uniorg-parse 3.0.1 → 3.1.0

package/lib/parser.js

@@ -19,10 +19,10 @@ import { Reader } from './reader.js';
  * By default, all Elements except `Headline`, `Planning`, `PropertyDrawer`, `ListItem`, `TableRow`, and
  * `NodeProperty` are supported.
  *
- * If the documentation of the mode say “allows”—the specified elements are supported in additional to default
+ * If the documentation of the mode say "allows"—the specified elements are supported in additional to default
  * elements.
  *
- * If the documentation of the mode says “expecting”—only that elements are allowed (default elements are
+ * If the documentation of the mode says "expecting"—only that elements are allowed (default elements are
  * not).
  */
 var ParseMode;
@@ -53,10 +53,28 @@ class Parser {
         this.options = { ...defaultOptions, ...options };
         this.re = new OrgRegexUtils(this.options);
     }
+    /**
+     * Adds position information to node data when trackPosition is enabled
+     */
+    addPosition(data, startOffset, endOffset) {
+        if (!this.options.trackPosition) {
+            return data;
+        }
+        const position = this.r.positionFromOffsets(startOffset, endOffset);
+        if (!position) {
+            return data;
+        }
+        return {
+            ...data,
+            position,
+        };
+    }
     parse() {
         this.parseEmptyLines();
+        const startOffset = 0;
         const children = this.parseElements(ParseMode.TopComment);
-        return u('org-data', { contentsBegin: 0, contentsEnd: this.r.endOffset() }, children);
+        const endOffset = this.r.endOffset();
+        return u('org-data', this.addPosition({ contentsBegin: startOffset, contentsEnd: endOffset }, startOffset, endOffset), children);
     }
     // General parsing structure
     parseElements(mode, structure) {
@@ -66,7 +84,7 @@ class Parser {
             const offset = this.r.offset();
             if (offset === prevOffset) {
                 console.log('elements:', elements, 'rest:', JSON.stringify(this.r.rest()));
-                throw new Error('no progress (elements)');
+                throw new Error('no progress (elements), if you see this, please report an issue to https://github.com/rasendubi/uniorg/issues');
             }
             prevOffset = offset;
             const element = this.parseElement(mode, structure);
@@ -85,7 +103,7 @@ class Parser {
                         element.structure
                     : undefined));
                 this.r.widen();
-                // Delete structure from lists. It’s only here to facilitate
+                // Delete structure from lists. It's only here to facilitate
                 // parsing and should not be exposed to the user.
                 // @ts-expect-error Property 'structure' does not exist on type 'OrgData'
                 if (element.structure) {
@@ -287,13 +305,13 @@ class Parser {
             // cursor. This is always a programming error and leads to
             // infinite loop here.
             if (this.r.offset() === prevOffset) {
-                throw new Error(`no progress (parseObject): ${JSON.stringify(mobject)}, text: ${JSON.stringify(this.r.rest())}, objects: ${JSON.stringify(objects, null, 2)}`);
+                throw new Error(`no progress (parseObject). If you see this, please report an issue to https://github.com/rasendubi/uniorg/issues with the following information: ${JSON.stringify(mobject)}, text: ${JSON.stringify(this.r.rest())}, objects: ${JSON.stringify(objects, null, 2)}`);
             }
             const [objectBegin, o] = mobject;
             if (objectBegin !== prevEnd) {
                 // parse text before object
                 const value = this.r.substring(prevEnd, objectBegin);
-                objects.push(u('text', { value }));
+                objects.push(u('text', this.addPosition({ value }, prevEnd, objectBegin)));
             }
             // @ts-expect-error contentsBegin is not defined for "literals"
             const cbeg = o.contentsBegin;
@@ -312,7 +330,7 @@ class Parser {
         const text = this.r.rest();
         this.r.advance(text.length);
         if (text.trim().length) {
-            objects.push(u('text', { value: text }));
+            objects.push(u('text', this.addPosition({ value: text }, prevEnd, this.r.offset())));
         }
         return objects;
     }
@@ -399,7 +417,7 @@ class Parser {
             const o = this.tryParseObject(restriction);
             if (o) {
                 if (begin === this.r.offset()) {
-                    throw new Error('no progress (tryParseObject)');
+                    throw new Error('no progress (tryParseObject). If you see this, please report an issue to https://github.com/rasendubi/uniorg/issues.');
                 }
                 return [begin, o];
             }
@@ -548,7 +566,7 @@ class Parser {
             ? this.r.offset() + endOfSubtree.index
             : this.r.endOffset();
         this.r.resetOffset(contentsEnd);
-        return u('section', { contentsBegin, contentsEnd }, []);
+        return u('section', this.addPosition({ contentsBegin, contentsEnd }, contentsBegin, contentsEnd), []);
     }
     parseHeadline() {
         const begin = this.r.offset();
@@ -576,7 +594,7 @@ class Parser {
         // Reset line restriction.
         this.r.widen();
         this.parseEmptyLines();
-        return u('headline', {
+        return u('headline', this.addPosition({
             level,
             todoKeyword,
             priority,
@@ -585,10 +603,12 @@ class Parser {
             tags,
             contentsBegin,
             contentsEnd,
-        }, []);
+        }, begin, titleEnd), []);
     }
     parsePlanning() {
         this.r.narrow(this.r.offset(), this.r.offset() + this.r.line().length);
+        this.r.advance(this.r.match(/^[ \t]*/));
+        const begin = this.r.offset();
         let scheduled = null;
         let deadline = null;
         let closed = null;
@@ -607,20 +627,23 @@ class Parser {
             if (keyword === 'CLOSED:')
                 closed = time;
         }
+        const end = this.r.offset();
         this.r.widen();
         this.r.advance(this.r.line());
         this.parseEmptyLines();
-        return u('planning', { scheduled, deadline, closed });
+        return u('planning', this.addPosition({ scheduled, deadline, closed }, begin, end));
     }
     parsePropertyDrawer() {
+        const begin = this.r.offset();
         this.r.advance(this.r.line());
         const contentsBegin = this.r.offset();
         const endM = this.r.forceMatch(/^[ \t]*:END:[ \t]*$/im);
         this.r.advance(endM.index);
         const contentsEnd = this.r.offset();
         this.r.advance(this.r.line());
+        const end = this.r.offset();
         this.parseEmptyLines();
-        return u('property-drawer', { contentsBegin, contentsEnd }, []);
+        return u('property-drawer', this.addPosition({ contentsBegin, contentsEnd }, begin, end), []);
     }
     parseBlock(type, pattern, affiliated) {
         const endM = this.r.match(new RegExp(`^[ \\t]*#\\+end_${pattern}[ \\t]*$`, 'im'));
@@ -633,13 +656,14 @@ class Parser {
         const contentsEnd = begin + endM.index;
         this.r.resetOffset(contentsEnd);
         this.r.advance(this.r.line());
+        const end = this.r.offset();
         this.parseEmptyLines();
-        const _end = this.r.offset();
-        return u(type, { affiliated, contentsBegin, contentsEnd }, []);
+        return u(type, this.addPosition({ affiliated, contentsBegin, contentsEnd }, begin, end), []);
     }
     parseComment() {
         let valueLines = [];
         this.r.advance(this.r.forceLookingAt(/^[ \t]*# ?/));
+        const start = this.r.offset();
         valueLines.push(this.r.advance(this.r.line()));
         while (true) {
             const m = this.r.advance(this.r.lookingAt(/^[ \t]*#( |$)/m));
@@ -647,14 +671,19 @@ class Parser {
                 break;
             valueLines.push(this.r.advance(this.r.line()));
         }
+        let end = this.r.offset();
+        if (this.r.substring(end - 1, end) === '\n') {
+            end -= 1;
+        }
         let value = valueLines.join('');
         if (value[value.length - 1] === '\n') {
             value = value.substring(0, value.length - 1);
         }
-        return u('comment', { value: value });
+        return u('comment', this.addPosition({ value }, start, end));
     }
     parseFixedWidth(affiliated) {
         let valueLines = [];
+        const begin = this.r.offset();
         while (true) {
             const m = this.r.lookingAt(/^[ \t]*: ?(.*)$/m);
             if (!m)
@@ -663,7 +692,11 @@ class Parser {
             valueLines.push(m[1]);
         }
         const value = valueLines.join('\n');
-        return u('fixed-width', { affiliated, value });
+        let end = this.r.offset();
+        if (this.r.substring(end - 1, end) === '\n') {
+            end -= 1;
+        }
+        return u('fixed-width', this.addPosition({ affiliated, value }, begin, end));
     }
     parseCommentBlock(affiliated) {
         const comment = this.parseBlock('comment-block', 'comment', affiliated);
@@ -671,8 +704,9 @@ class Parser {
             // parsed as paragraph
             return comment;
         }
-        const value = this.r.substring(comment.contentsBegin, comment.contentsEnd);
-        return u('comment-block', { affiliated, value });
+        const { type: _, contentsBegin, contentsEnd, children, ...rest } = comment;
+        const value = this.r.substring(contentsBegin, contentsEnd);
+        return u('comment-block', { ...rest, value, affiliated });
     }
     parseSrcBlock(affiliated) {
         const endM = this.r.match(/^[ \t]*#\+end_src[ \t]*$/im);
@@ -688,16 +722,16 @@ class Parser {
         const value = unescapeCodeInString(this.r.substring(contentsBegin, contentsEnd));
         this.r.resetOffset(contentsEnd);
         this.r.advance(this.r.line());
+        const end = begin + endM.index + endM[0].length;
         this.parseEmptyLines();
-        const _end = this.r.offset();
-        return u('src-block', {
+        return u('src-block', this.addPosition({
             affiliated,
             language,
             switches: switches?.trim() ?? null,
             // using || to convert empty strings to null as well
             parameters: parameters.trim() || null,
             value,
-        });
+        }, begin, end));
     }
     parseExampleBlock(affiliated) {
         // TODO: parse switches
@@ -706,8 +740,9 @@ class Parser {
             // parsed as paragraph
             return block;
         }
-        const value = this.r.substring(block.contentsBegin, block.contentsEnd);
-        return u('example-block', { affiliated, value });
+        const { type: _, contentsBegin, contentsEnd, children, ...rest } = block;
+        const value = this.r.substring(contentsBegin, contentsEnd);
+        return u('example-block', { ...rest, value, affiliated });
     }
     parseExportBlock(affiliated) {
         const endM = this.r.match(/^[ \t]*#\+end_export[ \t]*$/im);
@@ -724,8 +759,8 @@ class Parser {
         this.r.resetOffset(contentsEnd);
         this.r.advance(this.r.line());
         this.parseEmptyLines();
-        const _end = this.r.offset();
-        return u('export-block', { affiliated, backend, value });
+        const end = begin + endM.index + endM[0].length;
+        return u('export-block', this.addPosition({ affiliated, backend, value }, begin, end));
     }
     parseSpecialBlock(affiliated) {
         const blockType = this.r.forceLookingAt(/[ \t]*#\+begin_(\S+)/i)[1];
@@ -741,8 +776,8 @@ class Parser {
         this.r.resetOffset(contentsEnd);
         this.r.advance(this.r.line());
         this.parseEmptyLines();
-        const _end = this.r.offset();
-        return u('special-block', { affiliated, blockType, contentsBegin, contentsEnd }, []);
+        const end = begin + endM.index + endM[0].length;
+        return u('special-block', this.addPosition({ affiliated, blockType, contentsBegin, contentsEnd }, begin, end), []);
     }
     parseAffiliatedKeywords() {
         const offset = this.r.offset();
@@ -765,7 +800,7 @@ class Parser {
             this.r.widen();
             this.r.advance(this.r.line());
             const isDual = dualKeywords.has(keyword);
-            const dualValue = isDual ? keywordM.groups.dualValue ?? null : null;
+            const dualValue = isDual ? (keywordM.groups.dualValue ?? null) : null;
             const value = dualValue === null ? mainValue : [mainValue, dualValue];
             if (multipleKeywords.has(keyword) ||
                 // Attributes can always appear on multiple lines.
@@ -789,9 +824,11 @@ class Parser {
         const m = this.r.forceLookingAt(/[ \t]*#\+(\S+):(.*)/);
         const key = m[1].toUpperCase();
         const value = m[2].trim();
+        const begin = this.r.offset();
         this.r.advance(this.r.line());
+        const end = this.r.offset();
         this.parseEmptyLines();
-        return u('keyword', { affiliated, key, value });
+        return u('keyword', this.addPosition({ affiliated, key, value }, begin, end));
     }
     parseLatexEnvironment(affiliated) {
         const beginOffset = this.r.offset();
@@ -807,15 +844,17 @@ class Parser {
         const endOffset = this.r.offset();
         this.parseEmptyLines();
         const value = this.r.substring(beginOffset, endOffset);
-        return u('latex-environment', { affiliated, value });
+        return u('latex-environment', this.addPosition({ affiliated, value }, beginOffset, endOffset));
     }
     parseDrawer(affiliated) {
+        const start = this.r.offset();
         const endM = this.r.match(/^[ \t]*:END:[ \t]*$/im);
         if (!endM) {
             this.r.message('incomplete drawer', this.r.offset(), 'uniorg');
             // Incomplete drawer: parse it as a paragraph.
             return this.parseParagraph(affiliated);
         }
+        const end = start + endM.index + endM[0].length;
         const contentsEnd = this.r.offset() + endM.index;
         const name = this.r.forceLookingAt(drawerRe)[1];
         this.r.advance(this.r.line());
@@ -823,28 +862,33 @@ class Parser {
         this.r.resetOffset(contentsEnd);
         this.r.advance(this.r.line());
         this.parseEmptyLines();
-        return u('drawer', { affiliated, name, contentsBegin, contentsEnd }, []);
+        return u('drawer', this.addPosition({ affiliated, name, contentsBegin, contentsEnd }, start, end), []);
     }
     parseClock() {
+        const start = this.r.offset();
         this.r.advance(this.r.forceMatch(/^[ \t]*CLOCK:[ \t]*/));
         const value = this.parseTimestamp();
         this.r.advance(this.r.match(/^[ \t]+=>[ \t]*/));
         const durationM = this.r.advance(this.r.lookingAt(/^(\S+)[ \t]*$/m));
         const duration = durationM ? durationM[1] : null;
         const status = duration ? 'closed' : 'running';
+        const end = this.r.offset();
         this.parseEmptyLines();
-        return u('clock', { value, duration, status });
+        return u('clock', this.addPosition({ value, duration, status }, start, end));
     }
     parseNodeProperty() {
+        const start = this.r.offset();
         const propertyRe = /^[ \t]*:(?<key>\S+):(?:(?<value1>$)|[ \t]+(?<value2>.*?))[ \t]*$/m;
         const m = this.r.forceLookingAt(propertyRe);
         const key = m.groups['key'];
         const value = m.groups['value1'] ?? m.groups['value2'];
+        const end = this.r.offset() + m.index + m[0].length;
         this.r.advance(this.r.line());
-        return u('node-property', { key, value });
+        return u('node-property', this.addPosition({ key, value }, start, end));
     }
     parseParagraph(affiliated) {
-        const contentsBegin = this.r.offset();
+        const begin = this.r.offset();
+        const contentsBegin = begin;
         this.r.advance(this.r.line());
         let next = null;
         while ((next = this.r.match(this.re.paragraphSeparateRe()))) {
@@ -893,11 +937,13 @@ class Parser {
             break;
         }
         const contentsEnd = next ? this.r.offset() : this.r.endOffset();
+        const end = contentsEnd;
         this.r.resetOffset(contentsEnd);
         this.parseEmptyLines();
-        return u('paragraph', { affiliated, contentsBegin, contentsEnd }, []);
+        return u('paragraph', this.addPosition({ affiliated, contentsBegin, contentsEnd }, begin, end), []);
     }
     parseFootnoteDefinition(affiliated) {
+        const start = this.r.offset();
         const m = this.r.forceLookingAt(footnoteDefinitionRe);
         const label = m[1];
         const begin = this.r.offset();
@@ -924,26 +970,32 @@ class Parser {
             }
             contentsEnd = this.r.offset();
         }
+        const end = contentsEnd;
         this.r.narrow(begin, contentsEnd);
         this.r.advance(this.r.forceMatch(/\][ \r\t\n]*/m));
         const contentsBegin = this.r.offset();
         this.r.widen();
         this.r.resetOffset(contentsEnd);
         this.parseEmptyLines();
-        return u('footnote-definition', { affiliated, label, contentsBegin, contentsEnd }, []);
+        return u('footnote-definition', this.addPosition({ affiliated, label, contentsBegin, contentsEnd }, start, end), []);
     }
     parseHorizontalRule(affiliated) {
+        const start = this.r.offset();
         this.r.advance(this.r.line());
+        const end = this.r.offset();
         this.parseEmptyLines();
-        return u('horizontal-rule', { affiliated });
+        return u('horizontal-rule', this.addPosition({ affiliated }, start, end));
     }
     parseDiarySexp(affiliated) {
+        const start = this.r.offset();
         const value = this.r.forceLookingAt(/^(%%\(.*)[ \t]*$/m)[1];
         this.r.advance(this.r.line());
+        const end = this.r.offset();
         this.parseEmptyLines();
-        return u('diary-sexp', { affiliated, value });
+        return u('diary-sexp', this.addPosition({ affiliated, value }, start, end));
     }
     parseTable(affiliated) {
+        const start = this.r.offset();
         const contentsBegin = this.r.offset();
         const tableType = this.r.lookingAt(/^[ \t]*\|/)
             ? 'org'
@@ -960,40 +1012,46 @@ class Parser {
             tblfm = tblfm + tblfmM[1];
             this.r.advance(this.r.line());
         }
+        const end = this.r.offset();
         this.parseEmptyLines();
         if (tableType === 'org') {
-            return u('table', { tableType, tblfm, contentsBegin, contentsEnd }, []);
+            return u('table', this.addPosition({ tableType, tblfm, contentsBegin, contentsEnd }, start, end), []);
         }
         else {
-            return u('table', {
+            return u('table', this.addPosition({
                 affiliated,
                 tableType,
                 tblfm,
                 value: this.r.substring(contentsBegin, contentsEnd),
-            });
+            }, start, end));
         }
     }
     parseTableRow() {
+        const start = this.r.offset();
         const rowType = this.r.lookingAt(/^[ \t]*\|-/)
             ? 'rule'
             : 'standard';
         this.r.advance(this.r.forceMatch(/\|/));
         const contentsBegin = this.r.offset();
         this.r.advance(this.r.forceMatch(/^.*?[ \t]*$/m));
+        const end = this.r.offset();
         // A table rule has no contents. In that case, ensure
         // contentsBegin matches contentsEnd.
         const contentsEnd = rowType === 'rule' ? contentsBegin : this.r.offset();
         this.r.advance(this.r.line());
-        return u('table-row', { rowType, contentsBegin, contentsEnd }, []);
+        return u('table-row', this.addPosition({ rowType, contentsBegin, contentsEnd }, start, end), []);
     }
     parseTableCell() {
+        const start = this.r.offset();
         this.r.advance(this.r.forceLookingAt(/^[ \t]*/));
         const contentsBegin = this.r.offset();
         const m = this.r.advance(this.r.forceLookingAt(/(.*?)[ \t]*(?:\||$)/m));
         const contentsEnd = contentsBegin + m[1].length;
-        return u('table-cell', { contentsBegin, contentsEnd }, []);
+        const end = contentsBegin + m[0].length;
+        return u('table-cell', this.addPosition({ contentsBegin, contentsEnd }, start, end), []);
     }
     parseList(structure, affiliated) {
+        const start = this.r.offset();
         const contentsBegin = this.r.offset();
         const item = structure.find((x) => x.begin === contentsBegin);
         if (!item) {
@@ -1014,7 +1072,8 @@ class Parser {
         }
         const contentsEnd = pos;
         this.r.resetOffset(contentsEnd);
-        return u('plain-list', {
+        const end = this.r.offset();
+        return u('plain-list', this.addPosition({
             affiliated,
             indent,
             listType,
@@ -1023,10 +1082,10 @@ class Parser {
             // Exposing structure here is temporary as it gets removed in parseElements(). It is only exposed so
             // that parseElements() can pick it up and use it for parsing list items.
             structure,
-        }, []);
+        }, start, end), []);
     }
     parseListItem(structure) {
-        const offset = this.r.offset();
+        const start = this.r.offset();
         const m = this.r.advance(this.r.forceMatch(this.re.fullListItemRe()));
         const bullet = m.groups.bullet;
         const counter = m.groups.counter ?? null;
@@ -1037,11 +1096,12 @@ class Parser {
                 : m.groups.checkbox === '[-]'
                     ? 'trans'
                     : null;
-        const item = structure.find((x) => x.begin === offset);
+        const item = structure.find((x) => x.begin === start);
         const contentsBegin = this.r.offset();
         const contentsEnd = item.end;
         this.r.resetOffset(contentsEnd);
-        return u('list-item', {
+        const end = this.r.offset();
+        return u('list-item', this.addPosition({
             indent: item.indent,
             bullet,
             counter,
@@ -1049,7 +1109,7 @@ class Parser {
             contentsBegin,
             contentsEnd,
             structure,
-        }, item.tag ? [item.tag] : []);
+        }, start, end), item.tag ? [item.tag] : []);
     }
     parseListStructure() {
         const items = [];
@@ -1152,8 +1212,8 @@ class Parser {
         const begin = start + m[1].length;
         const contentsBegin = begin + m[2].length + (inside ? 1 : 0);
         const contentsEnd = begin + m[2].length + m[3].length - (inside ? 1 : 0);
-        const _end = this.r.offset();
-        return u('superscript', { contentsBegin, contentsEnd, children: [] });
+        const end = this.r.offset();
+        return u('superscript', this.addPosition({ contentsBegin, contentsEnd }, begin, end), []);
     }
     parseSubscript() {
         if (!this.options.useSubSuperscripts) {
@@ -1170,10 +1230,11 @@ class Parser {
         const begin = start + m[1].length;
         const contentsBegin = begin + m[2].length + (inside ? 1 : 0);
         const contentsEnd = begin + m[2].length + m[3].length - (inside ? 1 : 0);
-        const _end = this.r.offset();
-        return u('subscript', { contentsBegin, contentsEnd, children: [] });
+        const end = this.r.offset();
+        return u('subscript', this.addPosition({ contentsBegin, contentsEnd }, begin, end), []);
     }
     parseUnderline() {
+        const start = this.r.offset();
         // backoff one char to check border
         this.r.backoff(1);
         const m = this.r.lookingAt(this.re.emphRe());
@@ -1182,9 +1243,11 @@ class Parser {
         const contentsBegin = this.r.offset() + m.index + m[1].length + m[3].length;
         const contentsEnd = contentsBegin + m[4].length;
         this.r.resetOffset(contentsEnd + 1);
-        return u('underline', { contentsBegin, contentsEnd }, []);
+        const end = this.r.offset();
+        return u('underline', this.addPosition({ contentsBegin, contentsEnd }, start, end), []);
     }
     parseBold() {
+        const start = this.r.offset();
         // backoff one char to check border
         this.r.backoff(1);
         const m = this.r.lookingAt(this.re.emphRe());
@@ -1193,9 +1256,11 @@ class Parser {
         const contentsBegin = this.r.offset() + m.index + m[1].length + m[3].length;
         const contentsEnd = contentsBegin + m[4].length;
         this.r.resetOffset(contentsEnd + 1);
-        return u('bold', { contentsBegin, contentsEnd }, []);
+        const end = this.r.offset();
+        return u('bold', this.addPosition({ contentsBegin, contentsEnd }, start, end), []);
     }
     parseItalic() {
+        const start = this.r.offset();
         // backoff one char to check border
         this.r.backoff(1);
         const m = this.r.lookingAt(this.re.emphRe());
@@ -1204,9 +1269,11 @@ class Parser {
         const contentsBegin = this.r.offset() + m.index + m[1].length + m[3].length;
         const contentsEnd = contentsBegin + m[4].length;
         this.r.resetOffset(contentsEnd + 1);
-        return u('italic', { contentsBegin, contentsEnd }, []);
+        const end = this.r.offset();
+        return u('italic', this.addPosition({ contentsBegin, contentsEnd }, start, end), []);
     }
     parseCode() {
+        const start = this.r.offset();
         // backoff one char to check border
         this.r.backoff(1);
         const m = this.r.lookingAt(this.re.verbatimRe());
@@ -1216,9 +1283,11 @@ class Parser {
         const contentsBegin = this.r.offset() + m.index + m[1].length + m[3].length;
         const contentsEnd = contentsBegin + m[4].length;
         this.r.resetOffset(contentsEnd + 1);
-        return u('code', { value }, []);
+        const end = this.r.offset();
+        return u('code', this.addPosition({ value }, start, end), []);
     }
     parseVerbatim() {
+        const start = this.r.offset();
         this.r.backoff(1);
         const m = this.r.lookingAt(this.re.verbatimRe());
         if (!m)
@@ -1227,9 +1296,11 @@ class Parser {
         const contentsBegin = this.r.offset() + m.index + m[1].length + m[3].length;
         const contentsEnd = contentsBegin + m[4].length;
         this.r.resetOffset(contentsEnd + 1);
-        return u('verbatim', { value }, []);
+        const end = this.r.offset();
+        return u('verbatim', this.addPosition({ value }, start, end), []);
     }
     parseStrikeThrough() {
+        const start = this.r.offset();
         // backoff one char to check border
         this.r.backoff(1);
         const m = this.r.lookingAt(this.re.emphRe());
@@ -1238,7 +1309,8 @@ class Parser {
         const contentsBegin = this.r.offset() + m.index + m[1].length + m[3].length;
         const contentsEnd = contentsBegin + m[4].length;
         this.r.resetOffset(contentsEnd + 1);
-        return u('strike-through', { contentsBegin, contentsEnd }, []);
+        const end = this.r.offset();
+        return u('strike-through', this.addPosition({ contentsBegin, contentsEnd }, start, end), []);
     }
     parseStatisticsCookie() {
         const begin = this.r.offset();
@@ -1249,9 +1321,10 @@ class Parser {
         const value = this.r.substring(begin, end);
         // skip trailing whitespace
         const postBlank = this.r.advance(this.r.forceLookingAt(/\s*/))[0].length;
-        return u('statistics-cookie', { begin, end, value, postBlank });
+        return u('statistics-cookie', this.addPosition({ begin, end, value, postBlank }, begin, end));
     }
     parseEntity() {
+        const start = this.r.offset();
         const m = this.r.advance(this.r.lookingAt(/^\\(?:(?<value1>_ +)|(?<value2>there4|sup[123]|frac[13][24]|[a-zA-Z]+)(?<brackets>$|\{\}|\P{Letter}))/mu));
         if (!m)
             return null;
@@ -1262,12 +1335,14 @@ class Parser {
             // as text later.
             this.r.backoff(m.groups.brackets.length);
         }
+        const end = this.r.offset();
         const value = getOrgEntity(m.groups.value1 ?? m.groups.value2);
         if (!value)
             return null;
-        return u('entity', { useBrackets: hasBrackets, ...value });
+        return u('entity', this.addPosition({ useBrackets: hasBrackets, ...value }, start, end));
     }
     parseExportSnippet() {
+        const start = this.r.offset();
         const m = this.r.advance(this.r.lookingAt(/@@([-A-Za-z0-9]+):/));
         if (!m)
             return null;
@@ -1276,9 +1351,10 @@ class Parser {
         const mend = this.r.advance(this.r.match(/@@/));
         if (!mend)
             return null;
-        const contentsEnd = this.r.offset() - 2; // exclude @@
+        const end = this.r.offset();
+        const contentsEnd = end - 2; // exclude @@
         const value = this.r.substring(contentsBegin, contentsEnd);
-        return u('export-snippet', { backEnd, value });
+        return u('export-snippet', this.addPosition({ backEnd, value }, start, end));
     }
     parseLatexFragment() {
         const begin = this.r.offset();
@@ -1324,9 +1400,10 @@ class Parser {
         if (begin === end)
             return null;
         const value = this.r.substring(begin, end);
-        return u('latex-fragment', { value, contents: contents ?? value });
+        return u('latex-fragment', this.addPosition({ value, contents: contents ?? value }, begin, end));
     }
     parseLineBreak() {
+        const start = this.r.offset();
         const m = this.r.lookingAt(/\\\\[ \t]*$/m);
         if (!m)
             return null;
@@ -1334,8 +1411,9 @@ class Parser {
         this.r.backoff(1);
         if (this.r.peek(1) === '\\')
             return null;
+        const end = start + m[0].length;
         this.r.advance(this.r.line());
-        return u('line-break');
+        return u('line-break', this.addPosition({}, start, end));
     }
     parseFootnoteReference() {
         const begin = this.r.offset();
@@ -1366,21 +1444,17 @@ class Parser {
             ? 'inline'
             : 'standard';
         const label = footnoteType === 'inline'
-            ? m.groups.label_inline ?? null
+            ? (m.groups.label_inline ?? null)
             : m.groups.label;
         if (footnoteType === 'inline') {
-            return u('footnote-reference', {
-                label,
-                footnoteType,
-                contentsBegin,
-                contentsEnd,
-            }, []);
+            return u('footnote-reference', this.addPosition({ label, footnoteType, contentsBegin, contentsEnd }, begin, end), []);
         }
         else {
-            return u('footnote-reference', { label, footnoteType }, []);
+            return u('footnote-reference', this.addPosition({ label, footnoteType }, begin, end), []);
         }
     }
     parseCitation() {
+        const start = this.r.offset();
         let m = this.r.lookingAt(this.re.citationPrefixRe());
         if (!m)
             return null;
@@ -1400,7 +1474,7 @@ class Parser {
             return null;
         }
         this.r.resetOffset(end);
-        const cite = {
+        const cite = this.addPosition({
             type: 'citation',
             style,
             begin,
@@ -1410,7 +1484,7 @@ class Parser {
             contentsBegin,
             contentsEnd,
             children: [],
-        };
+        }, start, end);
         return cite;
     }
     parseCitationCommonPrefix() {
@@ -1428,12 +1502,12 @@ class Parser {
             return null;
         }
         const end = contentsEnd + ';'.length;
-        const prefix = {
+        const prefix = this.addPosition({
             type: 'citation-common-prefix',
             contentsBegin,
             contentsEnd,
             children: [],
-        };
+        }, begin, end);
         this.r.resetOffset(end);
         return prefix;
     }
@@ -1449,7 +1523,7 @@ class Parser {
         const separator = mSeparator ? this.r.offset() + mSeparator.index : null;
         const contentsEnd = separator ?? this.r.endOffset();
         const end = separator ? separator + 1 : this.r.endOffset();
-        const reference = {
+        const reference = this.addPosition({
             type: 'citation-reference',
             key,
             begin,
@@ -1457,7 +1531,7 @@ class Parser {
             contentsBegin,
             contentsEnd,
             children: [],
-        };
+        }, begin, end);
         this.r.resetOffset(end);
         return reference;
     }
@@ -1472,12 +1546,12 @@ class Parser {
         const contentsEnd = end;
         if (begin === end)
             return null;
-        const prefix = {
+        const prefix = this.addPosition({
             type: 'citation-prefix',
             contentsBegin,
             contentsEnd,
             children: [],
-        };
+        }, begin, end);
         return prefix;
     }
     parseCitationCommonSuffix() {
@@ -1488,23 +1562,25 @@ class Parser {
         if (contentsBegin === contentsEnd)
             return null;
         this.r.resetOffset(contentsEnd);
-        return {
+        return this.addPosition({
             type: 'citation-common-suffix',
             contentsBegin,
             contentsEnd,
             children: [],
-        };
+        }, contentsBegin, contentsEnd);
     }
     parseCitationKey() {
+        const start = this.r.offset();
         const m = this.r.match(this.re.citationKeyRe());
         if (!m)
             return null;
         this.r.advance(m);
+        const end = this.r.offset();
         const key = m.groups['key'];
-        return {
+        return this.addPosition({
             type: 'citation-key',
             key,
-        };
+        }, start, end);
     }
     parseCitationSuffix() {
         // this is called after key, so just parse till the end of
@@ -1514,12 +1590,12 @@ class Parser {
         if (contentsBegin === contentsEnd)
             return null;
         this.r.resetOffset(contentsEnd);
-        return {
+        return this.addPosition({
             type: 'citation-suffix',
             contentsBegin,
             contentsEnd,
             children: [],
-        };
+        }, contentsBegin, contentsEnd);
     }
     scanLists() {
         const start = this.r.offset();
@@ -1539,7 +1615,7 @@ class Parser {
         this.r.resetOffset(start);
         return depth === 0
             ? end
-            : // didn’t find matching closing parenthesis
+            : // didn't find matching closing parenthesis
                 null;
     }
     parseLink() {
@@ -1573,13 +1649,13 @@ class Parser {
                 .replace(/(\\+)([\[\]])/g, (p1, p2) => '\\'.repeat(p1.length / 2) + p2);
             // TODO: org-link-expand-abbrev
             const { linkType, path } = this.linkType(rawLink);
-            return u('link', {
+            return u('link', this.addPosition({
                 format: 'bracket',
                 linkType,
                 rawLink,
                 path,
                 ...contents,
-            }, []);
+            }, initialOffset, this.r.offset()), []);
         }
         // TODO: this is different from OrgRegexUtils.linkPlainRe
         // Type 3: Plain link, e.g., https://orgmode.org
@@ -1587,12 +1663,12 @@ class Parser {
         const plainM = this.r.advance(this.r.lookingAt(linkPlainRe));
         if (plainM) {
             const m = plainM;
-            return u('link', {
+            return u('link', this.addPosition({
                 format: 'plain',
                 linkType: m[1],
                 rawLink: m[0],
                 path: m[2],
-            }, []);
+            }, initialOffset, this.r.offset()), []);
         }
         // Type 4: Angular link, e.g., <https://orgmode.org>. Unlike
         // bracket links, follow RFC 3986 and remove any extra whitespace
@@ -1604,7 +1680,7 @@ class Parser {
             const linkType = m[1];
             const rawLink = m[0].substring(1, m[0].length - 1); // strip < >
             const path = m[2].replace(/[ \t]*\n[ \t]*/g, '');
-            return u('link', { format: 'angle', linkType, rawLink, path }, []);
+            return u('link', this.addPosition({ format: 'angle', linkType, rawLink, path }, initialOffset, this.r.offset()), []);
         }
         return null;
     }
@@ -1643,6 +1719,7 @@ class Parser {
         ].join('|'));
         if (!this.r.lookingAt(timestampRe))
             return null;
+        const contentsBegin = this.r.offset();
         const active = this.r.substring(this.r.offset(), this.r.offset() + 1) === '<';
         const m = this.r.advance(this.r.match(/^([<[](%%)?.*?)[\]>](?:--([<[].*?[\]>]))?/));
         if (!m)
@@ -1677,12 +1754,13 @@ class Parser {
                 : timeRange
                     ? { ...start, ...timeRange }
                     : null;
-        return u('timestamp', {
+        const contentsEnd = this.r.offset();
+        return u('timestamp', this.addPosition({
             timestampType,
             rawValue,
             start,
             end,
-        });
+        }, contentsBegin, contentsEnd));
     }
     // Helpers
     static parseDate(s) {