-
Notifications
You must be signed in to change notification settings - Fork 55
/
Copy pathtypes.go
1279 lines (1124 loc) · 43.3 KB
/
types.go
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
package cdp
// Code generated by cdproto-gen. DO NOT EDIT.
import (
"bytes"
"context"
"fmt"
"io"
"strconv"
"strings"
"sync"
"time"
"github.com/chromedp/sysutil"
)
// Executor is the common interface for executing a command.
type Executor interface {
// Execute executes the command.
Execute(context.Context, string, any, any) error
}
// contextKey is the context key type.
type contextKey int
// context keys.
const (
executorKey contextKey = iota
)
// WithExecutor sets the message executor for the context.
func WithExecutor(parent context.Context, executor Executor) context.Context {
return context.WithValue(parent, executorKey, executor)
}
// ExecutorFromContext returns the message executor for the context.
func ExecutorFromContext(ctx context.Context) Executor {
return ctx.Value(executorKey).(Executor)
}
// Execute uses the context's message executor to send a command or event
// method marshaling the provided parameters, and unmarshaling to res.
func Execute(ctx context.Context, method string, params, res any) error {
if executor := ctx.Value(executorKey); executor != nil {
return executor.(Executor).Execute(ctx, method, params, res)
}
return ErrInvalidContext
}
// Error is a error.
type Error string
// Error values.
const (
// ErrInvalidContext is the invalid context error.
ErrInvalidContext Error = "invalid context"
// ErrMsgMissingParamsOrResult is the msg missing params or result error.
ErrMsgMissingParamsOrResult Error = "msg missing params or result"
)
// Error satisfies the error interface.
func (err Error) Error() string {
return string(err)
}
// ErrUnknownCommandOrEvent is an unknown command or event error.
type ErrUnknownCommandOrEvent string
// Error satisfies the error interface.
func (err ErrUnknownCommandOrEvent) Error() string {
return fmt.Sprintf("unknown command or event %q", string(err))
}
// BrowserContextID [no description].
//
// See: https://chromedevtools.github.io/devtools-protocol/tot/Browser#type-BrowserContextID
type BrowserContextID string
// String returns the BrowserContextID as string value.
func (t BrowserContextID) String() string {
return string(t)
}
// NodeID unique DOM node identifier.
//
// See: https://chromedevtools.github.io/devtools-protocol/tot/DOM#type-NodeId
type NodeID int64
// Int64 returns the NodeID as int64 value.
func (t NodeID) Int64() int64 {
return int64(t)
}
// UnmarshalJSON satisfies [json.Unmarshaler].
func (t *NodeID) UnmarshalJSON(buf []byte) error {
if l := len(buf); l > 2 && buf[0] == '"' && buf[l-1] == '"' {
buf = buf[1 : l-1]
}
v, err := strconv.ParseInt(string(buf), 10, 64)
if err != nil {
return err
}
*t = NodeID(v)
return nil
}
// BackendNodeID unique DOM node identifier used to reference a node that may
// not have been pushed to the front-end.
//
// See: https://chromedevtools.github.io/devtools-protocol/tot/DOM#type-BackendNodeId
type BackendNodeID int64
// Int64 returns the BackendNodeID as int64 value.
func (t BackendNodeID) Int64() int64 {
return int64(t)
}
// UnmarshalJSON satisfies [json.Unmarshaler].
func (t *BackendNodeID) UnmarshalJSON(buf []byte) error {
if l := len(buf); l > 2 && buf[0] == '"' && buf[l-1] == '"' {
buf = buf[1 : l-1]
}
v, err := strconv.ParseInt(string(buf), 10, 64)
if err != nil {
return err
}
*t = BackendNodeID(v)
return nil
}
// BackendNode backend node with a friendly name.
//
// See: https://chromedevtools.github.io/devtools-protocol/tot/DOM#type-BackendNode
type BackendNode struct {
NodeType NodeType `json:"nodeType"` // Node's nodeType.
NodeName string `json:"nodeName"` // Node's nodeName.
BackendNodeID BackendNodeID `json:"backendNodeId"`
}
// PseudoType pseudo element type.
//
// See: https://chromedevtools.github.io/devtools-protocol/tot/DOM#type-PseudoType
type PseudoType string
// String returns the PseudoType as string value.
func (t PseudoType) String() string {
return string(t)
}
// PseudoType values.
const (
PseudoTypeFirstLine PseudoType = "first-line"
PseudoTypeFirstLetter PseudoType = "first-letter"
PseudoTypeCheckmark PseudoType = "checkmark"
PseudoTypeBefore PseudoType = "before"
PseudoTypeAfter PseudoType = "after"
PseudoTypePickerIcon PseudoType = "picker-icon"
PseudoTypeMarker PseudoType = "marker"
PseudoTypeBackdrop PseudoType = "backdrop"
PseudoTypeColumn PseudoType = "column"
PseudoTypeSelection PseudoType = "selection"
PseudoTypeSearchText PseudoType = "search-text"
PseudoTypeTargetText PseudoType = "target-text"
PseudoTypeSpellingError PseudoType = "spelling-error"
PseudoTypeGrammarError PseudoType = "grammar-error"
PseudoTypeHighlight PseudoType = "highlight"
PseudoTypeFirstLineInherited PseudoType = "first-line-inherited"
PseudoTypeScrollMarker PseudoType = "scroll-marker"
PseudoTypeScrollMarkerGroup PseudoType = "scroll-marker-group"
PseudoTypeScrollButton PseudoType = "scroll-button"
PseudoTypeScrollbar PseudoType = "scrollbar"
PseudoTypeScrollbarThumb PseudoType = "scrollbar-thumb"
PseudoTypeScrollbarButton PseudoType = "scrollbar-button"
PseudoTypeScrollbarTrack PseudoType = "scrollbar-track"
PseudoTypeScrollbarTrackPiece PseudoType = "scrollbar-track-piece"
PseudoTypeScrollbarCorner PseudoType = "scrollbar-corner"
PseudoTypeResizer PseudoType = "resizer"
PseudoTypeInputListButton PseudoType = "input-list-button"
PseudoTypeViewTransition PseudoType = "view-transition"
PseudoTypeViewTransitionGroup PseudoType = "view-transition-group"
PseudoTypeViewTransitionImagePair PseudoType = "view-transition-image-pair"
PseudoTypeViewTransitionOld PseudoType = "view-transition-old"
PseudoTypeViewTransitionNew PseudoType = "view-transition-new"
PseudoTypePlaceholder PseudoType = "placeholder"
PseudoTypeFileSelectorButton PseudoType = "file-selector-button"
PseudoTypeDetailsContent PseudoType = "details-content"
PseudoTypePicker PseudoType = "picker"
)
// UnmarshalJSON satisfies [json.Unmarshaler].
func (t *PseudoType) UnmarshalJSON(buf []byte) error {
s := string(buf)
s = strings.TrimSuffix(strings.TrimPrefix(s, `"`), `"`)
switch PseudoType(s) {
case PseudoTypeFirstLine:
*t = PseudoTypeFirstLine
case PseudoTypeFirstLetter:
*t = PseudoTypeFirstLetter
case PseudoTypeCheckmark:
*t = PseudoTypeCheckmark
case PseudoTypeBefore:
*t = PseudoTypeBefore
case PseudoTypeAfter:
*t = PseudoTypeAfter
case PseudoTypePickerIcon:
*t = PseudoTypePickerIcon
case PseudoTypeMarker:
*t = PseudoTypeMarker
case PseudoTypeBackdrop:
*t = PseudoTypeBackdrop
case PseudoTypeColumn:
*t = PseudoTypeColumn
case PseudoTypeSelection:
*t = PseudoTypeSelection
case PseudoTypeSearchText:
*t = PseudoTypeSearchText
case PseudoTypeTargetText:
*t = PseudoTypeTargetText
case PseudoTypeSpellingError:
*t = PseudoTypeSpellingError
case PseudoTypeGrammarError:
*t = PseudoTypeGrammarError
case PseudoTypeHighlight:
*t = PseudoTypeHighlight
case PseudoTypeFirstLineInherited:
*t = PseudoTypeFirstLineInherited
case PseudoTypeScrollMarker:
*t = PseudoTypeScrollMarker
case PseudoTypeScrollMarkerGroup:
*t = PseudoTypeScrollMarkerGroup
case PseudoTypeScrollButton:
*t = PseudoTypeScrollButton
case PseudoTypeScrollbar:
*t = PseudoTypeScrollbar
case PseudoTypeScrollbarThumb:
*t = PseudoTypeScrollbarThumb
case PseudoTypeScrollbarButton:
*t = PseudoTypeScrollbarButton
case PseudoTypeScrollbarTrack:
*t = PseudoTypeScrollbarTrack
case PseudoTypeScrollbarTrackPiece:
*t = PseudoTypeScrollbarTrackPiece
case PseudoTypeScrollbarCorner:
*t = PseudoTypeScrollbarCorner
case PseudoTypeResizer:
*t = PseudoTypeResizer
case PseudoTypeInputListButton:
*t = PseudoTypeInputListButton
case PseudoTypeViewTransition:
*t = PseudoTypeViewTransition
case PseudoTypeViewTransitionGroup:
*t = PseudoTypeViewTransitionGroup
case PseudoTypeViewTransitionImagePair:
*t = PseudoTypeViewTransitionImagePair
case PseudoTypeViewTransitionOld:
*t = PseudoTypeViewTransitionOld
case PseudoTypeViewTransitionNew:
*t = PseudoTypeViewTransitionNew
case PseudoTypePlaceholder:
*t = PseudoTypePlaceholder
case PseudoTypeFileSelectorButton:
*t = PseudoTypeFileSelectorButton
case PseudoTypeDetailsContent:
*t = PseudoTypeDetailsContent
case PseudoTypePicker:
*t = PseudoTypePicker
default:
return fmt.Errorf("unknown PseudoType value: %v", s)
}
return nil
}
// ShadowRootType shadow root type.
//
// See: https://chromedevtools.github.io/devtools-protocol/tot/DOM#type-ShadowRootType
type ShadowRootType string
// String returns the ShadowRootType as string value.
func (t ShadowRootType) String() string {
return string(t)
}
// ShadowRootType values.
const (
ShadowRootTypeUserAgent ShadowRootType = "user-agent"
ShadowRootTypeOpen ShadowRootType = "open"
ShadowRootTypeClosed ShadowRootType = "closed"
)
// UnmarshalJSON satisfies [json.Unmarshaler].
func (t *ShadowRootType) UnmarshalJSON(buf []byte) error {
s := string(buf)
s = strings.TrimSuffix(strings.TrimPrefix(s, `"`), `"`)
switch ShadowRootType(s) {
case ShadowRootTypeUserAgent:
*t = ShadowRootTypeUserAgent
case ShadowRootTypeOpen:
*t = ShadowRootTypeOpen
case ShadowRootTypeClosed:
*t = ShadowRootTypeClosed
default:
return fmt.Errorf("unknown ShadowRootType value: %v", s)
}
return nil
}
// CompatibilityMode document compatibility mode.
//
// See: https://chromedevtools.github.io/devtools-protocol/tot/DOM#type-CompatibilityMode
type CompatibilityMode string
// String returns the CompatibilityMode as string value.
func (t CompatibilityMode) String() string {
return string(t)
}
// CompatibilityMode values.
const (
CompatibilityModeQuirksMode CompatibilityMode = "QuirksMode"
CompatibilityModeLimitedQuirksMode CompatibilityMode = "LimitedQuirksMode"
CompatibilityModeNoQuirksMode CompatibilityMode = "NoQuirksMode"
)
// UnmarshalJSON satisfies [json.Unmarshaler].
func (t *CompatibilityMode) UnmarshalJSON(buf []byte) error {
s := string(buf)
s = strings.TrimSuffix(strings.TrimPrefix(s, `"`), `"`)
switch CompatibilityMode(s) {
case CompatibilityModeQuirksMode:
*t = CompatibilityModeQuirksMode
case CompatibilityModeLimitedQuirksMode:
*t = CompatibilityModeLimitedQuirksMode
case CompatibilityModeNoQuirksMode:
*t = CompatibilityModeNoQuirksMode
default:
return fmt.Errorf("unknown CompatibilityMode value: %v", s)
}
return nil
}
// Node DOM interaction is implemented in terms of mirror objects that
// represent the actual DOM nodes. DOMNode is a base node mirror type.
//
// See: https://chromedevtools.github.io/devtools-protocol/tot/DOM#type-Node
type Node struct {
NodeID NodeID `json:"nodeId"` // Node identifier that is passed into the rest of the DOM messages as the nodeId. Backend will only push node with given id once. It is aware of all requested nodes and will only fire DOM events for nodes known to the client.
ParentID NodeID `json:"parentId,omitempty,omitzero"` // The id of the parent node if any.
BackendNodeID BackendNodeID `json:"backendNodeId"` // The BackendNodeId for this node.
NodeType NodeType `json:"nodeType"` // Node's nodeType.
NodeName string `json:"nodeName"` // Node's nodeName.
LocalName string `json:"localName"` // Node's localName.
NodeValue string `json:"nodeValue"` // Node's nodeValue.
ChildNodeCount int64 `json:"childNodeCount,omitempty,omitzero"` // Child count for Container nodes.
Children []*Node `json:"children,omitempty,omitzero"` // Child nodes of this node when requested with children.
Attributes []string `json:"attributes,omitempty,omitzero"` // Attributes of the Element node in the form of flat array [name1, value1, name2, value2].
DocumentURL string `json:"documentURL,omitempty,omitzero"` // Document URL that Document or FrameOwner node points to.
BaseURL string `json:"baseURL,omitempty,omitzero"` // Base URL that Document or FrameOwner node uses for URL completion.
PublicID string `json:"publicId,omitempty,omitzero"` // DocumentType's publicId.
SystemID string `json:"systemId,omitempty,omitzero"` // DocumentType's systemId.
InternalSubset string `json:"internalSubset,omitempty,omitzero"` // DocumentType's internalSubset.
XMLVersion string `json:"xmlVersion,omitempty,omitzero"` // Document's XML version in case of XML documents.
Name string `json:"name,omitempty,omitzero"` // Attr's name.
Value string `json:"value,omitempty,omitzero"` // Attr's value.
PseudoType PseudoType `json:"pseudoType,omitempty,omitzero"` // Pseudo element type for this node.
PseudoIdentifier string `json:"pseudoIdentifier,omitempty,omitzero"` // Pseudo element identifier for this node. Only present if there is a valid pseudoType.
ShadowRootType ShadowRootType `json:"shadowRootType,omitempty,omitzero"` // Shadow root type.
FrameID FrameID `json:"frameId,omitempty,omitzero"` // Frame ID for frame owner elements.
ContentDocument *Node `json:"contentDocument,omitempty,omitzero"` // Content document for frame owner elements.
ShadowRoots []*Node `json:"shadowRoots,omitempty,omitzero"` // Shadow root list for given element host.
TemplateContent *Node `json:"templateContent,omitempty,omitzero"` // Content document fragment for template elements.
PseudoElements []*Node `json:"pseudoElements,omitempty,omitzero"` // Pseudo elements associated with this node.
DistributedNodes []*BackendNode `json:"distributedNodes,omitempty,omitzero"` // Distributed nodes for given insertion point.
IsSVG bool `json:"isSVG,omitempty,omitzero"` // Whether the node is SVG.
CompatibilityMode CompatibilityMode `json:"compatibilityMode,omitempty,omitzero"`
AssignedSlot *BackendNode `json:"assignedSlot,omitempty,omitzero"`
IsScrollable bool `json:"isScrollable,omitempty,omitzero"`
Parent *Node `json:"-"` // Parent node.
Invalidated chan struct{} `json:"-"` // Invalidated channel.
State NodeState `json:"-"` // Node state.
sync.RWMutex `json:"-"` // Read write mutex.
}
// AttributeValue returns the named attribute for the node.
func (n *Node) AttributeValue(name string) string {
value, _ := n.Attribute(name)
return value
}
// Attribute returns the named attribute for the node and if it exists.
func (n *Node) Attribute(name string) (string, bool) {
n.RLock()
defer n.RUnlock()
for i := 0; i < len(n.Attributes); i += 2 {
if n.Attributes[i] == name {
return n.Attributes[i+1], true
}
}
return "", false
}
// xpath builds the xpath string.
func (n *Node) xpath(stopAtDocument, stopAtID bool) string {
n.RLock()
defer n.RUnlock()
p, pos, id := "", "", n.AttributeValue("id")
switch {
case n.Parent == nil:
return n.LocalName
case stopAtDocument && n.NodeType == NodeTypeDocument:
return ""
case stopAtID && id != "":
p = "/"
pos = `[@id='` + id + `']`
case n.Parent != nil:
var i int
var found bool
n.Parent.RLock()
for j := 0; j < len(n.Parent.Children); j++ {
if n.Parent.Children[j].LocalName == n.LocalName {
i++
}
if n.Parent.Children[j].NodeID == n.NodeID {
found = true
break
}
}
n.Parent.RUnlock()
if found {
pos = "[" + strconv.Itoa(i) + "]"
}
p = n.Parent.xpath(stopAtDocument, stopAtID)
}
localName := n.LocalName
if n.IsSVG {
localName = `*[local-name()='` + localName + `']`
}
return p + "/" + localName + pos
}
// PartialXPathByID returns the partial XPath for the node, stopping at the
// first parent with an id attribute or at nearest parent document node.
func (n *Node) PartialXPathByID() string {
return n.xpath(true, true)
}
// PartialXPath returns the partial XPath for the node, stopping at the nearest
// parent document node.
func (n *Node) PartialXPath() string {
return n.xpath(true, false)
}
// FullXPathByID returns the full XPath for the node, stopping at the top most
// document root or at the closest parent node with an id attribute.
func (n *Node) FullXPathByID() string {
return n.xpath(false, true)
}
// FullXPath returns the full XPath for the node, stopping only at the top most
// document root.
func (n *Node) FullXPath() string {
return n.xpath(false, false)
}
// WriteTo writes a readable representation of the node and all its children to w.
func (n *Node) WriteTo(w io.Writer, prefix, indent string, nodeIDs bool) (int, error) {
if n == nil {
return w.Write([]byte(prefix + "<nil>"))
}
n.RLock()
defer n.RUnlock()
var err error
var nn, c int
// prefix
if c, err = w.Write([]byte(prefix)); err != nil {
return nn + c, err
}
nn += c
// node name
if n.LocalName != "" {
if c, err = w.Write([]byte(n.LocalName)); err != nil {
return nn + c, err
}
nn += c
} else {
if c, err = w.Write([]byte(n.NodeName)); err != nil {
return nn + c, err
}
nn += c
}
// add #id
var hasID int
for i := 0; i < len(n.Attributes); i += 2 {
if strings.ToLower(n.Attributes[i]) == "id" {
if c, err = w.Write([]byte("#" + n.Attributes[i+1])); err != nil {
return nn + c, err
}
nn += c
hasID = 2
break
}
}
// node type
if n.NodeType != NodeTypeElement && n.NodeType != NodeTypeText {
if c, err = fmt.Fprintf(w, " <%s>", n.NodeType); err != nil {
return nn + c, err
}
nn += c
}
// node value
if n.NodeType == NodeTypeText {
v := n.NodeValue
if len(v) > 15 {
v = v[:15] + "..."
}
if c, err = fmt.Fprintf(w, " %q", v); err != nil {
return nn + c, err
}
nn += c
}
// attributes
if n.NodeType == NodeTypeElement && len(n.Attributes) > hasID {
if c, err = w.Write([]byte(" [")); err != nil {
return nn + c, err
}
nn += c
for i, space := 0, ""; i < len(n.Attributes); i += 2 {
if strings.ToLower(n.Attributes[i]) == "id" {
continue
}
if c, err = fmt.Fprintf(w, "%s%s=%q", space, n.Attributes[i], n.Attributes[i+1]); err != nil {
return nn + c, err
}
nn += c
if space == "" {
space = " "
}
}
if c, err = w.Write([]byte{']'}); err != nil {
return nn + c, err
}
nn += c
}
// node id
if nodeIDs {
if c, err = fmt.Fprintf(w, " (%d)", n.NodeID); err != nil {
return nn + c, err
}
nn += c
}
// children
for i := 0; i < len(n.Children); i++ {
if c, err = fmt.Fprintln(w); err != nil {
return nn + c, err
}
nn += c
if c, err = n.Children[i].WriteTo(w, prefix+indent, indent, nodeIDs); err != nil {
return nn + c, err
}
nn += c
}
return nn, nil
}
// Dump builds a printable string representation of the node and its children.
func (n *Node) Dump(prefix, indent string, nodeIDs bool) string {
var buf bytes.Buffer
_, _ = n.WriteTo(&buf, prefix, indent, nodeIDs)
return buf.String()
}
// NodeState is the state of a DOM node.
type NodeState uint8
// NodeState enum values.
const (
NodeReady NodeState = 1 << (7 - iota)
NodeVisible
NodeHighlighted
)
// nodeStateNames are the names of the node states.
var nodeStateNames = map[NodeState]string{
NodeReady: "Ready",
NodeVisible: "Visible",
NodeHighlighted: "Highlighted",
}
// String satisfies stringer interface.
func (ns NodeState) String() string {
var s []string
for k, v := range nodeStateNames {
if ns&k != 0 {
s = append(s, v)
}
}
return "[" + strings.Join(s, " ") + "]"
}
// EmptyNodeID is the "non-existent" node id.
const EmptyNodeID = NodeID(0)
// RGBA a structure holding an RGBA color.
//
// See: https://chromedevtools.github.io/devtools-protocol/tot/DOM#type-RGBA
type RGBA struct {
R int64 `json:"r"` // The red component, in the [0-255] range.
G int64 `json:"g"` // The green component, in the [0-255] range.
B int64 `json:"b"` // The blue component, in the [0-255] range.
A float64 `json:"a"` // The alpha component, in the [0-1] range (default: 1).
}
// NodeType node type.
//
// See: https://developer.mozilla.org/en/docs/Web/API/Node/nodeType
type NodeType int64
// Int64 returns the NodeType as int64 value.
func (t NodeType) Int64() int64 {
return int64(t)
}
// NodeType values.
const (
NodeTypeElement NodeType = 1
NodeTypeAttribute NodeType = 2
NodeTypeText NodeType = 3
NodeTypeCDATA NodeType = 4
NodeTypeEntityReference NodeType = 5
NodeTypeEntity NodeType = 6
NodeTypeProcessingInstruction NodeType = 7
NodeTypeComment NodeType = 8
NodeTypeDocument NodeType = 9
NodeTypeDocumentType NodeType = 10
NodeTypeDocumentFragment NodeType = 11
NodeTypeNotation NodeType = 12
)
// String satisfies the [fmt.Stringer] interface.
func (t NodeType) String() string {
switch t {
case NodeTypeElement:
return "Element"
case NodeTypeAttribute:
return "Attribute"
case NodeTypeText:
return "Text"
case NodeTypeCDATA:
return "CDATA"
case NodeTypeEntityReference:
return "EntityReference"
case NodeTypeEntity:
return "Entity"
case NodeTypeProcessingInstruction:
return "ProcessingInstruction"
case NodeTypeComment:
return "Comment"
case NodeTypeDocument:
return "Document"
case NodeTypeDocumentType:
return "DocumentType"
case NodeTypeDocumentFragment:
return "DocumentFragment"
case NodeTypeNotation:
return "Notation"
}
return fmt.Sprintf("NodeType(%d)", t)
}
// UnmarshalJSON satisfies [json.Unmarshaler].
func (t *NodeType) UnmarshalJSON(buf []byte) error {
s := string(buf)
v, err := strconv.ParseInt(s, 10, 64)
if err != nil {
return err
}
switch NodeType(v) {
case NodeTypeElement:
*t = NodeTypeElement
case NodeTypeAttribute:
*t = NodeTypeAttribute
case NodeTypeText:
*t = NodeTypeText
case NodeTypeCDATA:
*t = NodeTypeCDATA
case NodeTypeEntityReference:
*t = NodeTypeEntityReference
case NodeTypeEntity:
*t = NodeTypeEntity
case NodeTypeProcessingInstruction:
*t = NodeTypeProcessingInstruction
case NodeTypeComment:
*t = NodeTypeComment
case NodeTypeDocument:
*t = NodeTypeDocument
case NodeTypeDocumentType:
*t = NodeTypeDocumentType
case NodeTypeDocumentFragment:
*t = NodeTypeDocumentFragment
case NodeTypeNotation:
*t = NodeTypeNotation
default:
return fmt.Errorf("unknown NodeType value: %v", s)
}
return nil
}
// LoaderID unique loader identifier.
//
// See: https://chromedevtools.github.io/devtools-protocol/tot/Network#type-LoaderId
type LoaderID string
// String returns the LoaderID as string value.
func (t LoaderID) String() string {
return string(t)
}
// TimeSinceEpoch UTC time in seconds, counted from January 1, 1970.
//
// See: https://chromedevtools.github.io/devtools-protocol/tot/Network#type-TimeSinceEpoch
type TimeSinceEpoch time.Time
// Time returns the TimeSinceEpoch as time.Time value.
func (t TimeSinceEpoch) Time() time.Time {
return time.Time(t)
}
// MarshalJSON satisfies [json.Marshaler].
func (t TimeSinceEpoch) MarshalJSON() ([]byte, error) {
v := float64(time.Time(t).UnixNano() / int64(time.Second))
return strconv.AppendFloat(make([]byte, 0, 20), v, 'f', -1, 64), nil
}
// UnmarshalJSON satisfies [json.Unmarshaler].
func (t *TimeSinceEpoch) UnmarshalJSON(buf []byte) error {
f, err := strconv.ParseFloat(string(buf), 64)
if err != nil {
return err
}
*t = TimeSinceEpoch(time.Unix(0, int64(f*float64(time.Second))))
return nil
}
// MonotonicTime monotonically increasing time in seconds since an arbitrary
// point in the past.
//
// See: https://chromedevtools.github.io/devtools-protocol/tot/Network#type-MonotonicTime
type MonotonicTime time.Time
// Time returns the MonotonicTime as time.Time value.
func (t MonotonicTime) Time() time.Time {
return time.Time(t)
}
// MonotonicTimeEpoch is the MonotonicTime time epoch.
var MonotonicTimeEpoch *time.Time
func init() {
// initialize epoch
bt := sysutil.BootTime()
MonotonicTimeEpoch = &bt
}
// MarshalJSON satisfies [json.Marshaler].
func (t MonotonicTime) MarshalJSON() ([]byte, error) {
v := float64(time.Time(t).Sub(*MonotonicTimeEpoch)) / float64(time.Second)
return strconv.AppendFloat(make([]byte, 0, 20), v, 'f', -1, 64), nil
}
// UnmarshalJSON satisfies [json.Unmarshaler].
func (t *MonotonicTime) UnmarshalJSON(buf []byte) error {
f, err := strconv.ParseFloat(string(buf), 64)
if err != nil {
return err
}
*t = MonotonicTime(MonotonicTimeEpoch.Add(time.Duration(f * float64(time.Second))))
return nil
}
// TimeSinceEpochMilli special timestamp type for Response's responseTime
// field.
//
// See: https://chromedevtools.github.io/devtools-protocol/tot/Network#type-TimeSinceEpochMilli
type TimeSinceEpochMilli time.Time
// Time returns the TimeSinceEpochMilli as time.Time value.
func (t TimeSinceEpochMilli) Time() time.Time {
return time.Time(t)
}
// MarshalJSON satisfies [json.Marshaler].
func (t TimeSinceEpochMilli) MarshalJSON() ([]byte, error) {
v := float64(time.Time(t).UnixNano() / int64(time.Millisecond))
return strconv.AppendFloat(make([]byte, 0, 20), v, 'f', -1, 64), nil
}
// UnmarshalJSON satisfies [json.Unmarshaler].
func (t *TimeSinceEpochMilli) UnmarshalJSON(buf []byte) error {
f, err := strconv.ParseFloat(string(buf), 64)
if err != nil {
return err
}
*t = TimeSinceEpochMilli(time.Unix(0, int64(f*float64(time.Millisecond))))
return nil
}
// FrameID unique frame identifier.
//
// See: https://chromedevtools.github.io/devtools-protocol/tot/Page#type-FrameId
type FrameID string
// String returns the FrameID as string value.
func (t FrameID) String() string {
return string(t)
}
// UnmarshalJSON satisfies [json.Unmarshaler].
func (t *FrameID) UnmarshalJSON(buf []byte) error {
if l := len(buf); l > 2 && buf[0] == '"' && buf[l-1] == '"' {
buf = buf[1 : l-1]
}
*t = FrameID(buf)
return nil
}
// AdFrameType indicates whether a frame has been identified as an ad.
//
// See: https://chromedevtools.github.io/devtools-protocol/tot/Page#type-AdFrameType
type AdFrameType string
// String returns the AdFrameType as string value.
func (t AdFrameType) String() string {
return string(t)
}
// AdFrameType values.
const (
AdFrameTypeNone AdFrameType = "none"
AdFrameTypeChild AdFrameType = "child"
AdFrameTypeRoot AdFrameType = "root"
)
// UnmarshalJSON satisfies [json.Unmarshaler].
func (t *AdFrameType) UnmarshalJSON(buf []byte) error {
s := string(buf)
s = strings.TrimSuffix(strings.TrimPrefix(s, `"`), `"`)
switch AdFrameType(s) {
case AdFrameTypeNone:
*t = AdFrameTypeNone
case AdFrameTypeChild:
*t = AdFrameTypeChild
case AdFrameTypeRoot:
*t = AdFrameTypeRoot
default:
return fmt.Errorf("unknown AdFrameType value: %v", s)
}
return nil
}
// AdFrameExplanation [no description].
//
// See: https://chromedevtools.github.io/devtools-protocol/tot/Page#type-AdFrameExplanation
type AdFrameExplanation string
// String returns the AdFrameExplanation as string value.
func (t AdFrameExplanation) String() string {
return string(t)
}
// AdFrameExplanation values.
const (
AdFrameExplanationParentIsAd AdFrameExplanation = "ParentIsAd"
AdFrameExplanationCreatedByAdScript AdFrameExplanation = "CreatedByAdScript"
AdFrameExplanationMatchedBlockingRule AdFrameExplanation = "MatchedBlockingRule"
)
// UnmarshalJSON satisfies [json.Unmarshaler].
func (t *AdFrameExplanation) UnmarshalJSON(buf []byte) error {
s := string(buf)
s = strings.TrimSuffix(strings.TrimPrefix(s, `"`), `"`)
switch AdFrameExplanation(s) {
case AdFrameExplanationParentIsAd:
*t = AdFrameExplanationParentIsAd
case AdFrameExplanationCreatedByAdScript:
*t = AdFrameExplanationCreatedByAdScript
case AdFrameExplanationMatchedBlockingRule:
*t = AdFrameExplanationMatchedBlockingRule
default:
return fmt.Errorf("unknown AdFrameExplanation value: %v", s)
}
return nil
}
// AdFrameStatus indicates whether a frame has been identified as an ad and
// why.
//
// See: https://chromedevtools.github.io/devtools-protocol/tot/Page#type-AdFrameStatus
type AdFrameStatus struct {
AdFrameType AdFrameType `json:"adFrameType"`
Explanations []AdFrameExplanation `json:"explanations,omitempty,omitzero"`
}
// SecureContextType indicates whether the frame is a secure context and why
// it is the case.
//
// See: https://chromedevtools.github.io/devtools-protocol/tot/Page#type-SecureContextType
type SecureContextType string
// String returns the SecureContextType as string value.
func (t SecureContextType) String() string {
return string(t)
}
// SecureContextType values.
const (
SecureContextTypeSecure SecureContextType = "Secure"
SecureContextTypeSecureLocalhost SecureContextType = "SecureLocalhost"
SecureContextTypeInsecureScheme SecureContextType = "InsecureScheme"
SecureContextTypeInsecureAncestor SecureContextType = "InsecureAncestor"
)
// UnmarshalJSON satisfies [json.Unmarshaler].
func (t *SecureContextType) UnmarshalJSON(buf []byte) error {
s := string(buf)
s = strings.TrimSuffix(strings.TrimPrefix(s, `"`), `"`)
switch SecureContextType(s) {
case SecureContextTypeSecure:
*t = SecureContextTypeSecure
case SecureContextTypeSecureLocalhost:
*t = SecureContextTypeSecureLocalhost
case SecureContextTypeInsecureScheme:
*t = SecureContextTypeInsecureScheme
case SecureContextTypeInsecureAncestor:
*t = SecureContextTypeInsecureAncestor
default:
return fmt.Errorf("unknown SecureContextType value: %v", s)
}
return nil
}
// CrossOriginIsolatedContextType indicates whether the frame is cross-origin
// isolated and why it is the case.
//
// See: https://chromedevtools.github.io/devtools-protocol/tot/Page#type-CrossOriginIsolatedContextType
type CrossOriginIsolatedContextType string
// String returns the CrossOriginIsolatedContextType as string value.
func (t CrossOriginIsolatedContextType) String() string {
return string(t)
}
// CrossOriginIsolatedContextType values.
const (
CrossOriginIsolatedContextTypeIsolated CrossOriginIsolatedContextType = "Isolated"
CrossOriginIsolatedContextTypeNotIsolated CrossOriginIsolatedContextType = "NotIsolated"
CrossOriginIsolatedContextTypeNotIsolatedFeatureDisabled CrossOriginIsolatedContextType = "NotIsolatedFeatureDisabled"
)
// UnmarshalJSON satisfies [json.Unmarshaler].
func (t *CrossOriginIsolatedContextType) UnmarshalJSON(buf []byte) error {
s := string(buf)
s = strings.TrimSuffix(strings.TrimPrefix(s, `"`), `"`)
switch CrossOriginIsolatedContextType(s) {
case CrossOriginIsolatedContextTypeIsolated:
*t = CrossOriginIsolatedContextTypeIsolated
case CrossOriginIsolatedContextTypeNotIsolated:
*t = CrossOriginIsolatedContextTypeNotIsolated