#12853

Committed 25 Jul 2024 01:32PM UTC coverage: 86.202%. Remained the same

Build Type

push

Committed by

Commit Message

Merge 242a1aefa into 5f3ffa3fa

Run Details

10593 of 13078 branches covered (81.0%)

Branch coverage included in aggregate %.

91 of 97 new or added lines in 15 files covered. (93.81%)

309 existing lines in 18 files now uncovered.

12292 of 13470 relevant lines covered (91.25%)

26625.48 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

96.21

/src/parser/SGParser.ts

import type { AttributeCstNode, ContentCstNode, DocumentCstNode, ElementCstNode } from '@xml-tools/parser';
import * as parser from '@xml-tools/parser';
import { DiagnosticMessages } from '../DiagnosticMessages';
import util from '../util';
import { SGAst, SGProlog, SGChildren, SGComponent, SGInterfaceField, SGInterfaceFunction, SGInterface, SGNode, SGScript, SGAttribute } from './SGTypes';
import type { SGElement, SGToken, SGReferences } from './SGTypes';
import { isSGComponent } from '../astUtils/xml';
import type { BsDiagnostic } from '../interfaces';
import type { Location, Range } from 'vscode-languageserver';

export default class SGParser {

    /**
     * The AST of the XML document, not including the inline scripts
     */
    public ast: SGAst = new SGAst();

    public tokens: IToken[];

    /**
     * The list of diagnostics found during the parse process
     */
    public diagnostics = [] as BsDiagnostic[];

    /**
     * The options used to parse the file
     */
    public options: SGParseOptions;

    private _references: SGReferences;

    /**
     * These are initially extracted during parse-time, but will also be dynamically regenerated if need be.
     *
     * If a plugin modifies the AST, then the plugin should call SGAst#invalidateReferences() to force this object to refresh
     */
    get references(): SGReferences {
        if (this._references === undefined) {
            this.findReferences();
        }
        return this._references;
    }


    /**
     * Invalidates (clears) the references collection. This should be called anytime the AST has been manipulated.
     */
    invalidateReferences() {
        this._references = undefined;
    }

    /**
     * Walk the AST to extract references to useful bits of information
     */
    private findReferences() {
        this._references = this.emptySGReferences();

        const { componentElement } = this.ast;
        if (!componentElement) {
            return;
        }

        const nameAttr = componentElement.getAttribute('name');
        this._references.name = nameAttr?.tokens.value;
        const extendsAttr = componentElement.getAttribute('extends');
        if (extendsAttr?.tokens.value) {
            this._references.extends = extendsAttr.tokens.value;
        }

        for (const script of componentElement.scriptElements) {
            const uriAttr = script.getAttribute('uri');
            if (uriAttr?.tokens.value) {
                const uri = uriAttr.tokens.value.text;
                this._references.scriptTagImports.push({
                    filePathRange: uriAttr.tokens.value.location?.range,
                    text: uri,
                    destPath: util.getPkgPathFromTarget(this.options.destPath, uri)
                });
            }
        }
    }

    private sanitizeParseOptions(options: SGParseOptions) {
        options ??= {
            destPath: undefined
        };
        options.trackLocations ??= true;
        return options;
    }


    public parse(fileContents: string, options?: SGParseOptions) {
        this.options = this.sanitizeParseOptions(options);
        this.diagnostics = [];

        const { cst, tokenVector, lexErrors, parseErrors } = parser.parse(fileContents);
        this.tokens = tokenVector;

        if (lexErrors.length) {
            for (const err of lexErrors) {
                this.diagnostics.push({
                    ...DiagnosticMessages.xmlGenericParseError(`Syntax error: ${err.message}`),
                    location: this.getLocationFromRange(util.createRange(
                        err.line - 1,
                        err.column,
                        err.line - 1,
                        err.column + err.length
                    ))
                });
            }
        }
        if (parseErrors.length) {
            const err = parseErrors[0];
            const token = err.token;
            this.diagnostics.push({
                ...DiagnosticMessages.xmlGenericParseError(`Syntax error: ${err.message}`),
                location: this.getLocationFromRange(!isNaN(token.startLine) ? this.rangeFromToken(token) : util.createRange(0, 0, 0, Number.MAX_VALUE))
            });
        }

        const { prolog, root } = this.buildAST(cst as any);
        if (!root) {
            const token1 = tokenVector[0];
            const token2 = tokenVector[1];
            //whitespace before the prolog isn't allowed by the parser
            if (
                token1?.image.trim().length === 0 &&
                token2?.image.trim() === '<?xml'
            ) {
                this.diagnostics.push({
                    ...DiagnosticMessages.xmlGenericParseError('Syntax error: whitespace found before the XML prolog'),
                    location: this.getLocationFromRange(this.rangeFromToken(token1))
                });
            }
        }

        if (isSGComponent(root)) {
            this.ast = new SGAst({ prologElement: prolog, rootElement: root, componentElement: root });
        } else {
            if (root) {
                //error: not a component
                this.diagnostics.push({
                    ...DiagnosticMessages.xmlUnexpectedTag(root.tokens.startTagName.text),
                    location: root.tokens.startTagName.location
                });
            }
            this.ast = new SGAst({ prologElement: prolog, rootElement: root });
        }
    }

    buildAST(cst: DocumentCstNode) {
        const { prolog: cstProlog, element } = cst.children;

        let prolog: SGProlog;
        if (cstProlog?.[0]) {
            const ctx = cstProlog[0].children;
            prolog = new SGProlog({
                // <?
                startTagOpen: this.createPartialToken(ctx.XMLDeclOpen[0], 0, 2),
                // xml
                startTagName: this.createPartialToken(ctx.XMLDeclOpen[0], 2, 3),
                attributes: this.mapAttributes(ctx.attribute),
                // ?>
                startTagClose: this.mapToken(ctx.SPECIAL_CLOSE[0])
            });
        }

        let root: SGElement;
        if (element.length > 0 && element[0]?.children?.Name) {
            root = this.mapElement(element[0]);
        }

        return {
            prolog: prolog,
            root: root
        };
    }

    mapElement({ children }: ElementCstNode): SGElement {
        const startTagOpen = this.mapToken(children.OPEN[0]);
        const startTagName = this.mapToken(children.Name[0]);
        const attributes = this.mapAttributes(children.attribute);
        const startTagClose = this.mapToken((children.SLASH_CLOSE ?? children.START_CLOSE)?.[0]);
        const endTagOpen = this.mapToken(children.SLASH_OPEN?.[0]);
        const endTagName = this.mapToken(children.END_NAME?.[0]);
        const endTagClose = this.mapToken(children.END?.[0]);

        const content = children.content?.[0];

        let constructorOptions = {
            startTagOpen: startTagOpen,
            startTagName: startTagName,
            attributes: attributes,
            startTagClose: startTagClose,
            elements: [],
            endTagOpen: endTagOpen,
            endTagName: endTagName,
            endTagClose: endTagClose
        };

        switch (startTagName.text) {
            case 'component':
                constructorOptions.elements = this.mapElements(content, ['interface', 'script', 'children', 'customization']);
                return new SGComponent(constructorOptions);
            case 'interface':
                constructorOptions.elements = this.mapElements(content, ['field', 'function']);
                return new SGInterface(constructorOptions);
            case 'field':
                if (this.hasElements(content)) {
                    this.diagnostics.push({
                        location: startTagName.location,
                        ...DiagnosticMessages.xmlUnexpectedChildren(startTagName.text)
                    });
                }
                return new SGInterfaceField(constructorOptions);
            case 'function':
                if (this.hasElements(content)) {
                    this.diagnostics.push({
                        location: startTagName.location,
                        ...DiagnosticMessages.xmlUnexpectedChildren(startTagName.text)
                    });
                }
                return new SGInterfaceFunction(constructorOptions);
            case 'script':
                if (this.hasElements(content)) {
                    this.diagnostics.push({
                        location: startTagName.location,
                        ...DiagnosticMessages.xmlUnexpectedChildren(startTagName.text)
                    });
                }
                const script = new SGScript(constructorOptions);
                script.cdata = this.getCdata(content);
                return script;
            case 'children':
                constructorOptions.elements = this.mapNodes(content);
                return new SGChildren(constructorOptions);
            default:
                constructorOptions.elements = this.mapNodes(content);
                return new SGNode(constructorOptions);
        }
    }

    mapNode({ children }: ElementCstNode): SGNode {
        return new SGNode({
            //<
            startTagOpen: this.mapToken(children.OPEN[0]),
            // TagName
            startTagName: this.mapToken(children.Name[0]),
            attributes: this.mapAttributes(children.attribute),
            // > or />
            startTagClose: this.mapToken((children.SLASH_CLOSE ?? children.START_CLOSE)[0]),
            elements: this.mapNodes(children.content?.[0]),
            // </
            endTagOpen: this.mapToken(children.SLASH_OPEN?.[0]),
            // TagName
            endTagName: this.mapToken(children.END_NAME?.[0]),
            // >
            endTagClose: this.mapToken(children.END?.[0])
        });
    }

    mapElements(content: ContentCstNode, allow: string[]): SGElement[] {
        if (!content) {
            return [];
        }
        const { element } = content.children;
        const tags: SGElement[] = [];
        if (element) {
            for (const entry of element) {
                const name = entry.children.Name?.[0];
                if (name?.image) {
                    if (!allow.includes(name.image)) {
                        //unexpected tag
                        this.diagnostics.push({
                            ...DiagnosticMessages.xmlUnexpectedTag(name.image),
                            location: this.getLocationFromRange(this.rangeFromToken(name))
                        });
                    }
                    tags.push(this.mapElement(entry));
                } else {
                    //bad xml syntax...
                }
            }
        }
        return tags;
    }

    mapNodes(content: ContentCstNode): SGNode[] {
        if (!content) {
            return [];
        }
        const { element } = content.children;
        return element?.map(element => this.mapNode(element));
    }

    hasElements(content: ContentCstNode): boolean {
        return !!content?.children.element?.length;
    }

    getCdata(content: ContentCstNode): SGToken {
        if (!content) {
            return undefined;
        }
        const { CData } = content.children;
        return this.mapToken(CData?.[0]);
    }

    private mapToken(token: IToken): SGToken {
        if (token) {
            return {
                text: token.image,
                //TODO should this be coerced into a uri?
                location: util.createLocationFromRange(this.options.srcPath, this.rangeFromToken(token))
            };
        } else {
            return undefined;
        }
    }

    /**
     * Build SGAttributes from the underlying XML parser attributes array
     */
    mapAttributes(attributes: AttributeCstNode[]) {
        // this is a hot function and has been optimized, so don't refactor unless you know what you're doing...
        const result = [] as SGAttribute[];
        if (attributes) {
            // eslint-disable-next-line @typescript-eslint/prefer-for-of
            for (let i = 0; i < attributes.length; i++) {

                const children = attributes[i].children;
                const attr = new SGAttribute({ key: this.mapToken(children.Name[0]) });

                if (children.EQUALS) {
                    attr.tokens.equals = this.mapToken(children.EQUALS[0]);
                }
                if (children.STRING) {
                    const valueToken = children.STRING[0];
                    attr.tokens.openingQuote = this.createPartialToken(valueToken, 0, 1);
                    attr.tokens.value = this.createPartialToken(valueToken, 1, -2);
                    attr.tokens.closingQuote = this.createPartialToken(valueToken, -1, 1);
                }
                result.push(attr);
            }
        }
        return result;
    }

    /**
     * Create a partial token from the given token. This only supports single-line tokens.
     * @param token the offset to start the new token. If negative, subtracts from token.length
     * @param startOffset the offset to start the new token. If negative, subtracts from token.length
     * @param length the length of the text to keep. If negative, subtracts from token.length
     */
    public createPartialToken(token: IToken, startOffset: number, length?: number): SGToken {
        if (startOffset < 0) {
            startOffset = token.image.length + startOffset;
        }
        if (length === undefined) {
            length = token.image.length - startOffset;
        }
        if (length < 0) {
            length = token.image.length + length;
        }
        return {
            text: token.image.substring(startOffset, startOffset + length),
            //xmltools startLine is 1-based, we need 0-based which is why we subtract 1 below
            location: util.createLocation(
                token.startLine - 1,
                token.startColumn - 1 + startOffset,
                token.endLine - 1,
                token.startColumn - 1 + (startOffset + length),
                this.options.srcPath
            )
        };
    }

    /**
     * Create a range based on the xmltools token
     */
    public rangeFromToken(token: IToken) {
        return util.createRange(
            token.startLine - 1,
            token.startColumn - 1,
            token.endLine - 1,
            token.endColumn
        );
    }

    private emptySGReferences(): SGReferences {
        return {
            scriptTagImports: []
        };
    }

    private getLocationFromRange(range: Range): Location {
        return util.createLocationFromRange(util.pathToUri(this.options.srcPath), range);
    }
}

//not exposed by @xml-tools/parser
interface IToken {
    image: string;
    startOffset: number;
    startLine?: number;
    startColumn?: number;
    endOffset?: number;
    endLine?: number;
    endColumn?: number;
}

export interface CstNodeLocation {
    startOffset: number;
    startLine: number;
    startColumn?: number;
    endOffset?: number;
    endLine?: number;
    endColumn?: number;
}

export interface SGParseOptions {
    /**
     * Path to the file where this source code originated
     */
    srcPath?: string;

    destPath: string;
    /**
     * Should locations be tracked. If false, the `range` property will be omitted
     * @default true
     */
    trackLocations?: boolean;
}

1	import type { AttributeCstNode, ContentCstNode, DocumentCstNode, ElementCstNode } from '@xml-tools/parser';
2	import * as parser from '@xml-tools/parser';	1✔
3	import { DiagnosticMessages } from '../DiagnosticMessages';	1✔
4	import util from '../util';	1✔
5	import { SGAst, SGProlog, SGChildren, SGComponent, SGInterfaceField, SGInterfaceFunction, SGInterface, SGNode, SGScript, SGAttribute } from './SGTypes';	1✔
6	import type { SGElement, SGToken, SGReferences } from './SGTypes';
7	import { isSGComponent } from '../astUtils/xml';	1✔
8	import type { BsDiagnostic } from '../interfaces';
9	import type { Location, Range } from 'vscode-languageserver';
10
11	export default class SGParser {	1✔
12
13	/**
14	* The AST of the XML document, not including the inline scripts
15	*/
16	public ast: SGAst = new SGAst();	451✔
17
18	public tokens: IToken[];
19
20	/**
21	* The list of diagnostics found during the parse process
22	*/
23	public diagnostics = [] as BsDiagnostic[];	451✔
24
25	/**
26	* The options used to parse the file
27	*/
28	public options: SGParseOptions;
29
30	private _references: SGReferences;
31
32	/**
33	* These are initially extracted during parse-time, but will also be dynamically regenerated if need be.
34	*
35	* If a plugin modifies the AST, then the plugin should call SGAst#invalidateReferences() to force this object to refresh
36	*/
37	get references(): SGReferences {
38	if (this._references === undefined) {	12,640✔
39	this.findReferences();	380✔
40	}
41	return this._references;	12,640✔
42	}
43
44
45	/**
46	* Invalidates (clears) the references collection. This should be called anytime the AST has been manipulated.
47	*/
48	invalidateReferences() {
UNCOV 49	this._references = undefined;	×
50	}
51
52	/**
53	* Walk the AST to extract references to useful bits of information
54	*/
55	private findReferences() {
56	this._references = this.emptySGReferences();	380✔
57
58	const { componentElement } = this.ast;	380✔
59	if (!componentElement) {	380✔
60	return;	10✔
61	}
62
63	const nameAttr = componentElement.getAttribute('name');	370✔
64	this._references.name = nameAttr?.tokens.value;	370✔
65	const extendsAttr = componentElement.getAttribute('extends');	370✔
66	if (extendsAttr?.tokens.value) {	370✔
67	this._references.extends = extendsAttr.tokens.value;	354✔
68	}
69
70	for (const script of componentElement.scriptElements) {	370✔
71	const uriAttr = script.getAttribute('uri');	228✔
72	if (uriAttr?.tokens.value) {	228✔
73	const uri = uriAttr.tokens.value.text;	227✔
74	this._references.scriptTagImports.push({	227✔
75	filePathRange: uriAttr.tokens.value.location?.range,	681!
76	text: uri,
77	destPath: util.getPkgPathFromTarget(this.options.destPath, uri)
78	});
79	}
80	}
81	}
82
83	private sanitizeParseOptions(options: SGParseOptions) {
84	options ??= {	388✔
85	destPath: undefined
86	};
87	options.trackLocations ??= true;	388!
88	return options;	388✔
89	}
90
91
92	public parse(fileContents: string, options?: SGParseOptions) {
93	this.options = this.sanitizeParseOptions(options);	388✔
94	this.diagnostics = [];	388✔
95
96	const { cst, tokenVector, lexErrors, parseErrors } = parser.parse(fileContents);	388✔
97	this.tokens = tokenVector;	388✔
98
99	if (lexErrors.length) {	388✔
100	for (const err of lexErrors) {	1✔
101	this.diagnostics.push({	1✔
102	...DiagnosticMessages.xmlGenericParseError(`Syntax error: ${err.message}`),
103	location: this.getLocationFromRange(util.createRange(
104	err.line - 1,
105	err.column,
106	err.line - 1,
107	err.column + err.length
108	))
109	});
110	}
111	}
112	if (parseErrors.length) {	388✔
113	const err = parseErrors[0];	15✔
114	const token = err.token;	15✔
115	this.diagnostics.push({	15✔
116	...DiagnosticMessages.xmlGenericParseError(`Syntax error: ${err.message}`),
117	location: this.getLocationFromRange(!isNaN(token.startLine) ? this.rangeFromToken(token) : util.createRange(0, 0, 0, Number.MAX_VALUE))	15✔
118	});
119	}
120
121	const { prolog, root } = this.buildAST(cst as any);	388✔
122	if (!root) {	388✔
123	const token1 = tokenVector[0];	12✔
124	const token2 = tokenVector[1];	12✔
125	//whitespace before the prolog isn't allowed by the parser
126	if (	12✔
127	token1?.image.trim().length === 0 &&	50✔
128	token2?.image.trim() === '<?xml'	6!
129	) {
130	this.diagnostics.push({	2✔
131	...DiagnosticMessages.xmlGenericParseError('Syntax error: whitespace found before the XML prolog'),
132	location: this.getLocationFromRange(this.rangeFromToken(token1))
133	});
134	}
135	}
136
137	if (isSGComponent(root)) {	388✔
138	this.ast = new SGAst({ prologElement: prolog, rootElement: root, componentElement: root });	375✔
139	} else {
140	if (root) {	13✔
141	//error: not a component
142	this.diagnostics.push({	1✔
143	...DiagnosticMessages.xmlUnexpectedTag(root.tokens.startTagName.text),
144	location: root.tokens.startTagName.location
145	});
146	}
147	this.ast = new SGAst({ prologElement: prolog, rootElement: root });	13✔
148	}
149	}
150
151	buildAST(cst: DocumentCstNode) {
152	const { prolog: cstProlog, element } = cst.children;	388✔
153
154	let prolog: SGProlog;
155	if (cstProlog?.[0]) {	388✔
156	const ctx = cstProlog[0].children;	237✔
157	prolog = new SGProlog({	237✔
158	// <?
159	startTagOpen: this.createPartialToken(ctx.XMLDeclOpen[0], 0, 2),
160	// xml
161	startTagName: this.createPartialToken(ctx.XMLDeclOpen[0], 2, 3),
162	attributes: this.mapAttributes(ctx.attribute),
163	// ?>
164	startTagClose: this.mapToken(ctx.SPECIAL_CLOSE[0])
165	});
166	}
167
168	let root: SGElement;
169	if (element.length > 0 && element[0]?.children?.Name) {	388!
170	root = this.mapElement(element[0]);	376✔
171	}
172
173	return {	388✔
174	prolog: prolog,
175	root: root
176	};
177	}
178
179	mapElement({ children }: ElementCstNode): SGElement {
180	const startTagOpen = this.mapToken(children.OPEN[0]);	721✔
181	const startTagName = this.mapToken(children.Name[0]);	721✔
182	const attributes = this.mapAttributes(children.attribute);	721✔
183	const startTagClose = this.mapToken((children.SLASH_CLOSE ?? children.START_CLOSE)?.[0]);	721!
184	const endTagOpen = this.mapToken(children.SLASH_OPEN?.[0]);	721✔
185	const endTagName = this.mapToken(children.END_NAME?.[0]);	721✔
186	const endTagClose = this.mapToken(children.END?.[0]);	721✔
187
188	const content = children.content?.[0];	721✔
189
190	let constructorOptions = {	721✔
191	startTagOpen: startTagOpen,
192	startTagName: startTagName,
193	attributes: attributes,
194	startTagClose: startTagClose,
195	elements: [],
196	endTagOpen: endTagOpen,
197	endTagName: endTagName,
198	endTagClose: endTagClose
199	};
200
201	switch (startTagName.text) {	721✔
202	case 'component':	721✔
203	constructorOptions.elements = this.mapElements(content, ['interface', 'script', 'children', 'customization']);	375✔
204	return new SGComponent(constructorOptions);	375✔
205	case 'interface':
206	constructorOptions.elements = this.mapElements(content, ['field', 'function']);	35✔
207	return new SGInterface(constructorOptions);	35✔
208	case 'field':
209	if (this.hasElements(content)) {	29✔
210	this.diagnostics.push({	1✔
211	location: startTagName.location,
212	...DiagnosticMessages.xmlUnexpectedChildren(startTagName.text)
213	});
214	}
215	return new SGInterfaceField(constructorOptions);	29✔
216	case 'function':
217	if (this.hasElements(content)) {	34!
UNCOV 218	this.diagnostics.push({	×
219	location: startTagName.location,
220	...DiagnosticMessages.xmlUnexpectedChildren(startTagName.text)
221	});
222	}
223	return new SGInterfaceFunction(constructorOptions);	34✔
224	case 'script':
225	if (this.hasElements(content)) {	233✔
226	this.diagnostics.push({	1✔
227	location: startTagName.location,
228	...DiagnosticMessages.xmlUnexpectedChildren(startTagName.text)
229	});
230	}
231	const script = new SGScript(constructorOptions);	233✔
232	script.cdata = this.getCdata(content);	233✔
233	return script;	233✔
234	case 'children':
235	constructorOptions.elements = this.mapNodes(content);	9✔
236	return new SGChildren(constructorOptions);	9✔
237	default:
238	constructorOptions.elements = this.mapNodes(content);	6✔
239	return new SGNode(constructorOptions);	6✔
240	}
241	}
242
243	mapNode({ children }: ElementCstNode): SGNode {
244	return new SGNode({	12✔
245	//<
246	startTagOpen: this.mapToken(children.OPEN[0]),
247	// TagName
248	startTagName: this.mapToken(children.Name[0]),
249	attributes: this.mapAttributes(children.attribute),
250	// > or />
251	startTagClose: this.mapToken((children.SLASH_CLOSE ?? children.START_CLOSE)[0]),	36✔
252	elements: this.mapNodes(children.content?.[0]),	36✔
253	// </
254	endTagOpen: this.mapToken(children.SLASH_OPEN?.[0]),	36✔
255	// TagName
256	endTagName: this.mapToken(children.END_NAME?.[0]),	36✔
257	// >
258	endTagClose: this.mapToken(children.END?.[0])	36✔
259	});
260	}
261
262	mapElements(content: ContentCstNode, allow: string[]): SGElement[] {
263	if (!content) {	410✔
264	return [];	6✔
265	}
266	const { element } = content.children;	404✔
267	const tags: SGElement[] = [];	404✔
268	if (element) {	404✔
269	for (const entry of element) {	231✔
270	const name = entry.children.Name?.[0];	346✔
271	if (name?.image) {	346✔
272	if (!allow.includes(name.image)) {	345✔
273	//unexpected tag
274	this.diagnostics.push({	4✔
275	...DiagnosticMessages.xmlUnexpectedTag(name.image),
276	location: this.getLocationFromRange(this.rangeFromToken(name))
277	});
278	}
279	tags.push(this.mapElement(entry));	345✔
280	} else {
281	//bad xml syntax...
282	}
283	}
284	}
285	return tags;	404✔
286	}
287
288	mapNodes(content: ContentCstNode): SGNode[] {
289	if (!content) {	27✔
290	return [];	15✔
291	}
292	const { element } = content.children;	12✔
293	return element?.map(element => this.mapNode(element));	12!
294	}
295
296	hasElements(content: ContentCstNode): boolean {
297	return !!content?.children.element?.length;	296✔
298	}
299
300	getCdata(content: ContentCstNode): SGToken {
301	if (!content) {	233✔
302	return undefined;	231✔
303	}
304	const { CData } = content.children;	2✔
305	return this.mapToken(CData?.[0]);	2✔
306	}
307
308	private mapToken(token: IToken): SGToken {
309	if (token) {	8,041✔
310	return {	7,098✔
311	text: token.image,
312	//TODO should this be coerced into a uri?
313	location: util.createLocationFromRange(this.options.srcPath, this.rangeFromToken(token))
314	};
315	} else {
316	return undefined;	943✔
317	}
318	}
319
320	/**
321	* Build SGAttributes from the underlying XML parser attributes array
322	*/
323	mapAttributes(attributes: AttributeCstNode[]) {
324	// this is a hot function and has been optimized, so don't refactor unless you know what you're doing...
325	const result = [] as SGAttribute[];	970✔
326	if (attributes) {	970✔
327	// eslint-disable-next-line @typescript-eslint/prefer-for-of
328	for (let i = 0; i < attributes.length; i++) {	919✔
329
330	const children = attributes[i].children;	1,703✔
331	const attr = new SGAttribute({ key: this.mapToken(children.Name[0]) });	1,703✔
332
333	if (children.EQUALS) {	1,703✔
334	attr.tokens.equals = this.mapToken(children.EQUALS[0]);	1,701✔
335	}
336	if (children.STRING) {	1,703✔
337	const valueToken = children.STRING[0];	1,701✔
338	attr.tokens.openingQuote = this.createPartialToken(valueToken, 0, 1);	1,701✔
339	attr.tokens.value = this.createPartialToken(valueToken, 1, -2);	1,701✔
340	attr.tokens.closingQuote = this.createPartialToken(valueToken, -1, 1);	1,701✔
341	}
342	result.push(attr);	1,703✔
343	}
344	}
345	return result;	970✔
346	}
347
348	/**
349	* Create a partial token from the given token. This only supports single-line tokens.
350	* @param token the offset to start the new token. If negative, subtracts from token.length
351	* @param startOffset the offset to start the new token. If negative, subtracts from token.length
352	* @param length the length of the text to keep. If negative, subtracts from token.length
353	*/
354	public createPartialToken(token: IToken, startOffset: number, length?: number): SGToken {
355	if (startOffset < 0) {	5,577✔
356	startOffset = token.image.length + startOffset;	1,701✔
357	}
358	if (length === undefined) {	5,577!
UNCOV 359	length = token.image.length - startOffset;	×
360	}
361	if (length < 0) {	5,577✔
362	length = token.image.length + length;	1,701✔
363	}
364	return {	5,577✔
365	text: token.image.substring(startOffset, startOffset + length),
366	//xmltools startLine is 1-based, we need 0-based which is why we subtract 1 below
367	location: util.createLocation(
368	token.startLine - 1,
369	token.startColumn - 1 + startOffset,
370	token.endLine - 1,
371	token.startColumn - 1 + (startOffset + length),
372	this.options.srcPath
373	)
374	};
375	}
376
377	/**
378	* Create a range based on the xmltools token
379	*/
380	public rangeFromToken(token: IToken) {
381	return util.createRange(	7,118✔
382	token.startLine - 1,
383	token.startColumn - 1,
384	token.endLine - 1,
385	token.endColumn
386	);
387	}
388
389	private emptySGReferences(): SGReferences {
390	return {	380✔
391	scriptTagImports: []
392	};
393	}
394
395	private getLocationFromRange(range: Range): Location {
396	return util.createLocationFromRange(util.pathToUri(this.options.srcPath), range);	22✔
397	}
398	}
399
400	//not exposed by @xml-tools/parser
401	interface IToken {
402	image: string;
403	startOffset: number;
404	startLine?: number;
405	startColumn?: number;
406	endOffset?: number;
407	endLine?: number;
408	endColumn?: number;
409	}
410
411	export interface CstNodeLocation {
412	startOffset: number;
413	startLine: number;
414	startColumn?: number;
415	endOffset?: number;
416	endLine?: number;
417	endColumn?: number;
418	}
419
420	export interface SGParseOptions {
421	/**
422	* Path to the file where this source code originated
423	*/
424	srcPath?: string;
425
426	destPath: string;
427	/**
428	* Should locations be tracked. If false, the `range` property will be omitted
429	* @default true
430	*/
431	trackLocations?: boolean;
432	}

rokucommunity / brighterscript / #12853

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous