@coderline/alphatab-language-server 1.9.0-alpha.1891 → 1.9.0-alpha.1963

package/dist/common.mjs

@@ -1,5 +1,5 @@
 /*!
-* alphaTab Language Server v1.9.0-alpha.1891 (develop, build 1891)
+* alphaTab Language Server v1.9.0-alpha.1963 (develop, build 1963)
 *
 * Copyright © 2026, Daniel Kuschny and Contributors, All rights reserved.
 *
@@ -30,7 +30,7 @@ var ac = {
         \\ks D \\ts 24 16 \\ac r.16 6.3 7.3 9.3 7.3 6.3 | r.16 5.4 7.4 9.4 7.4 5.4 6.3.4{d} 9.6.16 10.6 12.6 10.6 9.6 14.6.4{d} r.16
         `
 };
-alphaTab.model.WhammyType, alphaTab.model.BendStyle, alphaTab.model.GraceType, alphaTab.model.FermataType, alphaTab.importer.alphaTex.AlphaTexAccidentalMode, alphaTab.importer.alphaTex.AlphaTexVoiceMode, alphaTab.model.NoteAccidentalMode, alphaTab.model.BarreShape, alphaTab.model.Ottavia, alphaTab.model.Rasgueado, alphaTab.model.DynamicValue, alphaTab.model.BracketExtendMode, alphaTab.model.TrackNamePolicy, alphaTab.model.TrackNameOrientation, alphaTab.model.TrackNameMode, alphaTab.model.TuningDisplayMode, alphaTab.platform.TextAlign, alphaTab.model.BendType, alphaTab.model.KeySignature, alphaTab.model.KeySignatureType, alphaTab.model.Clef, alphaTab.model.TripletFeel, alphaTab.model.BarLineStyle, alphaTab.model.SimileMark, alphaTab.model.Direction, alphaTab.model.TremoloPickingStyle, alphaTab.model.BarNumberDisplay;
+alphaTab.model.WhammyType, alphaTab.model.BendStyle, alphaTab.model.GraceType, alphaTab.model.FermataType, alphaTab.importer.alphaTex.AlphaTexAccidentalMode, alphaTab.importer.alphaTex.AlphaTexVoiceMode, alphaTab.importer.alphaTex.AlphaTexStaffType, alphaTab.model.NoteAccidentalMode, alphaTab.model.BarreShape, alphaTab.model.Ottavia, alphaTab.model.Rasgueado, alphaTab.model.DynamicValue, alphaTab.model.BracketExtendMode, alphaTab.model.TrackNamePolicy, alphaTab.model.TrackNameOrientation, alphaTab.model.TrackNameMode, alphaTab.model.TuningDisplayMode, alphaTab.platform.TextAlign, alphaTab.model.BendType, alphaTab.model.KeySignature, alphaTab.model.KeySignatureType, alphaTab.model.Clef, alphaTab.model.TripletFeel, alphaTab.model.BarLineStyle, alphaTab.model.SimileMark, alphaTab.model.Direction, alphaTab.model.TremoloPickingStyle, alphaTab.model.BarNumberDisplay, alphaTab.model.StaffPlacement, alphaTab.model.SystemDisplay, alphaTab.TabRhythmMode;
 var alphaTexMappedEnumMapping = {
 	WhammyType: {
 		None: null,
@@ -133,6 +133,24 @@ var alphaTexMappedEnumMapping = {
 			longDescription: "A new voice adds a new voice to the current bar only."
 		}
 	},
+	AlphaTexStaffType: {
+		Score: {
+			snippet: "score",
+			shortDescription: "Standard notation"
+		},
+		Tabs: {
+			snippet: "tabs",
+			shortDescription: "Guitar tablature"
+		},
+		Slash: {
+			snippet: "slash",
+			shortDescription: "Slash notation"
+		},
+		Numbered: {
+			snippet: "numbered",
+			shortDescription: "Numbered notation (Jianpu)"
+		}
+	},
 	NoteAccidentalMode: {
 		Default: {
 			snippet: "default",
@@ -892,6 +910,44 @@ var alphaTexMappedEnumMapping = {
 			snippet: "hide",
 			shortDescription: "Hide"
 		}
+	},
+	StaffPlacement: {
+		AllStaves: {
+			snippet: "allStaves",
+			shortDescription: "All staves"
+		},
+		Primary: {
+			snippet: "primary",
+			shortDescription: "Only the primary (topmost) staff"
+		}
+	},
+	SystemDisplay: {
+		AllSystems: {
+			snippet: "allSystems",
+			shortDescription: "All systems"
+		},
+		FirstSystemOnly: {
+			snippet: "firstSystemOnly",
+			shortDescription: "Only the first system"
+		}
+	},
+	TabRhythmMode: {
+		Hidden: {
+			snippet: "hidden",
+			shortDescription: "Hidden"
+		},
+		ShowWithBeams: {
+			snippet: "showWithBeams",
+			shortDescription: "Individual beams per beat"
+		},
+		ShowWithBars: {
+			snippet: "showWithBars",
+			shortDescription: "Connected bars like standard notation"
+		},
+		Automatic: {
+			snippet: "automatic",
+			shortDescription: "Shown if no standard notation is shown"
+		}
 	}
 };
 function enumParameter(type) {
@@ -1372,7 +1428,7 @@ var sync = {
 		{
 			name: "millisecondOffset",
 			shortDescription: "The absolute millisecond offset within the external media",
-			parseMode: alphaTab.importer.alphaTex.ArgumentListParseTypesMode.Required,
+			parseMode: alphaTab.importer.alphaTex.ArgumentListParseTypesMode.RequiredAsFloat,
 			type: alphaTab.importer.alphaTex.AlphaTexNodeType.Number
 		},
 		{
@@ -2382,6 +2438,33 @@ function properties(...props) {
 function metadata(...metadata) {
 	return new Map(metadata.map((t) => [t.tag.toLowerCase(), t]));
 }
+/**
+* Creates the signatures for a boolean-like value: no value (= true), `true|false`, `"true"|"false"` or `1|0`.
+*/
+function booleanSignatures(name, shortDescription, trueDescription, falseDescription) {
+	const overload = (type, t, f, quote) => ({ parameters: [{
+		name,
+		shortDescription,
+		parseMode: alphaTab.importer.alphaTex.ArgumentListParseTypesMode.Required,
+		type,
+		values: [{
+			name: t,
+			snippet: `${quote}${t}${quote}`,
+			shortDescription: trueDescription
+		}, {
+			name: f,
+			snippet: `${quote}${f}${quote}`,
+			shortDescription: falseDescription
+		}]
+	}] });
+	const types = alphaTab.importer.alphaTex.AlphaTexNodeType;
+	return [
+		{ parameters: [] },
+		overload(types.String, "true", "false", "\""),
+		overload(types.Ident, "true", "false", ""),
+		overload(types.Number, "1", "0", "")
+	];
+}
 //#endregion
 //#region ../alphatex/src/metadata/staff/chord.ts
 var chord = {
@@ -4226,7 +4309,7 @@ var ah = {
 		shortDescription: "The harmonic value",
 		longDescription: harmonicValueDocs,
 		type: alphaTab.importer.alphaTex.AlphaTexNodeType.Number,
-		parseMode: alphaTab.importer.alphaTex.ArgumentListParseTypesMode.Optional
+		parseMode: alphaTab.importer.alphaTex.ArgumentListParseTypesMode.OptionalAsFloat
 	}] }],
 	examples: `
         C4 {volume 8} D4 E4 {tempo 16} F4
@@ -4342,7 +4425,7 @@ var fh = {
 		shortDescription: "The harmonic value",
 		longDescription: harmonicValueDocs,
 		type: alphaTab.importer.alphaTex.AlphaTexNodeType.Number,
-		parseMode: alphaTab.importer.alphaTex.ArgumentListParseTypesMode.Optional
+		parseMode: alphaTab.importer.alphaTex.ArgumentListParseTypesMode.OptionalAsFloat
 	}] }],
 	examples: `
         :8 3.3{fh} 3.3{ah} 3.3{ph} 3.3{th} 3.3{sh}
@@ -4517,7 +4600,7 @@ var ph = {
 		shortDescription: "The harmonic value",
 		longDescription: harmonicValueDocs,
 		type: alphaTab.importer.alphaTex.AlphaTexNodeType.Number,
-		parseMode: alphaTab.importer.alphaTex.ArgumentListParseTypesMode.Optional
+		parseMode: alphaTab.importer.alphaTex.ArgumentListParseTypesMode.OptionalAsFloat
 	}] }],
 	examples: `
         :8 3.3{nh} 3.3{ah} 3.3{ph} 3.3{th} 3.3{sh}
@@ -4592,7 +4675,7 @@ var sh = {
 		shortDescription: "The harmonic value",
 		longDescription: harmonicValueDocs,
 		type: alphaTab.importer.alphaTex.AlphaTexNodeType.Number,
-		parseMode: alphaTab.importer.alphaTex.ArgumentListParseTypesMode.Optional
+		parseMode: alphaTab.importer.alphaTex.ArgumentListParseTypesMode.OptionalAsFloat
 	}] }],
 	examples: `
         :8 3.3{nh} 3.3{ah} 3.3{ph} 3.3{th} 3.3{sh}
@@ -4734,11 +4817,33 @@ var string = {
 	property: "string",
 	snippet: "string",
 	shortDescription: "Show String Number",
-	longDescription: "Adds an annotation showing the string number of the note above the staff.",
-	signatures: [{ parameters: [] }],
-	examples: `
+	longDescription: `
+    Adds an annotation showing the string number of the note above the staff.
+
+    For fretted notes the string is taken from the note value (\`fret.string\`).
+    For pitched notes the string number can be specified explicitly (e.g. string indications in classical guitar music).
+    It is only shown as annotation and has no effect on the playback.
+    `,
+	signatures: [{
+		description: "Show the string number of a fretted note",
+		parameters: []
+	}, {
+		description: "Show the given string number on a pitched note",
+		parameters: [{
+			name: "string",
+			shortDescription: "The string number (1 is the highest string)",
+			longDescription: "The string number to show. Like for fretted notes 1 is the highest string. On staves without tuning a standard 6 string instrument is assumed. Only allowed on pitched notes.",
+			parseMode: alphaTab.importer.alphaTex.ArgumentListParseTypesMode.Required,
+			type: alphaTab.importer.alphaTex.AlphaTexNodeType.Number
+		}]
+	}],
+	examples: [`
         3.3{string} 3.4{string} 3.5{string}
-        `
+        `, `
+        \\tuning piano
+        .
+        a4{string 1} c4{string 2} g3{string 3} e3{string 4}
+        `]
 };
 //#endregion
 //#region ../alphatex/src/properties/note/t.ts
@@ -4804,7 +4909,7 @@ var th = {
 		shortDescription: "The harmonic value",
 		longDescription: harmonicValueDocs,
 		type: alphaTab.importer.alphaTex.AlphaTexNodeType.Number,
-		parseMode: alphaTab.importer.alphaTex.ArgumentListParseTypesMode.Optional
+		parseMode: alphaTab.importer.alphaTex.ArgumentListParseTypesMode.OptionalAsFloat
 	}] }],
 	examples: `
         :8 3.3{nh} 3.3{ah} 3.3{ph} 3.3{th} 3.3{sh}
@@ -5270,11 +5375,211 @@ var restDisplayPitch = {
         `
 };
 //#endregion
+//#region ../alphatex/src/metadata/bar/barNumber.ts
+var barNumber = {
+	tag: "\\barNumber",
+	snippet: "\\barNumber ${1:1}$0",
+	shortDescription: "Sets the bar number display.",
+	signatures: [{ parameters: [{
+		name: "text",
+		shortDescription: "THe custom text shown instead of the number",
+		parseMode: alphaTab.importer.alphaTex.ArgumentListParseTypesMode.Required,
+		type: alphaTab.importer.alphaTex.AlphaTexNodeType.String,
+		allowAllStringTypes: true
+	}] }, { parameters: [{
+		name: "number",
+		shortDescription: "The new number (affects subsequent counting)",
+		parseMode: alphaTab.importer.alphaTex.ArgumentListParseTypesMode.Required,
+		type: alphaTab.importer.alphaTex.AlphaTexNodeType.Number,
+		allowAllStringTypes: true
+	}] }],
+	examples: [{ tex: `
+                // anacrusis (no number)
+                \\ac 
+                    C4.1 
+                | 
+                // standard bar number 1
+                    C4 
+                | 
+                // custom text instead of bar number 2
+                \\barNumber "Hello" 
+                    C4
+                |
+                // a jump to 10 
+                \\barNumber 10
+                    C4
+                |
+                // now becomes 11 after the customization before
+                    C4
+            ` }]
+};
+//#endregion
+//#region ../alphatex/src/staffDisplay.ts
+/**
+* Creates the signatures selecting the staff types to which the staff display properties apply.
+*/
+function staffDisplayTargetSignatures() {
+	return [{ parameters: [{
+		name: "staffTypes",
+		shortDescription: "The staff types to which the properties apply. If omitted, every property applies to all staff types supporting it.",
+		parseMode: alphaTab.importer.alphaTex.ArgumentListParseTypesMode.ValueListWithoutParenthesis,
+		...enumParameter("AlphaTexStaffType")
+	}] }];
+}
+function enumSignatures(name, shortDescription, type) {
+	return [{ parameters: [{
+		name,
+		shortDescription,
+		parseMode: alphaTab.importer.alphaTex.ArgumentListParseTypesMode.Required,
+		...enumParameter(type)
+	}] }];
+}
+function staffDisplayExample(tag, level, props) {
+	const meta = `${tag} { ${props} }`;
+	const bars = [
+		"\\ks D 3.3.4 r 3.3 3.3",
+		"3.3.4 3.3 r 3.3",
+		"\\ts (3 4) \\ks A 3.3.4 3.3 r",
+		"3.3.4 r 3.3"
+	];
+	if (level === "bar") bars[2] = `${meta} ${bars[2]}`;
+	return {
+		options: { display: { layoutMode: "Parchment" } },
+		tex: [
+			level === "score" ? meta : "",
+			"\\track { defaultSystemsLayout 2 }",
+			"    \\staff {score tabs}",
+			level === "staff" ? `    ${meta}` : "",
+			`    ${bars.join(" | ")}`
+		].filter((l) => l.length > 0).join("\n")
+	};
+}
+/**
+* The elements configured via `<prefix>Visibility`, `<prefix>Placement` and `<prefix>Systems`:
+* prefix, name, supported staff types, available on bar level.
+*/
+var staffDisplayElements = [
+	[
+		"clef",
+		"clef",
+		"`score`, `tabs`",
+		true
+	],
+	[
+		"ks",
+		"key signature",
+		"`score`, `slash`",
+		true
+	],
+	[
+		"ts",
+		"time signature",
+		"`score`, `tabs`, `slash`, `numbered`",
+		true
+	],
+	[
+		"rests",
+		"rests",
+		"`tabs`",
+		false
+	]
+];
+/**
+* Creates the properties of a staff display tag. Every tag gets own definitions as the definitions
+* are prepared in place and the examples use the tag.
+*/
+function staffDisplayProperties(tag, level) {
+	const prop = (property, shortDescription, signatures, value) => ({
+		property,
+		snippet: `${property} $0`,
+		shortDescription,
+		signatures,
+		examples: staffDisplayExample(tag, level, `${property} ${value}`)
+	});
+	const props = [];
+	for (const [prefix, name, staffTypes, barLevel] of staffDisplayElements) {
+		if (level === "bar" && !barLevel) continue;
+		const supported = `Supported staff types: ${staffTypes}.`;
+		props.push(prop(`${prefix}Visibility`, `Show or hide the ${name}. ${supported}`, booleanSignatures("visibility", `Whether the ${name} is shown`, `Show the ${name}`, `Hide the ${name}`), "false"), prop(`${prefix}Placement`, `Show the ${name} on all staves or only on the primary (topmost) staff. ${supported}`, enumSignatures("placement", `On which staves the ${name} is shown`, "StaffPlacement"), "primary"), prop(`${prefix}Systems`, `Show the ${name} on all systems or only on the first system. ${supported}`, enumSignatures("systems", `On which systems the ${name} is shown`, "SystemDisplay"), "firstSystemOnly"));
+	}
+	props.push(prop("barNumber", "Set how bar numbers are shown. Supported staff types: all.", enumSignatures("mode", "The mode to use", "BarNumberDisplay"), "allBars"));
+	if (level !== "bar") props.push(prop("rhythm", "Set how the rhythm notation is shown. Supported staff types: `tabs`.", enumSignatures("mode", "The mode to use", "TabRhythmMode"), "showWithBeams"));
+	return properties(...props);
+}
+//#endregion
+//#region ../alphatex/src/metadata/score/defaultStaffDisplay.ts
+var defaultStaffDisplay = {
+	tag: "\\defaultStaffDisplay",
+	snippet: "\\defaultStaffDisplay $1 {$2}$0",
+	shortDescription: "Sets how elements are displayed on the staves of the whole song.",
+	longDescription: `
+    Defines the song-wide display of elements like clefs, key signatures, time signatures, rests and bar numbers.
+
+    The arguments select the staff types to which the properties apply. If no staff types are specified, every property applies to all staff types supporting the related element.
+
+    All properties are optional. Properties which are not specified keep their default. The values can be overridden per staff with [\`\\staffDisplay\`](https://alphatab.net/docs/alphatex/staff-metadata#staffdisplay) and per bar with [\`\\barDisplay\`](https://alphatab.net/docs/alphatex/bar-metadata#bardisplay).
+    `,
+	signatures: staffDisplayTargetSignatures(),
+	examples: `
+        \\defaultStaffDisplay { clefPlacement primary }
+        \\defaultStaffDisplay tabs { tsVisibility true tsPlacement allStaves }
+        \\track
+            \\staff {score tabs}
+            3.3.4 3.3 3.3 3.3 | 3.3 3.3 3.3 3.3
+        `,
+	properties: staffDisplayProperties("\\defaultStaffDisplay", "score")
+};
+//#endregion
+//#region ../alphatex/src/metadata/staff/staffDisplay.ts
+var staffDisplay = {
+	tag: "\\staffDisplay",
+	snippet: "\\staffDisplay $1 {$2}$0",
+	shortDescription: "Sets how elements are displayed on the current staff.",
+	longDescription: `
+    Defines the display of elements like clefs, key signatures, time signatures, rests and bar numbers for the current staff.
+
+    The arguments select the staff types to which the properties apply. If no staff types are specified, every property applies to all staff types supporting the related element.
+
+    All properties are optional. Properties which are not specified are inherited from [\`\\defaultStaffDisplay\`](https://alphatab.net/docs/alphatex/score-metadata#defaultstaffdisplay). The values can be overridden per bar with [\`\\barDisplay\`](https://alphatab.net/docs/alphatex/bar-metadata#bardisplay).
+    `,
+	signatures: staffDisplayTargetSignatures(),
+	examples: `
+        \\track
+            \\staff {score tabs}
+            \\staffDisplay tabs { tsPlacement allStaves rhythm showWithBeams }
+            3.3.4 3.3 3.3 3.3 | 3.3 3.3 3.3 3.3
+        `,
+	properties: staffDisplayProperties("\\staffDisplay", "staff")
+};
+//#endregion
+//#region ../alphatex/src/metadata/bar/barDisplay.ts
+var barDisplay = {
+	tag: "\\barDisplay",
+	snippet: "\\barDisplay $1 {$2}$0",
+	shortDescription: "Sets how elements are displayed on the current bar.",
+	longDescription: `
+    Defines the display of elements like clefs, key signatures, time signatures and bar numbers for the current bar.
+
+    The arguments select the staff types to which the properties apply. If no staff types are specified, every property applies to all staff types supporting the related element.
+
+    All properties are optional. Properties which are not specified are inherited from [\`\\staffDisplay\`](https://alphatab.net/docs/alphatex/staff-metadata#staffdisplay) and [\`\\defaultStaffDisplay\`](https://alphatab.net/docs/alphatex/score-metadata#defaultstaffdisplay). The values only apply to the bar they are specified on.
+    `,
+	signatures: staffDisplayTargetSignatures(),
+	examples: `
+        \\track
+            \\staff {score tabs}
+            \\ks D 3.3.4 3.3 3.3 3.3 |
+            \\barDisplay score { ksVisibility false } \\ks A 3.3 3.3 3.3 3.3 |
+            3.3 3.3 3.3 3.3
+        `,
+	properties: staffDisplayProperties("\\barDisplay", "bar")
+};
+//#endregion
 //#region ../alphatex/src/definitions.ts
 var structuralMetaData = metadata(track, staff, voice);
-var scoreMetaData = metadata(title, subtitle, artist, album, words, music, wordsAndMusic, copyright, copyright2, instructions, notices, tab, systemsLayout, defaultSystemsLayout, showDynamics, hideDynamics, useSystemSignSeparator, tuningDisplayMode, multiBarRest, bracketExtendMode, singleTrackTrackNamePolicy, multiTrackTrackNamePolicy, firstSystemTrackNameMode, otherSystemsTrackNameMode, firstSystemTrackNameOrientation, otherSystemsTrackNameOrientation, extendBarLines, chordDiagramsInScore, hideEmptyStaves, hideEmptyStavesInFirstSystem, showSingleStaffBrackets, defaultBarNumberDisplay);
-var staffMetaData = metadata(tuning, chord, capo, lyrics, articulation, displayTranspose, transpose, instrumentMeta);
-var barMetaData = metadata(ts, ro, rc, ae, ks, clef, ottava, tempo, tf, ac, section, jump, ft, simile, barlineLeft, barlineRight, scale, width, sync, accidentals, spd, sph, spu, db, voiceMode, barNumberDisplay, beaming);
+var scoreMetaData = metadata(title, subtitle, artist, album, words, music, wordsAndMusic, copyright, copyright2, instructions, notices, tab, systemsLayout, defaultSystemsLayout, showDynamics, hideDynamics, useSystemSignSeparator, tuningDisplayMode, multiBarRest, bracketExtendMode, singleTrackTrackNamePolicy, multiTrackTrackNamePolicy, firstSystemTrackNameMode, otherSystemsTrackNameMode, firstSystemTrackNameOrientation, otherSystemsTrackNameOrientation, extendBarLines, chordDiagramsInScore, hideEmptyStaves, hideEmptyStavesInFirstSystem, showSingleStaffBrackets, defaultBarNumberDisplay, defaultStaffDisplay);
+var staffMetaData = metadata(tuning, chord, capo, lyrics, articulation, displayTranspose, transpose, instrumentMeta, staffDisplay);
+var barMetaData = metadata(ts, ro, rc, ae, ks, clef, ottava, tempo, tf, ac, section, jump, ft, simile, barlineLeft, barlineRight, scale, width, sync, accidentals, spd, sph, spu, db, voiceMode, barNumberDisplay, beaming, barNumber, barDisplay);
 var allMetadata = new Map([
 	...structuralMetaData.entries(),
 	...scoreMetaData.entries(),
@@ -5573,8 +5878,10 @@ function createMetaDataCompletions(barIndex, metaData, offset, endOfMetaData) {
 			}));
 		}
 		return completions;
-	} else if (offset >= metaData.end.offset) if (barIndex === 0) completions.push(...topLevelCompletions);
-	else completions.push(...createMetaDataDocCompletions(structuralMetaData), ...createMetaDataDocCompletions(barMetaData));
+	} else if (offset >= metaData.end.offset) {
+		if (barIndex === 0) completions.push(...topLevelCompletions);
+		else completions.push(...createMetaDataDocCompletions(structuralMetaData), ...createMetaDataDocCompletions(barMetaData));
+	}
 	const metaDataDocs = allMetadata.get(`\\${metaData.tag.tag.text.toLowerCase()}`);
 	if (!metaDataDocs) return completions;
 	const endOfArguments = metaData.arguments?.closeParenthesis?.start?.offset ?? metaData.arguments?.end?.offset ?? metaData.properties?.start?.offset ?? endOfMetaData;