ident.mli 6.34 KB
Newer Older
Andrei Paskevich's avatar
Andrei Paskevich committed
1 2 3
(********************************************************************)
(*                                                                  *)
(*  The Why3 Verification Platform   /   The Why3 Development Team  *)
Guillaume Melquiond's avatar
Guillaume Melquiond committed
4
(*  Copyright 2010-2018   --   Inria - CNRS - Paris-Sud University  *)
Andrei Paskevich's avatar
Andrei Paskevich committed
5 6 7 8
(*                                                                  *)
(*  This software is distributed under the terms of the GNU Lesser  *)
(*  General Public License version 2.1, with the special exception  *)
(*  on linking described in file LICENSE.                           *)
9
(*                                                                  *)
Andrei Paskevich's avatar
Andrei Paskevich committed
10
(********************************************************************)
11

MARCHE Claude's avatar
MARCHE Claude committed
12 13
(** Identifiers *)

Andrei Paskevich's avatar
Andrei Paskevich committed
14
(** {2 Attributes} *)
MARCHE Claude's avatar
MARCHE Claude committed
15

Andrei Paskevich's avatar
Andrei Paskevich committed
16 17 18
type attribute = private {
  attr_string : string;
  attr_tag    : int;
Andrei Paskevich's avatar
Andrei Paskevich committed
19 20
}

Andrei Paskevich's avatar
Andrei Paskevich committed
21 22
module Mattr : Extmap.S with type key = attribute
module Sattr : Extset.S with module M = Mattr
23

Andrei Paskevich's avatar
Andrei Paskevich committed
24 25 26
val attr_compare : attribute -> attribute -> int
val attr_equal : attribute -> attribute -> bool
val attr_hash : attribute -> int
Andrei Paskevich's avatar
Andrei Paskevich committed
27

Andrei Paskevich's avatar
Andrei Paskevich committed
28
val create_attribute : string -> attribute
MARCHE Claude's avatar
MARCHE Claude committed
29

Andrei Paskevich's avatar
Andrei Paskevich committed
30
val list_attributes : unit -> string list
31

32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
(** {2 Naming convention } *)

val infix: string -> string
(** Apply the naming convention for infix operator (+) *)

val prefix: string -> string
(** Apply the naming convention for prefix operator *)

val mixfix: string -> string
(** Apply the naming convention for mixfix operator *)

val kind_of_fix: string -> [ `None
                           | `Prefix of string
                           | `Infix  of string
                           | `Mixfix of string ]

MARCHE Claude's avatar
MARCHE Claude committed
48
(** {2 Identifiers} *)
49 50

type ident = private {
Piotr Trojanek's avatar
Piotr Trojanek committed
51
  id_string : string;               (** non-unique name *)
Andrei Paskevich's avatar
Andrei Paskevich committed
52
  id_attrs  : Sattr.t;              (** identifier attributes *)
Piotr Trojanek's avatar
Piotr Trojanek committed
53 54
  id_loc    : Loc.position option;  (** optional location *)
  id_tag    : Weakhtbl.tag;         (** unique magical tag *)
55 56
}

57 58 59
module Mid : Extmap.S with type key = ident
module Sid : Extset.S with module M = Mid
module Hid : Exthtbl.S with type key = ident
Andrei Paskevich's avatar
Andrei Paskevich committed
60
module Wid : Weakhtbl.S with type key = ident
61

Andrei Paskevich's avatar
Andrei Paskevich committed
62
val id_compare : ident -> ident -> int
63
val id_equal : ident -> ident -> bool
Andrei Paskevich's avatar
Andrei Paskevich committed
64 65
val id_hash : ident -> int

Piotr Trojanek's avatar
Piotr Trojanek committed
66
(** a user-created type of unregistered identifiers *)
67 68
type preid = {
  pre_name  : string;
Andrei Paskevich's avatar
Andrei Paskevich committed
69
  pre_attrs : Sattr.t;
70 71
  pre_loc   : Loc.position option;
}
72

Piotr Trojanek's avatar
Piotr Trojanek committed
73
(** register a pre-ident (you should never use this function) *)
74
val id_register : preid -> ident
75

Piotr Trojanek's avatar
Piotr Trojanek committed
76
(** create a fresh pre-ident *)
Andrei Paskevich's avatar
Andrei Paskevich committed
77
val id_fresh : ?attrs:Sattr.t -> ?loc:Loc.position -> string -> preid
78

Piotr Trojanek's avatar
Piotr Trojanek committed
79
(** create a localized pre-ident *)
Andrei Paskevich's avatar
Andrei Paskevich committed
80
val id_user : ?attrs:Sattr.t -> string -> Loc.position -> preid
81

Andrei Paskevich's avatar
Andrei Paskevich committed
82 83
(** create a duplicate pre-ident with given attributes *)
val id_attr : ident -> Sattr.t -> preid
84

Piotr Trojanek's avatar
Piotr Trojanek committed
85
(** create a duplicate pre-ident *)
Andrei Paskevich's avatar
Andrei Paskevich committed
86
val id_clone : ?attrs:Sattr.t -> ident -> preid
87

Andrei Paskevich's avatar
Andrei Paskevich committed
88 89
(** create a derived pre-ident (inherit attributes and location) *)
val id_derive : ?attrs:Sattr.t -> string -> ident -> preid
90

91
(* DEPRECATED : retrieve preid name without registering *)
92
val preid_name : preid -> string
Francois Bobot's avatar
Francois Bobot committed
93

94 95
(** Unique persistent names for pretty printing *)

96
type ident_printer
97

98 99
val create_ident_printer :
  ?sanitizer : (string -> string) -> string list -> ident_printer
MARCHE Claude's avatar
MARCHE Claude committed
100
(** start a new printer with a sanitizing function and a blacklist *)
101

102 103
val id_unique :
  ident_printer -> ?sanitizer : (string -> string) -> ident -> string
104
(** use ident_printer to generate a unique name for ident
MARCHE Claude's avatar
MARCHE Claude committed
105
    an optional sanitizer is applied over the printer's sanitizer *)
106

107
val string_unique : ident_printer -> string -> string
MARCHE Claude's avatar
MARCHE Claude committed
108
(** Uniquify string *)
109

110 111 112 113
val known_id: ident_printer -> ident -> bool
(** Returns true if the printer already knows the id.
    false if it does not. *)

114
val forget_id : ident_printer -> ident -> unit
MARCHE Claude's avatar
MARCHE Claude committed
115
(** forget an ident *)
116

117
val forget_all : ident_printer -> unit
MARCHE Claude's avatar
MARCHE Claude committed
118
(** forget all idents *)
119

120 121 122
val sanitizer' : (char -> string) -> (char -> string) -> (char -> string) -> string -> string
(** generic sanitizer taking a separate encoder for the first and last letter *)

123
val sanitizer : (char -> string) -> (char -> string) -> string -> string
MARCHE Claude's avatar
MARCHE Claude committed
124 125 126
(** generic sanitizer taking a separate encoder for the first letter *)

(** various character encoders *)
127 128 129 130 131

val char_to_alpha : char -> string
val char_to_lalpha : char -> string
val char_to_ualpha : char -> string
val char_to_alnum : char -> string
132
val char_to_lalnum : char -> string
133
val char_to_alnumus : char -> string
134
val char_to_lalnumus : char -> string
135 136 137 138


(** {2 Name handling for ITP} *)

Andrei Paskevich's avatar
Andrei Paskevich committed
139 140
(* TODO: integrate this functionality into id_unique *)
val id_unique_attr :
141
  ident_printer -> ?sanitizer : (string -> string) -> ident -> string
Andrei Paskevich's avatar
Andrei Paskevich committed
142 143
(** Do the same as id_unique except that it tries first to use
    the "name:" attribute to generate the name instead of id.id_string *)
144

Andrei Paskevich's avatar
Andrei Paskevich committed
145
(** {2 Attributes for handling counterexamples} *)
146

Andrei Paskevich's avatar
Andrei Paskevich committed
147 148
val model_attr : attribute
val model_projected_attr : attribute
149

Andrei Paskevich's avatar
Andrei Paskevich committed
150 151 152
val model_vc_attr : attribute
val model_vc_post_attr : attribute
val model_vc_havoc_attr : attribute
153

Andrei Paskevich's avatar
Andrei Paskevich committed
154 155
val has_a_model_attr : ident -> bool
(** [true] when [ident] has one of the attributes above *)
156

Andrei Paskevich's avatar
Andrei Paskevich committed
157 158
val remove_model_attrs : attrs:Sattr.t -> Sattr.t
(** Remove the counter-example attributes from an attribute set *)
159

Andrei Paskevich's avatar
Andrei Paskevich committed
160
val create_model_trace_attr : string -> attribute
161

Andrei Paskevich's avatar
Andrei Paskevich committed
162
val is_model_trace_attr : attribute -> bool
163

Andrei Paskevich's avatar
Andrei Paskevich committed
164 165 166
val append_to_model_trace_attr : attrs:Sattr.t -> to_append:string -> Sattr.t
(** The returned set of attributes will contain the same set of attributes
    as argument attrs except that an attribute of the form ["model_trace:*"]
167 168
    will be ["model_trace:*to_append"]. *)

Andrei Paskevich's avatar
Andrei Paskevich committed
169 170 171
val append_to_model_element_name : attrs:Sattr.t -> to_append:string -> Sattr.t
(** The returned set of attributes will contain the same set of attributes
    as argument attrs except that an attribute of the form ["model_trace:*@*"]
172 173
    will be ["model_trace:*to_append@*"]. *)

Andrei Paskevich's avatar
Andrei Paskevich committed
174 175 176 177
val get_model_element_name : attrs:Sattr.t -> string
(** If attributes contain an attribute of the form ["model_trace:name@*"],
    return ["name"]. Raises [Not_found] if there is no attribute of
    the form ["model_trace:*"]. *)
178

Andrei Paskevich's avatar
Andrei Paskevich committed
179 180 181 182
val get_model_trace_string : attrs:Sattr.t -> string
(** If attrs contain an attribute of the form ["model_trace:mt_string"],
    return ["mt_string"]. Raises [Not_found] if there is no attribute of
    the form ["model_trace:*"]. *)
183

Andrei Paskevich's avatar
Andrei Paskevich committed
184 185 186
val get_model_trace_attr : attrs:Sattr.t -> attribute
(** Return an attribute of the form ["model_trace:*"].
    Raises [Not_found] if there is no such attribute. *)