package higlo

You can search for identifiers within the package.

in-package search v0.2.0

package higlo

higlo
- Higlo
  - Dot
  - Json
  - Lang
  - Ocaml
  - Printers
  - Xml

Legend:
Library
Module
Module type
Parameter
Class
Class type

Printers for the higlo tool.

type printer = Lang.token list -> unit

type classes = {

bcomment : string;
constant : string;
directive : string;
escape : string;
id : string;
keyword : int -> string;
lcomment : string;
numeric : string;
string : string;
symbol : int -> string;
text : string;
title : int -> string;

}

This structure defines the (X)HTML classes to use when producing XML.

val default_classes : classes

Default X(HTML) classes.

val token_to_xml : ?classes:classes -> Lang.token -> Xtmpl.Xml.tree

Map a token to an XML tree (just a <span class="...">code</span> node).

parameter classes
is used to change the class names used in the generated node.

val token_to_xml_rewrite : ?classes:classes -> Lang.token -> Xtmpl.Rewrite.tree

Same as token_to_xml but return a Xtmpl.Rewrite.tree.

val to_xml : ?classes:classes -> lang:string -> string -> Xtmpl.Xml.tree list

to_xtmpl ~lang code gets the lexer associated to the language lang, uses it to retrieve a list of tokens (using the Lang.parse function) and maps these tokens to XML nodes. See token_to_xml about the classes parameter.

val to_xml_rewrite : 
  ?classes:classes ->
  lang:string ->
  string ->
  Xtmpl.Rewrite.tree list

Same as to_xml but return a Xtmpl.Rewrite.tree.

val get_printer : string -> printer

raises Failure
if the printer is not registered.

val register_printer : string -> printer -> unit