-
-
Notifications
You must be signed in to change notification settings - Fork 99
STD to Penlight Migration
Simon Cozens edited this page Jan 3, 2020
·
2 revisions
Up until v0.9.5.1, SILE used the std
lua package for inheritance, object modelling, tree cloning and so on. After that build, we moved to penlight
(pl
). If you are used to the std
ways to do things, here is what you need to do to upgrade your code to penlight.
- For deep cloning structures, instead of
std.tree.clone
, usepl.tablex.deepcopy
. - For shallow cloning structures, instead of
std.table.clone
, usepl.tablex.copy
. - To add a table to a table, instead of our hacked
table.append
, usepl.tablex.insertvalues
. - To count the number of items in a table (as opposed to the highest index in the table), instead of our
table.nitems
, use the penlight builtinpl.tablex.size
. - To find the numerically highest key in a table, use
math.max(table.unpack(pl.tablex.keys(items)))
- To reverse a table in place, our old
table.flip
has been replaced bySU.flip_in_place
. - To turn a table into a string (for hashability or debugging), instead of
std.string.pickle(t)
, usepl.pretty.write(t, '')
.
To create a new base class:
local objectRepresentingClass = pl.class({
_init = function (self, stuff) ... end,
method = function (self, stuff) .. end
})
local instance = objectRepresentingClass(initialisationParameters)
Note that unlike std
, the object representing a class is not itself an instance: it is a true class, not a prototype object. Hence you need to instantiate it with objectRepresentingClass()
before calling methods.
Overloads such as __tostring
, __add
etc. work as normal.
To create a new class with inheritance:
local objectRepresentingClass = pl.class({
_base = objectRepresentingBaseClass,
...
})
prototype
/is_a
/type
(Should be later reflected in the documentation.)
- To instantiate a length, you can say:
l = SILE.length({ length = 1, stretch = 2, shrink = 3 })
-- or
l = SILE.length(1) -- stretch = 0, shrink = 0
-- or
l = SILE.length("1 plus 2 minus 3")
new
, make
and parse
(which essentially did the same thing) will soon be deprecated.
- Names of types in settings (
SILE.settings.declare({ type = "xxx", ...})
) are now all lower-case. -
pageTarget
has been renamedgetTargetLength