58523
|
1 |
/* Title: Pure/Tools/bibtex.scala
|
|
2 |
Author: Makarius
|
|
3 |
|
|
4 |
Some support for bibtex files.
|
|
5 |
*/
|
|
6 |
|
|
7 |
package isabelle
|
|
8 |
|
|
9 |
|
|
10 |
import scala.util.parsing.input.{Reader, CharSequenceReader}
|
|
11 |
import scala.util.parsing.combinator.RegexParsers
|
|
12 |
|
|
13 |
|
|
14 |
object Bibtex
|
|
15 |
{
|
|
16 |
/** content **/
|
|
17 |
|
|
18 |
val months = List(
|
|
19 |
"jan",
|
|
20 |
"feb",
|
|
21 |
"mar",
|
|
22 |
"apr",
|
|
23 |
"may",
|
|
24 |
"jun",
|
|
25 |
"jul",
|
|
26 |
"aug",
|
|
27 |
"sep",
|
|
28 |
"oct",
|
|
29 |
"nov",
|
|
30 |
"dec")
|
|
31 |
|
|
32 |
val commands = List("preamble", "string")
|
|
33 |
|
|
34 |
sealed case class Entry_Type(
|
|
35 |
required: List[String],
|
|
36 |
optional_crossref: List[String],
|
|
37 |
optional: List[String])
|
|
38 |
|
|
39 |
val entries =
|
|
40 |
Map[String, Entry_Type](
|
|
41 |
"Article" ->
|
|
42 |
Entry_Type(
|
|
43 |
List("author", "title"),
|
|
44 |
List("journal", "year"),
|
|
45 |
List("volume", "number", "pages", "month", "note")),
|
|
46 |
"InProceedings" ->
|
|
47 |
Entry_Type(
|
|
48 |
List("author", "title"),
|
|
49 |
List("booktitle", "year"),
|
|
50 |
List("editor", "volume", "number", "series", "pages", "month", "address",
|
|
51 |
"organization", "publisher", "note")),
|
|
52 |
"InCollection" ->
|
|
53 |
Entry_Type(
|
|
54 |
List("author", "title", "booktitle"),
|
|
55 |
List("publisher", "year"),
|
|
56 |
List("editor", "volume", "number", "series", "type", "chapter", "pages",
|
|
57 |
"edition", "month", "address", "note")),
|
|
58 |
"InBook" ->
|
|
59 |
Entry_Type(
|
|
60 |
List("author", "editor", "title", "chapter"),
|
|
61 |
List("publisher", "year"),
|
|
62 |
List("volume", "number", "series", "type", "address", "edition", "month", "pages", "note")),
|
|
63 |
"Proceedings" ->
|
|
64 |
Entry_Type(
|
|
65 |
List("title", "year"),
|
|
66 |
List(),
|
|
67 |
List("booktitle", "editor", "volume", "number", "series", "address", "month",
|
|
68 |
"organization", "publisher", "note")),
|
|
69 |
"Book" ->
|
|
70 |
Entry_Type(
|
|
71 |
List("author", "editor", "title"),
|
|
72 |
List("publisher", "year"),
|
|
73 |
List("volume", "number", "series", "address", "edition", "month", "note")),
|
|
74 |
"Booklet" ->
|
|
75 |
Entry_Type(
|
|
76 |
List("title"),
|
|
77 |
List(),
|
|
78 |
List("author", "howpublished", "address", "month", "year", "note")),
|
|
79 |
"PhdThesis" ->
|
|
80 |
Entry_Type(
|
|
81 |
List("author", "title", "school", "year"),
|
|
82 |
List(),
|
|
83 |
List("type", "address", "month", "note")),
|
|
84 |
"MastersThesis" ->
|
|
85 |
Entry_Type(
|
|
86 |
List("author", "title", "school", "year"),
|
|
87 |
List(),
|
|
88 |
List("type", "address", "month", "note")),
|
|
89 |
"TechReport" ->
|
|
90 |
Entry_Type(
|
|
91 |
List("author", "title", "institution", "year"),
|
|
92 |
List(),
|
|
93 |
List("type", "number", "address", "month", "note")),
|
|
94 |
"Manual" ->
|
|
95 |
Entry_Type(
|
|
96 |
List("title"),
|
|
97 |
List(),
|
|
98 |
List("author", "organization", "address", "edition", "month", "year", "note")),
|
|
99 |
"Unpublished" ->
|
|
100 |
Entry_Type(
|
|
101 |
List("author", "title", "note"),
|
|
102 |
List(),
|
|
103 |
List("month", "year")),
|
|
104 |
"Misc" ->
|
|
105 |
Entry_Type(
|
|
106 |
List(),
|
|
107 |
List(),
|
|
108 |
List("author", "title", "howpublished", "month", "year", "note")))
|
|
109 |
|
|
110 |
|
|
111 |
|
|
112 |
/** tokens and chunks **/
|
|
113 |
|
|
114 |
object Token
|
|
115 |
{
|
|
116 |
object Kind extends Enumeration
|
|
117 |
{
|
|
118 |
val KEYWORD = Value("keyword")
|
|
119 |
val NAT = Value("natural number")
|
|
120 |
val IDENT = Value("identifier")
|
|
121 |
val STRING = Value("string")
|
|
122 |
val SPACE = Value("white space")
|
|
123 |
val ERROR = Value("bad input")
|
|
124 |
}
|
|
125 |
}
|
|
126 |
|
|
127 |
sealed case class Token(kind: Token.Kind.Value, val source: String)
|
|
128 |
{
|
|
129 |
def is_space: Boolean = kind == Token.Kind.SPACE
|
|
130 |
def is_error: Boolean = kind == Token.Kind.ERROR
|
|
131 |
}
|
|
132 |
|
|
133 |
abstract class Chunk
|
|
134 |
case class Ignored(source: String) extends Chunk
|
|
135 |
case class Malformed(source: String) extends Chunk
|
|
136 |
case class Item(tokens: List[Token]) extends Chunk
|
|
137 |
{
|
|
138 |
val name: String =
|
|
139 |
tokens match {
|
|
140 |
case Token(Token.Kind.KEYWORD, "@") :: body
|
|
141 |
if !body.isEmpty && !body.exists(_.is_error) =>
|
|
142 |
(body.filterNot(_.is_space), body.last) match {
|
|
143 |
case (Token(Token.Kind.IDENT, id) :: Token(Token.Kind.KEYWORD, "{") :: _,
|
|
144 |
Token(Token.Kind.KEYWORD, "}")) => id
|
|
145 |
case (Token(Token.Kind.IDENT, id) :: Token(Token.Kind.KEYWORD, "(") :: _,
|
|
146 |
Token(Token.Kind.KEYWORD, ")")) => id
|
|
147 |
case _ => ""
|
|
148 |
}
|
|
149 |
case _ => ""
|
|
150 |
}
|
|
151 |
val entry_name: String = if (commands.contains(name.toLowerCase)) "" else name
|
|
152 |
def is_wellformed: Boolean = name != ""
|
|
153 |
}
|
|
154 |
|
|
155 |
|
|
156 |
|
|
157 |
/** parsing **/
|
|
158 |
|
|
159 |
// context of partial line-oriented scans
|
|
160 |
abstract class Line_Context
|
|
161 |
case class Delimited(quoted: Boolean, depth: Int) extends Line_Context
|
|
162 |
val Finished = Delimited(false, 0)
|
|
163 |
|
|
164 |
private def token(kind: Token.Kind.Value)(source: String): Token = Token(kind, source)
|
|
165 |
private def keyword(source: String): Token = Token(Token.Kind.KEYWORD, source)
|
|
166 |
|
|
167 |
|
|
168 |
// See also http://ctan.org/tex-archive/biblio/bibtex/base/bibtex.web
|
|
169 |
// module @<Scan for and process a \.{.bib} command or database entry@>.
|
|
170 |
|
|
171 |
object Parsers extends RegexParsers
|
|
172 |
{
|
|
173 |
/* white space and comments */
|
|
174 |
|
|
175 |
override val whiteSpace = "".r
|
|
176 |
|
|
177 |
private val space = """[ \t\n\r]+""".r ^^ token(Token.Kind.SPACE)
|
|
178 |
private val spaces = rep(space)
|
|
179 |
|
|
180 |
private val ignored =
|
|
181 |
rep1("""(?mi)([^@]+|@[ \t\n\r]*comment)""".r) ^^ { case ss => Ignored(ss.mkString) }
|
|
182 |
|
|
183 |
|
|
184 |
/* delimited string: outermost "..." or {...} and body with balanced {...} */
|
|
185 |
|
|
186 |
private def delimited_depth(delim: Delimited): Parser[(String, Delimited)] =
|
|
187 |
new Parser[(String, Delimited)]
|
|
188 |
{
|
|
189 |
require(if (delim.quoted) delim.depth > 0 else delim.depth >= 0)
|
|
190 |
|
|
191 |
def apply(in: Input) =
|
|
192 |
{
|
|
193 |
val start = in.offset
|
|
194 |
val end = in.source.length
|
|
195 |
|
|
196 |
var i = start
|
|
197 |
var q = delim.quoted
|
|
198 |
var d = delim.depth
|
|
199 |
var finished = false
|
|
200 |
while (!finished && i < end) {
|
|
201 |
val c = in.source.charAt(i)
|
|
202 |
if (c == '"' && d == 0) { i += 1; d = 1; q = true }
|
|
203 |
else if (c == '"' && d == 1) { i += 1; d = 0; q = false; finished = true }
|
|
204 |
else if (c == '{') { i += 1; d += 1 }
|
|
205 |
else if (c == '}' && d > 0) { i += 1; d -= 1; if (d == 0) finished = true }
|
|
206 |
else if (d > 0) i += 1
|
|
207 |
else finished = true
|
|
208 |
}
|
|
209 |
if (i == start) Failure("bad input", in)
|
|
210 |
else
|
|
211 |
Success((in.source.subSequence(start, i).toString,
|
|
212 |
Delimited(q, d)), in.drop(i - start))
|
|
213 |
}
|
|
214 |
}.named("delimited_depth")
|
|
215 |
|
|
216 |
private def delimited: Parser[String] =
|
|
217 |
delimited_depth(Finished) ^? { case (x, delim) if delim == Finished => x }
|
|
218 |
|
|
219 |
private def delimited_line(ctxt: Line_Context): Parser[(String, Line_Context)] =
|
|
220 |
{
|
|
221 |
ctxt match {
|
|
222 |
case delim: Delimited => delimited_depth(delim)
|
|
223 |
case _ => failure("")
|
|
224 |
}
|
|
225 |
}
|
|
226 |
|
|
227 |
private val recover_delimited: Parser[String] =
|
|
228 |
delimited_depth(Finished) ^^ (_._1)
|
|
229 |
|
|
230 |
private val delimited_token =
|
|
231 |
delimited ^^ token(Token.Kind.STRING) |
|
|
232 |
recover_delimited ^^ token(Token.Kind.ERROR)
|
|
233 |
|
|
234 |
|
|
235 |
/* other tokens */
|
|
236 |
|
|
237 |
private val at = "@" ^^ keyword
|
|
238 |
private val left_brace = "{" ^^ keyword
|
|
239 |
private val right_brace = "}" ^^ keyword
|
|
240 |
private val left_paren = "(" ^^ keyword
|
|
241 |
private val right_paren = ")" ^^ keyword
|
|
242 |
|
|
243 |
private val nat = "[0-9]+".r ^^ token(Token.Kind.NAT)
|
|
244 |
|
|
245 |
private val ident =
|
|
246 |
"""[\x21-\x7f&&[^"#%'(),={}0-9]][\x21-\x7f&&[^"#%'(),={}]]*""".r ^^ token(Token.Kind.IDENT)
|
|
247 |
|
|
248 |
|
|
249 |
/* chunks */
|
|
250 |
|
|
251 |
private val item_start =
|
|
252 |
at ~ spaces ~ ident ~ spaces ^^
|
|
253 |
{ case a ~ b ~ c ~ d => List(a) ::: b ::: List(c) ::: d }
|
|
254 |
|
|
255 |
private val body_token = delimited_token | ("[=#,]".r ^^ keyword | (nat | (ident | space)))
|
|
256 |
|
|
257 |
private val item =
|
|
258 |
(item_start ~ left_brace ~ rep(body_token) ~ opt(right_brace) |
|
|
259 |
item_start ~ left_paren ~ rep(body_token) ~ opt(right_paren)) ^^
|
|
260 |
{ case a ~ b ~ c ~ d => Item(a ::: List(b) ::: c ::: d.toList) }
|
|
261 |
|
|
262 |
private val recover_item = "(?m)@[^@]+".r ^^ (s => Malformed(s))
|
|
263 |
|
|
264 |
val chunks: Parser[List[Chunk]] = rep(ignored | (item | recover_item))
|
|
265 |
}
|
|
266 |
|
|
267 |
def parse(input: CharSequence): List[Chunk] =
|
|
268 |
{
|
|
269 |
val in: Reader[Char] = new CharSequenceReader(input)
|
|
270 |
Parsers.parseAll(Parsers.chunks, in) match {
|
|
271 |
case Parsers.Success(result, _) => result
|
|
272 |
case _ => error("Unexpected failure of tokenizing input:\n" + input.toString)
|
|
273 |
}
|
|
274 |
}
|
|
275 |
}
|
|
276 |
|