Doc: closure example

doc/Expr.adoc

@@ -720,6 +720,15 @@ IMPORTANT: If the left variable is NOT defined, the right expression is not eval
 `>>>` [blue]`var` +
 [green]`3`
 
+`>>>` [blue]`x ?! 5` +
+[green]`nil`
+
+`>>>` [blue]`x=1; x ?! 5` +
+[green]`5`
+
+`>>>` [blue]`y ?! (c=5); c` +
+[red]`Eval Error: undefined variable or function "c"`
+
 NOTE: These operators have a high priority, in particular higher than the operator [blue]`=`.
 
 == Priorities of operators
@@ -734,9 +743,10 @@ The table below shows all supported operators by decreasing priorities.
 | [blue]`[`...`]` | _Postfix_ | _Dict item_ | _dict_ `[` _any_ `]` -> _any_
 .2+|*INC*| [blue]`++` | _Postfix_ | _Post increment_| _integer-variable_ `++` -> _integer_
 | [blue]`++` | _Postfix_ | _Next item_ | _iterator_ `++` -> _any_
-.2+|*DEFAULT*| [blue]`??` | _Infix_ | _Default value_| _variable_ `??` _any-expr_ -> _any_
+.3+|*DEFAULT*| [blue]`??` | _Infix_ | _Default value_| _variable_ `??` _any-expr_ -> _any_
 | [blue]`?=` | _Infix_ | _Default/assign value_| _variable_ `?=` _any-expr_ -> _any_
-.1+| *ITER*^1^| [blue]`()` | _Prefix_ | _Iterator value_ | `()` _iterator_ -> _any_
+| [blue]`?!` | _Infix_ | _Alternate value_| _variable_ `?!` _any-expr_ -> _any_
+//.1+| *ITER*^1^| [blue]`()` | _Prefix_ | _Iterator value_ | `()` _iterator_ -> _any_
 .1+|*FACT*| [blue]`!` | _Postfix_ | _Factorial_| _integer_ `!` -> _integer_
 .3+|*SIGN*| [blue]`+`, [blue]`-` | _Prefix_ | _Change-sign_| (`+`\|`-`) _number_ -> _number_
 | [blue]`#` | _Prefix_ | _Lenght-of_ | `#` _collection_ -> _integer_
@@ -775,7 +785,7 @@ The table below shows all supported operators by decreasing priorities.
 .1+|*RANGE*| [blue]`:` | _Infix_ | _Index-range_ | _integer_ `:` _integer_ -> _integer-pair_
 |===
 
-^1^ Experimental
+//^1^ Experimental
 
 
 == Functions
@@ -786,25 +796,122 @@ Functions in _Expr_ are very similar to functions available in many programming
 
 
 === _Expr_ function definition
-A function is identified and referenced by its name. It can have zero or more parameter. _Expr_ functions also support optional parameters.
+A function is identified and referenced by its name. It can have zero or more parameter. _Expr_ functions also support optional parameters and passing paramters by name.
 
 .Expr's function definition syntax
 ====
-*_function-definition_* = _identifier_ "**=**"  "**func(**" [_param-list_] "**)**"  "**{**" _multi-expression_ "**}**" +
-_param_list_ = _required-param-list_ [ "**,**" _optional-param-list_ ] +
+*_function-definition_* = _identifier_ "**=**"  "**func(**" [_formal-param-list_] "**)**"  "**{**" _multi-expression_ "**}**" +
+_formal-param_list_ = _required-param-list_ [ "**,**" _optional-param-list_ ] +
 _required-param-list_ = _identifier_ { "**,**" _identifier_ } +
 _optional-param-list_ = _optional-parm_ { "**,**" _optional-param_ } +
-_optional-param_ = _identifier_ "**=**" _any-expr_
+_optional-param_ = _param-name_ "**=**" _any-expr_ +
+_param-name_ = _identifier_
 ====
 
 .Examples
-#TODO#
+`>>>` [gray]_// A simple function: it takes two parameters and returns their "sum"_**^(*)^** +
+`>>>` [blue]`sum = func(a, b){ a + b }` +
+[green]`sum(a, b):any{}`
+
+^(\*)^ Since the plus, *+*, operator is defined for multiple data-types, the _sum()_ function can be used for any pair of that types.
+
+`>>>` [gray]_// A more complex example: recursive calculation of the n-th value of Fibonacci's sequence_ +
+`>>>` [blue]`fib = func(n){ n ? [0] {0}: [1] {1} :: {fib(n-1)+fib(n-2)} }` +
+[green]`fib(n):any{}`
+
+
+`>>>` [gray]_// Same function fib() but entered by splitting it over mulple text lines_ +
+`>>>` [blue]`fib = func(n){ \` +
+`\...` [blue]`{nbsp}{nbsp}n ? \` +
+`\...` [blue]`{nbsp}{nbsp}{nbsp}{nbsp}[0] {0} : \` +
+`\...` [blue]`{nbsp}{nbsp}{nbsp}{nbsp}[1] {1} :: \` +
+`\...` [blue]`{nbsp}{nbsp}{nbsp}{nbsp}{ \` +
+`\...` [blue]`{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}fib(n-1) + fib(n-2) \` +
+`\...` [blue]`{nbsp}{nbsp}{nbsp}{nbsp}} \` +
+`\...` [blue]`}` +
+[green]`fib(n):any{}`
+
+`>>>` [gray]_// Required and optional parameters_ +
+`>>>` [blue]`measure = func(value, unit="meter"){ value + " " + unit + (value > 1) ? [true] {"s"} :: {""}}` +
+[green]`measure(value, unit="meter"):any{}`
+
 
 === _Golang_ function definition
 Description of how to define Golan functions and how to bind them to _Expr_ are topics treated in another document that I'll write, one day, maybe.
 
 === Function calls
-#TODO: function calls operations#
+To call a function, either Expr or Golang type, it is necessary to specify its name and, at least, its required parameters.
+
+.Function invocation syntax
+====
+*_function-call_* = _identifier_ "**(**" _actual-param-list_ "**)**" +
+_actual-param-list_ = [_positional-params_] [_named-parameters_] +
+_positional-params_ = _any-value_ { "*,*" _any-value_ } +
+_named-params_ = _param-name_ "**=**" _any-value_ { "*,*" _param-name_ "**=**" _any-value_ } +
+_param-name_ = _identifier_
+====
+
+.Examples of calling the `sum()` functions defined above
+`>>>` [gray]_// sum of two integers_ +
+`>>>` [blue]`sum(-6, 2)` +
+[green]`-4` +
+`>>>` [gray]_// same as above but passing the parameters by name_ +
+`>>>` [blue]`sum(a=-6, b=2)` +
+[green]`-4` +
+`>>>` [gray]_// again, but swapping parameter positions (see the diff() examples below)_ +
+`>>>` [blue]`sum(b=2, a=-6)` +
+[green]`-4` +
+`>>>` [gray]_// sum of a fraction and an integer_ +
+`>>>` [blue]`sum(3|2, 2)` +
+[green]`7|2` +
+`>>>` [gray]_// sum of two strings_ +
+`>>>` [blue]`sum("bye", "-bye")` +
+[green]`"bye-bye"` +
+`>>>` [gray]_// sum of two lists_ +
+`>>>` [blue]`sum(["one", 1], ["two", 2])` +
+[green]`["one", 1, "two", 2]`
+
+.Examples of calling a function with parameters passed by name
+`>>>` [gray]_// diff(a,b) calculates a-b_ +
+`>>>` [blue]`diff = func(a,b){a-b}` +
+[green]`diff(a, b):any{}` +
+`>>>` [gray]_// simple invocation_ +
+`>>>` [blue]`diff(10,8)` +
+[green]`2` +
+`>>>` [gray]_// swapped parameters passed by name_ +
+`>>>` [blue]`diff(b=8,a=10)` +
+[green]`2`
+
+.Examples of calling the `fib()` function defined above
+`>>>` [gray]_// Fibonacci sequence: 0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144, ..._ +
+`>>>` [blue]`fib(6)` +
+[green]`8` +
+`>>>` [blue]`fib(9)` +
+[green]`34`
+
+.Examples of calling the `measure()` functions defined above
+`>>>` [gray]_// simple call_ +
+`>>>` [blue]`measure(10,"litre")` +
+[green]`"10 litres"` +
+`>>>` [gray]_// accept the default unit_ +
+`>>>` [blue]`measure(8)` +
+[green]`"8 meters"` +
+`>>>` [gray]_// without the required parameter 'value'_ +
+`>>>` [blue]`measure(unit="degrees"))` +
+[red]`Eval Error: measure(): missing params -- value`
+
+.Examples of context binding (closures)
+`>>>` [blue]`factory = func(n=2){ func(x){x*n} }` +
+[green]`factory(n=2):any{}` +
+`>>>` [blue]`double = factory()` +
+[green]`double(x):any{}` +
+`>>>` [blue]`triple = factory(3)` +
+[green]`triple(x):any{}` +
+`>>>` [blue]`double(5)` +
+[green]`10` +
+`>>>` [blue]`triple(5)` +
+[green]`15`
+
 
 Functions compute values in a local context (scope) that do not make effects on the calling context. This is the normal behavior. Using the reference operator [blue]`@` it is possibile to export local definition to the calling context.