abcjs 6.4.1 → 6.4.3

package/src/tablatures/instruments/string-tablature.js

@@ -6,15 +6,16 @@
  */
 
 function StringTablature(numLines, lineSpace) {
-  this.numLines = numLines;
-  this.lineSpace = lineSpace;
-  this.verticalSize = this.numLines * this.lineSpace;
-  var pitch = 3;
-  this.bar = {
-    pitch: pitch,
-    pitch2: lineSpace * numLines,
-    height: 5,
-  };
+	//console.log("INIT StringTablature constructor")
+	this.numLines = numLines;
+	this.lineSpace = lineSpace;
+	this.verticalSize = this.numLines * this.lineSpace;
+	var pitch = 3;
+	this.bar = {
+		pitch: pitch,
+		pitch2: lineSpace * numLines,
+		height: 5,
+	};
 }
 
 /**
@@ -22,35 +23,37 @@ function StringTablature(numLines, lineSpace) {
  * @param {} line 
  */
 StringTablature.prototype.bypass = function (line) {
-  var voices = line.staffGroup.voices;
-  if (voices.length > 0) {
-    if (voices[0].isPercussion) return true;
-  }
-  return false;
-};  
+	//console.log("RENDER StringTablature bypass")
+	var voices = line.staffGroup.voices;
+	if (voices.length > 0) {
+		if (voices[0].isPercussion) return true;
+	}
+	return false;
+};
 
 
 StringTablature.prototype.setRelative = function (child, relative, first) {
-  switch (child.type) {
-    case 'bar':
-      relative.pitch = this.bar.pitch;
-      relative.pitch2 = this.bar.pitch2;
-      relative.height = this.height;
-      break;
-    case 'symbol':
-      var top = this.bar.pitch2 / 2;
-      if (child.name == 'dots.dot') {
-        if (first) {
-          relative.pitch = top;
-          return false;
-        } else {
-          relative.pitch = top + this.lineSpace;
-          return true;
-        }
-      }
-      break;
-  }
-  return first;
+	//console.log("RENDER StringTablature setRelative")
+	switch (child.type) {
+		case 'bar':
+			relative.pitch = this.bar.pitch;
+			relative.pitch2 = this.bar.pitch2;
+			relative.height = this.height;
+			break;
+		case 'symbol':
+			var top = this.bar.pitch2 / 2;
+			if (child.name == 'dots.dot') {
+				if (first) {
+					relative.pitch = top;
+					return false;
+				} else {
+					relative.pitch = top + this.lineSpace;
+					return true;
+				}
+			}
+			break;
+	}
+	return first;
 };
 
 module.exports = StringTablature;

package/src/tablatures/instruments/tab-note.js

@@ -1,216 +1,221 @@
-var {noteToMidi, midiToNote} = require('../../synth/note-to-midi');
+var { noteToMidi, midiToNote } = require('../../synth/note-to-midi');
 
 /**
  * 
  * Note structure for Tabs
  * 
  */
-var notes = ['A', 'B', 'C', 'D', 'E', 'F', 'G'];
 
 
 function TabNote(note, clefTranspose) {
-  var pitch = noteToMidi(note)
-  if (clefTranspose)
-    pitch += clefTranspose
-  var newNote = midiToNote(pitch);
-  var isFlat = false;
-  var isSharp = false;
-  var isAltered = false;
-  var natural = null;
-  var quarter = null;
-  var isDouble = false;
-  var acc = 0;
-
-  if (note.startsWith('_')) {
-    isFlat = true;
-    acc = -1;
-    // check quarter flat
-    if (note[1] == '/') {
-      isFlat = false;
-      quarter = "v";
-      acc = 0;
-    } else if (note[1] == '_') {
-      // double flat
-      isDouble = true;
-      acc -= 1;
-    }
-  } else if (note.startsWith('^')) {
-    isSharp = true;
-    acc = +1;
-    // check quarter sharp
-    if (note[1] == '/') {
-      isSharp = false;
-      quarter = "^";
-      acc = 0;
-    } else if (note[1] == '^') {
-      // double sharp
-      isDouble = true;
-      acc += 1;
-    }
-  } else if (note.startsWith('=')) {
-    natural = true;
-    acc = 0;
-  }
-  isAltered = isFlat || isSharp || (quarter != null);
-  if (isAltered || natural) {
-    if ((quarter != null) || (isDouble)) {
-      newNote = note.slice(2);
-    } else {
-      newNote = note.slice(1);
-    }
-  }
-  var hasComma = (newNote.match(/,/g) || []).length;
-  var hasQuote = (newNote.match(/'/g) || []).length;
-
-  this.pitch = pitch
-  this.pitchAltered = 0
-  this.name = newNote;
-  this.acc = acc;
-  this.isSharp = isSharp;
-  this.isKeySharp = false;
-  this.isDouble = isDouble;
-  this.isAltered = isAltered;
-  this.isFlat = isFlat;
-  this.isKeyFlat = false;
-  this.natural = natural;
-  this.quarter = quarter;
-  this.isLower = (this.name == this.name.toLowerCase());
-  this.name = this.name[0].toUpperCase();
-  this.hasComma = hasComma;
-  this.isQuoted = hasQuote;
+	//console.log("INIT/RENDER TabNote constructor")
+	var pitch = noteToMidi(note)
+	if (clefTranspose)
+		pitch += clefTranspose
+	var newNote = midiToNote(pitch);
+	var isFlat = false;
+	var isSharp = false;
+	var isAltered = false;
+	var natural = null;
+	var quarter = null;
+	var isDouble = false;
+	var acc = 0;
+
+	if (note.startsWith('_')) {
+		isFlat = true;
+		acc = -1;
+		// check quarter flat
+		if (note[1] == '/') {
+			isFlat = false;
+			quarter = "v";
+			acc = 0;
+		} else if (note[1] == '_') {
+			// double flat
+			isDouble = true;
+			acc -= 1;
+		}
+	} else if (note.startsWith('^')) {
+		isSharp = true;
+		acc = +1;
+		// check quarter sharp
+		if (note[1] == '/') {
+			isSharp = false;
+			quarter = "^";
+			acc = 0;
+		} else if (note[1] == '^') {
+			// double sharp
+			isDouble = true;
+			acc += 1;
+		}
+	} else if (note.startsWith('=')) {
+		natural = true;
+		acc = 0;
+	}
+	isAltered = isFlat || isSharp || (quarter != null);
+	if (isAltered || natural) {
+		if ((quarter != null) || (isDouble)) {
+			newNote = note.slice(2);
+		} else {
+			newNote = note.slice(1);
+		}
+	}
+	var hasComma = (newNote.match(/,/g) || []).length;
+	var hasQuote = (newNote.match(/'/g) || []).length;
+
+	this.pitch = pitch
+	this.pitchAltered = 0
+	this.name = newNote;
+	this.acc = acc;
+	this.isSharp = isSharp;
+	this.isKeySharp = false;
+	this.isDouble = isDouble;
+	this.isAltered = isAltered;
+	this.isFlat = isFlat;
+	this.isKeyFlat = false;
+	this.natural = natural;
+	this.quarter = quarter;
+	this.isLower = (this.name == this.name.toLowerCase());
+	this.name = this.name[0].toUpperCase();
+	this.hasComma = hasComma;
+	this.isQuoted = hasQuote;
 }
 
 function cloneNote(self) {
-  var newNote = self.name;
-  var newTabNote = new TabNote(newNote);
-  newTabNote.pitch = self.pitch;
-  newTabNote.hasComma = self.hasComma;
-  newTabNote.isLower = self.isLower;
-  newTabNote.isQuoted = self.isQuoted;
-  newTabNote.isSharp = self.isSharp;
-  newTabNote.isKeySharp = self.isKeySharp;
-  newTabNote.isFlat = self.isFlat;
-  newTabNote.isKeyFlat = self.isKeyFlat;
-  return newTabNote;
-} 
+	var newNote = self.name;
+	var newTabNote = new TabNote(newNote);
+	newTabNote.pitch = self.pitch;
+	newTabNote.hasComma = self.hasComma;
+	newTabNote.isLower = self.isLower;
+	newTabNote.isQuoted = self.isQuoted;
+	newTabNote.isSharp = self.isSharp;
+	newTabNote.isKeySharp = self.isKeySharp;
+	newTabNote.isFlat = self.isFlat;
+	newTabNote.isKeyFlat = self.isKeyFlat;
+	return newTabNote;
+}
 TabNote.prototype.sameNoteAs = function (note) {
-  return note.pitch === this.pitch
+	//console.log("INIT TabNote sameNoteAs")
+	return note.pitch === this.pitch
 };
 
 TabNote.prototype.isLowerThan = function (note) {
-  return note.pitch > this.pitch
+	//console.log("INIT TabNote isLowerThan")
+	return note.pitch > this.pitch
 };
 
-TabNote.prototype.checkKeyAccidentals = function(accidentals, measureAccidentals) {
-  if (this.isAltered || this.natural)
-    return
-  if (measureAccidentals[this.name.toUpperCase()]) {
-    switch (measureAccidentals[this.name.toUpperCase()]) {
-      case "__": this.acc = -2; this.pitchAltered = -2; return;
-      case "_": this.acc = -1; this.pitchAltered = -1; return;
-      case "=": this.acc = 0; this.pitchAltered = 0; return;
-      case "^": this.acc = 1; this.pitchAltered = 1; return;
-      case "^^": this.acc = 2; this.pitchAltered = 2; return;
-    }
-  } else if (accidentals) {
-    var curNote = this.name;
-    for (var iii = 0; iii < accidentals.length; iii++) {
-      var curAccidentals = accidentals[iii];
-      if (curNote == curAccidentals.note.toUpperCase()) {
-        if (curAccidentals.acc == 'flat') {
-          this.acc = -1;
-          this.isKeyFlat = true;
-          this.pitchAltered = -1
-        }
-        if (curAccidentals.acc == 'sharp') {
-          this.acc = +1;
-          this.isKeySharp = true;
-          this.pitchAltered = 1
-        }
-      }
-    }
-  }
+TabNote.prototype.checkKeyAccidentals = function (accidentals, measureAccidentals) {
+	//console.log("RENDER TabNote checkKeyAccidentals")
+	if (this.isAltered || this.natural)
+		return
+	if (measureAccidentals[this.name.toUpperCase()]) {
+		switch (measureAccidentals[this.name.toUpperCase()]) {
+			case "__": this.acc = -2; this.pitchAltered = -2; return;
+			case "_": this.acc = -1; this.pitchAltered = -1; return;
+			case "=": this.acc = 0; this.pitchAltered = 0; return;
+			case "^": this.acc = 1; this.pitchAltered = 1; return;
+			case "^^": this.acc = 2; this.pitchAltered = 2; return;
+		}
+	} else if (accidentals) {
+		var curNote = this.name;
+		for (var iii = 0; iii < accidentals.length; iii++) {
+			var curAccidentals = accidentals[iii];
+			if (curNote == curAccidentals.note.toUpperCase()) {
+				if (curAccidentals.acc == 'flat') {
+					this.acc = -1;
+					this.isKeyFlat = true;
+					this.pitchAltered = -1
+				}
+				if (curAccidentals.acc == 'sharp') {
+					this.acc = +1;
+					this.isKeySharp = true;
+					this.pitchAltered = 1
+				}
+			}
+		}
+	}
 };
 
 TabNote.prototype.getAccidentalEquiv = function () {
-  var cloned = cloneNote(this);
-  if (cloned.isSharp || cloned.isKeySharp ) {
-    cloned = cloned.nextNote();
-    cloned.isFlat = true;
-    cloned.isSharp = false;
-    cloned.isKeySharp = false;
-  } else if (cloned.isFlat || cloned.isKeyFlat ) {
-    cloned = cloned.prevNote();
-    cloned.isSharp = true;
-    cloned.isFlat = false;
-    cloned.isKeyFlat = false;
-  }
-  return cloned;
+	//console.log("TabNote getAccidentalEquiv")
+	var cloned = cloneNote(this);
+	if (cloned.isSharp || cloned.isKeySharp) {
+		cloned = cloned.nextNote();
+		cloned.isFlat = true;
+		cloned.isSharp = false;
+		cloned.isKeySharp = false;
+	} else if (cloned.isFlat || cloned.isKeyFlat) {
+		cloned = cloned.prevNote();
+		cloned.isSharp = true;
+		cloned.isFlat = false;
+		cloned.isKeyFlat = false;
+	}
+	return cloned;
 };
 
 
 TabNote.prototype.nextNote = function () {
-  var note = midiToNote(this.pitch+1+this.pitchAltered)
-  return new TabNote(note)
+	//console.log("INIT TabNote nextNote")
+	var note = midiToNote(this.pitch + 1 + this.pitchAltered)
+	return new TabNote(note)
 };
 
 TabNote.prototype.prevNote = function () {
-  var note = midiToNote(this.pitch-1+this.pitchAltered)
-  return new TabNote(note)
+	//console.log("TabNote prevNote")
+	var note = midiToNote(this.pitch - 1 + this.pitchAltered)
+	return new TabNote(note)
 };
 
-TabNote.prototype.emitNoAccidentals = function (  ) {
-  var returned = this.name;
-  if (this.isLower) {
-    returned = returned.toLowerCase();
-  }
-  for (var ii = 0; ii < this.isQuoted; ii++) {
-    returned += "'";
-  }
-  for (var jj = 0; jj < this.hasComma; jj++) {
-    returned += ",";
-  }
-  return returned;
+TabNote.prototype.emitNoAccidentals = function () {
+	//console.log("TabNote emitNoAccidentals")
+	var returned = this.name;
+	if (this.isLower) {
+		returned = returned.toLowerCase();
+	}
+	for (var ii = 0; ii < this.isQuoted; ii++) {
+		returned += "'";
+	}
+	for (var jj = 0; jj < this.hasComma; jj++) {
+		returned += ",";
+	}
+	return returned;
 };
 
 TabNote.prototype.emit = function () {
-  var returned = this.name;
-  if (this.isSharp || this.isKeySharp ) {
-    returned = '^' + returned;
-    if (this.isDouble) {
-      returned = '^' + returned;
-    }
-  }
-  if (this.isFlat || this.isKeyFlat) {
-    returned = '_' + returned;
-    if (this.isDouble) {
-      returned = '_' + returned;
-    }
-  }
-  if (this.quarter) {
-    if (this.quarter == "^") {
-      returned = "^/" + returned;
-    } else {
-      returned = "_/" + returned;
-    }
-  }
-  if (this.natural) {
-    returned = '=' + returned;
-  }
-  for (var ii = 1; ii <= this.hasComma; ii++) {
-    returned += ',';
-  }
-  
-  if (this.isLower) {
-    returned = returned.toLowerCase();
-    for (var jj = 1; jj <= this.isQuoted; jj++) {
-      returned += "'";
-    }
-  }
-  return returned;
+	//console.log("INIT/RENDER TabNote emit")
+	var returned = this.name;
+	if (this.isSharp || this.isKeySharp) {
+		returned = '^' + returned;
+		if (this.isDouble) {
+			returned = '^' + returned;
+		}
+	}
+	if (this.isFlat || this.isKeyFlat) {
+		returned = '_' + returned;
+		if (this.isDouble) {
+			returned = '_' + returned;
+		}
+	}
+	if (this.quarter) {
+		if (this.quarter == "^") {
+			returned = "^/" + returned;
+		} else {
+			returned = "_/" + returned;
+		}
+	}
+	if (this.natural) {
+		returned = '=' + returned;
+	}
+	for (var ii = 1; ii <= this.hasComma; ii++) {
+		returned += ',';
+	}
+
+	if (this.isLower) {
+		returned = returned.toLowerCase();
+		for (var jj = 1; jj <= this.isQuoted; jj++) {
+			returned += "'";
+		}
+	}
+	return returned;
 };
 
-module.exports = {
-  'TabNote': TabNote,
-  'notes': notes
-};
+module.exports = TabNote

package/src/tablatures/instruments/tab-notes.js

@@ -1,41 +1,36 @@
 
 var TabNote = require('./tab-note');
 
-var notes = TabNote.notes;
+var notes = ['A', 'B', 'C', 'D', 'E', 'F', 'G'];
 
-function TabNotes(fromNote, toNote) {
-  this.fromN = new TabNote.TabNote(fromNote);
-  this.toN = new TabNote.TabNote(toNote);
+function tabNotes(fromNote, toNote) {
+	//console.log("INIT TabNotes")
+	var fromN = new TabNote(fromNote);
+	var toN = new TabNote(toNote);
+	// check that toN is not lower than fromN
+	if (toN.isLowerThan(fromN)) {
+		var from = fromN.emit();
+		var tn = toN.emit();
+		return {
+			error: 'Invalid string Instrument tuning : ' +
+				tn + ' string lower than ' + from + ' string'
+		};
+	}
+	var buildReturned = [];
+	var startIndex = notes.indexOf(fromN.name);
+	var toIndex = notes.indexOf(toN.name);
+	if ((startIndex == -1) || (toIndex == -1)) {
+		return buildReturned;
+	}
+	var finished = false;
+	while (!finished) {
+		buildReturned.push(fromN.emit());
+		fromN = fromN.nextNote();
+		if (fromN.sameNoteAs(toN)) {
+			finished = true;
+		}
+	}
+	return buildReturned;
 }
 
-
-TabNotes.prototype.build = function () {
-  var fromN = this.fromN;
-  var toN = this.toN;
-  // check that toN is not lower than fromN
-  if (toN.isLowerThan(fromN)) {
-    var from = fromN.emit();
-    var tn = toN.emit();
-    return {
-      error: 'Invalid string Instrument tuning : ' +
-        tn + ' string lower than ' + from + ' string'
-    };
-  }
-  var buildReturned = [];
-  var startIndex = notes.indexOf(fromN.name);
-  var toIndex = notes.indexOf(toN.name);
-  if ((startIndex == -1) || (toIndex == -1)) {
-    return buildReturned;
-  }
-  var finished = false;
-  while (!finished) {
-    buildReturned.push(fromN.emit());
-    fromN = fromN.nextNote();
-    if (fromN.sameNoteAs(toN)) {
-      finished = true;
-    }
-  }
-  return buildReturned;
-};
-
-module.exports = TabNotes;
+module.exports = tabNotes;

package/src/tablatures/instruments/tab-string.js

@@ -1,47 +1,65 @@
 
 var StringTablature = require('./string-tablature');
-var TabCommon = require('../tab-common');
-var TabRenderer = require('../tab-renderer');
-var TabStringPatterns = require('./tab-string-patterns');
+var tabRenderer = require('../render/tab-renderer');
+var StringPatterns = require('./string-patterns');
 
 
 /**
  * upon init mainly store provided instances for later usage
  * @param {*} abcTune  the parsed tune AST tree
-*  @param {*} tuneNumber  the parsed tune AST tree
+ * @param {*} tuneNumber  the parsed tune AST tree
  * @param {*} params  complementary args provided to Tablature Plugin
  */
-Plugin.prototype.init = function (abcTune, tuneNumber, params, staffNumber, tabSettings) {
-  var _super = new TabCommon(abcTune, tuneNumber, params);
-  this.abcTune = abcTune;
-  this._super = _super;
-  this.linePitch = 3;
-  this.nbLines = tabSettings.defaultTuning.length;
-  this.isTabBig = tabSettings.isTabBig;
-  this.tabSymbolOffset = tabSettings.tabSymbolOffset;
-  this.capo = params.capo;
-  this.transpose = params.visualTranspose;
-  this.hideTabSymbol = params.hideTabSymbol;
-  this.tablature = new StringTablature(this.nbLines,
-    this.linePitch);
-  var semantics = new TabStringPatterns(this, tabSettings.defaultTuning);
-  this.semantics = semantics;
+Plugin.prototype.init = function (abcTune, tuneNumber, params, tabSettings) {
+	//console.log("INIT AbcStringTab Plugin.init")
+	this.tune = abcTune;
+	this.params = params;
+	this.tuneNumber = tuneNumber;
+	this.inError = false;
+	this.abcTune = abcTune;
+	this.linePitch = 3;
+	this.nbLines = tabSettings.defaultTuning.length;
+	this.isTabBig = tabSettings.isTabBig;
+	this.tabSymbolOffset = tabSettings.tabSymbolOffset;
+	this.capo = params.capo;
+	this.transpose = params.visualTranspose;
+	this.hideTabSymbol = params.hideTabSymbol;
+	this.tablature = new StringTablature(this.nbLines, this.linePitch);
+	var tuning = params.tuning;
+	if (!tuning) {
+		tuning = tabSettings.defaultTuning;
+	}
+	this.tuning = tuning;
+	this.semantics = new StringPatterns(this);
+};
+
+Plugin.prototype.setError = function (error) {
+	//console.log("Plugin setError")
+	if (error) {
+		this.error = error;
+		this.inError = true;
+		if (this.tune.warnings) {
+			this.tune.warnings.push(error);
+		} else {
+			this.tune.warnings = [error];
+		}
+	}
 };
 
 Plugin.prototype.render = function (renderer, line, staffIndex) {
-  if (this._super.inError) return;
-  if (this.tablature.bypass(line)) return;
-  var rndrer = new TabRenderer(this, renderer, line, staffIndex);
-  rndrer.doLayout();
+	//console.log("RENDER AbcStringTab Plugin.render")
+	if (this.inError) return;
+	if (this.tablature.bypass(line)) return;
+	tabRenderer(this, renderer, line, staffIndex);
 };
 
-function Plugin() {}
+function Plugin() { }
 
 //
 // Tablature plugin definition
 //
 var AbcStringTab = function () {
-  return { name: 'StringTab', tablature: Plugin };
+	return { name: 'StringTab', tablature: Plugin };
 };
 
 module.exports = AbcStringTab;