La metaméthode __newindex

Tu as appris comment __index contrôle ce qui se passe lorsque tu essaies de lire une clé qui n’existe pas dans une table. Tu vas maintenant découvrir son pendant : __newindex, qui contrôle ce qui se passe lorsque tu affectes une valeur à une clé que la table ne possède pas encore.

La métaméthode __newindex est déclenchée chaque fois que tu essaies d’assigner une valeur à une clé qui n’existe pas actuellement dans la table. Cela te permet d’intercepter et de contrôler les modifications avant qu’elles ne se produisent.

Voici un exemple simple qui empêche l’ajout de nouvelles clés à une table :

local readOnly = {}
local meta = {
    __newindex = function(table, key, value)
        print("Cannot add key: " .. key)
    end
}

setmetatable(readOnly, meta)

readOnly.name = "Alice"  -- Sortie : Cannot add key: name
print(readOnly.name)     -- Sortie : nil

Lorsque tu essaies de définir readOnly.name = "Alice", Lua constate que name n’existe pas dans la table. Au lieu de l’ajouter, Lua appelle la fonction __newindex avec trois arguments : la table elle-même, la clé à définir et la valeur attribuée.

Dans cet exemple, la fonction affiche simplement un message et ne stocke rien en réalité.

Tu peux aussi utiliser __newindex pour valider les données avant de les laisser entrer dans ta table :

local player = {}
local meta = {
    __newindex = function(t, key, value)
        if key == "health" and type(value) ~= "number" then
            print("Health must be a number!")
        else
            rawset(t, key, value)
        end
    end
}

setmetatable(player, meta)

player.health = "high"  -- Sortie : Health must be a number!
player.health = 100     -- Autorisé, stocké avec rawset
player.health = "high"  -- Aucun message : health existe maintenant

Remarquez l’utilisation de rawset() dans le deuxième exemple. Cette fonction contourne la métatable et définit directement la valeur dans la table.

Sans cela, définir la valeur déclencherait à nouveau __newindex, créant une boucle infinie.

Comme __newindex ne s’exécute que pour les clés que la table ne possède pas, cette vérification protège la première affectation de chaque clé. Une fois que rawset a stocké health, les affectations suivantes la modifient directement. Pour vérifier chaque affectation, laisse la table elle-même vide et stocke les valeurs dans une seconde table, à laquelle elle accède par __index :

local data = {}
local player = setmetatable({}, {
    __index = data,
    __newindex = function(t, key, value)
        if key == "health" and type(value) ~= "number" then
            print("Health must be a number!")
        else
            data[key] = value
        end
    end
})

player.health = 100
player.health = "high"  -- Sortie : Health must be a number!
print(player.health)    -- Sortie : 100

player n’obtient jamais de clé qui lui soit propre : chaque affectation passe donc par __newindex, et chaque lecture passe par __index pour accéder à data.