libsail 0.16 · OCaml Package

Module for breaking AST into syntactic chunks and interleaving comments.

This module is part of the Sail formatting system. It takes a parsed AST (not a desugared AST, as for formatting we need to preserve as much as possible), and breaks it up into more abstract syntactic elements - 'chunks' for want of a better term.

type binder =

| Var_binder
| Let_binder
| Internal_plet_binder

val binder_keyword : binder -> string

type if_format = {

then_brace : bool;
else_brace : bool;

}

type match_kind =

| Try_match
| Match_match

val match_keywords : match_kind -> string * string option

val comment_type_delimiters : Lexer.comment_type -> string * string

type chunk =

| Comment of Lexer.comment_type * int * int * string
| Spacer of bool * int
| Function of {
1. id : Parse_ast.id;
2. clause : bool;
3. rec_opt : chunks option;
4. typq_opt : chunks option;
5. return_typ_opt : chunks option;
6. funcls : pexp_chunks list;
}
| Val of {
1. id : Parse_ast.id;
2. extern_opt : Parse_ast.extern option;
3. typq_opt : chunks option;
4. typ : chunks;
}
| Enum of {
1. id : Parse_ast.id;
2. enum_functions : chunks list option;
3. members : chunks list;
}
| Function_typ of {
1. mapping : bool;
2. lhs : chunks;
3. rhs : chunks;
}
| Exists of {
1. vars : chunks;
2. constr : chunks;
3. typ : chunks;
}
| Typ_quant of {
1. vars : chunks;
2. constr_opt : chunks option;
}
| App of Parse_ast.id * chunks list
| Field of chunks * Parse_ast.id
| Tuple of string * string * int * chunks list
| Intersperse of string * chunks list
| Atom of string
| String_literal of string
| Pragma of string * string
| Unary of string * chunks
| Binary of chunks * string * chunks
| Ternary of chunks * string * chunks * string * chunks
| Index of chunks * chunks
| Delim of string
| Opt_delim of string
| Block of bool * chunks list
| Binder of binder * chunks * chunks * chunks
| Block_binder of binder * chunks * chunks
| If_then of bool * chunks * chunks
| If_then_else of if_format * chunks * chunks * chunks
| Struct_update of chunks * chunks list
| Match of {
1. kind : match_kind;
2. exp : chunks;
3. aligned : bool;
4. cases : pexp_chunks list;
}
| Foreach of {
1. var : chunks;
2. decreasing : bool;
3. from_index : chunks;
4. to_index : chunks;
5. step : chunks option;
6. body : chunks;
}
| While of {
1. repeat_until : bool;
2. termination_measure : chunks option;
3. cond : chunks;
4. body : chunks;
}
| Vector_updates of chunks * chunk list
| Chunks of chunks
| Raw of string

and chunks = chunk Queue.t

and pexp_chunks = {

funcl_space : bool;
pat : chunks;
guard : chunks option;
body : chunks;

}

val prerr_chunk : string -> chunk -> unit

val chunk_defs : string -> Lexer.comment list -> Parse_ast.def list -> chunks

package libsail