src/Doc/antiquote_setup.ML
author wenzelm
Thu Nov 07 13:34:04 2013 +0100 (2013-11-07)
changeset 54372 2d61935eed4a
parent 53061 417cb0f713e0
child 54705 0dff3326d12a
permissions -rw-r--r--
misc tuning;
wenzelm@48985
     1
(*  Title:      Doc/antiquote_setup.ML
wenzelm@21375
     2
    Author:     Makarius
wenzelm@21375
     3
wenzelm@26742
     4
Auxiliary antiquotations for the Isabelle manuals.
wenzelm@21375
     5
*)
wenzelm@21375
     6
wenzelm@43564
     7
signature ANTIQUOTE_SETUP =
wenzelm@43564
     8
sig
wenzelm@43564
     9
  val setup: theory -> theory
wenzelm@43564
    10
end;
wenzelm@43564
    11
wenzelm@43564
    12
structure Antiquote_Setup: ANTIQUOTE_SETUP =
wenzelm@26742
    13
struct
wenzelm@21375
    14
wenzelm@26742
    15
(* misc utils *)
wenzelm@26742
    16
wenzelm@29736
    17
fun translate f = Symbol.explode #> map f #> implode;
wenzelm@29736
    18
wenzelm@29736
    19
val clean_string = translate
wenzelm@26853
    20
  (fn "_" => "\\_"
wenzelm@30120
    21
    | "#" => "\\#"
wenzelm@52408
    22
    | "$" => "\\$"
wenzelm@52408
    23
    | "%" => "\\%"
wenzelm@26897
    24
    | "<" => "$<$"
wenzelm@26768
    25
    | ">" => "$>$"
wenzelm@26768
    26
    | "{" => "\\{"
wenzelm@30120
    27
    | "|" => "$\\mid$"
wenzelm@26768
    28
    | "}" => "\\}"
wenzelm@42666
    29
    | "\<hyphen>" => "-"
wenzelm@26768
    30
    | c => c);
wenzelm@26751
    31
wenzelm@31546
    32
fun clean_name "\<dots>" = "dots"
wenzelm@26897
    33
  | clean_name ".." = "ddot"
wenzelm@26897
    34
  | clean_name "." = "dot"
wenzelm@26910
    35
  | clean_name "_" = "underscore"
wenzelm@26897
    36
  | clean_name "{" = "braceleft"
wenzelm@26897
    37
  | clean_name "}" = "braceright"
wenzelm@42666
    38
  | clean_name s = s |> translate (fn "_" => "-" | "\<hyphen>" => "-" | c => c);
wenzelm@26897
    39
wenzelm@26742
    40
wenzelm@26742
    41
(* verbatim text *)
wenzelm@26742
    42
wenzelm@26742
    43
val verbatim = space_implode "\\verb,|," o map (enclose "\\verb|" "|") o space_explode "|";
wenzelm@26742
    44
wenzelm@43564
    45
val verbatim_setup =
wenzelm@43564
    46
  Thy_Output.antiquotation @{binding verbatim} (Scan.lift Args.name)
wenzelm@43564
    47
    (K (split_lines #> map verbatim #> space_implode "\\isasep\\isanewline%\n"));
wenzelm@26742
    48
wenzelm@26742
    49
wenzelm@54372
    50
(* unchecked file *)
wenzelm@54372
    51
wenzelm@54372
    52
val file_unchecked_setup =
wenzelm@54372
    53
  Thy_Output.antiquotation @{binding file_unchecked} (Scan.lift (Parse.position Parse.path))
wenzelm@54372
    54
    (fn {context = ctxt, ...} => fn (name, pos) =>
wenzelm@54372
    55
      let
wenzelm@54372
    56
        val dir = Thy_Load.master_directory (Proof_Context.theory_of ctxt);
wenzelm@54372
    57
        val path = Path.append dir (Path.explode name);
wenzelm@54372
    58
        val _ = Position.report pos (Markup.path name);
wenzelm@54372
    59
      in
wenzelm@54372
    60
        space_explode "/" name
wenzelm@54372
    61
        |> map Thy_Output.verb_text
wenzelm@54372
    62
        |> space_implode (Thy_Output.verb_text "/" ^ "\\discretionary{}{}{}")
wenzelm@54372
    63
      end);
wenzelm@54372
    64
wenzelm@54372
    65
wenzelm@26742
    66
(* ML text *)
wenzelm@26742
    67
wenzelm@26742
    68
local
wenzelm@26742
    69
wenzelm@21375
    70
fun ml_val (txt1, "") = "fn _ => (" ^ txt1 ^ ");"
wenzelm@39858
    71
  | ml_val (txt1, txt2) = "fn _ => (" ^ txt1 ^ " : " ^ txt2 ^ ");";
wenzelm@21375
    72
wenzelm@46261
    73
fun ml_op (txt1, "") = "fn _ => (op " ^ txt1 ^ ");"
wenzelm@46261
    74
  | ml_op (txt1, txt2) = "fn _ => (op " ^ txt1 ^ " : " ^ txt2 ^ ");";
wenzelm@46261
    75
wenzelm@21375
    76
fun ml_type (txt1, "") = "val _ = NONE : (" ^ txt1 ^ ") option;"
wenzelm@21375
    77
  | ml_type (txt1, txt2) = "val _ = [NONE : (" ^ txt1 ^ ") option, NONE : (" ^ txt2 ^ ") option];";
haftmann@22289
    78
wenzelm@39858
    79
fun ml_exn (txt1, "") = "fn _ => (" ^ txt1 ^ " : exn);"
wenzelm@39858
    80
  | ml_exn (txt1, txt2) = "fn _ => (" ^ txt1 ^ " : " ^ txt2 ^ " -> exn);";
haftmann@22289
    81
wenzelm@30394
    82
fun ml_structure (txt, _) = "functor XXX() = struct structure XX = " ^ txt ^ " end;";
wenzelm@21375
    83
wenzelm@36163
    84
fun ml_functor (txt, _) = "ML_Env.check_functor " ^ ML_Syntax.print_string txt;
wenzelm@21375
    85
wenzelm@39869
    86
val is_name = ML_Lex.kind_of #> (fn kind => kind = ML_Lex.Ident orelse kind = ML_Lex.LongIdent);
wenzelm@39869
    87
wenzelm@39869
    88
fun ml_name txt =
wenzelm@39869
    89
  (case filter is_name (ML_Lex.tokenize txt) of
wenzelm@39869
    90
    toks as [_] => ML_Lex.flatten toks
wenzelm@39869
    91
  | _ => error ("Single ML name expected in input: " ^ quote txt));
wenzelm@39869
    92
wenzelm@37216
    93
fun index_ml name kind ml = Thy_Output.antiquotation name
wenzelm@30394
    94
  (Scan.lift (Args.name -- Scan.optional (Args.colon |-- Args.name) ""))
wenzelm@30394
    95
  (fn {context = ctxt, ...} => fn (txt1, txt2) =>
wenzelm@30394
    96
    let
wenzelm@30394
    97
      val txt =
wenzelm@30394
    98
        if txt2 = "" then txt1
wenzelm@30394
    99
        else if kind = "type" then txt1 ^ " = " ^ txt2
wenzelm@30394
   100
        else if kind = "exception" then txt1 ^ " of " ^ txt2
wenzelm@50239
   101
        else if Symbol_Pos.is_identifier (Long_Name.base_name (ml_name txt1))
wenzelm@42290
   102
        then txt1 ^ ": " ^ txt2
wenzelm@39858
   103
        else txt1 ^ " : " ^ txt2;
wenzelm@30394
   104
      val txt' = if kind = "" then txt else kind ^ " " ^ txt;
wenzelm@37198
   105
      val _ = ML_Context.eval_text_in (SOME ctxt) false Position.none (ml (txt1, txt2));  (* ML_Lex.read (!?) *)
wenzelm@30394
   106
      val kind' = if kind = "" then "ML" else "ML " ^ kind;
wenzelm@30394
   107
    in
wenzelm@39869
   108
      "\\indexdef{}{" ^ kind' ^ "}{" ^ clean_string (ml_name txt1) ^ "}" ^
wenzelm@30394
   109
      (txt'
wenzelm@38767
   110
      |> (if Config.get ctxt Thy_Output.quotes then quote else I)
wenzelm@38767
   111
      |> (if Config.get ctxt Thy_Output.display then enclose "\\begin{verbatim}\n" "\n\\end{verbatim}"
wenzelm@30394
   112
          else split_lines #> map verbatim #> space_implode "\\isasep\\isanewline%\n"))
wenzelm@30394
   113
    end);
wenzelm@26742
   114
wenzelm@26742
   115
in
wenzelm@21375
   116
wenzelm@43564
   117
val index_ml_setup =
wenzelm@43564
   118
  index_ml @{binding index_ML} "" ml_val #>
wenzelm@46261
   119
  index_ml @{binding index_ML_op} "infix" ml_op #>
wenzelm@43564
   120
  index_ml @{binding index_ML_type} "type" ml_type #>
wenzelm@43564
   121
  index_ml @{binding index_ML_exn} "exception" ml_exn #>
wenzelm@43564
   122
  index_ml @{binding index_ML_structure} "structure" ml_structure #>
wenzelm@43564
   123
  index_ml @{binding index_ML_functor} "functor" ml_functor;
wenzelm@21375
   124
wenzelm@26742
   125
end;
wenzelm@21375
   126
berghofe@23846
   127
wenzelm@30394
   128
(* named theorems *)
berghofe@23846
   129
wenzelm@43564
   130
val named_thms_setup =
wenzelm@43564
   131
  Thy_Output.antiquotation @{binding named_thms}
wenzelm@43564
   132
    (Scan.repeat (Attrib.thm -- Scan.lift (Args.parens Args.name)))
wenzelm@43564
   133
    (fn {context = ctxt, ...} =>
wenzelm@43564
   134
      map (apfst (Thy_Output.pretty_thm ctxt))
wenzelm@43564
   135
      #> (if Config.get ctxt Thy_Output.quotes then map (apfst Pretty.quote) else I)
wenzelm@43564
   136
      #> (if Config.get ctxt Thy_Output.display
wenzelm@43564
   137
          then
wenzelm@43564
   138
            map (fn (p, name) =>
wenzelm@43564
   139
              Output.output (Pretty.string_of (Pretty.indent (Config.get ctxt Thy_Output.indent) p)) ^
wenzelm@43564
   140
              "\\rulename{" ^ Output.output (Pretty.str_of (Thy_Output.pretty_text ctxt name)) ^ "}")
wenzelm@43564
   141
            #> space_implode "\\par\\smallskip%\n"
wenzelm@43564
   142
            #> enclose "\\begin{isabelle}%\n" "%\n\\end{isabelle}"
wenzelm@43564
   143
          else
wenzelm@43564
   144
            map (fn (p, name) =>
wenzelm@43564
   145
              Output.output (Pretty.str_of p) ^
wenzelm@43564
   146
              "\\rulename{" ^ Output.output (Pretty.str_of (Thy_Output.pretty_text ctxt name)) ^ "}")
wenzelm@43564
   147
            #> space_implode "\\par\\smallskip%\n"
wenzelm@43564
   148
            #> enclose "\\isa{" "}"));
wenzelm@26742
   149
wenzelm@26742
   150
wenzelm@30394
   151
(* theory file *)
wenzelm@26742
   152
wenzelm@43564
   153
val thy_file_setup =
wenzelm@43564
   154
  Thy_Output.antiquotation @{binding thy_file} (Scan.lift Args.name)
wenzelm@43564
   155
    (fn {context = ctxt, ...} =>
wenzelm@48899
   156
      fn name => (Thy_Load.check_thy Path.current name; Thy_Output.output ctxt [Pretty.str name]));
wenzelm@26742
   157
wenzelm@26751
   158
wenzelm@30394
   159
(* Isabelle/Isar entities (with index) *)
wenzelm@26751
   160
wenzelm@26751
   161
local
wenzelm@26751
   162
wenzelm@26894
   163
fun no_check _ _ = true;
wenzelm@26894
   164
wenzelm@53061
   165
fun command_check (name, pos) =
wenzelm@53061
   166
  is_some (Keyword.command_keyword name) andalso
wenzelm@53061
   167
    let
wenzelm@53061
   168
      val markup =
wenzelm@53061
   169
        Outer_Syntax.scan Position.none name
wenzelm@53061
   170
        |> maps (Outer_Syntax.command_reports (#2 (Outer_Syntax.get_syntax ())))
wenzelm@53061
   171
        |> map (snd o fst);
wenzelm@53061
   172
      val _ = List.app (Position.report pos) markup;
wenzelm@53061
   173
    in true end;
wenzelm@53061
   174
wenzelm@53044
   175
fun thy_check check ctxt = can (check (Proof_Context.theory_of ctxt));
wenzelm@26894
   176
wenzelm@53044
   177
fun check_tool (name, pos) =
wenzelm@53044
   178
  let
wenzelm@53044
   179
    fun tool dir =
wenzelm@53044
   180
      let val path = Path.append dir (Path.basic name)
wenzelm@53044
   181
      in if File.exists path then SOME path else NONE end;
wenzelm@53044
   182
  in
wenzelm@53045
   183
    (case get_first tool (Path.split (getenv "ISABELLE_TOOLS")) of
wenzelm@53044
   184
      NONE => false
wenzelm@53044
   185
    | SOME path => (Position.report pos (Markup.path (Path.implode path)); true))
wenzelm@53044
   186
  end;
wenzelm@28237
   187
wenzelm@26751
   188
val arg = enclose "{" "}" o clean_string;
wenzelm@26751
   189
wenzelm@30394
   190
fun entity check markup kind index =
wenzelm@37216
   191
  Thy_Output.antiquotation
wenzelm@43564
   192
    (Binding.name (translate (fn " " => "_" | c => c) kind ^
wenzelm@43564
   193
      (case index of NONE => "" | SOME true => "_def" | SOME false => "_ref")))
wenzelm@53044
   194
    (Scan.lift (Scan.optional (Args.parens Args.name) "" -- Parse.position Args.name))
wenzelm@53044
   195
    (fn {context = ctxt, ...} => fn (logic, (name, pos)) =>
wenzelm@30394
   196
      let
wenzelm@30394
   197
        val hyper_name =
wenzelm@30394
   198
          "{" ^ Long_Name.append kind (Long_Name.append logic (clean_name name)) ^ "}";
wenzelm@30394
   199
        val hyper =
wenzelm@30394
   200
          enclose ("\\hyperlink" ^ hyper_name ^ "{") "}" #>
wenzelm@30394
   201
          index = SOME true ? enclose ("\\hypertarget" ^ hyper_name ^ "{") "}";
wenzelm@30394
   202
        val idx =
wenzelm@30394
   203
          (case index of
wenzelm@30394
   204
            NONE => ""
wenzelm@30394
   205
          | SOME is_def =>
wenzelm@30394
   206
              "\\index" ^ (if is_def then "def" else "ref") ^ arg logic ^ arg kind ^ arg name);
wenzelm@30394
   207
      in
wenzelm@53044
   208
        if check ctxt (name, pos) then
wenzelm@30394
   209
          idx ^
wenzelm@30394
   210
          (Output.output name
wenzelm@30394
   211
            |> (if markup = "" then I else enclose ("\\" ^ markup ^ "{") "}")
wenzelm@38767
   212
            |> (if Config.get ctxt Thy_Output.quotes then quote else I)
wenzelm@38767
   213
            |> (if Config.get ctxt Thy_Output.display
wenzelm@38767
   214
                then enclose "\\begin{isabelle}%\n" "%\n\\end{isabelle}"
wenzelm@30394
   215
                else hyper o enclose "\\mbox{\\isa{" "}}"))
wenzelm@53044
   216
        else error ("Bad " ^ kind ^ " " ^ quote name ^ Position.here pos)
wenzelm@30394
   217
      end);
wenzelm@26897
   218
wenzelm@26894
   219
fun entity_antiqs check markup kind =
wenzelm@43564
   220
  entity check markup kind NONE #>
wenzelm@43564
   221
  entity check markup kind (SOME true) #>
wenzelm@43564
   222
  entity check markup kind (SOME false);
wenzelm@26751
   223
wenzelm@26751
   224
in
wenzelm@26751
   225
wenzelm@43564
   226
val entity_setup =
wenzelm@43564
   227
  entity_antiqs no_check "" "syntax" #>
wenzelm@53061
   228
  entity_antiqs (K command_check) "isacommand" "command" #>
wenzelm@53044
   229
  entity_antiqs (K (Keyword.is_keyword o #1)) "isakeyword" "keyword" #>
wenzelm@53044
   230
  entity_antiqs (K (Keyword.is_keyword o #1)) "isakeyword" "element" #>
wenzelm@53044
   231
  entity_antiqs (thy_check Method.check) "" "method" #>
wenzelm@53044
   232
  entity_antiqs (thy_check Attrib.check) "" "attribute" #>
wenzelm@43564
   233
  entity_antiqs no_check "" "fact" #>
wenzelm@43564
   234
  entity_antiqs no_check "" "variable" #>
wenzelm@43564
   235
  entity_antiqs no_check "" "case" #>
wenzelm@53044
   236
  entity_antiqs (thy_check Thy_Output.check_command) "" "antiquotation" #>
wenzelm@53044
   237
  entity_antiqs (thy_check Thy_Output.check_option) "" "antiquotation option" #>
wenzelm@48554
   238
  entity_antiqs no_check "isatt" "setting" #>
wenzelm@48578
   239
  entity_antiqs no_check "isatt" "system option" #>
wenzelm@43564
   240
  entity_antiqs no_check "" "inference" #>
wenzelm@43564
   241
  entity_antiqs no_check "isatt" "executable" #>
wenzelm@48602
   242
  entity_antiqs (K check_tool) "isatool" "tool" #>
wenzelm@53044
   243
  entity_antiqs (thy_check ML_Context.check_antiq) "" Markup.ML_antiquotationN;
wenzelm@26751
   244
wenzelm@26742
   245
end;
wenzelm@26751
   246
wenzelm@43564
   247
wenzelm@43564
   248
(* theory setup *)
wenzelm@43564
   249
wenzelm@43564
   250
val setup =
wenzelm@43564
   251
  verbatim_setup #>
wenzelm@54372
   252
  file_unchecked_setup #>
wenzelm@43564
   253
  index_ml_setup #>
wenzelm@43564
   254
  named_thms_setup #>
wenzelm@43564
   255
  thy_file_setup #>
wenzelm@43564
   256
  entity_setup;
wenzelm@43564
   257
wenzelm@26751
   258
end;