-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Expand file tree
/
Copy pathFlowBlocks.js
More file actions
1263 lines (1115 loc) · 45 KB
/
FlowBlocks.js
File metadata and controls
1263 lines (1115 loc) · 45 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
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) 2019 Bottersnike
//
// 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
/*
global
_, last, ZERODIVIDEERRORMSG, Queue, FlowBlock, ValueBlock,
FlowClampBlock, NOINPUTERRORMSG, POSNUMBER, BaseBlock
*/
/* exported setupFlowBlocks */
function setupFlowBlocks(activity) {
/**
* Represents a block for running code in reverse order (Musical retrograde).
* @extends {FlowClampBlock}
*/
class BackwardBlock extends FlowClampBlock {
/**
* Constructs a BackwardBlock instance.
*/
constructor() {
// Call the constructor of the parent class
super("backward");
// Set the palette and activity for the block
this.setPalette("flow", activity);
// Set the block as a beginner block
this.beginnerBlock(true);
// Set the help string for the block
this.setHelpString([
_("The Backward block runs code in reverse order (Musical retrograde)."),
"documentation",
""
]);
// Form the block with specific parameters
this.formBlock({
name: _("backward")
});
// Define the macro for creating the block
this.makeMacro((x, y) => [
[0, "backward", x, y, [null, 1, null]],
[1, "hidden", 0, 0, [0, null]]
]);
}
/**
* Handles the flow of the backward block.
* @param {Array} args - The arguments for the block.
* @param {object} logo - The logo object.
* @param {object} turtle - The turtle object.
* @param {number} blk - The block number.
* @returns {Array} - An array containing the child flow and child flow count.
*/
flow(args, logo, turtle, blk) {
const tur = activity.turtles.ithTurtle(turtle);
// Push the current block to the backward stack
tur.singer.backward.push(blk);
// Set child to bottom block inside clamp
const childFlow = activity.blocks.findBottomBlock(args[0]);
const childFlowCount = 1;
// Set up the listener for the backward block
const listenerName = "_backward_" + turtle + "_" + blk;
logo.setDispatchBlock(blk, turtle, listenerName);
// Get the next block in the sequence
const nextBlock = activity.blocks.blockList[blk].connections[2];
// Pop the backward stack if there is no next block
if (nextBlock === null) {
tur.singer.backward.pop();
} else {
// Register the listener for the end of the clamp
if (nextBlock in tur.endOfClampSignals) {
tur.endOfClampSignals[nextBlock].push(listenerName);
} else {
tur.endOfClampSignals[nextBlock] = [listenerName];
}
}
// Set up the listener function
const __listener = event => tur.singer.backward.pop();
// Set the turtle listener
logo.setTurtleListener(turtle, listenerName, __listener);
// Return the child flow and child flow count
return [childFlow, childFlowCount];
}
}
/**
* Represents a block for running each block multiple times (Musical duplication).
* @extends {FlowClampBlock}
*/
class DuplicateBlock extends FlowClampBlock {
/**
* Constructs a DuplicateBlock instance.
*/
constructor() {
// Call the constructor of the parent class
super("duplicatenotes");
// Set the palette, piemenuValuesC1, and activity for the block
this.setPalette("flow", activity);
this.piemenuValuesC1 = [2, 3, 4, 5, 6, 7, 8];
// Set the help string for the block
this.setHelpString([
_("The Duplicate block will run each block multiple times.") +
" " +
_(
"The output of the example is: Sol, Sol, Sol, Sol, Re, Re, Re, Re, Sol, Sol, Sol, Sol."
),
"documentation",
null,
"duphelp"
]);
// Form the block with specific parameters
this.formBlock({
name: _("Duplicate").toLowerCase(),
args: 1,
defaults: [2]
});
// Define the macro for creating the block
this.makeMacro((x, y) => [
[0, "duplicatenotes", x, y, [null, 1, null, 2]],
[1, ["number", { value: 2 }], 0, 0, [0]],
[2, "hidden", 0, 0, [0, null]]
]);
}
/**
* Handles the flow of the duplicate block.
* @param {Array} args - The arguments for the block.
* @param {object} logo - The logo object.
* @param {object} turtle - The turtle object.
* @param {number} blk - The block number.
* @param {object} receivedArg - The received arguments.
*/
flow(args, logo, turtle, blk, receivedArg) {
if (args[1] === undefined) return;
let arg0;
if (args[0] === null || typeof args[0] !== "number" || args[0] < 1) {
// Handle invalid input for the number of duplicates
activity.errorMsg(NOINPUTERRORMSG, blk);
arg0 = 2;
} else {
arg0 = args[0];
}
const factor = Math.floor(arg0);
if (factor < 1) {
// Handle invalid input for the duplication factor
activity.errorMsg(ZERODIVIDEERRORMSG, blk);
logo.stopTurtle = true;
} else {
const tur = activity.turtles.ithTurtle(turtle);
// Update the duplicate factor in the turtle singer
tur.singer.duplicateFactor *= factor;
// Queue each block in the clamp
const listenerName = "_duplicate_" + turtle;
logo.setDispatchBlock(blk, turtle, listenerName);
// Function to look for other turtles in the connection store
const __lookForOtherTurtles = (blk, turtle) => {
for (const t in logo.connectionStore) {
if (t !== turtle.toString()) {
for (const b in logo.connectionStore[t]) {
if (b === blk.toString()) {
return t;
}
}
}
}
return null;
};
tur.singer.inDuplicate = true;
/**
* Acquires the connectionStoreLock with proper waiting.
* Uses a polling mechanism to wait for the lock to be released.
* @param {number} maxRetries - Maximum number of retry attempts
* @param {number} retryInterval - Milliseconds between retries
* @returns {Promise<boolean>} - Resolves to true when lock is acquired
*/
const __acquireLock = (maxRetries = 100, retryInterval = 10) => {
return new Promise(resolve => {
let retries = 0;
const tryAcquire = () => {
if (!logo.connectionStoreLock) {
logo.connectionStoreLock = true;
resolve(true);
} else if (retries < maxRetries) {
retries++;
setTimeout(tryAcquire, retryInterval);
} else {
// Force acquire after max retries to prevent deadlock
console.warn(
"connectionStoreLock: Max retries reached, forcing lock acquisition"
);
logo.connectionStoreLock = true;
resolve(true);
}
};
tryAcquire();
});
};
// Listener function for handling the end of duplication
const __listener = async event => {
tur.singer.inDuplicate = false;
tur.singer.duplicateFactor /= factor;
// Acquire lock with proper waiting
await __acquireLock();
try {
// The last turtle should restore the broken connections
if (__lookForOtherTurtles(blk, turtle) === null) {
const n = logo.connectionStore[turtle][blk].length;
for (let i = 0; i < n; i++) {
const obj = logo.connectionStore[turtle][blk].pop();
activity.blocks.blockList[obj[0]].connections[obj[1]] = obj[2];
if (obj[2] != null) {
activity.blocks.blockList[obj[2]].connections[0] = obj[0];
}
}
} else {
delete logo.connectionStore[turtle][blk];
}
} finally {
logo.connectionStoreLock = false;
}
};
// Set the turtle listener
logo.setTurtleListener(turtle, listenerName, __listener);
// Acquire lock synchronously for the main flow
// Note: This section runs synchronously, so we use a simple spin-wait
// with a maximum iteration count to prevent infinite loops
let lockAttempts = 0;
const maxLockAttempts = 1000;
while (logo.connectionStoreLock && lockAttempts < maxLockAttempts) {
lockAttempts++;
}
if (lockAttempts >= maxLockAttempts) {
console.warn(
"connectionStoreLock: Max attempts reached in DuplicateBlock flow"
);
}
logo.connectionStoreLock = true;
// Check to see if another turtle has already disconnected these blocks
const otherTurtle = __lookForOtherTurtles(blk, turtle);
if (otherTurtle != null) {
// Copy the connections and queue the blocks
logo.connectionStore[turtle][blk] = [];
for (let i = logo.connectionStore[otherTurtle][blk].length; i > 0; i--) {
const obj = [
logo.connectionStore[otherTurtle][blk][i - 1][0],
logo.connectionStore[otherTurtle][blk][i - 1][1],
logo.connectionStore[otherTurtle][blk][i - 1][2]
];
logo.connectionStore[turtle][blk].push(obj);
let child = obj[0];
if (activity.blocks.blockList[child].name === "hidden") {
child = activity.blocks.blockList[child].connections[0];
}
const queueBlock = new Queue(child, factor, blk, receivedArg);
tur.parentFlowQueue.push(blk);
tur.queue.push(queueBlock);
}
} else {
let child = activity.blocks.findBottomBlock(args[1]);
while (child != blk) {
if (activity.blocks.blockList[child].name !== "hidden") {
const queueBlock = new Queue(child, factor, blk, receivedArg);
tur.parentFlowQueue.push(blk);
tur.queue.push(queueBlock);
}
child = activity.blocks.blockList[child].connections[0];
}
// Break the connections between blocks in the clamp so
// that when we run the queues, only the individual blocks
// run
logo.connectionStore[turtle][blk] = [];
child = args[1];
while (child != null) {
const lastConnection =
activity.blocks.blockList[child].connections.length - 1;
const nextBlk =
activity.blocks.blockList[child].connections[lastConnection];
// Don't disconnect a hidden block from its parent
if (
nextBlk != null &&
activity.blocks.blockList[nextBlk].name === "hidden"
) {
logo.connectionStore[turtle][blk].push([
nextBlk,
1,
activity.blocks.blockList[nextBlk].connections[1]
]);
child = activity.blocks.blockList[nextBlk].connections[1];
activity.blocks.blockList[nextBlk].connections[1] = null;
} else {
logo.connectionStore[turtle][blk].push([
child,
lastConnection,
nextBlk
]);
activity.blocks.blockList[child].connections[lastConnection] = null;
child = nextBlk;
}
if (child != null) {
activity.blocks.blockList[child].connections[0] = null;
}
}
}
logo.connectionStoreLock = false;
}
}
}
/**
* Represents a block for defining the default action inside a Switch block.
* @extends {FlowClampBlock}
*/
class DefaultCaseBlock extends FlowClampBlock {
/**
* Constructs a DefaultCaseBlock instance.
*/
constructor() {
// Call the constructor of the parent class
super("defaultcase");
// Set the palette and activity for the block
this.setPalette("flow", activity);
// Set the help string for the block
this.setHelpString([
_("The Default block is used inside of a Switch to define the default action."),
"documentation",
null,
"switchhelp"
]);
// Form the block with specific parameters
this.formBlock({
name: _("default")
});
// Update the dock values for caseout and casein
this.updateDockValue(0, "caseout");
this.updateDockValue(2, "casein");
}
/**
* Handles the flow of the default case block.
* @param {Array} args - The arguments for the block.
* @param {object} logo - The logo object.
* @param {object} turtle - The turtle object.
* @param {number} blk - The block number.
*/
flow(args, logo, turtle, blk) {
const switchBlk = last(logo.switchBlocks[turtle]);
if (switchBlk === null) {
// Handle the case when the Default Case block is not inside a Switch block
activity.errorMsg(_("The Case Block must be used inside of a Switch Block."), blk);
logo.stopTurtle = true;
return;
}
const i = logo.switchCases[turtle][switchBlk].length;
// logo.switchCases[turtle][switchBlk].push(["__default__", args[0]]);
logo.switchCases[turtle][switchBlk][i - 1].push(["__default__", args[0]]);
}
}
/**
* Represents a block for defining matches inside a Switch block.
* @extends {FlowClampBlock}
*/
class CaseBlock extends FlowClampBlock {
/**
* Constructs a CaseBlock instance.
*/
constructor() {
// Call the constructor of the parent class
super("case");
// Set the palette and activity for the block
this.setPalette("flow", activity);
// Set the help string for the block
this.setHelpString([
_("The Case block is used inside of a Switch to define matches."),
"documentation",
null,
"switchhelp"
]);
// Form the block with specific parameters
this.formBlock({
name: _("case"),
args: 1,
argTypes: ["anyin"]
});
// Update the dock values for caseout and casein
this.updateDockValue(0, "caseout");
this.updateDockValue(3, "casein");
}
/**
* Handles the flow of the case block.
* @param {Array} args - The arguments for the block.
* @param {object} logo - The logo object.
* @param {object} turtle - The turtle object.
* @param {number} blk - The block number.
*/
flow(args, logo, turtle, blk) {
const switchBlk = last(logo.switchBlocks[turtle]);
if (switchBlk === null) {
// Handle the case when the Case block is not inside a Switch block
activity.errorMsg(_("The Case Block must be used inside of a Switch Block."), blk);
logo.stopTurtle = true;
return;
}
const i = logo.switchCases[turtle][switchBlk].length;
// logo.switchCases[turtle][switchBlk].push([args[0], args[1]]);
logo.switchCases[turtle][switchBlk][i - 1].push([args[0], args[1]]);
}
}
/**
* Represents a block for implementing switch-case functionality.
* @extends {FlowClampBlock}
*/
class SwitchBlock extends FlowClampBlock {
/**
* Constructs a SwitchBlock instance.
*/
constructor() {
// Call the constructor of the parent class
super("switch");
// Set the palette and activity for the block
this.setPalette("flow", activity);
// Set the help string for the block
this.setHelpString([
_("The Switch block will run the code in the matching Case."),
"documentation",
null,
"switchhelp"
]);
// Form the block with specific parameters
this.formBlock({
name: _("switch"),
args: 1,
argTypes: ["anyin"]
});
// Create the macro for the block
this.makeMacro((x, y) => [
[0, "switch", x, y, [null, 1, 2, 5]],
[1, ["number", { value: 1 }], 0, 0, [0]],
[2, "case", 0, 0, [0, 3, null, 4]],
[3, ["number", { value: 1 }], 0, 0, [2]],
[4, "defaultcase", 0, 0, [2, null, null]],
[5, "hidden", 0, 0, [0, null]]
]);
// Update the dock value for casein
this.updateDockValue(2, "casein");
}
/**
* Handles the flow of the switch block.
* @param {Array} args - The arguments for the block.
* @param {object} logo - The logo object.
* @param {object} turtle - The turtle object.
* @param {number} blk - The block number.
* @returns {Array} - An array containing the next block and its count.
*/
flow(args, logo, turtle, blk) {
const tur = activity.turtles.ithTurtle(turtle);
// Push the current switch block and create an empty case for it
logo.switchBlocks[turtle].push(blk);
if (blk in logo.switchCases[turtle]) {
logo.switchCases[turtle][blk].push([]);
} else {
logo.switchCases[turtle][blk] = [[]];
}
// Set up the listener for the switch block
const listenerName = "_switch_" + blk + "_" + turtle;
logo.setDispatchBlock(blk, turtle, listenerName);
// Define the listener function
const __listener = () => {
const switchBlk = last(logo.switchBlocks[turtle]);
// Run the cases here.
let switchCase;
const argBlk = activity.blocks.blockList[switchBlk].connections[1];
if (argBlk == null) {
switchCase = "__default__";
} else {
switchCase = logo.parseArg(logo, turtle, argBlk, logo.receivedArg);
}
let caseFlow = null;
for (let i = 0; i < last(logo.switchCases[turtle][switchBlk]).length; i++) {
if (last(logo.switchCases[turtle][switchBlk])[i][0] === switchCase) {
caseFlow = last(logo.switchCases[turtle][switchBlk])[i][1];
break;
} else if (last(logo.switchCases[turtle][switchBlk])[i][0] === "__default__") {
caseFlow = last(logo.switchCases[turtle][switchBlk])[i][1];
}
}
if (caseFlow != null) {
const queueBlock = new Queue(caseFlow, 1, switchBlk, null);
tur.parentFlowQueue.push(switchBlk);
tur.queue.push(queueBlock);
}
// Clean up afterward.
logo.switchCases[turtle][switchBlk].pop();
logo.switchBlocks[turtle].pop();
};
// Set the turtle listener
logo.setTurtleListener(turtle, listenerName, __listener);
// Return the next block and its count
return [args[1], 1];
}
}
/**
* Represents a hidden clamp block for controlling flow.
* @extends {FlowClampBlock}
*/
class ClampBlock extends FlowClampBlock {
/**
* Constructs a ClampBlock instance.
*/
constructor() {
// Call the constructor of the parent class
super("clamp");
// Set the palette and activity for the block
this.setPalette("flow", activity);
// Set the help string for the block
this.setHelpString();
// Mark the block as hidden
this.hidden = true;
// Form the block with specific parameters
this.formBlock(
{
name: ""
},
false
);
}
/**
* Handles the flow of the clamp block.
* @param {Array} args - The arguments for the block.
* @returns {Array} - An array containing the next block and its count.
*/
flow(args) {
if (args.length === 1) return [args[0], 1];
}
}
/**
* Represents a block for breaking out of a loop.
* @extends {BaseBlock}
*/
class BreakBlock extends BaseBlock {
/**
* Constructs a BreakBlock instance.
*/
constructor() {
// Call the constructor of the parent class
super("break");
// Set the palette and activity for the block
this.setPalette("flow", activity);
// Set the help string for the block
this.setHelpString([
_("The Stop block will stop a loop") +
": " +
_("Forever, Repeat, While, or Until."),
"documentation",
""
]);
// Form the block with specific parameters
this.formBlock({
name: _("Stop").toLowerCase(),
flows: {
top: true,
bottom: "tail",
type: ""
}
});
}
/**
* Handles the flow of the break block.
* @param {Array} _ - The arguments for the block (not used).
* @param {object} logo - The logo object.
* @param {object} turtle - The turtle object.
* @param {number} blk - The block number.
*/
flow(_, logo, turtle, blk) {
const tur = activity.turtles.ithTurtle(turtle);
// Perform the break operation
logo.doBreak(tur);
// Since we pop the queue, we need to unhighlight our parent
const parentBlk = activity.blocks.blockList[blk].connections[0];
if (parentBlk != null) {
if (!tur.singer.suppressOutput && tur.singer.justCounting.length === 0) {
tur.unhighlightQueue.push(parentBlk);
}
}
}
}
/**
* Represents a block for waiting until a condition is true.
* @extends {FlowBlock}
*/
class WaitForBlock extends FlowBlock {
/**
* Constructs a WaitForBlock instance.
*/
constructor() {
// Call the constructor of the parent class
super("waitFor");
// Set the palette and activity for the block
this.setPalette("flow", activity);
// Set the help string for the block
this.setHelpString([
_("The Waitfor block will wait until the condition is true."),
"documentation",
null,
"waitforhelp"
]);
// Form the block with specific parameters
this.formBlock({
name: _("wait for"),
args: 1,
argTypes: ["booleanin"]
});
}
/**
* Handles the flow of the wait-for block.
* @param {Array} args - The arguments for the block.
* @param {object} logo - The logo object.
* @param {object} turtle - The turtle object.
* @param {number} blk - The block number.
*/
flow(args, logo, turtle, blk) {
if (args.length !== 1) return;
const tur = activity.turtles.ithTurtle(turtle);
if (!args[0]) {
// Requeue.
const parentBlk = activity.blocks.blockList[blk].connections[0];
const queueBlock = new Queue(blk, 1, parentBlk);
tur.parentFlowQueue.push(parentBlk);
tur.queue.push(queueBlock);
tur.doWait(0.05);
} else {
// Since a wait-for block was requeued each
// time, we need to flush the queue of all but
// the last one, otherwise the child of the
// while block is executed multiple times.
const queueLength = tur.queue.length;
let kept_one = false;
for (let i = queueLength - 1; i > 0; i--) {
if (tur.queue[i].parentBlk === blk) {
if (kept_one) {
tur.queue.pop();
} else {
kept_one = true;
}
}
}
// We need to reset the turtle time
if (logo.firstNoteTime === null) {
logo.firstNoteTime = new Date().getTime();
}
const elapsedTime = (new Date().getTime() - this.firstNoteTime) / 1000;
tur.singer.turtleTime = elapsedTime;
tur.singer.previousTurtleTime = elapsedTime;
}
}
}
/**
* Represents a block for repeating until a condition is true.
* @extends {FlowClampBlock}
*/
class UntilBlock extends FlowClampBlock {
/**
* Constructs an UntilBlock instance.
*/
constructor() {
// Call the constructor of the parent class
super("until");
// Set the palette and activity for the block
this.setPalette("flow", activity);
// Set the help string for the block
this.setHelpString([
_("The Until block will repeat until the condition is true."),
"documentation",
null,
"untilhelp"
]);
// Form the block with specific parameters
this.formBlock({
name: _("until"),
flows: {
labels: [this.lang === "ja" ? _("do2") : _("do")]
},
args: 1,
argTypes: ["booleanin"]
});
}
/**
* Handles the flow of the until block.
* @param {Array} args - The arguments for the block.
* @param {object} logo - The logo object.
* @param {object} turtle - The turtle object.
* @param {number} blk - The block number.
* @returns {Array} - An array containing the next block and its count.
*/
flow(args, logo, turtle, blk) {
if (args.length !== 2) return;
const tur = activity.turtles.ithTurtle(turtle);
if (!args[0]) {
// We will add the outflow of the until block
// each time through, so we pop it off so as
// to not accumulate multiple copies.
const queueLength = tur.queue.length;
if (queueLength > 0) {
if (tur.queue[queueLength - 1].parentBlk === blk) {
tur.queue.pop();
}
}
// Requeue
const parentBlk = activity.blocks.blockList[blk].connections[0];
const queueBlock = new Queue(blk, 1, parentBlk);
tur.parentFlowQueue.push(parentBlk);
tur.queue.push(queueBlock);
} else {
// Since an until block was requeued each
// time, we need to flush the queue of all but
// the last one, otherwise the child of the
// until block is executed multiple times.
const queueLength = tur.queue.length;
for (let i = queueLength - 1; i > 0; i--) {
if (tur.queue[i].parentBlk === blk) {
tur.queue.pop();
}
}
}
// Queue the child flow.
return [args[1], 1];
}
}
/**
* Represents a block for repeating while a condition is true.
* @extends {FlowClampBlock}
*/
class WhileBlock extends FlowClampBlock {
/**
* Constructs a WhileBlock instance.
*/
constructor() {
// Call the constructor of the parent class
super("while");
// Set the palette and activity for the block
this.setPalette("flow", activity);
// Set the help string for the block
this.setHelpString([
_("The While block will repeat while the condition is true."),
"documentation",
null,
"whilehelp"
]);
// Form the block with specific parameters
this.formBlock({
name: _("while"),
flows: {
labels: [this.lang === "ja" ? _("do2") : _("do")]
},
args: 1,
argTypes: ["booleanin"]
});
}
/**
* Handles the flow of the while block.
* @param {Array} args - The arguments for the block.
* @param {object} logo - The logo object.
* @param {object} turtle - The turtle object.
* @param {number} blk - The block number.
* @returns {Array} - An array containing the next block and its count.
*/
flow(args, logo, turtle, blk) {
// While is tricky because we need to recalculate
// args[0] each time, so we requeue the While block
// itself.
if (args.length !== 2) return;
const tur = activity.turtles.ithTurtle(turtle);
if (args[0]) {
// We will add the outflow of the while block
// each time through, so we pop it off so as
// to not accumulate multiple copies.
const queueLength = tur.queue.length;
if (queueLength > 0) {
if (tur.queue[queueLength - 1].parentBlk === blk) {
tur.queue.pop();
}
}
const parentBlk = activity.blocks.blockList[blk].connections[0];
const queueBlock = new Queue(blk, 1, parentBlk);
tur.parentFlowQueue.push(parentBlk);
tur.queue.push(queueBlock);
// and queue the interior child flow.
return [args[1], 1];
} else {
// Since a while block was requeued each time,
// we need to flush the queue of all but the
// last one, otherwise the child of the while
// block is executed multiple times.
const queueLength = tur.queue.length;
for (let i = queueLength - 1; i > 0; i--) {
if (tur.queue[i].parentBlk === blk) {
tur.queue.pop();
}
}
}
// Queue the child flow.
return [args[1], 1];
}
}
/**
* Represents a block for conditionally executing one of two flows.
* @extends {FlowClampBlock}
*/
class IfThenElseBlock extends FlowClampBlock {
/**
* Constructs an IfThenElseBlock instance.
*/
constructor() {
// Call the constructor of the parent class
super("ifthenelse");
// Set the palette and activity for the block
this.setPalette("flow", activity);
this.beginnerBlock(true);
if (activity.beginnerMode && this.lang === "ja") {
this.setHelpString([
_(
"Conditionals lets your program take different actions depending on the condition."
) +
" " +
_("In this example if the mouse button is pressed a snare drum will play."),
"documentation",
null,
"elifhelp"
]);
} else {
this.setHelpString([
_(
"Conditionals lets your program take different actions depending on the condition."
) +
" " +
_(
"In this example if the mouse button is pressed a snare drum will play, else a kick drum will play."
),
"documentation",
null,
"elifhelp"
]);
}
// Form the block with specific parameters
this.formBlock({
name: _("if"),
flows: {
labels: [_("then"), _("else")]
},
args: 1,
argTypes: ["booleanin"]
});
}
/**
* Handles the flow of the if-then-else block.
* @param {Array} args - The arguments for the block.
* @returns {Array} - An array containing the next block and its count.
*/
flow(args) {
if (args.length !== 3) return;
if (args[0]) return [args[1], 1];
return [args[2], 1];
}
}
/**
* Represents a block for conditionally executing a flow.
* @extends {FlowClampBlock}
*/
class IfBlock extends FlowClampBlock {
/**
* Constructs an IfBlock instance.
*/
constructor() {
// Call the constructor of the parent class
super("if");
// Set the palette and activity for the block
this.setPalette("flow", activity);
this.beginnerBlock(true);
if (activity.beginnerMode && this.lang === "ja") {
this.setHelpString([
_(
"Conditionals lets your program take different actions depending on the condition."
) +