wenzelm@18: (*  Title:      Pure/Syntax/syntax.ML
clasohm@0:     ID:         $Id$
clasohm@0:     Author:     Tobias Nipkow and Markus Wenzel, TU Muenchen
wenzelm@18: 
wenzelm@18: Root of Isabelle's syntax module.
clasohm@0: *)
clasohm@0: 
wenzelm@556: infix |-> <-| <->;
wenzelm@556: 
wenzelm@260: signature BASIC_SYNTAX =
wenzelm@2383: sig
wenzelm@260:   include AST0
wenzelm@556:   include SYN_TRANS0
wenzelm@556:   include MIXFIX0
wenzelm@260:   include PRINTER0
wenzelm@2383: end;
wenzelm@260: 
clasohm@0: signature SYNTAX =
wenzelm@2383: sig
wenzelm@260:   include AST1
clasohm@0:   include LEXICON0
wenzelm@237:   include SYN_EXT0
clasohm@0:   include TYPE_EXT0
wenzelm@556:   include SYN_TRANS1
wenzelm@556:   include MIXFIX1
clasohm@0:   include PRINTER0
wenzelm@1158:   datatype 'a trrule =
paulson@2287:     |-> of 'a * 'a |
paulson@2287:     <-| of 'a * 'a |
paulson@2287:     <-> of 'a * 'a
wenzelm@556:   type syntax
wenzelm@556:   val extend_log_types: syntax -> string list -> syntax
wenzelm@556:   val extend_type_gram: syntax -> (string * int * mixfix) list -> syntax
wenzelm@2366:   val extend_const_gram: syntax -> string * bool -> (string * typ * mixfix) list -> syntax
wenzelm@556:   val extend_consts: syntax -> string list -> syntax
wenzelm@556:   val extend_trfuns: syntax ->
wenzelm@556:     (string * (ast list -> ast)) list *
wenzelm@556:     (string * (term list -> term)) list *
wenzelm@556:     (string * (term list -> term)) list *
wenzelm@556:     (string * (ast list -> ast)) list -> syntax
wenzelm@2383:   val extend_trfunsT: syntax -> (string * (typ -> term list -> term)) list -> syntax
wenzelm@1158:   val extend_trrules: syntax -> (string * string) trrule list -> syntax
wenzelm@1158:   val extend_trrules_i: syntax -> ast trrule list -> syntax
wenzelm@556:   val merge_syntaxes: syntax -> syntax -> syntax
wenzelm@556:   val type_syn: syntax
clasohm@764:   val pure_syn: syntax
wenzelm@556:   val print_gram: syntax -> unit
wenzelm@556:   val print_trans: syntax -> unit
wenzelm@556:   val print_syntax: syntax -> unit
wenzelm@556:   val test_read: syntax -> string -> string -> unit
clasohm@624:   val read: syntax -> typ -> string -> term list
wenzelm@556:   val read_typ: syntax -> (indexname -> sort) -> string -> typ
wenzelm@556:   val simple_read_typ: string -> typ
clasohm@922:   val pretty_term: bool -> syntax -> term -> Pretty.T
wenzelm@556:   val pretty_typ: syntax -> typ -> Pretty.T
clasohm@922:   val string_of_term: bool -> syntax -> term -> string
wenzelm@556:   val string_of_typ: syntax -> typ -> string
wenzelm@556:   val simple_string_of_typ: typ -> string
wenzelm@556:   val simple_pprint_typ: typ -> pprint_args -> unit
clasohm@882:   val ambiguity_level: int ref
wenzelm@2383: end;
clasohm@0: 
paulson@1511: structure Syntax : SYNTAX =
clasohm@0: struct
clasohm@0: 
paulson@1511: open Lexicon SynExt Ast Parser TypeExt SynTrans Mixfix Printer;
wenzelm@237: 
wenzelm@237: 
wenzelm@237: (** tables of translation functions **)
wenzelm@237: 
wenzelm@237: (*the ref serves as unique id*)
wenzelm@2383: (*does not subsume typed print translations*)
wenzelm@237: type 'a trtab = (('a list -> 'a) * unit ref) Symtab.table;
wenzelm@237: 
wenzelm@383: val dest_trtab = Symtab.dest;
wenzelm@237: 
wenzelm@237: fun lookup_trtab tab c =
wenzelm@237:   apsome fst (Symtab.lookup (tab, c));
clasohm@0: 
clasohm@0: 
wenzelm@237: (* empty, extend, merge trtabs *)
wenzelm@237: 
wenzelm@383: fun err_dup_trfuns name cs =
wenzelm@383:   error ("More than one " ^ name ^ " for " ^ commas_quote cs);
wenzelm@237: 
wenzelm@237: val empty_trtab = Symtab.null;
wenzelm@237: 
wenzelm@237: fun extend_trtab tab trfuns name =
wenzelm@383:   Symtab.extend_new (tab, map (fn (c, f) => (c, (f, ref ()))) trfuns)
wenzelm@383:     handle Symtab.DUPS cs => err_dup_trfuns name cs;
wenzelm@237: 
wenzelm@237: fun merge_trtabs tab1 tab2 name =
wenzelm@237:   Symtab.merge eq_snd (tab1, tab2)
wenzelm@383:     handle Symtab.DUPS cs => err_dup_trfuns name cs;
wenzelm@237: 
wenzelm@237: 
wenzelm@237: 
wenzelm@237: (** tables of translation rules **)
wenzelm@237: 
wenzelm@237: type ruletab = (ast * ast) list Symtab.table;
wenzelm@237: 
wenzelm@383: fun dest_ruletab tab = flat (map snd (Symtab.dest tab));
wenzelm@237: 
wenzelm@237: 
wenzelm@237: (* lookup_ruletab *)
wenzelm@237: 
wenzelm@237: fun lookup_ruletab tab =
wenzelm@237:   if Symtab.is_null tab then None
wenzelm@237:   else Some (fn a => Symtab.lookup_multi (tab, a));
wenzelm@237: 
wenzelm@237: 
wenzelm@237: (* empty, extend, merge ruletabs *)
wenzelm@237: 
wenzelm@237: val empty_ruletab = Symtab.null;
wenzelm@237: 
wenzelm@237: fun extend_ruletab tab rules =
wenzelm@237:   generic_extend (op =) Symtab.dest_multi Symtab.make_multi tab
wenzelm@237:     (map (fn r => (head_of_rule r, r)) (distinct rules));
wenzelm@237: 
wenzelm@237: fun merge_ruletabs tab1 tab2 =
wenzelm@237:   generic_merge (op =) Symtab.dest_multi Symtab.make_multi tab1 tab2;
clasohm@0: 
clasohm@0: 
clasohm@0: 
clasohm@0: (** datatype syntax **)
clasohm@0: 
wenzelm@237: datatype syntax =
wenzelm@237:   Syntax of {
wenzelm@18:     lexicon: lexicon,
clasohm@764:     logtypes: string list,
wenzelm@18:     gram: gram,
wenzelm@18:     consts: string list,
wenzelm@237:     parse_ast_trtab: ast trtab,
wenzelm@237:     parse_ruletab: ruletab,
wenzelm@237:     parse_trtab: term trtab,
wenzelm@2383:     print_trtab: ((typ -> term list -> term) * unit ref) Symtab.table,
wenzelm@237:     print_ruletab: ruletab,
wenzelm@237:     print_ast_trtab: ast trtab,
wenzelm@2202:     prtabs: prtabs};
clasohm@0: 
wenzelm@18: 
wenzelm@237: (* empty_syntax *)
wenzelm@18: 
wenzelm@237: val empty_syntax =
wenzelm@237:   Syntax {
wenzelm@167:     lexicon = empty_lexicon,
clasohm@764:     logtypes = [],
wenzelm@171:     gram = empty_gram,
wenzelm@167:     consts = [],
wenzelm@237:     parse_ast_trtab = empty_trtab,
wenzelm@237:     parse_ruletab = empty_ruletab,
wenzelm@237:     parse_trtab = empty_trtab,
wenzelm@237:     print_trtab = empty_trtab,
wenzelm@237:     print_ruletab = empty_ruletab,
wenzelm@237:     print_ast_trtab = empty_trtab,
wenzelm@2202:     prtabs = empty_prtabs};
wenzelm@167: 
wenzelm@167: 
wenzelm@237: (* extend_syntax *)
wenzelm@167: 
wenzelm@2366: fun extend_syntax (mode, inout) (Syntax tabs) syn_ext =
wenzelm@167:   let
wenzelm@2383:     val {lexicon, logtypes = logtypes1, gram, consts = consts1,
wenzelm@2366:       parse_ast_trtab, parse_ruletab, parse_trtab, print_trtab, print_ruletab,
wenzelm@2366:       print_ast_trtab, prtabs} = tabs;
clasohm@764:     val SynExt {logtypes = logtypes2, xprods, consts = consts2, parse_ast_translation,
wenzelm@167:       parse_rules, parse_translation, print_translation, print_rules,
wenzelm@237:       print_ast_translation} = syn_ext;
wenzelm@167:   in
wenzelm@237:     Syntax {
wenzelm@2366:       lexicon = if inout then extend_lexicon lexicon (delims_of xprods) else lexicon,
clasohm@764:       logtypes = extend_list logtypes1 logtypes2,
wenzelm@2366:       gram = if inout then extend_gram gram xprods else gram,
wenzelm@167:       consts = consts2 union consts1,
wenzelm@167:       parse_ast_trtab =
wenzelm@167:         extend_trtab parse_ast_trtab parse_ast_translation "parse ast translation",
wenzelm@167:       parse_ruletab = extend_ruletab parse_ruletab parse_rules,
wenzelm@167:       parse_trtab = extend_trtab parse_trtab parse_translation "parse translation",
wenzelm@167:       print_trtab = extend_trtab print_trtab print_translation "print translation",
wenzelm@167:       print_ruletab = extend_ruletab print_ruletab print_rules,
wenzelm@237:       print_ast_trtab =
wenzelm@237:         extend_trtab print_ast_trtab print_ast_translation "print ast translation",
wenzelm@2383:       prtabs = extend_prtabs prtabs mode xprods}
wenzelm@18:   end;
wenzelm@18: 
wenzelm@18: 
wenzelm@237: (* merge_syntaxes *)
clasohm@0: 
wenzelm@237: fun merge_syntaxes (Syntax tabs1) (Syntax tabs2) =
clasohm@0:   let
wenzelm@2383:     val {lexicon = lexicon1, logtypes = logtypes1, gram = gram1,
wenzelm@2366:       consts = consts1, parse_ast_trtab = parse_ast_trtab1, parse_ruletab = parse_ruletab1,
wenzelm@237:       parse_trtab = parse_trtab1, print_trtab = print_trtab1,
wenzelm@237:       print_ruletab = print_ruletab1, print_ast_trtab = print_ast_trtab1,
wenzelm@2202:       prtabs = prtabs1} = tabs1;
wenzelm@237: 
wenzelm@2383:     val {lexicon = lexicon2, logtypes = logtypes2, gram = gram2,
wenzelm@2366:       consts = consts2, parse_ast_trtab = parse_ast_trtab2, parse_ruletab = parse_ruletab2,
wenzelm@237:       parse_trtab = parse_trtab2, print_trtab = print_trtab2,
wenzelm@237:       print_ruletab = print_ruletab2, print_ast_trtab = print_ast_trtab2,
wenzelm@2202:       prtabs = prtabs2} = tabs2;
clasohm@0:   in
wenzelm@237:     Syntax {
wenzelm@237:       lexicon = merge_lexicons lexicon1 lexicon2,
clasohm@764:       logtypes = merge_lists logtypes1 logtypes2,
wenzelm@237:       gram = merge_grams gram1 gram2,
wenzelm@237:       consts = merge_lists consts1 consts2,
wenzelm@237:       parse_ast_trtab =
wenzelm@237:         merge_trtabs parse_ast_trtab1 parse_ast_trtab2 "parse ast translation",
wenzelm@237:       parse_ruletab = merge_ruletabs parse_ruletab1 parse_ruletab2,
wenzelm@237:       parse_trtab = merge_trtabs parse_trtab1 parse_trtab2 "parse translation",
wenzelm@237:       print_trtab = merge_trtabs print_trtab1 print_trtab2 "print translation",
wenzelm@237:       print_ruletab = merge_ruletabs print_ruletab1 print_ruletab2,
wenzelm@237:       print_ast_trtab =
wenzelm@237:         merge_trtabs print_ast_trtab1 print_ast_trtab2 "print ast translation",
wenzelm@2383:       prtabs = merge_prtabs prtabs1 prtabs2}
clasohm@0:   end;
clasohm@0: 
clasohm@0: 
wenzelm@260: (* type_syn *)
wenzelm@260: 
wenzelm@2366: val type_syn = extend_syntax ("", true) empty_syntax type_ext;
wenzelm@2366: val pure_syn = extend_syntax ("", true) type_syn pure_ext;
wenzelm@260: 
clasohm@0: 
wenzelm@237: (** inspect syntax **)
clasohm@0: 
wenzelm@260: fun pretty_strs_qs name strs =
wenzelm@260:   Pretty.strs (name :: map quote (sort_strings strs));
clasohm@0: 
wenzelm@18: 
wenzelm@18: (* print_gram *)
clasohm@0: 
wenzelm@237: fun print_gram (Syntax tabs) =
clasohm@0:   let
wenzelm@2383:     val {lexicon, logtypes, gram, prtabs, ...} = tabs;
clasohm@0:   in
wenzelm@260:     Pretty.writeln (pretty_strs_qs "lexicon:" (dest_lexicon lexicon));
clasohm@764:     Pretty.writeln (Pretty.strs ("logtypes:" :: logtypes));
wenzelm@2202:     Pretty.writeln (Pretty.big_list "prods:" (pretty_gram gram));
wenzelm@2383:     Pretty.writeln (pretty_strs_qs "print modes:" (prmodes_of prtabs))
clasohm@0:   end;
clasohm@0: 
clasohm@0: 
wenzelm@18: (* print_trans *)
clasohm@0: 
wenzelm@237: fun print_trans (Syntax tabs) =
clasohm@0:   let
wenzelm@260:     fun pretty_trtab name tab =
wenzelm@260:       pretty_strs_qs name (map fst (dest_trtab tab));
clasohm@0: 
wenzelm@260:     fun pretty_ruletab name tab =
wenzelm@260:       Pretty.big_list name (map pretty_rule (dest_ruletab tab));
clasohm@0: 
wenzelm@237:     val {consts, parse_ast_trtab, parse_ruletab, parse_trtab, print_trtab,
wenzelm@237:       print_ruletab, print_ast_trtab, ...} = tabs;
clasohm@0:   in
wenzelm@260:     Pretty.writeln (pretty_strs_qs "consts:" consts);
wenzelm@260:     Pretty.writeln (pretty_trtab "parse_ast_translation:" parse_ast_trtab);
wenzelm@260:     Pretty.writeln (pretty_ruletab "parse_rules:" parse_ruletab);
wenzelm@260:     Pretty.writeln (pretty_trtab "parse_translation:" parse_trtab);
wenzelm@260:     Pretty.writeln (pretty_trtab "print_translation:" print_trtab);
wenzelm@260:     Pretty.writeln (pretty_ruletab "print_rules:" print_ruletab);
wenzelm@260:     Pretty.writeln (pretty_trtab "print_ast_translation:" print_ast_trtab)
clasohm@0:   end;
clasohm@0: 
clasohm@0: 
clasohm@0: (* print_syntax *)
clasohm@0: 
wenzelm@237: fun print_syntax syn = (print_gram syn; print_trans syn);
clasohm@0: 
clasohm@0: 
clasohm@0: 
wenzelm@237: (** read **)
wenzelm@18: 
wenzelm@237: (* test_read *)
wenzelm@18: 
wenzelm@237: fun test_read (Syntax tabs) root str =
wenzelm@18:   let
wenzelm@237:     val {lexicon, gram, parse_ast_trtab, parse_ruletab, ...} = tabs;
wenzelm@18: 
wenzelm@2366:     val chars = SymbolFont.read_charnames (explode str);
wenzelm@2366:     val toks = tokenize lexicon false chars;
clasohm@624:     val _ = writeln ("tokens: " ^ space_implode " " (map display_token toks));
wenzelm@18: 
wenzelm@383:     fun show_pt pt =
wenzelm@383:       let
wenzelm@383:         val raw_ast = pt_to_ast (K None) pt;
wenzelm@383:         val _ = writeln ("raw: " ^ str_of_ast raw_ast);
wenzelm@383:         val pre_ast = pt_to_ast (lookup_trtab parse_ast_trtab) pt;
wenzelm@383:         val _ = normalize true true (lookup_ruletab parse_ruletab) pre_ast;
wenzelm@383:       in () end;
wenzelm@383:   in
wenzelm@383:     seq show_pt (parse gram root toks)
wenzelm@383:   end;
wenzelm@18: 
wenzelm@18: 
wenzelm@260: (* read_ast *)
wenzelm@260: 
clasohm@882: val ambiguity_level = ref 1;
clasohm@882: 
clasohm@865: fun read_asts (Syntax tabs) xids root str =
wenzelm@260:   let
clasohm@764:     val {lexicon, gram, parse_ast_trtab, logtypes, ...} = tabs;
clasohm@764:     val root' = if root mem logtypes then logic else root;
wenzelm@2366:     val chars = SymbolFont.read_charnames (explode str);
wenzelm@2366:     val pts = parse gram root' (tokenize lexicon xids chars);
clasohm@330: 
clasohm@624:     fun show_pt pt = writeln (str_of_ast (pt_to_ast (K None) pt));
wenzelm@260:   in
wenzelm@888:     if length pts > ! ambiguity_level then
berghofe@1580:       (warning ("Ambiguous input " ^ quote str);
clasohm@882:        writeln "produces the following parse trees:";
clasohm@882:        seq show_pt pts)
clasohm@624:     else ();
clasohm@624:     map (pt_to_ast (lookup_trtab parse_ast_trtab)) pts
wenzelm@260:   end;
wenzelm@260: 
wenzelm@260: 
wenzelm@237: (* read *)
clasohm@0: 
wenzelm@237: fun read (syn as Syntax tabs) ty str =
clasohm@0:   let
wenzelm@237:     val {parse_ruletab, parse_trtab, ...} = tabs;
clasohm@865:     val asts = read_asts syn false (typ_to_nonterm ty) str;
clasohm@0:   in
clasohm@624:     map (ast_to_term (lookup_trtab parse_trtab))
clasohm@624:       (map (normalize_ast (lookup_ruletab parse_ruletab)) asts)
clasohm@0:   end;
clasohm@0: 
clasohm@0: 
wenzelm@237: (* read types *)
clasohm@0: 
wenzelm@237: fun read_typ syn def_sort str =
wenzelm@888:   (case read syn typeT str of
wenzelm@888:     [t] => typ_of_term (raw_term_sorts t) def_sort t
wenzelm@888:   | _ => sys_error "read_typ: ambiguous type syntax");
wenzelm@144: 
wenzelm@237: fun simple_read_typ str = read_typ type_syn (K []) str;
wenzelm@144: 
wenzelm@144: 
wenzelm@18: 
wenzelm@1158: (** prepare translation rules **)
wenzelm@1158: 
wenzelm@1158: datatype 'a trrule =
wenzelm@888:   op |-> of 'a * 'a |
wenzelm@888:   op <-| of 'a * 'a |
wenzelm@888:   op <-> of 'a * 'a;
wenzelm@888: 
wenzelm@1158: fun map_rule f (x |-> y) = (f x |-> f y)
wenzelm@1158:   | map_rule f (x <-| y) = (f x <-| f y)
wenzelm@1158:   | map_rule f (x <-> y) = (f x <-> f y);
wenzelm@1158: 
wenzelm@1158: fun right_rule (pat1 |-> pat2) = Some (pat1, pat2)
wenzelm@1158:   | right_rule (pat1 <-| pat2) = None
wenzelm@1158:   | right_rule (pat1 <-> pat2) = Some (pat1, pat2);
wenzelm@1158: 
wenzelm@1158: fun left_rule (pat1 |-> pat2) = None
wenzelm@1158:   | left_rule (pat1 <-| pat2) = Some (pat2, pat1)
wenzelm@1158:   | left_rule (pat1 <-> pat2) = Some (pat2, pat1);
wenzelm@1158: 
wenzelm@1158: 
wenzelm@1158: fun check_rule (rule as (lhs, rhs)) =
wenzelm@1158:   (case rule_error rule of
wenzelm@1158:     Some msg =>
wenzelm@1158:       error ("Error in syntax translation rule: " ^ msg ^ "\n" ^
wenzelm@1158:         str_of_ast lhs ^ "  ->  " ^ str_of_ast rhs)
wenzelm@1158:   | None => rule);
wenzelm@888: 
wenzelm@888: 
wenzelm@888: fun read_pattern syn (root, str) =
wenzelm@18:   let
wenzelm@237:     val Syntax {consts, ...} = syn;
wenzelm@18: 
wenzelm@888:     fun constify (ast as Constant _) = ast
wenzelm@888:       | constify (ast as Variable x) =
wenzelm@18:           if x mem consts then Constant x else ast
wenzelm@888:       | constify (Appl asts) = Appl (map constify asts);
wenzelm@18:   in
wenzelm@888:     (case read_asts syn true root str of
wenzelm@888:       [ast] => constify ast
wenzelm@888:     | _ => error ("Syntactically ambiguous input: " ^ quote str))
wenzelm@888:   end handle ERROR =>
wenzelm@888:     error ("The error(s) above occurred in translation pattern " ^
wenzelm@888:       quote str);
clasohm@0: 
wenzelm@556: 
wenzelm@1158: fun prep_rules rd_pat raw_rules =
wenzelm@1158:   let val rules = map (map_rule rd_pat) raw_rules in
wenzelm@888:     (map check_rule (mapfilter right_rule rules),
wenzelm@888:       map check_rule (mapfilter left_rule rules))
wenzelm@1158:   end
wenzelm@18: 
wenzelm@18: 
wenzelm@18: 
wenzelm@18: (** pretty terms or typs **)
wenzelm@18: 
wenzelm@2202: fun pretty_t t_to_ast prt_t curried (syn as Syntax tabs) t =
clasohm@0:   let
wenzelm@2202:     val {print_trtab, print_ruletab, print_ast_trtab, prtabs, ...} = tabs;
wenzelm@237:     val ast = t_to_ast (lookup_trtab print_trtab) t;
clasohm@0:   in
wenzelm@2202:     prt_t curried prtabs (lookup_trtab print_ast_trtab)
wenzelm@237:       (normalize_ast (lookup_ruletab print_ruletab) ast)
clasohm@0:   end;
clasohm@0: 
clasohm@0: val pretty_term = pretty_t term_to_ast pretty_term_ast;
clasohm@922: val pretty_typ = pretty_t typ_to_ast pretty_typ_ast false;
clasohm@0: 
clasohm@922: fun string_of_term curried syn t =
clasohm@922:   Pretty.string_of (pretty_term curried syn t);
wenzelm@260: fun string_of_typ syn ty = Pretty.string_of (pretty_typ syn ty);
clasohm@0: 
wenzelm@260: val simple_string_of_typ = string_of_typ type_syn;
wenzelm@260: val simple_pprint_typ = Pretty.pprint o Pretty.quote o (pretty_typ type_syn);
clasohm@0: 
clasohm@0: 
clasohm@0: 
wenzelm@383: (** extend syntax (external interfaces) **)
wenzelm@383: 
wenzelm@2202: fun ext_syntax mk_syn_ext prmode (syn as Syntax {logtypes, ...}) decls =
wenzelm@2202:   extend_syntax prmode syn (mk_syn_ext logtypes decls);
wenzelm@383: 
wenzelm@167: 
clasohm@764: fun extend_log_types syn logtypes =
wenzelm@2366:   extend_syntax ("", true) syn (syn_ext_logtypes logtypes);
wenzelm@383: 
wenzelm@2366: val extend_type_gram = ext_syntax syn_ext_types ("", true);
wenzelm@383: 
wenzelm@2202: fun extend_const_gram syn prmode = ext_syntax syn_ext_consts prmode syn;
wenzelm@383: 
wenzelm@2366: val extend_consts = ext_syntax syn_ext_const_names ("", true);
wenzelm@383: 
wenzelm@2366: val extend_trfuns = ext_syntax syn_ext_trfuns ("", true);
wenzelm@383: 
wenzelm@2383: val extend_trfunsT = ext_syntax syn_ext_trfunsT ("", true);
wenzelm@2383: 
wenzelm@1158: fun extend_trrules syn rules =
wenzelm@2366:   ext_syntax syn_ext_rules ("", true) syn (prep_rules (read_pattern syn) rules);
wenzelm@1158: 
wenzelm@1158: fun extend_trrules_i syn rules =
wenzelm@2366:   ext_syntax syn_ext_rules ("", true) syn (prep_rules I rules);
wenzelm@2366: 
wenzelm@2366: 
clasohm@0: end;