abcjs 6.0.0-beta.9 → 6.0.2

package/src/parse/abc_parse_book.js

@@ -0,0 +1,62 @@
+//    abc_parse_book.js: parses a string representing ABC Music Notation into a usable internal structure.
+
+var parseCommon = require('./abc_common');
+
+var bookParser = function(book) {
+	"use strict";
+
+	var directives = "";
+	book = parseCommon.strip(book);
+	var tuneStrings = book.split("\nX:");
+	// Put back the X: that we lost when splitting the tunes.
+	for (var i = 1; i < tuneStrings.length; i++)
+		tuneStrings[i] = "X:" + tuneStrings[i];
+	// Keep track of the character position each tune starts with.
+	var pos = 0;
+	var tunes = [];
+	parseCommon.each(tuneStrings, function(tune) {
+		tunes.push({ abc: tune, startPos: pos});
+		pos += tune.length + 1; // We also lost a newline when splitting, so count that.
+	});
+	if (tunes.length > 1 && !parseCommon.startsWith(tunes[0].abc, 'X:')) {	// If there is only one tune, the X: might be missing, otherwise assume the top of the file is "intertune"
+		// There could be file-wide directives in this, if so, we need to insert it into each tune. We can probably get away with
+		// just looking for file-wide directives here (before the first tune) and inserting them at the bottom of each tune, since
+		// the tune is parsed all at once. The directives will be seen before the engraver begins processing.
+		var dir = tunes.shift();
+		var arrDir = dir.abc.split('\n');
+		parseCommon.each(arrDir, function(line) {
+			if (parseCommon.startsWith(line, '%%'))
+				directives += line + '\n';
+		});
+	}
+	var header = directives;
+
+	// Now, the tune ends at a blank line, so truncate it if needed. There may be "intertune" stuff.
+	parseCommon.each(tunes, function(tune) {
+		var end = tune.abc.indexOf('\n\n');
+		if (end > 0)
+			tune.abc = tune.abc.substring(0, end);
+		tune.pure = tune.abc;
+		tune.abc = directives + tune.abc;
+
+		// for the user's convenience, parse and store the title separately. The title is between the first T: and the next \n
+		tune.title = "";
+		var title = tune.pure.split("T:");
+		if (title.length > 1) {
+			title = title[1].split("\n");
+			tune.title = parseCommon.strip(title[0]);
+		}
+
+		// for the user's convenience, parse and store the id separately. The id is between the first X: and the next \n
+		var id = tune.pure.substring(2, tune.pure.indexOf("\n"));
+		tune.id = parseCommon.strip(id);
+	});
+
+	return {
+		header: header,
+		tunes: tunes
+	};
+};
+
+module.exports = bookParser;
+

package/src/parse/abc_parse_directive.js

@@ -1,18 +1,3 @@
-//    Copyright (C) 2010-2020 Paul Rosen (paul at paulrosen dot net)
-//
-//    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
-//    documentation files (the "Software"), to deal in the Software without restriction, including without limitation
-//    the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
-//    to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-//
-//    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-//
-//    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
-//    BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-//    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
-//    DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-//    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
 var parseCommon = require('./abc_common');
 
 var parseDirective = {};
@@ -23,11 +8,13 @@ var parseDirective = {};
 	var warn;
 	var multilineVars;
 	var tune;
-	parseDirective.initialize = function(tokenizer_, warn_, multilineVars_, tune_) {
+	var tuneBuilder;
+	parseDirective.initialize = function(tokenizer_, warn_, multilineVars_, tune_, tuneBuilder_) {
 		tokenizer = tokenizer_;
 		warn = warn_;
 		multilineVars = multilineVars_;
 		tune = tune_;
+		tuneBuilder = tuneBuilder_;
 		initializeFonts();
 	};
 
@@ -52,6 +39,9 @@ var parseDirective = {};
 		tune.formatting.footerfont  = { face: "\"Times New Roman\"", size: 12, weight: "normal", style: "normal", decoration: "none" };
 		tune.formatting.headerfont  = { face: "\"Times New Roman\"", size: 12, weight: "normal", style: "normal", decoration: "none" };
 		tune.formatting.voicefont  = { face: "\"Times New Roman\"", size: 13, weight: "bold", style: "normal", decoration: "none" };
+		tune.formatting.tablabelfont  = { face: "\"Trebuchet MS\"", size: 16, weight: "normal", style: "normal", decoration: "none" };
+		tune.formatting.tabnumberfont = { face: "\"Arial\"", size: 11, weight: "normal", style: "normal", decoration: "none" };
+		tune.formatting.tabgracefont = { face: "\"Arial\"", size: 8, weight: "normal", style: "normal", decoration: "none" };
 
 		// these are the default fonts for these element types. In the printer, these fonts might change as the tune progresses.
 		tune.formatting.annotationfont  = multilineVars.annotationfont;
@@ -67,7 +57,7 @@ var parseDirective = {};
 		tune.formatting.wordsfont  = multilineVars.wordsfont;
 	}
 
-	var fontTypeCanHaveBox = { gchordfont: true, measurefont: true, partsfont: true };
+	var fontTypeCanHaveBox = { gchordfont: true, measurefont: true, partsfont: true, annotationfont: true, composerfont: true, historyfont: true, infofont: true, subtitlefont: true, textfont: true, titlefont: true, voicefont: true  };
 
 	var fontTranslation = function(fontFace) {
 		// This translates Postscript fonts for a web alternative.
@@ -349,6 +339,74 @@ var parseDirective = {};
 		tune.formatting.scale = num;
 
 	};
+	// starts at 35
+	var drumNames = [
+		"acoustic-bass-drum",
+		"bass-drum-1",
+		"side-stick",
+		"acoustic-snare",
+		"hand-clap",
+		"electric-snare",
+		"low-floor-tom",
+		"closed-hi-hat",
+		"high-floor-tom",
+		"pedal-hi-hat",
+		"low-tom",
+		"open-hi-hat",
+		"low-mid-tom",
+		"hi-mid-tom",
+		"crash-cymbal-1",
+		"high-tom",
+		"ride-cymbal-1",
+		"chinese-cymbal",
+		"ride-bell",
+		"tambourine",
+		"splash-cymbal",
+		"cowbell",
+		"crash-cymbal-2",
+		"vibraslap",
+		"ride-cymbal-2",
+		"hi-bongo",
+		"low-bongo",
+		"mute-hi-conga",
+		"open-hi-conga",
+		"low-conga",
+		"high-timbale",
+		"low-timbale",
+		"high-agogo",
+		"low-agogo",
+		"cabasa",
+		"maracas",
+		"short-whistle",
+		"long-whistle",
+		"short-guiro",
+		"long-guiro",
+		"claves",
+		"hi-wood-block",
+		"low-wood-block",
+		"mute-cuica",
+		"open-cuica",
+		"mute-triangle",
+		"open-triangle",
+	];
+
+	var interpretPercMap = function(restOfString) {
+		var tokens = restOfString.split(/\s+/); // Allow multiple spaces.
+		if (tokens.length !== 2 && tokens.length !== 3)
+			return { error: 'Expected parameters "abc-note", "drum-sound", and optionally "note-head"'};
+		var key = tokens[0];
+		// The percussion sound can either be a MIDI number or a drum name. If it is not a number then check for a name.
+		var pitch = parseInt(tokens[1], 10);
+		if ((isNaN(pitch) || pitch < 35 || pitch > 81) && tokens[1]) {
+			pitch = drumNames.indexOf(tokens[1].toLowerCase()) + 35;
+		}
+		if ((isNaN(pitch) || pitch < 35 || pitch > 81))
+			return { error: 'Expected drum name, received "' + tokens[1] + '"' };
+		var value = { sound: pitch };
+		if (tokens.length === 3)
+			value.noteHead = tokens[2];
+		return { key: key, value: value };
+	};
 
 	var getRequiredMeasurement = function(cmd, tokens) {
 		var points = tokenizer.getMeasurement(tokens);
@@ -459,10 +517,6 @@ var parseDirective = {};
 	var midiCmdParam5Integer = [
 		"drone"
 	];
-	var midiCmdParam1IntegerOptionalOctave = [
-		"bassprog",
-		"chordprog"
-	];
 	var midiCmdParam1String1Integer = [
 		"portamento"
 	];
@@ -618,8 +672,8 @@ var parseDirective = {};
 			}
 		}
 
-		if (tune.hasBeginMusic())
-			tune.appendElement('midi', -1, -1, { cmd: midi_cmd, params: midi_params });
+		if (tuneBuilder.hasBeginMusic())
+			tuneBuilder.appendElement('midi', -1, -1, { cmd: midi_cmd, params: midi_params });
 		else {
 			if (tune.formatting['midi'] === undefined)
 				tune.formatting['midi'] = {};
@@ -659,6 +713,7 @@ var parseDirective = {};
 		restOfString = tokenizer.stripComment(restOfString);
 		var cmd = tokens.shift().token.toLowerCase();
 		var scratch = "";
+		var line;
 		switch (cmd)
 		{
 			// The following directives were added to abc_parser_lint, but haven't been implemented here.
@@ -671,7 +726,6 @@ var parseDirective = {};
 			//					exprabove: { type: "boolean", optional: true },
 			//					exprbelow: { type: "boolean", optional: true },
 			//					gchordbox: { type: "boolean", optional: true },
-			//					graceslurs: { type: "boolean", optional: true },
 			//					gracespacebefore: { type: "number", optional: true },
 			//					gracespaceinside: { type: "number", optional: true },
 			//					gracespaceafter: { type: "number", optional: true },
@@ -691,10 +745,26 @@ var parseDirective = {};
 			//					titleformat: { type: "string", optional: true },
 			case "bagpipes":tune.formatting.bagpipes = true;break;
 			case "flatbeams":tune.formatting.flatbeams = true;break;
+			case "jazzchords":tune.formatting.jazzchords = true;break;
 			case "landscape":multilineVars.landscape = true;break;
 			case "papersize":multilineVars.papersize = restOfString;break;
-			case "slurgraces":tune.formatting.slurgraces = true;break;
-			case "stretchlast":tune.formatting.stretchlast = true;break;
+			case "graceslurs":
+				if (tokens.length !== 1)
+					return "Directive graceslurs requires one parameter: 0 or 1";
+				if (tokens[0].token === '0' || tokens[0].token === 'false')
+					tune.formatting.graceSlurs = false;
+				else if (tokens[0].token === '1' || tokens[0].token === 'true')
+					tune.formatting.graceSlurs = true;
+				else
+					return "Directive graceslurs requires one parameter: 0 or 1 (received " + tokens[0].token + ')';
+				break;
+			case "stretchlast":
+				var sl = parseStretchLast(tokens);
+				if (sl.value !== undefined)
+					tune.formatting.stretchlast = sl.value;
+				if (sl.error)
+					return sl.error;
+				break;
 			case "titlecaps":multilineVars.titlecaps = true;break;
 			case "titleleft":tune.formatting.titleleft = true;break;
 			case "measurebox":tune.formatting.measurebox = true;break;
@@ -734,21 +804,21 @@ var parseDirective = {};
 				var voiceScale = tokens.shift();
 				if (multilineVars.currentVoice) {
 					multilineVars.currentVoice.scale = voiceScale.floatt;
-					tune.changeVoiceScale(multilineVars.currentVoice.scale);
+					tuneBuilder.changeVoiceScale(multilineVars.currentVoice.scale);
 				}
 				return null;
 			case "vskip":
 				var vskip = Math.round(getRequiredMeasurement(cmd, tokens));
 				if (vskip.error)
 					return vskip.error;
-				tune.addSpacing(vskip);
+				tuneBuilder.addSpacing(vskip);
 				return null;
 			case "scale":
 				setScale(cmd, tokens);
 				break;
 			case "sep":
 				if (tokens.length === 0)
-					tune.addSeparator(14,14,85); // If no parameters are given, then there is a default size.
+					tuneBuilder.addSeparator(14,14,85, { startChar: multilineVars.iChar, endChar: multilineVars.iChar+5}); // If no parameters are given, then there is a default size.
 				else {
 					var points = tokenizer.getMeasurement(tokens);
 					if (points.used === 0)
@@ -764,7 +834,7 @@ var parseDirective = {};
 					if (points.used === 0 || tokens.length !== 0)
 						return "Directive \"" + cmd + "\" requires 3 numbers: space above, space below, length of line";
 					var lenLine = points.value;
-					tune.addSeparator(spaceAbove, spaceBelow, lenLine);
+					tuneBuilder.addSeparator(spaceAbove, spaceBelow, lenLine, { startChar: multilineVars.iChar, endChar: multilineVars.iChar+restOfString.length});
 				}
 				break;
 			case "barsperstaff":
@@ -804,16 +874,28 @@ var parseDirective = {};
 				if (tokens.length !== 1 || tokens[0].type !== 'number') {
 					return 'Directive setbarnb requires a number as a parameter.';
 				}
-				multilineVars.currBarNumber = tune.setBarNumberImmediate(tokens[0].intt);
+				multilineVars.currBarNumber = tuneBuilder.setBarNumberImmediate(tokens[0].intt);
 				break;
 			case "begintext":
-				multilineVars.inTextBlock = true;
+				var textBlock = '';
+				line = tokenizer.nextLine();
+				while(line && line.indexOf('%%endtext') !== 0) {
+					if (parseCommon.startsWith(line, "%%"))
+						textBlock += line.substring(2) + "\n";
+					else
+						textBlock += line + "\n";
+					line = tokenizer.nextLine();
+				}
+				tuneBuilder.addText(textBlock, { startChar: multilineVars.iChar, endChar: multilineVars.iChar+textBlock.length+7});
 				break;
 			case "continueall":
 				multilineVars.continueall = true;
 				break;
 			case "beginps":
-				multilineVars.inPsBlock = true;
+				line = tokenizer.nextLine();
+				while(line && line.indexOf('%%endps') !== 0) {
+					tokenizer.nextLine();
+				}
 				warn("Postscript ignored", str, 0);
 				break;
 			case "deco":
@@ -823,11 +905,11 @@ var parseDirective = {};
 				break;
 			case "text":
 				var textstr = tokenizer.translateString(restOfString);
-				tune.addText(parseDirective.parseFontChangeLine(textstr));
+				tuneBuilder.addText(parseDirective.parseFontChangeLine(textstr), { startChar: multilineVars.iChar, endChar: multilineVars.iChar+restOfString.length+7});
 				break;
 			case "center":
 				var centerstr = tokenizer.translateString(restOfString);
-				tune.addCentered(parseDirective.parseFontChangeLine(centerstr));
+				tuneBuilder.addCentered(parseDirective.parseFontChangeLine(centerstr));
 				break;
 			case "font":
 				// don't need to do anything for this; it is a useless directive
@@ -891,8 +973,8 @@ var parseDirective = {};
 						multilineVars.staves.push({index: multilineVars.staves.length, numVoices: 0});
 					}
 					var staff = parseCommon.last(multilineVars.staves);
-					if (bracket !== undefined) staff.bracket = bracket;
-					if (brace !== undefined) staff.brace = brace;
+					if (bracket !== undefined && staff.bracket === undefined) staff.bracket = bracket;
+					if (brace !== undefined && staff.brace === undefined) staff.brace = brace;
 					if (continueBar) staff.connectBarLines = 'end';
 					if (multilineVars.voices[id] === undefined) {
 						multilineVars.voices[id] = {staffNum: staff.index, index: staff.numVoices};
@@ -977,7 +1059,7 @@ var parseDirective = {};
 
 			case "newpage":
 				var pgNum = tokenizer.getInt(restOfString);
-				tune.addNewPage(pgNum.digits === 0 ? -1 : pgNum.value);
+				tuneBuilder.addNewPage(pgNum.digits === 0 ? -1 : pgNum.value);
 				break;
 
 			case "abc":
@@ -989,7 +1071,7 @@ var parseDirective = {};
 					case "-version":
 					case "-charset":
 						var subCmd = arr.shift();
-						tune.addMetaText(cmd+subCmd, arr.join(' '));
+						tuneBuilder.addMetaText(cmd+subCmd, arr.join(' '), { startChar: multilineVars.iChar, endChar: multilineVars.iChar+restOfString.length+5});
 						break;
 					default:
 						return "Unknown directive: " + cmd+arr[0];
@@ -1012,7 +1094,7 @@ var parseDirective = {};
 				if (footerArr.length > 3)
 					warn("Too many tabs in " + cmd + ": " + footerArr.length + " found.", restOfString, 0);
 
-				tune.addMetaTextObj(cmd, footer);
+				tuneBuilder.addMetaTextObj(cmd, footer, { startChar: multilineVars.iChar, endChar: multilineVars.iChar+str.length});
 				break;
 
 			case "midi":
@@ -1024,9 +1106,18 @@ var parseDirective = {};
 				else
 					parseMidiCommand(midi, tune, restOfString);
 				break;
+			case "percmap":
+				var percmap = interpretPercMap(restOfString);
+				if (percmap.error)
+					warn(percmap.error, str, 8);
+				else {
+					if (!tune.formatting.percmap)
+						tune.formatting.percmap = {};
+					tune.formatting.percmap[percmap.key] = percmap.value;
+				}
+				break;
 
 			case "map":
-			case "percmap":
 			case "playtempo":
 			case "auquality":
 			case "continuous":
@@ -1064,6 +1155,9 @@ var parseDirective = {};
 					case "vocalfont":
 					case "wordsfont":
 					case "annotationfont":
+					case "tablabelfont":
+					case "tabnumberfont":
+					case "tabgracefont":
 						getChangingFont(cmd, tokens, value);
 						break;
 					case "scale":
@@ -1077,12 +1171,41 @@ var parseDirective = {};
 					case "freegchord":
 						scratch = addMultilineVarBool('freegchord', cmd, tokens);
 						if (scratch !== null) warn(scratch);
+						break;
+					case "fontboxpadding":
+						if (tokens.length !== 1 || tokens[0].type !== 'number')
+							warn("Directive \"" + cmd + "\" requires a number as a parameter.");
+						tune.formatting.fontboxpadding = tokens[0].floatt;
+						break;
+					case "stretchlast":
+						var sl = parseStretchLast(tokens);
+						if (sl.value !== undefined)
+							tune.formatting.stretchlast = sl.value;
+						if (sl.error)
+							return sl.error;
+						break;
 					default:
 						warn("Formatting directive unrecognized: ", cmd, 0);
 				}
 			}
 		}
 	};
+
+	function parseStretchLast(tokens) {
+		if (tokens.length === 0)
+			return { value: 1 }; // if there is no value then the presence of this is the same as "true"
+		else if (tokens.length === 1) {
+			if (tokens[0].type === "number") {
+				if (tokens[0].floatt >= 0 || tokens[0].floatt <= 1)
+					return {value: tokens[0].floatt};
+			} else if (tokens[0].token === 'false') {
+				return { value: 0 };
+			} else if (tokens[0].token === 'true') {
+				return {value: 1};
+			}
+		}
+		return { error: "Directive stretchlast requires zero or one parameter: false, true, or number between 0 and 1 (received " + tokens[0].token + ')' };
+	}
 })();
 
 module.exports = parseDirective;