doc-src/antiquote_setup.ML
author wenzelm
Tue Oct 09 00:20:13 2007 +0200 (2007-10-09)
changeset 24920 2a45e400fdad
parent 24584 01e83ffa6c54
child 26385 ae7564661e76
permissions -rw-r--r--
generic Syntax.pretty/string_of operations;
     1 (*  Title:      Doc/antiquote_setup.ML
     2     ID:         $Id$
     3     Author:     Makarius
     4 
     5 Auxiliary antiquotations for Isabelle manuals.
     6 *)
     7 
     8 local
     9 
    10 structure O = ThyOutput;
    11 
    12 val str_of_source = space_implode " " o map Args.string_of o #2 o #1 o Args.dest_src;
    13 
    14 fun ml_val (txt1, "") = "fn _ => (" ^ txt1 ^ ");"
    15   | ml_val (txt1, txt2) = "fn _ => (" ^ txt1 ^ ": " ^ txt2 ^ ");";
    16 
    17 fun ml_type (txt1, "") = "val _ = NONE : (" ^ txt1 ^ ") option;"
    18   | ml_type (txt1, txt2) = "val _ = [NONE : (" ^ txt1 ^ ") option, NONE : (" ^ txt2 ^ ") option];";
    19 
    20 fun ml_exn (txt1, "") = "fn _ => (" ^ txt1 ^ ": exn);"
    21   | ml_exn (txt1, txt2) = "fn _ => (" ^ txt1 ^ ": " ^ txt2 ^ " -> exn);";
    22 
    23 fun ml_structure (txt, _) = "functor DUMMY_FUNCTOR() = struct structure DUMMY = " ^ txt ^ " end;"
    24 
    25 fun ml_functor _ = "val _ = ();";  (*no check!*)
    26 
    27 val verbatim = space_implode "\\verb,|," o map (enclose "\\verb|" "|") o space_explode "|";
    28 
    29 fun index_ml kind ml src ctxt (txt1, txt2) =
    30   let
    31     val txt = if txt2 = "" then txt1 else
    32       if kind = "type"
    33         then txt1 ^ " = " ^ txt2
    34       else if kind = "exception"
    35         then txt1 ^ " of " ^ txt2
    36       else txt1 ^ ": " ^ txt2;
    37     val txt' = if kind = "" then txt else kind ^ " " ^ txt;
    38     val _ = writeln (ml (txt1, txt2));
    39     val _ = ML_Context.use_mltext (ml (txt1, txt2)) false (SOME (Context.Proof ctxt));
    40   in
    41     "\\indexml" ^ kind ^ enclose "{" "}"
    42       (translate_string (fn "_" => "-" | ">" => "$>$" | "#" => "\\#" | c => c) txt1) ^
    43     ((if ! O.source then str_of_source src else txt')
    44     |> (if ! O.quotes then quote else I)
    45     |> (if ! O.display then enclose "\\begin{verbatim}\n" "\n\\end{verbatim}"
    46     else split_lines #> map verbatim #> space_implode "\\isasep\\isanewline%\n"))
    47   end;
    48 
    49 fun output_verbatim _ _ = split_lines #> map verbatim #> space_implode "\\isasep\\isanewline%\n";
    50 
    51 fun arguments x = O.args (Scan.lift (Args.name -- Scan.optional (Args.colon |-- Args.name) "")) x;
    52 
    53 fun pretty_thy_file name = (ThyLoad.check_thy Path.current name; Pretty.str name);
    54 
    55 
    56 (* theorems with names *)
    57 
    58 fun tweak_line s =
    59   if ! O.display then s else Symbol.strip_blanks s;
    60 
    61 val pretty_text = Pretty.chunks o map Pretty.str o map tweak_line o Library.split_lines;
    62 
    63 fun output_named_list pretty src ctxt xs =
    64   map (apfst (pretty ctxt)) xs        (*always pretty in order to exhibit errors!*)
    65   |> (if ! O.quotes then map (apfst Pretty.quote) else I)
    66   |> (if ! O.display then
    67     map (fn (p, name) =>
    68       Output.output (Pretty.string_of (Pretty.indent (! O.indent) p)) ^
    69       "\\rulename{" ^ Output.output (Pretty.str_of (pretty_text name)) ^ "}")
    70     #> space_implode "\\par\\smallskip%\n"
    71     #> enclose "\\begin{isabelle}%\n" "%\n\\end{isabelle}"
    72   else
    73     map (fn (p, name) =>
    74       Output.output (Pretty.str_of p) ^
    75       "\\rulename{" ^ Output.output (Pretty.str_of (pretty_text name)) ^ "}")
    76     #> space_implode "\\par\\smallskip%\n"
    77     #> enclose "\\isa{" "}");
    78 
    79 fun pretty_term ctxt = Syntax.pretty_term ctxt o ProofContext.revert_skolems ctxt;
    80 fun pretty_thm ctxt = pretty_term ctxt o Thm.full_prop_of;
    81 
    82 in
    83 
    84 val _ = O.add_commands
    85  [("index_ML", arguments (index_ml "" ml_val)),
    86   ("index_ML_type", arguments (index_ml "type" ml_type)),
    87   ("index_ML_exn", arguments (index_ml "exception" ml_exn)),
    88   ("index_ML_structure", arguments (index_ml "structure" ml_structure)),
    89   ("index_ML_functor", arguments (index_ml "functor" ml_functor)),
    90   ("ML_functor", O.args (Scan.lift Args.name) output_verbatim),
    91   ("verbatim", O.args (Scan.lift Args.name) output_verbatim),
    92   ("thy_file", O.args (Scan.lift Args.name) (O.output (K pretty_thy_file))),
    93   ("named_thms", O.args (Scan.repeat (Attrib.thm --
    94        Scan.lift (Args.$$$ "(" |-- Args.name --| Args.$$$ ")")))
    95      (output_named_list pretty_thm))];
    96 
    97 end;