Package com.prineside.luaj.lib

Class StringLib

java.lang.Object

com.prineside.luaj.Varargs

com.prineside.luaj.LuaValue

com.prineside.luaj.LuaFunction

com.prineside.luaj.lib.LibFunction

com.prineside.luaj.lib.TwoArgFunction

com.prineside.luaj.lib.StringLib

All Implemented Interfaces:

com.esotericsoftware.kryo.KryoSerializable

Direct Known Subclasses:

JseStringLib

public class StringLib
extends TwoArgFunction

Subclass of LibFunction which implements the lua standard string library.

Typically, this library is included as part of a call to either

 
 Globals globals = JsePlatform.standardGlobals();
 System.out.println( globals.get("string").get("upper").call( LuaValue.valueOf("abcde") ) );
  

To instantiate and use it directly, link it into your globals table via LuaValue.load(LuaValue) using code such as:

 
 Globals globals = new Globals();
 globals.load(new JseBaseLib());
 globals.load(new PackageLib());
 globals.load(new JseStringLib());
 System.out.println( globals.get("string").get("upper").call( LuaValue.valueOf("abcde") ) );
  

This is a direct port of the corresponding library in C.

See Also:

• LibFunction
• Lua 5.2 String Lib Reference

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	StringLib._byte	string.byte (s [, i [, j]]) Returns the internal numerical codes of the characters s[i], s[i+1], ..., s[j].
static final class	StringLib._char	string.char (...) Receives zero or more integers.
static final class	StringLib.contains
static final class	StringLib.dump	string.dump (function[, stripDebug]) Returns a string containing a binary representation of the given function, so that a later loadstring on this string returns a copy of the function.
static final class	StringLib.endsWith
static final class	StringLib.find	string.find (s, pattern [, init [, plain]]) Looks for the first match of pattern in the string s.
static final class	StringLib.format	string.format (formatstring, ...) Returns a formatted version of its variable number of arguments following the description given in its first argument (which must be a string).
static final class	StringLib.gmatch	string.gmatch (s, pattern) Returns an iterator function that, each time it is called, returns the next captures from pattern over string s.
static final class	StringLib.gsub	string.gsub (s, pattern, repl [, n]) Returns a copy of s in which all (or the first n, if given) occurrences of the pattern have been replaced by a replacement string specified by repl, which may be a string, a table, or a function.
static final class	StringLib.len	string.len (s) Receives a string and returns its length.
static final class	StringLib.lower	string.lower (s) Receives a string and returns a copy of this string with all uppercase letters changed to lowercase.
static final class	StringLib.match	string.match (s, pattern [, init]) Looks for the first match of pattern in the string s.
static final class	StringLib.rep	string.rep (s, n) Returns a string that is the concatenation of n copies of the string s.
static final class	StringLib.replace
static final class	StringLib.replaceAll
static final class	StringLib.reverse	string.reverse (s) Returns a string that is the string s reversed.
static final class	StringLib.split
static final class	StringLib.startsWith
static final class	StringLib.sub	string.sub (s, i [, j]) Returns the substring of s that starts at i and continues until j; i and j may be negative.
static final class	StringLib.trim
static final class	StringLib.upper	string.upper (s) Receives a string and returns a copy of this string with all lowercase letters changed to uppercase.

Nested classes/interfaces inherited from class com.prineside.luaj.LuaValue

LuaValue.NillableSerializer, LuaValue.None

Nested classes/interfaces inherited from class com.prineside.luaj.Varargs

Varargs.ArrayVarargs

Field Summary

Fields inherited from class com.prineside.luaj.LuaFunction

s_metatable

Fields inherited from class com.prineside.luaj.LuaValue

ADD, CALL, CONCAT, DIV, EMPTYSTRING, ENV, EQ, FALSE, INDEX, LE, LEN, LT, METATABLE, MINUSONE, MOD, MODE, MUL, NEWINDEX, NIL, NILLABLE_SERIALIZER, NILS, NONE, NOVALS, ONE, POW, SUB, TBOOLEAN, TFUNCTION, TINT, TLIGHTUSERDATA, TNIL, TNONE, TNUMBER, TOSTRING, TRUE, TSTRING, TTABLE, TTHREAD, TUSERDATA, TVALUE, TYPE_NAMES, UNM, ZERO

Constructor Summary

Constructors

Constructor	Description
StringLib()	Construct a StringLib, which can be initialized by calling it with a modname string, and a global environment table as arguments using call(LuaValue, LuaValue).

Method Summary

Modifier and Type	Method	Description
LuaValue	call(LuaValue modname, LuaValue env)	Perform one-time initialization on the library by creating a table containing the library functions, adding that table to the supplied environment, adding the table to package.loaded, and returning table as the return value.

Methods inherited from class com.prineside.luaj.lib.TwoArgFunction

call, call, call, invoke

Methods inherited from class com.prineside.luaj.lib.LibFunction

call, read, tojstring, write

Methods inherited from class com.prineside.luaj.LuaFunction

checkfunction, classnamestub, getmetatable, isfunction, name, optfunction, strvalue, type, typename

Methods inherited from class com.prineside.luaj.LuaValue

add, add, add, and, arg, arg1, argerror, assert_, buffer, call, cBool, cDouble, cFloat, checkboolean, checkclosure, checkdouble, checkglobals, checkint, checkjstring, checklong, checknotnil, checknumber, checknumber, checkstring, checktable, checkthread, checkuserdata, checkuserdata, cInt, cNcDouble, cNcFloat, cNcInt, cObject, comparemt, concat, concat, concatmt, concatTo, concatTo, concatTo, cRegObject, cVarargs, cVarargs, cVarargs, cVarargs, cVarargs, cVarargs, cVarargs, cVarargs, div, div, div, divInto, eq, eq_b, eqmtcall, equals, error, get, get, get, gt, gt, gt, gt_b, gt_b, gt_b, gteq, gteq, gteq, gteq_b, gteq_b, gteq_b, inext, initupvalue1, invoke, invoke, invoke, invokemethod, invokemethod, invokemethod, invokemethod, isboolean, isclosure, isint, isinttype, islong, isnil, isnumber, isRegObject, isstring, istable, isthread, isuserdata, isuserdata, isvalidkey, len, length, listOf, listOf, load, lt, lt, lt, lt_b, lt_b, lt_b, lteq, lteq, lteq, lteq_b, lteq_b, lteq_b, markAsConst, metatag, method, method, method, method, method, method, mod, mod, mod, modFrom, mul, mul, mul, narg, neg, neq, neq_b, next, not, onInvoke, optboolean, optclosure, optdouble, optint, optjstring, optlong, optnumber, optstring, opttable, optthread, optuserdata, optuserdata, optvalue, or, pow, pow, pow, powWith, powWith, presize, raweq, raweq, raweq, raweq, raweq, rawget, rawget, rawget, rawlen, rawset, rawset, rawset, rawset, rawset, rawset, rawset, rawsetlist, set, set, set, set, set, set, set, setmetatable, strcmp, strcmp, strongvalue, sub, sub, sub, subargs, subFrom, subFrom, tableOf, tableOf, tableOf, tableOf, tableOf, tableOf, tailcallOf, testfor_b, toboolean, tobyte, tochar, todouble, tofloat, toint, tolong, tonumber, toshort, tostring, toString, touserdata, touserdata, userdataOf, userdataOf, valueOf, valueOf, valueOf, valueOf, valueOf, valueOf

Methods inherited from class com.prineside.luaj.Varargs

argcheck, checkboolean, checkclosure, checkdouble, checkfunction, checkint, checkjstring, checklong, checknotnil, checknumber, checkstring, checktable, checkthread, checkuserdata, checkuserdata, checkvalue, dealias, eval, isfunction, isnil, isnoneornil, isnumber, isstring, istable, isTailcall, isthread, isuserdata, isvalue, optboolean, optclosure, optdouble, optfunction, optint, optjstring, optlong, optnumber, optstring, opttable, optthread, optuserdata, optuserdata, optvalue, toboolean, tobyte, tochar, todouble, tofloat, toint, tojstring, tolong, toshort, touserdata, touserdata, type

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

StringLib

public StringLib()

Construct a StringLib, which can be initialized by calling it with a modname string, and a global environment table as arguments using call(LuaValue, LuaValue).

Method Details

call

public LuaValue call(LuaValue modname,
 LuaValue env)

Perform one-time initialization on the library by creating a table containing the library functions, adding that table to the supplied environment, adding the table to package.loaded, and returning table as the return value. Creates a metatable that uses __INDEX to fall back on itself to support string method operations. If the shared strings metatable instance is null, will set the metatable as the global shared metatable for strings.

All tables and metatables are read-write by default so if this will be used in a server environment, sandboxing should be used. In particular, the LuaString.s_metatable table should probably be made read-only.

Specified by:

call in class TwoArgFunction

Parameters:

modname - the module name supplied if this is loaded via 'require'.

env - the environment to load into, typically a Globals instance.

Returns:

First return value (this(arg1,arg2)), or LuaValue.NIL if there were none.

See Also:

• LuaValue.call()
• LuaValue.call(LuaValue)
• LuaValue.call(LuaValue, LuaValue, LuaValue)
• LuaValue.invoke(LuaValue, Varargs)
• LuaValue.method(String,LuaValue,LuaValue)
• LuaValue.method(LuaValue,LuaValue,LuaValue)