Lua => Создание и использование модулей

замечания

Основной шаблон для написания модуля - заполнить таблицу ключами, которые являются именами функций и значениями, которые являются самими функциями. Затем модуль возвращает эту функцию для вызова кода, который require и использует. (Функции являются первоклассными значениями в Lua, поэтому хранение функции в таблице является простым и обычным.) Таблица также может содержать любые важные константы в форме, скажем, строк или чисел.

Написание модуля

--- trim: a string-trimming module for Lua
-- Author, date, perhaps a nice license too
--
-- The code here is taken or adapted from  material in
-- Programming in Lua, 3rd ed., Roberto Ierusalimschy

-- trim_all(string) => return string with white space trimmed on both sides 
local trim_all = function (s)
  return (string.gsub(s, "^%s*(.-)%s*$", "%1"))
end

-- trim_left(string) => return string with white space trimmed on left side only
local trim_left = function (s)
  return (string.gsub(s, "^%s*(.*)$", "%1"))
end

-- trim_right(string) => return string with white space trimmed on right side only
local trim_right = function (s)
  return (string.gsub(s, "^(.-)%s*$", "%1"))
end

-- Return a table containing the functions created by this module
return {
  trim_all = trim_all,
  trim_left = trim_left,
  trim_right = trim_right
}

Альтернативный подход к приведенному выше - создать таблицу верхнего уровня, а затем сохранить функции непосредственно в ней. В этом идиоме наш модуль выше будет выглядеть так:

-- A conventional name for the table that will hold our functions
local M = {}

-- M.trim_all(string) => return string with white space trimmed on both sides
function M.trim_all(s)
  return (string.gsub(s, "^%s*(.-)%s*$", "%1"))
end

-- M.trim_left(string) => return string with white space trimmed on left side only
function M.trim_left(s)
  return (string.gsub(s, "^%s*(.*)$", "%1"))
end

-- trim_right(string) => return string with white space trimmed on right side only
function M.trim_right(s)
  return (string.gsub(s, "^(.-)%s*$", "%1"))
end


return M

С точки зрения звонящего, между этими двумя стилями мало различий. (Один из достоинств, о котором стоит упомянуть, заключается в том, что первый стиль усложняет пользователям возможность обезвреживать модуль. Это либо pro, либо con, в зависимости от вашей точки зрения. Подробнее об этом см. В этом блоге Энрике Гарсиа Cota.)

Использование модуля

-- The following assumes that trim module is installed or in the caller's package.path,
-- which is a built-in variable that Lua uses to determine where to look for modules.
local trim = require "trim"

local msg = "    Hello, world!      "
local cleaned = trim.trim_all(msg)
local cleaned_right = trim.trim_right(msg)
local cleaned_left = trim.trim_left(msg)

-- It's also easy to alias functions to shorter names.
local trimr = trim.trim_right
local triml = trim.trim_left

Modified text is an extract of the original Stack Overflow Documentation

Лицензировано согласно CC BY-SA 3.0

Не связан с Stack Overflow

Lua
Создание и использование модулей

Поиск…

замечания

Написание модуля

Использование модуля