package dune

You can search for identifiers within the package.

in-package search v0.2.0

package dune

dune._caml
- Dune_caml
dune._dune_lang
- Dune_lang
  - Ast
  - Atom
  - Conv
  - Cst
    
    Comment
  - Decoder
  - Encoder
  - Io
  - Lexer
    
    Token
  - Parse_error
  - Parser
    
    Mode
  - Syntax
  - Template
dune._ocaml_config
- Ocaml_config
  - Origin
  - Prog_and_args
  - Value
  - Vars
dune._result
- Dune_result
  - Result
dune._stdune
- Stdune
  - Ansi_color
    
    Color
    
    Render
    
    Tag
    
    Handler
    
    Style
  - Appendable_list
  - Array
  - Bin
  - Bool
  - Bytes
  - Char
  - Comparable
    
    OPS
    
    Operators
    
    X
    
    S
  - Digest
    
    Set
  - Dyn
    
    Encoder
  - Either
  - Env
    
    Map
    
    Multi
    
    Var
    
    Set
  - Exn
  - Exn_with_backtrace
  - Fdecl
  - Filename
  - Float
  - Fmt
  - Fn
  - Hashtbl
    
    Make
    
    Key
    
    S
  - Id
    
    Make
    
    Map
    
    Multi
    
    Set
    
    S
    
    Map
    
    Multi
    
    Set
  - In_expect_test
  - Int
    
    Infix
    
    Map
    
    Multi
    
    Set
  - Interned
    
    Make
    
    Map
    
    Multi
    
    R
    
    Set
    
    Table
    
    No_interning
    
    Map
    
    Multi
    
    R
    
    Set
    
    Table
    
    S
    
    Map
    
    Multi
    
    Set
    
    Table
    
    Settings
  - Io
    
    S
    
    String_path
  - List
  - Loc
  - Map
    
    Make
    
    Key
    
    Multi
    
    S
    
    Multi
  - Monad
    
    Id
    
    S
  - Nothing
  - Option
    
    List
    
    O
  - Or_exn
  - Ordering
  - Path
    
    External
    
    Internal
    
    Kind
    
    L
    
    Local
    
    L
    
    Map
    
    Multi
    
    Set
    
    Table
  - Pp
    
    Render
    
    Tag
    
    Handler
    
    Renderer
    
    Make
    
    Tag
    
    Handler
    
    S
    
    Tag
    
    Handler
    
    Tag
    
    Handler
  - Proc
  - Result
    
    List
    
    O
    
    Option
  - Set
    
    Make
    
    Elt
    
    S
  - Sexp
    
    Encoder
  - Sexp_intf
    
    Combinators
  - Staged
  - String
    
    Map
    
    Multi
    
    Set
    
    Table
  - Table
    
    Key
  - Tuple
    
    T2
  - Type_eq
  - Unit
  - Univ_map
    
    Key
dune._wp.dune
- Wp
dune._wp.jbuilder
- Wp
dune.configurator
- Configurator
  - V1
    
    C_define
    
    Type
    
    Value
    
    Flags
    
    Pkg_config
    
    Process

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parsing of s-expressions.

This library is internal to dune and guarantees no API stability.

module Atom : sig ... end

module Syntax : sig ... end

type syntax = Syntax.t =

| Jbuild
| Dune

module Template : sig ... end

type t =

| Atom of Atom.t
| Quoted_string of string
| List of t list
| Template of Template.t

The S-expression type

val atom : string -> t

atom s convert the string s to an Atom.

raises Exn.Code_error
if s does not satisfy Atom.is_valid s.

val atom_or_quoted_string : string -> t

val unsafe_atom_of_string : string -> t

val to_string : t -> syntax:syntax -> string

Serialize a S-expression

val pp : syntax -> Format.formatter -> t -> unit

Serialize a S-expression using indentation to improve readability

val pp_quoted : Format.formatter -> t -> unit

Serialization that never fails because it quotes atoms when necessary TODO remove this once we have a proper sexp type

val pp_split_strings : Format.formatter -> t -> unit

Same as pp ~syntax:Dune, but split long strings. The formatter must have been prepared with prepare_formatter.

val prepare_formatter : Format.formatter -> unit

Prepare a formatter for pp_split_strings. Additionaly the formatter escape newlines when the tags "makefile-action" or "makefile-stuff" are active.

module Ast : sig ... end

Abstract syntax tree

val add_loc : t -> loc:Stdune.Loc.t -> Ast.t

module Cst : sig ... end

Concrete syntax tree

val insert_comments : 
  Cst.t list ->
  (Stdune.Loc.t * Cst.Comment.t) list ->
  Cst.t list

Insert comments in a concrete syntax tree. Comments are inserted based on their location.

module Parse_error : sig ... end

exception Parse_error of Parse_error.t

Exception raised in case of a parsing error

module Lexer : sig ... end

module Parser : sig ... end

val parse_string : 
  fname:string ->
  mode:'a Parser.Mode.t ->
  ?lexer:Lexer.t ->
  string ->
  'a

val parse_cst_string : fname:string -> ?lexer:Lexer.t -> string -> Cst.t list

module Encoder : sig ... end

module Decoder : sig ... end

module type Conv = sig ... end

val to_sexp : t Stdune.Sexp.Encoder.t

module Io : sig ... end