README
¶
README for Lua 5.1 See INSTALL for installation instructions. See HISTORY for a summary of changes since the last released version. * What is Lua? ------------ Lua is a powerful, light-weight programming language designed for extending applications. Lua is also frequently used as a general-purpose, stand-alone language. Lua is free software. For complete information, visit Lua's web site at http://www.lua.org/ . For an executive summary, see http://www.lua.org/about.html . Lua has been used in many different projects around the world. For a short list, see http://www.lua.org/uses.html . * Availability ------------ Lua is freely available for both academic and commercial purposes. See COPYRIGHT and http://www.lua.org/license.html for details. Lua can be downloaded at http://www.lua.org/download.html . * Installation ------------ Lua is implemented in pure ANSI C, and compiles unmodified in all known platforms that have an ANSI C compiler. In most Unix-like platforms, simply do "make" with a suitable target. See INSTALL for detailed instructions. * Origin ------ Lua is developed at Lua.org, a laboratory of the Department of Computer Science of PUC-Rio (the Pontifical Catholic University of Rio de Janeiro in Brazil). For more information about the authors, see http://www.lua.org/authors.html . (end of README)
Documentation
¶
Index ¶
- Constants
- func ArgCheck(L *State, cond bool, narg int, extramsg string)
- func ArgError(L *State, narg int, extramsg string) int
- func CallMeta(L *State, obj int, e string) int
- func CheckAny(L *State, narg int)
- func CheckInteger(L *State, narg int) int
- func CheckNumber(L *State, narg int) float64
- func CheckOption(L *State, narg int, def string, lst []string) int
- func CheckString(L *State, narg int) string
- func CheckType(L *State, narg int, t int)
- func CheckUdata(L *State, narg int, tname string) unsafe.Pointer
- func FmtError(L *State, fmt string, args ...interface{}) int
- func GSub(L *State, s string, p string, r string) string
- func GetMetaField(L *State, obj int, e string) bool
- func LGetMetaTable(L *State, tname string)
- func LTypename(L *State, index int) string
- func TypeError(L *State, narg int, tname string) int
- func Unref(L *State, t int, ref int)
- func Where(L *State, lvl int)
- func XMove(from *State, to *State, n int)
- type Alloc
- type GoFunction
- type Reader
- type State
- func (L *State) AtPanic(panicf GoFunction) (oldpanicf GoFunction)
- func (L *State) Call(nargs int, nresults int)
- func (L *State) CheckStack(extra int) bool
- func (L *State) Close()
- func (L *State) Concat(n int)
- func (L *State) CreateTable(narr int, nrec int)
- func (L *State) DoFile(filename string) bool
- func (L *State) DoString(str string) bool
- func (L *State) Dump(writer Writer, data interface{}) int
- func (L *State) Equal(index1, index2 int) bool
- func (L *State) Error() int
- func (L *State) GC(what, data int) int
- func (L *State) GetField(index int, k string)
- func (L *State) GetGlobal(name string)
- func (L *State) GetMetaTable(index int) bool
- func (L *State) GetTable(index int)
- func (L *State) GetTop() int
- func (L *State) GetfEnv(index int)
- func (L *State) GoPCall(fun GoFunction, ud interface{}) int
- func (L *State) Insert(index int)
- func (L *State) IsBoolean(index int) bool
- func (L *State) IsFunction(index int) bool
- func (L *State) IsGoFunction(index int) bool
- func (L *State) IsLightUserdata(index int) bool
- func (L *State) IsNil(index int) bool
- func (L *State) IsNone(index int) bool
- func (L *State) IsNoneOrNil(index int) bool
- func (L *State) IsNumber(index int) bool
- func (L *State) IsString(index int) bool
- func (L *State) IsTable(index int) bool
- func (L *State) IsThread(index int) bool
- func (L *State) IsUserdata(index int) bool
- func (L *State) LessThan(index1, index2 int) bool
- func (L *State) Load(reader Reader, data interface{}, chunkname string) int
- func (L *State) LoadFile(filename string) int
- func (L *State) LoadString(s string) int
- func (L *State) NewMetaTable(tname string) bool
- func (L *State) NewTable()
- func (L *State) NewThread() *State
- func (L *State) NewUserdata(size uintptr) unsafe.Pointer
- func (L *State) Next(index int) int
- func (L *State) ObjLen(index int) uint
- func (L *State) OpenBase()
- func (L *State) OpenIO()
- func (L *State) OpenLibs()
- func (L *State) OpenMath()
- func (L *State) OpenOS()
- func (L *State) OpenPackage()
- func (L *State) OpenString()
- func (L *State) OpenTable()
- func (L *State) OptInteger(narg int, d int) int
- func (L *State) OptNumber(narg int, d float64) float64
- func (L *State) OptString(narg int, d string) string
- func (L *State) PCall(nargs int, nresults int, errfunc int) int
- func (L *State) Pop(n int)
- func (L *State) PushBoolean(b bool)
- func (L *State) PushGoFunction(f GoFunction)
- func (L *State) PushInteger(n int)
- func (L *State) PushLightInteger(n int)
- func (L *State) PushLightUserdata(ud *interface{})
- func (L *State) PushNil()
- func (L *State) PushNumber(n float64)
- func (L *State) PushString(str string)
- func (L *State) PushThread() (isMain bool)
- func (L *State) PushValue(index int)
- func (L *State) RawEqual(index1 int, index2 int) bool
- func (L *State) RawGet(index int)
- func (L *State) RawGeti(index int, n int)
- func (L *State) RawSet(index int)
- func (L *State) RawSeti(index int, n int)
- func (L *State) Ref(t int) int
- func (L *State) Register(name string, f GoFunction)
- func (L *State) Remove(index int)
- func (L *State) Replace(index int)
- func (L *State) Resume(narg int) int
- func (L *State) SetAllocf(f Alloc)
- func (L *State) SetExecutionLimit(instrNumber int)
- func (L *State) SetField(index int, k string)
- func (L *State) SetGlobal(name string)
- func (L *State) SetMetaTable(index int)
- func (L *State) SetTable(index int)
- func (L *State) SetTop(index int)
- func (L *State) SetfEnv(index int)
- func (L *State) Status() int
- func (L *State) ToBoolean(index int) bool
- func (L *State) ToGoFunction(index int) (f GoFunction)
- func (L *State) ToInteger(index int) int
- func (L *State) ToLightInteger(index int) int
- func (L *State) ToNumber(index int) float64
- func (L *State) ToPointer(index int) uintptr
- func (L *State) ToString(index int) string
- func (L *State) ToThread(index int) *State
- func (L *State) ToUserdata(index int) unsafe.Pointer
- func (L *State) Type(index int) int
- func (L *State) Typename(tp int) string
- func (L *State) Yield(nresults int) int
- type Writer
Constants ¶
View Source
const ( LUA_VERSION = C.LUA_VERSION LUA_RELEASE = C.LUA_RELEASE LUA_VERSION_NUM = C.LUA_VERSION_NUM LUA_COPYRIGHT = C.LUA_COPYRIGHT LUA_AUTHORS = C.LUA_AUTHORS LUA_MULTRET = C.LUA_MULTRET LUA_REGISTRYINDEX = C.LUA_REGISTRYINDEX LUA_ENVIRONINDEX = C.LUA_ENVIRONINDEX LUA_GLOBALSINDEX = C.LUA_GLOBALSINDEX LUA_YIELD = C.LUA_YIELD LUA_ERRRUN = C.LUA_ERRRUN LUA_ERRSYNTAX = C.LUA_ERRSYNTAX LUA_ERRMEM = C.LUA_ERRMEM LUA_ERRERR = C.LUA_ERRERR LUA_TNONE = C.LUA_TNONE LUA_TNIL = C.LUA_TNIL LUA_TBOOLEAN = C.LUA_TBOOLEAN LUA_TLIGHTUSERDATA = C.LUA_TLIGHTUSERDATA LUA_TNUMBER = C.LUA_TNUMBER LUA_TSTRING = C.LUA_TSTRING LUA_TTABLE = C.LUA_TTABLE LUA_TFUNCTION = C.LUA_TFUNCTION LUA_TUSERDATA = C.LUA_TUSERDATA LUA_TTHREAD = C.LUA_TTHREAD LUA_MINSTACK = C.LUA_MINSTACK LUA_GCSTOP = C.LUA_GCSTOP LUA_GCRESTART = C.LUA_GCRESTART LUA_GCCOLLECT = C.LUA_GCCOLLECT LUA_GCCOUNT = C.LUA_GCCOUNT LUA_GCCOUNTB = C.LUA_GCCOUNTB LUA_GCSTEP = C.LUA_GCSTEP LUA_GCSETPAUSE = C.LUA_GCSETPAUSE LUA_GCSETSTEPMUL = C.LUA_GCSETSTEPMUL LUA_HOOKCALL = C.LUA_HOOKCALL LUA_HOOKRET = C.LUA_HOOKRET LUA_HOOKLINE = C.LUA_HOOKLINE LUA_HOOKCOUNT = C.LUA_HOOKCOUNT LUA_HOOKTAILRET = C.LUA_HOOKTAILRET LUA_MASKCALL = C.LUA_MASKCALL LUA_MASKRET = C.LUA_MASKRET LUA_MASKLINE = C.LUA_MASKLINE LUA_MASKCOUNT = C.LUA_MASKCOUNT LUA_ERRFILE = C.LUA_ERRFILE LUA_NOREF = C.LUA_NOREF LUA_REFNIL = C.LUA_REFNIL LUA_FILEHANDLE = C.LUA_FILEHANDLE LUA_COLIBNAME = C.LUA_COLIBNAME LUA_TABLIBNAME = C.LUA_TABLIBNAME LUA_IOLIBNAME = C.LUA_IOLIBNAME LUA_OSLIBNAME = C.LUA_OSLIBNAME LUA_STRLIBNAME = C.LUA_STRLIBNAME LUA_MATHLIBNAME = C.LUA_MATHLIBNAME LUA_DBLIBNAME = C.LUA_DBLIBNAME LUA_LOADLIBNAME = C.LUA_LOADLIBNAME )
Variables ¶
This section is empty.
Functions ¶
func CheckInteger ¶
func CheckNumber ¶
func CheckString ¶
func GetMetaField ¶
returns false if no such metatable or no such field
func LGetMetaTable ¶
TODO: rename better... clashes with lua_getmetatable
Types ¶
type GoFunction ¶
type Reader ¶
like lua reader, but the return slice has the size, so does we do not need it to be an out param
type State ¶
type State struct {
// contains filtered or unexported fields
}
wrapper to keep cgo from complaining about incomplete ptr type
func NewStateAlloc ¶
NOTE: lua_newstate becomes NewStateAlloc whereas
luaL_newstate becomes NewState
func (*State) AtPanic ¶
func (L *State) AtPanic(panicf GoFunction) (oldpanicf GoFunction)
func (*State) CheckStack ¶
func (*State) CreateTable ¶
func (*State) GetMetaTable ¶
func (*State) GoPCall ¶
func (L *State) GoPCall(fun GoFunction, ud interface{}) int
CPcall replacement
func (*State) IsFunction ¶
func (*State) IsGoFunction ¶
func (*State) IsLightUserdata ¶
func (*State) IsNoneOrNil ¶
func (*State) IsUserdata ¶
func (*State) LoadString ¶
func (*State) NewMetaTable ¶
returns false if registry already contains key tname
func (*State) OpenPackage ¶
func (L *State) OpenPackage()
func (*State) OpenString ¶
func (L *State) OpenString()
func (*State) PushBoolean ¶
func (*State) PushGoFunction ¶
func (L *State) PushGoFunction(f GoFunction)
func (*State) PushInteger ¶
func (*State) PushLightInteger ¶
func (*State) PushLightUserdata ¶
func (L *State) PushLightUserdata(ud *interface{})
push pointer by value, as a value - we don't impact lifetime
func (*State) PushNumber ¶
func (*State) PushString ¶
func (*State) PushThread ¶
func (*State) Register ¶
func (L *State) Register(name string, f GoFunction)
func (*State) SetExecutionLimit ¶
func (*State) SetMetaTable ¶
func (*State) ToGoFunction ¶
func (L *State) ToGoFunction(index int) (f GoFunction)
func (*State) ToLightInteger ¶
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.