doc-src/antiquote_setup.ML
author wenzelm
Wed, 23 Apr 2008 15:04:14 +0200
changeset 26742 5a86bc79431c
parent 26710 f79aa228c582
child 26751 2b97ea3130c2
permissions -rw-r--r--
misc cleanup;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
24584
01e83ffa6c54 fixed title
haftmann
parents: 24204
diff changeset
     1
(*  Title:      Doc/antiquote_setup.ML
21375
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
     2
    ID:         $Id$
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
     3
    Author:     Makarius
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
     4
26742
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
     5
Auxiliary antiquotations for the Isabelle manuals.
21375
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
     6
*)
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
     7
26742
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
     8
structure AntiquoteSetup: sig end =
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
     9
struct
21375
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    10
22094
008794185f4d renamed IsarOutput to ThyOutput;
wenzelm
parents: 22090
diff changeset
    11
structure O = ThyOutput;
21375
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    12
26742
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    13
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    14
(* misc utils *)
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    15
21375
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    16
val str_of_source = space_implode " " o map Args.string_of o #2 o #1 o Args.dest_src;
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    17
26742
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    18
fun tweak_line s =
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    19
  if ! O.display then s else Symbol.strip_blanks s;
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    20
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    21
val pretty_text = Pretty.chunks o map Pretty.str o map tweak_line o Library.split_lines;
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    22
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    23
fun pretty_term ctxt t = Syntax.pretty_term (Variable.auto_fixes t ctxt) t;
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    24
fun pretty_thm ctxt = pretty_term ctxt o Thm.full_prop_of;
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    25
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    26
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    27
(* verbatim text *)
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    28
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    29
val verbatim = space_implode "\\verb,|," o map (enclose "\\verb|" "|") o space_explode "|";
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    30
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    31
val _ = O.add_commands
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    32
 [("verbatim", O.args (Scan.lift Args.name) (fn _ => fn _ =>
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    33
      split_lines #> map verbatim #> space_implode "\\isasep\\isanewline%\n"))];
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    34
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    35
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    36
(* ML text *)
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    37
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    38
local
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    39
21375
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    40
fun ml_val (txt1, "") = "fn _ => (" ^ txt1 ^ ");"
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    41
  | ml_val (txt1, txt2) = "fn _ => (" ^ txt1 ^ ": " ^ txt2 ^ ");";
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    42
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    43
fun ml_type (txt1, "") = "val _ = NONE : (" ^ txt1 ^ ") option;"
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    44
  | ml_type (txt1, txt2) = "val _ = [NONE : (" ^ txt1 ^ ") option, NONE : (" ^ txt2 ^ ") option];";
22289
41ce4f5c97c9 added antiquotation for exceptions
haftmann
parents: 22094
diff changeset
    45
23651
6e0b8b6012c9 renamed ML_exc to ML_exn;
wenzelm
parents: 22289
diff changeset
    46
fun ml_exn (txt1, "") = "fn _ => (" ^ txt1 ^ ": exn);"
6e0b8b6012c9 renamed ML_exc to ML_exn;
wenzelm
parents: 22289
diff changeset
    47
  | ml_exn (txt1, txt2) = "fn _ => (" ^ txt1 ^ ": " ^ txt2 ^ " -> exn);";
22289
41ce4f5c97c9 added antiquotation for exceptions
haftmann
parents: 22094
diff changeset
    48
21375
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    49
fun ml_structure (txt, _) = "functor DUMMY_FUNCTOR() = struct structure DUMMY = " ^ txt ^ " end;"
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    50
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    51
fun ml_functor _ = "val _ = ();";  (*no check!*)
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    52
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    53
fun index_ml kind ml src ctxt (txt1, txt2) =
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    54
  let
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    55
    val txt = if txt2 = "" then txt1 else
26742
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    56
      if kind = "type" then txt1 ^ " = " ^ txt2
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    57
      else if kind = "exception" then txt1 ^ " of " ^ txt2
22289
41ce4f5c97c9 added antiquotation for exceptions
haftmann
parents: 22094
diff changeset
    58
      else txt1 ^ ": " ^ txt2;
21375
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    59
    val txt' = if kind = "" then txt else kind ^ " " ^ txt;
22289
41ce4f5c97c9 added antiquotation for exceptions
haftmann
parents: 22094
diff changeset
    60
    val _ = writeln (ml (txt1, txt2));
26455
1757a6e049f4 reorganized signature of ML_Context;
wenzelm
parents: 26385
diff changeset
    61
    val _ = ML_Context.eval_in (SOME (Context.Proof ctxt)) false Position.none (ml (txt1, txt2));
21375
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    62
  in
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    63
    "\\indexml" ^ kind ^ enclose "{" "}"
22289
41ce4f5c97c9 added antiquotation for exceptions
haftmann
parents: 22094
diff changeset
    64
      (translate_string (fn "_" => "-" | ">" => "$>$" | "#" => "\\#" | c => c) txt1) ^
21375
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    65
    ((if ! O.source then str_of_source src else txt')
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    66
    |> (if ! O.quotes then quote else I)
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    67
    |> (if ! O.display then enclose "\\begin{verbatim}\n" "\n\\end{verbatim}"
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    68
    else split_lines #> map verbatim #> space_implode "\\isasep\\isanewline%\n"))
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    69
  end;
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    70
26461
da989545e59c some styling
haftmann
parents: 26455
diff changeset
    71
fun output_ml ctxt src =
da989545e59c some styling
haftmann
parents: 26455
diff changeset
    72
  if ! O.display then enclose "\\begin{verbatim}\n" "\n\\end{verbatim}"
26742
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    73
  else
26461
da989545e59c some styling
haftmann
parents: 26455
diff changeset
    74
    split_lines
da989545e59c some styling
haftmann
parents: 26455
diff changeset
    75
    #> map (space_implode "\\verb,|," o map (enclose "\\verb|" "|") o space_explode "|")
da989545e59c some styling
haftmann
parents: 26455
diff changeset
    76
    #> space_implode "\\isasep\\isanewline%\n";
da989545e59c some styling
haftmann
parents: 26455
diff changeset
    77
26742
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    78
fun ml_args x = O.args (Scan.lift (Args.name -- Scan.optional (Args.colon |-- Args.name) "")) x;
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    79
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    80
in
21375
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    81
26742
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    82
val _ = O.add_commands
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    83
 [("index_ML", ml_args (index_ml "" ml_val)),
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    84
  ("index_ML_type", ml_args (index_ml "type" ml_type)),
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    85
  ("index_ML_exn", ml_args (index_ml "exception" ml_exn)),
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    86
  ("index_ML_structure", ml_args (index_ml "structure" ml_structure)),
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    87
  ("index_ML_functor", ml_args (index_ml "functor" ml_functor)),
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    88
  ("ML_functor", O.args (Scan.lift Args.name) output_ml),
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    89
  ("ML_text", O.args (Scan.lift Args.name) output_ml)];
21375
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    90
26742
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    91
end;
21375
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
    92
23846
bfedd1a024fc Added named_thms antiquotation.
berghofe
parents: 23651
diff changeset
    93
bfedd1a024fc Added named_thms antiquotation.
berghofe
parents: 23651
diff changeset
    94
(* theorems with names *)
bfedd1a024fc Added named_thms antiquotation.
berghofe
parents: 23651
diff changeset
    95
26742
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    96
local
23846
bfedd1a024fc Added named_thms antiquotation.
berghofe
parents: 23651
diff changeset
    97
26742
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    98
fun output_named_thms src ctxt xs =
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
    99
  map (apfst (pretty_thm ctxt)) xs        (*always pretty in order to exhibit errors!*)
23846
bfedd1a024fc Added named_thms antiquotation.
berghofe
parents: 23651
diff changeset
   100
  |> (if ! O.quotes then map (apfst Pretty.quote) else I)
bfedd1a024fc Added named_thms antiquotation.
berghofe
parents: 23651
diff changeset
   101
  |> (if ! O.display then
bfedd1a024fc Added named_thms antiquotation.
berghofe
parents: 23651
diff changeset
   102
    map (fn (p, name) =>
bfedd1a024fc Added named_thms antiquotation.
berghofe
parents: 23651
diff changeset
   103
      Output.output (Pretty.string_of (Pretty.indent (! O.indent) p)) ^
bfedd1a024fc Added named_thms antiquotation.
berghofe
parents: 23651
diff changeset
   104
      "\\rulename{" ^ Output.output (Pretty.str_of (pretty_text name)) ^ "}")
bfedd1a024fc Added named_thms antiquotation.
berghofe
parents: 23651
diff changeset
   105
    #> space_implode "\\par\\smallskip%\n"
bfedd1a024fc Added named_thms antiquotation.
berghofe
parents: 23651
diff changeset
   106
    #> enclose "\\begin{isabelle}%\n" "%\n\\end{isabelle}"
bfedd1a024fc Added named_thms antiquotation.
berghofe
parents: 23651
diff changeset
   107
  else
bfedd1a024fc Added named_thms antiquotation.
berghofe
parents: 23651
diff changeset
   108
    map (fn (p, name) =>
bfedd1a024fc Added named_thms antiquotation.
berghofe
parents: 23651
diff changeset
   109
      Output.output (Pretty.str_of p) ^
bfedd1a024fc Added named_thms antiquotation.
berghofe
parents: 23651
diff changeset
   110
      "\\rulename{" ^ Output.output (Pretty.str_of (pretty_text name)) ^ "}")
bfedd1a024fc Added named_thms antiquotation.
berghofe
parents: 23651
diff changeset
   111
    #> space_implode "\\par\\smallskip%\n"
bfedd1a024fc Added named_thms antiquotation.
berghofe
parents: 23651
diff changeset
   112
    #> enclose "\\isa{" "}");
bfedd1a024fc Added named_thms antiquotation.
berghofe
parents: 23651
diff changeset
   113
21375
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
   114
in
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
   115
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
   116
val _ = O.add_commands
26742
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
   117
 [("named_thms", O.args (Scan.repeat (Attrib.thm --
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
   118
      Scan.lift (Args.$$$ "(" |-- Args.name --| Args.$$$ ")"))) output_named_thms)];
21375
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
   119
ae8a112b62d7 Auxiliary antiquotations for Isabelle manuals.
wenzelm
parents:
diff changeset
   120
end;
26742
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
   121
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
   122
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
   123
(* theory files *)
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
   124
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
   125
val _ = O.add_commands
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
   126
 [("thy_file", O.args (Scan.lift Args.name) (O.output (fn _ => fn name =>
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
   127
      (ThyLoad.check_thy Path.current name; Pretty.str name))))];
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
   128
5a86bc79431c misc cleanup;
wenzelm
parents: 26710
diff changeset
   129
end;