Description:
Several common useful Lua functions
-FileId:
-$Id$
-
License:
Copyright 2008 Steven Barth <steven@midlink.org>
local ldebug = require "luci.debug"
local string = require "string"
local coroutine = require "coroutine"
+local tparser = require "luci.template.parser"
local getmetatable, setmetatable = getmetatable, setmetatable
local rawget, rawset, unpack = rawget, rawset, unpack
local tostring, type, assert = tostring, type, assert
-local ipairs, pairs, loadstring = ipairs, pairs, loadstring
+local ipairs, pairs, next, loadstring = ipairs, pairs, next, loadstring
local require, pcall, xpcall = require, pcall, xpcall
+local collectgarbage, get_memory_limit = collectgarbage, get_memory_limit
--- LuCI utility functions.
module "luci.util"
if not b then
return a
elseif type(b) == "table" then
+ for k, _ in pairs(b) do if type(b[k]) == "userdata" then b[k] = tostring(b[k]) end end
return a:format(unpack(b))
else
+ if type(b) == "userdata" then b = tostring(b) end
return a:format(b)
end
end
-- Scope manipulation routines
--
---- Create a new or get an already existing thread local store associated with
--- the current active coroutine. A thread local store is private a table object
--- whose values can't be accessed from outside of the running coroutine.
--- @return Table value representing the corresponding thread local store
-function threadlocal()
- local tbl = {}
-
- local function get(self, key)
- local c = coroutine.running()
- local thread = coxpt[c] or c or 0
- if not rawget(self, thread) then
- return nil
- end
- return rawget(self, thread)[key]
- end
+local tl_meta = {
+ __mode = "k",
+
+ __index = function(self, key)
+ local t = rawget(self, coxpt[coroutine.running()]
+ or coroutine.running() or 0)
+ return t and t[key]
+ end,
- local function set(self, key, value)
- local c = coroutine.running()
- local thread = coxpt[c] or c or 0
- if not rawget(self, thread) then
- rawset(self, thread, {})
+ __newindex = function(self, key, value)
+ local c = coxpt[coroutine.running()] or coroutine.running() or 0
+ if not rawget(self, c) then
+ rawset(self, c, { [key] = value })
+ else
+ rawget(self, c)[key] = value
end
- rawget(self, thread)[key] = value
end
+}
- setmetatable(tbl, {__index = get, __newindex = set, __mode = "k"})
-
- return tbl
+--- Create a new or get an already existing thread local store associated with
+-- the current active coroutine. A thread local store is private a table object
+-- whose values can't be accessed from outside of the running coroutine.
+-- @return Table value representing the corresponding thread local store
+function threadlocal(tbl)
+ return setmetatable(tbl or {}, tl_meta)
end
-- String and data manipulation routines
--
---- Escapes all occurrences of the given character in given string.
--- @param s String value containing unescaped characters
--- @param c String value with character to escape (optional, defaults to "\")
--- @return String value with each occurrence of character escaped with "\"
-function escape(s, c)
- c = c or "\\"
- return s:gsub(c, "\\" .. c)
-end
-
--- Create valid XML PCDATA from given string.
-- @param value String value containing the data to escape
-- @return String value containing the escaped data
function pcdata(value)
- return value and tostring(value):gsub("[&\"'<>]", {
- ["&"] = "&",
- ['"'] = """,
- ["'"] = "'",
- ["<"] = "<",
- [">"] = ">"
- })
+ return value and tparser.pcdata(tostring(value))
end
--- Strip HTML tags from given string.
-- @param value String containing the HTML text
-- @return String with HTML tags stripped of
-function striptags(s)
- return pcdata(s:gsub("</?[A-Za-z][A-Za-z0-9:_%-]*[^>]*>", " "):gsub("%s+", " "))
+function striptags(value)
+ return value and tparser.striptags(tostring(value))
end
--- Splits given string on a defined separator sequence and return a table
return (str:gsub("^%s*(.-)%s*$", "%1"))
end
+--- Count the occurences of given substring in given string.
+-- @param str String to search in
+-- @param pattern String containing pattern to find
+-- @return Number of found occurences
+function cmatch(str, pat)
+ local count = 0
+ for _ in str:gmatch(pat) do count = count + 1 end
+ return count
+end
+
+--- Return a matching iterator for the given value. The iterator will return
+-- one token per invocation, the tokens are separated by whitespace. If the
+-- input value is a table, it is transformed into a string first. A nil value
+-- will result in a valid interator which aborts with the first invocation.
+-- @param val The value to scan (table, string or nil)
+-- @return Iterator which returns one token per call
+function imatch(v)
+ if type(v) == "table" then
+ local k = nil
+ return function()
+ k = next(v, k)
+ return v[k]
+ end
+
+ elseif type(v) == "number" or type(v) == "boolean" then
+ local x = true
+ return function()
+ if x then
+ x = false
+ return tostring(v)
+ end
+ end
+
+ elseif type(v) == "userdata" or type(v) == "string" then
+ return tostring(v):gmatch("%S+")
+ end
+
+ return function() end
+end
+
--- Parse certain units from the given string and return the canonical integer
-- value or 0 if the unit is unknown. Upper- or lower case is irrelevant.
-- Recognized units are:
return val
end
+-- also register functions above in the central string class for convenience
+string.pcdata = pcdata
+string.striptags = striptags
+string.split = split
+string.trim = trim
+string.cmatch = cmatch
+string.parse_units = parse_units
+
+
--- Appends numerically indexed tables or single objects to a given table.
-- @param src Target table
-- @param ... Objects to insert
code = string.dump( loadstring( "return " .. serialize_data(val) ) )
end
- return code and strip_bytecode(code)
+ return code -- and strip_bytecode(code)
end
--- Strips unnescessary lua bytecode from given string. Information like line
end
end
- local strip_function
- strip_function = function(code)
+ local function strip_function(code)
local count, offset = subint(code, 1, size)
- local stripped, dirty = string.rep("\0", size), offset + count
+ local stripped = { string.rep("\0", size) }
+ local dirty = offset + count
offset = offset + count + int * 2 + 4
offset = offset + int + subint(code, offset, int) * ins
count, offset = subint(code, offset, int)
end
end
count, offset = subint(code, offset, int)
- stripped = stripped .. code:sub(dirty, offset - 1)
+ stripped[#stripped+1] = code:sub(dirty, offset - 1)
for n = 1, count do
local proto, off = strip_function(code:sub(offset, -1))
- stripped, offset = stripped .. proto, offset + off - 1
+ stripped[#stripped+1] = proto
+ offset = offset + off - 1
end
offset = offset + subint(code, offset, int) * int + int
count, offset = subint(code, offset, int)
for n = 1, count do
offset = offset + subint(code, offset, size) + size
end
- stripped = stripped .. string.rep("\0", int * 3)
- return stripped, offset
+ stripped[#stripped+1] = string.rep("\0", int * 3)
+ return table.concat(stripped), offset
end
return code:sub(1,12) .. strip_function(code:sub(13,-1))
function _sortiter( t, f )
local keys = { }
+ local k, v
for k, v in pairs(t) do
keys[#keys+1] = k
end
return function()
_pos = _pos + 1
if _pos <= #keys then
- return keys[_pos], t[keys[_pos]]
+ return keys[_pos], t[keys[_pos]], _pos
end
end
end
--- Returns the absolute path to LuCI base directory.
-- @return String containing the directory path
function libpath()
- return require "luci.fs".dirname(ldebug.__file__)
+ return require "nixio.fs".dirname(ldebug.__file__)
end
if not status then
return false, err(debug.traceback(co, (...)), ...)
end
- if coroutine.status(co) == 'suspended' then
- return performResume(err, co, coroutine.yield(...))
- else
+
+ if coroutine.status(co) ~= 'suspended' then
return true, ...
end
+
+ return performResume(err, co, coroutine.yield(...))
end
-- Resume execution of protected function call
projects / project / luci.git / blobdiff