File: type.go

package info (click to toggle)
golang-github-burntsushi-xgb 0.0~git20210121.deaf085-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 2,100 kB
  • sloc: makefile: 61
file content (390 lines) | stat: -rw-r--r-- 7,822 bytes parent folder | download | duplicates (2)
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
package main

import (
	"fmt"
	"strings"
)

type Type interface {
	Initialize(p *Protocol)
	SrcName() string
	XmlName() string
	Size() Size

	Define(c *Context)
}

type Types []Type

func (ts Types) Len() int      { return len(ts) }
func (ts Types) Swap(i, j int) { ts[i], ts[j] = ts[j], ts[i] }
func (ts Types) Less(i, j int) bool {
	x1, x2 := ts[i].XmlName(), ts[j].XmlName()
	s1, s2 := ts[i].SrcName(), ts[j].SrcName()
	return (s1 == s2 && x1 < x2) || s1 < s2
}

// Translation is used *only* when transitioning from XML types to
// our better representation. They are placeholders for the real types (below)
// that will replace them.
type Translation struct {
	xmlName string
}

func newTranslation(name string) *Translation {
	return &Translation{xmlName: name}
}

// RealType takes 'XmlName' and finds its real concrete type in our Protocol.
// It is an error if we can't find such a type.
func (t *Translation) RealType(p *Protocol) Type {
	// Check to see if there is a namespace. If so, strip it and use it to
	// make sure we only look for a type in that protocol.
	namespace, typeName := "", t.XmlName()
	if ni := strings.Index(t.XmlName(), ":"); ni > -1 {
		namespace, typeName = strings.ToLower(typeName[:ni]), typeName[ni+1:]
	}

	if len(namespace) == 0 || namespace == strings.ToLower(p.Name) {
		for _, typ := range p.Types {
			if typeName == typ.XmlName() {
				return typ
			}
		}
	}
	for _, imp := range p.Imports {
		if len(namespace) == 0 || namespace == strings.ToLower(imp.Name) {
			for _, typ := range imp.Types {
				if typeName == typ.XmlName() {
					return typ
				}
			}
		}
	}
	panic("Could not find real type for translation type: " + t.XmlName())
}

func (t *Translation) SrcName() string {
	panic("it is illegal to call SrcName on a translation type")
}

func (t *Translation) XmlName() string {
	return t.xmlName
}

func (t *Translation) Size() Size {
	panic("it is illegal to call Size on a translation type")
}

func (t *Translation) Define(c *Context) {
	panic("it is illegal to call Define on a translation type")
}

func (t *Translation) Initialize(p *Protocol) {
	panic("it is illegal to call Initialize on a translation type")
}

type Base struct {
	srcName string
	xmlName string
	size    Size
}

func (b *Base) SrcName() string {
	return b.srcName
}

func (b *Base) XmlName() string {
	return b.xmlName
}

func (b *Base) Size() Size {
	return b.size
}

func (b *Base) Initialize(p *Protocol) {
	b.srcName = TypeSrcName(p, b)
}

type Enum struct {
	srcName string
	xmlName string
	Items   []*EnumItem
}

type EnumItem struct {
	srcName string
	xmlName string
	Expr    Expression
}

func (enum *Enum) SrcName() string {
	return enum.srcName
}

func (enum *Enum) XmlName() string {
	return enum.xmlName
}

func (enum *Enum) Size() Size {
	panic("Cannot take size of enum")
}

func (enum *Enum) Initialize(p *Protocol) {
	enum.srcName = TypeSrcName(p, enum)
	for _, item := range enum.Items {
		item.srcName = SrcName(p, item.xmlName)
		if item.Expr != nil {
			item.Expr.Initialize(p)
		}
	}
}

type Resource struct {
	srcName string
	xmlName string
}

func (r *Resource) SrcName() string {
	return r.srcName
}

func (r *Resource) XmlName() string {
	return r.xmlName
}

func (r *Resource) Size() Size {
	return newFixedSize(BaseTypeSizes["Id"], true)
}

func (r *Resource) Initialize(p *Protocol) {
	r.srcName = TypeSrcName(p, r)
}

type TypeDef struct {
	srcName string
	xmlName string
	Old     Type
}

func (t *TypeDef) SrcName() string {
	return t.srcName
}

func (t *TypeDef) XmlName() string {
	return t.xmlName
}

func (t *TypeDef) Size() Size {
	return t.Old.Size()
}

func (t *TypeDef) Initialize(p *Protocol) {
	t.Old = t.Old.(*Translation).RealType(p)
	t.srcName = TypeSrcName(p, t)
}

type Event struct {
	srcName    string
	xmlName    string
	Number     int
	NoSequence bool
	Fields     []Field
}

func (e *Event) SrcName() string {
	return e.srcName
}

func (e *Event) XmlName() string {
	return e.xmlName
}

func (e *Event) Size() Size {
	return newExpressionSize(&Value{v: 32}, true)
}

func (e *Event) Initialize(p *Protocol) {
	e.srcName = TypeSrcName(p, e)
	for _, field := range e.Fields {
		field.Initialize(p)
	}
}

func (e *Event) EvType() string {
	return fmt.Sprintf("%sEvent", e.srcName)
}

type EventCopy struct {
	srcName string
	xmlName string
	Old     Type
	Number  int
}

func (e *EventCopy) SrcName() string {
	return e.srcName
}

func (e *EventCopy) XmlName() string {
	return e.xmlName
}

func (e *EventCopy) Size() Size {
	return newExpressionSize(&Value{v: 32}, true)
}

func (e *EventCopy) Initialize(p *Protocol) {
	e.srcName = TypeSrcName(p, e)
	e.Old = e.Old.(*Translation).RealType(p)
	if _, ok := e.Old.(*Event); !ok {
		panic("an EventCopy's old type *must* be *Event")
	}
}

func (e *EventCopy) EvType() string {
	return fmt.Sprintf("%sEvent", e.srcName)
}

type Error struct {
	srcName string
	xmlName string
	Number  int
	Fields  []Field
}

func (e *Error) SrcName() string {
	return e.srcName
}

func (e *Error) XmlName() string {
	return e.xmlName
}

func (e *Error) Size() Size {
	return newExpressionSize(&Value{v: 32}, true)
}

func (e *Error) Initialize(p *Protocol) {
	e.srcName = TypeSrcName(p, e)
	for _, field := range e.Fields {
		field.Initialize(p)
	}
}

func (e *Error) ErrConst() string {
	return fmt.Sprintf("Bad%s", e.srcName)
}

func (e *Error) ErrType() string {
	return fmt.Sprintf("%sError", e.srcName)
}

type ErrorCopy struct {
	srcName string
	xmlName string
	Old     Type
	Number  int
}

func (e *ErrorCopy) SrcName() string {
	return e.srcName
}

func (e *ErrorCopy) XmlName() string {
	return e.xmlName
}

func (e *ErrorCopy) Size() Size {
	return newExpressionSize(&Value{v: 32}, true)
}

func (e *ErrorCopy) Initialize(p *Protocol) {
	e.srcName = TypeSrcName(p, e)
	e.Old = e.Old.(*Translation).RealType(p)
	if _, ok := e.Old.(*Error); !ok {
		panic("an ErrorCopy's old type *must* be *Event")
	}
}

func (e *ErrorCopy) ErrConst() string {
	return fmt.Sprintf("Bad%s", e.srcName)
}

func (e *ErrorCopy) ErrType() string {
	return fmt.Sprintf("%sError", e.srcName)
}

type Struct struct {
	srcName string
	xmlName string
	Fields  []Field
}

func (s *Struct) SrcName() string {
	return s.srcName
}

func (s *Struct) XmlName() string {
	return s.xmlName
}

func (s *Struct) Size() Size {
	size := newFixedSize(0, true)
	for _, field := range s.Fields {
		size = size.Add(field.Size())
	}
	return size
}

func (s *Struct) Initialize(p *Protocol) {
	s.srcName = TypeSrcName(p, s)
	for _, field := range s.Fields {
		field.Initialize(p)
	}
}

// HasList returns whether there is a field in this struct that is a list.
// When true, a more involved calculation is necessary to compute this struct's
// size.
func (s *Struct) HasList() bool {
	for _, field := range s.Fields {
		if _, ok := field.(*ListField); ok {
			return true
		}
	}
	return false
}

type Union struct {
	srcName string
	xmlName string
	Fields  []Field
}

func (u *Union) SrcName() string {
	return u.srcName
}

func (u *Union) XmlName() string {
	return u.xmlName
}

// Size for Union is broken. At least, it's broken for XKB.
// It *looks* like the protocol inherently relies on some amount of
// memory unsafety, since some members of unions in XKB are *variable* in
// length! The only thing I can come up with, maybe, is when a union has
// variable size, simply return the raw bytes. Then it's up to the user to
// pass those raw bytes into the appropriate New* constructor. GROSS!
// As of now, just pluck out the first field and return that size. This
// should work for union elements in randr.xml and xproto.xml.
func (u *Union) Size() Size {
	return u.Fields[0].Size()
}

func (u *Union) Initialize(p *Protocol) {
	u.srcName = fmt.Sprintf("%sUnion", TypeSrcName(p, u))
	for _, field := range u.Fields {
		field.Initialize(p)
	}
}