File: Pparse.html

package info (click to toggle)
ocaml-doc 4.11-2
  • links: PTS, VCS
  • area: non-free
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 20,580 kB
  • sloc: sh: 37; makefile: 11
file content (128 lines) | stat: -rw-r--r-- 8,871 bytes parent folder | download
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="Start" href="index.html">
<link rel="previous" href="Parsetree.html">
<link rel="next" href="Pprintast.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Arg_helper" rel="Chapter" href="Arg_helper.html">
<link title="Ast_helper" rel="Chapter" href="Ast_helper.html">
<link title="Ast_invariants" rel="Chapter" href="Ast_invariants.html">
<link title="Ast_iterator" rel="Chapter" href="Ast_iterator.html">
<link title="Ast_mapper" rel="Chapter" href="Ast_mapper.html">
<link title="Asttypes" rel="Chapter" href="Asttypes.html">
<link title="Attr_helper" rel="Chapter" href="Attr_helper.html">
<link title="Build_path_prefix_map" rel="Chapter" href="Build_path_prefix_map.html">
<link title="Builtin_attributes" rel="Chapter" href="Builtin_attributes.html">
<link title="CamlinternalMenhirLib" rel="Chapter" href="CamlinternalMenhirLib.html">
<link title="Ccomp" rel="Chapter" href="Ccomp.html">
<link title="Clflags" rel="Chapter" href="Clflags.html">
<link title="Compiler_libs" rel="Chapter" href="Compiler_libs.html">
<link title="Config" rel="Chapter" href="Config.html">
<link title="Consistbl" rel="Chapter" href="Consistbl.html">
<link title="Depend" rel="Chapter" href="Depend.html">
<link title="Docstrings" rel="Chapter" href="Docstrings.html">
<link title="Domainstate" rel="Chapter" href="Domainstate.html">
<link title="Identifiable" rel="Chapter" href="Identifiable.html">
<link title="Int_replace_polymorphic_compare" rel="Chapter" href="Int_replace_polymorphic_compare.html">
<link title="Lexer" rel="Chapter" href="Lexer.html">
<link title="Load_path" rel="Chapter" href="Load_path.html">
<link title="Location" rel="Chapter" href="Location.html">
<link title="Longident" rel="Chapter" href="Longident.html">
<link title="Misc" rel="Chapter" href="Misc.html">
<link title="Numbers" rel="Chapter" href="Numbers.html">
<link title="Parse" rel="Chapter" href="Parse.html">
<link title="Parser" rel="Chapter" href="Parser.html">
<link title="Parsetree" rel="Chapter" href="Parsetree.html">
<link title="Pparse" rel="Chapter" href="Pparse.html">
<link title="Pprintast" rel="Chapter" href="Pprintast.html">
<link title="Printast" rel="Chapter" href="Printast.html">
<link title="Profile" rel="Chapter" href="Profile.html">
<link title="Strongly_connected_components" rel="Chapter" href="Strongly_connected_components.html">
<link title="Syntaxerr" rel="Chapter" href="Syntaxerr.html">
<link title="Targetint" rel="Chapter" href="Targetint.html">
<link title="Terminfo" rel="Chapter" href="Terminfo.html">
<link title="Warnings" rel="Chapter" href="Warnings.html"><title>Pparse</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Parsetree.html" title="Parsetree">Previous</a>
&nbsp;<a class="up" href="index.html" title="Index">Up</a>
&nbsp;<a class="post" href="Pprintast.html" title="Pprintast">Next</a>
</div>
<h1>Module <a href="type_Pparse.html">Pparse</a></h1>

<pre><span id="MODULEPparse"><span class="keyword">module</span> Pparse</span>: <code class="code"><span class="keyword">sig</span></code> <a href="Pparse.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top">
<div class="info-desc">
<p>Driver for the parser and external preprocessors.</p>

<p><b>Warning:</b> this module is unstable and part of
  <a href="Compiler_libs.html">compiler-libs</a>.</p>
</div>
</div>
<hr width="100%">

<pre><code><span id="TYPEerror"><span class="keyword">type</span> <code class="type"></code>error</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTerror.CannotRun"><span class="constructor">CannotRun</span></span> <span class="keyword">of</span> <code class="type">string</code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTerror.WrongMagic"><span class="constructor">WrongMagic</span></span> <span class="keyword">of</span> <code class="type">string</code></code></td>

</tr></table>



<pre><span id="EXCEPTIONError"><span class="keyword">exception</span> Error</span> <span class="keyword">of</span> <code class="type"><a href="Pparse.html#TYPEerror">error</a></code></pre>

<pre><span id="VALpreprocess"><span class="keyword">val</span> preprocess</span> : <code class="type">string -> string</code></pre>
<pre><span id="VALremove_preprocessed"><span class="keyword">val</span> remove_preprocessed</span> : <code class="type">string -> unit</code></pre>
<pre><code><span id="TYPEast_kind"><span class="keyword">type</span> <code class="type">'a</code> ast_kind</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTast_kind.Structure"><span class="constructor">Structure</span></span> <span class="keyword">:</span> <code class="type"><a href="Parsetree.html#TYPEstructure">Parsetree.structure</a> <a href="Pparse.html#TYPEast_kind">ast_kind</a></code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTast_kind.Signature"><span class="constructor">Signature</span></span> <span class="keyword">:</span> <code class="type"><a href="Parsetree.html#TYPEsignature">Parsetree.signature</a> <a href="Pparse.html#TYPEast_kind">ast_kind</a></code></code></td>

</tr></table>



<pre><span id="VALread_ast"><span class="keyword">val</span> read_ast</span> : <code class="type">'a <a href="Pparse.html#TYPEast_kind">ast_kind</a> -> string -> 'a</code></pre>
<pre><span id="VALwrite_ast"><span class="keyword">val</span> write_ast</span> : <code class="type">'a <a href="Pparse.html#TYPEast_kind">ast_kind</a> -> string -> 'a -> unit</code></pre>
<pre><span id="VALfile"><span class="keyword">val</span> file</span> : <code class="type">tool_name:string -><br>       string -> (Lexing.lexbuf -> 'a) -> 'a <a href="Pparse.html#TYPEast_kind">ast_kind</a> -> 'a</code></pre>
<pre><span id="VALapply_rewriters"><span class="keyword">val</span> apply_rewriters</span> : <code class="type">?restore:bool -> tool_name:string -> 'a <a href="Pparse.html#TYPEast_kind">ast_kind</a> -> 'a -> 'a</code></pre><div class="info ">
<div class="info-desc">
<p>If <code class="code">restore&nbsp;=&nbsp;<span class="keyword">true</span></code> (the default), cookies set by external
      rewriters will be kept for later calls.</p>
</div>
</div>

<pre><span id="VALapply_rewriters_str"><span class="keyword">val</span> apply_rewriters_str</span> : <code class="type">?restore:bool -><br>       tool_name:string -> <a href="Parsetree.html#TYPEstructure">Parsetree.structure</a> -> <a href="Parsetree.html#TYPEstructure">Parsetree.structure</a></code></pre>
<pre><span id="VALapply_rewriters_sig"><span class="keyword">val</span> apply_rewriters_sig</span> : <code class="type">?restore:bool -><br>       tool_name:string -> <a href="Parsetree.html#TYPEsignature">Parsetree.signature</a> -> <a href="Parsetree.html#TYPEsignature">Parsetree.signature</a></code></pre>
<pre><span id="VALreport_error"><span class="keyword">val</span> report_error</span> : <code class="type">Format.formatter -> <a href="Pparse.html#TYPEerror">error</a> -> unit</code></pre>
<pre><span id="VALparse_implementation"><span class="keyword">val</span> parse_implementation</span> : <code class="type">tool_name:string -> string -> <a href="Parsetree.html#TYPEstructure">Parsetree.structure</a></code></pre>
<pre><span id="VALparse_interface"><span class="keyword">val</span> parse_interface</span> : <code class="type">tool_name:string -> string -> <a href="Parsetree.html#TYPEsignature">Parsetree.signature</a></code></pre>
<pre><span id="VALcall_external_preprocessor"><span class="keyword">val</span> call_external_preprocessor</span> : <code class="type">string -> string -> string</code></pre>
<pre><span id="VALopen_and_check_magic"><span class="keyword">val</span> open_and_check_magic</span> : <code class="type">string -> string -> in_channel * bool</code></pre></body></html>