forked from sugarlabs/musicblocks
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathSaveInterface.js
More file actions
805 lines (741 loc) · 30.5 KB
/
SaveInterface.js
File metadata and controls
805 lines (741 loc) · 30.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
// Copyright (c) 2018,19 Euan Ong
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the The GNU Affero General Public
// License as published by the Free Software Foundation; either
// version 3 of the License, or (at your option) any later version.
//
// You should have received a copy of the GNU Affero General Public
// License along with this library; if not, write to the Free Software
// Foundation, 51 Franklin Street, Suite 500 Boston, MA 02110-1335 USA
/*
globals
_, TITLESTRING, GUIDEURL, jQuery, docById, docByClass, doSVG,
fileExt, ABCHEADER, LILYPONDHEADER, platform, saveAbcOutput,
saveLilypondOutput, saveMxmlOutput
*/
/**
* Class representing the SaveInterface.
* @class
*/
class SaveInterface {
/**
* Creates an instance of SaveInterface.
* @constructor
* @param {*} activity - The main activity object.
*/
constructor(activity) {
/**
* The main activity object.
* @member {object}
*/
this.activity = activity;
/**
* The file name of the saved project
* @member {string}
*/
this.filename = null;
/**
* The notation conversion type
* @member {object}
*/
this.notationConvert = "";
/**
* The timestamp of the last save
* @member {number}
*/
this.timeLastSaved = -100;
/**
* HTML template for saving projects.
* @member {string}
* @private
*/
this.htmlSaveTemplate =
'<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="description" content="{{ project_description }}"> <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"> <title>{{ project_name }}</title> <meta property="og:site_name" content="Music Blocks"/> <meta property="og:type" content="website"/> <meta property="og:title" content="' +
_("Music Blocks Project") +
' - {{ project_name }}"/> <meta property="og:description" content="{{ project_description }}"/> <style>body{background-color: #dbf0fb;}#main{background-color: white; padding: 5%; position: fixed; width: 80vw; height: max-content; margin: auto; top: 0; left: 0; bottom: 0; right: 0; display: flex; flex-direction: column; justify-content: center; text-align: center; color: #424242; box-shadow: 0 10px 20px rgba(0,0,0,0.19), 0 6px 6px rgba(0,0,0,0.23); font-family: "Roboto", "Helvetica","Arial",sans-serif;}h3{font-weight: 400; font-size: 36px; margin-top: 10px;}hr{border-top: 0px solid #ccc; margin: 1em;}.btn {display: inline-block; margin-left: 10px; cursor: pointer; font-size: 14px; border-radius: 12px; border: 1px solid #1678ad; padding: 3px 5px; line-height: 20px; color: #181818;}.btn:hover {transition: 0.4s; -webkit-transition: 0.3s; -moz-transition: 0.3s; background-color: #3eb7e7;}.code{word-break: break-all; height: 15vh; background: #f6f8fa; color: #494949; text-align: justify; margin-right: 10vw; margin-left: 10vw; padding: 16px; overflow: auto; line-height: 1.45; background-color: #f6f8fa; border-radius: 3px; font-family: "SFMono-Regular",Consolas,"Liberation Mono",Menlo,Courier,monospace;}.image{border-radius: 2px 2px 0 0; position: relative; background-color: #96D3F3;}.image-div{margin-bottom: 10px;}.moreinfo-div{margin-top: 20px;}h4{font-weight: 500; font-size: 1.4em; margin-top: 10px; margin-bottom: 10px;}.tbcode{margin-bottom: 10px;}</style></head><body> <div id="main"> <div class="image-div"><img class="image" id="project-image" src="{{ project_image }}"></div><h3 id="title">' +
_("Music Blocks Project") +
' - {{ project_name }}</h3> <p>{{ project_description }}</p><hr> <div> <div style="color: #9E9E9E"><p>' +
_("This project was created in Music Blocks") +
' (<a href="https://musicblocks.sugarlabs.org" target="_blank">https://musicblocks.sugarlabs.org</a>). ' +
TITLESTRING +
" " +
_("Music Blocks is a Free/Libre Software application.") +
" " +
_("The source code can be accessed at") +
' <a href="https://github.com/sugarlabs/musicblocks" target="_blank">https://github.com/sugarlabs/musicblocks</a>.' +
" " +
_("For more information, please consult the") +
' <a href="' +
GUIDEURL +
'" target="_blank">' +
_("Music Blocks Guide") +
"</a>." +
"</p><p>" +
_(
"To run this project, open Music Blocks in a web browser and drag and drop this file into the browser window."
) +
" " +
_("Alternatively, open the file in Music Blocks using the Load project button.") +
'</p></div><div class="moreinfo-div"> <div class="tbcode"><h4>' +
_("Project Code") +
"</h4>" +
_("This code stores data about the blocks in a project.") +
'<a href="javascript:toggle();" id="showhide">' +
_("Show") +
"</a>" +
'<button class="btn" onclick="copyCode()" style="margin-left: 10px;">' +
_("Copy to Clipboard") +
"</button>" +
'</div> <div class="code" id="codeBlock">{{ data }}</div></div></div></div>' +
'<script type="text/javascript">' +
"function toggle() {" +
' var codeBlock = document.getElementsByClassName("code")[0];' +
' var showHideButton = document.getElementById("showhide");' +
' if (codeBlock.style.display === "none") {' +
' codeBlock.style.display = "flex";' +
' showHideButton.textContent = "' + _("Hide") + '";' +
" } else {" +
' codeBlock.style.display = "none";' +
' showHideButton.textContent = "' + _("Show") + '";' +
" }" +
"}" +
"window.onload = function() {" +
' var codeBlock = document.getElementById("codeBlock");' +
' var showHideButton = document.getElementById("showhide");' +
' codeBlock.style.display = "none";' +
' showHideButton.textContent = "' + _("Show") + '";' +
"};" +
"function copyCode() {" +
' var text = document.getElementById("codeBlock").innerText;' +
" navigator.clipboard.writeText(text).then(function() {" +
' alert("' + _("Project code copied to clipboard!") + '");' +
" }).catch(function() {" +
' alert("' + _("Failed to copy.") + '");' +
" });" +
"}" +
"</script>";
this.timeLastSaved = -100;
const $j = jQuery.noConflict();
$j(window).on("beforeunload", (event) => {
let saveButton = "#saveButtonAdvanced";
if (this.activity.beginnerMode) {
saveButton = "#saveButton";
}
if (
typeof this.PlanetInterface !== "undefined" &&
this.PlanetInterface.getTimeLastSaved() !== this.timeLastSaved
) {
event.preventDefault();
// Will trigger when exit/reload cancelled.
$j(saveButton).trigger("mouseenter");
return "";
}
});
}
/**
* Download a file to the user's computer.
* @param {string} extension - The file extension (including the dot).
* @param {string} dataurl - The base64 data url of the file.
* @param {string} defaultfilename - The default filename to be used.
* @returns {void}
*/
download(extension, dataurl, defaultfilename) {
let filename = null;
if (defaultfilename === undefined || defaultfilename === null) {
if (this.activity.PlanetInterface === undefined) {
defaultfilename = _("My Project");
} else {
defaultfilename = this.activity.PlanetInterface.getCurrentProjectName();
}
if (fileExt(defaultfilename) != extension) {
defaultfilename += "." + extension;
}
if (window.isElectron == true) {
filename = defaultfilename;
} else {
filename = prompt("Filename:", defaultfilename);
}
} else {
if (fileExt(defaultfilename) != extension) {
defaultfilename += "." + extension;
}
filename = defaultfilename;
}
// eslint-disable-next-line no-console
console.debug("saving to " + filename);
if (filename === null) {
// eslint-disable-next-line no-console
console.debug("save cancelled");
return;
}
if (fileExt(filename) != extension) {
filename += "." + extension;
}
this.downloadURL(filename, dataurl);
}
/**
* Saves the provided data as a file.
* @param {string} filename - The name of the file to save.
* @param {string} dataurl - The data to save in the file.
* @returns {void}
* @memberof SaveInterface
*/
downloadURL(filename, dataurl) {
const a = document.createElement("a");
a.setAttribute("href", dataurl);
a.setAttribute("download", filename);
document.body.appendChild(a);
a.click();
document.body.removeChild(a);
}
/**
* Prepare HTML content for export.
*
* This method generates HTML content for export, including project details, description, name,
* data, and project image. It uses a template and replaces placeholders with actual values.
*
* @returns {string} The HTML content prepared for export.
* @memberof SaveInterface
* @method
* @instance
*/
prepareHTML() {
let file = this.htmlSaveTemplate;
let description = _("No description provided");
if (this.activity.PlanetInterface !== undefined) {
description = this.activity.PlanetInterface.getCurrentProjectDescription();
}
// let author = '';
// Currently we're using anonymous for authors - not storing names.
let name = _("My Project");
if (this.activity.PlanetInterface !== undefined) {
name = this.activity.PlanetInterface.getCurrentProjectName();
}
const data = this.activity.prepareExport();
let image = "";
if (this.activity.PlanetInterface !== undefined) {
image = this.activity.PlanetInterface.getCurrentProjectImage();
}
file = file
.replace(new RegExp("{{ project_description }}", "g"), description)
.replace(new RegExp("{{ project_name }}", "g"), name)
.replace(new RegExp("{{ data }}", "g"), data)
.replace(new RegExp("{{ project_image }}", "g"), image);
return file;
}
/**
* Save HTML representation of an activity.
*
* This method generates and downloads the HTML representation of the provided activity.
*
* @param {SaveInterface} activity - The activity object to save.
* @returns {void}
* @memberof SaveInterface
* @method
* @instance
*/
saveHTML(activity) {
const html =
"data:text/plain;charset=utf-8," + encodeURIComponent(activity.save.prepareHTML());
activity.save.download("html", html, null);
}
/**
* Save HTML representation of an activity without prompting the user.
*
* This method generates and downloads the HTML representation of the provided activity without
* prompting the user. It uses a setTimeout to delay the execution by 500 milliseconds.
*
* @param {SaveInterface} activity - The activity object to save.
* @returns {void}
* @memberof SaveInterface
* @method
* @instance
*/
saveHTMLNoPrompt(activity) {
setTimeout(() => {
const html =
"data:text/plain;charset=utf-8," + encodeURIComponent(activity.save.prepareHTML());
if (activity.PlanetInterface !== undefined) {
activity.save.downloadURL(
activity.PlanetInterface.getCurrentProjectName() + ".html",
html
);
} else {
activity.save.downloadURL(_("My Project").replace(" ", "_") + ".html", html);
}
}, 500);
}
/**
* Save MIDI file.
*
* This method generates required MIDI data.
*
* @param {SaveInterface} activity - The activity object to save.
* @returns {void}
* @memberof SaveInterface
* @method
* @instance
*/
saveMIDI(activity) {
// Suppress music and turtle output when generating
activity.logo.runningMIDI = true;
activity.logo.runLogoCommands();
document.body.style.cursor = "wait";
}
/**
* Perform actions after generating MIDI data.
*
* This method generates a MIDI file using _midiData.
*
* @returns {void}
* @memberof SaveInterface
* @method
* @instance
*/
afterSaveMIDI() {
const instrumentMIDI = getMidiInstrument();
const drumMIDI = getMidiDrum();
const generateMidi = (data) => {
const normalizeNote = (note) => {
return note.replace("♯", "#").replace("♭", "b");
};
const midi = new Midi();
midi.header.ticksPerBeat = 480;
Object.entries(data).forEach(([blockIndex, notes]) => {
const mainTrack = midi.addTrack();
mainTrack.name = `Track ${parseInt(blockIndex) + 1}`;
const trackMap = new Map();
let globalTime = 0;
notes.forEach((noteData) => {
if (!noteData.note || noteData.note.length === 0) return;
const duration = ((1 / noteData.duration) * 60 * 4) / noteData.bpm;
const instrument = noteData.instrument || "default";
if (noteData.drum) {
const drum = noteData.drum || false;
if (!trackMap.has(drum)) {
const drumTrack = midi.addTrack();
drumTrack.name = `Track ${parseInt(blockIndex) + 1} - ${drum}`;
drumTrack.channel = 9; // Drums must be on Channel 10
trackMap.set(drum, drumTrack);
}
const drumTrack = trackMap.get(drum);
const midiNumber = drumMIDI[drum] || 36; // default to Bass Drum
drumTrack.addNote({
midi: midiNumber,
time: globalTime,
duration: duration,
velocity: 0.9
});
} else {
if (!trackMap.has(instrument)) {
const instrumentTrack = midi.addTrack();
instrumentTrack.name = `Track ${
parseInt(blockIndex) + 1
} - ${instrument}`;
instrumentTrack.instrument.number =
instrumentMIDI[instrument] ?? instrumentMIDI["default"];
trackMap.set(instrument, instrumentTrack);
}
const instrumentTrack = trackMap.get(instrument);
noteData.note.forEach((pitch) => {
if (!pitch.includes("R")) {
instrumentTrack.addNote({
name: normalizeNote(pitch),
time: globalTime,
duration: duration,
velocity: 0.8
});
}
});
}
globalTime += duration;
});
globalTime = 0;
});
// Generate the MIDI file and trigger download.
const midiData = midi.toArray();
const blob = new Blob([midiData], { type: "audio/midi" });
const url = URL.createObjectURL(blob);
activity.save.download("midi", url, null);
};
const data = activity.logo._midiData;
setTimeout(() => {
generateMidi(data);
activity.logo._midiData = {};
document.body.style.cursor = "default";
}, 500);
}
/**
* This method is to save SVG representation of an activity
*
* @param {SaveInterface} activity -The activity object to save
* @returns {void}
* @method
* @instance
*/
saveSVG(activity) {
const svg =
"data:image/svg+xml;utf8," +
doSVG(
activity.canvas,
activity.logo,
activity.turtles,
activity.canvas.width,
activity.canvas.height,
1.0
);
activity.save.download("svg", svg, null);
}
/**
* This method is to save PNG representation of an activity
*
* @param {SaveInterface} activity -The activity object to save
* @returns {void}
* @method
* @instance
*/
savePNG(activity) {
const png = docById("overlayCanvas").toDataURL("image/png");
activity.save.download("png", png, null);
}
/**
* This method is to save BlockArtwork and download the SVG representation of block artwork from the provided activity.
*
* @param {SaveInterface} activity - The activity object containing block artwork to save.
* @returns {void}
* @method
* @instance
*/
saveBlockArtwork(activity) {
const svg = "data:image/svg+xml;utf8," + activity.printBlockSVG();
activity.save.download("svg", svg, null);
}
/**
* This method is to save BlockArtwork and download the PNG representation of block artwork from the provided activity.
*
* @param {SaveInterface} activity - The activity object containing block artwork to save.
* @returns {void}
* @method
* @instance
*/
saveBlockArtworkPNG(activity) {
activity.printBlockPNG().then((pngDataUrl) => {
activity.save.download("png", pngDataUrl, null);
});
}
/**
* Save audio recording in WAV format.
*
* This method initiates the process of recording audio in WAV format within the provided activity.
*
* @param {SaveInterface} activity - The activity object for which audio recording is to be saved.
* @returns {void}
* @memberof SaveInterface
* @method
* @instance
*/
saveWAV(activity) {
document.body.style.cursor = "wait";
activity.logo.recording = true;
activity.logo.synth.setupRecorder();
activity.logo.synth.recorder.start();
activity.logo.runLogoCommands();
activity.textMsg(_("Your recording is in progress."));
}
/**
* Save ABC notation representation of an activity.
*
* This method generates and prepares ABC notation output for the provided activity.
*
* @param {SaveInterface} activity - The activity object to save as ABC notation.
* @returns {void}
* @memberof SaveInterface
* @method
* @instance
*/
saveAbc(activity) {
document.body.style.cursor = "wait";
//Suppress music and turtle output when generating
// Abc output.
activity.logo.runningAbc = true;
activity.logo.notationOutput = ABCHEADER;
activity.logo.notationNotes = {};
for (let t = 0; t < activity.turtles.getTurtleCount(); t++) {
activity.logo.notation.notationStaging[t] = [];
activity.logo.notation.notationDrumStaging[t] = [];
activity.turtles.getTurtle(t).painter.doClear(true, true, true);
}
activity.logo.runLogoCommands();
}
/**
* Perform actions after saving an ABC notation file.
*
* This method handles the post-processing steps after saving ABC notation.
*
* @returns {void}
* @memberof SaveInterface
* @method
* @instance
*/
afterSaveAbc() {
const abc = encodeURIComponent(saveAbcOutput(this.activity));
this.activity.save.download("abc", "data:text;utf8," + abc, null);
}
/**
* Save Lilypond representation of an activity.
*
* This method initiates the process of saving Lilypond representation of the provided activity.
*
* @param {SaveInterface} activity - The activity object to save as Lilypond.
* @returns {void}
* @memberof SaveInterface
* @method
* @instance
*/
saveLilypond(activity) {
const lyext = "ly";
let filename = _("My Project");
if (activity.PlanetInterface !== undefined) {
filename = activity.PlanetInterface.getCurrentProjectName();
}
if (fileExt(filename) != lyext) {
filename += "." + lyext;
}
docById("lilypondModal").style.display = "block";
//.TRANS: File name prompt for save as Lilypond
docById("fileNameText").textContent = _("File name");
//.TRANS: Project title prompt for save as Lilypond
docById("titleText").textContent = _("Project title");
//.TRANS: Project title prompt for save as Lilypond
docById("authorText").textContent = _("Project author");
//.TRANS: MIDI prompt for save as Lilypond
docById("MIDIText").textContent = _("Include MIDI output?");
//.TRANS: Guitar prompt for save as Lilypond
docById("guitarText").textContent = _("Include guitar tablature output?");
//.TRANS: Lilypond is a scripting language for generating sheet music
docById("submitLilypond").textContent = _("Save as Lilypond");
docById("fileName").value = filename;
if (activity.PlanetInterface !== undefined) {
docById("title").value = activity.PlanetInterface.getCurrentProjectName();
} else {
//.TRANS: default project title when saving as Lilypond
docById("title").value = _("My Project");
}
// Load custom author saved in local storage.
const customAuthorData = activity.storage.getItem("customAuthor");
if (customAuthorData != undefined) {
docById("author").value = JSON.parse(customAuthorData);
} else {
//.TRANS: default project author when saving as Lilypond
docById("author").value = _("Mr. Mouse");
}
docById("submitLilypond").onclick = () => {
activity.save.saveLYFile(false);
};
// if (this.planet){
// docById('submitPDF').onclick = function(){this.saveLYFile(true);}.bind(this);
// docById('submitPDF').disabled = false;
// } else {
// docById('submitPDF').disabled = true;
// }
docByClass("close")[0].onclick = () => {
activity.logo.runningLilypond = false;
docById("lilypondModal").style.display = "none";
};
}
/**
* Save Lilypond file with optional PDF conversion.
*
* This method handles the saving of Lilypond files with optional PDF conversion based on user preferences.
*
* @param {boolean} [isPDF=false] - Flag indicating whether to generate a PDF along with the Lilypond file.
* @returns {void}
* @memberof SaveInterface
* @method
* @instance
*/
saveLYFile(isPDF) {
if (isPDF === undefined) {
isPDF = false;
}
let filename = docById("fileName").value;
const projectTitle = docById("title").value;
const projectAuthor = docById("author").value;
// Save the author in local storage.
this.activity.storage.setItem("customAuthor", JSON.stringify(projectAuthor));
const MIDICheck = docById("MIDICheck").checked;
const guitarCheck = docById("guitarCheck").checked;
if (filename != null) {
if (fileExt(filename) !== "ly") {
filename += ".ly";
}
}
const mapLilypondObj = {
"My Music Blocks Creation": projectTitle,
"Mr. Mouse": projectAuthor
};
const lyheader = LILYPONDHEADER.replace(
/My Music Blocks Creation|Mr. Mouse/gi,
(matched) => mapLilypondObj[matched]
);
if (MIDICheck) {
this.activity.logo.MIDIOutput =
"% MIDI SECTION\n% MIDI Output included! \n\n\\midi {\n \\tempo 4=90\n}\n\n\n}\n\n";
} else {
this.activity.logo.MIDIOutput =
"% MIDI SECTION\n% Delete the %{ and %} below to include MIDI output.\n%{\n\\midi {\n \\tempo 4=90\n}\n%}\n\n}\n\n";
}
if (guitarCheck) {
this.activity.logo.guitarOutputHead =
'\n\n% GUITAR TAB SECTION\n% Guitar tablature output included!\n\n \\new TabStaff = "guitar tab" \n <<\n \\clef moderntab\n';
this.activity.logo.guitarOutputEnd = " >>\n\n";
} else {
this.activity.logo.guitarOutputHead =
'\n\n% GUITAR TAB SECTION\n% Delete the %{ and %} below to include guitar tablature output.\n%{\n \\new TabStaff = "guitar tab" \n <<\n \\clef moderntab\n';
this.activity.logo.guitarOutputEnd = " >>\n%}\n";
}
// Suppress music and turtle output when generating
// Lilypond output.
this.activity.logo.runningLilypond = true;
if (isPDF) {
this.notationConvert = "pdf";
} else {
this.notationConvert = "";
}
this.activity.logo.notationOutput = lyheader;
this.activity.logo.notationNotes = {};
for (let t = 0; t < this.activity.turtles.getTurtleCount(); t++) {
this.activity.logo.notation.notationStaging[t] = [];
this.activity.logo.notation.notationDrumStaging[t] = [];
this.activity.turtles.getTurtle(t).painter.doClear(true, true, true);
}
document.body.style.cursor = "wait";
this.activity.logo.runLogoCommands();
// Close the dialog box after hitting button.
docById("lilypondModal").style.display = "none";
}
/**
* Perform actions after saving a Lilypond file.
*
* This method handles post-processing steps after saving a Lilypond file, such as handling PDF conversion.
*
* @param {string} filename - The name of the Lilypond file.
* @returns {void}
* @memberof SaveInterface
* @method
* @instance
*/
afterSaveLilypond(filename) {
filename = docById("fileName").value;
const ly = saveLilypondOutput(this.activity);
switch (this.notationConvert) {
case "pdf":
this.afterSaveLilypondPDF(ly, filename);
break;
default:
this.afterSaveLilypondLY(ly, filename);
break;
}
this.notationConvert = "";
}
/**
* Perform actions after saving a Lilypond file in LY format.
*
* This method handles post-processing steps specific to saving a Lilypond file in LY format.
*
* @param {string} lydata - The Lilypond data.
* @param {string} filename - The name of the Lilypond file.
* @returns {void}
* @memberof SaveInterface
* @method
* @instance
*/
afterSaveLilypondLY(lydata, filename) {
filename = docById("fileName").value;
if (platform.FF) {
// eslint-disable-next-line no-console
console.debug('execCommand("copy") does not work on FireFox');
} else {
const tmp = jQuery("<textarea />").appendTo(document.body);
tmp.val(lydata);
tmp.select();
tmp[0].setSelectionRange(0, lydata.length);
document.execCommand("copy");
tmp.remove();
this.activity.textMsg(
_("The Lilypond code is copied to clipboard. You can paste it here: ") +
"<a href='http://hacklily.org' target='_blank'>http://hacklily.org</a> "
);
}
this.download("ly", "data:text;utf8," + encodeURIComponent(lydata), filename);
}
/**
* Perform actions after saving a Lilypond file in PDF format.
*
* This method handles post-processing steps specific to saving a Lilypond file in PDF format.
*
* @param {string} lydata - The Lilypond data.
* @param {string} filename - The name of the Lilypond file.
* @returns {void}
* @memberof SaveInterface
* @method
* @instance
*/
afterSaveLilypondPDF(lydata, filename) {
document.body.style.cursor = "wait";
window.Converter.ly2pdf(lydata, (success, dataurl) => {
document.body.style.cursor = "default";
if (!success) {
// eslint-disable-next-line no-console
console.debug("Error: " + dataurl);
//TODO: Error message box
} else {
this.activity.save.download("pdf", dataurl, filename);
}
});
}
/**
*
* Save MXML file.
*
* This method initiates the process of saving an MXML file.
*
* @param {string} filename - The name of the MXML file.
* @returns {void}
* @memberof SaveInterface
* @method
* @instance
*
*/
// eslint-disable-next-line no-unused-vars
saveMxml(filename) {
this.activity.logo.runningMxml = true;
for (let t = 0; t < this.activity.turtles.getTurtleCount(); t++) {
this.activity.logo.notation.notationStaging[t] = [];
this.activity.logo.notation.notationDrumStaging[t] = [];
this.activity.turtles.getTurtle(t).painter.doClear(true, true, true);
}
this.activity.logo.runLogoCommands();
}
/**
* Perform actions after saving an MXML file.
*
* This method handles post-processing steps after saving an MXML file.
*
* @param {string} filename - The name of the MXML file.
* @returns {void}
* @memberof SaveInterface
* @method
* @instance
*
*/
afterSaveMxml(filename) {
const data = saveMxmlOutput(this.activity.logo);
this.download("xml", "data:text;utf8," + encodeURIComponent(data), filename);
this.activity.logo.runningMxml = false;
}
}
if (typeof module !== "undefined" && module.exports) {
module.exports = { SaveInterface };
}