Extension:Scribunto/Lua reference manual/uk

Ця довідка документує мову такою, якою вона використовується на MediaWiki з розширенням. Деякі частини були взяті з документації Lua 5.1, яка поширюється під ліцензією MIT.

Як розпочати
Створіть сторінку, яка починається із "Module:" (або "Модуль:" в україномовних проектах) в будь-якому вікіпроекті, який використовує рушій MediaWiki, і в якому включене розширення Scribunto, наприклад "Module:Bananas". Скопіюйте цей текст в цю сторінку:

Збережіть сторінку. Далі відкрийте будь-яку іншу сторінку (спрацює на будь-якій, але рекомендується на сторінці, яка починається із "Template:" або "Шаблон:") і скопіюйте туди такий текст:

При цьому замість "Bananas" ви маєте написати назву тільки що створеного вами модуля. Цей текст викликає функцію "hello" з вашого модуля. Після збереження замість  на екрані буде показуватись текст, який повернула функція, в даному випадку вона поверне текст "Hello, world!".

Вставляти виклики функцій Lua краще у шаблонах. В такому випадку зі сторінки викликається саме шаблон і сторінка не залежить від того чи реалізований шаблон на вікітексті чи за допомогою Lua. Також це дозволяє уникнути складного синтаксису в тексті сторінок основного простору.

Структура модуля
Сам модуль має повертати таблицю, що містить функції які можуть бути викликані через. Зазвичай, як це показано вище, оголошується локальна змінна в якій зберігається таблиця. До цієї таблиці додаються функції і в самому кінці коду модуля ця таблиця повертається.

Будь-які функції, які не були додані до таблиці, не залежно від того чи це локальні чи глобальні функції, не будуть доступними через, але глобальні функції можуть бути доступними в інших модулях при використанні функції. Оголошення всіх функцій та змінних локальними вважається гарним стилем написання коду.

Доступ до параметрів з вікітексту
Функціям, які викликаються за допомогою, передається єдиний параметр який є об'єктом фрейму. Щоб отримати доступ до параметрів переданих до , зазвичай використовується таблиця   цього об'єкта фрейма. Також можна отримати доступ до параметрів переданих шаблону, який містить, за допомогою методу  frame:getParent.

Також за допомогою об'єкта фрейма можна скористатися функціями вікітекстового парсеру, наприклад викликати функцію парсера, викликати шаблон або обробити рядок вікітексту.

Повернення тексту
Функції модуля зазвичай повертають один текстовий рядок. У випадку, якщо функція повертає не текстовий рядок або не одне значення, всі повернуті значення перетворюються на текст за допомогою функції tostring після чого об'єднуються (конкатенуються) в один рядок без символів розділення. Результуючий рядок включається до вікітексту як результат.

На цей момент всі шаблони вже мають бути викликаними, всі парсерні функції обробленими, всі перетворення (наприклад перетворення тильд на підпис) виконаними. Модуль не повинен повертати текст, який містить перелічене вище. Наприклад, якщо модуль повертає текст, то і на сторінці він відобразиться як ""Hello, world! ", а шаблон "welcome" викликаний не буде.

Окрім того, підстановки виконуються на ранній стадії обробки тексту, тому код  не спрацює одразу, а тільки після наступного редагування сторінки де він написаний.

Документація модулів
Scribunto дозволяє документувати модулі, автоматично асоціюючи модуль зі сторінкою документації написаною на вікітексті яка за замовчуванням має назву модуля із доданим "/doc" на кінці, наприклад для "Module:Bananas" сторінка документації буде називатися "Module:Bananas/doc". При перегляді сторінки модуля, його документація автоматично показується перед кодом модуля.

Відображення сторінки документації може бути налаштоване за допомогою повідомлень MediaWiki-простору:


 * scribunto-doc-page-name: встановлює сторінку, яка буде використовуватись як сторінка документації. Назву модуля (без префікса "Module:" або "Модуль:") можна отримати за допомогою кода . Якщо вказана сторінка документації знаходиться в просторі назв "Модуль:", то її вміст інтерпритуватиметься як вікітекст, а не код на Lua. Також на сторінці документації не має бути  . Значенням за замовчуванням є "Module:$1/doc", тобто підстрінка "/doc" модуля. При вказанні назви сторінки документації не можна використовувати шаблони або парсерні функції.
 * scribunto-doc-page-does-not-exist: повідомлення, яке буде показуватись, якщо сторінка документації не існує. Назву модуля (без префікса "Module:" або "Модуль:") можна отримати за допомогою кода . Значенням за замовчуванням є порожній рядок.
 * scribunto-doc-page-show: повідомлення, яке буде показуватись, якщо сторінка документації існує. Назву модуля (без префікса "Module:" або "Модуль:") можна отримати за допомогою кода . За замовчуванням текст сторінки документації включається до сторінки модуля.
 * scribunto-doc-page-header: заголовок, який показується тільки на самій сторінці документації. Назву модуля (з префіксом "Module:" або "Модуль:") можна отримати за допомогою кода . За замовчуванням показується невеличкий опис курсивним шрифтом.

Зверніть увагу, що модулі не можуть бути напряму категоризовані і не можуть мати інтервікі-посилання вказані прямо на сторінці. Категорії та інтервікі-посилання краще вставляти на сторінку документації всередині тегів. Тоді вони застосуються до модуля коли сторінка документації буде включена до сторінки модуля.

Назви змінних та ключові слова
Назви (їх також називають ідентифікаторами) в Lua можуть бути будь-яким текстовим рядком, який складається з літер, цифр або знаків підкреслювання і не починається з цифри. Назви є чутливими до регістру, тому "foo", "Foo" та "FOO" є різними назвами.

Ключові слова, які є зарезервованими і не можуть використовуватись як назви:



Назви, які починаються із знаку підкреслення та великої літери зарезервовані для внутрішніх змінних Lua.

Операторами в мові Lua є:



Коментарі
Коментар в коді на мові Lua починається з  будь-де, окрім всередині текстового рядка, і продовжується до кінця рядка. Якщо після  одразу йде довга відкриваюча дужка, то коментар продовжується до відповідної довгої закриваючої дужки.

Типи даних
Lua є мовою програмування із динамічною типізацією. Це означає що змінні та аргументи функцій не мають типу, тільки їх значення мають тип. Кожне значення має тип.

Lua має вісім типів даних, але тільки шість із них доречно використовувати в розширенні Scribunto. Функція  повертає тип переданого їй аргумента.

Функція  перетворює переданий їй аргумент в текстовий рядок. Функція  перетворює переданий їй аргумент в число якщо це можливо, в іншому випадку повертає nil.

Число автоматично перетворюється на текстовий рядок коли це число використовується там, де очікується текстовий рядок, наприклад при використанні оператора об'єднання рядків. Рядки, які можуть бути оброблені функцією, автоматично перетворюються в числа коли до них застосовуються математичні оператори. Коли очікується логічне значення, всі значення окрім nil та false вважаються правдивими.

nil
nil є спеціальним типом даних який позначає відсутність значення.

Його не можна використовувати як ключ в таблиці тому що не існує різниці між непозначеним ключем та ключем позначеним значенням nil.

Якщо nil перетворити на текстовий рядоку, то вийде "nil". Якщо його перетворити на логічне значення, то він вважається неправдивим.

Логічні значення
Існує тільки два логічних значення:  (правда) та   (неправда).

Якщо їх перетворити на текстовий рядок, то вийде відповідно "true" або "false".

На відміну від більшості інших мов програмування, логічні значення не можуть бути перетворені у числа. Також, на відміну від більшості інших мов програмування, тільки false та nil вважаються неправдивими, а всі інші значення, включаючи 0 та порожній текстовий рядок, вважаються правдивими.

Текстові рядки
Текстові рядки в Lua вважаються послідовностями байтів, які інтерпритуються як текст відповідно до певної системи кодування.

Значення рядків починаються і закінчуються одинарними або подвійними лапками ( or  ). Подібно до JavaScript і на відміну від PHP, між цима двома варіантами лапок немає різниці. Всередині текстового рядка розпізнаються такі керуючі послідовності:


 * (звуковий сигнал, байтове значення 7)
 * (повернення на крок або backspace, байтове значення 8)
 * (горизонтальна табуляція, байтове значення 9)
 * (зміна рядка, байтове значення 10)
 * (вертикальна табуляція, байтове значення 11)
 * (зміна сторінки, байтове значення 12)
 * (повернення каретки, байтове значення 13)
 * (подвійні лапки, байтове значення 34)
 * (одинарні лапки, байтове значення 39)
 * (обернений слеш, байтове значення 92)

Також зміну рядка можна включити до текстового рядка за допомогою обернененого слеша та власне зміни рядка. Байти також можуть бути вказані через їх числові значення за допомогою керуючих послідовностей виду "\ddd", де "ddd" є десятковим значенням байту в межах 0-255. Щоб за допомогою керуючих послідовностей включити до текстового рядка символи Unicode, треба вказувати окремі байти UTF-8, тому легше включити символи Unicode до текстового рядка прямо написавши їх.

Текстові рядки окрім лапок можуть також починатись і закінчуватись довгими дужками. Довга відкриваюча дужка складається з відкриваючої квадратної дужки, після якої йде нуль або більше пробілів, після яких йде ще одна відкриваюча квадратна дужка, наприклад,   або. Якщо текстовий рядок почався із довгої відкриваючої дужки, то він має закінчуватись відповідною довгою закриваючою дужкою, наприклад,   або  .. Якщо після довгої відкриваючої дужки одразу йде зміна рядка, то ця зміна рядка не включається до текстового рядка. Якщо ж зміна рядка йде одразу перед довгою закриваючою дужкою, то зміна рядка включається до текстового рядка. В текстових рядках на кінцях яких стоять довгі дужки, на відміну від лапок, не інтерпритуються керуючі послідовності.

Зверніть увагу що всі текстові рядки вважаються правдивими якщо їх перевести в логічне значення, на відміну від більшості інших мов програмування, де порожній текстовий рядок вважається неправдивим.

Числа
В Lua є тільки один числовий тип, який внутрішньо представлений числом з рухомою десятичною точкою із подвійною точністю. В цьому форматі цілі числа від -9007199254740992 до 9007199254740992 представлені точно, але числа поза цим діапазоном та дробові числа можуть бути викривлені через помилки округлення.

Числові значення можуть бути задані використовуючи точку в якості розділового знаку між цілою та дробною частинами, наприклад. Також числові значення можна задати використовуючи експоненціальний запис без пробілів, наприклад,   або. Цілі значення можна також задати в шістнадцятковій системі числення використовуючи префікс, наприклад.

Значення NaN разом із негативною та позитивною нескінченностями коректно зберігаються та обробляються. Константа  дорівнює позитивній нескінченності, яка також може бути отримана за допомогою , а за допомогою   можна отримати значення NaN.

Зверніть увагу, що всі числа вважаються правдивими якщо їх перевести в логічне значення, на відміну від більшості інших мов програмування, де 0 вважається неправдивим. Якщо переводити число в текстовий рядок, то всі кінцеві числа переводяться в їх десяткове представлення, можливо із використанням експоненціального запису, NaN переводиться в  або , нескінченності переводяться в   або.

Таблиці
Таблиці в Lua є асоціативними масивами (хешами) подібно до об'єктів в JavaScript та масивів в PHP.

Таблиці задаються за допомогою фігурних дужок. Порожню таблицю можна задати за допомогою коду. Щоб задати поля таблиці при її створенні, треба їх записати всередині фігурних дужок розділяючи їх комами або крапками з комами. Це можна зробити такими способами:


 * використовує (перше або єдине) значення "вираз1" як ключ та (перше або єдине) значення "вираз2" як значення.
 * є еквівалентним до.
 * є еквівалентним до, де "i" це ціле число яке починається з 1 та збільшується із кожним значенням заданим цим способом. Якщо це останнє поле таблиці та вираз має багато значень, то всі вони включаються до таблиці. В інакшому випадку включається тільки перше значення виразу.

Доступ до полів таблиці можна отримати за допомогою синтаксису квадратних дужок, наприклад. Якщо ключ є текстовим рядком який відповідає критеріям назви, то значення також можна отримати через синтаксис точки, наприклад, що є еквівалентним до. Виклик функції, яка є значенням в таблиці, можна виконати за допомогою синтаксису двокрапки, наприклад, що є еквівалентним до   або.

Послідовністю називають таблицю в якій задані значення (не nil) для всіх цілих чисел від 1 до N, а значення для чисел більших за N не задані або дорівнюють nil. Багато функцій Lua працює тільки із послідовностями та ігнорує ключі в таблицях, які не є додатніми цілими числами.

На відміну від більшості інших мов програмування, будь-яке значення окрім nil та NaN може бути використане як ключ таблиці. Значення не змінюють свій тип при використанні їх в якості ключів. Всі перелічені нижче способи задання значень в таблиці є правильними:

Подібно до ключів, будь-яке значення окрім nil може зберігатись в таблиці як значення. Присвоєння ключу таблиці значення nil еквівалентне видаленню цього ключа з таблиці. Також спроба звернутися до значення ключа, якому не було присвоєне значення, повертає nil.

Зверніть увагу, що в мові Lua не відбувається неявне копіювання таблиць. Якщо таблиця передається функції як аргумент і функція змінює цю таблицю, то зміни залишаються навіть після завершення роботи функції.

Якщо перевести таблицю в текстовий рядок, то результатом буде "table", хоча це може бути змінене перевизначенням метаметоду. Навіть порожня таблиця при переведенні в логічне значення вважається правдивою.

Функції
Функції в Lua є повноправними значеннями. Їх можна створювати анонімними, передавати як аргументи, присвоювати змінним і так далі.

Функції створюються за допомогою ключового слова  та викликаються за допомогою назви і дужок в кінці неї. Синтаксичний цукор доступний для іменованих функцій, локальних функцій та функцій які є значеннями в таблиці. Дивіться розділи "Оголошення функції" та "Виклик функцій" нижче.

Функції в Lua є замиканнями. Це означає що вони містять посилання на область видимості в якій вони були оголошені та можуть отримувати доступ і змінювати змінні в цій області видимості.

Подібно до таблиць, якщо функція присвоюється іншій змінній або передається іншій функції, то копія функції не створюється, а використовується той самий "об'єкт" функції.

Якщо перевести функцію в текстовий рядок, то результатом буде "function".

Типи, що не підтримуються
Тип даних "користувацькі дані" використовується щоб зберігати інформацію для розширень до Lua написаних на інших мовах програмування, наприклад цей тип даних може використовуватись щоб зберігати вказівник чи структуру з мови C. Розширення Scribunto використовується в середовищі, яке не дозволяє використання компільованого коду, тому в цьому типі даних немає потреби.

Тип даних "поток" призначений для паралельних обчислень, які не підтримуються в Scribunto.

Метатаблиці
Кожна таблиця може мати асоційовану з нею іншу таблицю яку називають "метатаблиця". Поля в метатаблицях використовуються деякими операторами і функціями та визначають поведінку таблиці, яка може відрізнятись від такої в інших таблиць. Метатаблиця певної таблиці може бути отримана за допомогою функції getmetatable, а встановлена за допомогою функції setmetatable.

При зверненні до метафункцій метатаблиці, вони повертаються так, ніби до них звернулись за допомогою функції rawget.

Поля метатаблиці, які впливають на саму таблицю:
 * __index
 * Використовується коли звернення до поля таблиці  повертає nil. Якщо значенням поля таблиці є інша таблиця, то буде повернуте значення цієї іншої таблиці за тим cамим ключем, тобто   (що може включати поле __index метатаблиці цієї таблиці). Якщо значенням поля таблиці є функція, вона буде викликана як через  . Функція rawget дозволяє обійти цей метаметод.


 * __newindex
 * Використовується при присвоєнні значення ключу таблиці коли   повернуло би nil. Якщо значенням поля таблиці є інша таблиця, то присвоєння повториться і в цій іншій таблиці, тобто   (що може включати поле __newindex метатаблиці цієї таблиці). Якщо значенням поля є функція, то вона буде викликана як через  . Функція rawset дозволяє обійти цей метаметод.


 * __call
 * Використовується коли до таблиці звертаються як до функції . Значенням поля __call має бути функція, яка викликається як через.


 * __mode
 * Використовується щоб створювати таблиці із слабкими посиланнями (такими, які ігноруються збирачем сміття). Значенням цього поля має бути текстовий рядок. За замовчуванням, жодне значення, яке використовується в таблиці як ключ або значення, не буде видалене збирачем сміття. Якщо текстовий рядок, який є значенням поля __mode, містить літеру 'k', то ключі таблиці можуть бути видалені якщо в таблиці немає сильних посилань. Якщо текстовий рядок містить літеру 'v', то те саме відбувається із значеннями. В обох випадках з таблиці видаляються ключ і значення, яке йому відповідає. Зверніть увагу, що ця поведінка стає невизначеною, якщо це поле змінюється після того, як таблиця була використана як метатаблиця.

Іншими полями метатаблиць є:


 * __add†
 * __sub†
 * __mul†
 * __div†
 * __mod†
 * __pow†
 * __unm
 * __concat†
 * __eq‡
 * __lt‡
 * __le‡
 * __pairs
 * __ipairs
 * __metatable*
 * __tostring

† Для бінарних операторів для пошуку метаметоду який треба використати, Lua спершу дивиться на метатаблицю першого аргумента, потім на метатаблицю другого. ‡ Для операторів відношення метаметод використовується тільки якщо одна і та сама функція задана в метатаблицях обох аргументів. Анонімні функції, навіть з однаковим тілом функції, можуть вважатися різними. * __metatable впливає як на getmetatable, так і на setmetatable.

Зверніть увагу, що в Lua всі текстові рядки мають спільну метатаблицю, в якій  посилається на таблицю. Ця метатаблиця недоступна в Scribunto, так само як і таблиця string. Таблиця string, яка доступна в модулях, є лише копією оригінальної таблиці.

Змінні
Змінною є область пам'яті де зберігається значення. В Lua існує три типи змінних: глобальні змінні, локальні змінні та поля таблиці.

Глобальні та локальні змінні представлені назвами (так само як і аргументи функції, які є одним із видів локальних змінних). Змінні вважаються глобальними якщо прямо не вказано що вони локальні використанням ключового слова. Будь-яка змінна, якій не присвоєно значення, вважається рівною nil.

Глобальні змінні зберігаються в стандартній таблиці Lua під назвою "environment". Ця таблиця також часто доступна як глобальна змінна. Можна встановити метатаблицю для цієї таблиці. Тоді метаметоди __index та __newindex будуть викликатися при кожному зверненні і зміненні глобальної змінної, так само як і для полів будь-якої таблиці.

Оточення функції може бути отримане за допомогою функції getfenv та змінене за допомогою setfenv. В Scribunto ці функції є значно обмеженими якщо вони взагалі доступні.

Локальні змінні мають власні області видимості. Дивіться Оголошення локальних змінних.

Вирази
Виразом є щось, що містить значення: літерали (числа, текстові рядки, true, false, nil), оголошення анонімних функцій, конструктори таблиць, посилання на змінні, виклики функцій, вираз для змінної кількості аргументів, вирази в дужках, унарні оператори застосовані до виразів та вирази поєднані із бінарними операторами.

Більшість виразів має лише одне значення. Виклики функцій та вирази для змінної кількості аргументів можуть мати будь-яку кількість значень. Зверніть увагу, що розміщення виклику функції або виразу для змінної кількості аргументів всередині дужок відкидує всі значення крім першого.

Списком виразів є список виразів розділений комами. Всі вирази в списку, окрім останнього, можуть мати лише одне значення, тобто всі інші значення відкидаються або вираз дорівнює nil якщо значень немає. Всі значення останнього виразу в списку стають значеннями списку виразів.

Арифметичні оператори
Lua підтримує звичайні математичні оператори: додавання, віднімання, множення, ділення, остача від ділення, зведення до степені та унарний мінус.

Коли всі операнди є числами або текстовими рядками, які функція tonumber може перетворити на числа, оператори матимуть своє звичайне математичне значення.

Якщо хоч один операнд є таблицею із відповідним метаметодом, то викликається цей метаметод.

Оператори відношення
Операторами відношення в Lua є,  ,  ,  ,   та. Результатом, який повертає оператор відношення, завжди є логічне значення.

Оператор рівності спершу порівнює типи свої операндів. Якщо вони різні, то повертається false. Якщо ні, то далі порівнюються значення. Функції вважаються рівними тільки якщо вони відсилаються до одного і того самого об'єкта функції. Наприклад  поверне false, оскільки порівнюються дві різні анонімні функції. Таблиці за замовчуванням порівнюються в той самий спосіб, але це можна змінити за допомогою метаметоду __eq.

Оператор нерівності є просто логічним запереченням до рівності.

Для операторів порядку якщо обидва операнди є числами або строками, вони порівнюються напряму. Якщо ні, то використовуються такі метаметоди:


 * використовує.
 * використовує  якщо він існує, або   якщо він існує (тоді вираз вважається рівним  ).
 * вважається рівним
 * вважається рівним

Якщо потрібні метаметоди не існують, то виникає помилка.

Логічні оператори
Логічними операторами є,   та. Всі вони використовують стандартну інтерпритацію, в якій nil та false вважаються неправдивими, а все інше правдивим.

Оператор  спочатку дивиться на лівий операнд. Якщо він є неправдивим, то оператор повертає false і другий операнд не обчислюється. В іншому випадку повертається значення другого операнда.

Оператор  теж спочатку дивиться на лівий операнд. Якщо він є правдивим, то оператор повертає true і другий операнд не обчислюється. В іншому випадку повертається значення другого операнда.

Оператор  повертає протилежне значення до значення свого операнда.

Зверніть увагу, що оператори  та   є скороченими. Наприклад, код  викличе функцію   тільки якщо   поверне неправдиве значення.

Оператор об'єднання текстових рядків
Оператор об'єднання текстових рядків представлений двома точками і має вигляд. Якщо обидва оператори є числами, то вони перетворюються на текстові рядки та об'єднуються. Якщо оператори не є ні текстовими рядками, ні числами, то для них викликається метаметод __concat. Якщо він не існує, то виникає помилка.

Зверніть увагу, що текстові рядки в Lua є незмінними, тому цикл, на кожній ітерації якого відбувається об'єднання текстових рядків, буде створювати новий текстовий рядок на кожній ітерації, а попередні рядки будуть видалені збирачем сміття. Якщо потрібно об'єднати одразу багато текстових рядків, то краще скористатися методом string.format або створити послідовність з текстових рядків та викликати метод table.concat для неї.

Оператор довжини
Оператор довжини представлений символом  і використовується в вигляді. Якщо  є текстовим рядком, то оператор повертає його довжину в байтах. Якщо  є послідовністю, то оператор повертає кількість полів в ній.

Якщо  є таблицею, але не послідовністю, то оператор може повернути будь-яке N таке, що   не дорівнює nil, а   дорівнює nil, навіть якщо існують поля з більшим ключем, значення яких не дорівнює nil. Наприклад:

Пріоритети операторів
Пріоритети операцій або черговість операцій в Lua від найвищого до найнижчого:


 * 1) not # - унарний мінус
 * 2) + - віднімання
 * 3) and
 * or
 * 1) and
 * or
 * 1) and
 * or

Всередині рівнів пріоритетності більшість бінарних операторів є ліво-асоціативними, тобто  трактується як. Зведення до степені та об'єднання текстових рядків є право-асоціативними, тобто  трактується як.

Виклик функції
Виклик функції в Lua виглядає так само, як і в більшості інших мов програмування, а саме назва функції після якої йде список параметрів в дужках.

func( список параметрів )

Аргументи функції є списком виразів, тому тільки останній вираз може мати більше одного значення.

Якщо функція викликається із меншою кількістю параметрів, ніж це зазначено в оголошенні функції, то зайві аргументи приймають значення nil. Якщо функція викликається із більшою кількістю параметрів, ніж зазначено в оголошенні, то зайві параметри відкидаються. Також функція може приймати змінну кількість аргументів, дивіться Оголошення функції.

Lua також дозволяє пряме звернення до значення, яке повертає функція, за допомогою синтаксису. Якщо функція повертає вираз, який є складнішим за звернення до однієї змінної, то замість змінної можна написати вираз в дужках.

В Lua є синтаксичний цукор виклику функції для двох загальних випадків. Перший випадок коли таблиця використовується як об'єкт, а функція, яку треба викликати, є методом об'єкту. Синтаксис

table:name( список параметрів )

еквівалентним до

table.name( table, список параметрів )

Другий випадок є методом імплементації іменованих аргументів передачею до функції таблиці, яка містить поля назва-значення. В випадку якщо до функції передається лише один аргумент, дужки можна не писати. Наприклад, виклики функцій

func{ arg1 = exp, arg2 = exp } func"string"

є еквівалентними до

func( { arg1 = exp, arg2 = exp } ) func( "string" )

Ці способи можна поєднувати. Наступні виклики функцій є еквівалентними

table:name{ arg1 = exp, arg2 = exp } table.name( table, { arg1 = exp, arg2 = exp } )

Оголошення функції
Синтаксис оголошення функції виглядає так:

function ( var-list ) block end

Всі змінні в var-list є локальними змінними функції і вони отримують значення зі списку аргументів при виклику функції. Додаткові локальні змінні можна оголосити всередині блоку функції.

Коли викликається функція, код всередині блоку функції виконується тільки після того, як всі локальні змінні з var-list створені та отримали значення. Якщо досягнуто виразу із твердженням return, то виконання коду функції зупиняється і вираз виклику функції приймає значення повернуте твердженням return. Якщо виконання коду функції доходить до кінця блоку, жодного разу не зустрівши твердження return, то вираз виклику функції має нуль значень.

Функції в Lua є замиканнями. Загальною практикою є оголошення "приватних статичних" змінних як локальних в області видимості, де оголошується функція. Наприклад

Функцію можна оголосити так, щоб вона приймала змінну кількість аргументів, за допомогою виразу, який має бути останнім в списку аргументів.

function ( var-list, ... ) block end

Всередині блоку коду функції можна використовувати вираз, який повертатиме список всіх додаткових аргументів, переданих при виклику функції. Наприклад

Функція select працює із списками значень. Зокрема код  має використовуватись замість   для отримання кількості значень в списку, оскільки   може не бути послідовністю.

В Lua є синтаксичний цукор для поєднання оголошення функції з її присвоєнням змінній. Дивіться Твердження оголошення функції.

Зверніть увагу, що такий код не працюватиме:

 local factorial = function ( n ) if n <= 2 then return n   else return n * factorial( n - 1 ) end end

Оскільки оголошення функції обробляється до присвоєння значення локальній змінній, "factorial" всередині тіла функції буде невизначеним. Цієї проблеми можна уникнути спочатку оголосивши локальну змінну, а в наступному твердженні присвоївши їй функцію або іншим методом описаним в розділі Твердження оголошення функції.

Твердження
Твердженням є основна одиниця виконання: одне присвоєння, контрольна структура, виклик функції, оголошення змінної, тощо.

Чанком є послідовність тверджень, розділених крапками з комами (необов'язково). Тіло анонімної фуркції є чанком, тому там можна оголошувати локальні змінні, отримувати аргументи та повертати значення.

Блоком це теж послідовність тверджень, як і чанк. Блок можна явно визначити за допомогою синтаксису. Це використовується для обмеження області видимості локальних змінних або щоб вставити твердження  чи   всередину іншого блоку.

Присвоєння
Список змінних є списком змінних, які розділених комами. Аналогічно список виразів. Всі вирази обчислюються до присвоєння, тому код  поміняє значення змінних a та b місцями.

Оголошення локальної змінної
Локальні змінні можна оголошувати будь-де всередині блоку або чанку. Перша форма оголошення, показана вище, просто оголошує змінні, але не присвоює їм значення, тому вони матимуть значення nil. Друга форма одразу після оголошення присвоює змінним значення так само, як описано вище в розділі Присвоєння вище.

Зверніть увагу що видимість локальної змінної починається із наступного твердження, після її оголошення. Тому код  оголошує локальну змінну x та присвоює їй значення глобальної змінної x. Область видимості локальної змінної продовжується до кінця найвнутрішнього блоку, в якому вона була оголошена.

Контрольні структури
Твердження while виконує блок коду знову і знову, поки значення виразу залишається правдивим.

Твердження repeat виконує блок коду знову і знову, поки значення виразу не стане правдивим. Локальні змінні оголошені всередині блока доступні і в виразі.

Перша форма циклу for оголошує локальну змінну, присвоює їй значення exp1 та повторює блок доки ця змінна не стане рівною чи більшою за exp2, на кожній ітерації збільшуючи змінну на exp3. Якщо вираз exp3 пропущено, то він вважається рівним 1. Всі вирази обчислюються один раз до початку виконання блоку коду.

Форма циклу for, яка показана вище, є еквівалентною до

окрім того, що змінні var, limit та step більше ніде не доступні. Зверніть увагу, що змінна name є локальною для цього блоку, тому щоб використовувати її значення після циклу, це значення треба скопіювати в змінну оголошену поза циклом.

Друга форма циклу for працює із функцією-ітератором. Як і в першій формі, всі вирази обчислюються один раз до початку виконання блоку коду.

Фома циклу for вказана вище є еквівалентною до

окрім того, що знов ж таки змінні func, static та var більше ніде не доступні. Зверніть увагу, що змінні в var-list є локальними для цього блоку, тому щоб використовувати їх значення після циклу, ці значення треба скопіювати в змінні оголошені поза циклом.

Часто список виразів заміняють функцією, яка повертає три значення. Якщо можна написати ітератор так, щоб він залежав тільки від переданих йому аргументів, то краще так і зробити. В інакшому випадку Інструкція з програмування на Lua рекомендує використовувати замикання, яке буде змінювати значенням на кожній ітерації замість таблиці.

виконує блок1 якщо вираз exp1 є правдивим, інакше якщо вираз exp2 є правдивим виконує блок2. Якщо ні exp1, ні exp2 не є правдивими, то виконується блок3. можна пропустити, а  можна повторити стільки разів, скільки потрібно, чи теж пропустити.

Твердження return використовується щоб повертати значення з функцій або чанків. Список виразів є списком виразів, які розділені комами. Він може складатися з нуля чи більше виразів.

В Lua підтримується хвостова рекурсія. Якщо  містить лише один вираз, який є викликом функції, то поточний стековий фрейм буде використаний ще раз щоб викликати цю функцію. Це впливає на функції, які мають справу із викликом стеку, наприклад  або.

Твердження return має бути останнім твердженням блоку. Якщо необхідно повернути значення всередині блоку, то це можна зробити за допомогою вкладеного блоку.

Твердження break використовується для переривання виконання циклів while, repeat або for. Воно переводить виконання програми на твердження наступне після циклу.

Твердження break має бути останнім твердженням блоку. Якщо необхідно припинити виконання всередині блоку, то це можна зробити за допомогою вкладеного блоку.

Виклик функції як твердження
Виклик функції може бути використаний як твердження. В такому випадку функція викликається тільки щоб виконати якісь дії, а всі значення які вона повертає відкидаються (наприклад функція mw.log використовується для виводу повідомлень при налагодженні, а значення які вона повертає, частіше за все відкидаються).

Твердження оголошення функції
В Lua підтримується синтаксичний цукор, який робить оголошення функції та присвоєння її змінній простішим. Такі пари оголошень функцій є еквівалентними:

-- Basic declaration function func( var-list ) block end func = function ( var-list ) block end

-- Local function local function func( var-list ) block end local func; func = function ( var-list ) block end

-- Function as a field in a table function table.func( var-list ) block end table.func = function ( var-list ) block end

-- Function as a method in a table function table:func( var-list ) block end table.func = function ( self, var-list ) block end

Зверніть увагу, що оголошення функції з використанням синтаксису двокрапки є аналогічним до такого з використанням точки, окрім того що в першому випадку до функції першим аргументом треба передавати таблицю, в якій вона знаходиться.

Обробка помилок
Помилки можна згенерувати за допомогою функцій error та assert. Функції pcall та xpcall дозволяють обробляти помилки. Зверніть увагу, що деякі внутрішні помилки Scribunto неможливо обробити в колі Lua.

Збирання сміття
В Lua реалізоване автоматичне керування пам'яттю. Це означає що вам не потрібно резервувати пам'ять для нових об'єктів або звільняти її коли ці об'єкти більше не потрібні. Lua керує пам'яттю за допомогою збирача сміття, який час від часу видаляє всі об'єкти, на які більше немає посилань або є тільки слабкі посилання. Будь-яка пам'ять яка використовується в Lua є об'єктом автоматичного керування: таблиці, функції, текстові рядки, тощо.

Збирання сміття відбувається автоматично і його не можна змінювати в Scribunto.

Стандартні бібліотеки
Стандартні бібліотеки Lua реалізують основні можливості та функції необхідні для нормального функціонування мови. В Scribunto підтримується тільки частина стандартних бібліотек.

_G


Глобальні змінні містять посилання на поточну таблицю глобальних змінних, наприклад змінна  може бути також отримана через. Зверніть увагу, що сама таблиця _G не є якоюсь особливою, над нею можна виконувати всі дії, які можна виконувати над будь-якою іншою таблицею.

Таблицю глобальних змінних можна використовувати так само як будь-яку іншу таблицю. Наприклад

_VERSION


Текстовий рядок, який містить назву поточної версії Lua, наприклад "Lua 5.1".

assert
Якщо  дорівнює nil або false, то виникає помилка. В такому випадку   використовується як текст повідомлення про помилку. Якщо воно дорівнює nil або не задане, то текстом повідомлення про помилку стає "assertion failed!". Якщо воно є текстовим рядком або числом, то використовується це значення, в інакшому випадку виникає ще одна помилка.

Якщо  дорівнює будь-якому іншому значенню, то функція повертає всі свої аргументи, включаючи   та.

В Lua є загальною практикою для функцій повертати true в випадку нормального виконання або повертати nil чи false разом із повідомленням про помилку у випадку виникнення помилки під час виконання. Функція  дозволяє реалізувати перевірку на помилки. Щоб перевірити чи нормально виконалась функція, виклик цієї функції треба зробити першим аргументом функції, наприклад:

error
Генерує помилку, текстом повідомлення про яку є аргумент.

Функція  зазвичай додає інформацію про місце помилки. Аргумент  означає рівень вкладеності помилки. Якщо він дорівнює 1 або пропущений, то надається інформація про місце самої помилки. Якщо він рівний 2, то місце виклику функції, в якій виникла помилка. Якщо він рівний 3, то місце виклику функції, в якій викликається функція, в якій виникла помилка, і так далі. Якщо цей аргумент дорівнює 0, то інформація про місце помилки не надається.

getfenv
Зверніть увагу, що ця функція може бути недоступною у деяких проектах, в залежності від значення  в їх налаштуваннях.

Повертає оточення (таблицю глобальних змінних) в залежності від аргументу :


 * Якщо 1, nil або пропущений, то повертає оточення для функції, яка викликає . Часто, це буде те саме, що і звернення до _G.
 * Якщо ціле число від 2 до 10, то повертає оточення функції відповідного рівня з стеку викликів функції. Наприклад, при значенні 2 функція поверне оточення для функції, в якій була викликана функція, в якій була викликана, і так далі. Якщо цей аргумент буде більшим за кількість викликів функцій в стеку або функція потрібного рівня буде мати хвостову рекурсію, то виникне помилка.
 * Якщо аргументом є функція, то буде повернуте оточення, яке буде використане при виклику цієї функції.

Оточення, які використовуються всіма стандартними бібліотечними функціями та функціями бібліотеки Scribunto, є захищеними. При спробі отримати доступ до цих оточень функція  поверне nil.

getmetatable
Повертає метатаблицю для таблиці вказаної як аргумент. Якщо переданий аргумент не є таблицею, то функція поверне nil.

Якщо метатаблиця має поле, то буде повернуте саме воно а не сама метатаблиця.

ipairs
Повертає три значення: функцію-ітератор, таблицю  та 0. Це потрібно для використання ітеративної форми циклу for:

В цьому циклі будуть оброблені всі пари (1, t[1]), (2, t[2]) і так далі поки t[i] не буде дорівнювати nil.

Стандартна поведінка може бути змінена якщо задати метаметод. Якщо цей метаметод існує, то функція поверне три значення, які повертає метаметод.

next
Ця функція дозволяє обійти в циклі всі ключі таблиці. Якщо  дорівнює nil або пропущений, то повертається перший ключ в таблиці та його значення. В іншому випадку повертається наступний ключ та його значення. Коли ключів більше не залишилось, то повертається nil. Є можливість перевірити чи є таблиця порожньою за допомогою виразу.

Зверніть увагу, що порядок в якому повертаються ключі є випадковим, навіть для таблиць з цілочисельними ключами. Щоб обійти всі ключі в порядку зростання, використовуйте звичайну форму циклу for або функцію ipairs.

Поведінка функції  для випадків коли під час циклу створюється новий ключ, є невизначеною.

pairs
Повертає три значення: функцію-ітератор (next або подібну), таблицю  та nil (функція   повертає те саме, окрім 0 замість nil). Це потрібно для використання ітеративної форми циклу for:

Обійде всі пари ключ-значення в таблиці  так само як би це зробила функція next.

Стандартна поведінка функції може бути змінена створенням метаметоду. Якщо цей метод існує, то функція поверне три значення, які повертає метаметод.

pcall
Викликає функцію  із вказаними аргументами в "безпечному режимі". Це означає, що якщо під час виконання функції  виникне помилка, то   поверне false та текст повідомлення про помилку. Якщо помилок не виникне, то функція поверне true та всі значення повернуті функцією.

На псевдокоді функція  виглядає приблизно так:

rawequal
Ця функція еквівалентна до, окрім того, що вона ігнорує метаметоди   обох аргументів.

rawget
Ця функція еквівалентна до, окрім того, що вона ігнорує метаметод   таблиці.

rawset
Ця функція еквівалентна до, окрім того, що вона ігнорує метаметод   таблиці.

select
Якщо  є цілим числом, то функція повертає всі аргументи   після цього індексу. Якщо  є текстовим рядком '#', то функція повертає кількість аргументів в.

Іншими словами, функція  є подібною до коду нижче, окрім того що функція коректно працює навіть коли   містить значення nil (дивіться документацію для # та unpack для інформації про проблеми із значеннями nil).

setmetatable
Встановлює метатаблицю для вказаної таблиці. Аргумент  може дорівнювати nil, але всеодно має бути вказаний.

Якщо поточна метатаблиця має поле, то виникне помилка.

tonumber
Перетворює аргумент  в число в системі числення вказаній в аргументі. Якщо  є числом або текстовим рядком який можна перетворити на число, то повертається це число, в інакшому випадку повертається nil.

Необов'язковий аргумент  (за замовчуванням 10) визначає систему числення, в якій треба повернути число. Він може мати цілочисельне значення від 2 до 36 включно. Якщо система числення є більшою за 10, то літера 'A' (моде бути і великою, і маленькою) представляє цифру 10, 'B' представляє цифру 11, і так далі до літери 'Z' яка представляє 35.

Для системи числення 10, аргумент  може мати дробову частину, може бути вираженим за допомогою експоненціального запису або мати "0x" на початку, що вказує на систему числення 16. Для інших систем числення можна вказувати лише невід'ємні цілі числа.

tostring
Перетворює  на текстовий рядок. Дивіться розділ Типи даних для інформації про те яким чином перетворюється на текстовий рядок кожен тип даних.

Стандартна поведінка функції для таблиць може бути змінена створенням метаметоду. Якщо цей метод існує, то функція поверне значення, яке повертає метаметод.

type
Повертає тип даних який має  в вигляді текстового рядку: ,  ,  ,  ,   або.

unpack
Повертає значення із вказаної таблиці так само, як код виду. Якщо аргумент  дорівнює nil або пропущений, то за замовчуванням він дорівнює 1, а аргумент   за замовчуванням дорівнює довжині таблиці.

Зверніть увагу, що результат не визначений якщо  не є послідовністю і одночасно   дорівнює nil або пропущене. Дивіться розділ Оператор довжини.

xpcall
Працює так само як і функція, окрім того що повідомлення про помилку передається до функції   перед поверненням.

На псевдокоді функція  виглядає приблизно так:

debug.traceback
Повертає текстовий рядок з відстеженням стеку викликів функцій. Необов'язковий аргумент  вставляється на початок цього текстового рядка. Необов'язковий аргумент  вказує на якому рівні стеку почати відстеження.

math.abs
Повертає модуль (абсолютне значення).

math.acos
Повертає арккосинус  (в радіанах).

math.asin
Повертає арксинус  (в радіанах).

math.atan
Повертає арктангенс  (в радіанах).

math.atan2
Повертає арктангенс  (в радіанах), використовуючи знаки обох аргументів для визначення того, в якій чверті знаходиться відповідь.

math.ceil
Повертає найменше ціле число, яке більше чи рівне  (округлення в більшу сторону).

math.cos
Повертає косинус  (x задається в радіанах).

math.cosh
Повертає гіперболічний косинус.

math.deg
Переводить величину кута із радіанів в градуси.

math.exp
Повертає $$e^x$$.

math.floor
Повертає найменше ціле число, яке менше чи рівне  (округлення в меншу сторону).

math.fmod
Повертає остачу від ділення  на , з часткою округленою в сторону нуля. Наприклад,  повертає.

math.frexp
Повертає два значення  та   такі, що:


 * Якщо  є кінцевим числом і не є нулем: $$x = m \times 2^e$$, де   ціле число, а абсолютне значення   лежить на проміжку $$[0.5, 1)$$.
 * Якщо  дорівнює нулю:   та   обидва дорівнюють нулю.
 * Якщо  дорівнює NaN або нескінченності:   дорівнює , а   дорівнює nil.

math.huge
Значення яке представляє додатню нескінченність. Це значення є рівним чи більшим за будь-яке інше числове значення.

math.ldexp
Повертає $$m \times 2^e$$ ( має бути цілим числом).

math.log
Повертає натуральний логарифм.

math.log10
Повертає десятковий логарифм.

math.max
Повертає найбільший аргумент із переданих.

Поведінка щодо NaN не визначена. В поточній реалізації функція поверне NaN якщо  дорівнює NaN, але всі інші NaN будуть проігноровані.

math.min
Повертає найменший аргумент із переданих.

Поведінка щодо NaN не визначена. В поточній реалізації функція поверне NaN якщо  дорівнює NaN, але всі інші NaN будуть проігноровані.

math.modf
Повертає два числа, які є відповідно цілою та дробною частинами. Наприклад,  повертає.

math.pi
Повертає значення числа $$\pi$$.

math.pow
Еквівалентне до.

math.rad
Переводить величину кута із градусів в радіани.

math.random
Повертає псевдовипадкове число в межах від  до.

Аргументи  та   можна пропустити, але якщо вони задані, то мають бути числами або значеннями які можна перевести в числа.


 * Якщо жоден аргумент не заданий, повертає випадкове число в межах $$[0,1)$$.
 * Якщо задано лише один аргумент, повертає випадкове ціле число в межах $$[1,m]$$.
 * Якщо задані обидва аргументи, повертає випадкове ціле число в межах $$[m,n]$$.

math.randomseed
Встановлює  як зерно для генератора псевдовипадкових чисел.

Зверніть увагу, що використання однакового зерна змусить  видавати однакові послідовності чисел.

math.sin
Повертає синус  (x задається в радіанах).

math.sinh
Повертає гіперболічний синус.

math.sqrt
Повертає квадратний корінь. Еквівалентне до.

math.tan
Повертає тангенс  (x задається в радіанах).

math.tanh
Повертає гіперболічний тангенс.

os.clock
Повертає приблизний час виконання програми процесором в секундах.

os.date

 * formatDate з бібліотеки мов може бути використаний для складнішого форматування дати

Повертає текстовий рядок або таблицю, що містить дату і час, відформатовані відповідно до значення вказаного в змінній. Якщо ця змінна пропущена або дорівнює nil, то за замовчуванням використовується "%c".

Якщо задана змінна, то саме час вказаний в цій змінній форматується (дивіться  ). В іншому випадку форматується поточний час.

Якщо змінна  починається із символу '!', то дата форматується в форматі UTC а не в місцевому форматі. Якщо після цього символу або на самому початку рядка йде "*t", то дата повертається у вигляді таблиці з такими полями:


 * year (рік)
 * month (номер місяця в межах 1–12)
 * day (день місяця в межах 1–31)
 * hour (години в межах 0–23)
 * min (хвилини в межах 0–59)
 * sec (секунди в межах 0–60)
 * wday (номер дня тижня, де Неділя має номер 1)
 * yday (день року)
 * isdst (логічне значення яке вказує на те чи використовується літній та зимовий час)

Якщо змінна  не дорівнює "!", "*t" або "!*t", то дата форматується так само, як би це зробила функція strftime в мові програмування C.

os.difftime
Повертає різницю між моментами часу  та   в секундах.

os.time
Повертає поточний час у вигляді часу Unix.

Якщо функція викликана без аргументів, повертається число для поточного часу. Якщо функції передано таблицю, то повертається число для часу вказаного в таблиці. Таблиця має містити поля "year", "month" та "day", а також може містити поля "hour" (за замовчуванням 12), "min" (за замовчуванням 0), "sec" (за замовчуванням 0) та "isdst".

require
Завантажує вказаний модуль.

Спочатку функція шукає значення для назви модуля в таблиці щоб перевірити чи був вже завантажений цей модуль. Якщо був, то повертається значення.

В іншому випадку функція перевіряє кожен завантажувач з послідовності  щоб знайти підходящий завантажувач для модуля. Якщо потрібний завантажувач знайдено, то він викликається і повертає значення.

Дивіться документацію по  для інформації про доступні завантажувачі.

Наприклад, якщо у вас є "Module:Giving" який містить наступне:

То це можна завантажити в іншому модулі за допомогою коду подібного до цього:

package.loaded
Ця таблиця містить всі завантажені модулі. Ключами в ній є назви модулів, а значеннями є значення повернуті функцією  при завантаженні цього модуля.

package.loaders
Ця таблиця містить послідовність пошукових функцій які використовуються при завантаженні модулів. Кожна пошукова функція викликається із єдиним аргументом яким є назва необхідного модуля. Якщо модуль знайдено, то пошукова функція має повернути іншу функцію, яка і завантажить модуль, та значення, яке має бути повернуте функцією. В іншому випадку функція має повернути nil.

В Scribunto є дві пошукові функції:


 * 1) Та яка шукає функцію-завантажувач в.
 * 2) Та яка шукає назву модуля в модулях Scribunto, а якщо не знаходить її там, то шукає в просторі назв "Module:" (або "Модуль:" в україномовних проектах). Префікс "Module:" (або "Модуль:") має бути вказаним.

Зверніть увагу, що стандартні завантажувачі Lua не включені до цієї таблиці.

package.preload
Ця таблиця містить функції-завантажувачі, які використовуються першою пошуковою функцією Scribunto з package.loaders.

package.seeall
Встановлює метаметод  для аргументу   рівним _G.

Бібліотека string (бібліотека текстових рядків)
Всі функції пов'язані із текстовими рядками починають відлік символів в рядку з 1, на відміну від більшості інших мов програмування, де відлік починається з 0. Індекси також можуть бути від'ємними. В такому випадку вони рахуються з кінця текстового рядку. Індекс -1 означає останній символ в текстовому рядку, -2 передостанній і так далі.

Бібліотека string вважає всі символи в текстових рядках однобайтовими. Вона не може працювати із символами в кодуванні Unicode. Щоб працювати із символами в кодуванні Unicode, використовуйте відповідні методи з бібліотеки ustring.

string.byte
Ця функція вважає текстовий рядок масивом (послідовністю) байтів та повертає байтові значення для,  , ···,. Значенням за замовчуванням для  є 1. Значенням за замовчуванням для  є значення. Ця функція є подібною до функції mw.ustring.byte.

string.char
Отримує одне чи більше цілих чисел. Повертає текстовий рядок, в якому всі отримані цілі числа перетворюються на відповідні символи.

Функція mw.ustring.char є подібною до цієї, окрім того що вона трактує отримані цілі числа як коди Unicode, а не як байтові значення.

string.find
Шукає перший збіг аргументу  в текстовому рядку. Якщо збіг знайдено, то повертається початкова і кінцева позиції цього збігу. В інакшому випадку повертається nil. Якщо в аргументі  є групи, для яких є збіги, тоді ці збіги повертаються після початкової і кінцевої позицій.

Третій необов'язковий аргумент  вказує позицію, з якої починати пошук. За замовчуванням вважається рівним 1. Цей аргумент може мати негативне значення. Якщо четвертий необов'язковий аргумент  вказаний рівним true, то аргумент   розглядається як простий текстовий рядок, тобто функція просто шукає підрядок   в текстовому рядку.

Зверніть увагу, що якщо аргумент  заданий, то і аргумент   теж має бути заданим.

Функція mw.ustring.find є подібною до цієї, окрім того що вона вважає текстовий рядок записаним в Unicode, а аргумент  вказує на позицію в символах, а не в байтах. Вона використовує патерни ustring, які працюють на основі властивостей символів Unicode.

string.format
Ця функція повертає відформатовані версії всіх аргументів починаючи з другого відповідно до формату вказаного в аргументі, який має бути текстовим рядком.

Аргумент  використовує обмежену підмножину специфікаторів формату:


 * Прапори '-', '+', ' ', '#' та '0' розпізнаються.
 * Поля для цілих чисел шириною до 99 розпізнаються. Прапор "*" не розпізнається.
 * Точність цілих чисел до 99 знаку розпізнається. Прапор "*" не розпізнається.
 * Модифікатори довжини не розпізнаються.
 * Специфікаторами перетворення, які розпізнаються, є 'c', 'd', 'i', 'o', 'u', 'x', 'X', 'e', 'E', 'f', 'g', 'G', 's', '%' та нестандартний 'q'.
 * Позиційні специфікатори (наприклад "%2$s") не розпізнаються.

Специфікатор перетворення 'q' діє так само як і 's', окрім того що форматує текстовий рядок у форму, яка може бути безпечно прочитана інтерпритатором Lua. На початку і на кінці текстового рядка ставляться подвійні лапки, а всі подвійні лапки, переведення рядків, нульові символи та повернення на крок всередині цього текстового рядку замінюються на керуючі послідовності.

Перетворення текстових рядків та чисел одні в одного відбуваються так, як це описано в розділі Типи даних. Інші типи даних не перетворюються на текстові рядки автоматично. Текстові рядки, які містять нульові символи (символи з байтовим значенням 0) не оброблюються коректно.

Функція mw.ustring.format є подібною до цієї.

string.gmatch
Повертає функцію-ітератор, яка під час кожного її виклику повертає збіг для наступної групи з  в текстовому рядку. Якщо в аргументі  не задані групи, то при кожному виклику функції повертається збіг для всього текстового рядка.

Ця функція не вважає символ "^" на початку  магічним, оскільки це би унеможливило ітерації. Цей символ трактується буквально.

Функція mw.ustring.gmatch є подібною до цієї. Вона використовує патерни ustring, які працюють на основі властивостей символів Unicode.

string.gsub
Повертає копію текстового рядка, в якому всі (або кількість вказана в   на початку) збіги для   заміняються на значення аргументу  , який може бути текстовим рядком, таблицею або функцією. Також ця функція повертає кількість знайдених збігів як друге значення.

Якщо аргумент  є текстовим рядком, то збіги заміняються саме на нього. В ньому символ "%" трактується як символ керуючої послідовності: кожна послідовність символів в текстовому рядку  виду , де n є цілим числом між 1 та 9, означає n-ну групу. Послідовність  означає весь збіг, а послідовність   означає один символ "%".

Якщо аргумент  є таблицею, то кожний збіг заміняється на значення таблиці за ключем, який є першою групою. Якщо в  не задані групи, то весь збіг використовується як ключ.

Якщо аргумент  є функцією, то ця функція викликається для кожного збігу і групи передаються функції як аргументи. Якщо в  не задані групи, то весь збіг передається функції як єдиний аргумент.

Якщо значення в таблиці  або значення повернуте функцією   є текстовим рядком або числом, то на нього і відбувається заміна. Якщо це значення дорівнює nil або false, то заміна не відбувається.

Функція mw.ustring.gsub є подібною до цієї. Вона використовує патерни ustring, які працюють на основі властивостей символів Unicode.

string.len
Повертає довжину текстового рядка  в байтах. Якщо всередині текстового рядка присутній нульовий символ, то функція може видати неправильний результат. Функція еквавалентна до коду.

Функція mw.ustring.len є подібною до цієї, окрім того що вона вважає текстовий рядок записаним в Unicode.

string.lower
Повертає копію текстового рядку  де всі великі літери замінені на маленькі. Всі інші символи не змінюються.

Функція mw.ustring.lower є подібною до цієї, окрім того що вона вважає текстовий рядок записаним в Unicode.

string.match
Шукає перший збіг для  в текстовому рядку. Якщо функція знаходить збіг, то повертає групи з, в інакшому випадку повертає nil. Якщо в аргументі  не задані групи, то повертається весь збіг.

Третій необов'язковий аргумент  вказує позицію, з якої починати пошук. За замовчуванням вважається рівним 1. Цей аргумент може мати негативне значення.

Функція mw.ustring.match є подібною до цієї. Вона використовує патерни ustring, які працюють на основі властивостей символів Unicode.

string.rep
Повертає текстовий рядок, де  повторюється   разів підряд. Функція mw.ustring.rep є подібною до цієї.

string.reverse
Повертає текстовий рядок, в якому всі символи рядка  записані в зворотньому порядку (побайтово).

string.sub
Повертає підрядок текстового рядка, який починається з символа в позиції   і закінчується символом в позиції. Аргументи  та   можуть бути негативними. Якщо аргумент  пропущений, він вважається рівним -1.

Note that a string in Lua begins at index 1. Also, when using this function, the indices at both ends are inclusive.

Виклик функції  повертає префікс текстового рядка   довжиною , а виклик   повертає суфікс довжиною.

Функція mw.ustring.sub є подібною до цієї, окрім того що вона вважає текстовий рядок записаним в Unicode.

string.upper
Повертає копію текстового рядку  де всі маленькі літери замінені на великі. Всі інші символи не змінюються.

Функція mw.ustring.upper є подібною до цієї, окрім того що вона вважає текстовий рядок записаним в Unicode.

Патерни
Зверніть увагу, що патерни в Lua схожими на регулярні вирази, але вони не однакові. Існують такі відмінності від регулярних виразів та регулярних виразів Perl:


 * Символом посилання на групу та буквального включення є символ відсотка, а не обернений слеш.
 * Точка збігається зі всіма символами, в тому числі із змінами рядка.
 * Не існує режиму нечутливості до регістру.
 * Не існує оператора вибору (оператор ).
 * Квантифікатори (, ,   та  ) застосовуються тільки до окремих символів або класів символів, вони не застосовуються до груп.
 * Єдиним нежадібним квантифікатором є, який еквівалентний до квантифікатора   в Perl.
 * Не існує узагальнених кінцевих квантифікаторів ( в Perl).
 * Єдиними твердженнями нульової ширини є,   та  . Твердження, такі як   або   в Perl, не підтримуються.
 * Патерни не розпізнають вставки символів за байтовим значенням типу, але оскільки патерни є текстовими рядками, то можна створити текстовий рядок, який буде патерном, вказавши байтові значення всіх його символів.

Також зверніть увагу що патерни не можуть містити нульові символи (символи з байтовим значенням 0). Використовуйте натомість.

Дивіться також розділ Патерни ustring, для інформації про патерни для текстових рядків в кодуванні Unicode.

Класи символів
Клас символів використовується щоб представити певний набір символів. При описанні символу, дозволяються такі послідовності:


 * x: (де x не є одним з магічних символів ) представляє сам символ x.
 *  : (точка) представляє всі символи.
 *  : представляє всі літери.
 *  : представляє всі контрольні символи ASCII.
 *  : представляє всі цифри.
 *  : представляє всі маленькі літери.
 *  : представляє всі знаки пунктуації.
 *  : представляє всі пробільні символі.
 *  : представляє всі великі літери.
 *  : представляє всі літери та цифри.
 *  : представляє всі шістнадцяткові цифри.
 *  : представляє нульовий символ (символ із байтовим значенням 0).
 *  : представляє всі символи, які не містяться в.
 *  : представляє всі символи, які не містяться в.
 *  : представляє всі символи, які не містяться в.
 *  : представляє всі символи, які не містяться в.
 *  : представляє всі символи, які не містяться в.
 *  : представляє всі символи, які не містяться в.
 *  : представляє всі символи, які не містяться в.
 *  : представляє всі символи, які не містяться в.
 *  : представляє всі символи, які не містяться в.
 *  : представляє всі символи, які не містяться в.
 *  : (де x є будь-яким символом, який не є літерою або цифрою) представляє сам символ x. Це стандартний спосіб уникнути трактування символу як магічного. Перед кодним знаком пунктуації (навіть тим, який не є магічним символом) можна поставити символ  щоб символ x представляв сам себе, а не був магічним символом.
 *  : представляє клас, який містить всі символи та класи символів перелічені в набір. Можна також задати діапазон символів вказавши початковий і кінцевий символи діапазону розділені знаком . Наприклад   або   представляє всі літери та цифри, а також знак підкреслення. Код   представляє всі вісімкові цифри, код   представляє всі вісімкові цифри, маленькі літери та тире. Взаємодія діапазонів та класів символів не задана, тому патерни виду   або   не мають значення.
 *  : представляє всі символи, які не входять до набір. Сам набір трактується так само, як і в попередньому пункті.

Патерн-вирази
Патерн-виразами можуть бути


 * один вказівник класу виразів, який відповідає одному символу з цього класу;
 * один вказівник класу виразів перед символом ' ', які відповідають 0 або більше повторенням символу з класу. Ці вирази для вказання повторюваних символів завжди відповідають найдовшій можливій послідовності символів;
 * один вказівник класу виразів перед символом ' ', які відповідають 1 або більше повторенням символу з класу. Ці вирази для вказання повторюваних символів завжди відповідають найдовшій можливій послідовності символів;
 * один вказівник класу виразів перед символом ' ',, які відповідають 0 або більше повторенням символу з класу. На відміну від ' ', ці вирази для вказання повторюваних символів завжди відповідають найкоротшій можливій послідовності символів;
 * один вказівник класу виразів перед символом ' ', які відповідають 0 або 1 повторенням символу з класу;
 * , де n є цифрою від 1 до 9; такий вираз відповідає частині рядка рівній n-ому знайденому рядку (див. нижче);
 * , де x та y є двома різними символами; такий вираз відповідає рядку який починається з x, закінчується на y, і де x та y є збалансованими. Це означає що якщо хтось читає рядок зліва направо, додаючи 1 знайшовши x і віднімаючи 1 знайшовши y, то знайдений рядок закінчиться на y в якому рахунок вперше прийме значення 0. Наприклад, вираз  відповідає рядкам зі збалансованими дужками.
 * є патерном країв; такий вираз відповідає порожньому рядку в будь-якій позиції так, що наступний символ належить до набору set, а попередній не належить. Набір set інтерпритується як це було описано вище. Початок та кінець рядка оброблюються так, ніби вони є символом '\0'. Зверніть увагу, що патерни країв були присутніми, але незадокументованими, в Lua 5.1, і були додані офіційно лише до Lua 5.2. Принцип їх роботи в Lua 5.2.1 такий самий як був у 5.1.0.

Патерн
Патерн є послідовністю патерн-виразів.

Символ ' ' на початку патерну позначає шукомий підрядок який знаходиться на початку рядка, в якому відбувається пошук. Символ ' ' в кінці патерну позначає підрядок у кінці. В інших місцях ' ' та ' ' не мають спеціального значення та позначають самі себе.

Групи
Патерн може містити підпатерни у дужках; вони описують групи. Коли за патерном отримується підрядок, його частини, які відповідають групам, зберігаються ("згруповуються") для використання в майбутньому. Групи нумеруються за їхніми лівими відкриваючими дужками. Наприклад, в патерні, частина   зберігається в першій групі (і тому має номер 1); символ що відповідає   зберігається в групі із номером 2, а частина що відповідає послідовності   має номер 3.

Посилання на групи можуть з'являтися в патерні і вони посилаються на текст, який був раніше віднесений до групи в цьому патерні. Наприклад,  відповідає будь-якій парі однакових маленьких літер, а   відповідає будь-якому паліндрому із семи літер.

В якості особливого випадку, порожня група  відповідає поточній позиції в рядку (число). Наприклад, якщо ми використаємо патерн  для рядка , то ми отримаємо дві групи зі значеннями 3 та 5.

Бібліотека table (бібліотека таблиць)
Більшість функцій в бібліотеці table вважають що таблиці є послідовностями.

Функції,   та   доступні, але їх використання є небажаним. Замість них використовуйте цикл for із функцією pairs, цикл for із функцією ipairs або оператор довжини.

table.concat
Отримавши масив в якому всі елементи є текстовими рядками або числами, повертає всі значення від i-го до j-го розділені символом  у вигляді.

Значенням за замовчуванням для  є порожній рядок, для   значенням за замовчуванням є 1, а для   - довжина таблиці.

table.insert
Вставляє елемент  на позицію   в таблиці , зміщуючи всі наступні елементи, якщо потрібно. Для  значенням за замовчуванням є довжина таблиці плюс 1. Таким чином  вставляє   в самий кінець таблиці.

Елементи після  зміщуються; див. Оператор довжини для застережень щодо таблиць які не є послідовностями.

table.maxn
Повертає найбільший додатній числовий індекс таблиці, або нуль якщо в таблиці таких нема.

Щоб зробити це, функція переглядає всі елементи таблиці. Функція приблизно еквівалентна такому коду:

table.remove
Видаляє із таблиці  елемент в позиції , і, якщо потрібно, зміщує наступний елемент на його місце, а наступний після нього на місце попереднього, і так до кінця таблиці. Повертає значення видаленого елемента. Значенням за замовчуванням для  є довжина таблиці, тому   видалить останній елемент таблиці.

Елементи після  зміщуються; див. Оператор довжини для застережень щодо таблиць які не є послідовностями.

table.sort
Сортує елементи таблиці в заданному порядку, перебираючи їх по порядку від  до. Якщо задано, то це має бути функція якій передаються два елементи таблиці і яка повертає логічне значення true якщо перший має передувати другому (так щоб   повертав true після сортування). Якщо  не задано, використовується стандартний оператор порівняння.

Алгоритм сортування не є стабільним; це значить що для елементів які вважатимуться рівними в цьому порядку, відносні позиції можуть помінятися.

Бібліотеки Scribunto
Всі бібліотеки Scribunto розташовані в таблиці.

mw.addWarning
Додає попередження яке показується перед попереднім переглядом редагування. оброблюється як вікірозмітка.

mw.allToString
Перетворює всі аргументи на текстові рядки за допомогою методу tostring, після чого об'єднує їх в один текстовий рядок, де вони розділені символами табуляції в якості розділювача.

mw.clone
Створює глибоку копію аргументу. Всі таблиці (і їхні метатаблиці) створюються з нуля. Функції, однак, все одно є спільними.

mw.getCurrentFrame
Повертає поточний об'єкт frame, зазвичай об'єкт frame із останнього.

mw.incrementExpensiveFunctionCount
Збільшує кількість "ресурсомістких викликів функцій" на одиницю і генерує виняток якщо нове значення перевищує ліміт (див. ).

mw.isSubsting
Повертає логічне значення true якщо поточний  вставляється підстановкою, в іншому випадку повертає false. Див. розділ Повернення тексту вище для пояснення відмінностей між підстановкою і непідстановкою.

mw.loadData
Інколи модуль потребує великих таблиць даних; наприклад, загальновживаний модуль переведення одиниць вимірювання може потребувати великої таблиці одиниць вимірювання та їх коефіцієнтів конвертації. Інколи такі модулі можуть використовуватись багато разів на одній сторінці. Обробка великої таблиці даних для кожного  може зайняти багато часу. Щоб уникнути цієї проблеми існує.

працює так само як, із такими відмінностями:


 * Завантажений модуль обчислюється тільки один раз для кожної сторінки, а не по одному разу для кожного виклику.
 * Завантажений модуль не записується в.
 * Значення повернене із завантаженого модуля повинне бути таблицею. Інші типи даних не підтримуються.
 * Повернені таблиці (і всі підтаблиці) можуть містити тільки bлогічні значення, числа, текстові рядки або інші таблиці. Інші типи даних, зокрема функції, не дозволяються.
 * Повернені таблиці (і всі підтаблиці) не повинні містити метатаблиці.
 * Всі ключі таблиць мають бути логічними значеннями, числами або текстовими рядками.
 * Таблиці повернені функцією  мають метаметоди які надають доступ у режимі "тільки для читання" до таблиць повернених модулем. Оскільки ці таблиці не містять даних напряму, $pairs_function та $ipairs_function працюватимуть, але інші методи, включаючи ,   та функції з Бібліотеки table, працюватимуть некоректно.
 * The loaded module is not recorded in.
 * The value returned from the loaded module must be a table. Other data types are not supported.
 * The returned table (and all subtables) may contain only booleans, numbers, strings, and other tables. Other data types, particularly functions, are not allowed.
 * The returned table (and all subtables) may not have a metatable.
 * All table keys must be booleans, numbers, or strings.
 * The table actually returned by  has metamethods that provide read-only access to the table returned by the module. Since it does not contain the data directly,   and   will work but other methods, including ,  , and the functions in the Table library, will not work correctly.

Гіпотетичний модуль переведення одиниць вимірювання, згаданий вище, може містити свій виконуваний код в "Module:Convert", а дані для його роботи в "Module:Convert/data". Тоді "Module:Convert" використовуватиме  для ефективного завантаження даних.

mw.dumpObject
Серіалізує  у вигляд придатний для читання людиною, після чого повертає результуючий текстовий рядок.

mw.log
Передає аргументи до функції mw.allToString, після чого додає результуючий текстовий рядок до буфера журналу.

В консолі налагодження функція  є ідентичною до цієї.

mw.logObject
Викликає функцію mw.dumpObject та додає результуючий текстовий рядок до буфера журналу. Якщо надано аргумент, він, разом із знаком рівності, буде доданий до буферу журналу перед серіалізованим текстовим рядком (тобто, до журналу буде доданий текст "prefix = object-string").

Об'єкт frame
Об'єкт frame є інтерфейсом для параметрів переданих до  та до його парсера.

Note that there is no frame library, and there is no global variable named. A frame object is typically obtained by being passed as a parameter to the function called by, and can also be obtained from.

frame.args
Таблиця для отримання доступу до аргументів переданих до фрейму. Наприклад, якщо модуль викликається із вікітексту за допомогою коду

то  поверне ,   поверне  , а   (або  ) поверне. Також, є можливим обробити всі аргументи використовуючи функцію  або. However, due to how Lua implements table iterators, iterating over arguments will return them in an unspecified order, and there's no way to know the original order as they appear in wikitext.

Зверніть увагу, що значення в цій таблиці завжди є текстовими рядками;  може за потреби використовуватись для перетворення їх у числа. Ключі, однак, є числами навіть якщо вони прямо вказані у виклику модуля:  передає текстові значення   та   що індексуються числовими значеннями   та.

Як і при включенні шаблонів на сайтах із рушієм MediaWiki, в іменованих аргументах, перед їх передачею до модуля, будуть прибрані пробіли на початку і в кінці, як в назві аргумента, так і в його значенні. При цьому, в неіменованих аргументах пробіли не прибираються.

З міркувань оптимізації,  використовує метатаблицю замість прямого включення аргументів. Значення аргументів запитуються рушієм MediaWiki тільки коли вони потрібні. Це означає що більшість інших методів таблиць працюватимуть некоректно, включаючи,   та функції з бібліотеки table.

Якщо в аргументі включеному до #invoke був використаний препроцесорний синтаксис, такий як включення шаблонів або аргументи в потрійних фігурних дужках, він буде оброблений до передачі в модуль. Якщо деякі спеціальні теги написані в нотації XML, наприклад,  ,   або  , містяться в аргументах що передаються #invoke, вони будуть перетворені на "стріп-маркери — спеціальні текстові рядки які починаються із символа видалення (ASCII 127), які після повернення з #invoke заміняються розміткою HTML.

frame:callParserFunction

 * Зверніть увагу на використання іменованих аргументів.

Call a parser function, returning an appropriate string. Whenever possible, native Lua functions or Scribunto library functions should be preferred to this interface.

The following calls are approximately equivalent to the indicated wikitext:

Note that, as with frame:expandTemplate, the function name and arguments are not preprocessed before being passed to the parser function.

frame:expandTemplate

 * Note the use of named arguments.

This is transclusion. The call

frame:expandTemplate{ title = 'template', args = { 'arg1', 'arg2', name = 'arg3' } }

does roughly the same thing from Lua that  does in wikitext. As in transclusion, if the passed title does not contain a namespace prefix it will be assumed to be in the Template: namespace.

Note that the title and arguments are not preprocessed before being passed into the template:

frame:extensionTag
This is equivalent to a call to frame:callParserFunction with function name  and with   prepended to.

frame:getParent
Called on the frame created by, returns the frame for the page that called. Called on that frame, returns nil.

For instance, if the template  contains the code , and a page transcludes that template and supplies arguments to it , calling   in Module:ModuleName will return.

frame:getTitle
Returns the title associated with the frame as a string. For the frame created by, this is the title of the module invoked.

frame:newChild

 * Note the use of named arguments.

Create a new Frame object that is a child of the current frame, with optional arguments and title.

This is mainly intended for use in the debug console for testing functions that would normally be called by. The number of frames that may be created at any one time is limited.

frame:preprocess
This expands wikitext in the context of the frame, i.e. templates, parser functions, and parameters such as  are expanded. Certain special tags written in XML-style notation, such as,  ,   and  , will be replaced with "strip markers" &mdash; special strings which begin with a delete character (ASCII 127), to be replaced with HTML after they are returned from.

If you are expanding a single template, use  instead of trying to construct a wikitext string to pass to this method. It's faster and less prone to error if the arguments contain pipe characters or other wikimarkup.

If you are expanding a single parser function, use  for the same reasons.

frame:getArgument
Gets an object for the specified argument, or nil if the argument is not provided.

The returned object has one method,, that returns the expanded wikitext for the argument.

frame:newParserValue
Returns an object with one method,, that returns the result of.

frame:newTemplateParserValue

 * Note the use of named arguments.

Returns an object with one method,, that returns the result of   called with the given arguments.

frame:argumentPairs
Same as. Included for backwards compatibility.

mw.hash.hashValue
Hashes a string value with the specified algorithm. Valid algorithms may be fetched using mw.hash.listAlgorithms.

mw.hash.listAlgorithms
Returns a list of supported hashing algorithms, for use in mw.hash.hashValue.

Бібліотека HTML
is a fluent interface for building complex HTML from Lua. A mw.html object can be created using.

Functions documented as  are available on the global   table; functions documented as   and   are methods of an mw.html object (see  ).

A basic example could look like this:

mw.html.create
Creates a new mw.html object containing a  html element. You can also pass an empty string or nil as  in order to create an empty mw.html object.

can be a table with the following keys:


 * : Force the current tag to be self-closing, even if mw.html doesn't recognize it as self-closing
 * : Parent of the current mw.html instance (intended for internal usage)

mw.html:node
Appends a child mw.html node to the current mw.html instance. If a nil parameter is passed, this is a no-op. A node is a string representation of an html element.

mw.html:wikitext
Appends an undetermined number of wikitext strings to the mw.html object.

Note that this stops at the first nil item.

mw.html:newline
Appends a newline to the mw.html object.

mw.html:tag
Appends a new child node with the given  to the builder, and returns a mw.html instance representing that new node. The  parameter is identical to that of

mw.html:attr
Set an HTML attribute with the given  and   on the node. Alternatively a table holding name->value pairs of attributes to set can be passed. In the first form, a value of nil causes any attribute with the given name to be unset if it was previously set.

mw.html:getAttr
Get the value of a html attribute previously set using  with the given.

mw.html:addClass
Adds a class name to the node's class attribute. If a nil parameter is passed, this is a no-op.

mw.html:css
Set a CSS property with the given  and   on the node. Alternatively a table holding name->value pairs of properties to set can be passed. In the first form, a value of nil causes any property with the given name to be unset if it was previously set.

mw.html:cssText
Add some raw  to the node's style attribute. If a nil parameter is passed, this is a no-op.

mw.html:done
Returns the parent node under which the current node was created. Like jQuery.end, this is a convenience function to allow the construction of several child nodes to be chained together into a single statement.

mw.html:allDone
Like, but traverses all the way to the root node of the tree and returns it.

Бібліотека language (бібліотека мов)
Language codes are described at language code. Many of MediaWiki's language codes are similar to IETF language tags, but not all MediaWiki language codes are valid IETF tags or vice versa.

Functions documented as  are available on the global   table; functions documented as   and   are methods of a language object (see   or  ).

mw.language.fetchLanguageName
The full name of the language for the given language code: native name (language autonym) by default, name translated in target language if a value is given for.

mw.language.fetchLanguageNames
Fetch the list of languages known to MediaWiki, returning a table mapping language code to language name.

By default the name returned is the language autonym; passing a language code for  returns all names in that language.

By default, only language names known to MediaWiki are returned; passing  for   will return all available languages (e.g. from ), while passing   will include only languages having customized messages included with MediaWiki core or enabled extensions. To explicitly select the default,  may be passed.

mw.language.getContentLanguage
Returns a new language object for the wiki's default content language.

mw.language.getFallbacksFor


Returns a list of MediaWiki's fallback language codes for the specified code.

mw.language.isKnownLanguageTag
Returns true if a language code is known to MediaWiki.

A language code is "known" if it is a "valid built-in code" (i.e. it returns true for ) and returns a non-empty string for.

mw.language.isSupportedLanguage
Checks whether any localisation is available for that language code in MediaWiki.

A language code is "supported" if it is a "valid" code (returns true for ), contains no uppercase letters, and has a message file in the currently-running version of MediaWiki.

It is possible for a language code to be "supported" but not "known" (i.e. returning true for ). Also note that certain codes are "supported" despite  returning false.

mw.language.isValidBuiltInCode
Returns true if a language code is of a valid form for the purposes of internal customisation of MediaWiki.

The code may not actually correspond to any known language.

A language code is a "valid built-in code" if it is a "valid" code (i.e. it returns true for ); consists of only ASCII letters, numbers, and hyphens; and is at least two characters long.

Note that some codes are "supported" (i.e. returning true from ) even though this function returns false.

mw.language.isValidCode
Returns true if a language code string is of a valid form, whether or not it exists. This includes codes which are used solely for customisation via the MediaWiki namespace.

The code may not actually correspond to any known language.

A language code is valid if it does not contain certain unsafe characters (colons, single- or double-quotes, slashs, backslashs, angle brackets, ampersands, or ASCII NULs) and is otherwise allowed in a page title.

mw.language.new
Creates a new language object. Language objects do not have any publicly accessible properties, but they do have several methods, which are documented below.

There is a limit on the number of distinct language codes that may be used on a page. Exceeding this limit will result in errors.

mw.language:getCode
Returns the language code for this language object.

mw.language:getFallbackLanguages
Returns a list of MediaWiki's fallback language codes for this language object. Equivalent to.

mw.language:isRTL
Returns true if the language is written right-to-left, false if it is written left-to-right.

mw.language:lc
Converts the string to lowercase, honoring any special rules for the given language.

When the Ustring library is loaded, the mw.ustring.lower function is implemented as a call to.

mw.language:lcfirst
Converts the first character of the string to lowercase, as with lang:lc.

mw.language:uc
Converts the string to uppercase, honoring any special rules for the given language.

When the Ustring library is loaded, the mw.ustring.upper function is implemented as a call to.

mw.language:ucfirst
Converts the first character of the string to uppercase, as with lang:uc.

mw.language:caseFold
Converts the string to a representation appropriate for case-insensitive comparison. Note that the result may not make any sense when displayed.

mw.language:formatNum
Formats a number with grouping and decimal separators appropriate for the given language. Given 123456.78, this may produce "123,456.78", "123.456,78", or even something like "١٢٣٬٤٥٦٫٧٨" depending on the language and wiki configuration.

The  is a table of options, which can be:

Digit transformation may still occur, which may include transforming the decimal separator.
 * : Set true to omit grouping separators and use a dot as the decimal separator.

mw.language:formatDate
Formats a date according to the given format string. If  is omitted, the default is the current time. The value for  must be a boolean or nil; if true, the time is formatted in the wiki's local time rather than in UTC.

The format string and supported values for  are identical to those for the #time parser function from. Note however that backslashes may need to be doubled in a Lua string literal, since Lua also uses backslash as an escape character while wikitext does not:

mw.language:formatDuration
Breaks a duration in seconds into more human-readable units, e.g. 12345 to 3 hours, 25 minutes and 45 seconds, returning the result as a string.

, if given, is a table with values naming the interval units to use in the response. These include 'millennia', 'centuries', 'decades', 'years', 'weeks', 'days', 'hours', 'minutes', and 'seconds'.

mw.language:parseFormattedNumber
This takes a number as formatted by lang:formatNum and returns the actual number. In other words, this is basically a language-aware version of.

mw.language:convertPlural
This chooses the appropriate grammatical form from  (which must be a sequence table) or   based on the number. For example, in English you might use  or   to generate grammatically-correct text whether there is only 1 sock or 200 socks.

The necessary values for the sequence are language-dependent, see localization of magic words and translatewiki's FAQ on PLURAL for some details.

mw.language:convertGrammar

 * Note the different parameter order between the two aliases.  matches the order of the method of the same name on MediaWiki's Language object, while   matches the order of the parser function of the same name, documented at Special:MyLanguage/Help:Magic words.

This chooses the appropriate inflected form of  for the given inflection code.

The possible values for  and   are language-dependent, see Special:MyLanguage/Help:Magic words and translatewiki:Grammar for some details.

mw.language:gender
Chooses the string corresponding to the gender of, which may be "male", "female", or a registered user name.

mw.language:getArrow
Returns a Unicode arrow character corresponding to :


 * forwards: Either "→" or "←" depending on the directionality of the language.
 * backwards: Either "←" or "→" depending on the directionality of the language.
 * left: "←"
 * right: "→"
 * up: "↑"
 * down: "↓"

mw.language:getDir
Returns "ltr" or "rtl", depending on the directionality of the language.

mw.language:getDirMark
Returns a string containing either U+200E (the left-to-right mark) or U+200F (the right-to-left mark), depending on the directionality of the language and whether  is a true or false value.

mw.language:getDirMarkEntity
Returns "&amp;lrm;" or "&amp;rlm;", depending on the directionality of the language and whether  is a true or false value.

mw.language:getDurationIntervals
Breaks a duration in seconds into more human-readable units, e.g. 12345 to 3 hours, 25 minutes and 45 seconds, returning the result as a table mapping unit names to numbers.

For example,

, if given, is a table with values naming the interval units to use in the response. These include 'millennia', 'centuries', 'decades', 'years', 'days', 'hours', 'minutes', and 'seconds'.

The unit names in  may be specified in any order (currently in English only, indendantly of the language object used, and with their plural unabbreviated form only like in the returned table, where unit names are symbolic but still not translated and not grammatically changed according to their assigned value). If the input table contains only unsupported unit names, the returned table will be empty. If the input table is not specified, is nil, or is empty, a static table for any supported units (including 'seconds' for the shortest unit) will be used by default.

The specified duration in seconds is first rounded down to an integer number of the shortest desired unit. The number of members in the returned array is variable, and only unit names mapped to a non-zero value are kept in the returned table if the rounded number of seconds is strictly positive. Otherwise only the member for the shortest desired unit name ('seconds' by default) will be set to the rounded down duration.

Бібліотека message (бібліотека повідомлень)
This library is an interface to the localisation messages and the MediaWiki: namespace.

Functions documented as  are available on the global   table; functions documented as   and   are methods of a message object (see  ).

mw.message.new
Creates a new message object for the given message. The remaining parameters are passed to the new object's  method.

The message object has no properties, but has several methods documented below.

mw.message.newFallbackSequence
Creates a new message object for the given messages (the first one that exists will be used).

The message object has no properties, but has several methods documented below.

mw.message.newRawMessage
Creates a new message object, using the given text directly rather than looking up an internationalized message. The remaining parameters are passed to the new object's  method.

The message object has no properties, but has several methods documented below.

mw.message.rawParam
Wraps the value so that it will not be parsed as wikitext by.

mw.message.numParam
Wraps the value so that it will automatically be formatted as by. Note this does not depend on the Language library actually being available.

mw.message.getDefaultLanguage
Returns a Language object for the default language.

mw.message:params
Add parameters to the message, which may be passed as individual arguments or as a sequence table. Parameters must be numbers, strings, or the special values returned by mw.message.numParam or mw.message.rawParam. If a sequence table is used, parameters must be directly present in the table; references using the __index metamethod will not work.

Returns the  object, to allow for call chaining.

mw.message:rawParams
Like params, but has the effect of passing all the parameters through mw.message.rawParam first.

Returns the  object, to allow for call chaining.

mw.message:numParams
Like params, but has the effect of passing all the parameters through mw.message.numParam first.

Returns the  object, to allow for call chaining.

mw.message:inLanguage
Specifies the language to use when processing the message. may be a string or a table with a  method (i.e. a Language object).

The default language is the one returned by.

Returns the  object, to allow for call chaining.

mw.message:useDatabase
Specifies whether to look up messages in the MediaWiki: namespace (i.e. look in the database), or just use the default messages distributed with MediaWiki.

The default is true.

Returns the  object, to allow for call chaining.

mw.message:plain
Substitutes the parameters and returns the message wikitext as-is. Template calls and parser functions are intact.

mw.message:exists
Returns a boolean indicating whether the message key exists.

mw.message:isBlank
Returns a boolean indicating whether the message key has content. Returns true if the message key does not exist or the message is the empty string.

mw.message:isDisabled
Returns a boolean indicating whether the message key is disabled. Returns true if the message key does not exist or if the message is the empty string or the string "-".

mw.site.currentVersion
A string holding the current version of MediaWiki.

mw.site.scriptPath
The value of.

mw.site.server
The value of.

mw.site.siteName
The value of.

mw.site.stylePath
The value of.

mw.site.namespaces
Table holding data for all namespaces, indexed by number.

The data available is:


 * id: Namespace number.
 * name: Local namespace name.
 * canonicalName: Canonical namespace name.
 * displayName: Set on namespace 0, the name to be used for display (since the name is often the empty string).
 * hasSubpages: Whether subpages are enabled for the namespace.
 * hasGenderDistinction: Whether the namespace has different aliases for different genders.
 * isCapitalized: Whether the first letter of pages in the namespace is capitalized.
 * isContent: Whether this is a content namespace.
 * isIncludable: Whether pages in the namespace can be transcluded.
 * isMovable: Whether pages in the namespace can be moved.
 * isSubject: Whether this is a subject namespace.
 * isTalk: Whether this is a talk namespace.
 * defaultContentModel: The default content model for the namespace, as a string.
 * aliases: List of aliases for the namespace.
 * subject: Reference to the corresponding subject namespace's data.
 * talk: Reference to the corresponding talk namespace's data.
 * associated: Reference to the associated namespace's data.

A metatable is also set that allows for looking up namespaces by name (localized or canonical). For example, both  and   will return information about the Project namespace.

mw.site.contentNamespaces
Table holding just the content namespaces, indexed by number. See mw.site.namespaces for details.

mw.site.subjectNamespaces
Table holding just the subject namespaces, indexed by number. See mw.site.namespaces for details.

mw.site.talkNamespaces
Table holding just the talk namespaces, indexed by number. See mw.site.namespaces for details.

mw.site.stats
Table holding site statistics. Available statistics are:


 * pages: Number of pages in the wiki.
 * articles: Number of articles in the wiki.
 * files: Number of files in the wiki.
 * edits: Number of edits in the wiki.
 * users: Number of users in the wiki.
 * activeUsers: Number of active users in the wiki.
 * admins: Number of users in group 'sysop' in the wiki.

mw.site.stats.pagesInCategory


Gets statistics about the category. If  is unspecified, nil, or "*", returns a table with the following properties:


 * all: Total pages, files, and subcategories.
 * subcats: Number of subcategories.
 * files: Number of files.
 * pages: Number of pages.

If  is one of the above keys, just the corresponding value is returned instead.

Each new category queried will increment the expensive function count.

mw.site.stats.pagesInNamespace
Returns the number of pages in the given namespace (specify by number).

mw.site.stats.usersInGroup
Returns the number of users in the given group.

mw.site.interwikiMap
Returns a table holding data about available interwiki prefixes. If  is the string "local", then only data for local interwiki prefixes is returned. If  is the string "!local", then only data for non-local prefixes is returned. If no filter is specified, data for all prefixes is returned. A "local" prefix in this context is one that is for the same project. For example, on the English Wikipedia, other-language Wikipedias are considered local, while Wiktionary and such are not.

Keys in the table returned by this function are interwiki prefixes, and the values are subtables with the following properties:


 * prefix - the interwiki prefix.
 * url - the URL that the interwiki points to. The page name is represented by the parameter $1.
 * isProtocolRelative - a boolean showing whether the URL is protocol-relative.
 * isLocal - whether the URL is for a site in the current project.
 * isCurrentWiki - whether the URL is for the current wiki.
 * isTranscludable - whether pages using this interwiki prefix are transcludable. This requires scary transclusion, which is disabled on Wikimedia wikis.
 * isExtraLanguageLink - whether the interwiki is listed in.
 * displayText - for links listed in $wgExtraInterlanguageLinkPrefixes, this is the display text shown for the interlanguage link. Nil if not specified.
 * tooltip - for links listed in $wgExtraInterlanguageLinkPrefixes, this is the tooltip text shown when users hover over the interlanguage link. Nil if not specified.

Бібліотека text (бібліотека тексту)
The text library provides some common text processing functions missing from the String library and the Ustring library. These functions are safe for use with UTF-8 strings.

mw.text.decode
Replaces HTML entities in the string with the corresponding characters.

If boolean  is omitted or false, the only named entities recognized are '&amp;lt;', '&amp;gt;', '&amp;amp;', '&amp;quot;', and '&amp;nbsp;'. Otherwise, the list of HTML5 named entities to recognize is loaded from PHP's function.

mw.text.encode
Replaces characters in a string with HTML entities. Characters '<', '>', '&', '"', and the non-breaking space are replaced with the appropriate named entities; all others are replaced with numeric entities.

If  is supplied, it should be a string as appropriate to go inside brackets in a Ustring pattern, i.e. the "set" in. The default charset is  (the space at the end is the non-breaking space, U+00A0).

mw.text.jsonDecode
Decodes a JSON string. is 0 or a combination (use ) of the flags   and.

Normally JSON's zero-based arrays are renumbered to Lua one-based sequence tables; to prevent this, pass.

To relax certain requirements in JSON, such as no terminal comma in arrays or objects, pass. This is not recommended.

Limitations:


 * Decoded JSON arrays may not be Lua sequences if the array contains null values.
 * JSON objects will drop keys having null values.
 * It is not possible to directly tell whether the input was a JSON array or a JSON object with sequential integer keys.
 * A JSON object having sequential integer keys beginning with 1 will decode to the same table structure as a JSON array with the same values, despite these not being at all equivalent, unless  is used.

mw.text.jsonEncode
Encode a JSON string. Errors are raised if the passed value cannot be encoded in JSON. is 0 or a combination (use ) of the flags   and.

Normally Lua one-based sequence tables are encoded as JSON zero-based arrays; when  is set in , zero-based sequence tables are encoded as JSON arrays.

Обмеження:


 * Empty tables are always encoded as empty arrays, not empty objects.
 * Sequence tables cannot be encoded as JSON objects without adding a "dummy" element.
 * To produce objects or arrays with nil values, a tricky implementation of the  metamethod is required.
 * A Lua table having sequential integer keys beginning with 0 will encode as a JSON array, the same as a Lua table having integer keys beginning with 1, unless  is used.
 * When both a number and the string representation of that number are used as keys in the same table, behavior is unspecified.

mw.text.killMarkers
Removes all MediaWiki strip markers from a string.

mw.text.listToText
Joins a list, prose-style. In other words, it's like  but with a different separator before the final item.

The default separator is taken from MediaWiki:comma-separator in the wiki's content language, and the default conjunction is MediaWiki:and concatenated with MediaWiki:word-separator.

Examples, using the default values for the messages:

mw.text.nowiki
Replaces various characters in the string with HTML entities to prevent their interpretation as wikitext. This includes:


 * The following characters: '"', '&', "'", '<', '=', '>', '[', ']', '{', '|', '}'
 * The following characters at the start of the string or immediately after a newline: '#', '*', ':', ';', space, tab ('\t')
 * Blank lines will have one of the associated newline or carriage return characters escaped
 * "" at the start of the string or immediately after a newline will have the first '-' escaped
 * "__" will have one underscore escaped
 * "://" will have the colon escaped
 * A whitespace character following "ISBN", "RFC", or "PMID" will be escaped

mw.text.split
Splits the string into substrings at boundaries matching the Ustring pattern. If  is specified and true,   will be interpreted as a literal string rather than as a Lua pattern (just as with the parameter of the same name for  ). Returns a table containing the substrings.

For example,  would return a table.

If  matches the empty string,   will be split into individual characters.

mw.text.gsplit
Returns an iterator function that will iterate over the substrings that would be returned by the equivalent call to.

mw.text.tag

 * Note the use of named arguments.

Generates an HTML-style tag for.

If  is given, it must be a table with string keys. String and number values are used as the value of the attribute; boolean true results in the key being output as an HTML5 valueless parameter; boolean false skips the key entirely; and anything else is an error.

If  is not given (or is nil), only the opening tag is returned. If  is boolean false, a self-closed tag is returned. Otherwise it must be a string or number, in which case that content is enclosed in the constructed opening and closing tag. Note the content is not automatically HTML-encoded; use mw.text.encode if needed.

For properly returning extension tags such as, use frame:extensionTag instead.

mw.text.trim
Remove whitespace or other characters from the beginning and end of a string.

If  is supplied, it should be a string as appropriate to go inside brackets in a Ustring pattern, i.e. the "set" in. The default charset is ASCII whitespace,.

mw.text.truncate
Truncates  to the specified length, adding   if truncation was performed. If length is positive, the end of the string will be truncated; if negative, the beginning will be removed. If  is given and true, the resulting string including ellipsis will not be longer than the specified length.

The default value for  is taken from MediaWiki:ellipsis in the wiki's content language.

Examples, using the default "..." ellipsis:

mw.text.unstripNoWiki
Replaces MediaWiki &lt;nowiki&gt; strip markers with the corresponding text. Other types of strip markers are not changed.

mw.text.unstrip
Equivalent to.

This no longer reveals the HTML behind special page transclusion, &lt;ref&gt; tags, and so on as it did in earlier versions of Scribunto.

mw.title.equals
Test for whether two titles are equal. Note that fragments are ignored in the comparison.

mw.title.compare
Returns -1, 0, or 1 to indicate whether the title  is less than, equal to, or greater than title.

This compares titles by interwiki prefix (if any) as strings, then by namespace number, then by the unprefixed title text as a string. These string comparisons use Lua's standard  operator.

mw.title.getCurrentTitle
Returns the title object for the current page.

mw.title.new


Creates a new title object.

If a number  is given, an object is created for the title with that page_id. The title referenced will be counted as linked from the current page. If the page_id does not exist, returns nil. The expensive function count will be incremented if the title object created is not for a title that has already been loaded.

If a string  is given instead, an object is created for that title (even if the page does not exist). If the text string does not specify a namespace,  (which may be any key found in  ) will be used. If the text is not a valid title, nil is returned.

mw.title.makeTitle
Creates a title object with title  in namespace , optionally with the specified   and   prefix. may be any key found in. If the resulting title is not valid, returns nil.

Note that, unlike, this method will always apply the specified namespace. For example,  will create an object for the page Template:Module:Foo, while   will create an object for the page Module:Foo.

Title objects
A title object has a number of properties and methods. Most of the properties are read-only.

Note that fields ending with  return titles as string values whereas the fields ending with   return title objects.


 * id: The page_id. 0 if the page does not exist..
 * interwiki: The interwiki prefix, or the empty string if none.
 * namespace: The namespace number.
 * fragment: The fragment, or the empty string. May be assigned.
 * nsText: The text of the namespace for the page.
 * subjectNsText: The text of the subject namespace for the page.
 * text: The title of the page, without the namespace or interwiki prefixes.
 * prefixedText: The title of the page, with the namespace and interwiki prefixes.
 * fullText: The title of the page, with the namespace and interwiki prefixes and the fragment. Interwiki is not returned if equal to the current.
 * rootText: If this is a subpage, the title of the root page without prefixes. Otherwise, the same as.
 * baseText: If this is a subpage, the title of the page it is a subpage of without prefixes. Otherwise, the same as.
 * subpageText: If this is a subpage, just the subpage name. Otherwise, the same as.
 * canTalk: Whether the page for this title could have a talk page.
 * exists: Whether the page exists. Alias for file.exists for Media-namespace titles. For File-namespace titles this checks the existence of the file description page, not the file itself..
 * file, fileExists: See below.
 * isContentPage: Whether this title is in a content namespace.
 * isExternal: Whether this title has an interwiki prefix.
 * isLocal: Whether this title is in this project. For example, on the English Wikipedia, any other Wikipedia is considered "local" while Wiktionary and such are not.
 * isRedirect: Whether this is the title for a page that is a redirect..
 * isSpecialPage: Whether this is the title for a possible special page (i.e. a page in the Special: namespace).
 * isSubpage: Whether this title is a subpage of some other title.
 * isTalkPage: Whether this is a title for a talk page.
 * isSubpageOf( title2 ): Whether this title is a subpage of the given title.
 * inNamespace( ns ): Whether this title is in the given namespace. Namespaces may be specified by anything that is a key found in.
 * inNamespaces( ... ): Whether this title is in any of the given namespaces. Namespaces may be specified by anything that is a key found in.
 * hasSubjectNamespace( ns ): Whether this title's subject namespace is in the given namespace. Namespaces may be specified by anything that is a key found in.
 * contentModel: The content model for this title, as a string..
 * basePageTitle: The same as.
 * rootPageTitle: The same as.
 * talkPageTitle: The same as, or nil if this title cannot have a talk page.
 * subjectPageTitle: The same as.
 * redirectTarget: Returns a title object of the target of the redirect page if the page is a redirect and the page exists, returns false otherwise.
 * protectionLevels: The page's protection levels. This is a table with keys corresponding to each action (e.g., "edit" and "move"). The table values are arrays, the first item of which is a string containing the protection level. If the page is unprotected, either the table values or the array items will be nil..
 * cascadingProtection: The cascading protections applicable to the page. This is a table with keys "restrictions" (itself a table with keys like protectionLevels has) and "sources" (an array listing titles where the protections cascade from). If no protections cascade to the page, "restrictions" and "sources" will be empty..
 * subPageTitle( text ): The same as.
 * partialUrl: Returns  encoded as it would be in a URL.
 * fullUrl( query, proto ): Returns the full URL (with optional query table/string) for this title.  may be specified to control the scheme of the resulting url: "http", "https", "relative" (the default), or "canonical".
 * localUrl( query ): Returns the local URL (with optional query table/string) for this title.
 * canonicalUrl( query ): Returns the canonical URL (with optional query table/string) for this title.
 * getContent: Returns the (unparsed) content of the page, or nil if there is no page. The page will be recorded as a transclusion.

Title objects may be compared using relational operators. will return.

Since people find the fact surprising, note that accessing any expensive field on a title object records a "link" to the page (as shown on Special:WhatLinksHere, for example). Using the title object's  method or accessing the   field records it as a "", and accessing the title object's   or   fields records it as a "".

File metadata
Title objects representing a page in the File or Media namespace will have a property called. This is a table, structured as follows:


 * exists: Whether the file exists. It will be recorded as an image usage. The  property on a Title object exists for backwards compatibility reasons and is an alias for this property. If this is false, all other file properties will be nil.
 * width: The width of the file. If the file contains multiple pages, this is the width of the first page.
 * height: The height of the file. If the file contains multiple pages, this is the height of the first page.
 * pages: If the file format supports multiple pages, this is a table containing tables for each page of the file; otherwise, it is nil. The # operator can be used to get the number of pages in the file. Each individual page table contains a width and height property.
 * size: The size of the file in bytes.
 * mimeType: The MIME type of the file.
 * length: The length (duration) of the media file in seconds. Zero for media types which do not support length.

Expensive properties
The properties id, isRedirect, exists, and contentModel require fetching data about the title from the database. For this reason, the expensive function count is incremented the first time one of them is accessed for a page other than the current page. Subsequent accesses of any of these properties for that page will not increment the expensive function count again.

Other properties marked as expensive will always increment the expensive function count the first time they are accessed for a page other than the current page.

mw.uri.encode
Percent-encodes the string. The default type,, encodes spaces using '+' for use in query strings;   encodes spaces as %20; and   encodes spaces as '_'.

Note that the "WIKI" format is not entirely reversible, as both spaces and underscores are encoded as '_'.

mw.uri.decode
Percent-decodes the string. The default type,, decodes '+' to space;   does not perform any extra decoding; and   decodes '_' to space.

mw.uri.anchorEncode
Encodes a string for use in a MediaWiki URI fragment.

mw.uri.buildQueryString
Encodes a table as a URI query string. Keys should be strings; values may be strings or numbers, sequence tables, or boolean false.

mw.uri.parseQueryString
Decodes the query string  to a table. Keys in the string without values will have a value of false; keys repeated multiple times will have sequence tables as values; and others will have strings as values.

The optional numerical arguments  and   can be used to specify a substring of   to be parsed, rather than the entire string. is the position of the first character of the substring, and defaults to 1. is the position of the last character of the substring, and defaults to the length of the string. Both  and   can be negative, as in string.sub.

mw.uri.canonicalUrl
Returns a URI object for the canonical URL for a page, with optional query string/table.

mw.uri.fullUrl
Returns a URI object for the full URL for a page, with optional query string/table.

mw.uri.localUrl
Returns a URI object for the local URL for a page, with optional query string/table.

mw.uri.new
Constructs a new URI object for the passed string or table. See the description of URI objects for the possible fields for the table.

mw.uri.validate
Validates the passed table (or URI object). Returns a boolean indicating whether the table was valid, and on failure a string explaining what problems were found.

URI object
The URI object has the following fields, some or all of which may be nil:


 * protocol: String protocol/scheme
 * user: String user
 * password: String password
 * host: String host name
 * port: Integer port
 * path: String path
 * query: A table, as from mw.uri.parseQueryString
 * fragment: String fragment.

The following properties are also available:
 * userInfo: String user and password
 * hostPort: String host and port
 * authority: String user, password, host, and port
 * queryString: String version of the query table
 * relativePath: String path, query string, and fragment

will give the URI string.

Methods of the URI object are:

mw.uri:parse
Parses a string into the current URI object. Any fields specified in the string will be replaced in the current object; fields not specified will keep their old values.

mw.uri:clone
Makes a copy of the URI object.

mw.uri:extend
Merges the parameters table into the object's query table.

Ustring library
The ustring library is intended to be a direct reimplementation of the standard String library, except that the methods operate on characters in UTF-8 encoded strings rather than bytes.

Most functions will raise an error if the string is not valid UTF-8; exceptions are noted.

mw.ustring.maxPatternLength
The maximum allowed length of a pattern, in bytes.

mw.ustring.maxStringLength
The maximum allowed length of a string, in bytes.

mw.ustring.byte
Returns individual bytes; identical to string.byte.

mw.ustring.byteoffset
Returns the byte offset of a character in the string. The default for both  and   is 1. may be negative, in which case it counts from the end of the string.

The character at  == 1 is the first character starting at or after byte  ; the character at   == 0 is the first character starting at or before byte. Note this may be the same character. Greater or lesser values of  are calculated relative to these.

mw.ustring.char
Much like string.char, except that the integers are Unicode codepoints rather than byte values.

mw.ustring.codepoint
Much like string.byte, except that the return values are codepoints and the offsets are characters rather than bytes.

mw.ustring.find
Much like string.find, except that the pattern is extended as described in Ustring patterns and the  offset is in characters rather than bytes.

mw.ustring.format
Identical to string.format. Widths and precisions for strings are expressed in bytes, not codepoints.

mw.ustring.gcodepoint
Returns three values for iterating over the codepoints in the string. defaults to 1, and  to -1. This is intended for use in the iterator form of :

mw.ustring.gmatch
Much like string.gmatch, except that the pattern is extended as described in Ustring patterns.

mw.ustring.gsub
Much like string.gsub, except that the pattern is extended as described in Ustring patterns.

mw.ustring.isutf8
Returns true if the string is valid UTF-8, false if not.

mw.ustring.len
Returns the length of the string in codepoints, or nil if the string is not valid UTF-8.

See string.len for a similar function that uses byte length rather than codepoints.

mw.ustring.lower
Much like string.lower, except that all characters with lowercase to uppercase definitions in Unicode are converted.

If the Language library is also loaded, this will instead call lc on the default language object.

mw.ustring.match
Much like string.match, except that the pattern is extended as described in Ustring patterns and the  offset is in characters rather than bytes.

mw.ustring.rep
Identical to string.rep.

mw.ustring.sub
Much like string.sub, except that the offsets are characters rather than bytes.

mw.ustring.toNFC
Converts the string to Normalization Form C. Returns nil if the string is not valid UTF-8.

mw.ustring.toNFD
Converts the string to Normalization Form D. Returns nil if the string is not valid UTF-8.

mw.ustring.upper
Much like string.upper, except that all characters with uppercase to lowercase definitions in Unicode are converted.

If the Language library is also loaded, this will instead call uc on the default language object.

Ustring patterns
Patterns in the ustring functions use the same syntax as the String library patterns. The major difference is that the character classes are redefined in terms of Unicode character properties:


 *  : represents all characters with General Category "Letter".
 *  : represents all characters with General Category "Control".
 *  : represents all characters with General Category "Number, decimal digit".
 *  : represents all characters with General Category "Lowercase Letter".
 *  : represents all characters with General Category "Punctuation".
 *  : represents all characters with General Category "Separator", plus tab, linefeed, carriage return, vertical tab, and form feed.
 *  : represents all characters with General Category "Uppercase Letter".
 *  : represents all characters with General Category "Letter" or "Decimal Number".
 *  : adds fullwidth character versions of the hex digits.

Like in String library patterns,  ,  ,  ,  ,  ,  ,    here represent the complementary set ("all characters without given General Category").

In all cases, characters are interpreted as Unicode characters instead of bytes, so ranges such as, patterns such as  , and quantifiers applied to multibyte characters will work correctly. Empty captures will capture the position in code points rather than bytes.

Loadable libraries
These libraries are not included by default, but if needed may be loaded using.

bit32
This emulation of the Lua 5.2  library may be loaded using

bit32 = require( 'bit32' )

The bit32 library provides bitwise operations on unsigned 32-bit integers. Input numbers are truncated to integers (in an unspecified manner) and reduced modulo 232 so the value is in the range 0 to 232−1; return values are also in this range.

When bits are numbered (as in bit32.extract), 0 is the least-significant bit (the one with value 20) and 31 is the most-significant (the one with value 231).

bit32.band
Returns the bitwise AND of its arguments: the result has a bit set only if that bit is set in all of the arguments.

If given zero arguments, the result has all bits set.

bit32.bnot
Returns the bitwise complement of.

bit32.bor
Returns the bitwise OR of its arguments: the result has a bit set if that bit is set in any of the arguments.

If given zero arguments, the result has all bits clear.

bit32.btest
Equivalent to

bit32.bxor
Returns the bitwise XOR of its arguments: the result has a bit set if that bit is set in an odd number of the arguments.

If given zero arguments, the result has all bits clear.

bit32.extract
Extracts  bits from , starting with bit. Accessing bits outside of the range 0 to 31 is an error.

If not specified, the default for  is 1.

bit32.replace
Replaces  bits in , starting with bit  , with the low   bits from. Accessing bits outside of the range 0 to 31 is an error.

If not specified, the default for  is 1.

bit32.lshift
Returns the number  shifted   bits to the left. This is a logical shift: inserted bits are 0. This is generally equivalent to multiplying by 2undefined.

Note that a displacement over 31 will result in 0.

bit32.rshift
Returns the number  shifted   bits to the right. This is a logical shift: inserted bits are 0. This is generally equivalent to dividing by 2undefined.

Note that a displacement over 31 will result in 0.

bit32.arshift
Returns the number  shifted   bits to the right. This is an arithmetic shift: if  is positive, the inserted bits will be the same as bit 31 in the original number.

Note that a displacement over 31 will result in 0 or 4294967295.

bit32.lrotate
Returns the number  rotated   bits to the left.

Note that rotations are equivalent modulo 32: a rotation of 32 is the same as a rotation of 0, 33 is the same as 1, and so on.

bit32.rrotate
Returns the number  rotated   bits to the right.

Note that rotations are equivalent modulo 32: a rotation of 32 is the same as a rotation of 0, 33 is the same as 1, and so on.

libraryUtil
This library contains methods useful when implementing Scribunto libraries. It may be loaded using

libraryUtil = require( 'libraryUtil' )

libraryUtil.checkType
Raises an error if  does not match. In addition, no error will be raised if  is nil and   is true.

is the name of the calling function, and  is the position of the argument in the argument list. These are used in formatting the error message.

libraryUtil.checkTypeMulti
Raises an error if  does not match any of the strings in the array.

This is for arguments that have more than one valid type.

libraryUtil.checkTypeForIndex
Raises an error if  does not match.

This is intended for use in implementing a  metamethod.

libraryUtil.checkTypeForNamedArg
Raises an error if  does not match. In addition, no error will be raised if  is nil and   is true.

This is intended to be used as an equivalent to  in methods called using Lua's "named argument" syntax,.

libraryUtil.makeCheckSelfFunction
This is intended for use in implementing "methods" on object tables that are intended to be called with the  syntax. It returns a function that should be called at the top of these methods with the  argument and the method name, which will raise an error if that   object is not.

This function will generally be used in a library's constructor function, something like this:

luabit
The luabit library modules "bit" and "hex" may be loaded using

bit = require( 'luabit.bit' ) hex = require( 'luabit.hex' )

Note that the bit32 library contains the same operations as "luabit.bit", and the operations in "luabit.hex" may be performed using  and.

The luabit module "noki" is not available, as it is entirely useless in Scribunto. The luabit module "utf8" is also not available, as it was considered redundant to the Ustring library.

ustring
The pure-Lua backend to the Ustring library may be loaded using

ustring = require( 'ustring' )

In all cases the Ustring library should be used instead, as that replaces many of the slower and more memory-intensive operations with callbacks into PHP code.

Extension libraries
Some MediaWiki extensions provide additional Scribunto libraries. These are also located in the table, usually in the table  , however, they are only present when certain extensions are installed (in addition to the Scribunto extension itself).

Such extensions use Scribunto provided hooks:
 * ScribuntoExternalLibraries
 * ScribuntoExternalLibraryPaths

Writing Scribunto libraries provides information on how such libraries can be developed to provide Lua interfaces for MediaWiki extensions.

The following libraries are planned, or are in Gerrit pending review.


 * (none at this time)

mw.wikibase
Wikibase Client provides access to localizable structured data. See Extension:Wikibase Client/Lua. This is supported by Wikidata.

mw.wikibase.lexeme
WikibaseLexeme provides access to Wikibase Lexeme entities. This is supported by Wikidata:Lexicographical data.

mw.wikibase.mediainfo
WikibaseMediaInfo provides access to Wikibase MediaInfo entities. See Extension:WikibaseMediaInfo/Lua. This is supported by Structured Data on Commons. See Commons:Structured data/Lua.

mw.bcmath
BCmath provides arbitrary-precision arithmetic to Lua modules. See BCmath documentation via "LDoc" link at Extension:BCmath.

mw.smw
Semantic Scribunto provides native support for the Scribunto extension to Semantic MediaWiki extension.

mw.ext.data
JsonConfig provides access to localizable tabular and map data. See Extension:JsonConfig/Tabular. Tabular Data and GeoJSON Map Data is supported in Commons "Data:" namespace.

mw.ext.cargo
Cargo provides a means to query its data store from Lua. See Extension:Cargo/Other features.

mw.ext.cattools
CategoryToolbox provides a means to check from Lua if a certain page belongs to a category

mw.ext.FlaggedRevs
FlaggedRevs provides a means to access the stability settings of a page from Lua.

mw.ext.TitleBlacklist
TitleBlacklist provides a means to test and obtain information about blacklisted page naming entries from Lua.

mw.ext.ParserFunctions
ParserFunctions provides a means to evaluate a parser function expressions from Lua.

mw.ext.articlePlaceholder
ArticlePlaceholder provides a means to override default Wikibase renderings from Lua. See Extension:ArticlePlaceholder/Module:AboutTopic.

mw.ext.externalData
ExternalData provides a means to get structured data from Internet from Lua. See Extension:External Data.

mw.ext.seo
WikiSEO provides a means to set SEO Data for the current page. See Extension:WikiSEO.

Changed functions
The following functions have been modified:
 * setfenv
 * getfenv: May not be available, depending on the configuration. If available, attempts to access parent environments will fail.
 * getmetatable: Works on tables only to prevent unauthorized access to parent environments.
 * tostring: Pointer addresses of tables and functions are not provided. This is to make memory corruption vulnerabilities more difficult to exploit.
 * pairs
 * ipairs: Support for the __pairs and __ipairs metamethods (added in Lua 5.2) has been added.
 * pcall
 * xpcall: Certain internal errors cannot be intercepted.
 * require: Can fetch certain built-in modules distributed with Scribunto, as well as modules present in the Module namespace of the wiki. To fetch wiki modules, use the full page name including the namespace. Cannot otherwise access the local filesystem.

Removed functions and packages
The following packages are mostly removed. Only those functions listed are available:
 * package.*: Filesystem and C library access has been removed. Available functions and tables are:
 * package.loaded
 * package.preload
 * package.loaders: Loaders which access the local filesystem or load C libraries are not present. A loader for Module-namespace pages is added.
 * package.seeall


 * os.*: There are some insecure functions in here, such as os.execute, which can't be allowed. Available functions are:
 * os.clock
 * os.date
 * os.difftime
 * os.time


 * debug.*: Most of the functions are insecure. Available functions are:
 * debug.traceback

The following functions and packages are not available:
 * collectgarbage
 * module
 * coroutine.*: No application is known for us, so it has not been reviewed for security.
 * dofile
 * loadfile
 * io.*, file.*: Allows local filesystem access, which is insecure.
 * load
 * loadstring: These were omitted to allow for static analysis of the Lua source code. Also, allowing these would allow Lua code to be added directly to article and template pages, which was not desired for usability reasons.
 * print: This was discussed on wikitech-l and it was decided that it should be omitted in favour of return values, to improve code quality. If necessary, mw.log may be used to output information to the debug console.
 * string.dump: May expose private data from parent environments.

Additional caveats

 * Referential data structures: Circular data structures and data structures where the same node may be reached by more than one path cannot be correctly sent to PHP. Attempting to do so will cause undefined behavior. This includes (but is not limited to) returning such data structures from the module called by  and passing such data structures as parameters to Scribunto library functions that are implemented as callbacks into PHP. Such data structures may be used freely within Lua, including as the return values of modules loaded with.

Writing Scribunto libraries
This information is useful to developers writing additional Scribunto libraries, whether for inclusion in Scribunto itself or for providing an interface for their own extensions.

A Scribunto library will generally consist of five parts:


 * The PHP portion of the library.
 * The Lua portion of the library.
 * The PHP portion of the test cases.
 * The Lua portion of the test cases.
 * The documentation.

Existing libraries serve as a good example.

Library
The PHP portion of the library is a class that must extend. See the documentation for that class for implementation details. In the Scribunto extension, this file should be placed in, and a mapping added to. Other extensions should use the ScribuntoExternalLibraries hook. In either case, the key should match the Lua module name ("mw.name" for libraries in Scribunto, or "mw.ext.name" for extension libraries).

The Lua portion of the library sets up the table containing the functions that can be called from Lua modules. In the Scribunto extension, the file should be placed in. This file should generally include boilerplate something like this:

The module in  (load this with  ) contains some functions that may be helpful.

Be sure to run the Scribunto test cases with your library loaded, even if your library doesn't itself provide any test cases. The standard test cases include tests for things like libraries adding unexpected global variables. Also, if the library is loaded with PHP, any upvalues that its Lua functions have will not be reset between #invoke's. Care must be taken to ensure that modules can't abuse this to transfer information between #invoke's.

Test cases
The Scribunto extension includes a base class for test cases,, which will run the tests against both the LuaSandbox and LuaStandalone engines. The library's test case should extend this class, and should not override. In the Scribunto extension, the test case should be in  and added to the array in   (in  ); extensions should add the test case in their own  hook function, probably conditional on whether   is set.

Most of the time, all that is needed to make the test case is this:

class ClassNameTest extends Scribunto_LuaEngineTestBase { protected static $moduleName = 'ClassNameTest'; function getTestModules { return parent::getTestModules + array(             'ClassNameTest' => __DIR__ . '/ClassNameTests.lua';          ); } }

This will load the file  as if it were the page "Module:ClassNameTests", expecting it to return an object with the following properties:


 * count: Integer, number of tests
 * provide( n ): Function that returns three values:, the name of test  , and a string that is the expected output for test.
 * run( n ): Function that runs test  and returns one string.

If  is declared as shown, "Module:TestFramework" is available which provides many useful helper methods. If this is used,  would look something like this:

local testframework = require 'Module:TestFramework' return testframework.getTestProvider( {    -- Tests go here  } )

Each test is itself a table, with the following properties:


 * name: The name of the test.
 * func: The function to execute.
 * args: Optional table of arguments to pass to the function.
 * expect: Results to expect.
 * type: Optional "type" of the test, default is "Normal".

The type controls the format of  and how   is called. Included types are:


 * Normal:  is a table of return values, or a string if the test should raise an error.   is simply called.
 * Iterator:  is a table of tables of return values.   is called as with an iterated for loop, and each iteration's return values are accumulated.
 * ToString: Like "Normal", except each return value is passed through.

Test cases in another extension
There are (at least) two ways to run PHPUnit tests:

If your extension's test class names all contain a unique component (e.g. the extension's name), the  option may be used to run only your extension's tests.
 * 1) Run phpunit against core, allowing the tests/phpunit/suites/ExtensionsTestSuite.php to find the extension's tests using the  hook.
 * 1) Run phpunit against the extension directory, where it will pick up any file ending in "Test.php".

Either of these will work fine if Scribunto is loaded in LocalSettings.php. And it is easy for method #1 to work if Scribunto is not loaded, as the UnitTestsList hook can easily be written to avoid returning the Scribunto test when  is not set.

But Jenkins uses method #2. For Jenkins to properly run the tests, you will need to add Scribunto as a dependency for your extension. See for an example of how this is done.

If for some reason you need the tests to be able to run using method #2 without Scribunto loaded, one workaround is to add this check to the top of your unit test file:

Documentation
Modules included in Scribunto should include documentation in the Scribunto libraries section above. Extension libraries should include documentation in a subpage of their own extension page, and link to that documentation from the Extension libraries subsection above.

License
This manual is derived from the Lua 5.1 reference manual, which is available under the MIT license.

This derivative manual may also be copied under the terms of the same license.