doc-src/more_antiquote.ML
author wenzelm
Wed, 15 Apr 2009 11:14:48 +0200
changeset 30895 bad26d8f0adf
parent 30394 c11a1e65a2ed
child 30977 0e8e8903ff4e
permissions -rw-r--r--
updated for Isabelle2009;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
30394
c11a1e65a2ed moved @{ML_functor} and @{ML_text} to Pure;
wenzelm
parents: 30202
diff changeset
     1
(*  Title:      doc-src/more_antiquote.ML
28440
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
     2
    Author:     Florian Haftmann, TU Muenchen
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
     3
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
     4
More antiquotations.
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
     5
*)
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
     6
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
     7
signature MORE_ANTIQUOTE =
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
     8
sig
28727
185110a4b97a clarified verbatim vs. typewriter
haftmann
parents: 28714
diff changeset
     9
  val typewriter: string -> string
28440
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
    10
end;
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
    11
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
    12
structure More_Antiquote : MORE_ANTIQUOTE =
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
    13
struct
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
    14
28727
185110a4b97a clarified verbatim vs. typewriter
haftmann
parents: 28714
diff changeset
    15
(* printing typewriter lines *)
28440
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
    16
28727
185110a4b97a clarified verbatim vs. typewriter
haftmann
parents: 28714
diff changeset
    17
fun typewriter s =
28714
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
    18
  let
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
    19
    val parse = Scan.repeat
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
    20
      (Scan.this_string "\n" |-- Scan.succeed "\\\\\n\\hspace*{0pt}"
30394
c11a1e65a2ed moved @{ML_functor} and @{ML_text} to Pure;
wenzelm
parents: 30202
diff changeset
    21
        || (Scan.this_string " "
28921
e60a41c21768 consider TeX spacing conventions for punctuation marks
haftmann
parents: 28727
diff changeset
    22
          || Scan.this_string "."
e60a41c21768 consider TeX spacing conventions for punctuation marks
haftmann
parents: 28727
diff changeset
    23
          || Scan.this_string ","
28714
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
    24
          || Scan.this_string ":"
28921
e60a41c21768 consider TeX spacing conventions for punctuation marks
haftmann
parents: 28727
diff changeset
    25
          || Scan.this_string ";"
28714
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
    26
          || Scan.this_string "\"" |-- Scan.succeed "{\\char34}"
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
    27
          || Scan.this_string "#" |-- Scan.succeed "{\\char35}"
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
    28
          || Scan.this_string "$" |-- Scan.succeed "{\\char36}"
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
    29
          || Scan.this_string "%" |-- Scan.succeed "{\\char37}"
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
    30
          || Scan.this_string "&" |-- Scan.succeed "{\\char38}"
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
    31
          || Scan.this_string "\\" |-- Scan.succeed "{\\char92}"
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
    32
          || Scan.this_string "^" |-- Scan.succeed "{\\char94}"
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
    33
          || Scan.this_string "_" |-- Scan.succeed "{\\char95}"
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
    34
          || Scan.this_string "{" |-- Scan.succeed "{\\char123}"
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
    35
          || Scan.this_string "}" |-- Scan.succeed "{\\char125}"
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
    36
          || Scan.this_string "~" |-- Scan.succeed "{\\char126}")
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
    37
          -- Scan.repeat (Scan.this_string " ")
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
    38
          >> (fn (x, xs) => x ^ replicate_string (length xs) "~")
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
    39
        || Scan.one Symbol.not_eof);
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
    40
    fun is_newline s = (s = "\n");
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
    41
    val cs = explode s |> take_prefix is_newline |> snd
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
    42
      |> take_suffix is_newline |> fst;
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
    43
    val (texts, []) =  Scan.finite Symbol.stopper parse cs
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
    44
  in if null texts
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
    45
    then ""
28727
185110a4b97a clarified verbatim vs. typewriter
haftmann
parents: 28714
diff changeset
    46
    else implode ("\\isatypewriter%\n\\noindent%\n\\hspace*{0pt}" :: texts)
28714
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
    47
  end
28440
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
    48
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
    49
29397
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
    50
(* class and type constructor antiquotation *)
28440
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
    51
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
    52
local
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
    53
28634
764ef122a164 added type antiquotation
haftmann
parents: 28461
diff changeset
    54
val pr_text = enclose "\\isa{" "}" o Pretty.output o Pretty.str;
764ef122a164 added type antiquotation
haftmann
parents: 28461
diff changeset
    55
764ef122a164 added type antiquotation
haftmann
parents: 28461
diff changeset
    56
fun pr_class ctxt = Sign.read_class (ProofContext.theory_of ctxt)
764ef122a164 added type antiquotation
haftmann
parents: 28461
diff changeset
    57
  #> Sign.extern_class (ProofContext.theory_of ctxt)
764ef122a164 added type antiquotation
haftmann
parents: 28461
diff changeset
    58
  #> pr_text;
764ef122a164 added type antiquotation
haftmann
parents: 28461
diff changeset
    59
764ef122a164 added type antiquotation
haftmann
parents: 28461
diff changeset
    60
fun pr_type ctxt = Sign.intern_type (ProofContext.theory_of ctxt)
764ef122a164 added type antiquotation
haftmann
parents: 28461
diff changeset
    61
  #> tap (Sign.arity_number (ProofContext.theory_of ctxt))
764ef122a164 added type antiquotation
haftmann
parents: 28461
diff changeset
    62
  #> Sign.extern_type (ProofContext.theory_of ctxt)
764ef122a164 added type antiquotation
haftmann
parents: 28461
diff changeset
    63
  #> pr_text;
28440
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
    64
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
    65
in
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
    66
30394
c11a1e65a2ed moved @{ML_functor} and @{ML_text} to Pure;
wenzelm
parents: 30202
diff changeset
    67
val _ = ThyOutput.antiquotation "class" (Scan.lift Args.name) (pr_class o #context);
c11a1e65a2ed moved @{ML_functor} and @{ML_text} to Pure;
wenzelm
parents: 30202
diff changeset
    68
val _ = ThyOutput.antiquotation "type" (Scan.lift Args.name) (pr_type o #context);
28440
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
    69
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
    70
end;
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
    71
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
    72
29397
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
    73
(* code theorem antiquotation *)
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
    74
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
    75
local
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
    76
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
    77
fun pretty_term ctxt t = Syntax.pretty_term (Variable.auto_fixes t ctxt) t;
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
    78
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
    79
fun pretty_thm ctxt = pretty_term ctxt o Thm.full_prop_of;
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
    80
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
    81
fun no_vars ctxt thm =
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
    82
  let
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
    83
    val ctxt' = Variable.set_body false ctxt;
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
    84
    val ((_, [thm]), _) = Variable.import_thms true [thm] ctxt';
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
    85
  in thm end;
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
    86
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
    87
fun pretty_code_thm src ctxt raw_const =
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
    88
  let
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
    89
    val thy = ProofContext.theory_of ctxt;
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
    90
    val const = Code_Unit.check_const thy raw_const;
30202
2775062fd3a9 reduced confusion code_funcgr vs. code_wellsorted
haftmann
parents: 29874
diff changeset
    91
    val (_, funcgr) = Code_Wellsorted.make thy [const];
29874
0b92f68124e8 display code theorems with HOL equality
haftmann
parents: 29619
diff changeset
    92
    fun holize thm = @{thm meta_eq_to_obj_eq} OF [thm];
30202
2775062fd3a9 reduced confusion code_funcgr vs. code_wellsorted
haftmann
parents: 29874
diff changeset
    93
    val thms = Code_Wellsorted.eqns funcgr const
29397
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
    94
      |> map_filter (fn (thm, linear) => if linear then SOME thm else NONE)
29874
0b92f68124e8 display code theorems with HOL equality
haftmann
parents: 29619
diff changeset
    95
      |> map (holize o no_vars ctxt o AxClass.overload thy);
30394
c11a1e65a2ed moved @{ML_functor} and @{ML_text} to Pure;
wenzelm
parents: 30202
diff changeset
    96
  in ThyOutput.output (ThyOutput.maybe_pretty_source (pretty_thm ctxt) src thms) end;
29397
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
    97
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
    98
in
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
    99
30394
c11a1e65a2ed moved @{ML_functor} and @{ML_text} to Pure;
wenzelm
parents: 30202
diff changeset
   100
val _ = ThyOutput.antiquotation "code_thms" Args.term
c11a1e65a2ed moved @{ML_functor} and @{ML_text} to Pure;
wenzelm
parents: 30202
diff changeset
   101
  (fn {source, context, ...} => pretty_code_thm source context);
29397
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
   102
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
   103
end;
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
   104
aab26a65e80f dded code_thm antiquotation
haftmann
parents: 28921
diff changeset
   105
28440
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
   106
(* code antiquotation *)
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
   107
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
   108
local
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
   109
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
   110
  val parse_const_terms = Scan.repeat1 Args.term
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
   111
    >> (fn ts => fn thy => map (Code_Unit.check_const thy) ts);
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
   112
  val parse_consts = Scan.lift (Args.parens (Args.$$$ "consts")) |-- parse_const_terms
29619
82054da94a74 be more liberal with selected code statements
haftmann
parents: 29397
diff changeset
   113
    >> (fn mk_cs => fn thy => fn naming => map_filter (Code_Thingol.lookup_const naming) (mk_cs thy));
28440
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
   114
  val parse_types = Scan.lift (Args.parens (Args.$$$ "types") |-- Scan.repeat1 Args.name)
29619
82054da94a74 be more liberal with selected code statements
haftmann
parents: 29397
diff changeset
   115
    >> (fn tycos => fn thy => fn naming => map_filter (Code_Thingol.lookup_tyco naming o Sign.intern_type thy) tycos);
28440
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
   116
  val parse_classes = Scan.lift (Args.parens (Args.$$$ "classes") |-- Scan.repeat1 Args.name)
29619
82054da94a74 be more liberal with selected code statements
haftmann
parents: 29397
diff changeset
   117
    >> (fn classes => fn thy => fn naming => map_filter (Code_Thingol.lookup_class naming o Sign.intern_class thy) classes);
28440
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
   118
  val parse_instances = Scan.lift (Args.parens (Args.$$$ "instances") |-- Scan.repeat1 (Args.name --| Args.$$$ "::" -- Args.name))
29619
82054da94a74 be more liberal with selected code statements
haftmann
parents: 29397
diff changeset
   119
    >> (fn insts => fn thy => fn naming => map_filter (Code_Thingol.lookup_instance naming o apsnd (Sign.intern_type thy) o apfst (Sign.intern_class thy) o swap) insts);
30394
c11a1e65a2ed moved @{ML_functor} and @{ML_text} to Pure;
wenzelm
parents: 30202
diff changeset
   120
  val parse_names = parse_consts || parse_types || parse_classes || parse_instances;
28440
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
   121
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
   122
in
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
   123
30394
c11a1e65a2ed moved @{ML_functor} and @{ML_text} to Pure;
wenzelm
parents: 30202
diff changeset
   124
val _ = ThyOutput.antiquotation "code_stmts"
c11a1e65a2ed moved @{ML_functor} and @{ML_text} to Pure;
wenzelm
parents: 30202
diff changeset
   125
  (parse_const_terms -- Scan.repeat parse_names -- Scan.lift (Args.parens Args.name))
c11a1e65a2ed moved @{ML_functor} and @{ML_text} to Pure;
wenzelm
parents: 30202
diff changeset
   126
  (fn {context = ctxt, ...} => fn ((mk_cs, mk_stmtss), target) =>
c11a1e65a2ed moved @{ML_functor} and @{ML_text} to Pure;
wenzelm
parents: 30202
diff changeset
   127
    let val thy = ProofContext.theory_of ctxt in
c11a1e65a2ed moved @{ML_functor} and @{ML_text} to Pure;
wenzelm
parents: 30202
diff changeset
   128
      Code_Target.code_of thy
c11a1e65a2ed moved @{ML_functor} and @{ML_text} to Pure;
wenzelm
parents: 30202
diff changeset
   129
        target "Example" (mk_cs thy)
c11a1e65a2ed moved @{ML_functor} and @{ML_text} to Pure;
wenzelm
parents: 30202
diff changeset
   130
        (fn naming => maps (fn f => f thy naming) mk_stmtss)
c11a1e65a2ed moved @{ML_functor} and @{ML_text} to Pure;
wenzelm
parents: 30202
diff changeset
   131
      |> typewriter
c11a1e65a2ed moved @{ML_functor} and @{ML_text} to Pure;
wenzelm
parents: 30202
diff changeset
   132
    end);
28440
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
   133
0b9ddfa6458e added more_antiquote.ML
haftmann
parents:
diff changeset
   134
end;
30394
c11a1e65a2ed moved @{ML_functor} and @{ML_text} to Pure;
wenzelm
parents: 30202
diff changeset
   135
c11a1e65a2ed moved @{ML_functor} and @{ML_text} to Pure;
wenzelm
parents: 30202
diff changeset
   136
end;