Interface SyntaxMode

interface SyntaxMode {
    $behaviour?: Behaviour;
    $defaultBehaviour?: Behaviour;
    $embeds?: string[];
    $highlightRuleConfig?: any;
    $highlightRules: HighlightRules;
    $keywordList?: string[];
    $modes?: SyntaxMode[];
    $pairQuotesAfter: { [quote: string]: RegExp };
    $quotes: { [quote: string]: string };
    $tokenizer: Tokenizer;
    blockComment?: { end: string; start: string };
    completionKeywords: string[];
    foldingRules?: FoldMode;
    HighlightRules: new (config?: any) => HighlightRules;
    lineCommentStart?: string;
    nonTokenRe?: RegExp;
    path?: string;
    tokenRe?: RegExp;
    transformAction: BehaviorAction;
    $createKeywordList(): string[];
    $delegator(method: string, args: IArguments, defaultHandler: any): any;
    $getIndent(line: string): string;
    autoOutdent(state: string | string[], doc: EditSession, row: number): void;
    checkOutdent(
        state: string | string[],
        line: string,
        input: string,
    ): boolean;
    createModeDelegates(mapping: { [key: string]: string }): void;
    createWorker(session: EditSession): any;
    getCompletions(
        state: string | string[],
        session: EditSession,
        pos: Point,
        prefix: string,
    ): Completion[];
    getKeywords(append?: boolean): (string | RegExp)[];
    getNextLineIndent(
        state: string | string[],
        line: string,
        tab: string,
    ): string;
    getTokenizer(): Tokenizer;
    toggleBlockComment(
        state: string | string[],
        session: EditSession,
        range: Range,
        cursor: Point,
    ): void;
    toggleCommentLines(
        state: string | string[],
        session: EditSession,
        startRow: number,
        endRow: number,
    ): void;
}

Properties

$behaviour? $defaultBehaviour? $embeds? $highlightRuleConfig? $highlightRules $keywordList? $modes? $pairQuotesAfter $quotes $tokenizer blockComment? completionKeywords foldingRules? HighlightRules lineCommentStart? nonTokenRe? path? tokenRe? transformAction

Methods

$createKeywordList $delegator $getIndent autoOutdent checkOutdent createModeDelegates createWorker getCompletions getKeywords getNextLineIndent getTokenizer toggleBlockComment toggleCommentLines

Properties

Optional$behaviour

$behaviour?: Behaviour

Optional$defaultBehaviour

$defaultBehaviour?: Behaviour

Optional$embeds

$embeds?: string[]

Optional$highlightRuleConfig

$highlightRuleConfig?: any

$highlightRules

$highlightRules: HighlightRules

Optional$keywordList

$keywordList?: string[]

Optional$modes

$modes?: SyntaxMode[]

$pairQuotesAfter

$pairQuotesAfter: { [quote: string]: RegExp }

An object containing conditions to determine whether to apply matching quote or not.

$quotes

$quotes: { [quote: string]: string }

quotes used by language mode

$tokenizer

$tokenizer: Tokenizer

OptionalblockComment

blockComment?: { end: string; start: string }

characters that indicate the start and end of a block comment

completionKeywords

completionKeywords: string[]

OptionalfoldingRules

foldingRules?: FoldMode

HighlightRules

HighlightRules: new (config?: any) => HighlightRules

OptionallineCommentStart

lineCommentStart?: string

characters that indicate the start of a line comment

OptionalnonTokenRe

nonTokenRe?: RegExp

Optionalpath

path?: string

OptionaltokenRe

tokenRe?: RegExp

transformAction

transformAction: BehaviorAction

Methods

$createKeywordList

$delegator

  • $delegator(method: string, args: IArguments, defaultHandler: any): any

  • Parameters

    • method: string
    • args: IArguments
    • defaultHandler: any

    Returns any

$getIndent

  • $getIndent(line: string): string

  • Parameters

    • line: string

    Returns string

autoOutdent

checkOutdent

  • checkOutdent(state: string | string[], line: string, input: string): boolean

  • Parameters

    • state: string | string[]
    • line: string
    • input: string

    Returns boolean

createModeDelegates

  • createModeDelegates(mapping: { [key: string]: string }): void

  • Parameters

    • mapping: { [key: string]: string }

    Returns void

createWorker

getCompletions

getKeywords

  • getKeywords(append?: boolean): (string | RegExp)[]

  • Parameters

    • Optionalappend: boolean

    Returns (string | RegExp)[]

getNextLineIndent

  • getNextLineIndent(state: string | string[], line: string, tab: string): string

  • Parameters

    • state: string | string[]
    • line: string
    • tab: string

    Returns string

getTokenizer

toggleBlockComment

toggleCommentLines

  • toggleCommentLines(
        state: string | string[],
        session: EditSession,
        startRow: number,
        endRow: number,
    ): void

  • Parameters

    • state: string | string[]
    • session: EditSession
    • startRow: number
    • endRow: number

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods