ident.mli 6.77 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
(** {2 Naming convention} *)

type notation =
  | SNword   of string
  | SNinfix  of string
  | SNprefix of string
38 39 40 41 42 43
  | SNget    of string  (* [] *)
  | SNset    of string  (* []<- *)
  | SNupdate of string  (* [<-] *)
  | SNcut    of string  (* [..] *)
  | SNlcut   of string  (* [.._] *)
  | SNrcut   of string  (* [_..] *)
44 45 46 47 48 49 50

val sn_encode : notation -> string
(* encode the symbol name as a string *)

val sn_decode : string -> notation
(* decode the string as a symbol name *)

51
val print_decoded : Format.formatter -> string -> unit
52 53 54 55 56 57
(* decode the string as a symbol name and pretty-print it *)

(* specialized encoders *)

val op_infix  : string -> string
val op_prefix : string -> string
58 59 60 61 62 63 64 65
val op_get    : string -> string
val op_set    : string -> string
val op_update : string -> string
val op_cut    : string -> string
val op_lcut   : string -> string
val op_rcut   : string -> string
val op_equ    : string
val op_neq    : string
66

MARCHE Claude's avatar
MARCHE Claude committed
67
(** {2 Identifiers} *)
68 69

type ident = private {
Piotr Trojanek's avatar
Piotr Trojanek committed
70
  id_string : string;               (** non-unique name *)
Andrei Paskevich's avatar
Andrei Paskevich committed
71
  id_attrs  : Sattr.t;              (** identifier attributes *)
Piotr Trojanek's avatar
Piotr Trojanek committed
72 73
  id_loc    : Loc.position option;  (** optional location *)
  id_tag    : Weakhtbl.tag;         (** unique magical tag *)
74 75
}

76 77 78
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
79
module Wid : Weakhtbl.S with type key = ident
80

Andrei Paskevich's avatar
Andrei Paskevich committed
81
val id_compare : ident -> ident -> int
82
val id_equal : ident -> ident -> bool
Andrei Paskevich's avatar
Andrei Paskevich committed
83 84
val id_hash : ident -> int

Piotr Trojanek's avatar
Piotr Trojanek committed
85
(** a user-created type of unregistered identifiers *)
86 87
type preid = {
  pre_name  : string;
Andrei Paskevich's avatar
Andrei Paskevich committed
88
  pre_attrs : Sattr.t;
89 90
  pre_loc   : Loc.position option;
}
91

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

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

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

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

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

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

110
(* DEPRECATED : retrieve preid name without registering *)
111
val preid_name : preid -> string
Francois Bobot's avatar
Francois Bobot committed
112

113 114
(** Unique persistent names for pretty printing *)

115
type ident_printer
116

117 118
val create_ident_printer :
  ?sanitizer : (string -> string) -> string list -> ident_printer
MARCHE Claude's avatar
MARCHE Claude committed
119
(** start a new printer with a sanitizing function and a blacklist *)
120

121 122
val id_unique :
  ident_printer -> ?sanitizer : (string -> string) -> ident -> string
123
(** use ident_printer to generate a unique name for ident
MARCHE Claude's avatar
MARCHE Claude committed
124
    an optional sanitizer is applied over the printer's sanitizer *)
125

126
val string_unique : ident_printer -> string -> string
MARCHE Claude's avatar
MARCHE Claude committed
127
(** Uniquify string *)
128

129 130 131 132
val known_id: ident_printer -> ident -> bool
(** Returns true if the printer already knows the id.
    false if it does not. *)

133
val forget_id : ident_printer -> ident -> unit
MARCHE Claude's avatar
MARCHE Claude committed
134
(** forget an ident *)
135

136
val forget_all : ident_printer -> unit
MARCHE Claude's avatar
MARCHE Claude committed
137
(** forget all idents *)
138

139 140 141
val sanitizer' : (char -> string) -> (char -> string) -> (char -> string) -> string -> string
(** generic sanitizer taking a separate encoder for the first and last letter *)

142
val sanitizer : (char -> string) -> (char -> string) -> string -> string
MARCHE Claude's avatar
MARCHE Claude committed
143 144 145
(** generic sanitizer taking a separate encoder for the first letter *)

(** various character encoders *)
146 147 148 149 150

val char_to_alpha : char -> string
val char_to_lalpha : char -> string
val char_to_ualpha : char -> string
val char_to_alnum : char -> string
151
val char_to_lalnum : char -> string
152
val char_to_alnumus : char -> string
153
val char_to_lalnumus : char -> string
154 155 156 157


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

Andrei Paskevich's avatar
Andrei Paskevich committed
158 159
(* TODO: integrate this functionality into id_unique *)
val id_unique_attr :
160
  ident_printer -> ?sanitizer : (string -> string) -> ident -> string
Andrei Paskevich's avatar
Andrei Paskevich committed
161 162
(** 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 *)
163

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

Andrei Paskevich's avatar
Andrei Paskevich committed
166
val model_projected_attr : attribute
167

Andrei Paskevich's avatar
Andrei Paskevich committed
168 169 170
val model_vc_attr : attribute
val model_vc_post_attr : attribute
val model_vc_havoc_attr : attribute
171

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

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

Andrei Paskevich's avatar
Andrei Paskevich committed
178
val create_model_trace_attr : string -> attribute
179

Andrei Paskevich's avatar
Andrei Paskevich committed
180
val is_model_trace_attr : attribute -> bool
181

Andrei Paskevich's avatar
Andrei Paskevich committed
182 183 184
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:*"]
185 186
    will be ["model_trace:*to_append"]. *)

Andrei Paskevich's avatar
Andrei Paskevich committed
187 188 189
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:*@*"]
190 191
    will be ["model_trace:*to_append@*"]. *)

Andrei Paskevich's avatar
Andrei Paskevich committed
192 193 194 195
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:*"]. *)
196

Andrei Paskevich's avatar
Andrei Paskevich committed
197 198 199 200
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:*"]. *)
201

Andrei Paskevich's avatar
Andrei Paskevich committed
202 203 204
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. *)