package parsexp

  1. Overview
  2. Docs
package parsexp
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file parsexp_intf.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
(** Parsing of s-expression *)

open! Import

module type Parsexp = sig
  module Conv_error = Conv_error
  module Of_sexp_error = Of_sexp_error
  module Old_parser_cont_state = Old_parser_cont_state
  module Parse_error = Parse_error
  module Positions = Positions
  module Cst = Cst

  module type Conv = Conv.S
  module type Parser = Parser.S
  module type Eager_parser = Parser.S_eager

  (** Exception raised in case of a conversion error *)
  exception Of_sexp_error of Of_sexp_error.t

  (** Exception raised in case of a parsing error *)
  exception Parse_error of Parse_error.t

  module Single :
    Parser
      with type parsed_value = Sexp.t
       and type State.t = (unit, Automaton_stack.t) Automaton_state.t
       and type Stack.t = Automaton_stack.t

  module Many :
    Parser
      with type parsed_value = Sexp.t list
       and type State.t = (unit, Automaton_stack.t) Automaton_state.t
       and type Stack.t = Automaton_stack.t

  module Eager :
    Eager_parser
      with type parsed_value = Sexp.t
       and type State.t = (unit, Automaton_stack.t) Automaton_state.t
       and type Stack.t = Automaton_stack.t

  module Single_and_positions :
    Parser
      with type parsed_value = Sexp.t * Positions.t
       and type State.t = (Positions.Builder.t, Automaton_stack.t) Automaton_state.t
       and type Stack.t = Automaton_stack.t

  module Many_and_positions :
    Parser
      with type parsed_value = Sexp.t list * Positions.t
       and type State.t = (Positions.Builder.t, Automaton_stack.t) Automaton_state.t
       and type Stack.t = Automaton_stack.t

  module Eager_and_positions :
    Eager_parser
      with type parsed_value = Sexp.t * Positions.t
       and type State.t = (Positions.Builder.t, Automaton_stack.t) Automaton_state.t
       and type Stack.t = Automaton_stack.t

  module Single_just_positions :
    Parser
      with type parsed_value = Positions.t
       and type State.t = (Positions.Builder.t, unit) Automaton_state.t
       and type Stack.t = unit

  module Many_just_positions :
    Parser
      with type parsed_value = Positions.t
       and type State.t = (Positions.Builder.t, unit) Automaton_state.t
       and type Stack.t = unit

  module Eager_just_positions :
    Eager_parser
      with type parsed_value = Positions.t
       and type State.t = (Positions.Builder.t, unit) Automaton_state.t
       and type Stack.t = unit

  module Many_cst :
    Parser
      with type parsed_value = Cst.t_or_comment list
       and type State.t =
        (Automaton_state.For_cst.t, Automaton_stack.For_cst.t) Automaton_state.t
       and type Stack.t = Automaton_stack.For_cst.t

  module Eager_cst :
    Eager_parser
      with type parsed_value = Cst.t_or_comment
       and type State.t =
        (Automaton_state.For_cst.t, Automaton_stack.For_cst.t) Automaton_state.t
       and type Stack.t = Automaton_stack.For_cst.t

  (*_ These type synonyms are introduced because ocaml <4.06
    do not support destructive substitutions with `type 'a t1 = t2`
    or `type t1 = 'a t2`. *)
  type 'a id = 'a
  type sexp_list = Sexp.t list

  module Conv_single :
    Conv
      with type 'a res := 'a id
       and type parsed_sexp := Sexp.t
       and type chunk_to_conv := Sexp.t

  module Conv_many :
    Conv
      with type 'a res := 'a list
       and type parsed_sexp := sexp_list
       and type chunk_to_conv := Sexp.t

  module Conv_many_and_locations :
    Conv
      with type 'a res := 'a list
       and type parsed_sexp := sexp_list * Positions.t
       and type chunk_to_conv := Sexp.t * Positions.range

  module Conv_many_at_once :
    Conv
      with type 'a res := 'a id
       and type parsed_sexp := sexp_list
       and type chunk_to_conv := sexp_list

  (*_ For tests *)
  (*_ See the Jane Street Style Guide for an explanation of [Private] submodules:

    https://opensource.janestreet.com/standards/#private-submodules *)
  module Private : sig
    module Automaton = Automaton
    module Automaton_stack = Automaton_stack
    module Automaton_state = Automaton_state
    module Positions = Positions
  end
end