-
Notifications
You must be signed in to change notification settings - Fork 19
/
stativus.js
1441 lines (1259 loc) · 46.4 KB
/
stativus.js
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
/*globals Stativus:true, exports, $, createNode*/
/**
This is the code for creating statecharts in your javascript files
@author: Evin Grano
*/
//? if (DEBUG_MODE) {
if (typeof DEBUG_MODE === "undefined"){
DEBUG_MODE = true;
COLOR_MODE = navigator.userAgent.toLowerCase().indexOf('chrome') > -1;
if (COLOR_MODE) {
EVENT_COLOR = "#CC00FF";
ENTER_COLOR = "#009900";
EXIT_COLOR = "#880000";
}
}
//? }
var jQueryIsLoaded=false;
try {
if (jQuery) jQueryIsLoaded=true;
}
catch(err){
jQueryIsLoaded=false;
}
/** #preserve #license
==========================================================================
Statechart -- A Micro Library
Copyright: ©2011-2017 Evin Grano All rights reserved.
Portions ©2011-2017 Evin Grano, and contributors
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 and the Software is used
for Good, and not Evil.
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.
For more information about Statechart, visit http://www.itsgotwhatplanscrave.com
==========================================================================
*/
var creator = function(){
function F() {}
F.prototype = this;
return new F();
};
// helper function for merging in properties
var merge = function(obj, configs){
obj = obj || {};
configs = configs || [];
configs.forEach( function(x){
if (typeof x === 'object'){
for (var k in x){
if(x.hasOwnProperty(k)) obj[k] = x[k];
}
}
});
return obj;
};
Stativus = { DEFAULT_TREE: 'default', SUBSTATE_DELIM: 'SUBSTATE:', version: '/*?= VERSION */' };
// This creates the Debug object that is used to output statements
//? if (DEBUG_MODE) {
if(DEBUG_MODE){
Stativus.DebugMessagingObject = {
level: 1,
_buildOutput: function(type, state, details, tree){
tree = tree || Stativus.DEFAULT_TREE;
var msg = "Global::["+tree+"] ";
msg = msg + "=> State::["+state+"]: ";
msg = msg + '{'+type+'} > '+details;
return msg;
},
sendLog: function(type, state, details, tree){
if (this.level > 0) return;
var msg = this._buildOutput(type, state, details, tree);
if (console && console.log) console.log(msg);
return msg;
},
sendInfo: function(type, state, details, tree){
if (this.level > 1) return;
var msg = this._buildOutput(type, state, details, tree);
if (console && console.info) console.info(msg);
return msg;
},
sendWarn: function(type, state, details, tree){
if (this.level > 2) return;
var msg = this._buildOutput(type, state, details, tree);
if (console && console.warn) console.warn(msg);
return msg;
},
sendError: function(type, state, details, tree){
if (this.level > 3) return;
var msg = this._buildOutput(type, state, details, tree);
if (console && console.error) console.error(msg);
return msg;
}
};
}
//? }
// ******************
// State Object
// ******************
Stativus.State = {
// walk like a duck
isState: true,
_data: null,
_isNone: function(value){
return (value === undefined || value === null);
},
goToState: function(name, data){
var sc = this.statechart;
if (sc){ sc.goToState(name, this.globalConcurrentState, this.localConcurrentState, data); }
//? if (DEBUG_MODE) {
else { // weird format for UglifyJS preprocessing
if (DEBUG_MODE){ throw 'Cannot goToState cause state doesnt have a statechart'; }
}
//? }
},
goToHistoryState: function(name, isRecursive){
var sc = this.statechart;
if (sc){ sc.goToHistoryState(name, this.globalConcurrentState, this.localConcurrentState, isRecursive); }
//? if (DEBUG_MODE) {
else { // weird format for UglifyJS preprocessing
if (DEBUG_MODE){ throw 'Cannot goToState cause state doesnt have a statechart'; }
}
//? }
},
sendEvent: function(evt){
var sc = this.statechart;
if (sc){ sc.sendEvent.apply(sc, arguments); }
//? if (DEBUG_MODE) {
else { // weird format for UglifyJS preprocessing
if (DEBUG_MODE){ throw 'Cannot sendEvent cause state doesnt have a statechart'; }
}
//? }
},
sendAction: function(evt){
return this.sendEvent.apply(this, arguments);
},
getData: function(key){
if (this._isNone(key)) return key;
var sc = this.statechart, ret = this._data[key];
if (this._isNone(ret)) ret = sc.getData(key, this.parentState, this.globalConcurrentState);
return ret;
},
setData: function(key, value){
if (this._isNone(key)) return value;
this._data[key] = value;
},
removeData: function(key){
if (this._isNone(key)) return key;
var sc = this.statechart, ret = this._data[key];
if (this._isNone(ret)) {
sc.removeData(key, this.parentState, this.globalConcurrentState);
} else delete this._data[key];
},
setHistoryState: function(state){
this.history = this.substatesAreConcurrent ? this.substates : state.name;
//? if (DEBUG_MODE) {
if (DEBUG_MODE) {
Stativus.DebugMessagingObject.sendLog('HISTORY STATE SET', this.name, ' history state set to: '+state.name, this.globalConcurrentState);
}
//? }
},
_parseAndHandleEvents: function(events, remove) {
var sc = this.statechart, that = this;
function addEvent(evt, sel, fire) {
if (sel) {
jQuery('body').on(evt, sel, function (ev) { sc.sendEvent(fire, ev); });
}
else {
jQuery('body').on(evt, function (ev) { sc.sendEvent(fire, ev); });
}
//? if (DEBUG_MODE) {
if (DEBUG_MODE) {
Stativus.DebugMessagingObject.sendLog('STATE EVENT ADDED', that.name, ' event added from: '+ JSON.stringify({event: evt, selector: sel, toFire: fire}), that.globalConcurrentState);
}
//? }
}
function removeEvent(evt, sel) {
if (sel) {
jQuery('body').off(evt, sel);
}
else {
jQuery('body').off(evt);
}
//? if (DEBUG_MODE) {
if (DEBUG_MODE) {
Stativus.DebugMessagingObject.sendLog('STATE EVENT REMOVED', that.name, ' event removed '+ JSON.stringify({event: evt, selector: sel}), that.globalConcurrentState);
}
//? }
}
for (var key in events) {
if (events.hasOwnProperty(key)) {
var split, evt, selector, toFire;
split = key.split(' ');
evt = split[0];
// allow for complex paths
// 'change #foo .bar select'
selector = key.replace(evt,"");
toFire = events[key];
if(remove) removeEvent(evt, selector);
else addEvent(evt, selector, toFire);
}
}
},
_bindEvents: function() {
var prop = this.events || this.actions;
if (prop) {
this._parseAndHandleEvents(prop);
}
},
_unBindEvents: function() {
var prop = this.events || this.actions;
if (prop) {
this._parseAndHandleEvents(prop, true);
}
}
};
// Our Maker function: Thank you D.Crockford.
Stativus.State.create = function (config, sc) {
var nState, k, i, len, configs = [config],
key = config.name+'_'+config.globalConcurrentState,
waitingConfig = sc._configs_in_waiting[key];
nState = creator.call(this);
nState._data = {};
if (waitingConfig) configs.push(waitingConfig);
return merge(nState, configs);
};
/**
Statechart functionality...
TODO: Document more...
*/
Stativus.Statechart = {
create: function(config){
var sc = creator.call(this);
// config all the internal information
sc.isStatechart = true;
sc._all_states = {};
sc._all_states[Stativus.DEFAULT_TREE] = {};
sc._states_with_concurrent_substates = {};
sc._current_subtrees = {};
sc._current_state = {};
sc._current_state[Stativus.DEFAULT_TREE] = null;
sc._goToStateLocked = false;
sc._sendEventLocked = false;
sc._pendingStateTransitions = [];
sc._pendingEvents = [];
sc._active_subtrees = {};
sc._configs_in_waiting = {};
sc._paused_transition_states = {};
//? if (DEBUG_MODE) {
if(DEBUG_MODE){
sc.inState = function(name, tree){
var ret = false, cStates = this.currentState(tree);
if (!cStates) throw "Doesn't appear that you are in any states, perhaps you forgot to 'initStates'?";
cStates.forEach( function(x){
if(x.name === name) ret = true;
});
return ret;
};
sc.getActiveStates = sc.currentState;
}
//? }
return sc;
},
addState: function(name){
var tree, obj, hasConcurrentSubstates = false, pState, pName, states,
cTree, nState, config, configs = [], len, i, that = this, key, treeObj;
for(i = 1, len = arguments.length; i < len; i++){
configs[i-1] = config = arguments[i];
hasConcurrentSubstates = hasConcurrentSubstates || !!config.substatesAreConcurrent;
tree = tree || config.globalConcurrentState;
pName = pName || config.parentState;
}
tree = tree || Stativus.DEFAULT_TREE;
config = len === 1 ? {} : merge(null, configs);
// primary config is always the last config
config.name = name;
config.statechart = this;
config.globalConcurrentState = tree;
// Concurrent Substate checks:
// Do i have substates?
cTree = this._states_with_concurrent_substates[tree];
if (hasConcurrentSubstates){
obj = this._states_with_concurrent_substates[tree] || {};
obj[name] = true;
this._states_with_concurrent_substates[tree] = obj;
}
// Am I a substate of any parent State?
if (pName){
treeObj = this._all_states[tree];
pState = treeObj && treeObj[pName];
if(!pState) {
key = pName+'_'+tree;
this._configs_in_waiting[key] = pState = this._configs_in_waiting[key] || {};
}
pState.substates = pState.substates || [];
pState.substates.push(name);
}
nState = Stativus.State.create(config, this);
// Actually add the state to our statechart
obj = this._all_states[tree] || {};
//? if (DEBUG_MODE) {
if (DEBUG_MODE){
if (obj[name]) throw ['Trying to add state', name, 'to state tree', tree, 'and it already exists'].join(' ');
}
//? }
obj[name] = nState;
this._all_states[tree] = obj;
nState._beenAdded = true;
// Code to get the substates and add them.
states = nState.states || [];
//? if (DEBUG_MODE) {
if (DEBUG_MODE){
if(states.length === 1 && nState.substatesAreConcurrent){ // weird format for UglifyJS preprocessing
throw ['Trying to add substates in property \'states\' to '+nState.name+', but must have more than ONE substate'];
}
}
//? }
states.forEach( function(x, idx){
var args = [], good = false, last;
if(typeof x === 'object' && x.length > 0){
//? if (DEBUG_MODE) {
if (DEBUG_MODE){
if (typeof x[0] !== 'string'){
throw '#addState: invalid substate array...Must have the name at index=0';
}
}
//? }
args = args.concat(x);
good = true;
}
else if(typeof x === 'string'){
args.push(x);
good = true;
}
else if (typeof x === 'object'){
//? if (DEBUG_MODE) {
if (DEBUG_MODE){
if (typeof x.name !== 'string') throw '#addState: invalid substate hash...Must have a \'name\' property';
}
//? }
args.push(x.name);
args.push(x);
good = true;
}
if (good){
// add missing config parts to the last element.
last = args.length-1;
args[last].parentState = name;
args[last].globalConcurrentState = tree;
that.addState.apply(that, args);
}
//? if (DEBUG_MODE) {
else {
if (DEBUG_MODE) throw '#addState: invalid substate at index='+idx;
}
//? }
});
return this;
},
initStates: function(init){
var x, state;
this._inInitialSetup = true;
if ( typeof init === 'string'){
this.goToState(init, Stativus.DEFAULT_TREE);
}
else if ( typeof init === 'object'){
for( x in init){
if (init.hasOwnProperty(x)){
state = init[x];
this.goToState(state, x);
}
}
}
this._inInitialSetup = false;
this._flushPendingEvents();
return this;
},
goToState: function(requestedState, tree, localConcurrentState, data){
var cState, allStates = this._all_states[tree], idx, len,
enterStates = [], exitStates = [], haveExited, indexes, that,
reqState, pState, i, substateTree, t,
enterStateHandled, exitStateHandled, substates;
//? if (DEBUG_MODE) {
if (DEBUG_MODE){
if (!tree) throw '#goToState: invalid global parallel state';
}
//? }
// First, find the current tree off of the localConcurrentState, then the main tree
cState = (localConcurrentState && this._current_state[localConcurrentState]) || this._current_state[tree];
t = typeof requestedState;
if (t === 'object'){
reqState = this._compileStateTransitions(requestedState, allStates);
} else if (t === 'string'){
reqState = allStates[requestedState];
} else {
return;
}
//? if (DEBUG_MODE) {
if (DEBUG_MODE) {
if (!reqState) throw '#goToState: Could not find requested state: '+requestedState;
}
//? }
// if the current state is the same as the requested state do nothing
if (this._checkAllCurrentStates(reqState, localConcurrentState || tree)) return;
this._setDataOnState(reqState, data);
if (this._goToStateLocked){
// There is a state transition currently happening. Add this requested
// state transition to the queue of pending state transitions. The req
// will be invoked after the current state transition is finished
this._pendingStateTransitions.push({
requestedState: requestedState,
tree: tree,
localConcurrentState: localConcurrentState
});
return;
}
// Lock for the current state transition, so that it all gets sorted out
// in the right order
this._goToStateLocked = true;
// Get the parent states for the current state and the registered state.
// we will use them to find the commen parent state
enterStates = this._parentStatesWithRoot(reqState);
exitStates = cState ? this._parentStatesWithRoot(cState) : [];
indexes = this._findCommonAncestor(exitStates, enterStates);
// Setup for the enter state sequence
this._enterStates = enterStates;
this._enterStateMatchIndex = indexes.second;
this._enterStateTree = tree;
// Now, we will exit all the underlying states till we reach the common
// parent state. We do not exit the parent state because we transition
// within it.
this._exitStateStack = [];
for (i = 0; i < indexes.first; i+=1){
cState = exitStates[i];
if (cState.substatesAreConcurrent) this._fullExitFromSubstates(tree, cState);
this._exitStateStack.push(cState);
}
// Now, that we have the full stack of states to exit
// We can exit them in an orderly fashion.
this._unwindExitStateStack();
},
// Common Ancestor function:
// continue by finding the common parent state for the current and
// requested states:
//
// At most, this takes O(m^2) time, where m is the maximum depth from the
// root of the tree to either the requested state or the current state.
// Will always be less than or equal to O(n^2), where n is the number
// of states in the tree
_findCommonAncestor: function(set1, set2){
var idx, len, set1Idx, set2Idx = -1;
for (idx = 0, len = set1.length; idx < len; idx++){
set1Idx = idx;
set2Idx = set2.indexOf(set1[idx]);
if(set2Idx >= 0) break;
}
// In the case where we don't find a common parent state, we
// must enter from the root state
if (set2Idx < 0) set2Idx = set2.length - 1;
return {first: set1Idx, second: set2Idx};
},
_compileStateTransitions: function(stateTransitionObj, allStates){
var key, curr, ret, indexes,
retStates, currStates, pivot,
firstTime = true;
for(key in stateTransitionObj){
if (stateTransitionObj.hasOwnProperty(key)){
curr = stateTransitionObj[key];
if (firstTime){
ret = allStates[curr];
retStates = this._parentStates(ret);
firstTime = false;
} else {
currStates = this._parentStates(allStates[curr]);
indexes = this._findCommonAncestor(retStates, currStates);
// if we can't find a common ancestor then we have a violation of the statechart
if (indexes.second < 0){
//? if (DEBUG_MODE) {
if (DEBUG_MODE){
Stativus.DebugMessagingObject.sendError('TRANSITION:', ret.name, 'Invalid Transition to '+curr.name+' because of no suitable common ancestor', ret.globalConcurrentState);
}
//? }
continue;
}
// check to see if the common ancestor has concurrent substates because
// we need to pause transition on the parent state
pivot = currStates[indexes.second];
if (!pivot.substatesAreConcurrent){
//? if (DEBUG_MODE) {
if (DEBUG_MODE){
Stativus.DebugMessagingObject.sendError('TRANSITION:', ret.name, 'Invalid Transition to '+curr.name+' because of common ancestor is NOT have concurrent Substates', ret.globalConcurrentState);
}
//? }
continue;
}
pivot = currStates[indexes.second-1];
// now we take the top most concurrent substate and pause it in transition
// we will catch it on the next round of transition...
if(pivot){
this._paused_transition_states = this._paused_transition_states || {};
this._paused_transition_states[pivot.name] = (this._paused_transition_states[pivot.name] || 0) + 1;
this._pendingStateTransitions.push({
requestedState: curr,
tree: pivot.globalConcurrentState,
localConcurrentState: pivot.localConcurrentState
});
}
//? if (DEBUG_MODE) {
else if (DEBUG_MODE){
Stativus.DebugMessagingObject.sendError('TRANSITION:', ret.name, 'Invalid Transition to '+curr.name+' because of common ancestor is NOT have concurrent Substates', ret.globalConcurrentState);
}
//? }
}
}
}
return ret;
},
goToHistoryState: function(requestedState, tree, localConcurrentState, isRecursive){
var allStatesForTree = this._all_states[tree],
pState, realHistoryState;
//? if (DEBUG_MODE) {
if (DEBUG_MODE){
if (!tree || !allStatesForTree) throw '#goToHistoryState: State requesting does not have a valid global parallel tree';
}
//? }
pState = allStatesForTree[requestedState];
if (pState) realHistoryState = pState.history || pState.initialSubstate;
if(!realHistoryState){
realHistoryState = requestedState;
}
else if (isRecursive){
this.goToHistoryState(realHistoryState, tree, isRecursive);
return;
}
this.goToState(realHistoryState, tree);
},
currentState: function(tree){
var ret, tmp, sTree, aTrees, bTree, cStates = this._current_state,
cState, i, len, state, ps, aStates;
tree = tree || 'default';
cState = cStates[tree];
aStates = this._all_states[tree];
// now add all the parents of the current state...
if (cState && cState.isState){
ret = this._parentStates(cState);
}
// Now see if it has substates...
if (cState && cState.substatesAreConcurrent){
aTrees = this._active_subtrees[tree] || [];
for(i = 0, len = aTrees.length; i < len; i++){
sTree = aTrees[i];
state = cStates[sTree];
if(state) ps = aStates[state.parentState];
if (ps && ret.indexOf(ps) < 0) ret.unshift(ps);
if (state && ret.indexOf(state) < 0) ret.unshift(state);
}
}
return ret;
},
sendEvent: function(evt){
var args = [], len = arguments.length, i;
if (len < 1) return;
for(i = 1; i < len; i++){
args[i-1] = arguments[i];
}
try {
if (this._inInitialSetup || this._sendEventLocked || this._goToStateLocked){
// We want to prevent any events from occurring until
// we have completed the state transitions and events
this._pendingEvents.push({
evt: evt,
args: args
});
return;
}
this._sendEventLocked = true;
// function that processes the event, diff for testing v. production
this._processEvent(evt, args);
} catch(err) {
this._restartEvents();
throw err;
}
this._restartEvents();
},
_setDataOnState: function(state, data){
if (state && typeof data !== 'undefined' && data !== null) {
//? if (DEBUG_MODE) {
if (DEBUG_MODE) {
Stativus.DebugMessagingObject.sendLog('SETTING DATA FOR TRANSITION FOR => '+state.name);
}
//? }
if (typeof data === 'string') state.setData(data, data);
if (typeof data === 'object') {
for (var key in data) {
if(data.hasOwnProperty(key)) state.setData(key, data[key]);
}
}
}
},
_processEvent: function(evt, args){
this._structureCrawl('_cascadeEvents', evt, args);
},
getData: function(key, stateName, tree){
var allStates = this._all_states[tree], state;
if (!allStates) return null;
state = allStates[stateName];
if (state && state.isState) return state.getData(key);
},
removeData: function(key, statename, tree){
var allStates = this._all_states[tree], state;
if (!allStates) return null;
state = allStates[statename];
if (state && state.isState) return state.removeData(key);
},
getState: function(name, tree){
var allStates, ret;
tree = tree || Stativus.DEFAULT_TREE;
allStates = this._all_states[tree];
if (!allStates) return null;
ret = allStates[name];
return ret;
},
_restartEvents: function(){
// Now, that the states have a chance to process the first action
// we can go ahead and flush the queued events
this._sendEventLocked = false;
if (!this._inInitialSetup) this._flushPendingEvents();
},
_structureCrawl: function(func, evt, args){
var tree, currentStates = this._current_state, i, len, sResponder, tmp,
allStates, responder, aTrees, sTree, handled, found, ss = Stativus.SUBSTATE_DELIM;
for(tree in currentStates){
if(currentStates.hasOwnProperty(tree)) {
handled = false;
sTree = null;
responder = currentStates[tree];
if (!responder || tree.slice(0, ss.length) === ss) continue;
// if we don't have an all state tree then we know that this is a substate tree
allStates = this._all_states[tree];
if(!allStates) continue;
aTrees = this._active_subtrees[tree] || [];
for(i = 0, len = aTrees.length; i < len; i++){
sTree = aTrees[i];
sResponder = currentStates[sTree];
tmp = handled ? [true, true] : this[func](evt, args, sResponder, allStates, sTree);
handled = tmp[0];
//? if (DEBUG_MODE) {
if (DEBUG_MODE) found = tmp[1];
//? }
}
if (!handled) {
tmp = this[func](evt, args, responder, allStates, null);
handled = tmp[0];
//? if (DEBUG_MODE) {
if (DEBUG_MODE){
if (!found) found = tmp[1];
}
//? }
}
//? if (DEBUG_MODE) {
if (DEBUG_MODE){
if(!found) {
Stativus.DebugMessagingObject.sendLog('EVENT', this.name, 'Fired {'+evt+'} with '+(args.length || 0)+' argument(s) found NO state to handle this', this.globalConcurrentState);
}
}
//? }
}
}
},
/**
@private
name: _cascadeEvents
*/
_cascadeEvents: function(evt, args, responder, allStates, tree){
var handled, ssName, found = false, func;
// substate prep work...
ssName = this._splitConcurrencyKey(tree);
while(!handled && responder){
func = responder[evt];
if (func){
//? if (DEBUG_MODE) {
if (DEBUG_MODE) {
Stativus.DebugMessagingObject.sendInfo('EVENT', responder.name, 'Fired \''+evt+'\' with '+(args.length || 0)+' argument(s)', responder.globalConcurrentState);
}
//? }
try {
handled = func.apply(responder, args);
} catch(e){
//? if (DEBUG_MODE) {
if (DEBUG_MODE) {
Stativus.DebugMessagingObject.sendError('EVENT', responder.name, 'Fired \''+evt+'\': Exception: '+e, responder.globalConcurrentState);
}
//? }
}
found = true;
}
// check to see if we have reached the end of this tree
if (tree && ssName === responder.name) return [handled, found];
responder = !handled && responder.parentState ? allStates[responder.parentState] : null ;
}
return [handled, found];
},
_checkAllCurrentStates: function(reqState, tree){
var currentStates = this.currentState(tree) || [];
if (currentStates === reqState) return true;
else if (typeof currentStates === 'string' && reqState === this._all_states[tree][currentStates]) return true;
else if (currentStates.indexOf && currentStates.indexOf(reqState) > -1) return true;
else return false;
},
_flushPendingEvents: function(){
var args, pa = this._pendingEvents.shift();
if(!pa) return;
args = pa.args;
args.unshift(pa.evt);
this.sendEvent.apply(this, args);
},
_flushPendingStateTransitions: function(){
var pending = this._pendingStateTransitions.shift(), msg;
if (!pending) return false;
this.goToState(pending.requestedState, pending.tree, pending.localConcurrentState);
return true;
},
_fullEnter: function(state){
var pState, tree, enterStateHandled = false;
if (!state) return;
this._addActiveConcurrentSubstate(state, state.localConcurrentState);
tree = state.localConcurrentState || state.globalConcurrentState;
this._current_state[tree] = state;
try {
if (state.enterState) state.enterState();
if (state.didEnterState) state.didEnterState();
if (jQueryIsLoaded && (state.actions || state.events)) state._bindEvents();
} catch(e){
//? if (DEBUG_MODE) {
if (DEBUG_MODE) {
Stativus.DebugMessagingObject.sendError('ENTER STATE', state.name, 'EXECEPTION ['+e+']', state.globalConcurrentState);
}
//? }
}
//? if (DEBUG_MODE) {
if (DEBUG_MODE) {
Stativus.DebugMessagingObject.sendInfo('ENTER STATE', state.name, 'Completed', state.globalConcurrentState);
}
//? }
if (state.parentState) {
pState = state.statechart.getState(state.parentState, state.globalConcurrentState);
pState.setHistoryState(state);
}
this._unwindEnterStateStack();
},
_fullExit: function(state){
var pState, tree, key;
if (!state) return;
var exitStateHandled = false;
try {
if (jQueryIsLoaded && (state.actions || state.events)) state._unBindEvents();
if (state.exitState) state.exitState();
if (state.didExitState) state.didExitState();
// check to see if we are in a concurrent substate and if we are the defined
// state then delete the item else set the parent to the current state
// debugger;
tree = state.localConcurrentState || state.globalConcurrentState;
key = this._splitConcurrencyKey(tree);
if (key === state.name) {
delete this._current_state[tree];
} else {
this._current_state[tree] = this._all_states[state.globalConcurrentState][state.parentState];
}
} catch (e){
//? if (DEBUG_MODE) {
if (DEBUG_MODE) {
Stativus.DebugMessagingObject.sendError('EXIT STATE', state.name, 'EXECEPTION ['+e+']', state.globalConcurrentState);
}
//? }
}
//? if (DEBUG_MODE) {
if (DEBUG_MODE) {
Stativus.DebugMessagingObject.sendInfo('EXIT STATE', state.name, 'Completed', state.globalConcurrentState);
}
//? }
this._unwindExitStateStack();
},
_initiateEnterStateSequence: function(){
var enterStates, enterMatchIndex, concurrentTree, tree,
allStates, i, cState;
enterStates = this._enterStates;
enterMatchIndex = this._enterStateMatchIndex;
tree = this._enterStateTree;
allStates = this._all_states[tree];
// Initialize the Enter State Stack
this._enterStateStack = this._enterStateStack || [];
// Finally, from the common parent state, but not including the parent state,
// enter the sub states down to the requested state. If the requested state
// has an initial sub state, then we must enter it too
i = enterMatchIndex-1;
cState = enterStates[i];
tree = this._getValidLocalConcurrentState(cState) || tree;
if (cState) this._cascadeEnterSubstates(cState, enterStates.slice(0, enterMatchIndex), i-1, tree, allStates);
// once, we have fully hydrated the Enter State Stack, we must actually async unwind it
this._unwindEnterStateStack();
// Cleanup
enterStates = null;
enterMatchIndex = null;
concurrentTree = null;
tree = null;
delete this._enterStates;
delete this._enterStateMatchIndex;
delete this._enterStateTree;
},
_cascadeEnterSubstates: function(start, requiredStates, index, tree, allStates){
var cState, pState, subStates, that = this, newReqStates,
nTree, bTree, name, currStates, aTrees, nTreeBase;
if (!start || that._checkIfPausedState(start)) return;
name = start.name;
this._enterStateStack.push(start);
start.localConcurrentState = tree;
if (start.substatesAreConcurrent){
tree = start.globalConcurrentState || Stativus.DEFAULT_TREE;
nTreeBase = [Stativus.SUBSTATE_DELIM,tree,name].join('=>');
subStates = start.substates || [];
subStates.forEach( function(x){
cState = allStates[x];
// check to see if this state is on the paused list
// if, yes, then decrement the list count
if(that._checkIfPausedState(cState)) return;
// Now, we have to push the item onto the active subtrees for
// the base tree for later use of the events.
nTree = nTreeBase+'=>'+x;
// that._addActiveConcurrentSubstate(cState, nTree);
// If we have required states and we are in the middle of them
// check to see if we are on the required list and decrement the
// index and use the required list of states
if (index > -1 && requiredStates[index] === cState){
index = index - 1;
newReqStates = requiredStates;
// if we are in one of the other substates we *don't* have any
// required states so we must zero it out and just flow naturally
// through the initialSubstates.
} else {
newReqStates = [];
}
that._cascadeEnterSubstates(cState, newReqStates, index, nTree, allStates);
});
return;
}
else {
// now we can trigger the lower levels of the state
cState = requiredStates[index];
if (cState){
if (index > -1 && requiredStates[index] === cState) index = index - 1;
this._cascadeEnterSubstates( cState, requiredStates, index, tree, allStates);
}
// now we will go into the initial substates of this state
else {
cState = allStates[start.initialSubstate];
this._cascadeEnterSubstates( cState, requiredStates, index, tree, allStates);
}
}
},
_addActiveConcurrentSubstate: function(state, localConcurrentKey){
var gTree, aTrees;
if(!localConcurrentKey || state.globalConcurrentState === localConcurrentKey) return;
gTree = state.globalConcurrentState || Stativus.DEFAULT_TREE;
aTrees = this._active_subtrees[gTree] || [];
if (aTrees.indexOf(localConcurrentKey) < 0){
aTrees.unshift(localConcurrentKey);
this._active_subtrees[gTree] = aTrees;
}
},
_checkIfPausedState: function(state){
// check to see if this state is on the paused list
// if, yes, then decrement the list count
if(this._paused_transition_states[state.name]){