module Ag_util

: sig

Various convenience types and functions

type 'a ocaml_array = 'a array

An alias for OCaml's standard array type, used in generated code.

module Biniou : sig

type 'a reader = Bi_inbuf.t -> 'a

Type of a read_ function as produced by atdgen -biniou.

type 'a writer = Bi_outbuf.t -> 'a -> unit

Type of a write_ function as produced by atdgen -biniou.

val from_channel : ?len:int -> ?shrlen:int -> 'a reader -> Pervasives.in_channel -> 'a

Read a biniou value from a channel.

len input buffer length.

shrlen obsolete and ignored.

val from_file : ?len:int -> ?shrlen:int -> 'a reader -> string -> 'a

Read a biniou value from a file.

len input buffer length.

shrlen obsolete and ignored.

val to_channel : ?len:int -> ?shrlen:int -> 'a writer -> Pervasives.out_channel -> 'a -> unit

Write a biniou value to a channel.

len output buffer length.

shrlen obsolete and ignored.

val to_file : ?len:int -> ?shrlen:int -> 'a writer -> string -> 'a -> unit

Write a biniou value to a file.

len output buffer length.

shrlen obsolete and ignored.

end

module Json : sig

type 'a reader = Yojson.Safe.lexer_state -> Lexing.lexbuf -> 'a

Type of a read_ function as produced by atdgen -json.

In versions of yojson greater than 1.0.1, type Yojson.Safe.lexer_state is equivalent to Yojson.lexer_state, Yojson.Basic.lexer_state and Yojson.Raw.lexer_state.

type 'a writer = Bi_outbuf.t -> 'a -> unit

Type of a write_ function as produced by atdgen -json.

val from_lexbuf : ?stream:bool -> 'a reader -> Yojson.Safe.lexer_state -> Lexing.lexbuf -> 'a

Read a JSON value from a lexbuf.

stream if true, the JSON parser will not try to consume whitespace until the end of file. Default is false, which raises a Yojson.Json_error exception if the valid JSON value is followed by anything other than standard JSON whitespace.

val from_string : ?buf:Bi_outbuf.t -> ?fname:string -> ?lnum:int -> 'a reader -> string -> 'a

Convert a JSON value from a string.

buf buffer used to accumulate string data during the lexing phase.

fname input file name to be used in error messages. It does not have to be the name of a real file, it can be something like "<stdin>".

lnum line number to assign to the first line of input. For example lnum=10 means that an error on the first line of input will be reported as an error on line 10. Default: 1.

val from_channel : ?buf:Bi_outbuf.t -> ?fname:string -> ?lnum:int -> 'a reader -> Pervasives.in_channel -> 'a

Read a JSON value from a channel.

buf buffer used to accumulate string data during the lexing phase.

fname input file name to be used in error messages. It does not have to be the name of a real file, it can be something like "<stdin>".

lnum line number to assign to the first line of input. For example lnum=10 means that an error on the first line of input will be reported as an error on line 10. Default: 1.

val from_file : ?buf:Bi_outbuf.t -> ?fname:string -> ?lnum:int -> 'a reader -> string -> 'a

Read a JSON value from a channel.

buf buffer used to accumulate string data during the lexing phase.

fname input file name to be used in error messages. It is intended to represent the source file if it is different from the input file.

lnum line number to assign to the first line of input. For example lnum=10 means that an error on the first line of input will be reported as an error on line 10. Default: 1.

val stream_from_lexbuf : ?fin:(unit -> unit) -> 'a reader -> Yojson.Safe.lexer_state -> Lexing.lexbuf -> 'a Stream.t

Read a stream of JSON values from a lexbuf.

fin finalization function executed once when the end of the stream is reached either because there is no more input or because of an exception. This is typically used to close the input channel, e.g. fun () -> close_in_noerr ic.

val stream_from_string : ?buf:Bi_outbuf.t -> ?fin:(unit -> unit) -> ?fname:string -> ?lnum:int -> 'a reader -> string -> 'a Stream.t

Read a stream of JSON values from a channel. Values do not have to be separated by newline characters.

buf buffer used to accumulate string data during the lexing phase.

fin finalization function executed once when the end of the stream is reached either because there is no more input or because of an exception. This is typically used to free the underlying resources, if any.

fname input file name to be used in error messages. It does not have to be the name of a real file, it can be something like "<stdin>".

lnum line number to assign to the first line of input. For example lnum=10 means that an error on the first line of input will be reported as an error on line 10. Default: 1.

val stream_from_channel : ?buf:Bi_outbuf.t -> ?fin:(unit -> unit) -> ?fname:string -> ?lnum:int -> 'a reader -> Pervasives.in_channel -> 'a Stream.t

Read a stream of JSON values from a channel. Values do not have to be separated by newline characters.

buf buffer used to accumulate string data during the lexing phase.

fname input file name to be used in error messages. It does not have to be the name of a real file, it can be something like "<stdin>".

lnum line number to assign to the first line of input. For example lnum=10 means that an error on the first line of input will be reported as an error on line 10. Default: 1.

val stream_from_file : ?buf:Bi_outbuf.t -> ?fin:(unit -> unit) -> ?fname:string -> ?lnum:int -> 'a reader -> string -> 'a Stream.t

Read a stream of JSON values from a file. Values do not have to be separated by newline characters.

buf buffer used to accumulate string data during the lexing phase.

fin finalization function executed once when the end of the stream is reached either because there is no more input or because of an exception. This can be used to remove the input file if it was temporary, e.g. fun () -> Sys.remove fname.

fname input file name to be used in error messages. It is intended to represent the source file if it is different from the input file.

lnum line number to assign to the first line of input. For example lnum=10 means that an error on the first line of input will be reported as an error on line 10. Default: 1.

val list_from_string : ?buf:Bi_outbuf.t -> ?fin:(unit -> unit) -> ?fname:string -> ?lnum:int -> 'a reader -> string -> 'a list

Read a list of JSON values from a channel. Values do not have to be separated by newline characters.

buf buffer used to accumulate string data during the lexing phase.

fname input file name to be used in error messages. It does not have to be the name of a real file, it can be something like "<stdin>".

lnum line number to assign to the first line of input. For example lnum=10 means that an error on the first line of input will be reported as an error on line 10. Default: 1.

val list_from_channel : ?buf:Bi_outbuf.t -> ?fin:(unit -> unit) -> ?fname:string -> ?lnum:int -> 'a reader -> Pervasives.in_channel -> 'a list

Read a list of JSON values from a channel. Values do not have to be separated by newline characters.

buf buffer used to accumulate string data during the lexing phase.

fname input file name to be used in error messages. It does not have to be the name of a real file, it can be something like "<stdin>".

lnum line number to assign to the first line of input. For example lnum=10 means that an error on the first line of input will be reported as an error on line 10. Default: 1.

val list_from_file : ?buf:Bi_outbuf.t -> ?fname:string -> ?lnum:int -> 'a reader -> string -> 'a list

Read a list of JSON values from a file. Values do not have to be separated by newline characters.

buf buffer used to accumulate string data during the lexing phase.

fname input file name to be used in error messages. It is intended to represent the source file if it is different from the input file.

lnum line number to assign to the first line of input. For example lnum=10 means that an error on the first line of input will be reported as an error on line 10. Default: 1.

val to_string : ?len:int -> 'a writer -> 'a -> string

Write a JSON value to a string.

len output buffer length.

val to_channel : ?len:int -> 'a writer -> Pervasives.out_channel -> 'a -> unit

Write a JSON value to a channel.

len output buffer length.

val to_file : ?len:int -> 'a writer -> string -> 'a -> unit

Write a JSON value to a file.

len output buffer length.

val stream_to_string : ?len:int -> ?lf:string -> 'a writer -> 'a Stream.t -> string

Write a stream of values to a string.

len output buffer length.

lf additional element terminator. Default: "\n".

val stream_to_channel : ?len:int -> ?lf:string -> 'a writer -> Pervasives.out_channel -> 'a Stream.t -> unit

Write a stream of values to a channel.

len output buffer length.

lf additional element terminator. Default: "\n".

val stream_to_file : ?len:int -> ?lf:string -> 'a writer -> string -> 'a Stream.t -> unit

Write a stream of values to a file.

len output buffer length.

lf additional element terminator. Default: "\n".

val list_to_string : ?len:int -> ?lf:string -> 'a writer -> 'a list -> string

Write a list of values to a string.

len output buffer length.

lf additional element terminator. Default: "\n".

val list_to_channel : ?len:int -> ?lf:string -> 'a writer -> Pervasives.out_channel -> 'a list -> unit

Write a list of values to a channel.

len output buffer length.

lf additional element terminator. Default: "\n".

val list_to_file : ?len:int -> ?lf:string -> 'a writer -> string -> 'a list -> unit

Write a list of values to a file.

len output buffer length.

lf additional element terminator. Default: "\n".

val preset_unknown_field_handler : string -> string -> unit

preset_unknown_field_handler src_loc field_name raises a Failure exception with a message containing the location of the type definition in the source ATD file (src_loc) and the name of the field (field_name).

val unknown_field_handler : (string -> string -> unit) Pervasives.ref

Function called when an unknown JSON field is encountered if the code was generated by atdgen -json-strict-fields. Its preset behavior is to call preset_unknown_field_handler which raises a Failure exception.

Usage: !Ag_util.Json.unknown_field_handler src_loc field_name where src_loc is the location of the type definition in the source ATD file and field_name is the unknown JSON field name.

val preset_constr_mismatch_handler : string -> string -> string -> string -> unit

preset_constr_mismatch_handler constr_field constr_constr value_field value_constr raises a Ag_oj_run.Error exception with a message containing the constructor field and value (constr_field and constr_constr) which don't match the value field's (value_field) constructor (value_constr).

val constr_mismatch_handler : (string -> string -> string -> string -> unit) Pervasives.ref

end

module Validation : sig

type path_elem = [

| `Field of string

| `Index of int

]

type path = path_elem list

Path within a value, used to report validation errors.

val string_of_path : path -> string

Reverse and concatenate a path into a string such as ".settings.ports[0]"

type error = {

# error_path	: path	;
# error_msg	: string option	;

}

val error : ?msg:string -> path -> error

val string_of_error : error -> string

end