2.1   Iterators

iter(sequence) returns an iterator of sequence items (a table).

list(iterator) returns a table of items generated by iterator.

reverse(iterator) returns iterator in reverse order.

sort(iterator [, cmp]) returns iterator sorted using cmp (as table.sort)

map(f, ...) applies f to iterators.

zip(...) groups values of the same rank of several iterators.

filter(p, ...) selects values according to the predicate p.

range(i [, j [, s] ]) returns the values of the range [i, j]. s is the step. range(j) is equivalent to range(1, j). The default step is 1.

enum(iterator) generates tuples (i, x[i]) where i is the rank of the value x[i] for each value of iterator.

chain(...) chains several iterators.

3.1   Note about objects

Objects defined in these packages uses closures [1] to store internal data. No self is required and methods are called with a single dot (.), not with a colon (:).

Example:

aes = crypt.AES("my key", 128)
encrypted = aes.encrypt("some text")

3.2   crypt: Cryptographic functions

The crypt package is a pure Lua package (i.e. not really fast).

crypt.hex.encode(data) encodes data in hexa.

crypt.hex.decode(data) decodes the hexa data.

crypt.base64.encode(data) encodes data in base64.

crypt.base64.decode(data) decodes the base64 data.

crypt.crc32(data) computes the CRC32 of data.

crypt.shaXXX(data) computes an SHA digest of data. XXX is 1, 224 or 256.

crypt.AES(password [,keylen [,mode] ]) returns an AES codec. password is the encryption/decryption key, keylen is the length of the key (128 (default), 192 or 256), mode is the encryption/decryption mode ("cbc" (default) or "ecb"). crypt.AES objects have two methods: encrypt(data) and decrypt(data).

crypt.random(bits) returns a string with bits random bits.

3.3   curl: libcurl interface

libcurl is multiprotocol file transfer library. This package is a simple Lua interface to libcurl.

This package is based on Lua-cURL and provides the same API plus a few higher level objects.

This package was introduced before socket which is based on Lua Socket. I recommend using socket instead of curl.

curl.FTP(url [, login, password]) creates an FTP object to connect to the FTP server at url. login and password are optional. Methods are:

• cd(path) changes the current working directory. No connection is made, path is just stored internally for later connections.
• get(path) retrieves path.
• put(path, data) sends and stores the string data to the file path.
• rm(path) deletes the file path.
• mkdir(path) creates the directory path.
• rmdir(path) deletes the directory path.
• list(path) returns an iterator listing the directory path.

FTP connections are made through the cURL easy interface, each request is in fact an entire connection (and deconnection).

curl.HTTP(url) creates an HTTP object to connect to the HTTP server at url. Methods are:

• get(path) retrieves path.
• save(path [, name]) retrieves path and saves it to name. The default value of name is the basename of path.

3.4   fs: File System

fs.getcwd() returns the current working directory.

fs.chdir(path) changes the current directory to path.

fs.listdir([path]) returns the list of files and directories in path (the default path is the current directory).

fs.dir([path]) returns an iterator listing files and directories in path (the default path is the current directory).

fs.walk([path]) returns an iterator listing directory and file names in path and its subdirectories (the default path is the current directory).

fs.mkdir(path) creates a new directory path.

fs.rename(old_name, new_name) renames the file old_name to new_name.

fs.remove(name) deletes the file name.

fs.copy(source_name, target_name) copies file source_name to target_name. The attributes and times are preserved.

fs.stat(name) reads attributes of the file name. Attributes are:

• name: name
• type: "file" or "directory"
• size: size in bytes
• mtime, atime, ctime: modification, access and creation times.
• mode: file permissions
• uR, uW, uX: user Read/Write/eXecute permissions
• gR, gW, gX: group Read/Write/eXecute permissions
• oR, oW, oX: other Read/Write/eXecute permissions

fs.inode(name) reads device and inode attributes of the file name. Attributes are:

• dev, ino: device and inode numbers

fs.chmod(name, other_file_name) sets file name permissions as file other_file_name (string containing the name of another file).

fs.chmod(name, bit1, ..., bitn) sets file name permissions as bit1 or ... or bitn (integers).

fs.touch(name) sets the access time and the modification time of file name with the current time.

fs.touch(name, number) sets the access time and the modification time of file name with number.

fs.touch(name, other_name) sets the access time and the modification time of file name with the times of file other_name.

fs.basename(path) return the last component of path.

fs.dirname(path) return all but the last component of path.

fs.absname(path) return the absolute path name of path.

fs.sep is the directory separator (/ or \).

fs.uR, fs.uW, fs.uX are the User Read/Write/eXecute mask for fs.chmod.

fs.gR, fs.gW, fs.gX are the Group Read/Write/eXecute mask for fs.chmod.

fs.oR, fs.oW, fs.oX are the Other Read/Write/eXecute mask for fs.chmod.

fs.aR, fs.aW, fs.aX are All Read/Write/eXecute mask for fs.chmod.

3.5   z, lzo, qlz, lz4, zlib, ucl, lzma: compression libraries

Compression libraries are based on: - LZO - QuickLZ - LZ4 - ZLIB - UCL - XZ Utils

It's inspired by the Lua Lzo module.

Future versions of BonaLuna may remove or add some compression library.

Currently, only zlib is used in the default BonaLuna distribution but you can change it in setup.

z.compress(data) compresses data using the best compressor and returns the compressed string.

z.decompress(data) decompresses data and returns the decompressed string.

minilzo.compress(data) compresses data with miniLZO and returns the compressed string.

minilzo.decompress(data) decompresses data with miniLZO and returns the decompressed string.

lzo.compress(data) compresses data with LZO and returns the compressed string.

lzo.decompress(data) decompresses data with LZO and returns the decompressed string.

qlz.compress(data) compresses data with QLZ and returns the compressed string.

qlz.decompress(data) decompresses data with QLZ and returns the decompressed string.

lz4.compress(data) compresses data with LZ4 and returns the compressed string.

lz4.decompress(data) decompresses data with LZ4 and returns the decompressed string.

zlib.compress(data) compresses data with ZLIB and returns the compressed string.

zlib.decompress(data) decompresses data with ZLIB and returns the decompressed string.

ucl.compress(data) compresses data with UCL and returns the compressed string.

ucl.decompress(data) decompresses data with UCL and returns the decompressed string.

lzma.compress(data) compresses data with XZ Utils and returns the compressed string.

lzma.decompress(data) decompresses data with XZ Utils and returns the decompressed string.

3.6   ps: Processes

ps.sleep(n) sleeps for n seconds.

3.7   rl: readline

The rl (readline) package was initially inspired by ilua and adapted for BonaLuna.

rl.read(prompt) prints prompt and returns the string entered by the user.

rl.add(line) adds line to the readline history (Linux only).

3.8   socket: Lua Socket (and networking tools)

The socket package is based on Lua Socket and adapted for BonaLuna.

The documentation of Lua Socket is available at the Lua Socket documentation web site.

This package also comes with the following functions.

FTP(url [, login, password]) creates an FTP object to connect to the FTP server at url. login and password are optional. Methods are:

• cd(path) changes the current working directory.
• pwd() returns the current working directory.
• get(path) retrieves path.
• put(path, data) sends and stores the string data to the file path.
• rm(path) deletes the file path.
• mkdir(path) creates the directory path.
• rmdir(path) deletes the directory path.
• list(path) returns an iterator listing the directory path.

3.9   struct: (un)pack structures

The struct package is taken from Library for Converting Data to and from C Structs for Lua 5.1 and adapted for BonaLuna.

struct.pack(fmt, d1, d2, ...) returns a string containing the values d1, d2, etc. packed according to the format string fmt.

struct.unpack(fmt, s, [i]) returns the values packed in string s according to the format string fmt. An optional i marks where in s to start reading (default is 1). After the read values, this function also returns the index in s where it stopped reading, which is also where you should start to read the rest of the string.

struct.size(fmt) returns the size of a string formatted according to the format string fmt. For obvious reasons, the format string cannot contain neither the option s nor the option c0.

3.10   sys: System management

sys.hostname() returns the host name.

sys.domainname() returns the domain name.

sys.hostid() returns the host id.

sys.platform is "Linux" or "Windows"

4.1   pegar.lua parameters

compile:on|off|min turn compilation on, off or on when chunks are smaller than sources (min is the default value)

compress:on|off|min turn compression on, off or on when chunks are smaller than sources (min is the default value)

read:original_interpretor reads the initial interpretor

lua:script.lua adds a script to be executed at runtime

lua:script.lua=realname.lua as above but stored under a different name

str:name=value creates a global variable holding a string

str:name=@filename as above but the string is the content of a file

file:name adds a file to be created at runtime (the file is not overwritten if it already exists)

file:name=realname as above but stored under a different name

dir:name creates a directory at runtime

write:new_executable write a new executable containing the original interpretor and all the added items

When a path starts with :, it is relative to the executable path otherwise it is relative to the current working directory.