Skip to content
This repository has been archived by the owner on Sep 6, 2023. It is now read-only.

Commit

Permalink
Merge pull request #51 from aerhard/remove-comments
Browse files Browse the repository at this point in the history 
removed comments; minor corrections in jsDoc comments
  • Loading branch information
@zolaemil
zolaemil committed Jul 4, 2014
2 parents fea8b58 + e7a0761 commit b3127e3
Show file tree
Hide file tree
Showing 10 changed files with 47 additions and 162 deletions.
76 changes: 7 additions & 69 deletions src/Converter.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@
* the License.
*/

// TODO how to distinguish between different type of <section>s

var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {

/**
Expand Down Expand Up @@ -104,7 +102,6 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {
* between two hyphens in the lyrics lines
*/
maxHyphenDistance : 75,
//sectionsOnNewLine : false, // TODO: add feature
/**
* @cfg {Object} lyricsFont The font used for rendering lyrics (and
* hyphens)
Expand Down Expand Up @@ -165,7 +162,6 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {
}
},

// TODO add setters (and getters?) for single config items / groups
/**
* initializes the Converter
* @method initConfig
Expand All @@ -178,14 +174,11 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {
me.cfg = $.extend(true, {}, me.defaults, config);
/**
* an instance of MEI2VF.SystemInfo dealing with the system and staff
* info derived from
* the MEI data
* info derived from the MEI data
* @property {MEI2VF.SystemInfo} systemInfo
*/
me.systemInfo = new m2v.SystemInfo();

// TODO see if the values of this property should better be calculated
// in the viewer object
/**
* The print space coordinates calculated from the page config.
* @property {Object} printSpace
Expand All @@ -197,8 +190,7 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {
me.printSpace = {
// substract four line distances (40px) from page_margin_top in order
// to compensate VexFlow's default top spacing / allow specifying
// absolute
// values
// absolute values
top : me.cfg.page_margin_top - 40,
left : me.cfg.page_margin_left,
right : me.cfg.page_width - me.cfg.page_margin_right,
Expand All @@ -208,7 +200,6 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {

},

// TODO instead of creating new objects each time on reset, call reset functions in the generated objects
/**
* Resets all data. Called by {@link #process}.
* @method reset
Expand All @@ -219,7 +210,7 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {
var me = this;
me.systemInfo.init(me.cfg, me.printSpace);
/**
* @property {} unresolvedTStamp2
* @property {MEI2VF.EventLink[][]} unresolvedTStamp2
*/
me.unresolvedTStamp2 = [];
/**
Expand Down Expand Up @@ -316,8 +307,7 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {
*/
me.pendingSectionBreak = true;
/**
* Contains information about the
* volta type of the current staff. Properties:
* Contains information about the volta type of the current staff. Properties:
*
* - `start` {String} indicates the number to render to the volta. When
* falsy, it is assumed that the volta does not start in the current
Expand Down Expand Up @@ -485,9 +475,6 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {
return system;
},

// TODO: add rule: if an ending is followed by another ending, add
// space on the right (or choose a VexFlow parameter accordingly),
// otherwise don't add space
/**
* @method processSections
*/
Expand Down Expand Up @@ -569,7 +556,6 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {
this.pendingSystemBreak = true;
},

// TODO extract function for measure_child (see the staffDef functions)!?
/**
* Processes a MEI measure element and calls functions to process a
* selection of ancestors: .//staff, ./slur, ./tie, ./hairpin, .//tempo
Expand Down Expand Up @@ -636,10 +622,6 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {

var currentStaveVoices = new m2v.StaveVoices();

// TODO create all staff objects before processing the voices so a
// reference to any staff object in the current measure can be set to the
// note-like objects (this is necessary when the attribute staff=n is
// used, for example)
$.each(staffElements, function() {
me.processStaffEvents(staffs, this, measure_n, currentStaveVoices);
});
Expand Down Expand Up @@ -707,8 +689,6 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {
me.addStaffClef(staff, staff_n);
clefOffsets[staff_n] = staff.getModifierXShift();
maxClefOffset = Math.max(maxClefOffset, clefOffsets[staff_n]);
// console.log('clef offsets: ' +clefOffsets[staff_n] + ' ' +
// maxClefOffset);
isFirst = false;
});

Expand All @@ -718,22 +698,17 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {
$.each(staffs, function(i, staff) {
if (staff) {
if (clefOffsets[i] !== maxClefOffset) {
// console.log('do keysig padding ' + (maxClefOffset -
// clefOffsets[i]));
me.addStaffKeySig(staff, i, maxClefOffset - clefOffsets[i] + 10);
} else {
me.addStaffKeySig(staff, i);
}
keySigOffsets[i] = staff.getModifierXShift();
maxKeySigOffset = Math.max(maxKeySigOffset, keySigOffsets[i]);
// console.log('keysig '+keySigOffsets[i] + ' ' +
// maxKeySigOffset);
}
});

// third run: add time signatures; if the keySigOffset of a staff is
// lesser
// maxKeySigOffset, add padding to the left of the time signature.
// lesser maxKeySigOffset, add padding to the left of the time signature.
$.each(staffs, function(i, staff) {
if (staff) {
if (keySigOffsets[i] !== maxKeySigOffset) {
Expand Down Expand Up @@ -937,8 +912,9 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {
},

/**
* processes a note like element by calling the adequate processing
* processes a note-like element by calling the adequate processing
* function
*
* @method processNoteLikeElement
* @param {XMLElement} element the element to process
* @param {Vex.Flow.Stave} staff the VexFlow staff object
Expand Down Expand Up @@ -1004,17 +980,6 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {
} else {
var otherStaff = me.allVexMeasureStaffs[me.allVexMeasureStaffs.length - 1][mei_staff_n];
if (otherStaff) {
// TODO: the note is correctly assigned to the new staff
// here, but
// in the end it has the old staff assigned to it -> fix
// that!
// REASON PROBABLY: all notes get assigned to the old
// staff when
// the voices are drawn in StaveVoices.js
// ALSO: Vex.Flow.Voice seems to assign all voice
// tickables to only
// one staff
// n = note;
note.setStave(otherStaff);
} else {
throw new m2v.RUNTIME_ERROR('Error', 'Note has staff attribute "' + mei_staff_n + '", but the staff does not exist.');
Expand Down Expand Up @@ -1077,8 +1042,6 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {
}
},

// TODO add support for features found in me.processNote (annot etc.)
// extract functions!?
/**
* @method processChord
*/
Expand All @@ -1089,8 +1052,6 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {

atts = m2v.Util.attsToObj(element);
durAtt = atts.dur;
// var mei_tie = atts.tie;
// var mei_slur = atts.slur;

xml_id = MeiLib.XMLID(element);

Expand Down Expand Up @@ -1143,8 +1104,6 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {
me.fermatas.addFermataToNote(chord, atts.fermata);
}

// TODO add support for chord/@tie and chord/@slur

me.notes_by_id[xml_id] = {
meiNote : element,
vexNote : chord,
Expand Down Expand Up @@ -1299,15 +1258,8 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {
duration : me.processAttsDuration(element, true) + 'r'
});
space.setStave(staff);
// xml_id = MeiLib.XMLID(element);
// me.notes_by_id[xml_id] = {
// meiNote : element,
// vexNote : space
// };
return {
vexNote : space
// ,
// id : xml_id
};
} catch (e) {
throw new m2v.RUNTIME_ERROR('BadArguments', 'A problem occurred processing the <space>: ' + m2v.Util.attsToString(element));
Expand All @@ -1332,7 +1284,6 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {
return elements;
},

// num.visible -- currently not supported in VexFlow; would be easy to add there
/**
* Processes an MEI <b>tuplet</b>.
* Supported attributes:
Expand Down Expand Up @@ -1404,21 +1355,16 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {
*/
processAttrTie : function(mei_tie, xml_id, pname, oct) {
var me = this, i, j;
// if (!mei_tie) {
// mei_tie = "";
// }
for ( i = 0, j = mei_tie.length; i < j; ++i) {
if (mei_tie[i] === 'i') {
me.ties.start_tieslur(xml_id, {
pname : pname,
oct : oct
//,system : system
});
} else if (mei_tie[i] === 't') {
me.ties.terminate_tie(xml_id, {
pname : pname,
oct : oct
//,system : system
});
}
}
Expand All @@ -1436,12 +1382,10 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {
if (this.letter === 'i') {
me.slurs.start_tieslur(xml_id, {
nesting_level : this.nesting_level
//,system : system
});
} else if (this.letter === 't') {
me.slurs.terminate_slur(xml_id, {
nesting_level : this.nesting_level
//,system : system
});
}
});
Expand Down Expand Up @@ -1517,16 +1461,13 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {
syl = me.processSyllable(element);
if (syl) {
annot = me.createAnnot(syl.text, me.cfg.lyricsFont).setVerticalJustification(me.BOTTOM);
// TODO handle justification
// .setJustification(VF.Annotation.Justify.LEFT);
note.addAnnotation(0, annot);
if (syl.wordpos) {
me.hyphenation.addSyllable(annot, syl.wordpos, staff_n);
}
}
},

// Add annotation (lyrics)
// processSyllable : function(mei_note) {
// var me = this, syl, full_syl = '', dash;
// syl = $(mei_note).find('syl');
Expand Down Expand Up @@ -1582,9 +1523,6 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {
throw new m2v.RUNTIME_ERROR('BadArguments', 'The MEI duration "' + mei_dur + '" is not supported.');
},

// TODO: dots should work with the lastest VexFlow, so try to remove the noDots
// parameter there. Can the noDots condition be removed entirely or will there
// be dots rendered with space elements?
/**
* @method processAttsDuration
*/
Expand Down
9 changes: 3 additions & 6 deletions src/EventReference.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,9 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {
* @class MEI2VF.EventReverence
* Represents and event with its xmlid, but if the xmlid is not defined, it
* can also hold the timestamp that can be resolved as soon as the context
* that
* holds the event is established. When the tstamp reference is being
* that holds the event is established. When the tstamp reference is being
* resolved, the xml:id is calculated using the generic function tstamp2id(),
* then the
* xml:id stored, thus marking that the reference is resolved.
* then the xml:id stored, thus marking that the reference is resolved.
* @private
*
* @constructor
Expand Down Expand Up @@ -58,8 +56,7 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {
throw new m2v.RUNTIME_ERROR('MEI2VF:RERR:BADARG:EventRef001', 'EventReference: tstamp must be set in order to resolve reference.');
}
if (this.meicontext) {
// look up event corresponding to the given tstamp (strictly or
// losely)
// look up event corresponding to the given tstamp (strictly or losely)
this.xmlid = MeiLib.tstamp2id(this.tstamp, this.meicontext.layer, this.meicontext.meter);
} else {
this.xmlid = null;
Expand Down
4 changes: 0 additions & 4 deletions src/Hyphenation.js
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {

// TODO add support for multiple layers in one staff
/**
* @class MEI2VF.Hyphenation
* @private
Expand All @@ -11,7 +10,6 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {
m2v.Hyphenation = function(font, printSpaceRight, maxHyphenDistance) {
var me = this;
me.allSyllables = [];
// TODO move to main.js
me.printSpaceRight = printSpaceRight;
me.font = font;
me.maxHyphenDistance = maxHyphenDistance;
Expand Down Expand Up @@ -46,8 +44,6 @@ var MEI2VF = ( function(m2v, MeiLib, VF, $, undefined) {
return this;
},

// TODO add support for hyphens in lines where neither the first nor the
// second syllable occur
draw : function() {
var me = this, i, k, first, second, hyphenWidth;

Expand Down
2 changes: 0 additions & 2 deletions src/Interface.js
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
/**
* ### ADD GENERAL NOTES ###
*
* @class MEI2VF
* @singleton
*/
Expand Down
Loading

0 comments on commit b3127e3

Please sign in to comment.