@helloao/tools 0.0.1

package/parser/usfm-parser.d.ts

@@ -0,0 +1,135 @@
+import { ParseTree } from './types';
+/**
+ * Defines a class that can tokenize a stream of characters into tokens.
+ */
+export declare class UsfmTokenizer {
+    private _input;
+    private _index;
+    private _start;
+    private get _tokenLength();
+    /**
+     * Converts the given input into a list of tokens.
+     * @param input The input that should be tokenized.
+     */
+    tokenize(input: string): SimpleToken[];
+    private _parseTokens;
+    private _parseToken;
+}
+export interface UsfmParseOptions {
+    paragraphs: Set<string>;
+}
+/**
+ * Defines a USFM Parser.
+ */
+export declare class UsfmParser {
+    private _poem;
+    private _wordsOfJesus;
+    tokenize(input: string): Token[];
+    parse(input: string): ParseTree;
+    renderMarkdown(tree: ParseTree): string;
+    private _hasAttribute;
+    private _text;
+    private _throwError;
+}
+/**
+ * Determines if the given character is a digit.
+ * @param char The character.
+ */
+export declare function isDigit(char: string): boolean;
+/**
+ * Determines if the given character is considered whitespace.
+ * @param char The character.
+ */
+export declare function isWhitespace(char: string): boolean;
+export declare function t(loc: SourceLocation, kind: T): SimpleToken;
+/**
+ * Creates a new source location.
+ * @param start The start of the location.
+ * @param end The end of the location.
+ */
+export declare function loc(start: number, end: number): SourceLocation;
+/**
+ * Creates a new marker token.
+ * @param loc The location for the token.
+ * @param command The command that the token contains.
+ * @param number The number that the marker contains.
+ * @param type The type of the marker.
+ */
+export declare function marker(loc: SourceLocation, command: string, number?: number | null, type?: MarkerToken['type']): MarkerToken;
+/**
+ * Creates a new word token.
+ * @param loc The location for the token.
+ * @param word The word contained by the token.
+ */
+export declare function word(loc: SourceLocation, word: string): WordToken;
+export declare function whitespace(loc: SourceLocation, whitespace: string): WhitespaceToken;
+export type T = Token['kind'];
+/**
+ * Defines a simple token.
+ */
+export interface SimpleToken {
+    kind: T;
+    loc: SourceLocation;
+}
+export type Token = MarkerToken | WordToken | WhitespaceToken;
+/**
+ * Defines an interface for a USFM marker node.
+ * That is, the syntax for a marker.
+ */
+export interface MarkerToken {
+    kind: 'marker';
+    /**
+     * The command that the marker represents.
+     * This is generally the name of the marker (like "p" or "v" for paragraph and verse markers)
+     */
+    command: string;
+    /**
+     * The number that the marker contains.
+     * Null if no number was specified.
+     */
+    number: number | null;
+    /**
+     * Whether the marker represents a start or an end.
+     */
+    type: 'start' | 'end';
+    /**
+     * The location of the node.
+     */
+    loc: SourceLocation;
+}
+/**
+ * Defines an interface for a Whitespace node.
+ */
+export interface WhitespaceToken {
+    kind: 'whitespace';
+    /**
+     * The whitespace contained by the node.
+     */
+    whitespace: string;
+    /**
+     * The location of the node.
+     */
+    loc: SourceLocation;
+}
+/**
+ * Defines an interface for a word token.
+ */
+export interface WordToken {
+    kind: 'word';
+    /**
+     * The word contained by the token.
+     */
+    word: string;
+    /**
+     * The location of the word.
+     */
+    loc: SourceLocation;
+}
+/**
+ * The source location of the node.
+ */
+export interface SourceLocation {
+    start: number;
+    end: number;
+}
+//# sourceMappingURL=usfm-parser.d.ts.map