--load FILE
argument to command-line
launchereach
to work with raw iterator values (#201)--check-unused-locals
This release introduces docstrings as well as several new features to the macro system and some breaking changes; the most significant being the new unquote syntax and the requirement of auto-gensym for identifiers in backtick.
doc
for displaying them
in repl:detect-cycles? false
in fennelview to turn off
"#<table 1>" outputx#
syntax for auto-gensym inside backticklambda
arity checks when using
destructuring:one-line
output in fennelviewinclude
special form to selectively inline modules
in compiled output--require-as-include
to inline required modules in
compiled output--eval
argument to command-line launcherFENNEL_PATH
to
path
match
?
in pattern
matchingreadline.lua
is
available--globals
and --globals-only
options
to launcher scriptluaexpr
and
luastatement
for a single lua
specialif
expressions in many
situations#
special with length
@
(unquote) with ,
; comma is
no longer whitespace~
in symbols other than
~=
hashfn
and #
reader macro for
shorthand functions like #(+ $1 $2)
macro
to make defining a single macro easier(comment)
special which emits a Lua comment in the
generated source(foo:bar baz)
;
disallow :
in symbolsThis release mostly contains small bug fixes.
not=
as an alias for ~=
in-scope?
which caused
match
outer unification to fail~=
comparisonsThe second minor release introduces backtick, making macro authoring much more streamlined. Macros may now be defined in the same file, and pattern matching is added.
macros
--add-package-path
and
--add-fennel-path
to launcher script-?>
and -?>>
macros@
(later changed to ,
)match
macro for pattern matchingThis release contains a few small bug fixes.
The first real release sees the addition of several "creature comfort" improvements such as comments, iterator support, line number tracking, accidental global protection, pretty printing, and repl locals. It also introduces the name "Fennel".
defn
macrodoto
macro->
and ->>
macrospack
,
$
, block
, *break
,
special
.
formvar
; disallow regular locals from being setglobal
; refuse to set globals without it&
require-macros
//
for integer division on Lua 5.3+fennel.dofile
and fennel.searcher
for
require
supportpartial
local
:
for method callseach
lambda
/λ
for arity-checked
functionswhen
The initial version (named "fnl") was created in 8 days and then set aside for several years.
These are all the special forms recognized by the Fennel compiler. It does not include built-in Lua functions; see the Lua reference manual or the Lua primer for that.
Remember that Fennel relies completely on Lua for its runtime. Everything Fennel does happens at compile-time, so you will need to familiarize yourself with Lua's standard library functions. Thankfully it's much smaller than almost any other language.
Fennel source code should be UTF-8-encoded text.
fn
functionCreates a function which binds the arguments given inside the square
brackets. Will accept any number of arguments; ones in excess of the
declared ones are ignored, and if not enough arguments are supplied to
cover the declared ones, the remaining ones are nil
.
Example:
fn pxy [x y] (print (+ x y))) (
Giving it a name is optional; if one is provided it will be bound to it as a local. Even if you don't use it as an anonymous function, providing a name will cause your stack traces to be more readable, so it's recommended. Providing a name that's a table field will cause it to be inserted in a table instead of bound as a local.
lambda
/λ
arity-checked functionCreates a function like fn
does, but throws an error at
runtime if any of the listed arguments are nil, unless its identifier
begins with ?
.
Example:
lambda [x ?y z] (print (- x (* (or ?y 1) z)))) (
The λ
form is an alias for lambda
and
behaves identically.
(Since 0.3.0)
Both the fn
and lambda
/λ
forms
of function definition accept an optional docstring.
fn pxy [x y] "Print the sum of x and y" (print (+ x y)))
(λ pxyz [x ?y z]
("Print the sum of x, y, and z. If y is not provided, defaults to 0."
print (+ x (or ?y 0) z))) (
These are ignored by default outside of the REPL, unless metadata is
enabled from the CLI (---metadata
) or compiler options
{useMetadata=true}
, in which case they are stored in a
metadata table along with the arglist, enabling viewing function docs
via the doc
macro.
>> (doc pxy)
(pxy x y)
Print the sum of x and y
All function metadata will be garbage collected along with the
function itself. Docstrings and other metadata can also be accessed via
functions on the fennel API with fennel.metadata
.
(Since 0.3.0)
It's pretty easy to create function literals, but Fennel provides an even shorter form of functions. Hash functions are anonymous functions of one form, with implicitly named arguments. All of the below functions are functionally equivalent.
fn [a b] (+ a b)) (
hashfn (+ $1 $2)) (
#(+ $1 $2)
This style of anonymous function is useful as a parameter to higher order functions, such as those provided by Lua libraries like lume and luafun.
The current implementation only allows for functions of up to 9
arguments, each named $1
through $9
. A lone
$
in a hash function is treated as an alias for
$1
.
Hash functions are defined with the hashfn
macro, which
wraps it's single argument in a function literal. For example,
#$3
is a function that returns it's third argument.
#[$1 $2 $3]
is a function that returns a table from the
first 3 arguments. And so on.
Hash arguments can also be used as parts of multisyms. For instance,
#$.foo
is a function which will return the value of the
"foo" key in its first argument.
partial
partial
applicationReturns a new function which works like its first argument, but fills the first few arguments in place with the given ones. This is related to currying but different because calling it will call the underlying function instead of waiting till it has the "correct" number of args.
Example:
partial (fn [x y] (print (+ x y))) 2) (
This example returns a function which will print a number that is 2 greater than the argument it is passed.
let
scoped localsIntroduces a new scope in which a given set of local bindings are used.
Example:
let [x 89] (print (+ x 12)) ; => 101 (
These locals cannot be changed with set
but they can be
shadowed by an inner let
or local
. Outside the
body of the let
, the bindings it introduces are no longer
visible.
Any time you bind a local, you can destructure it if the value is a table or a function call which returns multiple values:
Example:
let [[a b c] [1 2 3]] (+ a b c)) ; => 6 (
Example:
let [(x y z) (unpack [10 9 8])] (+ x y z)) ; => 27 (
Example:
let [{:msg message : val} (returns-a-table)] (print message) val) (
local
declare localIntroduces a new local inside an existing scope. Similar to
let
but without a body argument. Recommended for use at the
top-level of a file for locals which will be used throughout the
file.
Example:
local tau-approx 6.28318) (
Supports destructuring and multiple-value binding.
match
pattern matchingEvaluates its first argument, then searches thru the subsequent pattern/body clauses to find one where the pattern matches the value, and evaluates the corresponding body. Pattern matching can be thought of as a combination of destructuring and conditionals.
Example:
match mytable
(59 :will-never-match-hopefully
9 q 5] (print :q q)
[1 a b] (+ a b)) [
In the example above, we have a mytable
value followed
by three pattern/body clauses. The first clause will only match if
mytable
is 59. The second clause will match if
mytable
is a table with 9 as its first element and 5 as its
third element; if it matches, then it evaluates
(print :q q)
with q
bound to the second
element of mytable
. The final clause will only match if
mytable
has 1 as its first element; if so then it will add
up the second and third elements.
Patterns can be tables, literal values, or symbols. If a symbol has already been bound, then the value is checked against the existing local's value, but if it's a new local then the symbol is bound to the value.
Tables can be nested, and they may be either sequential
([]
style) or key/value ({}
style) tables.
Sequential tables will match if they have at least as many elements as
the pattern. (To allow an element to be nil, use a symbol like
?this
.) Tables will never fail to match due to having too
many elements.
match mytable
(* b depth)
{:subtable [a b ?c] :depth depth} ( _ :unknown)
You can also match against multiple return values using parentheses. (These cannot be nested, but they can contain tables.) This can be useful for error checking.
match (io.open "/some/file")
(
(nil msg) (report-error msg) f (read-file f))
Pattern matching performs unification, meaning that if x
has an existing binding, clauses which attempt to bind it to a different
value will not match:
let [x 95]
(match [52 85 95]
(; because a=85 and a=95
[b a a] :no ; because x=95 and x=52
[x y z] :no ; a and b are fresh values while x=95 and x=95 [a b x] :yes))
There is a special case for _
; it is never bound and
always acts as a wildcard. If no clause matches, it returns nil.
Sometimes you need to match on something more general than a structure or specific value. In these cases you can use guard clauses:
match [91 12 53]
(= 5 a)) :will-not-match
([a b c] ? (= 0 (math.fmod (+ a b c) 2)) (= 91 a)) c) ; -> 53 ([a b c] ? (
In this case the pattern should be wrapped in parens (like when
matching against multiple values) but the second thing in the parens is
the ?
symbol. Each form following this marker is a
condition; all the conditions must evaluate to true for that pattern to
match.
(Note that Lua also has "patterns" which are matched against strings similar to how regular expressions work in other languages; these are two distinct concepts with similar names.)
global
set global
variableSets a global variable to a new value. Note that there is no distinction between introducing a new global and changing the value of an existing one.
Example:
global prettyprint (fn [x] (print (view x)))) (
Supports destructuring and multiple-value binding.
var
declare local
variableIntroduces a new local inside an existing scope which may have its
value changed. Identical to local
apart from allowing
set
to work on it.
Example:
var x 83) (
Supports destructuring and multiple-value binding.
set
set
local variable or table fieldChanges the value of a variable introduced with var
.
Will not work on globals or let
/local
-bound
locals. Can also be used to change a field of a table, even if the table
is bound with let
or local
, provided the field
is given at compile-time.
Example:
set x (+ x 91)) (
Example:
let [t {:a 4 :b 8}] (set t.a 2) t) ; => {:a 2 :b 8} (
Supports destructuring and multiple-value binding.
tset
set table fieldSet the field of a given table to a new value. The field name does
not need to be known at compile-time. Works on any table, even those
bound with local
and let
.
Example:
let [tbl {:d 32} field :d] (tset tbl field 19) tbl) ; => {:d 19} (
You can provide multiple successive field names to perform nested sets.
In any of the above contexts where you can make a new binding, you can use multiple value binding. Otherwise you will only capture the first value.
Example:
let [x (values 1 2 3)] x) ; => 1 (
Example:
let [(file-handle message code) (io.open "foo.blah")] message) ; => "foo.blah: No such file or directory" (
Example:
global (x-m x-e) (math.frexp 21)), {:m x-m :e m-e} ; => {:e 5 :m 0.65625} (
Example:
do (local (_ _ z) (unpack [:a :b :c :d :e])), z) => c (
if
conditionalChecks a condition and evaluates a corresponding body. Accepts any
number of condition/body pairs; if an odd number of arguments is given,
the last value is treated as a catch-all "else". Similar to
cond
in other lisps.
Example:
let [x (math.random 64)]
(if (= 0 (% x 10))
("multiple of ten"
= 0 (% x 2))
("even"
"I dunno, something else"))
All values other than nil or false are treated as true.
when
single
side-effecting conditionalTakes a single condition and evaluates the rest as a body if it's not nil or false. This is intended for side-effects.
Example:
when launch-missiles?
(
(power-on)
(open-doors) (fire))
each
general iterationRun the body once for each value provided by the iterator. Commonly
used with ipairs
(for sequential tables) or
pairs
(for any table in undefined order) but can be used
with any iterator.
Example:
each [key value (pairs mytbl)]
(print key (f value))) (
Most iterators return two values, but each
will bind any
number.
for
numeric loopCounts a number from a start to stop point (inclusive), evaluating the body once for each value. Accepts an optional step.
Example:
for [i 1 10 2]
(print i)) (
This example will print all odd numbers under ten.
do
evaluate multiple forms returning last valueAccepts any number of forms and evaluates all of them in order,
returning the last value. This is used for inserting side-effects into a
form which accepts only a single value, such as in a body of an
if
when multiple clauses make it so you can't use
when
. Some lisps call this begin
or
progn
.
if launch-missiles?
(do
(
(power-on)
(open-doors)
(fire))
false-alarm? (promote lt-petrov))
and
, or
, not
boolean+
, -
, *
, /
,
//
, %
, ^
arithmetic>
, <
, >=
,
<=
, =
, not=
comparisonThese all work as you would expect, with a few caveats.
//
for integer division is only available in Lua 5.3 and
onward.
They all take any number of arguments, as long as that number is
fixed at compile-time. For instance, (= 2 2 (unpack [2 5]))
will evaluate to true
because the compile-time number of
values being compared is 3.
Note that these are all special forms which cannot be used as higher-order functions.
..
string concatenationConcatenates its arguments into one string. Will coerce numbers into strings, but not other types.
Example:
"Hello" " " "world" 7 "!!!") ; => "Hello world7!!!" (..
length
string or
table length(Changed in 0.3.0: the function was called #
before.)
Returns the length of a string or table. Note that the length of a
table with gaps in it is undefined; it can return a number corresponding
to any of the table's "boundary" positions between nil and non-nil
values. If a table has nils and you want to know the last consecutive
numeric index starting at 1, you must calculate it yourself with
ipairs
; if you want to know the maximum numeric key in a
table with nils, you can use table.maxn
.
Example:
+ (length [1 2 3 nil 8]) (length "abc")) ; => 6 or 8 (
.
table lookupLooks up a given key in a table. Multiple arguments will perform nested lookup.
Example:
(. mytbl myfield)
Example:
let [t {:a [2 3 4]}] (. t :a 2)) ; => 3 (
Note that if the field name is known at compile time, you don't need
this and can just use mytbl.field
.
:
method callLooks up a function in a table and calls it with the table as its first argument. This is a common idiom in many Lua APIs, including some built-in ones.
(Since 0.3.0) Just like Lua, you can perform a method call
by calling a function name where :
separates the table
variable and method name.
Example:
let [f (assert (io.open "hello" "w"))]
("world")
(f:write (f:close))
If the name of the method isn't known at compile time, you can use
:
followed by the table and then the method's name as a
string.
Example:
let [f (assert (io.open "hello" "w"))
(
method1 :write
method2 :close]: f method1 "world")
(: f method2)) (
Both of these examples are equivalent to the following:
let [f (assert (io.open "hello" "w"))]
("world")
(f.write f (f.close f))
values
multi-valued
returnReturns multiple values from a function. Usually used to signal failure by returning nil followed by a message.
Example:
fn [filename]
(if (valid-file-name? filename)
(
(open-file filename)values nil (.. "Invalid filename: " filename)))) (
while
good old while
loopLoops over a body until a condition is met. Uses a native Lua while loop, so is preferable to a lambda function and tail recursion.
Example:
do
(var done? false)
(while (not done?)
(print :not-done)
(when (> (math.random) 0.95)
(set done? true)))) (
->
,
->>
, -?>
and -?>>
threading macrosThe ->
macro takes its first value and splices it
into the second form as the first argument. The result of evaluating the
second form gets spliced into the first argument of the third form, and
so on.
Example:
-> 52
(+ 91 2) ; (+ 52 91 2)
(- 8) ; (- (+ 52 91 2) 8)
(print "is the answer")) ; (print (- (+ 52 91 2) 8) "is the answer") (
The ->>
macro works the same, except it splices it
into the last position of each form instead of the first.
-?>
and -?>>
, the thread maybe
macros, are similar to ->
& ->>
but they also do checking after the evaluation of each threaded form. If
the result is false or nil then the threading stops and the result is
returned. -?>
splices the threaded value as the first
argument, like ->
, and -?>>
splices
it into the last position, like ->>
.
This example shows how to use them to avoid accidentally indexing a nil value:
-?> {:a {:b {:c 42}}}
(
(. :a)
(. :missing); -> nil
(. :c)) -?>> :a
(
(. {:a :b})
(. {:b :missing})42})) ; -> nil (. {:c
Note that these have nothing to do with "threads" used for
concurrency; they are named after the thread which is used in sewing.
This is similar to the way that |>
works in OCaml and
Elixir.
doto
Similarly, the doto
macro splices the first value into
subsequent forms. However, it keeps the same value and continually
splices the same thing in rather than using the value from the previous
form for the next form.
doto (io.open "/tmp/err.log)
( (: :write contents)
(: :close))
;; equivalent to:
(let [x (io.open "/tmp/err.log")]
(: x :write contents)
(: x :close)
x)
The first form becomes the return value for the whole expression, and subsequent forms are evaluated solely for side-effects.
require-macros
Requires a module at compile-time and binds its fields locally as macros.
Macros currently must be defined in separate modules. A macro module
exports any number of functions which take code forms as arguments at
compile time and emit lists which are fed back into the compiler. For
instance, here is a macro function which implements when2
in terms of if
and do
:
fn when2 [condition body1 ...]
(assert body1 "expected body")
(if ,condition
`(do ,body1 ,...)))
(
{:when2 when2}
A full explanation of how macros work is out of scope for this
document, but you can think of it as a compile-time template function.
The backtick on the third line creates a template for the code emitted
by the macro. The ,
serves as "unquote" which splices
values into the template. (Changed in 0.3.0: @
was used
instead of ,
before.)
Assuming the code above is in the file "my-macros.fnl" then it turns this input:
require-macros :my-macros)
(
= 3 (+ 2 a))
(when2 (print "yes")
( (finish-calculation))
and transforms it into this code at compile time by splicing the arguments into the backtick template:
if (= 3 (+ 2 a))
(do
(print "yes")
( (finish-calculation)))
See "Compiler API" below for details about additional functions visible inside compiler scope which macros run in.
Note that the macro interface is still preliminary and is subject to change over time.
macros
(Since 0.3.0)
Defines a table of macros local to the current fennel file. Note that inside the macro definitions, you cannot access variables and bindings from the surrounding code. The macros are essentially compiled in their own compiler environment. Again, see the "Compiler API" section for more details about the macro interface.
macros {:my-max (fn [x y]
(let [x# ,x y# ,y]
`(if (< x# y#) y# x#)))})
(
print (my-max 10 20))
(print (my-max 20 10))
(print (my-max 20 20)) (
It's easy to make macros which accidentally evaluate their arguments more than once. This is fine if they are passed literal values, but if they are passed a form which has side-effects, the result will be unexpected:
var v 1)
(macros {:my-max (fn [x y]
(if (< ,x ,y) ,y ,x))})
`(
fn f [] (set v (+ v 1)) v)
(
print (my-max (f) 2)) ; -> 3 since (f) is called twice in the macro body above (
(Since 0.3.0) In order to prevent accidental symbol
capture2,
you may not bind a bare symbol inside a backtick as an identifier.
Appending a #
on the end of the identifier name as above
invokes "auto gensym" which guarantees the local name is unique.
macros {:my-max (fn [x y]
(let [x2 ,x y2 ,y]
`(if (< x2 y2) y2 x2)))})
(
print (my-max 10 20))
(; Compile error in 'x2' unknown:?: macro tried to bind x2 without gensym; try x2# instead
macros
is useful for one-off, quick macros, or even some
more complicated macros, but be careful. It may be tempting to try and
use some function you have previously defined, but if you need such
functionality, you should probably use require-macros
.
For example, this will not compile in strict mode! Even when it does
allow the macro to be called, it will fail trying to call a global
my-fn
when the code is run:
fn my-fn [] (print "hi!"))
(
macros {:my-max (fn [x y]
(
(my-fn)let [x# ,x y# ,y]
`(if (< x# y#) y# x#)))})
(; Compile error in 'my-max': attempt to call global '__fnl_global__my_2dfn' (a nil value)
include
(since 0.3.0)
include :my.embedded.module) (
Load Fennel/Lua module code at compile time and embed it, along with any modules it requires, etc., in the compiled output. The module name must be a string literal that can resolve to a module during compilation. The bundled code will be wrapped in a function invocation in the emitted Lua.
See also: the requireAsInclude
option in the API
documentation and the --require-as-include
CLI flag
(fennel --help
)
eval-compiler
Evaluate a block of code during compile-time with access to compiler scope. This gives you a superset of the features you can get with macros, but you should use macros if you can.
Example:
eval-compiler
(tset _SPECIALS "local" (. _SPECIALS "global"))) (
Inside eval-compiler
, macros
, or
macro
blocks, as well as require-macros
modules, these functions are visible to your code.
Note that lists are compile-time concepts that don't exist at
runtime; they are implemented as regular tables which have a special
metatable to distinguish them from regular tables defined with square or
curly brackets. Similarly symbols are tables with a string entry for
their name and a metatable that the compiler uses to distinguish them.
You can use tostring
to get the name of a symbol.
list
- return a list, which is a special kind of table
used for codesym
- turn a string into a symbollist?
- is the argument a list?sym?
- is the argument a symbol?table?
- is the argument a non-list table?sequence?
- is the argument a non-list
sequential table (created with []
, as opposed to
{}
)?gensym
- generates a unique symbol for use in
macros.varg?
- is this a ...
symbol which
indicates var args?multi-sym?
- a multi-sym is a dotted symbol which
refers to a table's fieldin-scope?
- does this symbol refer to a local in the
current scope?Note that other internals of the compiler exposed in compiler scope are subject to change.
The fennel
module provides the following functions for
use when embedding Fennel in a Lua program. If you're writing a pure
Fennel program or working on a system that already has Fennel support,
you probably don't need this.
Any time a function takes an options
table argument,
that table will usually accept these fields:
allowedGlobals
: a sequential table of strings of the
names of globals which the compiler will allow references to.correlate
: when this is truthy, Fennel attempts to emit
Lua where the line numbers match up with the Fennel input code; useful
for situation where code that isn't under your control will print the
stack traces.useMetadata
(since 0.3.0): enables or disables
metadata, allowing use
of the doc macro. Intended for development purposes (see performance note); defaults to
true for REPL only.requireAsInclude
(since 0.3.0): Alias any
static require
calls to the include
special,
embedding the module code inline in the compiled output. If the module
name isn't a string literal or resolvable at compile time, falls back to
require
at runtime. Can be used to embed both fennel and
Lua modules.env
: an environment table in which to run the code; see
the Lua manual..repl([options]) fennel
Takes these additional options:
readChunk()
: a function that when called, returns a
string of source code. The empty is string is used as the end of source
marker.pp
: a pretty-printer function to apply on values.onValues(values)
: a function that will be called on all
returned top level values.onError(errType, err, luaSource)
: a function that will
be called on each error. errType
is a string with the type
of error, can be either, 'parse', 'compile', 'runtime', or 'lua'.
err
is the error message, and luaSource
is the
source of the generated lua code.The pretty-printer defaults to loading fennelview.fnl
if
present and falls back to tostring
otherwise.
fennelview.fnl
will produce output that can be fed back
into Fennel (other than functions, coroutines, etc) but you can use a
3rd-party pretty-printer that produces output in Lua format if you
prefer.
If you don't provide allowedGlobals
then it defaults to
being all the globals in the environment under which the code will run.
Passing in false
here will disable global checking
entirely.
By default, metadata will be enabled and you can view function
signatures and docstrings with the doc
macro from the
REPL.
local result = fennel.eval(str[, options[, ...]])
The options
table may also contain:
filename
: override the filename that Lua thinks the
code came from.Additional arguments beyond options
are passed to the
code and available as ...
.
local result = fennel.dofile(filename[, options[, ...]])
table.insert(package.loaders or package.searchers, fennel.searcher)
local mylib = require("mylib") -- will compile and load code in mylib.fnl
Normally Lua's require
function only loads modules
written in Lua, but you can install fennel.searcher
into
package.searchers
(or in Lua 5.1
package.loaders
) to teach it how to load Fennel code.
If you would rather change some of the options
you can
use fennel.makeSearcher
to override env
,
correlate
, etc.
The require
function is different from
fennel.dofile
in that it searches the directories in
fennel.path
for .fnl
files matching the module
name, and also in that it caches the loaded value to return on
subsequent calls, while fennel.dofile
will reload each
time. The behavior of fennel.path
mirrors that of Lua's
package.path
.
If you install Fennel into package.searchers
then you
can use the 3rd-party lume.hotswap function to
reload modules that have been loaded with require
.
local lua = fennel.compileString(str[, options])
Accepts indent
as a string in options
causing output to be indented using that string, which should contain
only whitespace if provided. Unlike the other functions, the
compile
functions default to performing no global checks,
though you can pass in an allowedGlobals
table in
options
to enable it.
local lua = fennel.compileStream(strm[, options])
Accepts indent
in options
as per above.
The code can be loaded via dostring or other methods. Will error on bad input.
local lua = fennel.compile(ast[, options])
Accepts indent
in options
as per above.
local stream = fennel.stringStream(str)
Useful for the REPL or reading files in chunks. This will NOT insert newlines or other whitespace between chunks, so be careful when using with io.read(). Returns a second function, clearstream, which will clear the current buffered chunk when called. Useful for implementing a repl.
local bytestream, clearstream = fennel.granulate(chunks)
Valuestream gets the next top level value parsed. Returns true in the first return value if a value was read, and returns nil if and end of file was reached without error. Will error on bad input or unexpected end of source.
local valuestream = fennel.parser(strm)
local ok, value = valuestream()
-- Or use in a for loop
for ok, value in valuestream do
print(ok, value)
end
(Since 0.3.0)
When running a REPL or using compile/eval with metadata enabled, each
function declared with fn
or λ/lambda
will use
the created function as a key on fennel.metadata
to store
the function's arglist and (if provided) docstring. The metadata table
is weakly-referenced by key, so each function's metadata will be garbage
collected along with the function itself.
You can work with the API to view or modify this metadata yourself,
or use the doc
macro from fennel to view function
documentation.
In addition to direct access to the metadata tables, you can use the following methods:
fennel.metadata:get(func, key)
: get a value from a
function's metadatafennel.metadata:set(func, key, val)
: set a metadata
valuefennel.metadata:setall(func, key1, val1, key2, val2, ...)
:
set pairsfennel.doc(func, fnName)
: print formatted documentation
for function using name. Utilized by the doc
macro, name is
whatever symbol you operate on that's bound to the function.= fennel.eval([[
greet (λ greet [name] "Say hello" (print (string.format "Hello, %s!" name)))
]], {useMetadata = true})
-- fennel.metadata[greet]
-- > {"fnl/docstring" = "Say hello", "fnl/arglist" = ["name"]}
-- works because greet was set globally above for example purposes only
.eval("(doc greet)", { useMetadata = true })
fennel-- > (greet name)
-- > Say hello
.metadata:set(greet, "fnl/docstring", "Say hello!!!")
fennel.doc(greet, "greet!")
fennel--> (greet! name)
--> Say hello!!!
Enabling metadata in the compiler/eval/REPL will cause every function to store a new table containing the function's arglist and docstring in the metadata table, weakly referenced by the function itself as a key.
This may have a performance impact in some applications due to the extra allocations and garbage collection associated with dynamic function creation. The impact hasn't been benchmarked, and may be minimal particularly in luajit, but enabling metadata is currently recommended for development purposes only to minimize overhead.