wenzelm@5829: (*  Title:      Pure/Isar/outer_syntax.ML
wenzelm@5829:     ID:         $Id$
wenzelm@5829:     Author:     Markus Wenzel, TU Muenchen
wenzelm@5829: 
wenzelm@5829: The global Isabelle/Isar outer syntax.
wenzelm@5829: *)
wenzelm@5829: 
wenzelm@5829: signature BASIC_OUTER_SYNTAX =
wenzelm@5829: sig
wenzelm@5829:   val main: unit -> unit
wenzelm@5883:   val loop: unit -> unit
wenzelm@5829:   val help: unit -> unit
wenzelm@5923:   val load: string -> unit
wenzelm@5829: end;
wenzelm@5829: 
wenzelm@5829: signature OUTER_SYNTAX =
wenzelm@5829: sig
wenzelm@5829:   include BASIC_OUTER_SYNTAX
wenzelm@5829:   type token
wenzelm@5829:   type parser
wenzelm@5829:   val parser: bool -> string -> string ->
wenzelm@5829:     (token list -> (Toplevel.transition -> Toplevel.transition) * token list) -> parser
wenzelm@5883:   val print_outer_syntax: unit -> unit
wenzelm@5829:   val add_keywords: string list -> unit
wenzelm@5829:   val add_parsers: parser list -> unit
wenzelm@5829:   val get_header: Position.T -> (string, 'a) Source.source -> (bstring * bstring list) option
wenzelm@5829:   val read_text: Position.T -> (string, 'a) Source.source -> Toplevel.transition list
wenzelm@5829:   val read_file: string -> Toplevel.transition list
wenzelm@5829:   val isar: Toplevel.isar
wenzelm@5829: end;
wenzelm@5829: 
wenzelm@5829: structure OuterSyntax: OUTER_SYNTAX =
wenzelm@5829: struct
wenzelm@5829: 
wenzelm@5829: open OuterParse;
wenzelm@5829: 
wenzelm@5829: 
wenzelm@5829: (** outer syntax **)
wenzelm@5829: 
wenzelm@5829: (* parsers *)
wenzelm@5829: 
wenzelm@5829: type token = OuterLex.token;
wenzelm@5829: type parser_fn = token list -> (Toplevel.transition -> Toplevel.transition) * token list;
wenzelm@5829: 
wenzelm@5829: datatype parser =
wenzelm@5829:   Parser of string * string * bool * parser_fn;
wenzelm@5829: 
wenzelm@5829: fun parser int_only name comment parse = Parser (name, comment, int_only, parse);
wenzelm@5829: 
wenzelm@5829: 
wenzelm@5829: (* parse command *)
wenzelm@5829: 
wenzelm@5829: fun command_name cmd =
wenzelm@5829:   group "command"
wenzelm@5829:     (position (Scan.one (OuterLex.keyword_pred (is_some o cmd)) >> OuterLex.val_of));
wenzelm@5829: 
wenzelm@5829: fun command_body cmd (name, _) =
wenzelm@5829:   let val (int_only, parse) = the (cmd name)
wenzelm@5829:   in !!! (Scan.prompt (name ^ "# ") (parse >> pair int_only)) end;
wenzelm@5829: 
wenzelm@5829: fun command cmd =
wenzelm@5829:   $$$ ";" >> K None ||
wenzelm@5829:   command_name cmd :-- command_body cmd >> (fn ((name, pos), (int_only, f)) =>
wenzelm@5829:     Some (Toplevel.empty |> Toplevel.name name |> Toplevel.position pos |>
wenzelm@5829:       Toplevel.interactive int_only |> f));
wenzelm@5829: 
wenzelm@5829: 
wenzelm@5829: 
wenzelm@5829: (** global syntax state **)
wenzelm@5829: 
wenzelm@5829: val global_lexicon = ref Scan.empty_lexicon;
wenzelm@5829: val global_parsers = ref (Symtab.empty: (string * (bool * parser_fn)) Symtab.table);
wenzelm@5829: 
wenzelm@5829: 
wenzelm@5829: (* print syntax *)
wenzelm@5829: 
wenzelm@5829: fun print_outer_syntax () =
wenzelm@5829:   let
wenzelm@5829:     val keywords = map implode (Scan.dest_lexicon (! global_lexicon));
wenzelm@5829:     fun pretty_cmd (name, (comment, _)) =
wenzelm@5829:       Pretty.block [Pretty.str (name ^ ":"), Pretty.brk 2, Pretty.str comment];
wenzelm@5829:     val (int_cmds, cmds) = partition (#1 o #2 o #2) (Symtab.dest (! global_parsers));
wenzelm@5829:   in
wenzelm@5829:     Pretty.writeln (Pretty.strs ("keywords:" :: map quote keywords));
wenzelm@5829:     Pretty.writeln (Pretty.big_list "general commands:" (map pretty_cmd cmds));
wenzelm@5829:     Pretty.writeln (Pretty.big_list "interactive commands:" (map pretty_cmd int_cmds))
wenzelm@5829:   end;
wenzelm@5829: 
wenzelm@5829: 
wenzelm@5829: (* augment syntax *)
wenzelm@5829: 
wenzelm@5829: fun add_keywords keywords =
wenzelm@5829:   global_lexicon := Scan.extend_lexicon (! global_lexicon) (map Symbol.explode keywords);
wenzelm@5829: 
wenzelm@5829: fun add_parser (tab, Parser (name, comment, int_only, parse)) =
wenzelm@5829:  (if is_none (Symtab.lookup (tab, name)) then ()
wenzelm@5829:   else warning ("Redefined outer syntax command " ^ quote name);
wenzelm@5829:   Symtab.update ((name, (comment, (int_only, parse))), tab));
wenzelm@5829: 
wenzelm@5829: fun add_parsers parsers =
wenzelm@5829:   (global_parsers := foldl add_parser (! global_parsers, parsers);
wenzelm@5829:     add_keywords (map (fn Parser (name, _, _, _) => name) parsers));
wenzelm@5829: 
wenzelm@5829: 
wenzelm@5829: (* get current lexer / parser *)
wenzelm@5829: 
wenzelm@5829: (*Note: the syntax for files is statically determined at the very
wenzelm@5829:   beginning; for interactive processing it may change dynamically.*)
wenzelm@5829: 
wenzelm@5829: fun get_lexicon () = ! global_lexicon;
wenzelm@5829: fun get_parser () = apsome snd o curry Symtab.lookup (! global_parsers);
wenzelm@5829: 
wenzelm@5829: 
wenzelm@5829: 
wenzelm@5829: (** read theory **)
wenzelm@5829: 
wenzelm@5829: (* source *)
wenzelm@5829: 
wenzelm@5829: fun no_command cmd =
wenzelm@5829:   Scan.one ((not o OuterLex.keyword_pred ((is_some o cmd) orf equal ";")) andf OuterLex.not_eof);
wenzelm@5829: 
wenzelm@5829: fun recover cmd =
wenzelm@5829:   Scan.prompt "recover# " (Scan.one OuterLex.not_eof -- Scan.repeat (no_command cmd));
wenzelm@5829: 
wenzelm@5829: fun source do_recover cmd src =
wenzelm@5829:   src
wenzelm@5829:   |> Source.source OuterLex.stopper (Scan.bulk (fn xs => !!! (command (cmd ())) xs))
wenzelm@5829:     (if do_recover then Some (fn xs => recover (cmd ()) xs) else None)
wenzelm@5829:   |> Source.mapfilter I;
wenzelm@5829: 
wenzelm@5829: 
wenzelm@5829: (* detect header *)
wenzelm@5829: 
wenzelm@5829: val head_lexicon =
wenzelm@5829:   Scan.make_lexicon (map Symbol.explode ["+", ":", "=", "theory"]);
wenzelm@5829: 
wenzelm@5829: val head_parser =
wenzelm@5829:   $$$ "theory" |-- !!! (name -- ($$$ "=" |-- enum "+" name --| (Scan.ahead eof || $$$ ":")));
wenzelm@5829: 
wenzelm@5829: fun get_header pos src =
wenzelm@5829:   src
wenzelm@5829:   |> Symbol.source false
wenzelm@5829:   |> OuterLex.source false (K head_lexicon) pos
wenzelm@5829:   |> Source.source OuterLex.stopper (Scan.single (Scan.option head_parser)) None
wenzelm@5829:   |> (fst o the o Source.get_single);
wenzelm@5829: 
wenzelm@5829: 
wenzelm@5829: (* read text (including header) *)
wenzelm@5829: 
wenzelm@5829: fun read_text pos src =
wenzelm@5829:   src
wenzelm@5829:   |> Symbol.source false
wenzelm@5829:   |> OuterLex.source false (K (get_lexicon ())) pos
wenzelm@5829:   |> source false (K (get_parser ()))
wenzelm@5829:   |> Source.exhaust;
wenzelm@5829: 
wenzelm@5829: fun read_file name = read_text (Position.line_name 1 (quote name)) (Source.of_file name);
wenzelm@5829: 
wenzelm@5829: 
wenzelm@5829: (* interactive source of state transformers *)
wenzelm@5829: 
wenzelm@5829: val isar =
wenzelm@5829:   Source.tty
wenzelm@5829:   |> Symbol.source true
wenzelm@5829:   |> OuterLex.source true get_lexicon (Position.line_name 1 "stdin")
wenzelm@5829:   |> source true get_parser;
wenzelm@5829: 
wenzelm@5829: 
wenzelm@5829: 
wenzelm@5829: (** the read-eval-print loop **)
wenzelm@5829: 
wenzelm@5923: (* main loop *)
wenzelm@5923: 
wenzelm@5883: fun loop () = (Context.reset_context (); Toplevel.loop isar);
wenzelm@5829: 
wenzelm@5829: fun main () =
wenzelm@5829:  (Toplevel.set_state Toplevel.toplevel;
wenzelm@5829:   ml_prompts "ML> " "ML# ";
wenzelm@5829:   writeln ("\n\n" ^ Context.welcome ());
wenzelm@5883:   loop ());
wenzelm@5829: 
wenzelm@5829: 
wenzelm@5923: (* load *)
wenzelm@5923: 
wenzelm@5923: fun load name = Toplevel.excursion (read_file (name ^ ".thy"))
wenzelm@5923:   handle exn => error (Toplevel.exn_message exn);
wenzelm@5923: 
wenzelm@5923: 
wenzelm@5829: (* help *)
wenzelm@5829: 
wenzelm@5829: fun help () =
wenzelm@5829:   writeln ("This is Isabelle's underlying ML system (" ^ ml_system ^ ");\n\
wenzelm@5883:     \invoke 'loop();' to enter the Isar loop.");
wenzelm@5829: 
wenzelm@5829: 
wenzelm@5829: end;
wenzelm@5829: 
wenzelm@5829: 
wenzelm@5829: structure BasicOuterSyntax: BASIC_OUTER_SYNTAX = OuterSyntax;
wenzelm@5829: open BasicOuterSyntax;