# Lua

Lua est un langage de script libre, réflexif et impératif.
Créé en 1993, il est conçu de manière à pouvoir être embarqué au sein d'autres applications afin d'étendre celles-ci. Lua (du portugais : Lua [ˈlu.ɐ], au Brésil : [ˈlu.a], signifiant « Lune ») a été développé par Luiz Henrique de Figueiredo, Roberto Ierusalimschy (en) et Waldemar Celes, membres du groupe de recherche TeCGraf, de l'université pontificale catholique de Rio de Janeiro au Brésil.
L'interpréteur Lua est écrit en langage C ANSI strict, et de ce fait est compilable sur une grande variété de systèmes. Il est également très compact, la version 5.0.2 n'occupant que 95 ko à 185 ko selon le compilateur utilisé et le système cible. Il est souvent utilisé dans des systèmes embarqués tels qu'OpenWrt où cette compacité est très appréciée. Il profite de la compatibilité que possède le langage C avec un grand nombre de langages pour s'intégrer facilement dans la plupart des projets. Il intègre un ramasse-miettes.
Il est particulièrement apprécié pour l'embarqué, le développement réseau et les jeux vidéo.
Le Lua est utilisé dans des jeux vidéo comme : Minetest, Transformice, World of Warcraft, Roblox, Garry's Mod, Onset, ComputerCraft (mod de Minecraft), Multi Theft Auto (mod multijoueur de Grand Theft Auto: San Andreas), FiveM (mod multijoueur de Grand Theft Auto V), Factorio, Project Zomboid, nanos world, ainsi que les moteurs de jeu vidéo tels que le SourceEngine, CryENGINE, LÖVE, Solarus ou encore les Fantasy consoles, tel que Pico-8.
Il est également utilisé au niveau réseau comme hook sur Apache, Lighttpd (par défaut), Nginx (via OpenResty), dans les routeurs Cisco, dans l'analyseur de paquets Wireshark, l'antispam Rspamd, l'autocommutateur téléphonique privé Asterisk (optionnel), pour les scripts de MediaWiki.

## Généralités
### Commentaires

En Lua, les commentaires débutent par -- et finissent à la fin de la ligne, comme en Ada. Si la première ligne commence par #! (shebang) elle est aussi traitée comme un commentaire. Les commentaires multilignes sont également disponibles avec la syntaxe

### Variables

Une variable peut contenir un booléen, une chaîne de caractères, un nombre (pas de différence entre entier et flottant), une table ou une fonction. Il existe aussi d'autres types comme userdata ou thread, moins souvent rencontrés. Le type userdata correspond à un objet C/C++ défini par l'utilisateur : il est donc possible de créer une structure C ou une classe C++, et d'utiliser des objets de ce type dans un script Lua après avoir attaché à cet objet une métatable qui se charge d'appeler les fonctions C/C++ appropriées. On pourrait donc imaginer, par exemple, créer les classes métier de base d'un programme en C++, et coder l'application elle-même en Lua, ce qui accélérerait son développement grâce aux outils de haut niveau fournis par le langage.
Une variable non définie a la valeur nil. Affecter nil à une variable revient à la supprimer.
En interne on peut aussi rencontrer des proto, une sorte de prototype de fonction: le bytecode de cette fonction est chargé mais ce dernier n'a pas encore été exécuté. On rencontre les proto quand un fichier est chargé (compilé) mais pas exécuté ou bien avec des closures.
Par défaut, une variable déclarée est globale à tout l'environnement d'exécution, sauf si elle est précédée du mot-clef local.
Les chaînes de caractères sont délimitées par des guillemets simples (') ou doubles ("), voire par la marque de chaîne littérale
(multiligne, pas de caractère spécial).
L'opérateur de concaténation de chaînes se représente par deux points (..).

### Les fonctions

Les fonctions sont considérées comme des variables. Il est donc possible de créer des fonctions à l'intérieur d'autres fonctions, de passer une fonction comme paramètre d'une autre fonction (ou comme valeur de retour) ou de mettre des fonctions dans des tables (à la fois comme clé ou comme valeur).
Une spécificité des fonctions en Lua est qu'elles peuvent prendre un nombre indéfini de paramètres mais aussi qu'elles peuvent retourner plusieurs valeurs.

### Les tables, métatables

Une table est une structure Lua qui stocke des variables indexées par une clé (comme en PHP par exemple). Les tables servent beaucoup en Lua, notamment pour représenter des objets complexes.
Une table peut, entre autres, être utilisée comme :
* Une liste (avec un index commençant à 1 et non à 0 comme dans la plupart des langages). L’opérateur # donne alors la longueur de la liste.
* Une hashtable (pouvant faire office de structure), qui peut prendre en clé et en valeur tout type de variable (sauf nil).
Il est possible (mais fortement déconseillé pour la qualité du code) d'avoir une table qui mêle liste et hashtable.
Par convention, on parcourt une liste avec l'itérateur ipairs et une hashtable avec l'itérateur pairs.
La clé nil est interdite. Affecter nil à un index est permis mais revient à le supprimer. Ainsi a={nil,"x",nil,"y"} équivaut à a={[2]="x",[4]="y"}. L’opérateur de longueur # n’a alors plus de sens, l’itérateur pairs saute les nil, et l’itérateur ipairs s’arrête au premier nil.
Les métatables sont des tables qui associent une fonction à chaque opérateur de base (+, -,,…). Ce mécanisme est très proche de la surcharge des opérateurs. Par exemple, si la variable x contient une table associée à une métatable appropriée, l'appel de fonction x(arguments) est valide et l'interpréteur cherche alors dans la métatable comment traiter cet appel.
On dispose ainsi d’une sorte d'héritage entre tables: si un champ demandé manque, Lua le cherche dans la métatable parente si elle existe.

## Exemples
### Condition

La première méthode est d'écrire en toutes lettres le mot "AND".
La seconde méthode est d'écrire && à la place de "AND".

### Boucles

et
(La différence entre les deux est qu'une boucle repeat exécutera toujours au moins une fois le code de la boucle contrairement à une boucle while)
ainsi que
ou

## Déclaration de fonctions

ou

### Blocs inconditionnels

Les blocs inconditionnels servent par exemple à déclarer des variables locales à ce bloc :

### Déclaration de table

Table à indices numériques consécutifs (En Lua, le premier indice d'une table est 1) :
Table à indices explicites, indiqués entre crochets (les indices qui sont des chaînes ayant la syntaxe d'une variable n'ont pas besoin de guillemets ni de crochets) :
Quand on assigne une variable a une autre, si la valeur de celle-ci n'est pas un nombre, une chaîne de caractères ou un booléen alors la référence de celle-ci est copiée. Donc, dans le cas des tables, si une variable a possède une table et qu'on assigne à la variable b la variable a, alors toutes les modifications subies par a seront directement visibles sur b :
Table stockant des variables complexes : autres tables, fonctions, références croisées… Lorsque les valeurs en tant qu'indices ne sont pas des nombres, des chaînes de caractères ou des booléens, alors l'indice sera la référence de la variable en question :

## Les fonctions
### Les fonctions mathématiques

La fonction math.pi retourne la valeur de pi.
La fonction math.min(liste) retourne le plus petit nombre contenu dans une liste
La fonction math.max(liste) retourne le plus grand nombre contenu dans une liste
La fonction math.floor(x) retourne la partie entière de x.
La fonction math.abs(x) retourne la valeur absolue de x.
La fonction math.pow(x, y) retourne x à la puissance de y. On peut aussi utiliser l'expression x^y
La fonction math.random(x, y) retourne un nombre aléatoire entre la valeur x et la valeur y.
La fonction math.sqrt(x) retourne la racine carrée de x.

### Les fonctions os

La fonction os.time retourne le nombre de secondes entre le 1er janvier 1970 à 00:00 et la seconde à laquelle vous appelez la fonction.
La fonction os.date retourne le jour, le mois, le numéro du mois, l'heure, les minutes, les secondes et l'année à laquelle vous êtes quand vous appelez cette "fonction"
La fonction os.clock retourne le temps écoulé en seconde depuis que Lua a été lancé.

### La fonction type

La fonction type(x) permet de donner le type de x.

### Les fonctions table

En lua, il existe 9 fonctions table.
La fonction table.insert(x, y, z) permet d'insérer une valeur y dans un tableau x. On peut aussi lui donner une position à laquelle s'ajouter en rajoutant un argument z. Si aucun argument z n'est donné, la valeur s'affichera en dernière position de la table.
La fonction table.remove(x, y) permet de retirer du tableau x une valeur en indiquant la position de la valeur y.
La fonction table.sort(x) permet de trier et modifier la position des éléments du tableau x.
La fonction table.concat(x, y) permet de regrouper l'ensemble des valeurs d'un tableau et les transforme en chaines de caractères. Le y, facultatif, sert de séparateur entre les valeurs.
Voici un exemple d’utilisation du séparateur y:.
La fonction table.foreach(x, z) ne fonctionne plus depuis la version 5.1 de lua et doit être remplacée par les boucles pairs. Voir ci-dessous.
La fonction table.foreachi(x, y) ne fonctionne plus depuis la version 5.1 de lua et doit être remplacée par les boucles ipairs.
La fonction table.getn(x) donne la taille d'un tableau x.

### Les fonctions strings

Les fonctions «string.», au nombre de 15, opèrent sur les variables de type string.
Le string.find(x, y) recherche des caractères y dans le string x. Il renvoie nil si rien n’est trouvé. Sinon il indique à partir de quel emplacement les caractères recherchés ont été trouvés.
On peut aussi ajouter un argument z pour commencer la recherche à une certaine position.
Le string.byte(x, y, z) renvoie le code numérique des caractères (Code ASCII) de la string x.
On peut aussi utiliser l'argument y pour définir un début de conversion ainsi que l'argument z pour définir la fin de conversion (numéro de caractère).
Le string.char(x) convertit le code numérique x qui est en code ASCII en caractères normaux.
Le string.dump(x) convertit la fonction x en une représentation binaire utilisable par la fonction loadString(y).
Le string.format renvoie une chaine de caractères formatée.
Le string.gmatch(x, y) renvoie une sous-chaîne de la chaîne principale x.
Le string.gsub(x, y, z) remplace les mots y d'une string x par un autre mot z.
Le string.upper(x) renvoie le texte d'une string x en changeant les minuscules en MAJUSCULES (sauf caractères spéciaux).
Le string.lower(x) renvoie le texte d'une string x en changeant les MAJUSCULES en minuscules.
Le string.reverse(x) retourne le texte d'une string x en inversant la chaîne de caractères.
Le string.sub(x, y, z) renvoie une sous-chaîne de la string x en gardant uniquement le caractère s. Avec un argument z, il renvoie la sous-chaîne du caractère y au caractère z. Si l'argument y est négatif, il commence à l'envers et il prend la fin de phrase.
Le string.rep(x, y) concatène y fois le contenu de la string x.
Le string.match(x, y, z) renvoie une sous-chaîne de caractères de la string x conforme au motif indiqué en y, et en cherchant à partir du caractère z (qui est facultatif).

### La fonction pairs

La fonction pairs(x) énumère les index et les valeurs d'un tableau x. Elle sert actuellement à remplacer la fonction table.foreach qui est erronée depuis la version de lua 5.1. A chaque itération, la première variable qui suit for reçoit l’index, et la seconde variable reçoit la valeur correspondant à cet index dans le tableau. On choisit donc souvent les noms de variables i pour l’index et v pour la valeur. Ainsi, dans « for i, v in pairs(x) do …», le i est l’index de la valeur dans le tableau, et le v est la valeur.
Le tableau à parcourir est donné comme argument de pairs.
On peut aussi utiliser pairs pour rechercher et retirer une valeur d'un tableau:

### La fonction pcall

La fonction pcall sert à capturer les erreurs qui surviennent dans une fonction. Dans ce cas, pcall empêche l’arrêt du script et fournit les informations sur l’erreur.
Les informations sur une erreur éventuelle sont données dans les deux valeurs renvoyées par pcall:

## Usages
### Consoles

Lua a été embarqué dans la PlayStation Portable de Sony, grâce au programme Lua Player, et plus récemment Lua Player HM et Lua Player Euphoria qui permettent de lire des applications écrites avec Lua afin d'étendre les capacités de la console. Viendra plus tard l'XtreamLua Player, destiné à la création de jeux vidéo. Une modification (non officielle) du micrologiciel de la PSP permettait de lancer des programmes non-signés par Sony d'où la création d'un interpréteur Lua adapté pour la PSP.
Lua Player Euphoria reprend la syntaxe du Lua Player original et exécute le script à une vitesse fulgurante comparé au Lua Player HM. Cependant, Lua Player Euphoria est moins complet que son homologue plus ancien.
Lua Player One, un des derniers Lua Player mis à jour pour PSP, est un Lua Player développé au sein d'une communauté de développeurs espagnols ; il permet, entre autres, de gérer la 3D sur PSP. Un jeu de mini-golf dans l'espace a été développé à l'aide de cet outil.
Lua Player Plus (LPP) est sorti sur PlayStation Vita le 16 août 2015. Ce Lua Player permet de créer des jeux pour la console.
Lua est inclus dans la console de poche open-source Pocket Chip (projet Kickstater). En effet cette dernière embarque le programme de console virtuel Pico-8 qui permet de jouer et de créer des jeux en Lua.

### Extensions de jeux vidéo

Parmi les jeux vidéo de bac à sable qui l'utilisent figurent Garry's Mod, Roblox, Core, Stormworks (en) et Minecraft. Pour ce dernier, ComputerCraft, un mod du jeu Minecraft, utilise Lua pour concevoir des programmes graphiques ou consoles et des « robots » autonomes à l'intérieur du jeu, permettant d'automatiser de nombreuses tâches répétitives ; Minetest, un jeu sandbox sous licence LGPL similaire à ce dernier, utilise Lua comme langage pour l'écriture d'extensions et à l'intérieur même du jeu (via certains modes) via la programmation de microcontrôleur ou de FPGA.
Il existe également un moteur de jeu utilisant Lua comme langage de programmation (une sorte de Pygame pour Lua) : LÖVE.
Beaucoup d'autres jeux vidéo l'utilisent, comme World of Warcraft de Blizzard Entertainment, Far Cry (et le moteur CryEngine en général) de Crytek Studios, le logiciel multijoueurs de GTA:SA Multi Theft Auto, SimCity 4 et Natural Selection 2 de Unknown Worlds Entertainment (qui a entre autres développé Decoda, un IDE pour Lua). Enfin, certains scripts de Zoo Tycoon 2 (Blue Fang Games) sont également présents sous des formes non compilées dans les fichiers du jeu. The Binding of Isaac: Afterbirth+ est un DLC pour le jeu The Binding of Isaac: Rebirth qui permet le support de mods écrits en Lua.

### Autres logiciels

Lua est également utilisé pour l'extension des capacités du lecteur multimédia VLC, dans les gestionnaires de fenêtres EFL Edje d'Enlightenment, dans NeoVim pour sa configuration, ainsi que Awesome (comme langage de configuration et de script).
Le PABX Asterisk propose Lua comme alternative pour étendre son plan de numérotation.
MediaWiki et les sites Wikimedia utilisent Lua comme langage de script pour les modèles (appelés modules).
Le logiciel CraftStudio utilise Lua pour programmer les éléments dynamiques des modèles.
Le logiciel libre d'interface neuronale directe OpenVibE (en) utilise Lua comme langage de script, en particulier pour la gestion de stimuli pour les expériences de neuroscience.
Le robot IRC irccd utilise Lua pour la création de plugins.
L'antispam Rspamd utilise également Lua pour son interface de programmation.
Lua est le langage de scripting principalement utilisé pour le système d'exploitation embarqué OpenWrt fonctionnant sur de nombreux routeurs. L'interface graphique d'administration LuCI est entièrement écrite en Lua.
Lua est le langage natif de Domoticz, logiciel de domotique open source. Il permet le scripting avec des fonctionnalités avancées : Domoticz déclenche automatiquement ces scripts sur les changements d’états, en fonction du temps, etc.
Lua est également le langage natif de NSBase, logiciel de gestion de bases données. Le scripting permet de dynamiser les formulaires, rapports. Lua ainsi intégré permet de créer de véritables applications de gestion de bases de données.
Le logiciel de simulation de vol spatial Orbiter et ses add-ons (UCGO, UMmu) utilisent Lua pour permettre la création aisée d'écrans de contrôle (MFD - Multi Function Display), de missions ou de vaisseaux. La création de vaisseaux, en particulier, à la différence de modules DLL, ne nécessite pas la compilation d'un fichier C++.
BeamNG.drive utilise Lua pour compléter ses équations physiques.
Prosody : serveur XMPP léger écrit entièrement en lua.
L'environnement de bureau Awesome (linux) utilise aussi Lua dans ses fichiers de configuration depuis sa version 3.
FreeBSD intègre un interpréteur lua dans son chargeur depuis la version 11.3.
La solution qui associe le montage, l’étalonnage, les effets visuels, les animations graphiques et la post-production audio Davinci Resolve utilise Lua, Py2 et Py3.
Le logiciel de notation musicale professionnel Finale propose un plugin Lua.