@coderline/alphatab 1.7.0 → 1.7.1

package/dist/alphaTab.d.ts

@@ -255,7 +255,7 @@ export declare class AlphaTabApi extends AlphaTabApiBase<SettingsJson | Settings
     /**
      * @inheritdoc
      */
-    tex(tex: string, tracks?: number[]): void;
+    tex(tex: string, tracks?: number[] | 'all'): void;
     /**
      * Opens a popup window with the rendered music notation for printing.
      * @param width An optional custom width as CSS width that should be used. Best is to use a CSS width that is suitable for your preferred page size.
@@ -2935,6 +2935,7 @@ declare enum AlphaTabSystemExclusiveEvents {
 
 export declare namespace alphaTex {
     export {
+        AlphaTexArgumentList,
         AlphaTexAsteriskTokenNode,
         AlphaTexAstNode,
         AlphaTexAstNodeLocation,
@@ -2964,12 +2965,12 @@ export declare namespace alphaTex {
         AlphaTexStringLiteral,
         AlphaTexTextNode,
         AlphaTexTokenNode,
-        AlphaTexValueList,
+        IAlphaTexArgumentValue,
         IAlphaTexAstNode,
         IAlphaTexMetaDataTagPrefixNode,
         IAlphaTexNoteValueNode,
-        IAlphaTexValueListItem,
         AlphaTexLexer,
+        AlphaTexParseMode,
         AlphaTexParser,
         AlphaTexAccidentalMode,
         AlphaTexDiagnostic,
@@ -2977,6 +2978,7 @@ export declare namespace alphaTex {
         AlphaTexDiagnosticCode,
         AlphaTexDiagnosticsSeverity,
         AlphaTexStaffNoteKind,
+        ArgumentListParseTypesMode,
         IAlphaTexImporter,
         IAlphaTexImporterState
     }
@@ -2990,6 +2992,37 @@ declare enum AlphaTexAccidentalMode {
     Explicit = 1
 }
 
+/**
+ * A node holding multiple arguments optionally grouped by parenthesis.
+ * Whether parenthesis are needed depends on the context.
+ * Used in contexts like bend effects `3.3{b (0 4)}`.
+ * @record
+ * @public
+ */
+declare interface AlphaTexArgumentList extends AlphaTexAstNode {
+    nodeType: AlphaTexNodeType.Arguments;
+    /**
+     * The open parenthesis token grouping the arguments.
+     */
+    openParenthesis?: AlphaTexParenthesisOpenTokenNode;
+    /**
+     * The list of arguments.
+     */
+    arguments: IAlphaTexArgumentValue[];
+    /**
+     * The close parenthesis token grouping the arguments.
+     */
+    closeParenthesis?: AlphaTexParenthesisCloseTokenNode;
+
+    /**
+     * A list of indices to signatures which were selected as candidates matching
+     * this argument list.
+     * These values can be used to lookup the respective signature definition in
+     * the documentation or alphaTex language definition.
+     */
+    signatureCandidateIndices?: number[];
+}
+
 /**
  * @record
  * @public
@@ -3271,11 +3304,11 @@ declare enum AlphaTexDiagnosticCode {
      */
     AT208 = 208,
     /**
-     * Unexpected %s value '%s', expected: %s
+     * Unexpected %s arguments '%s', Signature: %s
      */
     AT209 = 209,
     /**
-     * Missing values. Expected following values: %s
+     * Missing arguments. Expected following arguments: %s
      */
     AT210 = 210,
     /**
@@ -3291,7 +3324,7 @@ declare enum AlphaTexDiagnosticCode {
      */
     AT213 = 213,
     /**
-     * The '%s' effect needs %s values per item. With %s points, %s values are needed, only %s values found.
+     * The '%s' effect needs %s arguments per item. With %s points, %s arguments are needed, only %s arguments found.
      */
     AT214 = 214,
     /**
@@ -3311,19 +3344,27 @@ declare enum AlphaTexDiagnosticCode {
      */
     AT218 = 218,
     /**
-     * Expected no values, but found some. Values are ignored.
+     * Error parsing arguments: no overload matched arguments %s. Signatures: %s
+     */
+    AT219 = 219,
+    /**
+     * Error parsing arguments: unexpected additional arguments. Signatures: %s
+     */
+    AT220 = 220,
+    /**
+     * Expected no arguments, but found some.
      */
     AT300 = 300,
     /**
-     * Metadata values should be wrapped into parenthesis.
+     * Metadata arguments should be wrapped into parenthesis.
      */
     AT301 = 301,
     /**
-     * Metadata values should be placed before metadata properties.
+     * Metadata arguments should be placed before metadata properties.
      */
     AT302 = 302,
     /**
-     * Property values should be wrapped into parenthesis.
+     * Property arguments should be wrapped into parenthesis.
      */
     AT303 = 303,
     /**
@@ -3412,7 +3453,7 @@ declare class AlphaTexExporter extends ScoreExporter {
  * @record
  * @public
  */
-declare interface AlphaTexIdentifier extends AlphaTexTextNode, IAlphaTexValueListItem, IAlphaTexNoteValueNode {
+declare interface AlphaTexIdentifier extends AlphaTexTextNode, IAlphaTexArgumentValue, IAlphaTexNoteValueNode {
     nodeType: AlphaTexNodeType.Ident;
 }
 
@@ -3420,13 +3461,19 @@ declare interface AlphaTexIdentifier extends AlphaTexTextNode, IAlphaTexValueLis
  * @public
  */
 declare class AlphaTexImporter extends ScoreImporter implements IAlphaTexImporter {
-    private _parser;
+    private _parser?;
     private _handler;
     private _state;
     get state(): IAlphaTexImporterState;
+    get scoreNode(): AlphaTexScoreNode | undefined;
     get name(): string;
     get lexerDiagnostics(): AlphaTexDiagnosticBag;
     get parserDiagnostics(): AlphaTexDiagnosticBag;
+    /**
+     * The underlying parser used for parsing the AST. Available after initialization of the importer.
+     */
+    get parser(): AlphaTexParser | undefined;
+    get parseMode(): AlphaTexParseMode;
     logErrors: boolean;
     readonly semanticDiagnostics: AlphaTexDiagnosticBag;
     addSemanticDiagnostic(diagnostic: AlphaTexDiagnostic): void;
@@ -3465,7 +3512,7 @@ declare class AlphaTexLexer {
     private _offset;
     private _line;
     private _col;
-    private _fatalError;
+    fatalError: boolean;
     private _tokenStart;
     private _leadingComments;
     private _trailingCommentNode;
@@ -3498,7 +3545,7 @@ declare class AlphaTexLexer {
 }
 
 /**
- * A metadata tag with optional values and optional properties like:
+ * A metadata tag with optional arguments and optional properties like:
  * `\track "Name" {color "#F00"}` .
  * @record
  * @public
@@ -3510,17 +3557,14 @@ declare interface AlphaTexMetaDataNode extends AlphaTexAstNode {
      */
     tag: AlphaTexMetaDataTagNode;
     /**
-     * A value list directly listed after the metadata (not within braces).
+     * A argument list directly listed after the metadata.
      */
-    values?: AlphaTexValueList;
+    arguments?: AlphaTexArgumentList;
     /**
-     * The optional properties attached to the metadata.
+     * The optional properties defined for the metadata.
      */
     properties?: AlphaTexPropertiesNode;
-    /**
-     * Whether the properties are listed before the values (if both are present).
-     */
-    propertiesBeforeValues: boolean;
+
 }
 
 /**
@@ -3558,7 +3602,7 @@ declare enum AlphaTexNodeType {
     Ident = 10,
     Tag = 11,
     Meta = 12,
-    Values = 13,
+    Arguments = 13,
     Props = 14,
     Prop = 15,
     Number = 16,
@@ -3626,7 +3670,7 @@ declare interface AlphaTexNoteNode extends AlphaTexAstNode {
  * @record
  * @public
  */
-declare interface AlphaTexNumberLiteral extends AlphaTexAstNode, IAlphaTexValueListItem, IAlphaTexNoteValueNode {
+declare interface AlphaTexNumberLiteral extends AlphaTexAstNode, IAlphaTexArgumentValue, IAlphaTexNoteValueNode {
     nodeType: AlphaTexNodeType.Number;
     /**
      * The numeric value described by this literal.
@@ -3650,6 +3694,25 @@ declare interface AlphaTexParenthesisOpenTokenNode extends AlphaTexTokenNode {
     nodeType: AlphaTexNodeType.LParen;
 }
 
+/**
+ * The different modes of the alphaTex parser.
+ * @public
+ */
+declare enum AlphaTexParseMode {
+    /**
+     * Optimizes the parser for only the model importing.
+     * The model importing does not need all details from the AST allowing a more lightweight
+     * parsing.
+     */
+    ForModelImport = 0,
+    /**
+     * Performs the full AST parsing with all details.
+     * This mode is mainly used by the Language Server providing IDE support.
+     * All AST information is parsed and filled.
+     */
+    Full = 1
+}
+
 /**
  * A parser for translating a given alphaTex source into an AST for further use
  * in the alphaTex importer, editors etc.
@@ -3659,6 +3722,10 @@ declare class AlphaTexParser {
     readonly lexer: AlphaTexLexer;
     private _scoreNode;
     private _metaDataReader;
+    /**
+     * The parsing mode.
+     */
+    mode: AlphaTexParseMode;
     get lexerDiagnostics(): AlphaTexDiagnosticBag;
     readonly parserDiagnostics: AlphaTexDiagnosticBag;
     addParserDiagnostic(diagnostics: AlphaTexDiagnostic): void;
@@ -3680,7 +3747,7 @@ declare class AlphaTexParser {
     private _metaData;
     private _properties;
     private _property;
-    valueList(): AlphaTexValueList | undefined;
+    argumentList(): AlphaTexArgumentList | undefined;
 }
 
 /**
@@ -3714,7 +3781,7 @@ declare interface AlphaTexPropertiesNode extends AlphaTexAstNode {
 }
 
 /**
- * A node describing a property with attached values.
+ * A node describing a property with attached arguments.
  * @record
  * @public
  */
@@ -3725,9 +3792,9 @@ declare interface AlphaTexPropertyNode extends AlphaTexAstNode {
      */
     property: AlphaTexIdentifier;
     /**
-     * The values attached to the property.
+     * The arguments passed into to the property.
      */
-    values?: AlphaTexValueList;
+    arguments?: AlphaTexArgumentList;
 }
 
 /**
@@ -3758,7 +3825,7 @@ declare enum AlphaTexStaffNoteKind {
  * @record
  * @public
  */
-declare interface AlphaTexStringLiteral extends AlphaTexTextNode, IAlphaTexValueListItem, IAlphaTexNoteValueNode {
+declare interface AlphaTexStringLiteral extends AlphaTexTextNode, IAlphaTexArgumentValue, IAlphaTexNoteValueNode {
     nodeType: AlphaTexNodeType.String;
 }
 
@@ -3784,27 +3851,45 @@ declare interface AlphaTexTokenNode extends AlphaTexAstNode {
 }
 
 /**
- * A node holding multiple values optionally grouped by parenthesis.
- * Whether parenthesis are needed depends on the context.
- * Used in contexts like bend effects `3.3{b (0 4)}`.
- * @record
+ * Defines how the arguments of the meta data tag is parsed.
  * @public
  */
-declare interface AlphaTexValueList extends AlphaTexAstNode {
-    nodeType: AlphaTexNodeType.Values;
+declare enum ArgumentListParseTypesMode {
     /**
-     * The open parenthesis token grouping the values.
+     * Indicates that the parameter of the given types is required.
+     * If the token matches, it is added to the value list.
+     * If the token does not match, an error diagnostic is added and parsing is stopped.
      */
-    openParenthesis?: AlphaTexParenthesisOpenTokenNode;
+    Required = 0,
     /**
-     * The list of values.
+     * Indicates that the parameter of the given types is optional.
+     * If the token matches, it is added to the value list.
+     * If the token does not match, the value list completes and parsing continues.
      */
-    values: IAlphaTexValueListItem[];
+    Optional = 1,
     /**
-     * The close parenthesis token grouping the values.
+     * Same as {@link Required} but the next argument is interpreted as a float.
      */
-    closeParenthesis?: AlphaTexParenthesisCloseTokenNode;
-
+    RequiredAsFloat = 2,
+    /**
+     * Same as {@link Optional} but the next argument is interpreted as a float.
+     */
+    OptionalAsFloat = 3,
+    /**
+     * Indicates that multiple arguments of the same types should be parsed as a list
+     * Think: rest-parameter that allows parameters to follow if the type doesn't match anymore.
+     * If the token is a open parenthesis, it starts reading the specified types as value list. If an unexpected item is
+     * encountered an error diagnostic is added.
+     * If the token matches the expected type, a single value is read.
+     * If the token is any other type, an error diagnostic is added and parsing is stopped.
+     */
+    RequiredAsValueList = 4,
+    /**
+     * Indicates that multiple parameters of the same types should be parsed. (this is mainly for backwards compatibility with older alphaTex files)
+     * If the token matches, it is added to the value list. Parsing stays on the current type.
+     * If the token does not match, the value list completes and parsing continues.
+     */
+    ValueListWithoutParenthesis = 5
 }
 
 /**
@@ -8510,6 +8595,22 @@ declare interface IAlphaSynthAudioExporter {
     render(milliseconds: number): AudioExportChunk | undefined;
 }
 
+/**
+ * Base marker interface for nodes which can be arguments in an {@link AlphaTexArgumentList}
+ * @public
+ */
+declare interface IAlphaTexArgumentValue extends IAlphaTexAstNode {
+    /**
+     * For every signature candidate available for parent current argument list, this
+     * array contains the index to the parameter definition in the alphaTex language definitino.
+     *
+     * This value can be used to lookup the respective parameter definition in
+     * the documentation or alphaTex language definition. As paramters can be optional this value
+     * allows a reverse lookup to the parameter information.
+     */
+    parameterIndices?: Map<number, number>;
+}
+
 /**
  * The base type for all alphaTex AST nodes
  * @public
@@ -8542,6 +8643,7 @@ declare interface IAlphaTexAstNode {
  */
 declare interface IAlphaTexImporter {
     readonly state: IAlphaTexImporterState;
+    readonly parseMode: AlphaTexParseMode;
     applyStaffNoteKind(staff: Staff, staffNoteKind: AlphaTexStaffNoteKind): void;
     startNewVoice(): void;
     startNewTrack(): Track;
@@ -8580,13 +8682,6 @@ declare interface IAlphaTexMetaDataTagPrefixNode extends IAlphaTexAstNode {
 declare interface IAlphaTexNoteValueNode extends IAlphaTexAstNode {
 }
 
-/**
- * Defines the possible types for values in a {@link AlphaTexValueList}
- * @public
- */
-declare interface IAlphaTexValueListItem extends IAlphaTexAstNode {
-}
-
 /**
  * A {@link IBackingTrackSynthOutput} which uses a HTMLAudioElement as playback mechanism.
  * Allows the access to the element for further custom usage.