author | wenzelm |
Fri, 20 Jan 2023 19:52:52 +0100 | |
changeset 77028 | f5896dea6fce |
parent 77027 | ac7af931189f |
child 77029 | 1046a69fabaa |
permissions | -rw-r--r-- |
67274 | 1 |
(* Title: Pure/Thy/bibtex.ML |
58544
340f130b3d38
bibtex support in ML: document antiquotation @{cite} with markup;
wenzelm
parents:
diff
changeset
|
2 |
Author: Makarius |
340f130b3d38
bibtex support in ML: document antiquotation @{cite} with markup;
wenzelm
parents:
diff
changeset
|
3 |
|
340f130b3d38
bibtex support in ML: document antiquotation @{cite} with markup;
wenzelm
parents:
diff
changeset
|
4 |
BibTeX support. |
340f130b3d38
bibtex support in ML: document antiquotation @{cite} with markup;
wenzelm
parents:
diff
changeset
|
5 |
*) |
340f130b3d38
bibtex support in ML: document antiquotation @{cite} with markup;
wenzelm
parents:
diff
changeset
|
6 |
|
340f130b3d38
bibtex support in ML: document antiquotation @{cite} with markup;
wenzelm
parents:
diff
changeset
|
7 |
signature BIBTEX = |
340f130b3d38
bibtex support in ML: document antiquotation @{cite} with markup;
wenzelm
parents:
diff
changeset
|
8 |
sig |
67301 | 9 |
val check_database: |
10 |
Position.T -> string -> (string * Position.T) list * (string * Position.T) list |
|
67275
5e427586cb57
check bibtex database on ML side -- for semantic PIDE editing;
wenzelm
parents:
67274
diff
changeset
|
11 |
val check_database_output: Position.T -> string -> unit |
77028
f5896dea6fce
more direct check of bibtex entries via Isabelle/Scala;
wenzelm
parents:
77027
diff
changeset
|
12 |
val check_bibtex_entry: Proof.context -> string * Position.T -> unit |
58544
340f130b3d38
bibtex support in ML: document antiquotation @{cite} with markup;
wenzelm
parents:
diff
changeset
|
13 |
val cite_macro: string Config.T |
76959 | 14 |
val cite_antiquotation: binding -> (Proof.context -> string) -> theory -> theory |
58544
340f130b3d38
bibtex support in ML: document antiquotation @{cite} with markup;
wenzelm
parents:
diff
changeset
|
15 |
end; |
340f130b3d38
bibtex support in ML: document antiquotation @{cite} with markup;
wenzelm
parents:
diff
changeset
|
16 |
|
340f130b3d38
bibtex support in ML: document antiquotation @{cite} with markup;
wenzelm
parents:
diff
changeset
|
17 |
structure Bibtex: BIBTEX = |
340f130b3d38
bibtex support in ML: document antiquotation @{cite} with markup;
wenzelm
parents:
diff
changeset
|
18 |
struct |
340f130b3d38
bibtex support in ML: document antiquotation @{cite} with markup;
wenzelm
parents:
diff
changeset
|
19 |
|
67275
5e427586cb57
check bibtex database on ML side -- for semantic PIDE editing;
wenzelm
parents:
67274
diff
changeset
|
20 |
(* check database *) |
5e427586cb57
check bibtex database on ML side -- for semantic PIDE editing;
wenzelm
parents:
67274
diff
changeset
|
21 |
|
67301 | 22 |
type message = string * Position.T; |
67275
5e427586cb57
check bibtex database on ML side -- for semantic PIDE editing;
wenzelm
parents:
67274
diff
changeset
|
23 |
|
5e427586cb57
check bibtex database on ML side -- for semantic PIDE editing;
wenzelm
parents:
67274
diff
changeset
|
24 |
fun check_database pos0 database = |
72194 | 25 |
\<^scala>\<open>bibtex_check_database\<close> database |
67275
5e427586cb57
check bibtex database on ML side -- for semantic PIDE editing;
wenzelm
parents:
67274
diff
changeset
|
26 |
|> YXML.parse_body |
67301 | 27 |
|> let open XML.Decode in pair (list (pair string properties)) (list (pair string properties)) end |
28 |
|> (apply2 o map o apsnd) (fn pos => Position.of_properties (pos @ Position.get_props pos0)); |
|
67275
5e427586cb57
check bibtex database on ML side -- for semantic PIDE editing;
wenzelm
parents:
67274
diff
changeset
|
29 |
|
5e427586cb57
check bibtex database on ML side -- for semantic PIDE editing;
wenzelm
parents:
67274
diff
changeset
|
30 |
fun check_database_output pos0 database = |
67301 | 31 |
let val (errors, warnings) = check_database pos0 database in |
32 |
errors |> List.app (fn (msg, pos) => |
|
67275
5e427586cb57
check bibtex database on ML side -- for semantic PIDE editing;
wenzelm
parents:
67274
diff
changeset
|
33 |
Output.error_message ("Bibtex error" ^ Position.here pos ^ ":\n " ^ msg)); |
67301 | 34 |
warnings |> List.app (fn (msg, pos) => |
67275
5e427586cb57
check bibtex database on ML side -- for semantic PIDE editing;
wenzelm
parents:
67274
diff
changeset
|
35 |
warning ("Bibtex warning" ^ Position.here pos ^ ":\n " ^ msg)) |
5e427586cb57
check bibtex database on ML side -- for semantic PIDE editing;
wenzelm
parents:
67274
diff
changeset
|
36 |
end; |
5e427586cb57
check bibtex database on ML side -- for semantic PIDE editing;
wenzelm
parents:
67274
diff
changeset
|
37 |
|
5e427586cb57
check bibtex database on ML side -- for semantic PIDE editing;
wenzelm
parents:
67274
diff
changeset
|
38 |
|
77028
f5896dea6fce
more direct check of bibtex entries via Isabelle/Scala;
wenzelm
parents:
77027
diff
changeset
|
39 |
(* check bibtex entry *) |
f5896dea6fce
more direct check of bibtex entries via Isabelle/Scala;
wenzelm
parents:
77027
diff
changeset
|
40 |
|
f5896dea6fce
more direct check of bibtex entries via Isabelle/Scala;
wenzelm
parents:
77027
diff
changeset
|
41 |
fun check_bibtex_entry ctxt (name, pos) = |
f5896dea6fce
more direct check of bibtex entries via Isabelle/Scala;
wenzelm
parents:
77027
diff
changeset
|
42 |
let |
f5896dea6fce
more direct check of bibtex entries via Isabelle/Scala;
wenzelm
parents:
77027
diff
changeset
|
43 |
fun warn () = |
f5896dea6fce
more direct check of bibtex entries via Isabelle/Scala;
wenzelm
parents:
77027
diff
changeset
|
44 |
if Context_Position.is_visible ctxt then |
f5896dea6fce
more direct check of bibtex entries via Isabelle/Scala;
wenzelm
parents:
77027
diff
changeset
|
45 |
warning ("Unknown session context: cannot check Bibtex entry " ^ |
f5896dea6fce
more direct check of bibtex entries via Isabelle/Scala;
wenzelm
parents:
77027
diff
changeset
|
46 |
quote name ^ Position.here pos) |
f5896dea6fce
more direct check of bibtex entries via Isabelle/Scala;
wenzelm
parents:
77027
diff
changeset
|
47 |
else (); |
f5896dea6fce
more direct check of bibtex entries via Isabelle/Scala;
wenzelm
parents:
77027
diff
changeset
|
48 |
in |
f5896dea6fce
more direct check of bibtex entries via Isabelle/Scala;
wenzelm
parents:
77027
diff
changeset
|
49 |
if name = "*" then () |
f5896dea6fce
more direct check of bibtex entries via Isabelle/Scala;
wenzelm
parents:
77027
diff
changeset
|
50 |
else |
f5896dea6fce
more direct check of bibtex entries via Isabelle/Scala;
wenzelm
parents:
77027
diff
changeset
|
51 |
(case Position.id_of pos of |
f5896dea6fce
more direct check of bibtex entries via Isabelle/Scala;
wenzelm
parents:
77027
diff
changeset
|
52 |
NONE => warn () |
f5896dea6fce
more direct check of bibtex entries via Isabelle/Scala;
wenzelm
parents:
77027
diff
changeset
|
53 |
| SOME id => |
f5896dea6fce
more direct check of bibtex entries via Isabelle/Scala;
wenzelm
parents:
77027
diff
changeset
|
54 |
(case \<^scala>\<open>bibtex_session_entries\<close> [id] of |
f5896dea6fce
more direct check of bibtex entries via Isabelle/Scala;
wenzelm
parents:
77027
diff
changeset
|
55 |
[] => warn () |
f5896dea6fce
more direct check of bibtex entries via Isabelle/Scala;
wenzelm
parents:
77027
diff
changeset
|
56 |
| _ :: entries => |
f5896dea6fce
more direct check of bibtex entries via Isabelle/Scala;
wenzelm
parents:
77027
diff
changeset
|
57 |
Completion.check_entity Markup.bibtex_entryN (map (rpair Position.none) entries) |
f5896dea6fce
more direct check of bibtex entries via Isabelle/Scala;
wenzelm
parents:
77027
diff
changeset
|
58 |
ctxt (name, pos) |> ignore)) |
f5896dea6fce
more direct check of bibtex entries via Isabelle/Scala;
wenzelm
parents:
77027
diff
changeset
|
59 |
end; |
f5896dea6fce
more direct check of bibtex entries via Isabelle/Scala;
wenzelm
parents:
77027
diff
changeset
|
60 |
|
f5896dea6fce
more direct check of bibtex entries via Isabelle/Scala;
wenzelm
parents:
77027
diff
changeset
|
61 |
|
67275
5e427586cb57
check bibtex database on ML side -- for semantic PIDE editing;
wenzelm
parents:
67274
diff
changeset
|
62 |
(* document antiquotations *) |
5e427586cb57
check bibtex database on ML side -- for semantic PIDE editing;
wenzelm
parents:
67274
diff
changeset
|
63 |
|
76961
d756f4f78dc7
clarified default: final value is provided in Isabelle/Scala Latex.Cite.unapply;
wenzelm
parents:
76960
diff
changeset
|
64 |
val cite_macro = Attrib.setup_config_string \<^binding>\<open>cite_macro\<close> (K ""); |
76963 | 65 |
fun get_cite_macro ctxt = Config.get ctxt cite_macro; |
66 |
||
67 |
val _ = |
|
68 |
Theory.setup (Document_Antiquotation.setup_option \<^binding>\<open>cite_macro\<close> (Config.put cite_macro)); |
|
58544
340f130b3d38
bibtex support in ML: document antiquotation @{cite} with markup;
wenzelm
parents:
diff
changeset
|
69 |
|
76964
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
70 |
|
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
71 |
local |
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
72 |
|
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
73 |
val parse_citations = Parse.and_list1 Args.name_position; |
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
74 |
|
76986 | 75 |
fun cite_command ctxt get_kind ((opt_loc, citations), macro_name) = |
76964
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
76 |
let |
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
77 |
val loc = the_default Input.empty opt_loc; |
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
78 |
val _ = |
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
79 |
Context_Position.reports ctxt |
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
80 |
(Document_Output.document_reports loc @ |
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
81 |
map (fn (name, pos) => (pos, Markup.citation name)) citations); |
77028
f5896dea6fce
more direct check of bibtex entries via Isabelle/Scala;
wenzelm
parents:
77027
diff
changeset
|
82 |
val _ = List.app (check_bibtex_entry ctxt) citations; |
76959 | 83 |
|
76986 | 84 |
val kind = if macro_name = "" then get_kind ctxt else macro_name; |
76964
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
85 |
val location = Document_Output.output_document ctxt {markdown = false} loc; |
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
86 |
in Latex.cite {kind = kind, citations = citations, location = location} end; |
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
87 |
|
76985 | 88 |
fun cite_command_old ctxt get_kind args = |
89 |
let |
|
90 |
val _ = |
|
91 |
if Context_Position.is_visible ctxt then |
|
92 |
legacy_feature ("Old antiquotation syntax, better use \"isabelle update -u cite\"" ^ |
|
93 |
Position.here_list (map snd (snd args))) |
|
94 |
else (); |
|
76986 | 95 |
in cite_command ctxt get_kind (args, "") end; |
76985 | 96 |
|
77017 | 97 |
val cite_keywords = |
98 |
Thy_Header.bootstrap_keywords |
|
99 |
|> Keyword.add_keywords (map (fn a => ((a, Position.none), Keyword.no_spec)) ["in", "using"]); |
|
100 |
||
76964
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
101 |
fun cite_command_embedded ctxt get_kind input = |
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
102 |
let |
76986 | 103 |
val parser = |
104 |
Scan.option (Parse.embedded_input --| Parse.$$$ "in") -- parse_citations -- |
|
77017 | 105 |
Scan.optional (Parse.$$$ "using" |-- Parse.!!! Parse.name) ""; |
106 |
val args = Parse.read_embedded ctxt cite_keywords parser input; |
|
76964
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
107 |
in cite_command ctxt get_kind args end; |
76959 | 108 |
|
76964
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
109 |
fun cite_command_parser get_kind = |
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
110 |
Scan.option Args.cartouche_input -- parse_citations |
76985 | 111 |
>> (fn args => fn ctxt => cite_command_old ctxt get_kind args) || |
76964
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
112 |
Parse.embedded_input |
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
113 |
>> (fn arg => fn ctxt => cite_command_embedded ctxt get_kind arg); |
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
114 |
|
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
115 |
in |
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
116 |
|
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
117 |
fun cite_antiquotation binding get_kind = |
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
118 |
Document_Output.antiquotation_raw binding (Scan.lift (cite_command_parser get_kind)) |
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
119 |
(fn ctxt => fn cmd => cmd ctxt); |
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
120 |
|
c044306db39f
support embedded syntax, for use with control symbols;
wenzelm
parents:
76963
diff
changeset
|
121 |
end; |
76959 | 122 |
|
58544
340f130b3d38
bibtex support in ML: document antiquotation @{cite} with markup;
wenzelm
parents:
diff
changeset
|
123 |
val _ = |
340f130b3d38
bibtex support in ML: document antiquotation @{cite} with markup;
wenzelm
parents:
diff
changeset
|
124 |
Theory.setup |
76963 | 125 |
(cite_antiquotation \<^binding>\<open>cite\<close> get_cite_macro #> |
76960 | 126 |
cite_antiquotation \<^binding>\<open>nocite\<close> (K "nocite") #> |
127 |
cite_antiquotation \<^binding>\<open>citet\<close> (K "citet") #> |
|
128 |
cite_antiquotation \<^binding>\<open>citep\<close> (K "citep")); |
|
58544
340f130b3d38
bibtex support in ML: document antiquotation @{cite} with markup;
wenzelm
parents:
diff
changeset
|
129 |
|
340f130b3d38
bibtex support in ML: document antiquotation @{cite} with markup;
wenzelm
parents:
diff
changeset
|
130 |
end; |