abcjs-rails 1.1.0 → 1.1.1

data/app/assets/javascripts/abcjs/parse/abc_parse_header.js

@@ -0,0 +1,521 @@
+//    abc_parse_header.js: parses a the header fields from a string representing ABC Music Notation into a usable internal structure.
+//    Copyright (C) 2010 Paul Rosen (paul at paulrosen dot net)
+//
+//    This program is free software: you can redistribute it and/or modify
+//    it under the terms of the GNU General Public License as published by
+//    the Free Software Foundation, either version 3 of the License, or
+//    (at your option) any later version.
+//
+//    This program is distributed in the hope that it will be useful,
+//    but WITHOUT ANY WARRANTY; without even the implied warranty of
+//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//    GNU General Public License for more details.
+//
+//    You should have received a copy of the GNU General Public License
+//    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+/*global window */
+
+if (!window.ABCJS)
+	window.ABCJS = {};
+
+if (!window.ABCJS.parse)
+	window.ABCJS.parse = {};
+
+window.ABCJS.parse.ParseHeader = function(tokenizer, warn, multilineVars, tune) {
+	window.ABCJS.parse.parseKeyVoice.initialize(tokenizer, warn, multilineVars, tune);
+	window.ABCJS.parse.parseDirective.initialize(tokenizer, warn, multilineVars, tune);
+
+
+	this.setTitle = function(title) {
+		if (multilineVars.hasMainTitle)
+			tune.addSubtitle(tokenizer.translateString(tokenizer.stripComment(title)));	// display secondary title
+		else
+		{
+			tune.addMetaText("title", tokenizer.translateString(tokenizer.theReverser(tokenizer.stripComment(title))));
+			multilineVars.hasMainTitle = true;
+		}
+	};
+
+	this.setMeter = function(line) {
+		line = tokenizer.stripComment(line);
+		if (line === 'C') {
+			if (multilineVars.havent_set_length === true)
+				multilineVars.default_length = 0.125;
+			return {type: 'common_time'};
+		} else if (line === 'C|') {
+			if (multilineVars.havent_set_length === true)
+				multilineVars.default_length = 0.125;
+			return {type: 'cut_time'};
+		} else if (line === 'o') {
+			if (multilineVars.havent_set_length === true)
+				multilineVars.default_length = 0.125;
+			return {type: 'tempus_perfectum'};
+		} else if (line === 'c') {
+			if (multilineVars.havent_set_length === true)
+				multilineVars.default_length = 0.125;
+			return {type: 'tempus_imperfectum'};
+		} else if (line === 'o.') {
+			if (multilineVars.havent_set_length === true)
+				multilineVars.default_length = 0.125;
+			return {type: 'tempus_perfectum_prolatio'};
+		} else if (line === 'c.') {
+			if (multilineVars.havent_set_length === true)
+				multilineVars.default_length = 0.125;
+			return {type: 'tempus_imperfectum_prolatio'};
+		} else if (line.length === 0 || line.toLowerCase() === 'none') {
+			if (multilineVars.havent_set_length === true)
+				multilineVars.default_length = 0.125;
+			return null;
+		}
+		else
+		{
+			var tokens = tokenizer.tokenize(line, 0, line.length);
+			// the form is [open_paren] decimal [ plus|dot decimal ]... [close_paren] slash decimal [plus same_as_before]
+			try {
+				var parseNum = function() {
+					// handles this much: [open_paren] decimal [ plus|dot decimal ]... [close_paren]
+					var ret = {value: 0, num: ""};
+
+					var tok = tokens.shift();
+					if (tok.token === '(')
+						tok = tokens.shift();
+					while (1) {
+						if (tok.type !== 'number') throw "Expected top number of meter";
+						ret.value += parseInt(tok.token);
+						ret.num += tok.token;
+						if (tokens.length === 0 || tokens[0].token === '/') return ret;
+						tok = tokens.shift();
+						if (tok.token === ')') {
+							if (tokens.length === 0 || tokens[0].token === '/') return ret;
+							throw "Unexpected paren in meter";
+						}
+						if (tok.token !== '.' && tok.token !== '+') throw "Expected top number of meter";
+						ret.num += tok.token;
+						if (tokens.length === 0) throw "Expected top number of meter";
+						tok = tokens.shift();
+					}
+					return ret;	// just to suppress warning
+				};
+
+				var parseFraction = function() {
+					// handles this much: parseNum slash decimal
+					var ret = parseNum();
+					if (tokens.length === 0) return ret;
+					var tok = tokens.shift();
+					if (tok.token !== '/') throw "Expected slash in meter";
+					tok = tokens.shift();
+					if (tok.type !== 'number') throw "Expected bottom number of meter";
+					ret.den = tok.token;
+					ret.value = ret.value / parseInt(ret.den);
+					return ret;
+				};
+
+				if (tokens.length === 0) throw "Expected meter definition in M: line";
+				var meter = {type: 'specified', value: [ ]};
+				var totalLength = 0;
+				while (1) {
+					var ret = parseFraction();
+					totalLength += ret.value;
+					var mv = { num: ret.num };
+					if (ret.den !== undefined)
+						mv.den = ret.den;
+					meter.value.push(mv);
+					if (tokens.length === 0) break;
+					//var tok = tokens.shift();
+					//if (tok.token !== '+') throw "Extra characters in M: line";
+				}
+
+				if (multilineVars.havent_set_length === true) {
+					multilineVars.default_length = totalLength < 0.75 ? 0.0625 : 0.125;
+				}
+				return meter;
+			} catch (e) {
+				warn(e, line, 0);
+			}
+		}
+		return null;
+	};
+
+	this.calcTempo = function(relTempo) {
+		var dur = 1/4;
+		if (multilineVars.meter && multilineVars.meter.type === 'specified') {
+			dur = 1 / parseInt(multilineVars.meter.value[0].den);
+		} else if (multilineVars.origMeter && multilineVars.origMeter.type === 'specified') {
+			dur = 1 / parseInt(multilineVars.origMeter.value[0].den);
+		}
+		//var dur = multilineVars.default_length ? multilineVars.default_length : 1;
+		for (var i = 0; i < relTempo.duration; i++)
+			relTempo.duration[i] = dur * relTempo.duration[i];
+		return relTempo;
+	};
+
+	this.resolveTempo = function() {
+		if (multilineVars.tempo) {	// If there's a tempo waiting to be resolved
+			this.calcTempo(multilineVars.tempo);
+			tune.metaText.tempo = multilineVars.tempo;
+			delete multilineVars.tempo;
+		}
+	};
+
+	this.addUserDefinition = function(line, start, end) {
+		var equals = line.indexOf('=', start);
+		if (equals === -1) {
+			warn("Need an = in a macro definition", line, start);
+			return;
+		}
+
+		var before = window.ABCJS.parse.strip(line.substring(start, equals));
+		var after = window.ABCJS.parse.strip(line.substring(equals+1));
+
+		if (before.length !== 1) {
+			warn("Macro definitions can only be one character", line, start);
+			return;
+		}
+		var legalChars = "HIJKLMNOPQRSTUVWXYhijklmnopqrstuvw~";
+		if (legalChars.indexOf(before) === -1) {
+			warn("Macro definitions must be H-Y, h-w, or tilde", line, start);
+			return;
+		}
+		if (after.length === 0) {
+			warn("Missing macro definition", line, start);
+			return;
+		}
+		if (multilineVars.macros === undefined)
+			multilineVars.macros = {};
+		multilineVars.macros[before] = after;
+	};
+
+	this.setDefaultLength = function(line, start, end) {
+		var len = window.ABCJS.parse.gsub(line.substring(start, end), " ", "");
+		var len_arr = len.split('/');
+		if (len_arr.length === 2) {
+			var n = parseInt(len_arr[0]);
+			var d = parseInt(len_arr[1]);
+			if (d > 0) {
+				multilineVars.default_length = n / d;	// a whole note is 1
+				multilineVars.havent_set_length = false;
+			}
+		}
+	};
+
+	this.setTempo = function(line, start, end) {
+		//Q - tempo; can be used to specify the notes per minute, e.g. If
+		//the meter denominator is a 4 note then Q:120 or Q:C=120
+		//is 120 quarter notes per minute. Similarly  Q:C3=40 would be 40
+		//dotted half notes per minute. An absolute tempo may also be
+		//set, e.g. Q:1/8=120 is 120 eighth notes per minute,
+		//irrespective of the meter's denominator.
+		//
+		// This is either a number, "C=number", "Cnumber=number", or fraction [fraction...]=number
+		// It depends on the M: field, which may either not be present, or may appear after this.
+		// If M: is not present, an eighth note is used.
+		// That means that this field can't be calculated until the end, if it is the first three types, since we don't know if we'll see an M: field.
+		// So, if it is the fourth type, set it here, otherwise, save the info in the multilineVars.
+		// The temporary variables we keep are the duration and the bpm. In the first two forms, the duration is 1.
+		// In addition, a quoted string may both precede and follow. If a quoted string is present, then the duration part is optional.
+		try {
+			var tokens = tokenizer.tokenize(line, start, end);
+
+			if (tokens.length === 0) throw "Missing parameter in Q: field";
+
+			var tempo = {};
+			var delaySet = true;
+			var token = tokens.shift();
+			if (token.type === 'quote') {
+				tempo.preString = token.token;
+				token = tokens.shift();
+				if (tokens.length === 0) {	// It's ok to just get a string for the tempo
+					return {type: 'immediate', tempo: tempo};
+				}
+			}
+			if (token.type === 'alpha' && token.token === 'C')	 { // either type 2 or type 3
+				if (tokens.length === 0) throw "Missing tempo after C in Q: field";
+				token = tokens.shift();
+				if (token.type === 'punct' && token.token === '=') {
+					// This is a type 2 format. The duration is an implied 1
+					if (tokens.length === 0) throw "Missing tempo after = in Q: field";
+					token = tokens.shift();
+					if (token.type !== 'number') throw "Expected number after = in Q: field";
+					tempo.duration = [1];
+					tempo.bpm = parseInt(token.token);
+				} else if (token.type === 'number') {
+					// This is a type 3 format.
+					tempo.duration = [parseInt(token.token)];
+					if (tokens.length === 0) throw "Missing = after duration in Q: field";
+					token = tokens.shift();
+					if (token.type !== 'punct' || token.token !== '=') throw "Expected = after duration in Q: field";
+					if (tokens.length === 0) throw "Missing tempo after = in Q: field";
+					token = tokens.shift();
+					if (token.type !== 'number') throw "Expected number after = in Q: field";
+					tempo.bpm = parseInt(token.token);
+				} else throw "Expected number or equal after C in Q: field";
+
+			} else if (token.type === 'number') {	// either type 1 or type 4
+				var num = parseInt(token.token);
+				if (tokens.length === 0 || tokens[0].type === 'quote') {
+					// This is type 1
+					tempo.duration = [1];
+					tempo.bpm = num;
+				} else {	// This is type 4
+					delaySet = false;
+					token = tokens.shift();
+					if (token.type !== 'punct' && token.token !== '/') throw "Expected fraction in Q: field";
+					token = tokens.shift();
+					if (token.type !== 'number') throw "Expected fraction in Q: field";
+					var den = parseInt(token.token);
+					tempo.duration = [num/den];
+					// We got the first fraction, keep getting more as long as we find them.
+					while (tokens.length > 0  && tokens[0].token !== '=' && tokens[0].type !== 'quote') {
+						token = tokens.shift();
+						if (token.type !== 'number') throw "Expected fraction in Q: field";
+						num = parseInt(token.token);
+						token = tokens.shift();
+						if (token.type !== 'punct' && token.token !== '/') throw "Expected fraction in Q: field";
+						token = tokens.shift();
+						if (token.type !== 'number') throw "Expected fraction in Q: field";
+						den = parseInt(token.token);
+						tempo.duration.push(num/den);
+					}
+					token = tokens.shift();
+					if (token.type !== 'punct' && token.token !== '=') throw "Expected = in Q: field";
+					token = tokens.shift();
+					if (token.type !== 'number') throw "Expected tempo in Q: field";
+					tempo.bpm = parseInt(token.token);
+				}
+			} else throw "Unknown value in Q: field";
+			if (tokens.length !== 0) {
+				token = tokens.shift();
+				if (token.type === 'quote') {
+					tempo.postString = token.token;
+					token = tokens.shift();
+				}
+				if (tokens.length !== 0) throw "Unexpected string at end of Q: field";
+			}
+			if (multilineVars.printTempo === false)
+				tempo.suppress = true;
+			return {type: delaySet?'delaySet':'immediate', tempo: tempo};
+		} catch (msg) {
+			warn(msg, line, start);
+			return {type: 'none'};
+		}
+	};
+
+	this.letter_to_inline_header = function(line, i)
+	{
+		var ws = tokenizer.eatWhiteSpace(line, i);
+		i +=ws;
+		if (line.length >= i+5 && line.charAt(i) === '[' && line.charAt(i+2) === ':') {
+			var e = line.indexOf(']', i);
+			switch(line.substring(i, i+3))
+			{
+				case "[I:":
+					var err = window.ABCJS.parse.parseDirective.addDirective(line.substring(i+3, e));
+					if (err) warn(err, line, i);
+					return [ e-i+1+ws ];
+				case "[M:":
+					var meter = this.setMeter(line.substring(i+3, e));
+					if (tune.hasBeginMusic() && meter)
+						tune.appendStartingElement('meter', -1, -1, meter);
+					else
+						multilineVars.meter = meter;
+					return [ e-i+1+ws ];
+				case "[K:":
+					var result = window.ABCJS.parse.parseKeyVoice.parseKey(line.substring(i+3, e));
+					if (result.foundClef && tune.hasBeginMusic())
+						tune.appendStartingElement('clef', -1, -1, multilineVars.clef);
+					if (result.foundKey && tune.hasBeginMusic())
+						tune.appendStartingElement('key', -1, -1, window.ABCJS.parse.parseKeyVoice.fixKey(multilineVars.clef, multilineVars.key));
+					return [ e-i+1+ws ];
+				case "[P:":
+					tune.appendElement('part', -1, -1, {title: line.substring(i+3, e)});
+					return [ e-i+1+ws ];
+				case "[L:":
+					this.setDefaultLength(line, i+3, e);
+					return [ e-i+1+ws ];
+				case "[Q:":
+					if (e > 0) {
+						var tempo = this.setTempo(line, i+3, e);
+						if (tempo.type === 'delaySet') tune.appendElement('tempo', -1, -1, this.calcTempo(tempo.tempo));
+						else if (tempo.type === 'immediate') tune.appendElement('tempo', -1, -1, tempo.tempo);
+						return [ e-i+1+ws, line.charAt(i+1), line.substring(i+3, e)];
+					}
+					break;
+				case "[V:":
+					if (e > 0) {
+						window.ABCJS.parse.parseKeyVoice.parseVoice(line, i+3, e);
+						//startNewLine();
+						return [ e-i+1+ws, line.charAt(i+1), line.substring(i+3, e)];
+					}
+					break;
+
+				default:
+					// TODO: complain about unhandled header
+			}
+		}
+		return [ 0 ];
+	};
+
+	this.letter_to_body_header = function(line, i)
+	{
+		if (line.length >= i+3) {
+			switch(line.substring(i, i+2))
+			{
+				case "I:":
+					var err = window.ABCJS.parse.parseDirective.addDirective(line.substring(i+2));
+					if (err) warn(err, line, i);
+					return [ line.length ];
+				case "M:":
+					var meter = this.setMeter(line.substring(i+2));
+					if (tune.hasBeginMusic() && meter)
+						tune.appendStartingElement('meter', -1, -1, meter);
+					return [ line.length ];
+				case "K:":
+					var result = window.ABCJS.parse.parseKeyVoice.parseKey(line.substring(i+2));
+					if (result.foundClef && tune.hasBeginMusic())
+						tune.appendStartingElement('clef', -1, -1, multilineVars.clef);
+					if (result.foundKey && tune.hasBeginMusic())
+						tune.appendStartingElement('key', -1, -1, window.ABCJS.parse.parseKeyVoice.fixKey(multilineVars.clef, multilineVars.key));
+					return [ line.length ];
+				case "P:":
+					if (tune.hasBeginMusic())
+						tune.appendElement('part', -1, -1, {title: line.substring(i+2)});
+					return [ line.length ];
+				case "L:":
+					this.setDefaultLength(line, i+2, line.length);
+					return [ line.length ];
+				case "Q:":
+					var e = line.indexOf('\x12', i+2);
+					if (e === -1) e = line.length;
+					var tempo = this.setTempo(line, i+2, e);
+					if (tempo.type === 'delaySet') tune.appendElement('tempo', -1, -1, this.calcTempo(tempo.tempo));
+					else if (tempo.type === 'immediate') tune.appendElement('tempo', -1, -1, tempo.tempo);
+				return [ e, line.charAt(i), window.ABCJS.parse.strip(line.substring(i+2))];
+				case "V:":
+					window.ABCJS.parse.parseKeyVoice.parseVoice(line, 2, line.length);
+//						startNewLine();
+					return [ line.length, line.charAt(i), window.ABCJS.parse(line.substring(i+2))];
+				default:
+					// TODO: complain about unhandled header
+			}
+		}
+		return [ 0 ];
+	};
+
+	var metaTextHeaders = {
+		A: 'author',
+		B: 'book',
+		C: 'composer',
+		D: 'discography',
+		F: 'url',
+		G: 'group',
+		I: 'instruction',
+		N: 'notes',
+		O: 'origin',
+		R: 'rhythm',
+		S: 'source',
+		W: 'unalignedWords',
+		Z: 'transcription'
+	};
+
+	this.parseHeader = function(line) {
+		if (window.ABCJS.parse.startsWith(line, '%%')) {
+			var err = window.ABCJS.parse.parseDirective.addDirective(line.substring(2));
+			if (err) warn(err, line, 2);
+			return {};
+		}
+		line = tokenizer.stripComment(line);
+		if (line.length === 0)
+			return {};
+
+		if (line.length >= 2) {
+			if (line.charAt(1) === ':') {
+				var nextLine = "";
+				if (line.indexOf('\x12') >= 0 && line.charAt(0) !== 'w') {	// w: is the only header field that can have a continuation.
+					nextLine = line.substring(line.indexOf('\x12')+1);
+					line = line.substring(0, line.indexOf('\x12'));	//This handles a continuation mark on a header field
+				}
+				var field = metaTextHeaders[line.charAt(0)];
+				if (field !== undefined) {
+					if (field === 'unalignedWords')
+						tune.addMetaTextArray(field, window.ABCJS.parse.parseDirective.parseFontChangeLine(tokenizer.translateString(tokenizer.stripComment(line.substring(2)))));
+					else
+						tune.addMetaText(field, tokenizer.translateString(tokenizer.stripComment(line.substring(2))));
+					return {};
+				} else {
+					switch(line.charAt(0))
+					{
+						case  'H':
+							tune.addMetaText("history", tokenizer.translateString(tokenizer.stripComment(line.substring(2))));
+							multilineVars.is_in_history = true;
+							break;
+						case  'K':
+							// since the key is the last thing that can happen in the header, we can resolve the tempo now
+							this.resolveTempo();
+							var result = window.ABCJS.parse.parseKeyVoice.parseKey(line.substring(2));
+							if (!multilineVars.is_in_header && tune.hasBeginMusic()) {
+								if (result.foundClef)
+									tune.appendStartingElement('clef', -1, -1, multilineVars.clef);
+								if (result.foundKey)
+									tune.appendStartingElement('key', -1, -1, window.ABCJS.parse.parseKeyVoice.fixKey(multilineVars.clef, multilineVars.key));
+							}
+							multilineVars.is_in_header = false;	// The first key signifies the end of the header.
+							break;
+						case  'L':
+							this.setDefaultLength(line, 2, line.length);
+							break;
+						case  'M':
+							multilineVars.origMeter = multilineVars.meter = this.setMeter(line.substring(2));
+							break;
+						case  'P':
+							// TODO-PER: There is more to do with parts, but the writer doesn't care.
+							if (multilineVars.is_in_header)
+								tune.addMetaText("partOrder", tokenizer.translateString(tokenizer.stripComment(line.substring(2))));
+							else
+								multilineVars.partForNextLine = tokenizer.translateString(tokenizer.stripComment(line.substring(2)));
+							break;
+						case  'Q':
+							var tempo = this.setTempo(line, 2, line.length);
+							if (tempo.type === 'delaySet') multilineVars.tempo = tempo.tempo;
+							else if (tempo.type === 'immediate') tune.metaText.tempo = tempo.tempo;
+							break;
+						case  'T':
+							this.setTitle(line.substring(2));
+							break;
+						case 'U':
+							this.addUserDefinition(line, 2, line.length);
+							break;
+						case  'V':
+							window.ABCJS.parse.parseKeyVoice.parseVoice(line, 2, line.length);
+							if (!multilineVars.is_in_header)
+								return {newline: true};
+							break;
+						case  's':
+							return {symbols: true};
+						case  'w':
+							return {words: true};
+						case 'X':
+							break;
+						case 'E':
+						case 'm':
+							warn("Ignored header", line, 0);
+							break;
+						default:
+							// It wasn't a recognized header value, so parse it as music.
+							if (nextLine.length)
+								nextLine = "\x12" + nextLine;
+							//parseRegularMusicLine(line+nextLine);
+							//nextLine = "";
+							return {regular: true, str: line+nextLine};
+					}
+				}
+				if (nextLine.length > 0)
+					return {recurse: true, str: nextLine};
+				return {};
+			}
+		}
+
+		// If we got this far, we have a regular line of mulsic
+		return {regular: true, str: line};
+	};
+};