src/Pure/Syntax/syntax.ML
author paulson
Fri Feb 16 17:24:51 1996 +0100 (1996-02-16)
changeset 1511 09354d37a5ab
parent 1158 96804ce95516
child 1580 e3fd931e6095
permissions -rw-r--r--
Elimination of fully-functorial style.
Type tactic changed to a type abbrevation (from a datatype).
Constructor tactic and function apply deleted.
     1 (*  Title:      Pure/Syntax/syntax.ML
     2     ID:         $Id$
     3     Author:     Tobias Nipkow and Markus Wenzel, TU Muenchen
     4 
     5 Root of Isabelle's syntax module.
     6 *)
     7 
     8 infix |-> <-| <->;
     9 
    10 signature BASIC_SYNTAX =
    11   sig
    12   include AST0
    13   include SYN_TRANS0
    14   include MIXFIX0
    15   include PRINTER0
    16   datatype 'a trrule =
    17     op |-> of 'a * 'a |
    18     op <-| of 'a * 'a |
    19     op <-> of 'a * 'a
    20   end;
    21 
    22 signature SYNTAX =
    23   sig
    24   include AST1
    25   include LEXICON0
    26   include SYN_EXT0
    27   include TYPE_EXT0
    28   include SYN_TRANS1
    29   include MIXFIX1
    30   include PRINTER0
    31   datatype 'a trrule =
    32     op |-> of 'a * 'a |
    33     op <-| of 'a * 'a |
    34     op <-> of 'a * 'a
    35   type syntax
    36   val extend_log_types: syntax -> string list -> syntax
    37   val extend_type_gram: syntax -> (string * int * mixfix) list -> syntax
    38   val extend_const_gram: syntax -> (string * typ * mixfix) list -> syntax
    39   val extend_consts: syntax -> string list -> syntax
    40   val extend_trfuns: syntax ->
    41     (string * (ast list -> ast)) list *
    42     (string * (term list -> term)) list *
    43     (string * (term list -> term)) list *
    44     (string * (ast list -> ast)) list -> syntax
    45   val extend_trrules: syntax -> (string * string) trrule list -> syntax
    46   val extend_trrules_i: syntax -> ast trrule list -> syntax
    47   val merge_syntaxes: syntax -> syntax -> syntax
    48   val type_syn: syntax
    49   val pure_syn: syntax
    50   val print_gram: syntax -> unit
    51   val print_trans: syntax -> unit
    52   val print_syntax: syntax -> unit
    53   val test_read: syntax -> string -> string -> unit
    54   val read: syntax -> typ -> string -> term list
    55   val read_typ: syntax -> (indexname -> sort) -> string -> typ
    56   val simple_read_typ: string -> typ
    57   val pretty_term: bool -> syntax -> term -> Pretty.T
    58   val pretty_typ: syntax -> typ -> Pretty.T
    59   val string_of_term: bool -> syntax -> term -> string
    60   val string_of_typ: syntax -> typ -> string
    61   val simple_string_of_typ: typ -> string
    62   val simple_pprint_typ: typ -> pprint_args -> unit
    63   val ambiguity_level: int ref
    64   end;
    65 
    66 structure Syntax : SYNTAX =
    67 struct
    68 
    69 open Lexicon SynExt Ast Parser TypeExt SynTrans Mixfix Printer;
    70 
    71 
    72 (** tables of translation functions **)
    73 
    74 (*the ref serves as unique id*)
    75 type 'a trtab = (('a list -> 'a) * unit ref) Symtab.table;
    76 
    77 val dest_trtab = Symtab.dest;
    78 
    79 fun lookup_trtab tab c =
    80   apsome fst (Symtab.lookup (tab, c));
    81 
    82 
    83 (* empty, extend, merge trtabs *)
    84 
    85 fun err_dup_trfuns name cs =
    86   error ("More than one " ^ name ^ " for " ^ commas_quote cs);
    87 
    88 val empty_trtab = Symtab.null;
    89 
    90 fun extend_trtab tab trfuns name =
    91   Symtab.extend_new (tab, map (fn (c, f) => (c, (f, ref ()))) trfuns)
    92     handle Symtab.DUPS cs => err_dup_trfuns name cs;
    93 
    94 fun merge_trtabs tab1 tab2 name =
    95   Symtab.merge eq_snd (tab1, tab2)
    96     handle Symtab.DUPS cs => err_dup_trfuns name cs;
    97 
    98 
    99 
   100 (** tables of translation rules **)
   101 
   102 type ruletab = (ast * ast) list Symtab.table;
   103 
   104 fun dest_ruletab tab = flat (map snd (Symtab.dest tab));
   105 
   106 
   107 (* lookup_ruletab *)
   108 
   109 fun lookup_ruletab tab =
   110   if Symtab.is_null tab then None
   111   else Some (fn a => Symtab.lookup_multi (tab, a));
   112 
   113 
   114 (* empty, extend, merge ruletabs *)
   115 
   116 val empty_ruletab = Symtab.null;
   117 
   118 fun extend_ruletab tab rules =
   119   generic_extend (op =) Symtab.dest_multi Symtab.make_multi tab
   120     (map (fn r => (head_of_rule r, r)) (distinct rules));
   121 
   122 fun merge_ruletabs tab1 tab2 =
   123   generic_merge (op =) Symtab.dest_multi Symtab.make_multi tab1 tab2;
   124 
   125 
   126 
   127 (** datatype syntax **)
   128 
   129 datatype syntax =
   130   Syntax of {
   131     lexicon: lexicon,
   132     logtypes: string list,
   133     gram: gram,
   134     consts: string list,
   135     parse_ast_trtab: ast trtab,
   136     parse_ruletab: ruletab,
   137     parse_trtab: term trtab,
   138     print_trtab: term trtab,
   139     print_ruletab: ruletab,
   140     print_ast_trtab: ast trtab,
   141     prtab: prtab};
   142 
   143 
   144 (* empty_syntax *)
   145 
   146 val empty_syntax =
   147   Syntax {
   148     lexicon = empty_lexicon,
   149     logtypes = [],
   150     gram = empty_gram,
   151     consts = [],
   152     parse_ast_trtab = empty_trtab,
   153     parse_ruletab = empty_ruletab,
   154     parse_trtab = empty_trtab,
   155     print_trtab = empty_trtab,
   156     print_ruletab = empty_ruletab,
   157     print_ast_trtab = empty_trtab,
   158     prtab = empty_prtab};
   159 
   160 
   161 (* extend_syntax *)
   162 
   163 fun extend_syntax (Syntax tabs) syn_ext =
   164   let
   165     val {lexicon, logtypes = logtypes1, gram, consts = consts1, parse_ast_trtab,
   166       parse_ruletab, parse_trtab, print_trtab, print_ruletab, print_ast_trtab,
   167       prtab} = tabs;
   168     val SynExt {logtypes = logtypes2, xprods, consts = consts2, parse_ast_translation,
   169       parse_rules, parse_translation, print_translation, print_rules,
   170       print_ast_translation} = syn_ext;
   171   in
   172     Syntax {
   173       lexicon = extend_lexicon lexicon (delims_of xprods),
   174       logtypes = extend_list logtypes1 logtypes2,
   175       gram = extend_gram gram xprods,
   176       consts = consts2 union consts1,
   177       parse_ast_trtab =
   178         extend_trtab parse_ast_trtab parse_ast_translation "parse ast translation",
   179       parse_ruletab = extend_ruletab parse_ruletab parse_rules,
   180       parse_trtab = extend_trtab parse_trtab parse_translation "parse translation",
   181       print_trtab = extend_trtab print_trtab print_translation "print translation",
   182       print_ruletab = extend_ruletab print_ruletab print_rules,
   183       print_ast_trtab =
   184         extend_trtab print_ast_trtab print_ast_translation "print ast translation",
   185       prtab = extend_prtab prtab xprods}
   186   end;
   187 
   188 
   189 (* merge_syntaxes *)
   190 
   191 fun merge_syntaxes (Syntax tabs1) (Syntax tabs2) =
   192   let
   193     val {lexicon = lexicon1, logtypes = logtypes1, gram = gram1, consts = consts1,
   194       parse_ast_trtab = parse_ast_trtab1, parse_ruletab = parse_ruletab1,
   195       parse_trtab = parse_trtab1, print_trtab = print_trtab1,
   196       print_ruletab = print_ruletab1, print_ast_trtab = print_ast_trtab1,
   197       prtab = prtab1} = tabs1;
   198 
   199     val {lexicon = lexicon2, logtypes = logtypes2, gram = gram2, consts = consts2,
   200       parse_ast_trtab = parse_ast_trtab2, parse_ruletab = parse_ruletab2,
   201       parse_trtab = parse_trtab2, print_trtab = print_trtab2,
   202       print_ruletab = print_ruletab2, print_ast_trtab = print_ast_trtab2,
   203       prtab = prtab2} = tabs2;
   204   in
   205     Syntax {
   206       lexicon = merge_lexicons lexicon1 lexicon2,
   207       logtypes = merge_lists logtypes1 logtypes2,
   208       gram = merge_grams gram1 gram2,
   209       consts = merge_lists consts1 consts2,
   210       parse_ast_trtab =
   211         merge_trtabs parse_ast_trtab1 parse_ast_trtab2 "parse ast translation",
   212       parse_ruletab = merge_ruletabs parse_ruletab1 parse_ruletab2,
   213       parse_trtab = merge_trtabs parse_trtab1 parse_trtab2 "parse translation",
   214       print_trtab = merge_trtabs print_trtab1 print_trtab2 "print translation",
   215       print_ruletab = merge_ruletabs print_ruletab1 print_ruletab2,
   216       print_ast_trtab =
   217         merge_trtabs print_ast_trtab1 print_ast_trtab2 "print ast translation",
   218       prtab = merge_prtabs prtab1 prtab2}
   219   end;
   220 
   221 
   222 (* type_syn *)
   223 
   224 val type_syn = extend_syntax empty_syntax type_ext;
   225 val pure_syn = extend_syntax type_syn pure_ext;
   226 
   227 
   228 (** inspect syntax **)
   229 
   230 fun pretty_strs_qs name strs =
   231   Pretty.strs (name :: map quote (sort_strings strs));
   232 
   233 
   234 (* print_gram *)
   235 
   236 fun print_gram (Syntax tabs) =
   237   let
   238     val {lexicon, logtypes, gram, ...} = tabs;
   239   in
   240     Pretty.writeln (pretty_strs_qs "lexicon:" (dest_lexicon lexicon));
   241     Pretty.writeln (Pretty.strs ("logtypes:" :: logtypes));
   242     Pretty.writeln (Pretty.big_list "prods:" (pretty_gram gram))
   243   end;
   244 
   245 
   246 (* print_trans *)
   247 
   248 fun print_trans (Syntax tabs) =
   249   let
   250     fun pretty_trtab name tab =
   251       pretty_strs_qs name (map fst (dest_trtab tab));
   252 
   253     fun pretty_ruletab name tab =
   254       Pretty.big_list name (map pretty_rule (dest_ruletab tab));
   255 
   256     val {consts, parse_ast_trtab, parse_ruletab, parse_trtab, print_trtab,
   257       print_ruletab, print_ast_trtab, ...} = tabs;
   258   in
   259     Pretty.writeln (pretty_strs_qs "consts:" consts);
   260     Pretty.writeln (pretty_trtab "parse_ast_translation:" parse_ast_trtab);
   261     Pretty.writeln (pretty_ruletab "parse_rules:" parse_ruletab);
   262     Pretty.writeln (pretty_trtab "parse_translation:" parse_trtab);
   263     Pretty.writeln (pretty_trtab "print_translation:" print_trtab);
   264     Pretty.writeln (pretty_ruletab "print_rules:" print_ruletab);
   265     Pretty.writeln (pretty_trtab "print_ast_translation:" print_ast_trtab)
   266   end;
   267 
   268 
   269 (* print_syntax *)
   270 
   271 fun print_syntax syn = (print_gram syn; print_trans syn);
   272 
   273 
   274 
   275 (** read **)
   276 
   277 (* test_read *)
   278 
   279 fun test_read (Syntax tabs) root str =
   280   let
   281     val {lexicon, gram, parse_ast_trtab, parse_ruletab, ...} = tabs;
   282 
   283     val toks = tokenize lexicon false str;
   284     val _ = writeln ("tokens: " ^ space_implode " " (map display_token toks));
   285 
   286     fun show_pt pt =
   287       let
   288         val raw_ast = pt_to_ast (K None) pt;
   289         val _ = writeln ("raw: " ^ str_of_ast raw_ast);
   290         val pre_ast = pt_to_ast (lookup_trtab parse_ast_trtab) pt;
   291         val _ = normalize true true (lookup_ruletab parse_ruletab) pre_ast;
   292       in () end;
   293   in
   294     seq show_pt (parse gram root toks)
   295   end;
   296 
   297 
   298 (* read_ast *)
   299 
   300 val ambiguity_level = ref 1;
   301 
   302 fun read_asts (Syntax tabs) xids root str =
   303   let
   304     val {lexicon, gram, parse_ast_trtab, logtypes, ...} = tabs;
   305     val root' = if root mem logtypes then logic else root;
   306     val pts = parse gram root' (tokenize lexicon xids str);
   307 
   308     fun show_pt pt = writeln (str_of_ast (pt_to_ast (K None) pt));
   309   in
   310     if length pts > ! ambiguity_level then
   311       (writeln ("Warning: Ambiguous input " ^ quote str);
   312        writeln "produces the following parse trees:";
   313        seq show_pt pts)
   314     else ();
   315     map (pt_to_ast (lookup_trtab parse_ast_trtab)) pts
   316   end;
   317 
   318 
   319 (* read *)
   320 
   321 fun read (syn as Syntax tabs) ty str =
   322   let
   323     val {parse_ruletab, parse_trtab, ...} = tabs;
   324     val asts = read_asts syn false (typ_to_nonterm ty) str;
   325   in
   326     map (ast_to_term (lookup_trtab parse_trtab))
   327       (map (normalize_ast (lookup_ruletab parse_ruletab)) asts)
   328   end;
   329 
   330 
   331 (* read types *)
   332 
   333 fun read_typ syn def_sort str =
   334   (case read syn typeT str of
   335     [t] => typ_of_term (raw_term_sorts t) def_sort t
   336   | _ => sys_error "read_typ: ambiguous type syntax");
   337 
   338 fun simple_read_typ str = read_typ type_syn (K []) str;
   339 
   340 
   341 
   342 (** prepare translation rules **)
   343 
   344 datatype 'a trrule =
   345   op |-> of 'a * 'a |
   346   op <-| of 'a * 'a |
   347   op <-> of 'a * 'a;
   348 
   349 fun map_rule f (x |-> y) = (f x |-> f y)
   350   | map_rule f (x <-| y) = (f x <-| f y)
   351   | map_rule f (x <-> y) = (f x <-> f y);
   352 
   353 fun right_rule (pat1 |-> pat2) = Some (pat1, pat2)
   354   | right_rule (pat1 <-| pat2) = None
   355   | right_rule (pat1 <-> pat2) = Some (pat1, pat2);
   356 
   357 fun left_rule (pat1 |-> pat2) = None
   358   | left_rule (pat1 <-| pat2) = Some (pat2, pat1)
   359   | left_rule (pat1 <-> pat2) = Some (pat2, pat1);
   360 
   361 
   362 fun check_rule (rule as (lhs, rhs)) =
   363   (case rule_error rule of
   364     Some msg =>
   365       error ("Error in syntax translation rule: " ^ msg ^ "\n" ^
   366         str_of_ast lhs ^ "  ->  " ^ str_of_ast rhs)
   367   | None => rule);
   368 
   369 
   370 fun read_pattern syn (root, str) =
   371   let
   372     val Syntax {consts, ...} = syn;
   373 
   374     fun constify (ast as Constant _) = ast
   375       | constify (ast as Variable x) =
   376           if x mem consts then Constant x else ast
   377       | constify (Appl asts) = Appl (map constify asts);
   378   in
   379     (case read_asts syn true root str of
   380       [ast] => constify ast
   381     | _ => error ("Syntactically ambiguous input: " ^ quote str))
   382   end handle ERROR =>
   383     error ("The error(s) above occurred in translation pattern " ^
   384       quote str);
   385 
   386 
   387 fun prep_rules rd_pat raw_rules =
   388   let val rules = map (map_rule rd_pat) raw_rules in
   389     (map check_rule (mapfilter right_rule rules),
   390       map check_rule (mapfilter left_rule rules))
   391   end
   392 
   393 
   394 
   395 (** pretty terms or typs **)
   396 
   397 fun pretty_t t_to_ast pretty_t curried (syn as Syntax tabs) t =
   398   let
   399     val {print_trtab, print_ruletab, print_ast_trtab, prtab, ...} = tabs;
   400     val ast = t_to_ast (lookup_trtab print_trtab) t;
   401   in
   402     pretty_t curried prtab (lookup_trtab print_ast_trtab)
   403       (normalize_ast (lookup_ruletab print_ruletab) ast)
   404   end;
   405 
   406 val pretty_term = pretty_t term_to_ast pretty_term_ast;
   407 val pretty_typ = pretty_t typ_to_ast pretty_typ_ast false;
   408 
   409 fun string_of_term curried syn t =
   410   Pretty.string_of (pretty_term curried syn t);
   411 fun string_of_typ syn ty = Pretty.string_of (pretty_typ syn ty);
   412 
   413 val simple_string_of_typ = string_of_typ type_syn;
   414 val simple_pprint_typ = Pretty.pprint o Pretty.quote o (pretty_typ type_syn);
   415 
   416 
   417 
   418 (** extend syntax (external interfaces) **)
   419 
   420 fun ext_syntax mk_syn_ext (syn as Syntax {logtypes, ...}) decls =
   421   extend_syntax syn (mk_syn_ext logtypes decls);
   422 
   423 
   424 fun extend_log_types syn logtypes =
   425   extend_syntax syn (syn_ext_logtypes logtypes);
   426 
   427 val extend_type_gram = ext_syntax syn_ext_types;
   428 
   429 val extend_const_gram = ext_syntax syn_ext_consts;
   430 
   431 val extend_consts = ext_syntax syn_ext_const_names;
   432 
   433 val extend_trfuns = ext_syntax syn_ext_trfuns;
   434 
   435 fun extend_trrules syn rules =
   436   ext_syntax syn_ext_rules syn (prep_rules (read_pattern syn) rules);
   437 
   438 fun extend_trrules_i syn rules =
   439   ext_syntax syn_ext_rules syn (prep_rules I rules);
   440 
   441 end;