spiegel-keyman/developer/docs/api/etc/kmc-ldml.api.md

API Report File for "@keymanapp/kmc-ldml"

Do not edit this file. It is a report generated by API Extractor.

import { CompilerCallbacks } from '@keymanapp/developer-utils';
import { CompilerEvent } from '@keymanapp/developer-utils';
import { CompilerOptions } from '@keymanapp/developer-utils';
import { KeymanCompiler } from '@keymanapp/developer-utils';
import { KeymanCompilerArtifactOptional } from '@keymanapp/developer-utils';
import { KeymanCompilerArtifacts } from '@keymanapp/developer-utils';
import { KeymanCompilerResult } from '@keymanapp/developer-utils';
import { KMXPlus } from '@keymanapp/common-types';
import { LDMLKeyboardTestDataXMLSourceFile } from '@keymanapp/developer-utils';
import { LdmlKeyboardTypes } from '@keymanapp/common-types';
import { LDMLKeyboardXMLSourceFileReaderOptions } from '@keymanapp/developer-utils';
import { ObjectWithCompileContext } from '@keymanapp/common-types';

// Warning: (ae-internal-missing-underscore) The name "LdmlCompilerMessages" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal (undocumented)
export class LdmlCompilerMessages {
    // (undocumented)
    static ERROR_CantReferenceSetFromUnicodeSet: number;
    // (undocumented)
    static Error_CantReferenceSetFromUnicodeSet: (o: {
        id: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_DisplayIsRepeated: number;
    // (undocumented)
    static Error_DisplayIsRepeated: (o: {
        display?: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_DisplayNeedsToOrId: number;
    // (undocumented)
    static Error_DisplayNeedsToOrId: (o: {
        display?: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_DuplicateLayerWidth: number;
    // (undocumented)
    static Error_DuplicateLayerWidth: (o: {
        minDeviceWidth: number;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_DuplicateTransformsType: number;
    // (undocumented)
    static Error_DuplicateTransformsType: (o: {
        type: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_DuplicateVariable: number;
    // (undocumented)
    static Error_DuplicateVariable: (o: {
        id: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_EmptyTransformGroup: number;
    // (undocumented)
    static Error_EmptyTransformGroup: (compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_ExcessHardware: number;
    // (undocumented)
    static Error_ExcessHardware: (o: {
        formId: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_GestureKeyNotFoundInKeyBag: number;
    // (undocumented)
    static Error_GestureKeyNotFoundInKeyBag: (o: {
        keyId: string;
        parentKeyId: string;
        attribute: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_HardwareLayerHasTooManyRows: number;
    // (undocumented)
    static Error_HardwareLayerHasTooManyRows: (compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_IllegalCharacters: number;
    // (undocumented)
    static Error_IllegalCharacters: (o: {
        count: number;
        lowestCh: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_IllegalTransformAsterisk: number;
    // (undocumented)
    static Error_IllegalTransformAsterisk: (o: {
        from: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_IllegalTransformDollarsign: number;
    // (undocumented)
    static Error_IllegalTransformDollarsign: (o: {
        from: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_IllegalTransformPlus: number;
    // (undocumented)
    static Error_IllegalTransformPlus: (o: {
        from: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_IllegalTransformToUset: number;
    // (undocumented)
    static Error_IllegalTransformToUset: (o: {
        to: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_InvalidFile: number;
    // (undocumented)
    static Error_InvalidFile: (o: {
        errorText: string;
    }) => CompilerEvent;
    // (undocumented)
    static ERROR_InvalidHardware: number;
    // (undocumented)
    static Error_InvalidHardware: (o: {
        formId: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_InvalidLayerWidth: number;
    // (undocumented)
    static Error_InvalidLayerWidth: (o: {
        minDeviceWidth: number;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_InvalidLocale: number;
    // (undocumented)
    static Error_InvalidLocale: (o: {
        tag: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_InvalidMarkerIdentifier: number;
    // (undocumented)
    static Error_InvalidMarkerIdentifier: (o: {
        id: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_InvalidModifier: number;
    // (undocumented)
    static Error_InvalidModifier: (o: {
        modifiers: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_InvalidQuadEscape: number;
    // (undocumented)
    static Error_InvalidQuadEscape: (o: {
        cp: string;
        recommended: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_InvalidScanCode: number;
    // (undocumented)
    static Error_InvalidScanCode: (o: {
        codes: string;
        id: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_InvalidTransformsType: number;
    // (undocumented)
    static Error_InvalidTransformsType: (o: {
        type: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_InvalidVariableIdentifier: number;
    // (undocumented)
    static Error_InvalidVariableIdentifier: (o: {
        id: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_InvalidVersion: number;
    // (undocumented)
    static Error_InvalidVersion: (o: {
        version: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_KeyMissingToGapOrSwitch: number;
    // (undocumented)
    static Error_KeyMissingToGapOrSwitch: (o: {
        keyId: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_KeyNotFoundInKeyBag: number;
    // (undocumented)
    static Error_KeyNotFoundInKeyBag: (o: {
        keyId: string;
        col: number;
        row: number;
        layer: string;
        form: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_MissingFlicks: number;
    // (undocumented)
    static Error_MissingFlicks: (o: {
        id: string;
        flickId: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_MissingMarkers: number;
    // (undocumented)
    static Error_MissingMarkers: (o: {
        ids: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_MissingSetVariable: number;
    // (undocumented)
    static Error_MissingSetVariable: (o: {
        id: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_MissingStringVariable: number;
    // (undocumented)
    static Error_MissingStringVariable: (o: {
        id: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_MissingUnicodeSetVariable: number;
    // (undocumented)
    static Error_MissingUnicodeSetVariable: (o: {
        id: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_MixedTransformGroup: number;
    // (undocumented)
    static Error_MixedTransformGroup: (compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_MustBeAtLeastOneLayerElement: number;
    // (undocumented)
    static Error_MustBeAtLeastOneLayerElement: (compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_NeedSpacesBetweenSetVariables: number;
    // (undocumented)
    static Error_NeedSpacesBetweenSetVariables: (o: {
        item: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_RowOnHardwareLayerHasTooManyKeys: number;
    // (undocumented)
    static Error_RowOnHardwareLayerHasTooManyKeys: (o: {
        row: number;
        hardware: string;
        modifiers: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_TransformFromMatchesNothing: number;
    // (undocumented)
    static Error_TransformFromMatchesNothing: (o: {
        from: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_UnparseableTransformFrom: number;
    // (undocumented)
    static Error_UnparseableTransformFrom: (o: {
        from: string;
        message: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static ERROR_UnparseableTransformTo: number;
    // (undocumented)
    static Error_UnparseableTransformTo: (o: {
        to: string;
        message: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static HINT_CharClassImplicitDenorm: number;
    // (undocumented)
    static Hint_CharClassImplicitDenorm: (o: {
        lowestCh: number;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static HINT_LocaleIsNotMinimalAndClean: number;
    // (undocumented)
    static Hint_LocaleIsNotMinimalAndClean: (o: {
        sourceLocale: string;
        locale: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static HINT_NoDisplayForMarker: number;
    // (undocumented)
    static Hint_NoDisplayForMarker: (o: {
        id: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static HINT_NoDisplayForSwitch: number;
    // (undocumented)
    static Hint_NoDisplayForSwitch: (o: {
        id: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static HINT_NormalizationDisabled: number;
    // (undocumented)
    static Hint_NormalizationDisabled: (compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static HINT_OneOrMoreRepeatedLocales: number;
    // (undocumented)
    static Hint_OneOrMoreRepeatedLocales: (compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static HINT_PUACharacters: number;
    // (undocumented)
    static Hint_PUACharacters: (o: {
        count: number;
        lowestCh: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static WARN_CharClassExplicitDenorm: number;
    // (undocumented)
    static Warn_CharClassExplicitDenorm: (o: {
        lowestCh: number;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static WARN_CustomForm: number;
    // (undocumented)
    static Warn_CustomForm: (o: {
        id: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static WARN_StringDenorm: number;
    // (undocumented)
    static Warn_StringDenorm: (o: {
        s: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
    // (undocumented)
    static WARN_UnassignedCharacters: number;
    // (undocumented)
    static Warn_UnassignedCharacters: (o: {
        count: number;
        lowestCh: string;
    }, compileContext?: ObjectWithCompileContext) => CompilerEvent;
}

// @public
export interface LdmlCompilerOptions extends CompilerOptions {
    readerOptions: LDMLKeyboardXMLSourceFileReaderOptions;
}

// @public
export class LdmlKeyboardCompiler implements KeymanCompiler {
    // @internal
    compile(source: LDMLKeyboardXMLSourceFile, postValidate?: boolean): Promise<KMXPlus.KMXPlusFile>;
    // @internal
    getUsetParser(): Promise<LdmlKeyboardTypes.UnicodeSetParser>;
    init(callbacks: CompilerCallbacks, options: LdmlCompilerOptions): Promise<boolean>;
    // Warning: (ae-forgotten-export) The symbol "LDMLKeyboardXMLSourceFile" needs to be exported by the entry point main.d.ts
    //
    // @internal
    load(filename: string): LDMLKeyboardXMLSourceFile | null;
    // @internal
    loadTestData(filename: string): LDMLKeyboardTestDataXMLSourceFile | null;
    // Warning: (ae-forgotten-export) The symbol "LdmlKeyboardCompilerResult" needs to be exported by the entry point main.d.ts
    run(inputFilename: string, outputFilename?: string): Promise<LdmlKeyboardCompilerResult>;
    // @internal
    validate(source: LDMLKeyboardXMLSourceFile): Promise<boolean>;
    // Warning: (ae-forgotten-export) The symbol "LdmlKeyboardCompilerArtifacts" needs to be exported by the entry point main.d.ts
    write(artifacts: LdmlKeyboardCompilerArtifacts): Promise<boolean>;
}

// (No @packageDocumentation comment for this package)