abcjs 6.0.0-beta.7 → 6.0.0

package/src/api/abc_tunebook_svg.js

@@ -1,24 +1,12 @@
-//    Copyright (C) 2015-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 tunebook = require('./abc_tunebook');
 var Tune = require('../data/abc_tune');
 
 var EngraverController = require('../write/abc_engraver_controller');
 var Parse = require('../parse/abc_parse');
 var wrap = require('../parse/wrap_lines');
+var parseCommon = require("../parse/abc_common");
+// var tablatures = require('./abc_tablatures');
+
 
 var resizeDivs = {};
 function resizeOuter() {
@@ -40,7 +28,7 @@ try {
     // if we aren't in a browser, this code will crash, but it is not needed then either.
 }
 
-function renderOne(div, tune, params, tuneNumber) {
+function renderOne(div, tune, params, tuneNumber, lineOffset) {
     if (params.viewportHorizontal) {
         // Create an inner div that holds the music, so that the passed in div will be the viewport.
         div.innerHTML = '<div class="abcjs-inner"></div>';
@@ -62,7 +50,7 @@ function renderOne(div, tune, params, tuneNumber) {
     else
 	    div.innerHTML = "";
     var engraver_controller = new EngraverController(div, params);
-    engraver_controller.engraveABC(tune, tuneNumber);
+    engraver_controller.engraveABC(tune, tuneNumber, lineOffset);
     tune.engraver = engraver_controller;
     if (params.viewportVertical || params.viewportHorizontal) {
         // If we added a wrapper around the div, then we need to size the wrapper, too.
@@ -77,8 +65,6 @@ function renderEachLineSeparately(div, tune, params, tuneNumber) {
         obj.formatting = tune.formatting;
         obj.media = tune.media;
         obj.version = tune.version;
-        obj.metaText = {};
-        obj.lines = [];
         return obj;
     }
 
@@ -94,14 +80,7 @@ function renderEachLineSeparately(div, tune, params, tuneNumber) {
 
         if (i === 0) {
             // These items go on top of the music
-            tuneLine.metaText.tempo = tune.metaText.tempo;
-            tuneLine.metaText.title = tune.metaText.title;
-            tuneLine.metaText.header = tune.metaText.header;
-            tuneLine.metaText.rhythm = tune.metaText.rhythm;
-            tuneLine.metaText.origin = tune.metaText.origin;
-            tuneLine.metaText.composer = tune.metaText.composer;
-            tuneLine.metaText.author = tune.metaText.author;
-            tuneLine.metaText.partOrder = tune.metaText.partOrder;
+            tuneLine.copyTopInfo(tune);
         }
 
         // push the lines until we get to a music line
@@ -120,17 +99,7 @@ function renderEachLineSeparately(div, tune, params, tuneNumber) {
 
     // These items go below the music
     tuneLine = tunes[tunes.length-1];
-    tuneLine.metaText.unalignedWords = tune.metaText.unalignedWords;
-    tuneLine.metaText.book = tune.metaText.book;
-    tuneLine.metaText.source = tune.metaText.source;
-    tuneLine.metaText.discography = tune.metaText.discography;
-    tuneLine.metaText.notes = tune.metaText.notes;
-    tuneLine.metaText.transcription = tune.metaText.transcription;
-    tuneLine.metaText.history = tune.metaText.history;
-    tuneLine.metaText['abc-copyright'] = tune.metaText['abc-copyright'];
-    tuneLine.metaText['abc-creator'] = tune.metaText['abc-creator'];
-    tuneLine.metaText['abc-edited-by'] = tune.metaText['abc-edited-by'];
-    tuneLine.metaText.footer = tune.metaText.footer;
+    tuneLine.copyBottomInfo(tune);
 
     // Now create sub-divs and render each line. Need to copy the params to change the padding for the interior slices.
     var ep = {};
@@ -141,7 +110,10 @@ function renderEachLineSeparately(div, tune, params, tuneNumber) {
     }
     var origPaddingTop = ep.paddingtop;
     var origPaddingBottom = ep.paddingbottom;
+    var currentScrollY = div.parentNode.scrollTop; // If there is scrolling it will be lost during the redraw so remember it.
+    var currentScrollX = div.parentNode.scrollLeft;
     div.innerHTML = "";
+    var lineCount = 0;
     for (var k = 0; k < tunes.length; k++) {
         var lineEl = document.createElement("div");
         div.appendChild(lineEl);
@@ -156,7 +128,13 @@ function renderEachLineSeparately(div, tune, params, tuneNumber) {
 	        ep.paddingtop = 10;
 	        ep.paddingbottom = -20;
         }
-        renderOne(lineEl, tunes[k], ep, tuneNumber);
+        if (k < tunes.length-1) {
+            // If it is not the last line, force stretchlast. If it is, stretchlast might have been set by the input parameters.
+            tunes[k].formatting = parseCommon.clone(tunes[k].formatting);
+            tunes[k].formatting.stretchlast = true;
+        }
+        renderOne(lineEl, tunes[k], ep, tuneNumber, lineCount);
+        lineCount += tunes[k].lines.length;
         if (k === 0)
             tune.engraver = tunes[k].engraver;
         else {
@@ -166,6 +144,9 @@ function renderEachLineSeparately(div, tune, params, tuneNumber) {
                 tune.engraver.staffgroups.push(tunes[k].engraver.staffgroups[0]);
         }
     }
+    if (currentScrollX || currentScrollY) {
+        div.parentNode.scrollTo(currentScrollX, currentScrollY);
+    }
 }
 
 // A quick way to render a tune from javascript when interactivity is not required.
@@ -195,6 +176,9 @@ var renderAbc = function(output, abc, parserParams, engraverParams, renderParams
                 params[key] = parserParams[key];
             }
         }
+        if (params.warnings_id && params.tablature) {
+            params.tablature.warning_id = params.warnings_id;
+        }
     }
     if (engraverParams) {
         for (key in engraverParams) {
@@ -231,7 +215,7 @@ var renderAbc = function(output, abc, parserParams, engraverParams, renderParams
 	        return tune;
         }
         else if (removeDiv || !params.oneSvgPerLine || tune.lines.length < 2)
-            renderOne(div, tune, params, tuneNumber);
+            renderOne(div, tune, params, tuneNumber, 0);
         else
             renderEachLineSeparately(div, tune, params, tuneNumber);
         if (removeDiv)
@@ -246,13 +230,21 @@ function doLineWrapping(div, tune, tuneNumber, abcString, params) {
 	var engraver_controller = new EngraverController(div, params);
 	var widths = engraver_controller.getMeasureWidths(tune);
 
-	var ret = wrap.calcLineWraps(tune, widths, abcString, params, Parse, engraver_controller);
-    if (!params.oneSvgPerLine || ret.tune.lines.length < 2)
-        renderOne(div, ret.tune, ret.revisedParams, tuneNumber);
+	var ret = wrap.calcLineWraps(tune, widths, params);
+	if (ret.reParse) {
+        var abcParser = new Parse();
+        abcParser.parse(abcString, ret.revisedParams);
+        tune = abcParser.getTune();
+        var warnings = abcParser.getWarnings();
+        if (warnings)
+            tune.warnings = warnings;
+    }
+    if (!params.oneSvgPerLine || tune.lines.length < 2)
+        renderOne(div, tune, ret.revisedParams, tuneNumber, 0);
     else
-        renderEachLineSeparately(div, ret.tune, ret.revisedParams, tuneNumber);
-	ret.tune.explanation = ret.explanation;
-	return ret.tune;
+        renderEachLineSeparately(div, tune, ret.revisedParams, tuneNumber);
+	tune.explanation = ret.explanation;
+	return tune;
 }
 
 module.exports = renderAbc;