ident.mli 3.46 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} *)

26
type label = string
MARCHE Claude's avatar
MARCHE Claude committed
27 28

(** {2 Identifiers} *)
29 30

type ident = private {
31 32 33 34
  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 *)
35 36 37
}

module Mid : Map.S with type key = ident
38
module Sid : Mid.Set
39 40
module Hid : Hashtbl.S with type key = ident

41 42
val id_equal : ident -> ident -> bool

Andrei Paskevich's avatar
Andrei Paskevich committed
43 44
val id_hash : ident -> int

45 46
(* a user-created type of unregistered identifiers *)
type preid
47

48
(* register a pre-ident (you should never use this function) *)
49
val id_register : preid -> ident
50

51
(* create a fresh pre-ident *)
52
val id_fresh : ?label:(label list) -> ?loc:Loc.position -> string -> preid
53

54
(* create a localized pre-ident *)
55
val id_user : ?label:(label list) -> string -> Loc.position -> preid
56 57

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

60 61
(* create a derived pre-ident (inherit labels and location) *)
val id_derive : ?label:(label list) -> string -> ident -> preid
62

Francois Bobot's avatar
Francois Bobot committed
63

64 65
(** Unique persistent names for pretty printing *)

66
type ident_printer
67

68 69
val create_ident_printer :
  ?sanitizer : (string -> string) -> string list -> ident_printer
MARCHE Claude's avatar
MARCHE Claude committed
70
(** start a new printer with a sanitizing function and a blacklist *)
71

72 73
val id_unique :
  ident_printer -> ?sanitizer : (string -> string) -> ident -> string
74
(** use ident_printer to generate a unique name for ident
MARCHE Claude's avatar
MARCHE Claude committed
75
    an optional sanitizer is applied over the printer's sanitizer *)
76

77
val string_unique : ident_printer -> string -> string
MARCHE Claude's avatar
MARCHE Claude committed
78
(** Uniquify string *)
79

80
val forget_id : ident_printer -> ident -> unit
MARCHE Claude's avatar
MARCHE Claude committed
81
(** forget an ident *)
82

83
val forget_all : ident_printer -> unit
MARCHE Claude's avatar
MARCHE Claude committed
84
(** forget all idents *)
85 86

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

(** various character encoders *)
90 91 92 93 94 95

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
96