Sanitize header files and add a timestamp mark in each source file.
[tatoo.git] / src / qName.mli
1 (***********************************************************************)
2 (*                                                                     *)
3 (*                               TAToo                                 *)
4 (*                                                                     *)
5 (*                     Kim Nguyen, LRI UMR8623                         *)
6 (*                   Université Paris-Sud & CNRS                       *)
7 (*                                                                     *)
8 (*  Copyright 2010-2012 Université Paris-Sud and Centre National de la *)
9 (*  Recherche Scientifique. All rights reserved.  This file is         *)
10 (*  distributed under the terms of the GNU Lesser General Public       *)
11 (*  License, with the special exception on linking described in file   *)
12 (*  ../LICENSE.                                                        *)
13 (*                                                                     *)
14 (***********************************************************************)
15
16 (*
17   Time-stamp: <Last modified on 2013-01-30 19:07:34 CET by Kim Nguyen>
18 *)
19
20 (** Implementation of qualified names as hashconsed strings *)
21
22 include Sigs.HCONS.S with type data = string
23 include Sigs.AUX.Printable with type t := t
24
25
26 val of_string : string -> t
27 (** Utility function, equivalent to [make] *)
28
29 val to_string : t -> string
30 (** Utility function, equivalent to [node] *)
31
32
33 (** Special constants, that denote the QName of nodes that are not
34     elements (using the nodeValue property of DOM for such nodes.
35 *)
36
37 val document : t
38 (** Represents the QName of a document node. Equivalent to
39     [of_string "#document"]
40 *)
41
42 val text : t
43 (** Represents the QName of a text node. Equivalent to
44     [of_string "#text"]
45 *)
46
47 val cdata_section : t
48 (** Represents the QName of a document node. Equivalent to
49     [of_string "#cdata-section"]
50 *)
51
52 val comment : t
53 (** Represents the QName of a comment node. Equivalent to
54     [of_string "#cdata-section"]
55 *)
56
57 val document_fragment : t
58 (** Represents the QName of a document fragment. Equivalent to
59     [of_string "#document-fragment"]
60 *)
61
62 val attribute_map : t
63 (** Represents the QName of a dummy document node holding the
64     attributes of the current element. Equivalent to
65     [of_string "#attribute-map"]
66 *)
67
68 val nil : t
69 (** Represents the QName of a nil node. Equivalent to
70     [of_string "#"]
71 *)