package higlo

You can search for identifiers within the package.

in-package search v0.2.0

package higlo

Higlo
- Library higlo
  - Higlo
    
    Dot
    
    Json
    
    Lang
    
    Ocaml
    
    Printers
    
    Xml
- Sources
  - higlo
    
    dot.ml
    
    higlo.ml
    
    json.ml
    
    lang.ml
    
    ocaml.ml
    
    printers.ml
    
    xml.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Higlo.Printers`Source

Printers for the higlo tool.

Sourcetype printer = Lang.token list -> unit

Sourcetype 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.

Sourceval default_classes : classes

Default X(HTML) classes.

Sourceval 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.

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

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

Sourceval 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.

Source

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

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

Sourceval get_printer : string -> printer

raises Failure
if the printer is not registered.

Sourceval register_printer : string -> printer -> unit

package higlo

Module Higlo.PrintersSource

Module `Higlo.Printers`Source