-
Notifications
You must be signed in to change notification settings - Fork 2
/
bitwrench.js
executable file
·3348 lines (2844 loc) · 122 KB
/
bitwrench.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
/*
* bitwrench.js --- Misc Helper Functions ..
*
* bitwrench is just a named space set of javascript helper functions useful for common web tasks and
* some server side js. No rhyme or reason I just needed these items over and overgain and didn't feel
* like cobbling together different common libs
*
* M. A. Chatterjee 2013
*
* @copy Copyright (C) <2013> <M. A. Chatterjee>
*
* @author M A Chatterjee <deftio [at] deftio [dot] com>
*
* This software is provided 'as-is', without any express or implied
* warranty. In no event will the authors be held liable for any damages
* arising from the use of this software.
*
* Permission is granted to anyone to use this software for any purpose,
* including commercial applications, and to alter it and redistribute it
* freely, subject to the following restrictions:
*
* 1. The origin of this software must not be misrepresented; you must not
* claim that you wrote the original software. If you use this software
* in a product, an acknowledgment in the product documentation is required.
*
* 2. Altered source versions must be plainly marked as such, and must not be
* misrepresented as being the original software.
*
* 3. This notice may not be removed or altered from any source
* distribution.
*
*/
//JS Hint linter directives
/*jshint -W069 */ //suppresses warning about using x.var_name vs x["var_name"]
//usage in browser
//<script type="text/javascript" src="./bitwrench.js"></script>
//usage in nodejs
//var bw = require('./bitwrench.js'); //adds to current scope in nodejs
// optional polyfill for IE8 and earlier
"use strict";
/* istanbul ignore next */
(function(fn){ // this is a polyfill for IE7/IE8
/*
//node.textContent
// Source: Eli Grey @ https://eligrey.com/blog/post/textcontent-in-ie8
if (Object.defineProperty
&& Object.getOwnPropertyDescriptor
&& Object.getOwnPropertyDescriptor(Element.prototype, "textContent")
&& !Object.getOwnPropertyDescriptor(Element.prototype, "textContent").get) {
(function() {
var innerText = Object.getOwnPropertyDescriptor(Element.prototype, "innerText");
Object.defineProperty(Element.prototype, "textContent",
// Passing innerText or innerText.get directly does not work,
// wrapper function is required.
{
get: function() {
return innerText.get.call(this);
},
set: function(s) {
return innerText.set.call(this, s);
}
}
);
})();
}
*/
//Array stuff
if (!Array.prototype.indexOf) {
Array.prototype.indexOf = function (searchElement ) {
"use strict";
if (this == null) {
throw new TypeError();
}
var t = Object(this);
var len = t.length >>> 0;
if (len === 0) {
return -1;
}
var n = 0;
if (arguments.length > 0) {
n = Number(arguments[1]);
if (n != n) { // shortcut for verifying if it's NaN
n = 0;
} else if (n != 0 && n != Infinity && n != -Infinity) {
n = (n > 0 || -1) * Math.floor(Math.abs(n));
}
}
if (n >= len) {
return -1;
}
var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
for (; k < len; k++) {
if (k in t && t[k] === searchElement) {
return k;
}
}
return -1;
};
}
if (!fn.join) fn.join = function(s) {var i,r="";s=s?s:""; if (this.length) {for(i=0;i<this.length-1;i++){r+= this[i].toString()+s;} r= (i>=0) ? r+this[i].toString() : r;} return r;};
if (!fn.map) fn.map=function(f){var r=[];for(var i=0;i<this.length;i++)r.push(f(this[i]));return r;};
if (!fn.filter) fn.filter=function(f){var r=[];for(var i=0;i<this.length;i++)if(f(this[i]))r.push(this[i]);return r;};
if (!String.prototype.trim) {String.prototype.trim = function () { return this.replace(/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g, ""); };}
})(Array.prototype); // end polyfills
// * /
(function (root, factory) {
if (typeof define === "function" && define.amd) { // eslint-disable-line no-undef
// AMD. Register as an anonymous module.
//define(['myRequiredDependancyModule'], factory); // use this if other modules required
define([], factory); // eslint-disable-line no-undef
} else if (typeof module === "object") {
if ((typeof module !== "object" ) || (typeof module !== "function") ) // this hack required for older versions of node
// var m =require("module");
// Node. Does not work with strict CommonJS, but
// only CommonJS-like environments that support module.exports,
// like Node.
//console.log("node...");
var libm= factory();
libm.exportModuleType = "module.exports";
module.exports=libm;
} else {
//console.log("browser..",root, typeof root);
// Browser globals (root is window)
var libg = factory();
libg.exportModuleType="global";
root[libg["exportName"]] = libg;
}
}(typeof self !== "undefined" ? self : this, function () { // note if needing requirements use ... (typeof self !== "undefined" ? self : this, function (myRequiredDependancyModule)
"use strict";
// Use b in some fashion.
// Just return a value to define the module export.
// This example returns an object, but the module
// can return a function as the exported value.
//BEGIN_LIBRARY_CODE
var bw = {};
bw.exportName = "bw"; //
bw.exportModuleType = "AMD"; //default export see UMD wrapper above for more info this. it allows the consumer to know how this was loaded.
// ===================================================================================
bw.choice = function (x,choices,def) {
/**
bw.choice(x,choices-dictionary, default)
Allows a dictionary to be used as a switch statement, including functions.
example:
colors = {"red": 1, "blue": 2, "aqua" : function(z){return z+"marine"}};
bw.choice("red",colors,"0") ==> "1"
bw.choice("shiny",colors,"0") ==> "0"
bw.choice("aqua",colors) ==> "aquamarine"
*/
var z = (x in choices) ? choices[x] : def;
return _to(z) == "function" ? z(x) : z;
};
// ===================================================================================
bw.jsonClone = function (x) {
/**
bw.jsonClone(object)
crude deep copy by value of an object as long as no js dates or functions
*/
return JSON.parse(JSON.stringify(x));
};
// ===================================================================================
bw.typeOf = function (x, baseTypeOnly) {
/**
_to(x, baseTypeOnly) returns a useful typeOf the object.
_to(2) // "number"
bw.typeof( function(){}) // "function"
function Car(make, model, year) {
this.make = make;
this.model = model;
this.year = year;
}
x = new Car("Ford", "Escape", 2009);
_to(Car) // "function"
_to(x) // "Car" ---> returns correct object type
_to(x,true) // "object" ---> returns base object type
*/
//A useable typeof operator. See this fantastic reference for a starter
//https://javascriptweblog.wordpress.com/2011/08/08/fixing-the-javascript-typeof-operator/
if (x === null)
return "null";
var y = (typeof x == "undefined") ? "undefined" : (({ /*empty*/}).toString.call(x).match(/\s([a-zA-Z]+)/)[1].toLocaleLowerCase());
if ((y != "object") && (y != "function"))
return y;
if (baseTypeOnly == true) // so if undefind or anything but true
return y;
var r = y;
try {
r = (x.constructor.name.toLocaleLowerCase() == y.toLocaleLowerCase()) ? y : x.constructor.name; // return object's name e.g.
}
catch (e) {/*empty*/}
if (r == "object") {
if (x["_is_BW_HTMLNode"] == true )
r="BW_HTMLNode";
}
return r;
};
var _to = bw.typeOf;
bw.to = _to;
//===============================================
// internally used type check and assign function
bw.typeAssign = function (a, typeString, trueValue, falseValue) {
/**
bw.typeAssign(variable, typeString, trueValue, falseValue)
typeAssign is used to see if the argument a is of type typeString as defined by _to().
if it is then trueValue is returned else falseValue.
bw.typeAssign("23","number","is a number!", "not a number!") ==> "is a number!"
bw.typeAssign([23],"number","is a number!", "not a number!") ==> "not a number!" // is an array of length 1
can also supply list of types
bw.typeAssign(23,["string","number"], "string or num", "something else") ==> "string or num"
bw.typeAssign(true,["string","number"], "string or num", "something else") ==> "something else"
*/
if (["string","array"].indexOf(_to(typeString)) == -1) // typeString must be a string or an arrag or strings
typeString = "notValidType";
if (_to(typeString) == "string")
typeString = [typeString];
return (typeString.indexOf(_to(a)) >= 0) ? trueValue : falseValue;
};
var _toa = bw.toa = bw.typeAssign; // eslint-disable-line no-unused-vars
//===============================================
// internally used type check and assign function with functional support (trueValue or falseValue can be functions which are passed the param a)
bw.typeConvert = function (a, typeString, trueValue, falseValue) {
/**
bw.typeConvert(variable, typeString, trueValue, falseValue)
typeConvert is used to see if the argument a is of type typeString as defined by _to().
if it is then trueValue is returned else falseValue.
bw.typeConvert("23","number","is a number!", "not a number!") ==> "is a number!"
bw.typeConvert([23],"number","is a number!", "not a number!") ==> "not a number!" // is an array of length 1
can also supply list of types
bw.typeConvert(23,["string","number"], "string or num", "something else") ==> "string or num"
bw.typeConvert(true,["string","number"], "string or num", "something else") ==> "something else"
bw.typeConvert(23,["string","number"],function(x){return x+1},function(){return function(x){return x+2}})}) ==> 24
bw.typeConvert(23,["string"],function(x){return x+1},function(){return function(x){return x+2;}})}) ==> function(x){return x+2;}
however typeConvert also allows functions (as apposed to typeAssign)
*/
if (["string","array"].indexOf(_to(typeString)) == -1) // typeString must be a string or an arrag or strings
typeString = "notValidType";
if (_to(typeString) == "string")
typeString = [typeString];
return (typeString.indexOf(_to(a)) >= 0) ? (_to(trueValue) == "function") ? trueValue(a) : trueValue : ( _to(falseValue) == "function") ? falseValue(a): falseValue;
};
//var _tc = bw.typeConvert;
var _toc = bw.tc = bw.typeConvert; // eslint-disable-line no-unused-vars
//===============================================
// internally used function for options copy
// keys in opts are copied to dopts (or overwrite options in dopts)
/* istanbul ignore next */
var optsCopy = function(dopts,opts) {
/* istanbul ignore next */
if ((_to(opts) == "object") && (_to(dopts)=="object")) {
var i;
for (i in opts) {
if ((_to(opts[i]) == "object" )||(_to(dopts[i])=="object")) {
var j;
for (j in opts[i])
dopts[i][j] = opts[i][j];
}
else
dopts[i] = opts[i];
}
}
return dopts;
};
bw._oc = optsCopy;
// ===================================================================================
bw.arrayUniq = function (x){
/**
arrayUniq(x)
returns uniq elements of simple array x.
*/
if (_to(x) != "array")
return [];
return x.filter (function (v, i, arr) {return (arr.indexOf(v)==i);});
};
// ===================================================================================
bw.arrayBinA = function (a,b) {
/**
arrayBinA(x)
returns intersection elements of to simple arrays a and b
*/
if ((_to(a)!="array") || (_to(b)!== "array"))
return [];
return bw.arrayUniq(a.filter(function(n) { return b.indexOf(n) !== -1;}));
};
bw.arrayBNotInA = function (a,b) {
/**
arrayBNotinA(x)
returns elements of b not present in a
*/
if ((_to(a)!="array") || (_to(b)!== "array"))
return [];
return bw.arrayUniq(b.filter(function(n) { return a.indexOf(n) < 0;}));
};
//===============================================
/* istanbul ignore next */
bw.DOMIsElement = function(el) {
/**
@method bw.DOMIsElement() - returns whether a supplied element is a HTML DOM element. only useful in browser,
*/
var r = false;
try {
if(_to(el)== "undefined")
return r;
if ((bw.isNodeJS() == false) || (typeof Element == "function"))
r = el instanceof Element;
}
catch(e) {
r = (typeof HTMLElement === "object" ? el instanceof HTMLElement : //DOM2
el && (typeof el === "object") && (el !== null) && (el.nodeType === 1) && (typeof el.nodeName==="string")
);
bw.logd(e.toString());
}
return r;
};
var _isEl = bw.DOMIsElement;
//===============================================
/* istanbul ignore next */
bw.DOMGetElements = function (el, type) {
/**
@method DOMGetElements(el, type) returns an array of DOM elements (if running in browser)
@param {string | DOM_node} el - if string uses CSS selector other wise if already a DOM element returns itself
@return an js array of zero or more matching DOM nodes
DOMGetElements always looks in the root.
*/
/*
TODO:
var container = document.querySelector("#test");
var matches = container.querySelectorAll("div.highlighted > p");
*/
var r=[],a=[],i;
if (bw.isNodeJS() == false)
{ // we're running in a browser
if (_isEl(el))
return [el];
if (_to(el) == "string") { // now its a string so we have choices..
type = _toa(type,"string",type,"auto"); // auto means detect whether has a # or . in front of it
el.trim();
if (type == "auto")
type = bw.choice(el[0],{".":"className", "#":"id"},"tagName");
type=type.toLowerCase();
switch (type) {
case "id" : //get Element by ID
el = (el[0]=="#") ? el.substring(1,el.length) : el;
a = document.getElementById(el);
a = _toa(a,"null",[],[a]);
break;
case "classname": // get Elements by class name
el = (el[0]==".") ? el.substring(1,el.length) : el;
a = document.getElementsByClassName(el);
break;
case "tagname" : // get Elements by tag name
a = document.getElementsByTagName(el);
break;
case "name":
a = document.getElementsByName(el);
break;
case "css" :
a = document.querySelectorAll(el);
break;
default:
a = document.querySelectorAll(el);
}
for (i in a)
r.push(a[i]);
}
}
return r.filter(function(x){return _isEl(x);});
};
//var _els = bw.DOMGetElements;
// =============================================================================================
/* istanbul ignore next */
bw.DOMSetElements = function(domElement,param) {
/**
@method DOMSetElements(domElement, param) sets DOM elements with the supplied (optional) params
@param {string | array | dict |function} - params to set on DOMElements
@return an js array of zero or more matching DOM nodes
*/
var els = bw.DOMGetElements(domElement);
if (els==[])
bw.log("dom element not found");
var i,l,e, ef = function(x,p){bw.log(x,p);};
for (l=0; l<els.length; l++) {
e = els[l];
switch(_to(param)) {
case "array":
try{
for (i=0; i<param.length; i++) e[param[i][0]] = param[i][1];
}
catch(d) {ef(d,param);}
break;
case "object":
try {
for (i in param) e[i] = param[i];
}
catch(d) {ef(d,param);}
break;
case "string":
try {
e.innerHTML = param;
}
catch(d) {ef(d,param);}
break;
case "function":
try {
param(e); // apply a function to e
}
catch(d) {ef(d,param);}
break;
default: break;
}
}
return els;
};
bw.DOM = bw.DOMSetElements; //short hand
//================================================================================
bw.DOMInsertElement = function (parentEl, htmldata, putFirst) {
/**
DOMInsertElement (attachEl, html , putFirst)
creates an HTML element (browser only). If an attachment element is provided it will attach the new element to the attachElement.
if putFirst == true it is made the first child of the attachEl else it is the lastChild of the attachEl
*/
var el = null;
if (bw.isNodeJS() == false) {
if (bw.DOMIsElement(htmldata))
el = htmldata;
else {
el = document.createElement("div"); //outer wrapper
el.innerHTML = bw.html(htmldata);
el = el.firstChild; // get our element back
}
if (parentEl) {
parentEl = bw.DOM(parentEl)[0];
if (putFirst ) {
parentEl.insertBefore(el, parentEl.firstChild); // put it first
}
else
parentEl.appendChild(el); // put it last
}
}
return el;
};
bw.DOMIns = bw.DOMInsertElement;
// =============================================================================================
bw.htmlToElement = function (htmldata) {
var el=null;
if (bw.isNodeJS() == false) {
if (bw.DOMIsElement(htmldata))
el = htmldata;
else {
el = document.createElement("div"); //outer wrapper
el.innerHTML = bw.html(htmldata);
el = el.firstChild; // get our element back
}
}
return el;
};
// =============================================================================================
bw.DOMReplaceElement = function(oldEl, newEl) {
if (bw.isNodeJS() == false) {
var e = bw.DOM(oldEl)[0];
return e.parentNode.replaceChild(bw.htmlToElement(newEl), e);
}
return null;
};
// =============================================================================================
/**
bitwrench: color functions (used for theming and interpolations)
bitwrench color functons operate using this internal color representation model:
[c0, c1, c2, alpha, model]
where c0, c1, c2 are model dependant
alpha represents the transperancy
model is a color model string (lowercase) "rgb", or "hsl" (compatible with HTML/CSS colors)
colorParse() ==> take an input color of anymodel and output a bw [c0,c1,c2,a,m] array
*/
bw.colorInterp = function(x, in0, in1, colors, stretch) {
/**
@method colorInterp (x, lo, hi, colors[], stretch) - interpolate between and array of colors.
x is a number between the numbers in0 <= x <= in1
colors is an array of colors supplied in rgb format e.g. ["#123", "#234"]
colors can be anylength
*/
var c = _toa(colors,"array",colors,["#000","#fff"]); // make sure we have an array of colors
c = c.length == 0 ? ["#000","#fff"] : c; // no colors provide .. interp grayscale is default
if (c.length == 1)
return c[0];
//ok now we we have an array of atleast length 2 which hopefully contains colors.
c = c.map(function(x){return bw.colorParse(x);}); // all colors will now be converted to bw RGB format
var a = bw.mapScale(x,in0,in1,0,c.length-1,{clip: true, expScale: stretch});
var i = bw.clip(Math.floor(a),0,c.length-2);
var r = a-i;
var _f = function(x) {return bw.mapScale(r,0,1, c[i][x],c[i+1][x],{clip:true});};
return [_f(0), _f(1), _f(2),_f(3),"rgb"];
};
// =============================================================================================
bw.colorHslToRgb = function (h, s, l, a, rnd){
/**
@method colorHslToRgb
Converts an HSL color value to RGB. Conversion formula
Assumes h is [0..360] , s, and l are contained in the set [0 .. 100].
returns r, g, and b in the set [0, 255].
@param {number} h The hue [0..360]
@param {number} s The saturation [0..100]
@param {number} l The lightness [0..100]
OR...
pass the colors as a bitwrench color array as a single parameter:
colorHslToRgb([h,s,l,a,"hsl"])
@return {Array} The RGB representation as [r, g, b, alpha, "rgb"]
last parameter rnd rounds the results to 0..255. set to false to eliminate rounding. This can be useful for chained calcs
see : adapted from http:https://hsl2rgb.nichabi.com/javascript-function.php
*/
if (_to(h)=="array") { // handles colors of [h,s,l,a,"hsl"]
s=h[1];
l=h[2];
a=h[3];
h=h[0]; //do this last so it doesn't overwrite iself
}
var _fn = rnd == false ? function(x){return x;} : function(x){return bw.clip(Math.round(x),0,255);} ;
var r,g,b,c,x,m;
h = (h+360)%360;
h /= 60;
if (h < 0) h = 6 - (-h % 6);
h %= 6;
s = Math.max(0, Math.min(1, s / 100));
l = Math.max(0, Math.min(1, l / 100));
c = (1 - Math.abs((2 * l) - 1)) * s;
x = c * (1 - Math.abs((h % 2) - 1));
if (h < 1) {
r = c; g = x; b = 0;
} else if (h < 2) {
r = x; g = c; b = 0;
} else if (h < 3) {
r = 0; g = c; b = x;
} else if (h < 4) {
r = 0; g = x; b = c;
} else if (h < 5) {
r = x; g = 0; b = c;
} else {
r = c; g = 0; b = x;
}
m = l - c / 2;
r = (r + m) * 255;
g = (g + m) * 255;
b = (b + m) * 255;
return [_fn(r),_fn(g),_fn(b),a,"rgb"];
};
// =============================================================================================
bw.colorRgbToHsl = function (r, g, b, a, rnd) {
/**
Converts an RGB color value to HSL. Conversion formula
adapted from http:https://en.wikipedia.org/wiki/HSL_color_space.
Assumes r, g, and b are contained in the set [0, 255] and
returns h as [0..360] s, and l in the set [0 .. 100].
@param {number} r The red color value
@param {number} g The green color value
@param {number} b The blue color value
pass the colors as a bitwrench color array as a single parameter:
colorRgbToHsl([h,s,l,a,"rgb"])
last parameter rnd rounds the results to 0..255. set to false to eliminate rounding. This can be useful for chained calcs
@return {Array} The HSL representation
*/
if (_to(r)=="array") { // handles colors of [h,s,l,a,"hsl"]
g=r[1];
b=r[2];
a=r[3];
r=r[0]; //do this last so it doesn't overwrite iself
}
r /= 255, g /= 255, b /= 255;
var max = Math.max(r, g, b), min = Math.min(r, g, b);
var h, s, l = (max + min) / 2;
if(max == min){
h = s = 0; // achromatic
}else{
var d = max - min;
s = l > 0.5 ? d / (2 - max - min) : d / (max + min);
switch(max){
case r: h = (g - b) / d + (g < b ? 6 : 0); break;
case g: h = (b - r) / d + 2; break;
case b: h = (r - g) / d + 4; break;
}
h /= 6;
}
var _fn = rnd == false ? function (x){return x;} : function(x){return Math.round(x);} ;
return [_fn(h*360), _fn(s*100), _fn(l*100), a, "hsl"];
};
// =============================================================================================
bw.colorParse = function(s,defAlpha) {
/**
@method bw.colorParse(s)
@description take a valid CSS style color string: #rgb | #rgba | #rrggbb | #rrggbbaa | rgb(r,g,b) | rgb(r,g,b,a) | hsl(h,s,l) | hsla(h,s,l,a )
... and return array [c0,c1,c2,a,model] where model is one of "rgb", "hsl"
*/
defAlpha = _toa(defAlpha,"number",defAlpha,255);
var r = [0,0,0,defAlpha,"rgb"]; // always return a valid type
if (_to(s)=="array"){ // it could be a bwcolor type [c0,c1,c2,a,model]
var p,df = [0,0,0,255,"rgb"];
for (p=0; p< s.length; p++)
df[p]=s[p];
s= String(df[4])+"("+String(df[0])+","+String(df[1])+","+String(df[2])+","+String(df[3])+")"; //could use slice..join(",")
}
s = String(s).replace(/\s/g,"");
var reT = /\s*(#|hsl|rgb|yuv|hsv){1}([a-f|A-F|0-9|,().\t ]*)/img;
var i,j=0,x = reT.exec(s);
if (_to(x)=="array" && (x.length >= 3)) {
r[4]= x[1] == "#" ? "rgb" : x;
if (x[1] == "#") { //parse one of these #rgb #rgba #rrggbb #rrggbbaa
switch (x[2].length) {
case 3: //#rgb
case 4: //#rgba
for (i=0; i< x[2].length; i++)
r[i] = parseInt(x[2][i]+x[2][i],16);
break;
case 6: //#rrggbb
case 8: //#rrggbbaa
for (i=0; i< x[2].length; i+=2)
r[j++] = parseInt(x[2][i]+x[2][i+1],16);
break;
default:
bw.logd("bw.parseColor bad input "+ s);
}
}
else { // its should be of form (c0,c1,c2) or (c0,c1,c2,alpha)
r[4] = x[1].toLocaleLowerCase();
if ((x[2][0] == "(") && (x[2][x[2].length-1] == ")")) { // parans are present
var v = x[2].substring(1,x[2].length-1);
v = v.split(",");
switch(v.length){ // valid entries are 3 or 4 components
case 3:
case 4:
for (i=0; i< v.length; i++)
r[i] = Number(v[i]);
break;
default:
bw.logd("bw.parseColor bad input : " + s);
}
} else {
bw.logd("bw.parseColor bad input : " + s);
}
}
}
return r;
};
// =============================================================================================
bw.colorToRGBHex = function(c, format) {
/**
@method bw.colorToRGBHex(color)
@description take a color of the form a string or [c0,c1,c2,alpha,model] ==> convert to #rrggbbaa format
format (optional) can be set to auto in which case alpha is ommitted if set to 255
*/
var r = "#00000000";
var ph = function(x){var y=(bw.clip(Math.round(x),0,255)).toString(16); return (y.length==1)?"0"+y:y;}; // pad hex
c = bw.colorParse(c); // converts color to bw color vector format
switch(c[4]) {
case "rgb":
r = "#"+ph(c[0])+ph(c[1])+ph(c[2]);
if (!((format == "auto") && (c[3]==255)))
r += ph(c[3]);
break;
case "hsl":
r= bw.colorToRGBHex(bw.colorHslToRgb(c));
break;
default:
bw.logd("colorToRGBHex : unsupported format" + c[4]);
}
return r; // default
};
// =============================================================================================
bw.colorConvertColorSpace = function(c, space, rnd) {
/**
@method bw.colorConvertColorSpace(color, spaceToConvertTo)
@description take a color and convert it to the destination color space ("rgb" | "hsl")
color can be any valid color type ("#abc" | "hs(...)" or [r,g,b,a,"rgb"] etc)
optional 3rd param rnd if set to false will suppress rounding in calcs to allow chained color conversion w/o loss of precision
*/
c = bw.colorParse(c);
if (space == c[4])
return c;
switch(c[4]) {
case "rgb":
break;
case "hsl":
c = bw.colorHslToRgb(c[0],c[1],c[2],c[3],rnd); // turns off rounding
break;
default:
bw.logd("colorConvertColorSpace: unsupported color format");
}
//now c is in the rgb space
switch(space) {
case "rgb":
break;
case "hsl":
c = bw.colorRgbToHsl(c[0],c[1],c[2],c[3],rnd); // turns off rounding
break;
default:
bw.logd("colorConvertColorSpace: unsupported color format");
}
return c;
};
// =============================================================================================
var _logdata=[];
bw.log = function (value,msg,opts) {
/**
bw.log(value, message, options)
write a value to the in-memory log
options {
clear: false | true | "clear-only"
false : normal write
true : clear log and add 1st entry
clear-only - only clear don't write, value, msg
saveMethod: "raw" | "JSON" // raw is default, save object as passed, JSON saves stringified version (useful for exporting or saving state)
}
*/
var dopts = {
clear : false, // values fales, true, "clear-only"
saveMethod: "raw" // else "JSON"
};
dopts = optsCopy(dopts,opts);
if ((dopts["clear"] == true) || (dopts["clear"] == "clear-only")) {
_logdata = [["Time-stamp (ms)"," Value "," Message "]];
var ct = (new Date());
_logdata.push ([0, ct.getTime()," log started at " + ct.toString()]);
}
msg = _toa(msg,"undefined","",String(msg));
value = (dopts["saveMethod"]=="raw") ? value : JSON.stringify(value);
if ((_to(value) != "undefined") && (dopts["clear"] != "clear-only"))
_logdata.push([(new Date()).getTime()-_logdata[1][1], value, msg]);
return _logdata.length -1;
};
bw.log("","",{clear:"clear-only"}); // initialize
// =============================================================================================
bw.logd = function() {
/**
@method bw.logd()
@description: bw.logd is a log funciton which behaves similar to console.log() however instread of outputting to console,
it writes to bw.log() function with the following differences:
*/
/*
todo: comma seperated items; ? done
console ==> also (attempt) to output to console.log ? would need to set a bw.state variable..
bwdbg ==> log bw catches / errors (else silent)
none ==> no output (of any kind)
stringify ==> takes bw.logd args and strinigyfies before writing to bw.log
example:
logd=console,bwlogd
*/
var logdargs = ("bwlogd" in bw.bwargs) ? bw.bwargs["bwlogd"].split(",") : [];
if (logdargs.indexOf("none") < 0) {
var i=0;
var _a = [];
for (i=0; i< arguments.length; i++)
_a.push(arguments[i]); //arguments, a reserved javascript keyword, is not a true array
bw.log(_a,"bw.logd: "+bw.bwargs["bwlogd"]); // message
}
};
// =============================================================================================
bw.logExport = function(opts) {
/**
bw.logExport(options)
export the built in log.
default is "raw" which is an array of values:
[timestamp, <value logged>, <optional message from the event>]
[ .. , .. , .. ]
also can be exported as an HTML table.
bw.logExport({"format":"HTML"})
or as a simple text file:
bw.logExport("format" : "text"})
see bw.saveClientFile(fname) for saving the log as a file
*/
var dopts = {
"format" : "raw" // can also be HTML table if set to "HTML"
};
dopts = optsCopy(dopts,opts);
var _ld = _logdata;
if (dopts["format"] == "HTML") {
return bw.makeHTMLTableStr(_ld,{sortable:true});
}
if (dopts["format"] == "text") {
return _ld.map(function(x){return x.map(function(y){return bw.padString(y.toString(),16,"left");}).join("\t");}).join("\n");
}
return _ld;
};
// ===================================================================================
bw.setCookie = function (cname, cvalue, exdays) {
/**
@method bw.setCookie(cookieName, value, expireDays) set a client side cookie. (browser only)
@param cname : a string for the name of the cookie
@param cvalue : a string for the value of the cookie
@param expdays : cookie expiration date in days
*/
var d = new Date();
d.setTime(d.getTime() + (exdays*24*60*60*1000));
var expires = "expires="+d.toUTCString();
document.cookie = cname + "=" + cvalue + "; " + expires;
};
// ===================================================================================
bw.getCookie = function (cname, defaultValue) {
/**
@method bw.getCookie: bw.getCookie(cookieName, defaultValueIfNotFound) (browser only)
get a client side cookie, if it is set. returns defaultValue if cookie could not be found
*/
var name = cname + "=";
var ca = document.cookie.split(";");
for(var i=0; i<ca.length; i++) {
var c = ca[i];
while (c.charAt(0)==" ") c = c.substring(1);
if (c.indexOf(name) == 0) return c.substring(name.length, c.length);
}
return defaultValue;
};
// ===================================================================================
bw.getURLParam = function (key, defaultValue) {
/**
@method bw.getURLParam(key,defaultValueIfNotFound)
read the URL (e.g. http:https://example.com/my/page?this=that&foo=123&bub&x=123) and parse the URL paraemeters
x = bw.getURLParam() ==> returns entire dict of url params ==? {this:"that",foo:"123",bub:true,x:"123"}
x = bw.getURLParam("foo","whatever") ==> returns "123"
x = bw.getURLParam("bar","whatever") ==> returns "whatever" since bar isn't set
x = bw.getURLParam("bub","whatever") ==> returns true since bub doesn't have a value (note boolean true not "true")
*/
if ((bw.isNodeJS()== true) || (typeof window != "object"))
return defaultValue;
try {
if (window.location.href) {
return bw.URLParamParse(window.location.href,key,defaultValue);
}
}
catch (e) {
bw.log(e);
}
return defaultValue;
};
bw.URLHash = function (url,defValue) {
/**
@method bw.URLHash(url,defValue) - returns the hash portion of a URL (if present) else return defValue
*/
if (_to(url)=="undefined")
url = typeof window == "object" ? window.location.href : "";
var r = url.split(/#+/);
return url.includes("#") ? r[r.length-1] : defValue;
};
//=================================================
bw.URLParamParse = function (url,key,defValue,allowHash) {
/**
@method bw.URLParamParse(urlString, key, defaultValue)
decode a URL encoded string in to a javascript dictionary. Other params (http, port, path) are not handled
if key is present than only that value is returned (as a string ) else defValue is returned.
examples:
x = URLParamParse("http:https://example.com?a=123&b=345") ==> {a:"123", b:"456"}
x = URLParamParse("http:https://example.com?a=123&b=345","a") ==> "123"
x = URLParamParse("http:https://example.com?a=123&b=345","c","otherValue") ==> {a:"123", b:"456"} ==> "otherValue"
*/
try {
var hs=function(u){var x = u.split(/^.*\?+/); return x.length==2 ? x[1] : "";};
var sh=function(u,b){return (b==true) ? u : u.split(/#+/)[0];};
var params={}, parts = sh(hs(url),allowHash).split("&");
for (var i = 0; i < parts.length; i++) {
var e = parts[i].split("=");
if (!e[0])
continue;
params[decodeURIComponent(e[0])] = _to(e[1])=="string" ? decodeURIComponent(e[1].replace("#","%23")) : true;
}
if (_to(key)=="undefined")
return params;
return params.hasOwnProperty(key) ? params[key] : defValue;
}
catch (e) {
bw.log(e);
return defValue;
}
};
//=================================================