Module `Handlebars_ml.Compiler`Source

Sourcetype compile_error =

| Missing_helper of string
(*
Helper function not found
*)
| Missing_partial of string
(*
Partial template not found
*)
| Partial_parse_error of string * Parser.parse_error
(*
Parsing error in a partial template
*)
| Partial_compile_error of string * compile_error
(*
Compilation error in a partial template
*)

Compilation errors that can occur during template processing

val pp_compile_error : 
  Ppx_deriving_runtime.Format.formatter ->
  compile_error ->
  Ppx_deriving_runtime.unit

Sourceval show_compile_error : compile_error -> Ppx_deriving_runtime.string

Source

val equal_compile_error : 
  compile_error ->
  compile_error ->
  Ppx_deriving_runtime.bool

Sourcetype compile_result = (string, compile_error) result

Result type for compilation operations

Sourcetype hb_error =

| ParseError of Parser.parse_error
(*
Error during parsing
*)
| CompileError of compile_error
(*
Error during compilation
*)

Combined error type for both lexing and compilation errors

Source

val pp_hb_error : 
  Ppx_deriving_runtime.Format.formatter ->
  hb_error ->
  Ppx_deriving_runtime.unit

Sourceval show_hb_error : hb_error -> Ppx_deriving_runtime.string

Sourceval equal_hb_error : hb_error -> hb_error -> Ppx_deriving_runtime.bool

Sourcetype hb_result = (string, hb_error) result

Result type for complete handlebars processing

Source

val pp_hb_result : 
  Ppx_deriving_runtime.Format.formatter ->
  hb_result ->
  Ppx_deriving_runtime.unit

Sourceval show_hb_result : hb_result -> Ppx_deriving_runtime.string

Sourceval equal_hb_result : hb_result -> hb_result -> Ppx_deriving_runtime.bool

Sourcetype context_values = {

v : Types.literal_or_collection;
extras : Types.literal_or_collection;

}

Context values for template variables + injected extras

Sourcetype context =

| Root of context_values
(*
Root context
*)
| Child of {
1. values : context_values;
2. parent : context;
3. root : context;
}
(*
Child context with parent and root reference
*)

Template execution context with parent chain

Source

type custom_helper =
  Types.literal_or_collection list ->
  Types.literal_or_collection option

Custom helper function type

Sourcetype custom_helper_lookup_fn = string -> custom_helper option

Function to look up custom helpers by name

Sourcetype partial_lookup_fn = string -> string option

Function to look up partial templates by name

Source

val make_ctx : 
  ?parent_ctx:context ->
  ?extras:(string * Types.literal_or_collection) List.t ->
  Types.literal_or_collection ->
  context

Create a context from a value with optional parent

Source

val lookup : 
  context ->
  Types.ident_path_segment list ->
  Types.literal_or_collection

Look up a value in context using an identifier path, returns `Null if not found

Source

val eval : 
  context ->
  custom_helper_lookup_fn ->
  Types.evalable ->
  (Types.literal_or_collection, compile_error) result

Evaluate an expression in a given context

Source

val compile_tokens : 
  custom_helper_lookup_fn ->
  partial_lookup_fn ->
  Types.token list ->
  Types.literal_or_collection ->
  compile_result

Compile a list of tokens with given context and helpers

Sourceval string_of_literal : Types.literal_or_collection -> string

Convert a literal_or_collection to string representation

Sourceval escape_html : string -> string

Escape HTML entities in a string

Sourceval default_get_helper : custom_helper_lookup_fn

Default helper lookup function with built-in helpers

Sourceval default_get_partial : partial_lookup_fn

Default partial lookup function (returns None for all partials)

Source

val compile : 
  ?get_helper:custom_helper_lookup_fn ->
  ?get_partial:partial_lookup_fn ->
  string ->
  Types.literal_or_collection ->
  hb_result

Main compilation function

package handlebars-ml

Module Handlebars_ml.CompilerSource

Module `Handlebars_ml.Compiler`Source