58523
|
1 |
/* Title: Pure/Tools/bibtex.scala
|
|
2 |
Author: Makarius
|
|
3 |
|
|
4 |
Some support for bibtex files.
|
|
5 |
*/
|
|
6 |
|
|
7 |
package isabelle
|
|
8 |
|
|
9 |
|
58528
|
10 |
import scala.collection.mutable
|
58523
|
11 |
import scala.util.parsing.input.{Reader, CharSequenceReader}
|
|
12 |
import scala.util.parsing.combinator.RegexParsers
|
|
13 |
|
|
14 |
|
|
15 |
object Bibtex
|
|
16 |
{
|
|
17 |
/** content **/
|
|
18 |
|
58529
|
19 |
private val months = List(
|
58523
|
20 |
"jan",
|
|
21 |
"feb",
|
|
22 |
"mar",
|
|
23 |
"apr",
|
|
24 |
"may",
|
|
25 |
"jun",
|
|
26 |
"jul",
|
|
27 |
"aug",
|
|
28 |
"sep",
|
|
29 |
"oct",
|
|
30 |
"nov",
|
|
31 |
"dec")
|
58529
|
32 |
def is_month(s: String): Boolean = months.contains(s.toLowerCase)
|
58523
|
33 |
|
58529
|
34 |
private val commands = List("preamble", "string")
|
|
35 |
def is_command(s: String): Boolean = commands.contains(s.toLowerCase)
|
58523
|
36 |
|
58524
|
37 |
sealed case class Entry(
|
58526
|
38 |
kind: String,
|
58523
|
39 |
required: List[String],
|
|
40 |
optional_crossref: List[String],
|
58529
|
41 |
optional_other: List[String])
|
58524
|
42 |
{
|
58529
|
43 |
def is_required(s: String): Boolean = required.contains(s)
|
|
44 |
def is_optional(s: String): Boolean =
|
|
45 |
optional_crossref.contains(s) || optional_other.contains(s)
|
|
46 |
|
|
47 |
def fields: List[String] = required ::: optional_crossref ::: optional_other
|
58524
|
48 |
def template: String =
|
58526
|
49 |
"@" + kind + "{,\n" + fields.map(x => " " + x + " = {},\n").mkString + "}\n"
|
58524
|
50 |
}
|
58523
|
51 |
|
58524
|
52 |
val entries: List[Entry] =
|
|
53 |
List(
|
|
54 |
Entry("Article",
|
|
55 |
List("author", "title"),
|
|
56 |
List("journal", "year"),
|
|
57 |
List("volume", "number", "pages", "month", "note")),
|
|
58 |
Entry("InProceedings",
|
|
59 |
List("author", "title"),
|
|
60 |
List("booktitle", "year"),
|
|
61 |
List("editor", "volume", "number", "series", "pages", "month", "address",
|
|
62 |
"organization", "publisher", "note")),
|
|
63 |
Entry("InCollection",
|
|
64 |
List("author", "title", "booktitle"),
|
|
65 |
List("publisher", "year"),
|
|
66 |
List("editor", "volume", "number", "series", "type", "chapter", "pages",
|
|
67 |
"edition", "month", "address", "note")),
|
|
68 |
Entry("InBook",
|
|
69 |
List("author", "editor", "title", "chapter"),
|
|
70 |
List("publisher", "year"),
|
|
71 |
List("volume", "number", "series", "type", "address", "edition", "month", "pages", "note")),
|
|
72 |
Entry("Proceedings",
|
|
73 |
List("title", "year"),
|
|
74 |
List(),
|
|
75 |
List("booktitle", "editor", "volume", "number", "series", "address", "month",
|
|
76 |
"organization", "publisher", "note")),
|
|
77 |
Entry("Book",
|
|
78 |
List("author", "editor", "title"),
|
|
79 |
List("publisher", "year"),
|
|
80 |
List("volume", "number", "series", "address", "edition", "month", "note")),
|
|
81 |
Entry("Booklet",
|
|
82 |
List("title"),
|
|
83 |
List(),
|
|
84 |
List("author", "howpublished", "address", "month", "year", "note")),
|
|
85 |
Entry("PhdThesis",
|
|
86 |
List("author", "title", "school", "year"),
|
|
87 |
List(),
|
|
88 |
List("type", "address", "month", "note")),
|
|
89 |
Entry("MastersThesis",
|
|
90 |
List("author", "title", "school", "year"),
|
|
91 |
List(),
|
|
92 |
List("type", "address", "month", "note")),
|
|
93 |
Entry("TechReport",
|
|
94 |
List("author", "title", "institution", "year"),
|
|
95 |
List(),
|
|
96 |
List("type", "number", "address", "month", "note")),
|
|
97 |
Entry("Manual",
|
|
98 |
List("title"),
|
|
99 |
List(),
|
|
100 |
List("author", "organization", "address", "edition", "month", "year", "note")),
|
|
101 |
Entry("Unpublished",
|
|
102 |
List("author", "title", "note"),
|
|
103 |
List(),
|
|
104 |
List("month", "year")),
|
|
105 |
Entry("Misc",
|
|
106 |
List(),
|
|
107 |
List(),
|
|
108 |
List("author", "title", "howpublished", "month", "year", "note")))
|
58523
|
109 |
|
58529
|
110 |
def get_entry(kind: String): Option[Entry] =
|
|
111 |
entries.find(entry => entry.kind.toLowerCase == kind.toLowerCase)
|
|
112 |
|
58523
|
113 |
|
|
114 |
|
|
115 |
/** tokens and chunks **/
|
|
116 |
|
|
117 |
object Token
|
|
118 |
{
|
|
119 |
object Kind extends Enumeration
|
|
120 |
{
|
58529
|
121 |
val COMMAND = Value("command")
|
|
122 |
val ENTRY = Value("entry")
|
58523
|
123 |
val KEYWORD = Value("keyword")
|
|
124 |
val NAT = Value("natural number")
|
58529
|
125 |
val STRING = Value("string")
|
58523
|
126 |
val IDENT = Value("identifier")
|
58529
|
127 |
val IGNORED = Value("ignored")
|
58523
|
128 |
val ERROR = Value("bad input")
|
|
129 |
}
|
|
130 |
}
|
|
131 |
|
|
132 |
sealed case class Token(kind: Token.Kind.Value, val source: String)
|
|
133 |
{
|
58529
|
134 |
def is_ignored: Boolean = kind == Token.Kind.IGNORED
|
58523
|
135 |
def is_error: Boolean = kind == Token.Kind.ERROR
|
|
136 |
}
|
|
137 |
|
58528
|
138 |
abstract class Chunk
|
|
139 |
{
|
|
140 |
def kind: String
|
58529
|
141 |
def tokens: List[Token]
|
|
142 |
def source: String
|
58528
|
143 |
}
|
|
144 |
|
|
145 |
case class Ignored(source: String) extends Chunk
|
|
146 |
{
|
|
147 |
def kind: String = ""
|
58529
|
148 |
val tokens = List(Token(Token.Kind.IGNORED, source))
|
58528
|
149 |
}
|
|
150 |
|
|
151 |
case class Item(kind: String, tokens: List[Token]) extends Chunk
|
58523
|
152 |
{
|
58529
|
153 |
val source = tokens.map(_.source).mkString
|
58526
|
154 |
|
58528
|
155 |
private val wellformed_content: Option[List[Token]] =
|
58523
|
156 |
tokens match {
|
|
157 |
case Token(Token.Kind.KEYWORD, "@") :: body
|
|
158 |
if !body.isEmpty && !body.exists(_.is_error) =>
|
58529
|
159 |
(body.init.filterNot(_.is_ignored), body.last) match {
|
58528
|
160 |
case (Token(Token.Kind.IDENT, _) :: Token(Token.Kind.KEYWORD, "{") :: toks,
|
|
161 |
Token(Token.Kind.KEYWORD, "}")) => Some(toks)
|
|
162 |
case (Token(Token.Kind.IDENT, _) :: Token(Token.Kind.KEYWORD, "(") :: toks,
|
|
163 |
Token(Token.Kind.KEYWORD, ")")) => Some(toks)
|
|
164 |
case _ => None
|
58523
|
165 |
}
|
58528
|
166 |
case _ => None
|
58526
|
167 |
}
|
58528
|
168 |
def is_wellformed: Boolean = kind != "" && wellformed_content.isDefined
|
|
169 |
def content_tokens: List[Token] = wellformed_content getOrElse Nil
|
58526
|
170 |
|
|
171 |
def name: String =
|
|
172 |
content_tokens match {
|
58528
|
173 |
case Token(Token.Kind.IDENT, id) :: _ if is_wellformed => id
|
58523
|
174 |
case _ => ""
|
|
175 |
}
|
|
176 |
}
|
|
177 |
|
|
178 |
|
|
179 |
|
|
180 |
/** parsing **/
|
|
181 |
|
|
182 |
// context of partial line-oriented scans
|
|
183 |
abstract class Line_Context
|
58528
|
184 |
case object Ignored_Context extends Line_Context
|
|
185 |
case class Item_Context(kind: String, delim: Delimited, right: String) extends Line_Context
|
|
186 |
case class Delimited(quoted: Boolean, depth: Int)
|
|
187 |
val Closed = Delimited(false, 0)
|
58523
|
188 |
|
|
189 |
private def token(kind: Token.Kind.Value)(source: String): Token = Token(kind, source)
|
|
190 |
private def keyword(source: String): Token = Token(Token.Kind.KEYWORD, source)
|
|
191 |
|
|
192 |
|
|
193 |
// See also http://ctan.org/tex-archive/biblio/bibtex/base/bibtex.web
|
|
194 |
// module @<Scan for and process a \.{.bib} command or database entry@>.
|
|
195 |
|
|
196 |
object Parsers extends RegexParsers
|
|
197 |
{
|
|
198 |
/* white space and comments */
|
|
199 |
|
|
200 |
override val whiteSpace = "".r
|
|
201 |
|
58529
|
202 |
private val space = """[ \t\n\r]+""".r ^^ token(Token.Kind.IGNORED)
|
|
203 |
private val strict_space = """[ \t]+""".r ^^ token(Token.Kind.IGNORED)
|
58523
|
204 |
|
58528
|
205 |
|
|
206 |
/* ignored material outside items */
|
|
207 |
|
|
208 |
private val ignored: Parser[Chunk] =
|
|
209 |
rep1("""(?mi)([^@]+|@[ \t]*comment)""".r) ^^ { case ss => Ignored(ss.mkString) }
|
|
210 |
|
|
211 |
private def ignored_line(ctxt: Line_Context): Parser[(Chunk, Line_Context)] =
|
|
212 |
ctxt match {
|
|
213 |
case Ignored_Context => ignored ^^ { case a => (a, ctxt) }
|
|
214 |
case _ => failure("")
|
|
215 |
}
|
58523
|
216 |
|
|
217 |
|
|
218 |
/* delimited string: outermost "..." or {...} and body with balanced {...} */
|
|
219 |
|
|
220 |
private def delimited_depth(delim: Delimited): Parser[(String, Delimited)] =
|
|
221 |
new Parser[(String, Delimited)]
|
|
222 |
{
|
|
223 |
require(if (delim.quoted) delim.depth > 0 else delim.depth >= 0)
|
|
224 |
|
|
225 |
def apply(in: Input) =
|
|
226 |
{
|
|
227 |
val start = in.offset
|
|
228 |
val end = in.source.length
|
|
229 |
|
|
230 |
var i = start
|
|
231 |
var q = delim.quoted
|
|
232 |
var d = delim.depth
|
|
233 |
var finished = false
|
|
234 |
while (!finished && i < end) {
|
|
235 |
val c = in.source.charAt(i)
|
|
236 |
if (c == '"' && d == 0) { i += 1; d = 1; q = true }
|
|
237 |
else if (c == '"' && d == 1) { i += 1; d = 0; q = false; finished = true }
|
|
238 |
else if (c == '{') { i += 1; d += 1 }
|
|
239 |
else if (c == '}' && d > 0) { i += 1; d -= 1; if (d == 0) finished = true }
|
|
240 |
else if (d > 0) i += 1
|
|
241 |
else finished = true
|
|
242 |
}
|
|
243 |
if (i == start) Failure("bad input", in)
|
58528
|
244 |
else {
|
|
245 |
val s = in.source.subSequence(start, i).toString
|
|
246 |
Success((s, Delimited(q, d)), in.drop(i - start))
|
|
247 |
}
|
58523
|
248 |
}
|
|
249 |
}.named("delimited_depth")
|
|
250 |
|
58528
|
251 |
private def delimited: Parser[Token] =
|
|
252 |
delimited_depth(Closed) ^?
|
|
253 |
{ case (s, delim) if delim == Closed => Token(Token.Kind.STRING, s) }
|
58523
|
254 |
|
58528
|
255 |
private def delimited_line(ctxt: Line_Context): Parser[(Item, Line_Context)] =
|
58523
|
256 |
{
|
|
257 |
ctxt match {
|
58528
|
258 |
case Item_Context(kind, delim, right) =>
|
|
259 |
delimited_depth(delim) ^^ { case (s, delim1) =>
|
|
260 |
(Item(kind, List(Token(Token.Kind.STRING, s))), Item_Context(kind, delim1, right)) }
|
58523
|
261 |
case _ => failure("")
|
|
262 |
}
|
|
263 |
}
|
|
264 |
|
58528
|
265 |
private def recover_delimited: Parser[Token] =
|
|
266 |
"""(?m)["{][^@]+""".r ^^ token(Token.Kind.ERROR)
|
58523
|
267 |
|
|
268 |
|
|
269 |
/* other tokens */
|
|
270 |
|
|
271 |
private val at = "@" ^^ keyword
|
|
272 |
private val left_brace = "{" ^^ keyword
|
|
273 |
private val right_brace = "}" ^^ keyword
|
|
274 |
private val left_paren = "(" ^^ keyword
|
|
275 |
private val right_paren = ")" ^^ keyword
|
|
276 |
|
|
277 |
private val nat = "[0-9]+".r ^^ token(Token.Kind.NAT)
|
|
278 |
|
58529
|
279 |
private val identifier =
|
|
280 |
"""[\x21-\x7f&&[^"#%'(),={}0-9]][\x21-\x7f&&[^"#%'(),={}]]*""".r
|
|
281 |
|
|
282 |
private val ident = identifier ^^ token(Token.Kind.IDENT)
|
58523
|
283 |
|
58528
|
284 |
val other_token = "[=#,]".r ^^ keyword | (nat | (ident | space))
|
|
285 |
|
|
286 |
|
|
287 |
/* items */
|
|
288 |
|
58529
|
289 |
private val special_ident =
|
|
290 |
identifier ^^ { case a =>
|
|
291 |
val kind =
|
|
292 |
if (is_command(a)) Token.Kind.COMMAND
|
|
293 |
else if (get_entry(a).isDefined) Token.Kind.ENTRY
|
|
294 |
else Token.Kind.IDENT
|
|
295 |
Token(kind, a)
|
|
296 |
}
|
|
297 |
|
58528
|
298 |
private val item_start: Parser[(String, List[Token])] =
|
58529
|
299 |
at ~ rep(strict_space) ~ special_ident ~ rep(strict_space) ^^
|
58528
|
300 |
{ case a ~ b ~ c ~ d => (c.source, List(a) ::: b ::: List(c) ::: d) }
|
|
301 |
|
|
302 |
private val item_body =
|
|
303 |
delimited | (recover_delimited | other_token)
|
|
304 |
|
|
305 |
private val item: Parser[Item] =
|
|
306 |
(item_start ~ left_brace ~ rep(item_body) ~ opt(right_brace) |
|
|
307 |
item_start ~ left_paren ~ rep(item_body) ~ opt(right_paren)) ^^
|
|
308 |
{ case (kind, a) ~ b ~ c ~ d => Item(kind, a ::: List(b) ::: c ::: d.toList) }
|
|
309 |
|
|
310 |
private val recover_item: Parser[Item] =
|
58529
|
311 |
at ~ "(?m)[^@]*".r ^^ { case a ~ b => Item("", List(a, Token(Token.Kind.ERROR, b))) }
|
58528
|
312 |
|
|
313 |
def item_line(ctxt: Line_Context): Parser[(Item, Line_Context)] =
|
|
314 |
{
|
|
315 |
ctxt match {
|
|
316 |
case Ignored_Context =>
|
|
317 |
item_start ~ (left_brace | left_paren) ^^
|
|
318 |
{ case (kind, a) ~ b =>
|
|
319 |
val right = if (b.source == "{") "}" else ")"
|
58529
|
320 |
(Item(kind, a ::: List(b)), Item_Context(kind, Closed, right)) } |
|
|
321 |
recover_item ^^ { case a => (a, Ignored_Context) }
|
58528
|
322 |
case Item_Context(kind, delim, right) =>
|
|
323 |
if (delim.depth > 0)
|
|
324 |
delimited_line(ctxt)
|
|
325 |
else {
|
|
326 |
delimited_line(ctxt) |
|
|
327 |
other_token ^^ { case a => (Item(kind, List(a)), ctxt) } |
|
|
328 |
right ^^ { case a => (Item(kind, List(keyword(a))), Ignored_Context) }
|
|
329 |
}
|
|
330 |
case _ => failure("")
|
|
331 |
}
|
|
332 |
}
|
|
333 |
|
58523
|
334 |
|
|
335 |
/* chunks */
|
|
336 |
|
58528
|
337 |
val chunk: Parser[Chunk] = ignored | (item | recover_item)
|
58523
|
338 |
|
58528
|
339 |
def chunk_line(ctxt: Line_Context): Parser[(Chunk, Line_Context)] =
|
|
340 |
ignored_line(ctxt) | item_line(ctxt)
|
|
341 |
}
|
58523
|
342 |
|
|
343 |
|
58528
|
344 |
/* parse */
|
58523
|
345 |
|
|
346 |
def parse(input: CharSequence): List[Chunk] =
|
|
347 |
{
|
|
348 |
val in: Reader[Char] = new CharSequenceReader(input)
|
58528
|
349 |
Parsers.parseAll(Parsers.rep(Parsers.chunk), in) match {
|
58523
|
350 |
case Parsers.Success(result, _) => result
|
58526
|
351 |
case _ => error("Unexpected failure to parse input:\n" + input.toString)
|
58523
|
352 |
}
|
|
353 |
}
|
58528
|
354 |
|
|
355 |
def parse_line(input: CharSequence, context: Line_Context): (List[Chunk], Line_Context) =
|
|
356 |
{
|
|
357 |
var in: Reader[Char] = new CharSequenceReader(input)
|
|
358 |
val chunks = new mutable.ListBuffer[Chunk]
|
|
359 |
var ctxt = context
|
|
360 |
while (!in.atEnd) {
|
|
361 |
Parsers.parse(Parsers.chunk_line(ctxt), in) match {
|
|
362 |
case Parsers.Success((x, c), rest) => { chunks += x; ctxt = c; in = rest }
|
|
363 |
case Parsers.NoSuccess(_, rest) =>
|
|
364 |
error("Unepected failure to parse input:\n" + rest.source.toString)
|
|
365 |
}
|
|
366 |
}
|
|
367 |
(chunks.toList, ctxt)
|
|
368 |
}
|
58523
|
369 |
}
|
|
370 |
|