Support @string in bibtex structure pane

Author: James-Yu

src/providers/completer/citation.ts

@@ -77,6 +77,54 @@ function readCitationFormat(configuration: vscode.WorkspaceConfiguration, exclud
     return fields
 }
 
+export const bibTools = {
+    expandField,
+    deParenthesis,
+    parseAbbrevations
+}
+
+function expandField(abbreviations: {[key: string]: string}, value: bibtexParser.FieldValue): string {
+    if (value.kind === 'concat') {
+        const args = value.content as bibtexParser.FieldValue[]
+        return args.map(arg => expandField(abbreviations, arg)).join(' ')
+    }
+    if (bibtexParser.isAbbreviationValue(value)) {
+        if (value.content in abbreviations) {
+            return abbreviations[value.content]
+        }
+        return ''
+    }
+    return value.content
+}
+
+function deParenthesis(str: string): string {
+    // Remove wrapping { }
+    // Extract the content of \url{}
+    return str.replace(/\\url{([^\\{}]+)}/g, '$1').replace(/{+([^\\{}]+)}+/g, '$1')
+}
+
+function parseAbbrevations(ast: bibtexParser.BibtexAst) {
+    const abbreviations: {[key: string]: string} = {}
+    ast.content.filter(bibtexParser.isStringEntry).forEach((entry: bibtexParser.StringEntry) => {
+        // @string{string1 = "Proceedings of the "}
+        // @string{string2 = string1 # "Foo"}
+        if (typeof entry.value.content === 'string') {
+            abbreviations[entry.abbreviation] = entry.value.content
+        } else {
+            abbreviations[entry.abbreviation] =
+                (entry.value.content as (bibtexParser.AbbreviationValue | bibtexParser.TextStringValue)[]).map(subEntry => {
+                    if (bibtexParser.isAbbreviationValue(subEntry)) {
+                        return abbreviations[subEntry.content] ?? `undefined @string "${subEntry.content}"`
+                    } else {
+                        return subEntry.content
+                    }
+                }).join('')
+        }
+    })
+
+    return abbreviations
+}
+
 export class Citation implements IProvider {
     /**
      * Bib entries in each bib `file`.
@@ -261,23 +309,7 @@ export class Citation implements IProvider {
             lw.eventBus.fire(eventbus.FileParsed, fileName)
             return
         }
-        const abbreviations: {[key: string]: string} = {}
-        ast.content.filter(bibtexParser.isStringEntry).forEach((entry: bibtexParser.StringEntry) => {
-            // @string{string1 = "Proceedings of the "}
-            // @string{string2 = string1 # "Foo"}
-            if (typeof entry.value.content === 'string') {
-                abbreviations[entry.abbreviation] = entry.value.content
-            } else {
-                abbreviations[entry.abbreviation] =
-                    (entry.value.content as (bibtexParser.AbbreviationValue | bibtexParser.TextStringValue)[]).map(subEntry => {
-                        if (bibtexParser.isAbbreviationValue(subEntry)) {
-                            return abbreviations[subEntry.content] ?? `undefined @string "${subEntry.content}"`
-                        } else {
-                            return subEntry.content
-                        }
-                    }).join('')
-            }
-        })
+        const abbreviations = parseAbbrevations(ast)
         ast.content
             .filter(bibtexParser.isEntry)
             .forEach((entry: bibtexParser.Entry) => {
@@ -293,7 +325,7 @@ export class Citation implements IProvider {
                     fields: new Fields()
                 }
                 entry.content.forEach(field => {
-                    const value = this.deParenthesis(this.expandField(abbreviations, field.value))
+                    const value = deParenthesis(expandField(abbreviations, field.value))
                     item.fields.set(field.name, value)
                 })
                 newEntry.push(item)
@@ -304,20 +336,6 @@ export class Citation implements IProvider {
         lw.eventBus.fire(eventbus.FileParsed, fileName)
     }
 
-    private expandField(abbreviations: {[key: string]: string}, value: bibtexParser.FieldValue): string {
-        if (value.kind === 'concat') {
-            const args = value.content as bibtexParser.FieldValue[]
-            return args.map(arg => this.expandField(abbreviations, arg)).join(' ')
-        }
-        if (bibtexParser.isAbbreviationValue(value)) {
-            if (value.content in abbreviations) {
-                return abbreviations[value.content]
-            }
-            return ''
-        }
-        return value.content
-    }
-
     removeEntriesInFile(file: string) {
         logger.log(`Remove parsed bib entries for ${file}`)
         this.bibEntries.delete(file)
@@ -360,10 +378,4 @@ export class Citation implements IProvider {
         }
         return items
     }
-
-    private deParenthesis(str: string): string {
-        // Remove wrapping { }
-        // Extract the content of \url{}
-        return str.replace(/\\url{([^\\{}]+)}/g, '$1').replace(/{+([^\\{}]+)}+/g, '$1')
-    }
 }

src/providers/structurelib/bibtex.ts

@@ -4,19 +4,22 @@ import { TeXElement, TeXElementType } from '../structure'
 import { parser } from '../../components/parser'
 
 import { getLogger } from '../../components/logger'
+import { bibTools } from '../completer/citation'
 
 const logger = getLogger('Structure', 'BibTeX')
 
 /**
 * Convert a bibtexParser.FieldValue to a string
 * @param field the bibtexParser.FieldValue to parse
 */
-function fieldValueToString(field: bibtexParser.FieldValue): string {
-   if (field.kind === 'concat') {
-       return field.content.map(value => fieldValueToString(value)).reduce((acc, cur) => {return acc + ' # ' + cur})
-   } else {
-       return field.content
-   }
+function fieldValueToString(field: bibtexParser.FieldValue, abbreviations: {[abbr: string]: string}): string {
+    if (field.kind === 'concat') {
+        return field.content.map(value => fieldValueToString(value, abbreviations)).reduce((acc, cur) => {return acc + ' # ' + cur})
+    } else if (field.kind === 'abbreviation') {
+        return abbreviations[field.content] ?? `undefined @string "${field.content}"`
+    } else {
+        return field.content
+    }
 }
 
 export async function buildBibTeX(document: vscode.TextDocument): Promise<TeXElement[]> {
@@ -31,6 +34,7 @@ export async function buildBibTeX(document: vscode.TextDocument): Promise<TeXEle
         return []
     }
     logger.log(`Parsed ${ast.content.length} AST items.`)
+    const abbreviations = bibTools.parseAbbrevations(ast)
     const ds: TeXElement[] = []
     ast.content.filter(bibtexParser.isEntry)
         .forEach(entry => {
@@ -44,7 +48,7 @@ export async function buildBibTeX(document: vscode.TextDocument): Promise<TeXEle
                 children: []
             }
             entry.content.forEach(field => {
-                const content = fieldValueToString(field.value)
+                const content = fieldValueToString(field.value, abbreviations)
                 const fielditem: TeXElement = {
                     type: TeXElementType.BibField,
                     name: field.name,