package ocp-ocamlres

You can search for identifiers within the package.

in-package search v0.2.0

ocplib-ocamlres
- OCamlResFormats
  - Files
    
    SF
  - Format
  - OCaml
    
    SF
  - Res
    
    SF
- OCamlResRegistry
  - ExtensionDispatcherSubFormat
  - Files
  - Format
  - Int
  - Lines
  - OCaml
  - PredefOptions
  - Raw
  - Res
  - SubFormat
  - Variants
- OCamlResScanners
  - PathFilter
  - ResFilter
- OCamlResSubFormats
  - Int
  - Lines
  - Raw
  - SubFormat
ocplib-ocamlres.runtime
- OCamlRes
  - Path
  - Res

Legend:
Library
Module
Module type
Parameter
Class
Class type

The default format (raw contents as a string)

type t = string

The generation-time intermediate representation of data.

val from_raw : OCamlRes.Path.t -> string -> t

A parser as used by the scanner to obtain the in-memory resources from files.

val to_raw : OCamlRes.Path.t -> t -> string

A dumper to reconstitute the files from the in-memory resources.

val pprint : OCamlRes.Path.t -> t -> PPrint.document

Takes the path to the resource in the resource tree, and its value to pretty print. Returns the OCaml representation of the value.

val pprint_header : OCamlRes.Path.t -> t -> PPrint.document option

Provides an optional piece of OCaml code to put before the resource store definition, for instance a type definition.

val pprint_footer : OCamlRes.Path.t -> t -> PPrint.document option

Provides an optional piece of OCaml code to put after the resource store definition, for instance a type definition.

val name : OCamlRes.Path.t -> t -> string

A name used to identify the subformat.

val type_name : OCamlRes.Path.t -> t -> string

The run-time OCaml type name (that describes the type of values generated by pprint). Used to annotate the generated source where needed. The common usecase is when this function returns the same type as the static t type.

val mod_name : OCamlRes.Path.t -> t -> string

The name of the subformat module at run-time. If the static type t is the same as the runtime type returned by type_abbrv, this is simply the path to the module used for generation.