-
Notifications
You must be signed in to change notification settings - Fork 0
/
awesome-code-element.js
3839 lines (3293 loc) · 163 KB
/
awesome-code-element.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
// MIT License
//
// Copyright (c) 2021-2022 Guillaume Dua "Guss"
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
// awesome-code-element
//
// Brief: Standalone HTML element to represents a code section. Executable, highlighted & dynamically modifiable
// Lightweight, out-of-the-box, Compiler-Explorer integration in websites & documentations
// Doxygen + doxygen-awesome-css + highlightjs == <3 (awesome-code-element)
// Note that neither `Doxygen` nor `doxygen-awesome-css` are mandatory dependencies
//
// Code sections, with extra features :
// - load content from
// - JS constructor parameter
// - HTML
// - attribute `code` or `url` (for remote-located resource, such as <div class='code-section' url='https://some/remote/path/to/file.cpp'></div>)
// - inner TextContent
// - synthax-coloration provided by highlightjs,
// - theme selector
// - toggle dark/light theme
// - buttons :
// - open-in-godbolt
// - copy-to-clipboard
// - (doxygen-awesome-css compatibility) toggle light/dark mode
// ----------------------------------------------------------------------------------------------------------------------------
// TODO: name: not `ace` (already exists: Ajax.org Cloud9 Editor)
// TODO: Documentation
// TODO: decoupled highlighter
// - highlightjs
// - https://github.com/EnlighterJS/EnlighterJS
// TODO: compatibility with Marp
// TODO: interface with [CodeMirror](https://codemirror.net/)
// -----
// TODO: test behavior without theme selector (provide default behavior)
// TODO: not mandatory dependency to doxygen (WIP)
// TODO: highlightjs makes clickable code elements not clickable anymore. Fix that ?
// https://stackoverflow.com/questions/74114767/highlightjs-how-to-create-custom-clickable-sequence-of-characters
// TODO: hide warnings for undefined/fallback hljs language
// TODO: soft errors (replace HTMLElement content with red error message, rather than stopping the process)
// TODO: make Initialize_DivHTMLElements generic
// TODO: Global option: force fallback language to ... [smthg]
// TODO: per-codeSection CE configuration (local override global)
// TODO: toggle technical info/warning logs
// TODO: use ?? vs ||
// TODO: execution -> pre.code rather than a new CS (+copy-to-cpliboard button)
// TODO: buttons: bound to CS left-panel, not the element itself ?
// TODO: check encapsulation/visibility
// TODO: type = ace.details.${name} ?
// TODO: update error messages -> ${classname}.name ?
// TODO: named parameters
// TODO: static vs. const ?
// TODO: element name consistency ?
// TODO: use arrow function: automatically captures the `this` value of the enclosing scope (rather than _this)
// TODO: alias awesome-code-element -> ace ?
// TODO: HTMLElements_name -> ace_${name}
// TODO: check shadowroot-callbacks
// TODO: dark_or_light -> color_scheme
// TODO: console.xxx -> replace '\n\t' by ','-separated arguments ?
// - arguments homogeneity console.xxx(this.toString(), ...)
// TODO: remove useless funcs, class (if any)
// TODO: awesome-code-element.js: sub-modules aggregator
// TODO: style : px vs. em
// TODO: get rid of jquery ? -> document.querySelector
// - check $.getScript for script loading
// TODO: wraps around a rich code editor block
// TODO: cleanup logs
// TODO: cleanup module: ease code navigation
// - class-as-namespace
// TODO: unfold_to -> use Object.assign(a, b) ?
// TODO: naming consistency
// TODO: remove unused or unecessary code
// TODO: extends HTMLElements: prefix this lib methods => `ace_cs_${NAME}` ?
// TODO: opt-in: godbolt /api/shortener instead of ClientState ?
// TODO: feature: add compilation/execution duration information (useful for quick-performance comparisons)
// TODO: get [Symbol.toStringTag]()
// TODO Symbol.toStringTag consistency
// TODO: use synthax qwe?.asd?.zxc rather than ternary expressions
// TODO: avoid useless calls (get/set)
// TODO: test all network errors (url, execution)
// TODO: online/offline
// - offline: local CE, existing dependencies
// - online: at least one dependency is not local
// TODO: log debug sub-channels/contexts
// TODO: custom hljs language for execution output ? (and reduce "poor language relevance" noise)
// TODO: ace.cs: change url dynamically (attr binding)
// TODO: try/catch -> finally
// TODO: hljs: web-worker https://github.com/highlightjs/highlight.js/#using-web-workers
// TODO: static member ref: this.constructor.<name> rather than classname redundancy
// TODO: on page focus -> refresh toggle light/dark button icon
// TODO? ace.details => ace_details => not exported (hidden details ?)
// TODO: pre-fetch+load resources in background to improve reactivity
// - available theme
// - non-default dark/light theme variations, if any
// TODO: Additional UI infos (stylesheet only ?)
// - soft-(error|warning) icon (opt-out)
// - language detection failed
// - active language
// TODO: [OPT-IN] compiler-explorer instance -> godbolt.org by default, can be another
export { ace_API as default, ace_details }
let ace = {}
ace.API = {};
ace.details = {};
const ace_API = ace.API
const ace_details = ace.details
// ----------------------------------------------------------------------------------------------------------------------------
// ====================
// details.dependencies
ace.details.dependency = {};
ace.details.dependency.descriptor = class {
get [Symbol.toStringTag](){ return 'ace.details.dependency.descriptor' }
constructor(args) {
for (const property in args)
this[property] = args[property]
if (!this.name)
throw new Error('ace.details.dependency.descriptor: invalid input: missing mandatory parameter [name]')
if (!this.version_detector)
throw new Error('ace.details.dependency.descriptor: invalid input: missing mandatory parameter [version_detector]')
}
name = undefined
version_detector = () => { return undefined }
url = ""
is_mandatory = false
// TODO: post-dl configure ?
}
ace.details.dependency.manager = new class dependency_manager {
get [Symbol.toStringTag](){ return 'ace.details.dependency.manager' }
dependencies = {}
constructor(args = []) {
if (!(args instanceof Array))
throw new Error('ace.details.dependency.manager: invalid input: expect Array of dependency_descriptor')
args.forEach(element => {
element.version = element.version_detector()
this.dependencies[element.name] = element
})
}
async load_missing_dependencies() {
// include missing mandatory dependencies asynchronously
console.info('ace.details.dependency.manager: loading missing dependencies (this can take some time...)')
let promises = Object.entries(this.dependencies)
.map(([key, value]) => value)
.filter(element => element.is_mandatory)
.map(async element => {
if (element.version_detector())
return
const url = (element.url instanceof Function) ? element.url() : element.url
if (!url)
throw new Error(`ace.details.dependency.manager: missing mandatory dependency [${element.name}], no fallback provided`)
return dependency_manager
.include({name : element.name, url: url })
.then(() => {
// update version after loading
element.version = element.version_detector()
})
})
await Promise.all(promises)
}
static include({ name, url }) {
console.info(`ace.details.dependency.manager.include: including dependency [${name}]`, `using url [${url}]`)
let id = `ace-dependency_${name}`
let element = document.getElementById(id)
if (element && element.src === url)
return
element = document.createElement('script'); // TODO: link ?
element.src = url;
element.type = 'text/javascript';
element.defer = false;
element.async = false;
element.id = id;
element.setAttribute('ace-dependecy-name', name)
element = document.head.appendChild(element)
return new Promise((resolve, reject) => {
element.addEventListener('error', () => {
reject(new Error(`ace.details.dependency.manager.include: failure: [${name}] using url [${url}]`))
})
element.addEventListener('load', () => {
element.is_loaded = true
console.info(`ace.details.dependency.manager.include: loaded: [${name}]`)
resolve(element)
})
})
}
static get_imported_module_path(name) {
const imported_modules = Array.from(document.querySelectorAll('script[type="module"]'));
let result = ""
const find_match = (value) => {
let match = value.match(`(:?[^\"\']*)${name}`)
if (match && match.length == 2)
result = match[1]
}
imported_modules
.map(value => value.src)
.forEach(find_match)
if (result)
return result
imported_modules
.filter(value => !value.src)
.map(value => value.innerText)
.forEach(find_match)
return result
}
}([
new ace.details.dependency.descriptor({
name: 'jquery',
version_detector: function(){ return (typeof jQuery !== "undefined") ? jQuery.fn.jquery : undefined },
url : 'https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js',
is_mandatory: true,
}),
new ace.details.dependency.descriptor({
name: 'hljs',
version_detector: function(){ return (typeof hljs !== "undefined") ? hljs.versionString : undefined },
is_mandatory: true,
url: 'https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/highlight.min.js'
}),
// todo: doxygen-awesome-css
new ace.details.dependency.descriptor({
name: 'doxygen_awesome_css_dark_mode',
is_mandatory: false,
version_detector: function(){
return (typeof DoxygenAwesomeDarkModeToggle !== 'undefined')
? "not_impl_yet"
: undefined
}
}),
new ace.details.dependency.descriptor({
name: 'doxygen',
is_mandatory: false,
version_detector: function(){
let result = document.querySelector('meta[name=generator][content^=Doxygen]')
if (!result)
return undefined
return result.getAttribute('content').replace('Doxygen ', '')
}
})
])
await ace.details.dependency.manager.load_missing_dependencies()
// ==================
// details.containers
ace.details.containers = {}
ace.details.containers.translation_map = class extends Map {
// Similar to `Map`, with non-mandatory translation for key, mapped
// example: upper-case keys
// value = new translation_map(
// [ ['a', 42 ]],
// {
// key_translator: (key) => { return key.toUpperCase() }
// }
// );
get [Symbol.toStringTag](){ return 'ace.details.containers.translation_map' }
key_translator = undefined
mapped_translator = undefined
constructor(values, { key_translator, mapped_translator } = {}) {
if (values)
values = values.map((item) => {
let [ key, mapped ] = item
if (key_translator)
key = key_translator(key)
if (mapped_translator)
mapped = mapped_translator(mapped)
return [ key, mapped ]
})
super(values)
this.key_translator = key_translator
this.mapped_translator = mapped_translator
}
get(key) {
if (this.key_translator)
key = this.key_translator(key)
return super.get(key)
}
set(key, mapped) {
if (this.key_translator)
key = this.key_translator(key)
if (this.mapped_translator)
mapped = this.mapped_translator(mapped)
super.set(key, mapped)
return this
}
has(key) {
if (this.key_translator)
key = this.key_translator(key)
return super.has(key)
}
}
// =================
// API.configuration
ace.API.configuration = new class configuration {
get [Symbol.toStringTag](){ return 'ace.API.configuration' }
static compiler_explorer_type = class extends ace.details.containers.translation_map {
// similar to a Map, but use `hljs.getLanguage(key)` as a key translator
//
// key : language (name or alias. e.g: C++, cpp, cc, c++ are equivalent)
// value : {
// language, // not mandatory, if same as key. Refers to https://godbolt.org/api/languages
// compiler_id, // mandatory
// default_options // not mandatory
// }
get [Symbol.toStringTag](){ return 'ace.API.configuration.compiler_explorer_type' }
static get base(){ return ace.details.containers.translation_map; }
constructor(values) {
super(values, {
key_translator: (key) => {
// transform any language alias into a consistent name
let language = hljs.getLanguage(key)
if (!language)
console.warn(`${this} as ${base.prototype}: invalid language [${key}]`)
return language ? language.name : undefined
},
mapped_translator : (mapped) => {
if (!mapped || !mapped.compiler_id)
throw new Error(`${this} as ${base.prototype}: missing mandatory field '.compiler_id' in configuration ${mapped}`)
return mapped
}
})
}
set(key, mapped) {
if (this.has(key)) {
const language = hljs.getLanguage(key) // TODO: remove strong coupling with hljs here ?
console.warn(
`${this}.set: override existing configuration for language [${key}].`,
`\n\tTranslated name is [${language.name}], aliases are [${language.aliases}]`
)
}
super.set(key, mapped)
}
}
get #default_value(){
return {
is_default : true,
description: {
// ace-library self-awareness
version: '1.0.0',
name: 'awesome-code-element.js',
path_prefix: ((name) => {
// quick-fix.
// TODO:
// local: this function
// otherwise: path to deployed release
const imported_modules = Array.from(document.querySelectorAll('script[type="module"]'));
let result = ""
const find_match = (value) => {
let match = value.match(`(:?[^\"\']*)${name}`)
if (match && match.length == 2)
result = match[1]
}
imported_modules
.map(value => value.src)
.forEach(find_match)
if (result)
return result
imported_modules
.filter(value => !value.src)
.map(value => value.innerText)
.forEach(find_match)
return result
})('awesome-code-element.js'),
stylesheet_url: undefined // default: local
},
CE : new configuration.compiler_explorer_type,
CodeSection : {
// can be overrided locally
language : undefined, // autodetect
toggle_parsing : true,
toggle_execution: false,
direction : '' // default: row
},
hljs : {
// default_theme: If no ace-cs-theme-selector, then this is the default one.
// Otherwise, the first valid option of the first ace-cs-theme-selector is the default
default_theme : 'tokyo-night' // supports dark/light variations
},
compatibility : {
doxygen: Boolean(ace.details.dependency.manager.dependencies.doxygen.version), // default: enabled if detected
doxygen_awesome_css: false, // TODO: autodetect
pre_code: false
},
auto_hide_buttons : false, // TODO: rename force_ or always_
force_dark_light_scheme : (() => {
if (Boolean(ace.details.dependency.manager.dependencies.doxygen_awesome_css_dark_mode.version))
return 'dark'
if (Boolean(ace.details.dependency.manager.dependencies.doxygen.version))
return 'light' // assuming doxygen does not handle light/dark-mode by default
return undefined // auto-detect
})()
}
}
#value = this.#default_value;
get value(){ return this.#value }
configure(arg){
if (!arg)
throw new Error(`${this}.configure: invalid argument`)
arg.CE = (() => {
if (!arg.CE || (arg.CE instanceof configuration.compiler_explorer_type))
return arg.CE;
if (arg.CE instanceof Map)
return new configuration.compiler_explorer_type([...arg.CE])
throw new Error(`${this}: invalid type for argument: [CE]`)
})();
ace.details.utility.unfold_into({
target : this.#value,
properties : arg
})
if (this.#value.is_default)
delete this.#value.is_default;
this.#make_ready()
}
get is_default(){ return this.#value?.is_default ?? false }
#is_ready = false
get is_ready(){ return this.#is_ready }
#make_ready() {
if (this.#is_ready)
throw new Error(`${this}.#make_ready: already called`)
this.#is_ready = true
this.#when_ready_callbacks.forEach((handler) => handler())
this.#when_ready_callbacks = []
}
#when_ready_callbacks = []
when_ready_then({ handler }){
if (!handler || !(handler instanceof Function))
throw new Error(`${this}.when_ready_then: invalid argument type`)
this.#is_ready
? handler()
: this.#when_ready_callbacks.push(handler)
;
}
}
ace.API.configure = ace.API.configuration.configure.bind(ace.API.configuration);
// ================
// internal details
ace.details.remote = {}
ace.details.remote.resources_cache = class {
get [Symbol.toStringTag](){ return `ace.details.remote.resources_cache` }
#remote_files = new Map() // uri -> text
static async #fetch_remote_file(uri) {
try {
let response = await fetch(uri)
return await response.text()
}
catch (error) {
console.error(
`${this.prototype}.#fetch_remote_file(): error`,
`\n\twith error = [${error}]`,
`\n\twith uri = [${uri}]`,
)
}
}
async get(uri) {
if (! this.#remote_files.has(uri)) {
this.#remote_files.set(
uri,
await ace.details.remote.resources_cache.#fetch_remote_file(uri)
)
}
return this.#remote_files.get(uri)
}
}
ace.details.utility = class utility {
// TODO: move to another module ?
get [Symbol.toStringTag](){ return `ace.details.utility` }
constructor(){ throw new Error(`${this}.constructor: not instanciable`) }
static accumulate_objects = (lhs, rhs) => {
lhs ??= {}
rhs ??= {}
let result = { ...lhs }
const keys = new Set([ ...Object.keys(lhs), ...Object.keys(rhs) ])
keys.forEach((key) => {
result[key] = rhs[key] ?? lhs[key]
})
return result
}
static unfold_into({target, properties = {}}) {
if (!target)
throw new Error(`${this.prototype}: invalid argument "target" = [${target}]`)
for (const property in properties) {
// HTMLElement
if (target[property]
&& target[property] instanceof HTMLElement || properties[property] instanceof HTMLElement) {
target[property] = properties[property]; // no unfolding here but assign, to preserve
continue
}
// Map
if (target[property]
&& target[property] instanceof Map && properties[property] instanceof Map) {
properties[property].forEach((value, key) => target[property].set(key, value)); // no unfolding here but assign, to preserve
continue
}
// object
if (target[property]
&& typeof target[property] === 'object' && typeof properties[property] === 'object') {
utility.unfold_into({ target: target[property], properties : properties[property]})
continue
}
// assign
target[property] = properties[property];
}
}
static get_url_extension(url) {
try {
return url.split(/[#?]/)[0].split('.').pop().trim();
}
catch (error) {
return undefined
}
}
static fetch_resource(url, { on_error, on_success }) {
// TODO: AddEventListener("abort", ...)
// TODO: report progress
// if (event.lengthComputable)
// const percentComplete = (event.loaded / event.total) * 100;
let xhr = new XMLHttpRequest();
xhr.open('GET', url);
xhr.onerror = () => {
on_error(`${this.prototype}.fetch_resource: network error on url [${url}]`)
};
xhr.onload = () => {
if (xhr.status != 200) {
on_error(`${this.prototype}.fetch_resource: bad request status ${xhr.status} on url [${url}]`)
return;
}
on_success(xhr.responseText)
};
xhr.send();
return xhr;
}
static make_incremental_counter_generator = function*(){
let i = 0;
while (true) { yield i++; }
}
static cancelable_setTimeout = function(func, delay){
let update_controler = { canceled: false }
setTimeout(() => {
if (!update_controler.canceled)
func()
}, delay);
return update_controler
}
static inject_field_proxy = function(target, property_name, { getter_payload, setter_payload } = {}) {
// generate a proxy to a value's field, injecting optional payload
// getter: post-op
// setter: pre-op
if (1 === (Boolean(target.__lookupSetter__(property_name) === undefined)
+ Boolean(target.__lookupGetter__(property_name) === undefined)
)) console.warn(`${this.prototype}.inject_field_proxy: target property [${target.constructor.name}.${property_name}] has a getter but no setter, or vice-versa`)
var _target = target
var storage = _target[property_name]
const target_getter = (() => {
const value = _target.__lookupGetter__(property_name)
return value
? value.bind(target)
: () => { return storage }
})()
const target_setter = (() => {
const value = _target.__lookupSetter__(property_name)
return value
? value.bind(_target)
: (argument) => { storage = argument }
})()
Object.defineProperty(_target, property_name, {
get: getter_payload
? () => {
const value = target_getter()
return getter_payload(value)// ?? value
}
: () => { return target_getter() },
set: setter_payload
? (value) => {
value = setter_payload(value)
target_setter(value)
}
: (value) => { target_setter(value) }
});
return {
get: _target.__lookupGetter__(property_name),
set: _target.__lookupSetter__(property_name)
}
}
// WIP: proxy on proxy: how to avoid multiples getter/setter calls
static inject_on_property_change_proxy = function({ target, property_name, on_property_change } = {}) {
// calls `on_property_change` when target[property_name] change
// on_property_change: ({ argument, old_value, new_value }) => { ... }
// warning: assumes target[property_name] get/set reciprocity
// warning: the setter will call the getter
const property_descriptor = Object.getOwnPropertyDescriptor(target, property_name)
?? Object.getOwnPropertyDescriptor(Object.getPrototypeOf(target), property_name)
if (property_descriptor === undefined
|| !property_descriptor.configurable)
throw new Error(`${this.prototype}.inject_on_property_change_proxy: invalid property descriptor: ${target.toString()}[${property_name}] is not configurable`)
var storage = target[property_name]
delete target[property_name]
const target_getter = (() => {
if (property_descriptor.get)
return property_descriptor.get.bind(target)
return property_descriptor.value
? () => { return storage }
: undefined
})()
const target_setter = (() => {
if (property_descriptor.set)
return property_descriptor.set.bind(target)
return property_descriptor.value
? (value) => { return storage = value }
: undefined
})()
let descriptor = {
configurable: true,
enumerable: true
}
if (target_getter)
descriptor.get = () => {
const result = target_getter()
if (result === storage) return result
const notify_property_changed = {
origin_op: 'get',
property_name: property_name,
old_value: storage,
new_value: result
}
storage = result
// console.debug('proxy %cgetter:', 'color:green', target.toString(), notify_property_changed)
on_property_change(notify_property_changed)
return storage
}
if (target_setter)
descriptor.set = (value) => {
if (value === storage) return
target_setter(value)
const notify_property_changed = {
origin_op: 'set',
property_name: property_name,
old_value: storage,
new_value: value
}
storage = value
// console.debug('proxy %csetter:', 'color:red', target.toString(), notify_property_changed)
on_property_change(notify_property_changed)
}
Object.defineProperty(target, property_name, descriptor);
return {
origin: {
get: target_getter,
set: target_setter
},
transformed: {
get: target.__lookupGetter__(property_name),
set: target.__lookupSetter__(property_name)
},
revoke: () => Object.defineProperty(target, property_name, property_descriptor)
}
}
}
ace.details.utility.html = class html_utility {
get [Symbol.toStringTag](){ return `ace.details.utility.html` }
constructor(){ throw new Error(`${this}.constructor: not instanciable`) }
static codec = class html_codec {
get [Symbol.toStringTag](){ return `ace.details.utility.html_codec` }
constructor(){ throw new Error(`${this}.constructor: not instanciable`) }
static entities = new Array(
// [ '\\\\' , '\\'],
[ '>', '>' ],
[ '<', '<' ],
[ '&', '&' ],
[ '"', '"' ],
[ ''', '\'' ]
)
static decode = (text) => {
html_codec.entities.forEach(([key, value]) => text = text.replaceAll(key, value))
return text
}
static encode = (text) => {
html_codec.entities.forEach(([value, key]) => text = text.replaceAll(key, value))
return text
}
}
static apply_css(element, properties) {
ace.details.utility.unfold_into({target : element.style, properties })
}
static create_shadowroot_slot(element, when_childrens_attached) {
if (!element.shadowRoot)
element.attachShadow({ mode: 'open' });
element.shadowRoot.innerHTML = `<slot></slot>`;
const slot = element.shadowRoot.querySelector('slot');
let callback = (event) => {
const childrens = event.target.assignedElements();
when_childrens_attached(childrens)
}
slot.addEventListener('slotchange', callback, { once: true });
return { // accessor
remove: () => {
slot.removeEventListener('slotchange', callback);
element.shadowRoot.innerHTML = ""
element.outerHTML = element.outerHTML
return element
}
}
}
static remove_shadowroot(element) {
element.shadowRoot.innerHTML = ""
element.outerHTML = element.outerHTML
}
static remove_all_childrens(element) {
while (element.firstChild)
element.removeChild(element.lastChild)
}
static is_scrolling(element) {
return {
horizontally : element.scrollWidth > element.clientWidth,
vertically : element.scrollHeight > element.clientHeight
}
}
}
ace.details.utility.types = class types {
get [Symbol.toStringTag](){ return `ace.details.utility.types` }
constructor(){ throw new Error(`${this}.constructor: not instanciable`) }
static get_inherited_typenames = function(value){
if (!value || !value.constructor)
return "";
const inheritedTypes = [];
for (
let currentType = Object.getPrototypeOf(value.constructor);
currentType && currentType !== Object && currentType.name;
currentType = Object.getPrototypeOf(currentType)) {
inheritedTypes.push(currentType.name);
}
return inheritedTypes.join(', ')
}
static get_object_typename = function(value){
if (!value || !value.toString)
return "";
return value.toString().replace(/^\[object\ (?:(.*)\/)?(.*)\]$/, '$1')
}
static typename_of({ value }){
if (!(value instanceof Object))
throw new Error(`${this.prototype}.typename_of: invalid argument`)
const matches = value.toString().match(/\[object (.+)\]/)
return matches.length === 2 ? matches[1] : undefined
}
static is_string(value){ return typeof value === 'string' || value instanceof String }
static is_int(value){ return !isNaN(value) && parseInt(Number(value)) == value }
static is_empty(value){
return Boolean(value)
&& Object.keys(value).length === 0
&& Object.getPrototypeOf(value) === Object.prototype
}
static projections = class {
static no_op = {
from: (value) => { return value },
to: (value) => { return value }
}
static boolean = {
from: (value) => { return String(value) },
to: (value) => { return value === 'true' || false }
}
static integer = {
from: (value) => { return String(value) },
to: (value) => { return parseInt(value) }
}
static float = {
from: (value) => { return String(value) },
to: (value) => { return parseFloat(value) }
}
static string = {
from: (value) => { return types.is_string(value) ? value : String(value) },
to: (value) => { return String(value) }
}
}
}
ace.details.utility.data_binder = class data_binder {
get [Symbol.toStringTag](){ return `ace.details.utility.data_binder` }
constructor(){ throw new Error(`${this}.constructor: not instanciable`) }
static get default_projection(){
return {
from: (value) => { return value },
to: (value) => { return value + '' },
}
}
static get_property_descriptor({ owner, property_name }){
return Object.getOwnPropertyDescriptor(owner, property_name)
|| Object.getOwnPropertyDescriptor(Object.getPrototypeOf(owner), property_name)
|| {}
}
static #make_attribute_bound_adapter({ target, attribute_name, on_value_changed }){
attribute_name = attribute_name.replace(/\s+/g, '_') // whitespace are not valid in attributes names
if (!target || !(target instanceof HTMLElement) || !attribute_name)
throw new Error(`${this.prototype}.#make_attribute_bound_adapter: invalid argument`)
let observer = (() => {
let observer = undefined
observer = new MutationObserver((mutationsList) => {
for (let mutation of mutationsList) {
const value = mutation.target.getAttribute(mutation.attributeName)
if (mutation.oldValue === value)
continue
// console.debug('intercept mutation:', mutation.attributeName, ':', mutation.oldValue, '->', value)
if (on_value_changed)
on_value_changed(value)
else{
// reset to old value
observer.suspend_while(() => target.setAttribute(attribute_name, mutation.oldValue))
console.warn(
`${this.prototype}.#make_attribute_bound_adapter: data-source is read-only`,
'\n\tcanceling requested attr change [', mutation.oldValue, '->', value, ']',
'\n\tinspect property [', attribute_name, '] of target', target
)
}
}
});
observer.suspend_while = (action) => {
// warning: can result in race conditions
// TODO: process pending records ? MutationObserver.`takeRecords`
observer.disconnect()
action()
observer.observe(target, { attributeFilter: [ attribute_name ], attributeOldValue: true });
}
observer.observe(target, { attributeFilter: [ attribute_name ], attributeOldValue: true });
return observer
})()
return {
owner: target,
attribute_name: attribute_name,
initiale: {
get: () => target.getAttribute(attribute_name),
set: (value) => observer.suspend_while(() => target.setAttribute(attribute_name, value))
},
revoke: () => { observer.disconnect() }
}
}
static #make_property_bound_adapter({ owner, property_name, on_value_changed }){
// uniform access to properties. for descriptor= { get and/or set, value }
if (!owner || !property_name || !(property_name in owner) || !on_value_changed)
throw new Error(`${this.prototype}.#make_property_bound_adapter: invalid argument`)
const descriptor = data_binder.get_property_descriptor({ owner: owner, property_name: property_name })
let storage = descriptor.value // descriptor.value is mutable but mutating it has no effect on the original property's configuration
const initiale = {
get: (() => {
if (descriptor.get)
return descriptor.get.bind(owner)
if ('value' in descriptor)
return () => storage
return undefined
})(),
set: (() => {
if (descriptor.set)
return descriptor.set.bind(owner)
if ('value' in descriptor)
return (value) => storage = value
return undefined
})()
}
const getter = initiale.get
? () => {
const value = initiale.get()
on_value_changed(value)
return value
}
: undefined
const setter = initiale.set
? (value) => {
initiale.set(value)
on_value_changed(initiale.get ? initiale.get() : value)
}
: undefined
Object.defineProperty(owner, property_name, {
get: getter,
set: setter,
configurable: true
})
return {
owner: owner,
property_name: property_name,
initiale: initiale,
revoke: () => Object.defineProperty(owner, property_name, descriptor),