src/Doc/antiquote_setup.ML
author blanchet
Tue Nov 07 15:16:42 2017 +0100 (19 months ago)
changeset 67022 49309fe530fd
parent 66682 c4cbe609f6a8
child 67386 998e01d6f8fd
permissions -rw-r--r--
more robust parsing for THF proofs (esp. polymorphic Leo-III proofs)
     1 (*  Title:      Doc/antiquote_setup.ML
     2     Author:     Makarius
     3 
     4 Auxiliary antiquotations for the Isabelle manuals.
     5 *)
     6 
     7 structure Antiquote_Setup: sig end =
     8 struct
     9 
    10 (* misc utils *)
    11 
    12 fun translate f = Symbol.explode #> map f #> implode;
    13 
    14 val clean_string = translate
    15   (fn "_" => "\\_"
    16     | "#" => "\\#"
    17     | "$" => "\\$"
    18     | "%" => "\\%"
    19     | "<" => "$<$"
    20     | ">" => "$>$"
    21     | "{" => "\\{"
    22     | "|" => "$\\mid$"
    23     | "}" => "\\}"
    24     | "\<hyphen>" => "-"
    25     | c => c);
    26 
    27 fun clean_name "\<dots>" = "dots"
    28   | clean_name ".." = "ddot"
    29   | clean_name "." = "dot"
    30   | clean_name "_" = "underscore"
    31   | clean_name "{" = "braceleft"
    32   | clean_name "}" = "braceright"
    33   | clean_name s = s |> translate (fn "_" => "-" | "\<hyphen>" => "-" | c => c);
    34 
    35 
    36 (* ML text *)
    37 
    38 local
    39 
    40 fun ml_val (toks1, []) = ML_Lex.read "fn _ => (" @ toks1 @ ML_Lex.read ");"
    41   | ml_val (toks1, toks2) =
    42       ML_Lex.read "fn _ => (" @ toks1 @ ML_Lex.read " : " @ toks2 @ ML_Lex.read ");";
    43 
    44 fun ml_op (toks1, []) = ML_Lex.read "fn _ => (op " @ toks1 @ ML_Lex.read ");"
    45   | ml_op (toks1, toks2) =
    46       ML_Lex.read "fn _ => (op " @ toks1 @ ML_Lex.read " : " @ toks2 @ ML_Lex.read ");";
    47 
    48 fun ml_type (toks1, []) = ML_Lex.read "val _ = NONE : (" @ toks1 @ ML_Lex.read ") option;"
    49   | ml_type (toks1, toks2) =
    50       ML_Lex.read "val _ = [NONE : (" @ toks1 @ ML_Lex.read ") option, NONE : (" @
    51         toks2 @ ML_Lex.read ") option];";
    52 
    53 fun ml_exception (toks1, []) = ML_Lex.read "fn _ => (" @ toks1 @ ML_Lex.read " : exn);"
    54   | ml_exception (toks1, toks2) =
    55       ML_Lex.read "fn _ => (" @ toks1 @ ML_Lex.read " : " @ toks2 @ ML_Lex.read " -> exn);";
    56 
    57 fun ml_structure (toks, _) =
    58   ML_Lex.read "functor XXX() = struct structure XX = " @ toks @ ML_Lex.read " end;";
    59 
    60 fun ml_functor (Antiquote.Text tok :: _, _) =
    61       ML_Lex.read "ML_Env.check_functor " @
    62       ML_Lex.read (ML_Syntax.print_string (ML_Lex.content_of tok))
    63   | ml_functor _ = raise Fail "Bad ML functor specification";
    64 
    65 val is_name =
    66   ML_Lex.kind_of #> (fn kind => kind = ML_Lex.Ident orelse kind = ML_Lex.Long_Ident);
    67 
    68 fun ml_name txt =
    69   (case filter is_name (ML_Lex.tokenize txt) of
    70     toks as [_] => ML_Lex.flatten toks
    71   | _ => error ("Single ML name expected in input: " ^ quote txt));
    72 
    73 fun prep_ml source =
    74   (Input.source_content source, ML_Lex.read_source false source);
    75 
    76 fun index_ml name kind ml = Thy_Output.antiquotation name
    77   (Scan.lift (Args.text_input -- Scan.option (Args.colon |-- Args.text_input)))
    78   (fn {context = ctxt, ...} => fn (source1, opt_source2) =>
    79     let
    80       val (txt1, toks1) = prep_ml source1;
    81       val (txt2, toks2) =
    82         (case opt_source2 of
    83           SOME source => prep_ml source
    84         | NONE => ("", []));
    85 
    86       val txt =
    87         if txt2 = "" then txt1
    88         else if kind = "type" then txt1 ^ " = " ^ txt2
    89         else if kind = "exception" then txt1 ^ " of " ^ txt2
    90         else if Symbol_Pos.is_identifier (Long_Name.base_name (ml_name txt1))
    91         then txt1 ^ ": " ^ txt2
    92         else txt1 ^ " : " ^ txt2;
    93       val txt' = if kind = "" then txt else kind ^ " " ^ txt;
    94 
    95       val pos = Input.pos_of source1;
    96       val _ =
    97         ML_Context.eval_in (SOME ctxt) ML_Compiler.flags pos (ml (toks1, toks2))
    98           handle ERROR msg => error (msg ^ Position.here pos);
    99       val kind' = if kind = "" then "ML" else "ML " ^ kind;
   100     in
   101       "\\indexdef{}{" ^ kind' ^ "}{" ^ clean_string (ml_name txt1) ^ "}" ^
   102       (Thy_Output.verbatim_text ctxt txt')
   103     end);
   104 
   105 in
   106 
   107 val _ =
   108   Theory.setup
   109    (index_ml @{binding index_ML} "" ml_val #>
   110     index_ml @{binding index_ML_op} "infix" ml_op #>
   111     index_ml @{binding index_ML_type} "type" ml_type #>
   112     index_ml @{binding index_ML_exception} "exception" ml_exception #>
   113     index_ml @{binding index_ML_structure} "structure" ml_structure #>
   114     index_ml @{binding index_ML_functor} "functor" ml_functor);
   115 
   116 end;
   117 
   118 
   119 (* named theorems *)
   120 
   121 val _ =
   122   Theory.setup (Thy_Output.antiquotation @{binding named_thms}
   123     (Scan.repeat (Attrib.thm -- Scan.lift (Args.parens Args.name)))
   124     (fn {context = ctxt, ...} =>
   125       map (apfst (Thy_Output.pretty_thm ctxt))
   126       #> (if Config.get ctxt Thy_Output.quotes then map (apfst Pretty.quote) else I)
   127       #> (if Config.get ctxt Thy_Output.display
   128           then
   129             map (fn (p, name) =>
   130               Output.output
   131                 (Thy_Output.string_of_margin ctxt
   132                   (Pretty.indent (Config.get ctxt Thy_Output.indent) p)) ^
   133               "\\rulename{" ^
   134               Output.output (Pretty.unformatted_string_of (Thy_Output.pretty_text ctxt name)) ^ "}")
   135             #> space_implode "\\par\\smallskip%\n"
   136             #> Latex.environment "isabelle"
   137           else
   138             map (fn (p, name) =>
   139               Output.output (Pretty.unformatted_string_of p) ^
   140               "\\rulename{" ^
   141               Output.output (Pretty.unformatted_string_of (Thy_Output.pretty_text ctxt name)) ^ "}")
   142             #> space_implode "\\par\\smallskip%\n"
   143             #> enclose "\\isa{" "}")));
   144 
   145 
   146 (* Isabelle/Isar entities (with index) *)
   147 
   148 local
   149 
   150 fun no_check (_: Proof.context) (name, _: Position.T) = name;
   151 
   152 fun check_keyword ctxt (name, pos) =
   153   if Keyword.is_keyword (Thy_Header.get_keywords' ctxt) name then name
   154   else error ("Bad outer syntax keyword " ^ quote name ^ Position.here pos);
   155 
   156 fun check_system_option ctxt (name, pos) =
   157   (Context_Position.report ctxt pos (Options.default_markup (name, pos)); true)
   158     handle ERROR _ => false;
   159 
   160 val arg = enclose "{" "}" o clean_string;
   161 
   162 fun entity check markup binding index =
   163   Thy_Output.antiquotation
   164     (binding |> Binding.map_name (fn name => name ^
   165       (case index of NONE => "" | SOME true => "_def" | SOME false => "_ref")))
   166     (Scan.lift (Scan.optional (Args.parens Args.name) "" -- Parse.position Args.name))
   167     (fn {context = ctxt, ...} => fn (logic, (name, pos)) =>
   168       let
   169         val kind = translate (fn "_" => " " | c => c) (Binding.name_of binding);
   170         val hyper_name =
   171           "{" ^ Long_Name.append kind (Long_Name.append logic (clean_name name)) ^ "}";
   172         val hyper =
   173           enclose ("\\hyperlink" ^ hyper_name ^ "{") "}" #>
   174           index = SOME true ? enclose ("\\hypertarget" ^ hyper_name ^ "{") "}";
   175         val idx =
   176           (case index of
   177             NONE => ""
   178           | SOME is_def =>
   179               "\\index" ^ (if is_def then "def" else "ref") ^ arg logic ^ arg kind ^ arg name);
   180         val _ =
   181           if Context_Position.is_reported ctxt pos then ignore (check ctxt (name, pos)) else ();
   182       in
   183         idx ^
   184         (Output.output name
   185           |> (if markup = "" then I else enclose ("\\" ^ markup ^ "{") "}")
   186           |> hyper o enclose "\\mbox{\\isa{" "}}")
   187       end);
   188 
   189 fun entity_antiqs check markup kind =
   190   entity check markup kind NONE #>
   191   entity check markup kind (SOME true) #>
   192   entity check markup kind (SOME false);
   193 
   194 in
   195 
   196 val _ =
   197   Theory.setup
   198    (entity_antiqs no_check "" @{binding syntax} #>
   199     entity_antiqs Outer_Syntax.check_command "isacommand" @{binding command} #>
   200     entity_antiqs check_keyword "isakeyword" @{binding keyword} #>
   201     entity_antiqs check_keyword "isakeyword" @{binding element} #>
   202     entity_antiqs Method.check_name "" @{binding method} #>
   203     entity_antiqs Attrib.check_name "" @{binding attribute} #>
   204     entity_antiqs no_check "" @{binding fact} #>
   205     entity_antiqs no_check "" @{binding variable} #>
   206     entity_antiqs no_check "" @{binding case} #>
   207     entity_antiqs Thy_Output.check_command "" @{binding antiquotation} #>
   208     entity_antiqs Thy_Output.check_option "" @{binding antiquotation_option} #>
   209     entity_antiqs no_check "isasystem" @{binding setting} #>
   210     entity_antiqs check_system_option "isasystem" @{binding system_option} #>
   211     entity_antiqs no_check "" @{binding inference} #>
   212     entity_antiqs no_check "isasystem" @{binding executable} #>
   213     entity_antiqs no_check "isatool" @{binding tool} #>
   214     entity_antiqs ML_Context.check_antiquotation "" @{binding ML_antiquotation} #>
   215     entity_antiqs (K JEdit.check_action) "isasystem" @{binding action});
   216 
   217 end;
   218 
   219 end;