ident.mli 3.61 KB
Newer Older
1 2
(**************************************************************************)
(*                                                                        *)
3
(*  Copyright (C) 2010-2011                                               *)
4 5 6
(*    François Bobot                                                      *)
(*    Jean-Christophe Filliâtre                                           *)
(*    Claude Marché                                                       *)
7 8 9 10 11 12 13 14 15 16 17 18 19
(*    Andrei Paskevich                                                    *)
(*                                                                        *)
(*  This software is free software; you can redistribute it and/or        *)
(*  modify it under the terms of the GNU Library General Public           *)
(*  License version 2.1, with the special exception on linking            *)
(*  described in file LICENSE.                                            *)
(*                                                                        *)
(*  This software 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.                  *)
(*                                                                        *)
(**************************************************************************)

François Bobot's avatar
François Bobot committed
20 21
open Stdlib

MARCHE Claude's avatar
MARCHE Claude committed
22 23
(** Identifiers *)

MARCHE Claude's avatar
MARCHE Claude committed
24 25
(** {2 Labels} *)

Andrei Paskevich's avatar
Andrei Paskevich committed
26 27 28 29 30 31 32 33 34
type label = private {
  lab_string : string;
  lab_tag    : int;
}

val lab_equal : label -> label -> bool
val lab_hash  : label -> int

val create_label : string -> label
MARCHE Claude's avatar
MARCHE Claude committed
35 36

(** {2 Identifiers} *)
37 38

type ident = private {
39 40 41 42
  id_string : string;               (* non-unique name *)
  id_label  : label list;           (* identifier labels *)
  id_loc    : Loc.position option;  (* optional location *)
  id_tag    : Hashweak.tag;         (* unique magical tag *)
43 44 45
}

module Mid : Map.S with type key = ident
46
module Sid : Mid.Set
47 48
module Hid : Hashtbl.S with type key = ident

49 50
val id_equal : ident -> ident -> bool

Andrei Paskevich's avatar
Andrei Paskevich committed
51 52
val id_hash : ident -> int

53 54
(* a user-created type of unregistered identifiers *)
type preid
55

56
(* register a pre-ident (you should never use this function) *)
57
val id_register : preid -> ident
58

59
(* create a fresh pre-ident *)
60
val id_fresh : ?label:(label list) -> ?loc:Loc.position -> string -> preid
61

62
(* create a localized pre-ident *)
63
val id_user : ?label:(label list) -> string -> Loc.position -> preid
64 65

(* create a duplicate pre-ident *)
66
val id_clone : ?label:(label list) -> ident -> preid
67

68 69
(* create a derived pre-ident (inherit labels and location) *)
val id_derive : ?label:(label list) -> string -> ident -> preid
70

Francois Bobot's avatar
Francois Bobot committed
71

72 73
(** Unique persistent names for pretty printing *)

74
type ident_printer
75

76 77
val create_ident_printer :
  ?sanitizer : (string -> string) -> string list -> ident_printer
MARCHE Claude's avatar
MARCHE Claude committed
78
(** start a new printer with a sanitizing function and a blacklist *)
79

80 81
val id_unique :
  ident_printer -> ?sanitizer : (string -> string) -> ident -> string
82
(** use ident_printer to generate a unique name for ident
MARCHE Claude's avatar
MARCHE Claude committed
83
    an optional sanitizer is applied over the printer's sanitizer *)
84

85
val string_unique : ident_printer -> string -> string
MARCHE Claude's avatar
MARCHE Claude committed
86
(** Uniquify string *)
87

88
val forget_id : ident_printer -> ident -> unit
MARCHE Claude's avatar
MARCHE Claude committed
89
(** forget an ident *)
90

91
val forget_all : ident_printer -> unit
MARCHE Claude's avatar
MARCHE Claude committed
92
(** forget all idents *)
93 94

val sanitizer : (char -> string) -> (char -> string) -> string -> string
MARCHE Claude's avatar
MARCHE Claude committed
95 96 97
(** generic sanitizer taking a separate encoder for the first letter *)

(** various character encoders *)
98 99 100 101 102 103

val char_to_alpha : char -> string
val char_to_lalpha : char -> string
val char_to_ualpha : char -> string
val char_to_alnum : char -> string
val char_to_alnumus : char -> string
104