← Back to branch summary

~ubuntu-branches/ubuntu/precise/ocaml-batteries/precise

« back to all changes in this revision

Viewing changes to src/core/extlib/uCharParser.mli

  • Committer: Bazaar Package Importer
  • Author(s): Stefano Zacchiroli
  • Date: 2010-03-06 16:03:38 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20100306160338-spvwiv3uc4jr28hw
Tags: 1.1.0-1
http://bugs.debian.org/569455
http://bugs.debian.org/514265
* New upstream release
  - major changes, "diet" version of the library
  - fix old FTBFS error, due to major code changes (Closes: #569455)
* Revamp packaging
  - adapt to new stuff shipped by upstream
  - switch from CDBS to dh
  - adapt dependencies (generally: reduce them)
* debian/patches/
  - remove old debian/patches/{debian-specific-installation-paths,
    debian-specific-info-on-doc-availability} as obsolete
  - new patch 0001-install-fix-for-bytecode-only-build: avoid
    installing *.a files with bytecode only compilation
* debian/libbatteries-ocaml-dev.links: remove file, shortend
  /usr/bin/ocaml-batteries to the top-level no longer exists
* remove debian/README.Debian (previous content is now obsolete)
* bump Standards-Version to 3.8.4 (no changes needed)
* debian/watch: update to match new upstream version convention
* debian/libbatteries-ocaml-{dev,doc}.{docs,examples}: ship only doc
  file from the root dir, other stuff is currently out of date
  (Closes: #514265)

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/core/extlib/uCharParser.mli
1
 
(* 
2
 
 * CharParser - Parsing unicode text
3
 
 * Copyright (C) 2008 David Teller
4
 
 *
5
 
 * This library is free software; you can redistribute it and/or
6
 
 * modify it under the terms of the GNU Lesser General Public
7
 
 * License as published by the Free Software Foundation; either
8
 
 * version 2.1 of the License, or (at your option) any later version,
9
 
 * with the special exception on linking described in file LICENSE.
10
 
 *
11
 
 * This library is distributed in the hope that it will be useful,
12
 
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13
 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14
 
 * Lesser General Public License for more details.
15
 
 *
16
 
 * You should have received a copy of the GNU Lesser General Public
17
 
 * License along with this library; if not, write to the Free Software
18
 
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
 
 *)
20
 
 
21
 
(** Parsing unicode text
22
 
 
23
 
    This module defines common functions for parsing Unicode
24
 
    texts. These functions are meant to be used in conjunction with
25
 
    the {!ParserCo} module.
26
 
 
27
 
    {b Note} As ParserCo, this module is still very rough and needs testing.
28
 
 
29
 
    @author David Teller
30
 
*)
31
 
 
32
 
open ParserCo
33
 
open ExtUChar
34
 
open ExtUTF8
35
 
 
36
 
(** The position inside one file or one stream. *)
37
 
type position = CharParser.position = 
38
 
{
39
 
  offset: int;(**Offset on the line (starting at 0)*)
40
 
  line:   int (**Line number (starting at 0)*)
41
 
}
42
 
 
43
 
val advance : UChar.t-> position -> position
44
 
(**Advance by one char. 
45
 
 
46
 
   [advance c p] returns a new position advanced by one char. If [c] is '\r' or '\n',
47
 
   the result is [{offset = 0; line = p.line + 1}]. Other wise, the result is
48
 
   [{offset = p.offset + 1; line = p.line}].*)
49
 
 
50
 
val source_of_rope : Rope.t      -> (UChar.t, position) Source.t
51
 
(** Create a source from a Unicode Rope.*)
52
 
 
53
 
val source_of_enum : UChar.t Enum.t -> (UChar.t, position) Source.t
54
 
(** Create a source from an enumeration of unicode characters.*)
55
 
 
56
 
val parse : (UChar.t, 'a, position) t -> Rope.t -> ('a, position report) Std.result
57
 
(**Apply a parser to a Unicode Rope.*)
58
 
 
59
 
(**{6 Utilities}*)
60
 
 
61
 
val char : UChar.t -> (UChar.t, UChar.t, position) t
62
 
  (** Recognize exactly one char*)
63
 
 
64
 
val none_of : UChar.t list -> (UChar.t, UChar.t, position) t
65
 
  (**Accept any value not in a list
66
 
     As [ParserCo.none_of], just with improved error message.*)
67
 
 
68
 
val not_char : UChar.t -> (UChar.t, UChar.t, position) t
69
 
  (**Accept any value not a given char
70
 
     As [none_of]. *)
71
 
 
72
 
val string : string -> (UChar.t, string, position) t
73
 
  (** Recognize exactly one string*)
74
 
 
75
 
val rope : Rope.t -> (UChar.t, Rope.t, position) t
76
 
  (** Recognize exactly one string*)
77
 
 
78
 
val ustring : UTF8.t -> (UChar.t, UTF8.t, position) t
79
 
  (** Recognize exactly one string*)
80
 
 
81
 
val case_char : UChar.t -> (UChar.t, UTF8.t, position) t
82
 
  (** As [char], but case-insensitive *)
83
 
 
84
 
val case_string : string -> (UChar.t, string, position) t
85
 
  (** As [string], but case-insensitive *)
86
 
 
87
 
val case_ustring : UTF8.t -> (UChar.t, UTF8.t, position) t
88
 
  (** As [ustring], but case-insensitive *)
89
 
 
90
 
val case_rope : Rope.t -> (UChar.t, Rope.t, position) t
91
 
  (** As [rope], but case-insensitive *)
92
 
 
93
 
val newline : (UChar.t, UChar.t, position) t
94
 
  (**Recognizes a newline*)
95
 
 
96
 
val whitespace : (UChar.t, UChar.t, position) t
97
 
  (**Recognizes white-space*)
98
 
 
99
 
val uppercase : (UChar.t, UChar.t, position) t
100
 
  (**Recognizes one upper-case ASCII character, including
101
 
     accentuated characters.*)
102
 
 
103
 
val lowercase : (UChar.t, UChar.t, position) t
104
 
  (**Recognizes one lower-case character, including
105
 
     accentuated characters.*)
106
 
 
107
 
val letter: (UChar.t, UChar.t, position) t
108
 
  (**Recognizes one lower- or upper-case character.*)
109
 
 
110
 
val digit : (UChar.t, UChar.t, position) t
111
 
  (**Recognizes one decimal digit*)
112
 
 
113
 
val hex : (UChar.t, UChar.t, position) t
114
 
  (**Recognizes one hexadecimal digit (case-insensitive)*)
115