mutable struct Accumulator

A structure to accumulate part of the input stream as a simple string. It differs from Position that store line and column information.

BibTeXError

Description of a BibTeXError, including the relevant position in the input string.

Arguments:

• kind::Symbol: the type of BibTeX error
• input::String: the BibTeX string being parsed
• start::Position: the row/col start position of the BibTeXError
• stop::Position: the row/col end position of the BibTeXError

Content

Store the different BibTeX elements once succesfully parsed.

Content()

Create an (almost) empty content constructor for a new Parser. Some usual BibTeX content is added:

• List of months abbreviations in English (added automatically by some BibTeX class)

Feel free to contribute to more default content.

Field

A structure that can store BibTeX fields information.

Arguments:

• braces::Int: counter to the number of opened braces in a field being parsed
• name::String: name of the field being parsed
• quotes::Bool: true if the field is delimited by quotes
• value::String: the value of the field

Parser

A structure allowing to parse a BibTeX formatted string one character at a time.

Arguments:

• acc::Accumulator: an accumulated string from last dump to content
• content::Content: the current content of a parser
• errors::Vector{BibTeXError}: a collection of BibTeX errors
• field::Field: temporary storage for an entry fields names
• input::Vector{Char}: the BibTeX string
• pos_start::Position: pointer to the raw/col start position
• pos_end::Position: pointer to the raw/col end position
• storage::Storage: temporary storage of the content of an entry being parsed
• task::Symbol: describe which part of the BibTeX gramma is being parsed

Position

A structure pointing to a position in the input based on rows and columns.

Position()

Initial position constructor

Storage

Store the content of an entry being parsed.

Arguments:

• delim::Union{Char, Nothing}: the character delimiting the entry
• fields::Vector{Field}: a collection of the entry's fields
• key::String: the key of the entry
• kind::String: the kind/type of BibTeX entry

Storage()

Empty storage constructor called when a new entry is being parsed.

dump!(parser, char = ' ')

Dump the content of the parser Accumulator into the parser Content. Dispatch to the appropriate dump! method according to the state of the parser.

get_acc(parser; from = 1, to = 0)

Retrieve the Accumulator of the parser.

Arguments:

• parser: a Parser
• from: a positive offset from the start of the Accumulator, default to 1
• to: a negative offset from the end of the Accumulator, default to 0

get_entries(parser)

Retrieve the entries succesfully parsed by parser.

inc!(parser, char, dumped)

Increment the start/end position and accumulator of the parser.

Arguments:

• parser: a BibTeX.Parser structure
• char: the character being parsed
• dumped: boolean value describing if the Accumulator content is being dumped into the parser Content

inc_col!(parser) = begin

Increment the column field of the pointer to the end position of the Parser.

inc_row!(parser)

Increment the row field of the pointer to the end position of the Parser.

is_dumped(parser, char)

Check if an Accumulator needs to be dump!ed. Dispatch to the appropriate is_dumped method according to the state of the parser.

make_entry(storage)

Make a BibInternal.Entry from a completed entry in a parser storage.

parse!(parser, char)

Parse a single character of a BibTeX string. Modify the Parser accordingly.

parse_file(path)

Parse a BibTeX file located at path. Raise a detailed warning for each invalid entry.

parse_string(str)

Parse a BibTeX string of entries. Raise a detailed warning for each invalid entry.

rev(char)

Return the closing character )/} matching either ( or {.

set_delim!(parser, char)

Set the delimiter for this section of the entry to parenthesis or braces.

set_entry_kind!(parser, kind) = begin

Set the kind of the entry being parsed in the parser's storage.

warn(error)

Dispatch a BibTeX error as a Julia warning based on the type of error.