<!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="ListLabels.html"> <link rel="next" href="Longident.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" rel="Chapter" href="Arg.html"> <link title="Arg_helper" rel="Chapter" href="Arg_helper.html"> <link title="Array" rel="Chapter" href="Array.html"> <link title="ArrayLabels" rel="Chapter" href="ArrayLabels.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="Bigarray" rel="Chapter" href="Bigarray.html"> <link title="Buffer" rel="Chapter" href="Buffer.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="Bytes" rel="Chapter" href="Bytes.html"> <link title="BytesLabels" rel="Chapter" href="BytesLabels.html"> <link title="Callback" rel="Chapter" href="Callback.html"> <link title="CamlinternalFormat" rel="Chapter" href="CamlinternalFormat.html"> <link title="CamlinternalFormatBasics" rel="Chapter" href="CamlinternalFormatBasics.html"> <link title="CamlinternalLazy" rel="Chapter" href="CamlinternalLazy.html"> <link title="CamlinternalMod" rel="Chapter" href="CamlinternalMod.html"> <link title="CamlinternalOO" rel="Chapter" href="CamlinternalOO.html"> <link title="Ccomp" rel="Chapter" href="Ccomp.html"> <link title="Char" rel="Chapter" href="Char.html"> <link title="Clflags" rel="Chapter" href="Clflags.html"> <link title="Complex" rel="Chapter" href="Complex.html"> <link title="Condition" rel="Chapter" href="Condition.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="Digest" rel="Chapter" href="Digest.html"> <link title="Docstrings" rel="Chapter" href="Docstrings.html"> <link title="Dynlink" rel="Chapter" href="Dynlink.html"> <link title="Ephemeron" rel="Chapter" href="Ephemeron.html"> <link title="Event" rel="Chapter" href="Event.html"> <link title="Filename" rel="Chapter" href="Filename.html"> <link title="Float" rel="Chapter" href="Float.html"> <link title="Format" rel="Chapter" href="Format.html"> <link title="Gc" rel="Chapter" href="Gc.html"> <link title="Genlex" rel="Chapter" href="Genlex.html"> <link title="Graphics" rel="Chapter" href="Graphics.html"> <link title="GraphicsX11" rel="Chapter" href="GraphicsX11.html"> <link title="Hashtbl" rel="Chapter" href="Hashtbl.html"> <link title="Identifiable" rel="Chapter" href="Identifiable.html"> <link title="Int32" rel="Chapter" href="Int32.html"> <link title="Int64" rel="Chapter" href="Int64.html"> <link title="Lazy" rel="Chapter" href="Lazy.html"> <link title="Lexer" rel="Chapter" href="Lexer.html"> <link title="Lexing" rel="Chapter" href="Lexing.html"> <link title="List" rel="Chapter" href="List.html"> <link title="ListLabels" rel="Chapter" href="ListLabels.html"> <link title="Location" rel="Chapter" href="Location.html"> <link title="Longident" rel="Chapter" href="Longident.html"> <link title="Map" rel="Chapter" href="Map.html"> <link title="Marshal" rel="Chapter" href="Marshal.html"> <link title="Misc" rel="Chapter" href="Misc.html"> <link title="MoreLabels" rel="Chapter" href="MoreLabels.html"> <link title="Mutex" rel="Chapter" href="Mutex.html"> <link title="Nativeint" rel="Chapter" href="Nativeint.html"> <link title="Numbers" rel="Chapter" href="Numbers.html"> <link title="Obj" rel="Chapter" href="Obj.html"> <link title="Oo" rel="Chapter" href="Oo.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="Parsing" rel="Chapter" href="Parsing.html"> <link title="Pervasives" rel="Chapter" href="Pervasives.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="Printexc" rel="Chapter" href="Printexc.html"> <link title="Printf" rel="Chapter" href="Printf.html"> <link title="Profile" rel="Chapter" href="Profile.html"> <link title="Queue" rel="Chapter" href="Queue.html"> <link title="Random" rel="Chapter" href="Random.html"> <link title="Scanf" rel="Chapter" href="Scanf.html"> <link title="Seq" rel="Chapter" href="Seq.html"> <link title="Set" rel="Chapter" href="Set.html"> <link title="Simplif" rel="Chapter" href="Simplif.html"> <link title="Sort" rel="Chapter" href="Sort.html"> <link title="Spacetime" rel="Chapter" href="Spacetime.html"> <link title="Stack" rel="Chapter" href="Stack.html"> <link title="StdLabels" rel="Chapter" href="StdLabels.html"> <link title="Str" rel="Chapter" href="Str.html"> <link title="Stream" rel="Chapter" href="Stream.html"> <link title="String" rel="Chapter" href="String.html"> <link title="StringLabels" rel="Chapter" href="StringLabels.html"> <link title="Strongly_connected_components" rel="Chapter" href="Strongly_connected_components.html"> <link title="Syntaxerr" rel="Chapter" href="Syntaxerr.html"> <link title="Sys" rel="Chapter" href="Sys.html"> <link title="Targetint" rel="Chapter" href="Targetint.html"> <link title="Tbl" rel="Chapter" href="Tbl.html"> <link title="Terminfo" rel="Chapter" href="Terminfo.html"> <link title="Thread" rel="Chapter" href="Thread.html"> <link title="ThreadUnix" rel="Chapter" href="ThreadUnix.html"> <link title="Typemod" rel="Chapter" href="Typemod.html"> <link title="Uchar" rel="Chapter" href="Uchar.html"> <link title="Unix" rel="Chapter" href="Unix.html"> <link title="UnixLabels" rel="Chapter" href="UnixLabels.html"> <link title="Warnings" rel="Chapter" href="Warnings.html"> <link title="Weak" rel="Chapter" href="Weak.html"><title>Location</title> </head> <body> <div class="navbar"><a class="pre" href="ListLabels.html" title="ListLabels">Previous</a> <a class="up" href="index.html" title="Index">Up</a> <a class="post" href="Longident.html" title="Longident">Next</a> </div> <h1>Module <a href="type_Location.html">Location</a></h1> <pre><span id="MODULELocation"><span class="keyword">module</span> Location</span>: <code class="code"><span class="keyword">sig</span></code> <a href="Location.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top"> <div class="info-desc"> <p>Source code locations (ranges of positions), used in parsetree.</p> </div> </div> <hr width="100%"> <pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> = <code class="type"><a href="Warnings.html#TYPEloc">Warnings.loc</a></code> = {</pre><table class="typetable"> <tr> <td align="left" valign="top" > <code> </code></td> <td align="left" valign="top" > <code><span id="TYPEELTt.loc_start">loc_start</span> : <code class="type"><a href="Lexing.html#TYPEposition">Lexing.position</a></code>;</code></td> </tr> <tr> <td align="left" valign="top" > <code> </code></td> <td align="left" valign="top" > <code><span id="TYPEELTt.loc_end">loc_end</span> : <code class="type"><a href="Lexing.html#TYPEposition">Lexing.position</a></code>;</code></td> </tr> <tr> <td align="left" valign="top" > <code> </code></td> <td align="left" valign="top" > <code><span id="TYPEELTt.loc_ghost">loc_ghost</span> : <code class="type">bool</code>;</code></td> </tr></table> } <p>Note on the use of Lexing.position in this module. If <code class="code">pos_fname = <span class="string">""</span></code>, then use <code class="code">!input_name</code> instead. If <code class="code">pos_lnum = -1</code>, then <code class="code">pos_bol = 0</code>. Use <code class="code">pos_cnum</code> and re-parse the file to get the line and character numbers. Else all fields are correct.</p> <pre><span id="VALnone"><span class="keyword">val</span> none</span> : <code class="type"><a href="Location.html#TYPEt">t</a></code></pre><div class="info "> <div class="info-desc"> <p>An arbitrary value of type <code class="code">t</code>; describes an empty ghost range.</p> </div> </div> <pre><span id="VALin_file"><span class="keyword">val</span> in_file</span> : <code class="type">string -> <a href="Location.html#TYPEt">t</a></code></pre><div class="info "> <div class="info-desc"> <p>Return an empty ghost range located in a given file.</p> </div> </div> <pre><span id="VALinit"><span class="keyword">val</span> init</span> : <code class="type"><a href="Lexing.html#TYPElexbuf">Lexing.lexbuf</a> -> string -> unit</code></pre><div class="info "> <div class="info-desc"> <p>Set the file name and line number of the <code class="code">lexbuf</code> to be the start of the named file.</p> </div> </div> <pre><span id="VALcurr"><span class="keyword">val</span> curr</span> : <code class="type"><a href="Lexing.html#TYPElexbuf">Lexing.lexbuf</a> -> <a href="Location.html#TYPEt">t</a></code></pre><div class="info "> <div class="info-desc"> <p>Get the location of the current token from the <code class="code">lexbuf</code>.</p> </div> </div> <pre><span id="VALsymbol_rloc"><span class="keyword">val</span> symbol_rloc</span> : <code class="type">unit -> <a href="Location.html#TYPEt">t</a></code></pre> <pre><span id="VALsymbol_gloc"><span class="keyword">val</span> symbol_gloc</span> : <code class="type">unit -> <a href="Location.html#TYPEt">t</a></code></pre> <pre><span id="VALrhs_loc"><span class="keyword">val</span> rhs_loc</span> : <code class="type">int -> <a href="Location.html#TYPEt">t</a></code></pre><div class="info "> <div class="info-desc"> <p><code class="code">rhs_loc n</code> returns the location of the symbol at position <code class="code">n</code>, starting at 1, in the current parser rule.</p> </div> </div> <pre><span id="VALinput_name"><span class="keyword">val</span> input_name</span> : <code class="type">string <a href="Pervasives.html#TYPEref">ref</a></code></pre> <pre><span id="VALinput_lexbuf"><span class="keyword">val</span> input_lexbuf</span> : <code class="type"><a href="Lexing.html#TYPElexbuf">Lexing.lexbuf</a> option <a href="Pervasives.html#TYPEref">ref</a></code></pre> <pre><span id="VALget_pos_info"><span class="keyword">val</span> get_pos_info</span> : <code class="type"><a href="Lexing.html#TYPEposition">Lexing.position</a> -> string * int * int</code></pre> <pre><span id="VALprint_loc"><span class="keyword">val</span> print_loc</span> : <code class="type"><a href="Format.html#TYPEformatter">Format.formatter</a> -> <a href="Location.html#TYPEt">t</a> -> unit</code></pre> <pre><span id="VALprint_error_prefix"><span class="keyword">val</span> print_error_prefix</span> : <code class="type"><a href="Format.html#TYPEformatter">Format.formatter</a> -> unit</code></pre> <pre><span id="VALprint_error"><span class="keyword">val</span> print_error</span> : <code class="type"><a href="Format.html#TYPEformatter">Format.formatter</a> -> <a href="Location.html#TYPEt">t</a> -> unit</code></pre> <pre><span id="VALprint_error_cur_file"><span class="keyword">val</span> print_error_cur_file</span> : <code class="type"><a href="Format.html#TYPEformatter">Format.formatter</a> -> unit -> unit</code></pre> <pre><span id="VALprint_warning"><span class="keyword">val</span> print_warning</span> : <code class="type"><a href="Location.html#TYPEt">t</a> -> <a href="Format.html#TYPEformatter">Format.formatter</a> -> <a href="Warnings.html#TYPEt">Warnings.t</a> -> unit</code></pre> <pre><span id="VALformatter_for_warnings"><span class="keyword">val</span> formatter_for_warnings</span> : <code class="type"><a href="Format.html#TYPEformatter">Format.formatter</a> <a href="Pervasives.html#TYPEref">ref</a></code></pre> <pre><span id="VALprerr_warning"><span class="keyword">val</span> prerr_warning</span> : <code class="type"><a href="Location.html#TYPEt">t</a> -> <a href="Warnings.html#TYPEt">Warnings.t</a> -> unit</code></pre> <pre><span id="VALecho_eof"><span class="keyword">val</span> echo_eof</span> : <code class="type">unit -> unit</code></pre> <pre><span id="VALreset"><span class="keyword">val</span> reset</span> : <code class="type">unit -> unit</code></pre> <pre><span id="VALdefault_printer"><span class="keyword">val</span> default_printer</span> : <code class="type"><a href="Format.html#TYPEformatter">Format.formatter</a> -> <a href="Location.html#TYPEt">t</a> -> unit</code></pre> <pre><span id="VALprinter"><span class="keyword">val</span> printer</span> : <code class="type">(<a href="Format.html#TYPEformatter">Format.formatter</a> -> <a href="Location.html#TYPEt">t</a> -> unit) <a href="Pervasives.html#TYPEref">ref</a></code></pre> <pre><span id="VALwarning_printer"><span class="keyword">val</span> warning_printer</span> : <code class="type">(<a href="Location.html#TYPEt">t</a> -> <a href="Format.html#TYPEformatter">Format.formatter</a> -> <a href="Warnings.html#TYPEt">Warnings.t</a> -> unit) <a href="Pervasives.html#TYPEref">ref</a></code></pre><div class="info "> <div class="info-desc"> <p>Hook for intercepting warnings.</p> </div> </div> <pre><span id="VALdefault_warning_printer"><span class="keyword">val</span> default_warning_printer</span> : <code class="type"><a href="Location.html#TYPEt">t</a> -> <a href="Format.html#TYPEformatter">Format.formatter</a> -> <a href="Warnings.html#TYPEt">Warnings.t</a> -> unit</code></pre><div class="info "> <div class="info-desc"> <p>Original warning printer for use in hooks.</p> </div> </div> <pre><span id="VALhighlight_locations"><span class="keyword">val</span> highlight_locations</span> : <code class="type"><a href="Format.html#TYPEformatter">Format.formatter</a> -> <a href="Location.html#TYPEt">t</a> list -> bool</code></pre> <pre><span id="VALshow_code_at_location"><span class="keyword">val</span> show_code_at_location</span> : <code class="type"><a href="Format.html#TYPEformatter">Format.formatter</a> -> <a href="Lexing.html#TYPElexbuf">Lexing.lexbuf</a> -> <a href="Location.html#TYPEt">t</a> -> unit</code></pre> <pre><code><span id="TYPEloc"><span class="keyword">type</span> <code class="type">'a</code> loc</span> = {</code></pre><table class="typetable"> <tr> <td align="left" valign="top" > <code> </code></td> <td align="left" valign="top" > <code><span id="TYPEELTloc.txt">txt</span> : <code class="type">'a</code>;</code></td> </tr> <tr> <td align="left" valign="top" > <code> </code></td> <td align="left" valign="top" > <code><span id="TYPEELTloc.loc">loc</span> : <code class="type"><a href="Location.html#TYPEt">t</a></code>;</code></td> </tr></table> } <pre><span id="VALmknoloc"><span class="keyword">val</span> mknoloc</span> : <code class="type">'a -> 'a <a href="Location.html#TYPEloc">loc</a></code></pre> <pre><span id="VALmkloc"><span class="keyword">val</span> mkloc</span> : <code class="type">'a -> <a href="Location.html#TYPEt">t</a> -> 'a <a href="Location.html#TYPEloc">loc</a></code></pre> <pre><span id="VALprint"><span class="keyword">val</span> print</span> : <code class="type"><a href="Format.html#TYPEformatter">Format.formatter</a> -> <a href="Location.html#TYPEt">t</a> -> unit</code></pre> <pre><span id="VALprint_compact"><span class="keyword">val</span> print_compact</span> : <code class="type"><a href="Format.html#TYPEformatter">Format.formatter</a> -> <a href="Location.html#TYPEt">t</a> -> unit</code></pre> <pre><span id="VALprint_filename"><span class="keyword">val</span> print_filename</span> : <code class="type"><a href="Format.html#TYPEformatter">Format.formatter</a> -> string -> unit</code></pre> <pre><span id="VALrewrite_absolute_path"><span class="keyword">val</span> rewrite_absolute_path</span> : <code class="type">string -> string</code></pre><div class="info "> <div class="info-desc"> <p>rewrite absolute path to honor the BUILD_PATH_PREFIX_MAP variable (https://reproducible-builds.org/specs/build-path-prefix-map/) if it is set.</p> </div> </div> <pre><span id="VALabsolute_path"><span class="keyword">val</span> absolute_path</span> : <code class="type">string -> string</code></pre> <pre><span id="VALshow_filename"><span class="keyword">val</span> show_filename</span> : <code class="type">string -> string</code></pre><div class="info "> <div class="info-desc"> <p>In -absname mode, return the absolute path for this filename. Otherwise, returns the filename unchanged.</p> </div> </div> <pre><span id="VALabsname"><span class="keyword">val</span> absname</span> : <code class="type">bool <a href="Pervasives.html#TYPEref">ref</a></code></pre><p>Support for located errors</p> <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> </code></td> <td align="left" valign="top" > <code><span id="TYPEELTerror.loc">loc</span> : <code class="type"><a href="Location.html#TYPEt">t</a></code>;</code></td> </tr> <tr> <td align="left" valign="top" > <code> </code></td> <td align="left" valign="top" > <code><span id="TYPEELTerror.msg">msg</span> : <code class="type">string</code>;</code></td> </tr> <tr> <td align="left" valign="top" > <code> </code></td> <td align="left" valign="top" > <code><span id="TYPEELTerror.sub">sub</span> : <code class="type"><a href="Location.html#TYPEerror">error</a> list</code>;</code></td> </tr> <tr> <td align="left" valign="top" > <code> </code></td> <td align="left" valign="top" > <code><span id="TYPEELTerror.if_highlight">if_highlight</span> : <code class="type">string</code>;</code></td> </tr></table> } <pre><span id="EXCEPTIONAlready_displayed_error"><span class="keyword">exception</span> Already_displayed_error</span></pre> <pre><span id="EXCEPTIONError"><span class="keyword">exception</span> Error</span> <span class="keyword">of</span> <code class="type"><a href="Location.html#TYPEerror">error</a></code></pre> <pre><span id="VALerror"><span class="keyword">val</span> error</span> : <code class="type">?loc:<a href="Location.html#TYPEt">t</a> -><br> ?sub:<a href="Location.html#TYPEerror">error</a> list -> ?if_highlight:string -> string -> <a href="Location.html#TYPEerror">error</a></code></pre> <pre><span id="VALerrorf"><span class="keyword">val</span> errorf</span> : <code class="type">?loc:<a href="Location.html#TYPEt">t</a> -><br> ?sub:<a href="Location.html#TYPEerror">error</a> list -><br> ?if_highlight:string -><br> ('a, <a href="Format.html#TYPEformatter">Format.formatter</a>, unit, <a href="Location.html#TYPEerror">error</a>) <a href="Pervasives.html#TYPEformat4">format4</a> -> 'a</code></pre> <pre><span id="VALraise_errorf"><span class="keyword">val</span> raise_errorf</span> : <code class="type">?loc:<a href="Location.html#TYPEt">t</a> -><br> ?sub:<a href="Location.html#TYPEerror">error</a> list -><br> ?if_highlight:string -><br> ('a, <a href="Format.html#TYPEformatter">Format.formatter</a>, unit, 'b) <a href="Pervasives.html#TYPEformat4">format4</a> -> 'a</code></pre> <pre><span id="VALerror_of_printer"><span class="keyword">val</span> error_of_printer</span> : <code class="type"><a href="Location.html#TYPEt">t</a> -> (<a href="Format.html#TYPEformatter">Format.formatter</a> -> 'a -> unit) -> 'a -> <a href="Location.html#TYPEerror">error</a></code></pre> <pre><span id="VALerror_of_printer_file"><span class="keyword">val</span> error_of_printer_file</span> : <code class="type">(<a href="Format.html#TYPEformatter">Format.formatter</a> -> 'a -> unit) -> 'a -> <a href="Location.html#TYPEerror">error</a></code></pre> <pre><span id="VALerror_of_exn"><span class="keyword">val</span> error_of_exn</span> : <code class="type">exn -> [ `Already_displayed | `Ok of <a href="Location.html#TYPEerror">error</a> ] option</code></pre> <pre><span id="VALregister_error_of_exn"><span class="keyword">val</span> register_error_of_exn</span> : <code class="type">(exn -> <a href="Location.html#TYPEerror">error</a> option) -> unit</code></pre><div class="info "> <div class="info-desc"> <p>Each compiler module which defines a custom type of exception which can surface as a user-visible error should register a "printer" for this exception using <code class="code">register_error_of_exn</code>. The result of the printer is an <code class="code">error</code> value containing a location, a message, and optionally sub-messages (each of them being located as well).</p> </div> </div> <pre><span id="VALreport_error"><span class="keyword">val</span> report_error</span> : <code class="type"><a href="Format.html#TYPEformatter">Format.formatter</a> -> <a href="Location.html#TYPEerror">error</a> -> unit</code></pre> <pre><span id="VALerror_reporter"><span class="keyword">val</span> error_reporter</span> : <code class="type">(<a href="Format.html#TYPEformatter">Format.formatter</a> -> <a href="Location.html#TYPEerror">error</a> -> unit) <a href="Pervasives.html#TYPEref">ref</a></code></pre><div class="info "> <div class="info-desc"> <p>Hook for intercepting error reports.</p> </div> </div> <pre><span id="VALdefault_error_reporter"><span class="keyword">val</span> default_error_reporter</span> : <code class="type"><a href="Format.html#TYPEformatter">Format.formatter</a> -> <a href="Location.html#TYPEerror">error</a> -> unit</code></pre><div class="info "> <div class="info-desc"> <p>Original error reporter for use in hooks.</p> </div> </div> <pre><span id="VALreport_exception"><span class="keyword">val</span> report_exception</span> : <code class="type"><a href="Format.html#TYPEformatter">Format.formatter</a> -> exn -> unit</code></pre><div class="info "> <div class="info-desc"> <p>Reraise the exception if it is unknown.</p> </div> </div> <pre><span id="VALdeprecated"><span class="keyword">val</span> deprecated</span> : <code class="type">?def:<a href="Location.html#TYPEt">t</a> -> ?use:<a href="Location.html#TYPEt">t</a> -> <a href="Location.html#TYPEt">t</a> -> string -> unit</code></pre></body></html>