aboutsummaryrefslogtreecommitdiff
path: root/interp/syntax_def.ml
diff options
context:
space:
mode:
Diffstat (limited to 'interp/syntax_def.ml')
-rw-r--r--interp/syntax_def.ml114
1 files changed, 114 insertions, 0 deletions
diff --git a/interp/syntax_def.ml b/interp/syntax_def.ml
new file mode 100644
index 0000000000..49273c4146
--- /dev/null
+++ b/interp/syntax_def.ml
@@ -0,0 +1,114 @@
+(************************************************************************)
+(* * The Coq Proof Assistant / The Coq Development Team *)
+(* v * INRIA, CNRS and contributors - Copyright 1999-2018 *)
+(* <O___,, * (see CREDITS file for the list of authors) *)
+(* \VV/ **************************************************************)
+(* // * This file is distributed under the terms of the *)
+(* * GNU Lesser General Public License Version 2.1 *)
+(* * (see LICENSE file for the text of the license) *)
+(************************************************************************)
+
+open Util
+open Pp
+open CErrors
+open Names
+open Libnames
+open Libobject
+open Lib
+open Notation_term
+
+(* Syntactic definitions. *)
+
+type version = Flags.compat_version option
+
+let syntax_table =
+ Summary.ref (KNmap.empty : (interpretation*version) KNmap.t)
+ ~name:"SYNTAXCONSTANT"
+
+let add_syntax_constant kn c onlyparse =
+ syntax_table := KNmap.add kn (c,onlyparse) !syntax_table
+
+let load_syntax_constant i ((sp,kn),(_,pat,onlyparse)) =
+ if Nametab.exists_cci sp then
+ user_err ~hdr:"cache_syntax_constant"
+ (Id.print (basename sp) ++ str " already exists");
+ add_syntax_constant kn pat onlyparse;
+ Nametab.push_syndef (Nametab.Until i) sp kn
+
+let is_alias_of_already_visible_name sp = function
+ | _,NRef ref ->
+ let (dir,id) = repr_qualid (Nametab.shortest_qualid_of_global Id.Set.empty ref) in
+ DirPath.is_empty dir && Id.equal id (basename sp)
+ | _ ->
+ false
+
+let open_syntax_constant i ((sp,kn),(_,pat,onlyparse)) =
+ if not (Int.equal i 1 && is_alias_of_already_visible_name sp pat) then begin
+ Nametab.push_syndef (Nametab.Exactly i) sp kn;
+ match onlyparse with
+ | None ->
+ (* Redeclare it to be used as (short) name in case an other (distfix)
+ notation was declared inbetween *)
+ Notation.declare_uninterpretation (Notation.SynDefRule kn) pat
+ | _ -> ()
+ end
+
+let cache_syntax_constant d =
+ load_syntax_constant 1 d;
+ open_syntax_constant 1 d
+
+let subst_syntax_constant (subst,(local,pat,onlyparse)) =
+ (local,Notation_ops.subst_interpretation subst pat,onlyparse)
+
+let classify_syntax_constant (local,_,_ as o) =
+ if local then Dispose else Substitute o
+
+let in_syntax_constant
+ : bool * interpretation * Flags.compat_version option -> obj =
+ declare_object {(default_object "SYNTAXCONSTANT") with
+ cache_function = cache_syntax_constant;
+ load_function = load_syntax_constant;
+ open_function = open_syntax_constant;
+ subst_function = subst_syntax_constant;
+ classify_function = classify_syntax_constant }
+
+type syndef_interpretation = (Id.t * subscopes) list * notation_constr
+
+(* Coercions to the general format of notation that also supports
+ variables bound to list of expressions *)
+let in_pat (ids,ac) = (List.map (fun (id,sc) -> (id,((Constrexpr.InConstrEntrySomeLevel,sc),NtnTypeConstr))) ids,ac)
+let out_pat (ids,ac) = (List.map (fun (id,((_,sc),typ)) -> (id,sc)) ids,ac)
+
+let declare_syntactic_definition local id onlyparse pat =
+ let _ = add_leaf id (in_syntax_constant (local,in_pat pat,onlyparse)) in ()
+
+let pr_syndef kn = pr_qualid (Nametab.shortest_qualid_of_syndef Id.Set.empty kn)
+
+let pr_compat_warning (kn, def, v) =
+ let pp_def = match def with
+ | [], NRef r -> spc () ++ str "is" ++ spc () ++ Nametab.pr_global_env Id.Set.empty r
+ | _ -> strbrk " is a compatibility notation"
+ in
+ pr_syndef kn ++ pp_def
+
+let warn_compatibility_notation =
+ CWarnings.(create ~name:"compatibility-notation"
+ ~category:"deprecated" ~default:Enabled pr_compat_warning)
+
+let verbose_compat ?loc kn def = function
+ | Some v when Flags.version_strictly_greater v ->
+ warn_compatibility_notation ?loc (kn, def, v)
+ | _ -> ()
+
+let search_syntactic_definition ?loc kn =
+ let pat,v = KNmap.find kn !syntax_table in
+ let def = out_pat pat in
+ verbose_compat ?loc kn def v;
+ def
+
+let search_filtered_syntactic_definition ?loc filter kn =
+ let pat,v = KNmap.find kn !syntax_table in
+ let def = out_pat pat in
+ let res = filter def in
+ (match res with Some _ -> verbose_compat ?loc kn def v | None -> ());
+ res