/usr/lib/ocaml/batteries/batCharParser.mli is in libbatteries-ocaml-dev 2.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | (*
* CharParser - Parsing character strings
* Copyright (C) 2008 David Teller
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version,
* with the special exception on linking described in file LICENSE.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*)
(** Parsing character strings.
This module defines common functions for parsing character strings,
encoded in Latin-1. These functions are meant to be used in conjunction
with the {!ParserCo} module.
{b Note} As ParserCo, this module is still very rough and needs testing.
@author David Teller
*)
open BatParserCo
(** The position inside one file or one stream. *)
type position =
{
offset: int;(**Offset on the line (starting at 0)*)
line: int (**Line number (starting at 0)*)
}
val advance : char -> position -> position
(**Advance by one char.
[advance c p] returns a new position advanced by one char. If [c] is '\r' or '\n',
the result is [{offset = 0; line = p.line + 1}]. Other wise, the result is
[{offset = p.offset + 1; line = p.line}].*)
val source_of_string : string -> (char, position) Source.t
(** Create a source from a latin-1 character string.*)
val source_of_enum : char BatEnum.t -> (char, position) Source.t
(** Create a source from a latin-1 character.*)
val parse : (char, 'a, position) t -> string -> ('a, position report) BatPervasives.result
(**Apply a parser to a string.*)
(**{6 Utilities}*)
val char : char -> (char, char, position) t
(** Recognize exactly one char*)
val none_of : char list -> (char, char, position) t
(**Accept any value not in a list
As [ParserCo.none_of], just with improved error message.*)
val not_char : char -> (char, char, position) t
(**Accept any value not a given char
As [none_of]. *)
val string : string -> (char, string, position) t
(** Recognize exactly one string*)
val case_char : char -> (char, char, position) t
(** As [char], but case-insensitive *)
val case_string : string -> (char, string, position) t
(** As [case_string], but case-insensitive *)
val newline : (char, char, position) t
(**Recognizes a newline*)
val whitespace : (char, char, position) t
(**Recognizes white-space*)
val uppercase : (char, char, position) t
(**Recognizes one upper-case ASCII character, including
accentuated characters.*)
val lowercase : (char, char, position) t
(**Recognizes one lower-case ASCII character, including
accentuated characters.*)
val letter: (char, char, position) t
(**Recognizes one lower- or upper-case ASCII character, including
accentuated characters.*)
val uppercase_latin1 : (char, char, position) t
(**Recognizes one upper-case Latin-1 character, including
accentuated characters.*)
val lowercase_latin1 : (char, char, position) t
(**Recognizes one lower-case Latin-1 character, including
accentuated characters.*)
val latin1: (char, char, position) t
(**Recognizes one lower- or upper-case Latin1 character, including
accentuated characters.*)
val digit : (char, char, position) t
(**Recognizes one decimal digit*)
val hex : (char, char, position) t
(**Recognizes one hexadecimal digit (case-insensitive)*)
|