@the_dissidents/libemmm 0.0.4 → 0.0.7

package/README.md

@@ -83,9 +83,9 @@ You can also use the brackets without a modifier. However, this has little effec
 Suppose the modifier `[.pre]` accepts a preformatted block:
 
 ```
-[.pre] Preformatted content, suitable for code and ASCII art. Always treated as plain text, even if I write [.foo] or [/foo] or \[.
+[.pre] This is preformatted content, suitable for code and ASCII art. Always treated as plain text, even if I write [.foo] or [/foo] or \[.
 
-However, like in a normal paragraph, a blank line creates a new block so this is no longer in the pre. Use brackets:
+However, like in a normal paragraph, a blank line creates a new block so this is no longer in the pre. Use brackets if you don't want that:
 
 [.pre]
 :--
@@ -104,7 +104,7 @@ Use a `;` before `]` to signify empty content. Modifiers that don't accept conte
 [.pre;]
 ```
 
-In normal paragraphs, use a slash `\` to **escape** the character immediately after it, so that it will not be interpreted as a special character (e.g. the beginning of a modifier).
+In normal paragraphs, you can use a backslash `\` to **escape** a character immediately after it, so that it will not be interpreted as a special character (e.g. the beginning of a modifier).
 
 **Inline modifiers** are similar to block modifiers, but occur in paragraphs. They are written as `[/baa]` or `[/baa args]`. If accepting content, use `[;]` to mark the end of their scope.
 
@@ -159,10 +159,10 @@ A colon before the first argument states explicitly the beginning of that argume
 
 ### System modifiers
 
-[**-define-block** *name*:*args...*]  
-[**-define-block** *name*:*args...*:(*slot*)]  
-[**-define-inline** *name*:*args...*]  
-[**-define-inline** *name*:*args...*:(*slot*)]  
+[**-define-block** *name*:*args...*] *content*  
+[**-define-block** *name*:*args...*:(*slot*)] *content*  
+[**-define-inline** *name*:*args...*] *content*  
+[**-define-inline** *name*:*args...*:(*slot*)] *content*  
 
 > Define a new modifier. The first argument is the name. If one or more arguments exist, and the last is enclosed in `()`, it is taken as the **slot name** (more on that later). The rest in the middle are names for the arguments.
 > 
@@ -174,15 +174,15 @@ A colon before the first argument states explicitly the beginning of that argume
 > 
 > You can't reassign arguments, only variables. Since arguments always take precedence over variables, "reassigning" them has no effect inside a definition and can only confuse the rest of the code.
 
-[**-define-block-prefix** *prefix*]  
-[**-define-block-prefix** *prefix*:(*slot*)]
+[**-define-block-prefix** *prefix*] *content*  
+[**-define-block-prefix** *prefix*:(*slot*)] *content*
 
 > Not implemented yet
 
-[**-define-inline-shorthand** *prefix*]  
-[**-define-inline-shorthand** *prefix*:(*slot*):*postfix*]  
-[**-define-inline-shorthand** *prefix*:*arg1*:*mid1*:*arg2*:*mid2*...]  
-[**-define-inline-shorthand** *prefix*:*arg1*:*mid1*:*arg2*:*mid2*...:(*slot*):*postfix*]  
+[**-define-inline-shorthand** *prefix*] *content*  
+[**-define-inline-shorthand** *prefix*:(*slot*):*postfix*] *content*  
+[**-define-inline-shorthand** *prefix*:*arg1*:*mid1*:*arg2*:*mid2*...] *content*  
+[**-define-inline-shorthand** *prefix*:*arg1*:*mid1*:*arg2*:*mid2*...:(*slot*):*postfix*] *content*  
 
 > Defines an inline shorthand. A shorthand notation consists of a prefix, zero or more pairs of argument and middle part, and optionally a slot and a postfix. You must specify a slot name if you want to use one, although you can specify an empty one using `()`. You may also specify an *empty* last argument, i.e. a `:` before the `]` that ends the modifier head, to make the postfix stand out better.
 > ```
@@ -222,14 +222,22 @@ A colon before the first argument states explicitly the beginning of that argume
 > ```
 > Note the first, unnamed `.slot` refers to the slot of `q`.
 
-[**.module** *module-name*]
+[**.module** *module-name*] *content*
 
 > Causes the definitions in the content to become part of a **module**. They don't take effect outside the `[.module]` modifier *unless* activated by a `[.use]` or `[-use]` modifier.
 
-[**.use** *module-name*]
+[**.use** *module-name*] *content*
 
 > Activates the definitions in a module for the content *within this modifier*. Use `[-use]` to activate for the whole document instead.
 
+[**.ifdef** *id*] *content*
+
+> Expands to the content if the variable or argument *id* is defined, or nothing if it's not.
+
+[**.ifndef** *id*] *content*
+
+> Expands to the content if the variable or argument *id* is undefined, or nothing if it's defined.
+
 ### Inline modifiers
 
 [**/slot**]  
@@ -245,6 +253,11 @@ A colon before the first argument states explicitly the beginning of that argume
 
 > Expands to the value of the arguments, separated by nothing, as plain text.
 
+[**/ifdef** *id*] *content* [;]  
+[**/ifndef** *id*] *content* [;]
+
+> See the similarly named block modifiers.
+
 ### Interpolators
 
 **$(** *varid* **)**

package/dist/index.d.mts

@@ -6,6 +6,35 @@ declare enum DebugLevel {
     None = 4
 }
 
+type SourceDescriptor = {
+    readonly name: string;
+};
+interface Source extends SourceDescriptor {
+    readonly nLines: number;
+    /**
+     * Return the row- and column-index corresponding to a given location. The indices are zero-based.
+     */
+    getRowCol(loc: number): [row: number, col: number];
+    /**
+     * Returns the position of the start of line `n` (zero-based). If `n` is zero, returns zero. If the source contains less than `n` lines, returns `Infinity`.
+     */
+    getLineStart(n: number): number;
+    /**
+     * Returns the content line `n`. If the source contains less than `n` lines, returns `Infinity`.
+     */
+    getLine(n: number): string | undefined;
+}
+declare class StringSource implements Source {
+    private readonly src;
+    readonly name: string;
+    readonly nLines: number;
+    private readonly lineMap;
+    constructor(d: SourceDescriptor, src: string);
+    getRowCol(pos: number): [row: number, col: number];
+    getLineStart(n: number): number;
+    getLine(n: number): string | undefined;
+}
+
 declare class NameManager<T extends {
     name: string;
 }> {
@@ -43,6 +72,14 @@ declare class Document {
     readonly messages: readonly Message[];
     constructor(root: RootNode, context: ParseContext, messages: readonly Message[]);
     toStripped(): Document;
+    /**
+     * Performs a depth-first walk of the node tree.
+     */
+    walk(callback: (node: BlockEntity | InlineEntity | ArgumentEntity) => 'skip' | 'break' | 'continue'): void;
+    /**
+     * Gets all nodes that covers the given position, from outermost to innermost (essentially a path).
+     */
+    resolvePosition(pos: number): (BlockEntity | InlineEntity | ArgumentEntity)[];
 }
 interface ReadonlyConfiguration {
     readonly initializers: readonly ((cxt: ParseContext) => void)[];
@@ -77,12 +114,9 @@ type Message = {
     readonly info: string;
     readonly code: number;
 };
-type SourceDescriptor = {
-    name: string;
-};
 type LocationRange = {
     original?: LocationRange;
-    source: SourceDescriptor;
+    source: Source;
     start: number;
     end: number;
     actualEnd?: number;
@@ -155,7 +189,7 @@ type InlineModifierNode<TState> = {
 type RootNode = {
     type: NodeType.Root;
     content: BlockEntity[];
-    source: SourceDescriptor;
+    source: Source;
 };
 type ModifierNode<T = any> = BlockModifierNode<T> | InlineModifierNode<T> | SystemModifierNode<T>;
 type BlockEntity = ParagraphNode | PreNode | BlockModifierNode<any> | SystemModifierNode<any>;
@@ -187,22 +221,38 @@ declare class ModifierBase<TNode, TEntity> {
     constructor(name: string, slotType?: ModifierSlotType, args?: Partial<ModifierBase<TNode, TEntity>>);
     roleHint?: string;
     /**
-     * If true, any modifier encountered in the content of it will *not* be expanded, *unless* that modifier is `alwaysTryExpand`.
+     * If true, any modifier encountered inside it will *not* be expanded *during parse-content*,
+     * *unless* that modifier is `alwaysTryExpand`. In the vast majority of cases, you shouldn't
+     * be using this.
      */
     delayContentExpansion: boolean;
     /**
-     * If true, such a modifier will always be expanded whenever it is encountered, *even if* contained in a modifier with `delayContentExpansion`.
+     * If true, such a modifier will always be expanded whenever it is encountered, *even if*
+     * contained in a modifier with `delayContentExpansion`. In the vast majority of cases,
+     * you shouldn't be using this.
      */
     alwaysTryExpand: boolean;
-    /** Called before the modifier's content is parsed. */
+    /** Called before the modifier's content is parsed.
+     * @param immediate False when the node is inside a `delayContentExpansion` modifier, but it is `alwaysTryExpand`; otherwise true.
+    */
     beforeParseContent?: (node: TNode, cxt: ParseContext, immediate: boolean) => Message[];
-    /** Called after the modifier's content is parsed. */
+    /** Called after the modifier's content is parsed.
+     * @param immediate False when the node is inside a `delayContentExpansion` modifier, but it is `alwaysTryExpand`; otherwise true.
+    */
     afterParseContent?: (node: TNode, cxt: ParseContext, immediate: boolean) => Message[];
-    /** Called before reparsing of the expansion. */
+    /** Called before reparsing of the expansion.
+     * @param immediate False when the node is inside a `delayContentExpansion` modifier, but it is `alwaysTryExpand`; otherwise true.*/
     beforeProcessExpansion?: (node: TNode, cxt: ParseContext, immediate: boolean) => Message[];
-    /** Called before reparsing of the expansion. */
+    /** Called before reparsing of the expansion.
+     * @param immediate False when the node is inside a `delayContentExpansion` modifier, but it is `alwaysTryExpand`; otherwise true.*/
     afterProcessExpansion?: (node: TNode, cxt: ParseContext, immediate: boolean) => Message[];
+    /**
+     * @param immediate False when the node is inside a `delayContentExpansion` modifier, but it is `alwaysTryExpand`; otherwise true.
+     */
     prepareExpand?: (node: TNode, cxt: ParseContext, immediate: boolean) => Message[];
+    /**
+     * @param immediate False when the node is inside a `delayContentExpansion` modifier, but it is `alwaysTryExpand`; otherwise true.
+     */
     expand?: (node: TNode, cxt: ParseContext, immediate: boolean) => TEntity[] | undefined;
 }
 declare class BlockModifierDefinition<TState> extends ModifierBase<BlockModifierNode<TState>, BlockEntity> {
@@ -229,9 +279,9 @@ type InlineShorthand<TState> = Shorthand<InlineModifierDefinition<TState>>;
 
 declare class SimpleScanner implements Scanner {
     private src;
-    readonly source: SourceDescriptor;
+    readonly source: Source;
     private pos;
-    constructor(src: string, source?: SourceDescriptor);
+    constructor(src: string, sourceDesc?: SourceDescriptor);
     position(): number;
     isEOF(): boolean;
     peek(str: string): boolean;
@@ -240,7 +290,7 @@ declare class SimpleScanner implements Scanner {
     acceptWhitespaceChar(): string | null;
 }
 interface Scanner {
-    readonly source: SourceDescriptor;
+    readonly source: Source;
     position(): number;
     isEOF(): boolean;
     peek(str: string): boolean;
@@ -425,7 +475,7 @@ declare class UnnecessaryNewlineMessage extends RemoveThingMessage {
 declare class NewBlockShouldBeOnNewlineMessage extends AddThingMessage {
     constructor(location: LocationRange);
 }
-declare class ContentShouldBeOnNewlineMessage extends AddThingMessage {
+declare class ShouldBeOnNewlineMessage extends AddThingMessage {
     constructor(location: LocationRange);
 }
 declare class NameAlreadyDefinedMessage implements Message {
@@ -468,8 +518,6 @@ type messages_CannotExpandArgumentMessage = CannotExpandArgumentMessage;
 declare const messages_CannotExpandArgumentMessage: typeof CannotExpandArgumentMessage;
 type messages_CannotUseModuleInSelfMessage = CannotUseModuleInSelfMessage;
 declare const messages_CannotUseModuleInSelfMessage: typeof CannotUseModuleInSelfMessage;
-type messages_ContentShouldBeOnNewlineMessage = ContentShouldBeOnNewlineMessage;
-declare const messages_ContentShouldBeOnNewlineMessage: typeof ContentShouldBeOnNewlineMessage;
 type messages_EitherNormalOrPreMessage = EitherNormalOrPreMessage;
 declare const messages_EitherNormalOrPreMessage: typeof EitherNormalOrPreMessage;
 type messages_EntityNotAllowedMessage = EntityNotAllowedMessage;
@@ -494,6 +542,8 @@ type messages_OverwriteSpecialVariableMessage = OverwriteSpecialVariableMessage;
 declare const messages_OverwriteSpecialVariableMessage: typeof OverwriteSpecialVariableMessage;
 type messages_ReachedRecursionLimitMessage = ReachedRecursionLimitMessage;
 declare const messages_ReachedRecursionLimitMessage: typeof ReachedRecursionLimitMessage;
+type messages_ShouldBeOnNewlineMessage = ShouldBeOnNewlineMessage;
+declare const messages_ShouldBeOnNewlineMessage: typeof ShouldBeOnNewlineMessage;
 type messages_SlotUsedOutsideDefinitionMessage = SlotUsedOutsideDefinitionMessage;
 declare const messages_SlotUsedOutsideDefinitionMessage: typeof SlotUsedOutsideDefinitionMessage;
 type messages_UnclosedInlineModifierMessage = UnclosedInlineModifierMessage;
@@ -505,7 +555,7 @@ declare const messages_UnknownModifierMessage: typeof UnknownModifierMessage;
 type messages_UnnecessaryNewlineMessage = UnnecessaryNewlineMessage;
 declare const messages_UnnecessaryNewlineMessage: typeof UnnecessaryNewlineMessage;
 declare namespace messages {
-  export { messages_ArgumentCountMismatchMessage as ArgumentCountMismatchMessage, messages_CannotExpandArgumentMessage as CannotExpandArgumentMessage, messages_CannotUseModuleInSelfMessage as CannotUseModuleInSelfMessage, messages_ContentShouldBeOnNewlineMessage as ContentShouldBeOnNewlineMessage, messages_EitherNormalOrPreMessage as EitherNormalOrPreMessage, messages_EntityNotAllowedMessage as EntityNotAllowedMessage, messages_ExpectedMessage as ExpectedMessage, messages_InvalidArgumentMessage as InvalidArgumentMessage, messages_MultipleBlocksNotPermittedMessage as MultipleBlocksNotPermittedMessage, messages_NameAlreadyDefinedMessage as NameAlreadyDefinedMessage, messages_NewBlockShouldBeOnNewlineMessage as NewBlockShouldBeOnNewlineMessage, messages_NoNestedModuleMessage as NoNestedModuleMessage, messages_OnlySimpleParagraphsPermittedMessage as OnlySimpleParagraphsPermittedMessage, messages_OverwriteDefinitionsMessage as OverwriteDefinitionsMessage, messages_OverwriteSpecialVariableMessage as OverwriteSpecialVariableMessage, messages_ReachedRecursionLimitMessage as ReachedRecursionLimitMessage, messages_SlotUsedOutsideDefinitionMessage as SlotUsedOutsideDefinitionMessage, messages_UnclosedInlineModifierMessage as UnclosedInlineModifierMessage, messages_UndefinedVariableMessage as UndefinedVariableMessage, messages_UnknownModifierMessage as UnknownModifierMessage, messages_UnnecessaryNewlineMessage as UnnecessaryNewlineMessage };
+  export { messages_ArgumentCountMismatchMessage as ArgumentCountMismatchMessage, messages_CannotExpandArgumentMessage as CannotExpandArgumentMessage, messages_CannotUseModuleInSelfMessage as CannotUseModuleInSelfMessage, messages_EitherNormalOrPreMessage as EitherNormalOrPreMessage, messages_EntityNotAllowedMessage as EntityNotAllowedMessage, messages_ExpectedMessage as ExpectedMessage, messages_InvalidArgumentMessage as InvalidArgumentMessage, messages_MultipleBlocksNotPermittedMessage as MultipleBlocksNotPermittedMessage, messages_NameAlreadyDefinedMessage as NameAlreadyDefinedMessage, messages_NewBlockShouldBeOnNewlineMessage as NewBlockShouldBeOnNewlineMessage, messages_NoNestedModuleMessage as NoNestedModuleMessage, messages_OnlySimpleParagraphsPermittedMessage as OnlySimpleParagraphsPermittedMessage, messages_OverwriteDefinitionsMessage as OverwriteDefinitionsMessage, messages_OverwriteSpecialVariableMessage as OverwriteSpecialVariableMessage, messages_ReachedRecursionLimitMessage as ReachedRecursionLimitMessage, messages_ShouldBeOnNewlineMessage as ShouldBeOnNewlineMessage, messages_SlotUsedOutsideDefinitionMessage as SlotUsedOutsideDefinitionMessage, messages_UnclosedInlineModifierMessage as UnclosedInlineModifierMessage, messages_UndefinedVariableMessage as UndefinedVariableMessage, messages_UnknownModifierMessage as UnknownModifierMessage, messages_UnnecessaryNewlineMessage as UnnecessaryNewlineMessage };
 }
 
 declare const BuiltinConfiguration: ReadonlyConfiguration;
@@ -544,11 +594,15 @@ declare const debugPrint: {
     blockShorthand: (x: BlockShorthand<any>) => string;
     argument: (arg: ModifierArgument) => string;
     node: (...nodes: (BlockEntity | InlineEntity)[]) => string;
-    message: (m: Message, source?: string, descriptor?: SourceDescriptor) => string;
+    message: typeof debugPrintMsg;
+    range: typeof debugPrintRange;
     document: typeof debugDumpDocument;
 };
-declare function debugDumpDocument(doc: Document, source: string): string;
+declare function debugPrintRange(loc: LocationRange, context?: number): string;
+declare function debugPrintMsg(m: Message): string;
+declare function debugDumpDocument(doc: Document): string;
 
+declare const emmmVersion = "0.0.6";
 declare function setDebugLevel(level: DebugLevel): void;
 
-export { type ArgumentEntity, ArgumentInterpolatorDefinition, type BlockEntity, BlockModifierDefinition, type BlockModifierNode, type BlockRendererDefiniton, type BlockShorthand, BuiltinConfiguration, Configuration, DebugLevel, DefaultConfiguration, Document, type DocumentNode, type EscapedNode, type HTMLComponentPlugin, type HTMLPostprocessPlugin, HTMLRenderConfiguration, type HTMLRenderPlugin, HTMLRenderState, type HTMLRenderType, type HTMLRendererOptions, type InlineEntity, InlineModifierDefinition, type InlineModifierNode, type InlineRendererDefiniton, type InlineShorthand, type InterpolationNode, type LocationRange, type Message, MessageSeverity, type ModifierArgument, type ModifierNode, ModifierSlotType, type NodeRenderer, type NodeRendererDefinition, NodeType, type ParagraphNode, ParseContext, type ParseContextStoreDefinitions, type ParseContextStoreKey, type PreNode, type ReadonlyConfiguration, type ReadonlyRenderConfiguration, RenderConfiguration, RenderContext, type RendererType, type RootNode, type Scanner, SimpleScanner, type SourceDescriptor, SystemModifierDefinition, type SystemModifierNode, type TextNode, debugPrint, messages, parse, setDebugLevel };
+export { type ArgumentEntity, ArgumentInterpolatorDefinition, type BlockEntity, BlockModifierDefinition, type BlockModifierNode, type BlockRendererDefiniton, type BlockShorthand, BuiltinConfiguration, Configuration, DebugLevel, DefaultConfiguration, Document, type DocumentNode, type EscapedNode, type HTMLComponentPlugin, type HTMLPostprocessPlugin, HTMLRenderConfiguration, type HTMLRenderPlugin, HTMLRenderState, type HTMLRenderType, type HTMLRendererOptions, type InlineEntity, InlineModifierDefinition, type InlineModifierNode, type InlineRendererDefiniton, type InlineShorthand, type InterpolationNode, type LocationRange, type Message, MessageSeverity, type ModifierArgument, type ModifierNode, ModifierSlotType, type NodeRenderer, type NodeRendererDefinition, NodeType, type ParagraphNode, ParseContext, type ParseContextStoreDefinitions, type ParseContextStoreKey, type PreNode, type ReadonlyConfiguration, type ReadonlyRenderConfiguration, RenderConfiguration, RenderContext, type RendererType, type RootNode, type Scanner, SimpleScanner, type Source, type SourceDescriptor, StringSource, SystemModifierDefinition, type SystemModifierNode, type TextNode, debugPrint, emmmVersion, messages, parse, setDebugLevel };

package/dist/index.d.ts

@@ -6,6 +6,35 @@ declare enum DebugLevel {
     None = 4
 }
 
+type SourceDescriptor = {
+    readonly name: string;
+};
+interface Source extends SourceDescriptor {
+    readonly nLines: number;
+    /**
+     * Return the row- and column-index corresponding to a given location. The indices are zero-based.
+     */
+    getRowCol(loc: number): [row: number, col: number];
+    /**
+     * Returns the position of the start of line `n` (zero-based). If `n` is zero, returns zero. If the source contains less than `n` lines, returns `Infinity`.
+     */
+    getLineStart(n: number): number;
+    /**
+     * Returns the content line `n`. If the source contains less than `n` lines, returns `Infinity`.
+     */
+    getLine(n: number): string | undefined;
+}
+declare class StringSource implements Source {
+    private readonly src;
+    readonly name: string;
+    readonly nLines: number;
+    private readonly lineMap;
+    constructor(d: SourceDescriptor, src: string);
+    getRowCol(pos: number): [row: number, col: number];
+    getLineStart(n: number): number;
+    getLine(n: number): string | undefined;
+}
+
 declare class NameManager<T extends {
     name: string;
 }> {
@@ -43,6 +72,14 @@ declare class Document {
     readonly messages: readonly Message[];
     constructor(root: RootNode, context: ParseContext, messages: readonly Message[]);
     toStripped(): Document;
+    /**
+     * Performs a depth-first walk of the node tree.
+     */
+    walk(callback: (node: BlockEntity | InlineEntity | ArgumentEntity) => 'skip' | 'break' | 'continue'): void;
+    /**
+     * Gets all nodes that covers the given position, from outermost to innermost (essentially a path).
+     */
+    resolvePosition(pos: number): (BlockEntity | InlineEntity | ArgumentEntity)[];
 }
 interface ReadonlyConfiguration {
     readonly initializers: readonly ((cxt: ParseContext) => void)[];
@@ -77,12 +114,9 @@ type Message = {
     readonly info: string;
     readonly code: number;
 };
-type SourceDescriptor = {
-    name: string;
-};
 type LocationRange = {
     original?: LocationRange;
-    source: SourceDescriptor;
+    source: Source;
     start: number;
     end: number;
     actualEnd?: number;
@@ -155,7 +189,7 @@ type InlineModifierNode<TState> = {
 type RootNode = {
     type: NodeType.Root;
     content: BlockEntity[];
-    source: SourceDescriptor;
+    source: Source;
 };
 type ModifierNode<T = any> = BlockModifierNode<T> | InlineModifierNode<T> | SystemModifierNode<T>;
 type BlockEntity = ParagraphNode | PreNode | BlockModifierNode<any> | SystemModifierNode<any>;
@@ -187,22 +221,38 @@ declare class ModifierBase<TNode, TEntity> {
     constructor(name: string, slotType?: ModifierSlotType, args?: Partial<ModifierBase<TNode, TEntity>>);
     roleHint?: string;
     /**
-     * If true, any modifier encountered in the content of it will *not* be expanded, *unless* that modifier is `alwaysTryExpand`.
+     * If true, any modifier encountered inside it will *not* be expanded *during parse-content*,
+     * *unless* that modifier is `alwaysTryExpand`. In the vast majority of cases, you shouldn't
+     * be using this.
      */
     delayContentExpansion: boolean;
     /**
-     * If true, such a modifier will always be expanded whenever it is encountered, *even if* contained in a modifier with `delayContentExpansion`.
+     * If true, such a modifier will always be expanded whenever it is encountered, *even if*
+     * contained in a modifier with `delayContentExpansion`. In the vast majority of cases,
+     * you shouldn't be using this.
      */
     alwaysTryExpand: boolean;
-    /** Called before the modifier's content is parsed. */
+    /** Called before the modifier's content is parsed.
+     * @param immediate False when the node is inside a `delayContentExpansion` modifier, but it is `alwaysTryExpand`; otherwise true.
+    */
     beforeParseContent?: (node: TNode, cxt: ParseContext, immediate: boolean) => Message[];
-    /** Called after the modifier's content is parsed. */
+    /** Called after the modifier's content is parsed.
+     * @param immediate False when the node is inside a `delayContentExpansion` modifier, but it is `alwaysTryExpand`; otherwise true.
+    */
     afterParseContent?: (node: TNode, cxt: ParseContext, immediate: boolean) => Message[];
-    /** Called before reparsing of the expansion. */
+    /** Called before reparsing of the expansion.
+     * @param immediate False when the node is inside a `delayContentExpansion` modifier, but it is `alwaysTryExpand`; otherwise true.*/
     beforeProcessExpansion?: (node: TNode, cxt: ParseContext, immediate: boolean) => Message[];
-    /** Called before reparsing of the expansion. */
+    /** Called before reparsing of the expansion.
+     * @param immediate False when the node is inside a `delayContentExpansion` modifier, but it is `alwaysTryExpand`; otherwise true.*/
     afterProcessExpansion?: (node: TNode, cxt: ParseContext, immediate: boolean) => Message[];
+    /**
+     * @param immediate False when the node is inside a `delayContentExpansion` modifier, but it is `alwaysTryExpand`; otherwise true.
+     */
     prepareExpand?: (node: TNode, cxt: ParseContext, immediate: boolean) => Message[];
+    /**
+     * @param immediate False when the node is inside a `delayContentExpansion` modifier, but it is `alwaysTryExpand`; otherwise true.
+     */
     expand?: (node: TNode, cxt: ParseContext, immediate: boolean) => TEntity[] | undefined;
 }
 declare class BlockModifierDefinition<TState> extends ModifierBase<BlockModifierNode<TState>, BlockEntity> {
@@ -229,9 +279,9 @@ type InlineShorthand<TState> = Shorthand<InlineModifierDefinition<TState>>;
 
 declare class SimpleScanner implements Scanner {
     private src;
-    readonly source: SourceDescriptor;
+    readonly source: Source;
     private pos;
-    constructor(src: string, source?: SourceDescriptor);
+    constructor(src: string, sourceDesc?: SourceDescriptor);
     position(): number;
     isEOF(): boolean;
     peek(str: string): boolean;
@@ -240,7 +290,7 @@ declare class SimpleScanner implements Scanner {
     acceptWhitespaceChar(): string | null;
 }
 interface Scanner {
-    readonly source: SourceDescriptor;
+    readonly source: Source;
     position(): number;
     isEOF(): boolean;
     peek(str: string): boolean;
@@ -425,7 +475,7 @@ declare class UnnecessaryNewlineMessage extends RemoveThingMessage {
 declare class NewBlockShouldBeOnNewlineMessage extends AddThingMessage {
     constructor(location: LocationRange);
 }
-declare class ContentShouldBeOnNewlineMessage extends AddThingMessage {
+declare class ShouldBeOnNewlineMessage extends AddThingMessage {
     constructor(location: LocationRange);
 }
 declare class NameAlreadyDefinedMessage implements Message {
@@ -468,8 +518,6 @@ type messages_CannotExpandArgumentMessage = CannotExpandArgumentMessage;
 declare const messages_CannotExpandArgumentMessage: typeof CannotExpandArgumentMessage;
 type messages_CannotUseModuleInSelfMessage = CannotUseModuleInSelfMessage;
 declare const messages_CannotUseModuleInSelfMessage: typeof CannotUseModuleInSelfMessage;
-type messages_ContentShouldBeOnNewlineMessage = ContentShouldBeOnNewlineMessage;
-declare const messages_ContentShouldBeOnNewlineMessage: typeof ContentShouldBeOnNewlineMessage;
 type messages_EitherNormalOrPreMessage = EitherNormalOrPreMessage;
 declare const messages_EitherNormalOrPreMessage: typeof EitherNormalOrPreMessage;
 type messages_EntityNotAllowedMessage = EntityNotAllowedMessage;
@@ -494,6 +542,8 @@ type messages_OverwriteSpecialVariableMessage = OverwriteSpecialVariableMessage;
 declare const messages_OverwriteSpecialVariableMessage: typeof OverwriteSpecialVariableMessage;
 type messages_ReachedRecursionLimitMessage = ReachedRecursionLimitMessage;
 declare const messages_ReachedRecursionLimitMessage: typeof ReachedRecursionLimitMessage;
+type messages_ShouldBeOnNewlineMessage = ShouldBeOnNewlineMessage;
+declare const messages_ShouldBeOnNewlineMessage: typeof ShouldBeOnNewlineMessage;
 type messages_SlotUsedOutsideDefinitionMessage = SlotUsedOutsideDefinitionMessage;
 declare const messages_SlotUsedOutsideDefinitionMessage: typeof SlotUsedOutsideDefinitionMessage;
 type messages_UnclosedInlineModifierMessage = UnclosedInlineModifierMessage;
@@ -505,7 +555,7 @@ declare const messages_UnknownModifierMessage: typeof UnknownModifierMessage;
 type messages_UnnecessaryNewlineMessage = UnnecessaryNewlineMessage;
 declare const messages_UnnecessaryNewlineMessage: typeof UnnecessaryNewlineMessage;
 declare namespace messages {
-  export { messages_ArgumentCountMismatchMessage as ArgumentCountMismatchMessage, messages_CannotExpandArgumentMessage as CannotExpandArgumentMessage, messages_CannotUseModuleInSelfMessage as CannotUseModuleInSelfMessage, messages_ContentShouldBeOnNewlineMessage as ContentShouldBeOnNewlineMessage, messages_EitherNormalOrPreMessage as EitherNormalOrPreMessage, messages_EntityNotAllowedMessage as EntityNotAllowedMessage, messages_ExpectedMessage as ExpectedMessage, messages_InvalidArgumentMessage as InvalidArgumentMessage, messages_MultipleBlocksNotPermittedMessage as MultipleBlocksNotPermittedMessage, messages_NameAlreadyDefinedMessage as NameAlreadyDefinedMessage, messages_NewBlockShouldBeOnNewlineMessage as NewBlockShouldBeOnNewlineMessage, messages_NoNestedModuleMessage as NoNestedModuleMessage, messages_OnlySimpleParagraphsPermittedMessage as OnlySimpleParagraphsPermittedMessage, messages_OverwriteDefinitionsMessage as OverwriteDefinitionsMessage, messages_OverwriteSpecialVariableMessage as OverwriteSpecialVariableMessage, messages_ReachedRecursionLimitMessage as ReachedRecursionLimitMessage, messages_SlotUsedOutsideDefinitionMessage as SlotUsedOutsideDefinitionMessage, messages_UnclosedInlineModifierMessage as UnclosedInlineModifierMessage, messages_UndefinedVariableMessage as UndefinedVariableMessage, messages_UnknownModifierMessage as UnknownModifierMessage, messages_UnnecessaryNewlineMessage as UnnecessaryNewlineMessage };
+  export { messages_ArgumentCountMismatchMessage as ArgumentCountMismatchMessage, messages_CannotExpandArgumentMessage as CannotExpandArgumentMessage, messages_CannotUseModuleInSelfMessage as CannotUseModuleInSelfMessage, messages_EitherNormalOrPreMessage as EitherNormalOrPreMessage, messages_EntityNotAllowedMessage as EntityNotAllowedMessage, messages_ExpectedMessage as ExpectedMessage, messages_InvalidArgumentMessage as InvalidArgumentMessage, messages_MultipleBlocksNotPermittedMessage as MultipleBlocksNotPermittedMessage, messages_NameAlreadyDefinedMessage as NameAlreadyDefinedMessage, messages_NewBlockShouldBeOnNewlineMessage as NewBlockShouldBeOnNewlineMessage, messages_NoNestedModuleMessage as NoNestedModuleMessage, messages_OnlySimpleParagraphsPermittedMessage as OnlySimpleParagraphsPermittedMessage, messages_OverwriteDefinitionsMessage as OverwriteDefinitionsMessage, messages_OverwriteSpecialVariableMessage as OverwriteSpecialVariableMessage, messages_ReachedRecursionLimitMessage as ReachedRecursionLimitMessage, messages_ShouldBeOnNewlineMessage as ShouldBeOnNewlineMessage, messages_SlotUsedOutsideDefinitionMessage as SlotUsedOutsideDefinitionMessage, messages_UnclosedInlineModifierMessage as UnclosedInlineModifierMessage, messages_UndefinedVariableMessage as UndefinedVariableMessage, messages_UnknownModifierMessage as UnknownModifierMessage, messages_UnnecessaryNewlineMessage as UnnecessaryNewlineMessage };
 }
 
 declare const BuiltinConfiguration: ReadonlyConfiguration;
@@ -544,11 +594,15 @@ declare const debugPrint: {
     blockShorthand: (x: BlockShorthand<any>) => string;
     argument: (arg: ModifierArgument) => string;
     node: (...nodes: (BlockEntity | InlineEntity)[]) => string;
-    message: (m: Message, source?: string, descriptor?: SourceDescriptor) => string;
+    message: typeof debugPrintMsg;
+    range: typeof debugPrintRange;
     document: typeof debugDumpDocument;
 };
-declare function debugDumpDocument(doc: Document, source: string): string;
+declare function debugPrintRange(loc: LocationRange, context?: number): string;
+declare function debugPrintMsg(m: Message): string;
+declare function debugDumpDocument(doc: Document): string;
 
+declare const emmmVersion = "0.0.6";
 declare function setDebugLevel(level: DebugLevel): void;
 
-export { type ArgumentEntity, ArgumentInterpolatorDefinition, type BlockEntity, BlockModifierDefinition, type BlockModifierNode, type BlockRendererDefiniton, type BlockShorthand, BuiltinConfiguration, Configuration, DebugLevel, DefaultConfiguration, Document, type DocumentNode, type EscapedNode, type HTMLComponentPlugin, type HTMLPostprocessPlugin, HTMLRenderConfiguration, type HTMLRenderPlugin, HTMLRenderState, type HTMLRenderType, type HTMLRendererOptions, type InlineEntity, InlineModifierDefinition, type InlineModifierNode, type InlineRendererDefiniton, type InlineShorthand, type InterpolationNode, type LocationRange, type Message, MessageSeverity, type ModifierArgument, type ModifierNode, ModifierSlotType, type NodeRenderer, type NodeRendererDefinition, NodeType, type ParagraphNode, ParseContext, type ParseContextStoreDefinitions, type ParseContextStoreKey, type PreNode, type ReadonlyConfiguration, type ReadonlyRenderConfiguration, RenderConfiguration, RenderContext, type RendererType, type RootNode, type Scanner, SimpleScanner, type SourceDescriptor, SystemModifierDefinition, type SystemModifierNode, type TextNode, debugPrint, messages, parse, setDebugLevel };
+export { type ArgumentEntity, ArgumentInterpolatorDefinition, type BlockEntity, BlockModifierDefinition, type BlockModifierNode, type BlockRendererDefiniton, type BlockShorthand, BuiltinConfiguration, Configuration, DebugLevel, DefaultConfiguration, Document, type DocumentNode, type EscapedNode, type HTMLComponentPlugin, type HTMLPostprocessPlugin, HTMLRenderConfiguration, type HTMLRenderPlugin, HTMLRenderState, type HTMLRenderType, type HTMLRendererOptions, type InlineEntity, InlineModifierDefinition, type InlineModifierNode, type InlineRendererDefiniton, type InlineShorthand, type InterpolationNode, type LocationRange, type Message, MessageSeverity, type ModifierArgument, type ModifierNode, ModifierSlotType, type NodeRenderer, type NodeRendererDefinition, NodeType, type ParagraphNode, ParseContext, type ParseContextStoreDefinitions, type ParseContextStoreKey, type PreNode, type ReadonlyConfiguration, type ReadonlyRenderConfiguration, RenderConfiguration, RenderContext, type RendererType, type RootNode, type Scanner, SimpleScanner, type Source, type SourceDescriptor, StringSource, SystemModifierDefinition, type SystemModifierNode, type TextNode, debugPrint, emmmVersion, messages, parse, setDebugLevel };