-
Notifications
You must be signed in to change notification settings - Fork 3
/
index.ts
1708 lines (1438 loc) · 53 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import * as bibtex from './grammar'
import { parse as chunker } from './chunker'
import { latex as latex2unicode, diacritics } from 'unicode2latex'
type Markup = { kind: 'Markup', value: string, loc?: any, source: string }
type Node =
| bibtex.Bibliography
| bibtex.Block
| bibtex.RegularCommand
| bibtex.DiacriticCommand
| bibtex.Entry
| bibtex.Field
| bibtex.NumberValue
| bibtex.StringDeclaration
| bibtex.StringReference
| bibtex.SubscriptCommand
| bibtex.SuperscriptCommand
| bibtex.SymbolCommand
| bibtex.TextValue
| bibtex.PreambleExpression
| bibtex.BracedComment
| bibtex.LineComment
| Markup
class ParserError extends Error {
public node: any
constructor(message?: string, node?: any) {
super(message) // 'Error' breaks prototype chain here
Object.setPrototypeOf(this, new.target.prototype) // restore prototype chain
this.name = this.constructor.name
this.node = node
}
}
class TeXError extends Error {
public node: any
public text: string
constructor(message: string, node: any, text: string) {
super(message) // 'Error' breaks prototype chain here
Object.setPrototypeOf(this, new.target.prototype) // restore prototype chain
this.name = this.constructor.name
this.node = node
this.text = text
}
}
import charCategories = require('xregexp/tools/output/categories')
const charClass = {
Lu: charCategories.filter(cat => ['Uppercase_Letter', 'Titlecase_Letter'].includes(cat.alias)).map(cat => cat.bmp).join(''),
Ll: charCategories.find(cat => cat.alias === 'Lowercase_Letter').bmp,
LnotLu: charCategories.filter(cat => ['Lowercase_Letter', 'Modifier_Letter', 'Other_Letter', 'Nonspacing_Mark', 'Spacing_Mark', 'Decimal_Number', 'Letter_Number'].includes(cat.alias)).map(cat => cat.bmp).join(''),
P: charCategories.find(cat => cat.alias === 'Punctuation').bmp,
L: charCategories.find(cat => cat.alias === 'Letter').bmp,
N: charCategories.filter(cat => ['Decimal_Number', 'Letter_Number'].includes(cat.alias)).map(cat => cat.bmp).join(''),
AlphaNum: charCategories.filter(cat => ['Letter', 'Decimal_Number', 'Letter_Number'].includes(cat.alias)).map(cat => cat.bmp).join(''),
LC: charCategories.find(cat => cat.alias === 'Cased_Letter').bmp,
}
const marker = {
and: '\u0001',
comma: '\u0002',
space: '\u0003',
literal: '\u0004',
markup: '\u0005',
re: {
and: /./,
comma: /./,
space: /./,
literal: /./,
literalName: /./,
},
}
marker.re = {
and: new RegExp(marker.and, 'g'),
comma: new RegExp(marker.comma, 'g'),
space: new RegExp(marker.space, 'g'),
literal: new RegExp(marker.literal, 'g'),
literalName: new RegExp(`^${marker.literal}[^${marker.literal}]*${marker.literal}$`),
}
const preserveCase = {
leadingCap: new RegExp(`^[${charClass.Lu}][${charClass.LnotLu}]+[${charClass.P}]?$`),
allCaps: new RegExp(`^[${charClass.Lu}${charClass.N}]{2,}$`),
allLower: new RegExp(`^[${charClass.Ll}${charClass.N}]{2,}$`),
joined: new RegExp(`^[${charClass.Lu}][${charClass.LnotLu}]*([-+][${charClass.L}${charClass.N}]+)*[${charClass.P}]*$`),
hasUppercase: new RegExp(`[${charClass.Lu}]`),
isNumber: /^[0-9]+$/,
hasAlpha: new RegExp(`[${charClass.L}]`),
hasAlphaNum: new RegExp(`[${charClass.AlphaNum}]`),
notAlphaNum: new RegExp(`[^${charClass.AlphaNum}]`, 'g'),
sentenceStart: new RegExp(`(^|([\u2014:?!.]\\s+))[${charClass.Lu}]`, 'g'),
markup: /<\/?span[^>]*>/g,
acronym: new RegExp(`.*\\.${marker.markup}*[${charClass.Lu}]${marker.markup}*\\.$`),
nonCased: new RegExp(`[^${charClass.LC}]`),
hasCased: new RegExp(`[${charClass.LC}]`),
quoted: /("[^"]+")|(“[^“]+“)/g,
}
export interface Name {
/**
* If the name is a literal (surrounded by braces) it will be in this property, and none of the other properties will be set
*/
literal?: string
/**
* Family name
*/
lastName?: string
/**
* available when parsing biblatex extended name format
*/
useprefix?: boolean
/**
* available when parsing biblatex extended name format
*/
juniorcomma?: boolean
/**
* given name. Will include middle names and initials.
*/
firstName?: string
/**
* Initials.
*/
initial?: string
/**
* things like `Jr.`, `III`, etc
*/
suffix?: string
/**
* things like `von`, `van der`, etc
*/
prefix?: string
}
export interface Entry {
/**
* citation key
*/
key: string,
/**
* entry type
*/
type: string
/**
* entry fields. The keys are always in lowercase
*/
fields: { [key: string]: string[] }
/**
* authors, editors, by creator type. Name order within the creator-type is retained.
*/
creators: { [type: string]: Name[] }
/**
* will be set to `true` if sentence casing was applied to the entry
*/
sentenceCased?: boolean
}
type FieldBuilder = {
name: string
text: string
level: number
preserveRanges: { start: number, end: number, reason?: string }[]
html?: boolean
words: {
upper: number
lower: number
other: number
}
}
/**
* Markup mapping. As the bibtex file is parsed, markup will be transformed according to this table
*/
export interface MarkupMapping {
sub?: { open: string, close: string }
sup?: { open: string, close: string }
bold?: { open: string, close: string }
italics?: { open: string, close: string }
smallCaps?: { open: string, close: string }
caseProtect?: { open: string, close: string }
enquote?: { open: string, close: string }
h1?: { open: string, close: string }
h2?: { open: string, close: string }
roman?: { open: string, close: string }
fixedWidth?: { open: string, close: string }
}
export interface Bibliography {
/**
* errors found while parsing
*/
errors: ParseError[]
/**
* entries in the order in which they are found, omitting those which could not be parsed.
*/
entries: Entry[]
/**
* `@comment`s found in the bibtex file. See also [[jabref.parse]]
*/
comments: string[]
/**
* `@string`s found in the bibtex file.
*/
strings: { [key: string]: string }
/**
* `@preamble` declarations found in the bibtex file
*/
preamble: string[]
}
export interface ParseError {
/**
* error message
*/
message: string
/**
* text block that was parsed where the error was found
*/
source?: string
/**
* Error line number within the bibtex file
*/
line?: number
/**
* Error column number within the bibtex file
*/
column?: number
}
const fields = {
creator: [
'author',
'bookauthor',
'collaborator',
'commentator',
'director',
'editor',
'editora',
'editorb',
'editors',
'holder',
'scriptwriter',
'translator',
],
title: [
'title',
'series',
'shorttitle',
'booktitle',
'type',
'origtitle',
'maintitle',
'eventtitle',
],
unnest: [
'publisher',
'location',
],
verbatim: [
'url',
'doi',
'file',
'files',
'eprint',
'verba',
'verbb',
'verbc',
],
html: [
'annotation',
'comment',
'annote',
'review',
'notes',
'note',
],
unabbrev: [
'journal',
'journaltitle',
'journal-full',
],
}
export interface ParserOptions {
/**
* BibTeX files are expected to store title-type fields in Sentence Case, where other reference managers (such as Zotero) expect them to be stored as Sentence case. When there is no language field, or the language field
* is one of the languages (case insensitive) passed in this option, the parser will attempt to sentence-case title-type fields as they are being parsed. This uses heuristics and does not employ any kind of natural
* language processing, so you should always inspect the results. Default languages to sentenceCase are:
*
* - american
* - british
* - canadian
* - english
* - australian
* - newzealand
* - usenglish
* - ukenglish
* - en
* - eng
* - en-au
* - en-bz
* - en-ca
* - en-cb
* - en-gb
* - en-ie
* - en-jm
* - en-nz
* - en-ph
* - en-tt
* - en-us
* - en-za
* - en-zw
*
* If you pass an empty array, or `false`, no sentence casing will be applied (even when there's no language field).
*/
sentenceCase?: string[] | boolean
/**
* Some bibtex has titles in sentence case, or all-uppercase. If this is on, and there is a field that would normally have sentence-casing applied in which more words are all-`X`case
* (where `X` is either lower or upper) than mixed-case, it is assumed that you want them this way, and no sentence-casing will be applied to that field
*/
guessAlreadySentenceCased?: boolean
/**
* translate braced parts of text into a case-protected counterpart; uses the [[MarkupMapping]] table in `markup`. Default == true == as-needed.
* In as-needed mode the parser will assume that words that have capitals in them imply "nocase" behavior in the consuming application. If you don't want this, turn this option on, and you'll get
* case protection exactly as the input has it
*/
caseProtection?: 'as-needed' | 'strict' | boolean
/**
* The parser can change TeX markup (\textsc, \emph, etc) to a text equivalent. The defaults are HTML-oriented, but you can pass in your own configuration here
*/
markup?: MarkupMapping
/**
* return a promise for a [[Bibliography]] when set to true
*/
async?: boolean
/**
* By default, when an unexpected parsing error is found (such as a TeX command which I did not anticipate), the parser will throw an error. You can pass a function to handle the error instead,
* where you can log it, display it, or even still throw an error
*/
errorHandler?: false | ((message: string) => void)
/**
* Some fields such as `url` are parsed in what is called "verbatim mode" where pretty much everything except braces is treated as regular text, not TeX commands. You can change the default list here if you want,
* for example to help parse Mendeley `file` fields, which against spec are not in verbatim mode.
*/
verbatimFields?: (string | RegExp)[]
/**
* Some commands such as `url` are parsed in what is called "verbatim mode" where pretty much everything except braces is treated as regular text, not TeX commands.
*/
verbatimCommands?: string[]
/**
* In the past many bibtex entries would just always wrap a field in double braces ({{ title here }}), likely because whomever was writing them couldn't figure out the case meddling rules (and who could
* blame them. Fields listed here will either have one outer layer of braces treated as case-preserve, or have the outer braced be ignored completely, if this is detected.
*/
unnestFields?: string[]
unnestMode?: 'preserve' | 'unwrap'
/**
* Some note-like fields may have more rich formatting. If listed here, more HTML conversions will be applied.
*/
htmlFields?: string[]
/**
* If this flag is set entries will be returned without conversion of LaTeX to unicode equivalents.
*/
raw?: boolean
/**
* You can pass in an existing @string dictionary
*/
strings?: Record<string, string>
/**
* BibTeX files may have abbreviations in the journal field. If you provide a dictionary, journal names that are found in the dictionary are replaced with the attached full name
*/
unabbreviate?: Record<string, { ast: any, text: string }>
}
const english = [
'american',
'british',
'canadian',
'english',
'australian',
'newzealand',
'usenglish',
'ukenglish',
'en',
'eng',
'en-au',
'en-bz',
'en-ca',
'en-cb',
'en-gb',
'en-ie',
'en-jm',
'en-nz',
'en-ph',
'en-tt',
'en-us',
'en-za',
'en-zw',
'anglais', // don't do this people
]
class Parser {
private errors: ParseError[]
private strings: Record<string, bibtex.ValueType[]>
private unresolvedStrings: Record<string, boolean>
private default_strings: Record<string, bibtex.TextValue[]>
private comments: string[]
private entries: Entry[]
private entry: Entry
private cleaning: {
type: 'title' | 'creator' | 'other'
name?: string
}
private field: FieldBuilder
private chunk: string
private options: ParserOptions
private preamble: string[] = []
public log: (string) => void = function(str) {} // tslint:disable-line variable-name only-arrow-functions no-empty
constructor(options: ParserOptions = {}) {
for (const [option, value] of Object.entries(options)) {
if (typeof value === 'undefined') delete options[option]
}
if (options.errorHandler === false) {
// tslint:disable-next-line only-arrow-functions no-empty
options.errorHandler = function(err) {}
} else if (options.errorHandler === undefined) {
// tslint:disable-next-line only-arrow-functions
options.errorHandler = function(err) { throw err }
}
if (typeof options.sentenceCase === 'boolean') {
options.sentenceCase = options.sentenceCase ? english : []
} else {
options.sentenceCase = options.sentenceCase || english
}
if (!options.strings) options.strings = {}
if (!options.unabbreviate) options.unabbreviate = {}
if (options.raw) {
options.sentenceCase = false
options.caseProtection = false
}
this.options = {
caseProtection: 'as-needed',
verbatimFields: [ /^citeulike-linkout-[0-9]+$/, ...fields.verbatim],
verbatimCommands: [ 'url', 'href' ],
unnestFields: [ ...fields.title, ...fields.unnest, ...fields.verbatim],
unnestMode: 'unwrap',
htmlFields: fields.html,
guessAlreadySentenceCased: true,
markup: {},
...options,
}
const markup_defaults = {
enquote: { open: '\u201c', close: '\u201d' },
sub: { open: '<sub>', close: '</sub>' },
sup: { open: '<sup>', close: '</sup>' },
bold: { open: '<b>', close: '</b>' },
italics: { open: '<i>', close: '</i>' },
smallCaps: { open: '<span style="font-variant:small-caps;">', close: '</span>' },
caseProtect: { open: '<span class="nocase">', close: '</span>' },
roman: { open: '', close: '' },
fixedWidth: { open: '', close: '' },
h1: { open: '<h1>', close: '</h1>' },
h2: { open: '<h2>', close: '</h2>' },
}
// patch in because the options will likely not have enquote and case-protect
for (const [markup, {open, close}] of Object.entries(markup_defaults)) {
this.options.markup[markup] = this.options.markup[markup] || { open, close }
}
this.unresolvedStrings = {}
this.errors = []
this.comments = []
this.entries = []
this.strings = { }
this.default_strings = {
JAN: [ this.text('01') ],
FEB: [ this.text('02') ],
MAR: [ this.text('03') ],
APR: [ this.text('04') ],
MAY: [ this.text('05') ],
JUN: [ this.text('06') ],
JUL: [ this.text('07') ],
AUG: [ this.text('08') ],
SEP: [ this.text('09') ],
OCT: [ this.text('10') ],
NOV: [ this.text('11') ],
DEC: [ this.text('12') ],
ACMCS: [ this.text('ACM Computing Surveys') ],
ACTA: [ this.text('Acta Informatica') ],
CACM: [ this.text('Communications of the ACM') ],
IBMJRD: [ this.text('IBM Journal of Research and Development') ],
IBMSJ: [ this.text('IBM Systems Journal') ],
IEEESE: [ this.text('IEEE Transactions on Software Engineering') ],
IEEETC: [ this.text('IEEE Transactions on Computers') ],
IEEETCAD: [ this.text('IEEE Transactions on Computer-Aided Design of Integrated Circuits') ],
IPL: [ this.text('Information Processing Letters') ],
JACM: [ this.text('Journal of the ACM') ],
JCSS: [ this.text('Journal of Computer and System Sciences') ],
SCP: [ this.text('Science of Computer Programming') ],
SICOMP: [ this.text('SIAM Journal on Computing') ],
TOCS: [ this.text('ACM Transactions on Computer Systems') ],
TODS: [ this.text('ACM Transactions on Database Systems') ],
TOG: [ this.text('ACM Transactions on Graphics') ],
TOMS: [ this.text('ACM Transactions on Mathematical Software') ],
TOOIS: [ this.text('ACM Transactions on Office Information Systems') ],
TOPLAS: [ this.text('ACM Transactions on Programming Languages and Systems') ],
TCS: [ this.text('Theoretical Computer Science') ],
}
}
public ast(input, clean = true) {
const _ast = []
for (const chunk of chunker(input)) {
let chunk_ast = bibtex.parse(chunk.text, {...this.options, combiningDiacritics: diacritics.commands})
if (clean) chunk_ast = this.clean(chunk_ast)
_ast.push(chunk_ast)
}
return _ast
}
public parse(input: string): Bibliography | Promise<Bibliography> {
return this.options.async ? this.parseAsync(input) : this.parseSync(input)
}
private parseSync(input): Bibliography {
for (const chunk of chunker(input)) {
this.parseChunk(chunk)
}
return this.parsed()
}
private async parseAsync(input): Promise<Bibliography> {
for (const chunk of await chunker(input, { async: true })) {
this.parseChunk(chunk)
}
return this.parsed()
}
private parsed(): Bibliography {
this.field = null
const strings = {}
this.cleaning = { type: 'other' }
for (const [key, value] of Object.entries(this.strings)) {
this.field = {
name: '@string',
text: '',
level: 0,
preserveRanges: null,
words: {
upper: 0,
lower: 0,
other: 0,
},
}
this.convert(this.clean(value))
strings[key] = this.field.text
}
return {
errors: this.errors,
entries: this.entries,
comments: this.comments,
strings,
preamble: this.preamble,
}
}
private preserve(start, end?, reason?) {
if (!this.field.preserveRanges) return
if (!end) {
this.field.preserveRanges = null
return
}
/*
this.field.preserveRanges = this.field.preserveRanges.filter(range => range.start < start || range.end > end)
if (this.field.preserveRanges.find(range => range.start <= start && range.end >= end)) return
*/
/*
if (this.field.preserveRanges && this.field.preserveRanges.length) {
const last = this.field.preserveRanges[this.field.preserveRanges.length - 1]
if (start < last.start) throw new Error(JSON.stringify({...last, new: { start, end, reason }, text: this.field.text}))
}
*/
this.field.preserveRanges.push({start, end, reason})
}
private parseChunk(chunk) {
this.chunk = chunk.text
try {
let bib = bibtex.parse(chunk.text, {...this.options, combiningDiacritics: diacritics.commands})
if (bib.kind !== 'Bibliography') throw new Error(this.show(bib))
bib = this.clean(bib)
for (const entity of bib.children) {
switch (entity.kind) {
case 'Entry':
case 'BracedComment':
case 'LineComment':
case 'PreambleExpression':
this.convert(entity)
break
case 'StringDeclaration':
case 'NonEntryText':
break
}
}
return bib
} catch (err) {
if (!err.location) throw err
this.errors.push({
message: err.message,
line: err.location.start.line + chunk.offset.line,
column: err.location.start.column,
source: this.chunk,
})
return null
}
}
private show(o) {
// tslint:disable-next-line prefer-template
let text = JSON.stringify(o)
if (this.chunk) text += '\n' + this.chunk.trim()
return text
}
private text(value = ''): bibtex.TextValue {
return { kind: 'Text', value, mode: 'text' }
}
private error(err, returnvalue) {
if (typeof this.options.errorHandler === 'function') this.options.errorHandler(err)
return returnvalue
}
private condense(node: bibtex.Field | bibtex.Block) {
// apply cleaning to resulting children
node.value = node.value.map(child => this.clean(child))
// unpack redundant blocks
node.value = node.value.reduce((acc, child, i) => {
if (child.kind === 'Block' && !child.case && Object.keys(child.markup).length === 0) {
acc = acc.concat(child.value)
} else {
acc.push(child)
}
return acc
}, [])
// condense text nodes to make whole words for sentence casing
node.value = node.value.reduce((acc, child, i) => {
if (acc.length === 0) {
acc.push(child)
return acc
}
const last = acc[acc.length - 1]
const next = node.value[i + 1]
if (this.options.caseProtection === 'strict' && this.onlyCaseProtected(last) && child.kind === 'Text' && !child.value.match(preserveCase.hasCased) && this.onlyCaseProtected(next)) {
last.value.push(child)
delete last.source
return acc
}
if (last.kind === 'Block' && child.kind === 'Block' && Object.keys(last.markup).sort().join('/') === Object.keys(child.markup).sort().join('/')) {
last.value = last.value.concat(child.value)
delete last.source
return acc
}
if (last.kind === 'Text' && child.kind === 'Text' && last.mode === child.mode) {
last.value += child.value
delete last.source
return acc
}
acc.push(child)
return acc
}, [])
}
private onlyCaseProtected(node) {
return node?.kind === 'Block' && node.case === 'protect' && Object.keys(node.markup).join('/') === ''
}
private argument(node, kind) {
if (!node.arguments || !node.arguments.required.length) return (kind === 'none')
// expect 'n' text arguments
if (typeof kind === 'number') {
if (node.arguments.required.length !== kind) return false
return node.arguments.required
}
// return first argument if it's the only one
if (node.arguments.required.length !== 1) return false
// loose checking for text
if (kind === 'text') {
const first = node.arguments.required[0]
if (first.kind === 'Block' && first.value.length === 1) {
if (first.value[0].kind === 'Text') return first.value[0].value
}
// fall back to strict kind check
kind = 'Text'
}
// return first argument if it's the only one and is of the specified kind
if (node.arguments.required.length !== 1 || node.arguments.required[0].kind !== kind) return false
switch (kind) {
case 'Text':
return node.arguments.required[0].value
case 'RegularCommand':
case 'Block':
return node.arguments.required[0]
}
return false
}
private clean(node: Node | Node[]) {
if (Array.isArray(node)) return node.map(child => this.clean(child))
delete node.loc
switch (node.kind) {
case 'InlineMath':
case 'DisplayMath':
case 'Block':
return this.clean_block(node)
case 'Bibliography':
return this.clean_bib(node)
case 'RegularCommand':
return this.clean_command(node)
case 'DiacriticCommand':
return this.clean_diacritic(node)
case 'Entry':
return this.clean_entry(node)
case 'Field':
return this.options.raw ? node : this.clean_field(node)
case 'StringDeclaration':
return this.clean_stringdecl(node)
case 'StringReference':
return this.clean_stringref(node)
case 'SubscriptCommand':
case 'SuperscriptCommand':
return this.clean_script(node)
case 'SymbolCommand':
return this.clean_symbol(node)
case 'Number':
case 'Text':
case 'PreambleExpression':
case 'BracedComment':
case 'LineComment':
return node
default:
return this.error(new ParserError(`no cleanup method for ${this.show(node)}`, node), this.text())
}
}
private clean_bib(node: bibtex.Bibliography) {
node.children = node.children.filter(child => child.kind !== 'NonEntryText').map(child => this.clean(child as Node))
return node
}
private clean_stringdecl(node: bibtex.StringDeclaration) {
this.strings[node.name.toUpperCase()] = node.value
return node
}
private clean_stringref(node: bibtex.StringReference) {
const name = node.name.toUpperCase()
const _string = this.strings[name]
|| this.options.strings[name]
|| this.default_strings[name]
|| (fields.unabbrev.includes(this.cleaning.name) && this.options.unabbreviate[name]?.text && [ this.text(this.options.unabbreviate[name].text) ])
if (!_string) {
if (!this.unresolvedStrings[name]) this.errors.push({ message: `Unresolved @string reference ${JSON.stringify(node.name)}` })
this.unresolvedStrings[name] = true
}
return this.clean({
kind: 'Block',
// if the string isn't found, add it as-is but exempt it from sentence casing
case: _string ? undefined : 'preserve',
markup: {},
value: _string ? (JSON.parse(JSON.stringify(_string)) as bibtex.ValueType[]) : [ this.text(node.name) ],
})
}
private clean_entry(node: bibtex.Entry) {
const shortjournals = []
for (const field of node.fields) {
if (fields.unabbrev.includes(field.name) && Array.isArray(field.value)) {
const abbr = field.value.map(v => v.source).join('')
const journal = this.options.unabbreviate[abbr]
if (journal) {
shortjournals.push({ ...JSON.parse(JSON.stringify(field)), name: 'shortjournal' })
field.value = JSON.parse(JSON.stringify(journal.ast))
}
}
}
node.fields = node.fields.concat(shortjournals).map(child => this.clean(child))
return node
}
private startCleaning(name) {
name = name.toLowerCase()
if (fields.title.includes(name)) {
this.cleaning = { type: 'title', name }
} else if (fields.creator.includes(name.replace(/s$/, ''))) {
this.cleaning = { type: 'creator', name: name.replace(/s$/, '') }
} else {
this.cleaning = { type: 'other', name }
}
}
private stripNoCase(node: Node, strip, preserve) {
switch (node.kind) {
case 'RegularCommand':
// a bit cheaty to assume these to be nocased, but it's just more likely to be what people want
if (['chsf', 'bibstring', 'cite'].includes(node.command)) strip = true
node.arguments.required.map(arg => this.stripNoCase(arg, strip, preserve))
break
case 'Block':
case 'InlineMath':
case 'DisplayMath':
if (strip && node.case === 'protect') {
if (preserve) {
node.case = 'preserve'
} else {
delete node.case
}
}
node.value.map(v => this.stripNoCase(v, strip || node.case === 'protect', preserve))
break
case 'Field':
if (Array.isArray(node.value)) node.value.map(v => this.stripNoCase(v, strip, preserve))
break
}
}
private isVerbatimField(name) {
return !!this.options.verbatimFields.find(p => (typeof p === 'string') ? name === p : name.match(p))
}
private clean_field(node: bibtex.Field) {
this.startCleaning(node.name)
this.stripNoCase(node, !this.options.caseProtection || this.isVerbatimField(node.name), (this.options.sentenceCase as string[]).length === 0)
if (Array.isArray(node.value)) this.condense(node)
return node
}
private clean_script(node: bibtex.SubscriptCommand | bibtex.SuperscriptCommand) {
let m, value, singlechar
// recognize combined forms like \^\circ
if (singlechar = latex2unicode[node.source]) return this.text(singlechar)
if ((m = node.source.match(/^([\^_])([^{}]+)$/)) && ((singlechar = latex2unicode[`${m[1]}${m[2]}`]) || (singlechar = latex2unicode[`${m[1]}{${m[2]}}`]))) return this.text(singlechar)
if ((m = node.source.match(/^([\^_])\{([^{}]+)\}$/)) && ((singlechar = latex2unicode[`${m[1]}${m[2]}`]) || (singlechar = latex2unicode[`${m[1]}{${m[2]}}`]))) return this.text(singlechar)
const cmd = node.kind === 'SuperscriptCommand' ? '^' : '_'
if (typeof node.value === 'string' && (singlechar = latex2unicode[`${cmd}${node.value}`] || latex2unicode[`${cmd}{${node.value}}`])) {
return this.text(singlechar)
}
if (typeof node.value === 'string') {
value = [ this.text(node.value) ]
} else if (!Array.isArray(node.value)) {
value = [ node.value ]
} else {
value = node.value
}
const mode = node.kind === 'SuperscriptCommand' ? 'sup' : 'sub'
return this.clean({
kind: 'Block',
markup: { [mode]: true },
value,
})
}
private clean_block(node: bibtex.Block) {
this.condense(node)
if (this.options.caseProtection !== 'strict' && this.cleaning.type === 'title' && node.case === 'protect') {
// test whether we can get away with skipping case protection because it contains all words that will be preserved anyway when converting back to Title Case
let preserve = true
for (const child of node.value) {
if (child.kind === 'Text') {
const value = child.value.trim()
preserve = !value.match(preserveCase.hasCased) || !value.split(/\s+/).find(word => !word.match(preserveCase.hasUppercase) && !word.match(preserveCase.isNumber))
} else {
preserve = false
}
if (!preserve) break
}
if (preserve) node.case = 'preserve'
}
for (const [markup, on] of Object.entries(node.markup)) {
if (!on) delete node.markup[markup]
}
return node
}
private clean_diacritic(node: bibtex.DiacriticCommand) {
const char = node.dotless ? `\\${node.character}` : node.character
let unicode = latex2unicode[`\\${node.mark}{${char}}`]
|| latex2unicode[`\\${node.mark}${char}`]
|| latex2unicode[`{\\${node.mark} ${char}}`]
|| latex2unicode[`{\\${node.mark}${char}}`]
|| latex2unicode[`\\${node.mark} ${char}`]
if (!unicode && !node.dotless && node.character.length === 1 && diacritics.tounicode[node.mark]) unicode = node.character + diacritics.tounicode[node.mark]
if (!unicode) return this.error(new TeXError(`Unhandled \\${node.mark}{${char}}`, node, this.chunk), this.text())
return this.text(unicode)
}
private clean_symbol(node: bibtex.SymbolCommand) {
if (node.command === '\\') return this.text('\n')
return this.text(latex2unicode[`\\${node.command}`] || node.command)
}
private first_text_block(node): bibtex.Block {
if (!node) return null
if (node.kind === 'Block') {