package jingoo

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Boxing OCaml values
Unboxing OCaml values
Helpers for function writing
Notes about some data types
Function calls

package jingoo

jingoo
- Jingoo
  - Jg_ast_mapper
  - Jg_ast_optimize
  - Jg_interp
    
    Loaded
    
    RevicedApi
  - Jg_lexer
  - Jg_parser
  - Jg_runtime
  - Jg_stub
  - Jg_template
    
    Loaded
  - Jg_template2
    
    Loaded
  - Jg_types
  - Jg_utils
    
    Maybe
    
    UTF8

Legend:
Library
Module
Module type
Parameter
Class
Class type

exception SyntaxError of string

type environment = {

autoescape : bool;
(*
If true, template variables are auto escaped when output.
*)
strict_mode : bool;
(*
If true, strict type cheking is enabled. If false, some kind of invalid type usages are just ignored. for example, following expression throws exception if strict_mode = true, but is skipped if strict_mode = false.
```
{# 3(Tint) is not iterable #}
{% for item in 3 %}
  {{ item }}
{% endfor %}
```
*)
template_dirs : string list;
(*
Template search path list used by {% include %} statements. Jingoo will always search in current directory in last resort.
*)
filters : (string * tvalue) list;
(*
User-defined filters.
*)
extensions : string list;
(*
Path list of shared library modules (.cms or .cmxs files) which are dynamically loaded.
*)

}

See std_env

and context = {

frame_stack : frame list;
macro_table : (string, macro) Hashtbl.t;
namespace_table : (string, (string, tvalue) Hashtbl.t) Hashtbl.t;
active_filters : string list;
serialize : bool;
output : tvalue -> unit;

}

and frame = string -> tvalue

and macro =

| Macro of macro_arg_names * macro_defaults * macro_code

and macro_arg_names = string list

and macro_defaults = kwargs

and macro_code = statement list

and tvalue =

| Tnull
| Tint of int
| Tbool of bool
| Tfloat of float
| Tstr of string
| Tobj of (string * tvalue) list
| Thash of (string, tvalue) Hashtbl.t
| Tpat of string -> tvalue
| Tlist of tvalue list
| Tset of tvalue list
| Tfun of ?kwargs:kwargs -> tvalue -> tvalue
| Tarray of tvalue array
| Tlazy of tvalue Lazy.t
| Tvolatile of unit -> tvalue
| Tsafe of string

and kwargs = (string * tvalue) list

Boxing OCaml values

Unboxing OCaml values

Unboxing operations raise Invalid_argument in case of type error.

Helpers for function writing

Notes about some data types

tvalue.Tobj Key/value object using an associative list.

tvalue.Thash Key/value objects using a hash table.

tvalue.Tpat Key/value object using a function to map "key" to value. Faster than tvalue.Tobj and tvalue.Thash, but not iterable nor testable.

tvalue.Tset Tuples

tvalue.Tlazy Lazy values are actually computed only when needed. Useful for recursive some data structure. In the following example, your app would throw a stack overflow without lazyness.

let rec lazy_model n =
  let prev = lazy_model (n - 1) in
  let next = lazy_model (n + 1) in
  let cur = Tint n in
  Tlazy (lazy (Tobj [ ("cur", cur) ; ("prev", prev) ; ("next", next) ]) )

tvalue.Tvolatile You can use volatile values for variables that can not be defined at model's definition time or if it is subject to changes over time on ocaml's side

Function calls

Built-in functions (aka filters) expect the TARGET value to be the LAST argument, in order to be usable with the pipe notation. You are encouraged to do the same while defining your own functions.

{{ x | foo (10,20) }} is equivalent too {{ foo (10,20,x) }}.

Functions support partial application. e.g. {{ list | map (foo (10,20)) }}

There is two kind of arguments: unnamed arguments and keyword arguments.

When defining a keyword argument, label can't be omitted.

You can't use slice(4, [1,2,3,4,5], 0), because you need to explicitly bind 0 with the fill_with label.

A correct usage of the slice function would be slice(4, [1,2,3,4,5], fill_with=0).

Note that kwargs may be defined at any place: slice(4, fill_with=0, [1,2,3,4,5]).