-
Notifications
You must be signed in to change notification settings - Fork 1
/
interface.go
338 lines (306 loc) · 9.17 KB
/
interface.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
package idl
import (
"fmt"
"reflect"
"github.com/dave/jennifer/jen"
"github.com/lugu/qiloop/meta/signature"
"github.com/lugu/qiloop/type/object"
)
// Proxy were generated from MetaObjects. This is convinient from a
// boostraping point of view. Since the data structures are well
// known, we introduce the InterfaceType which contains the
// information of the MetaObject with the possibility to resolve
// object references.
// Two stage parsing of the IDL:
// 1. Construct a set of Types associated with context.
// 2. Defer the resolution of the types to the proxy/stub generation.
// Namespace represents a set of packages extracted from IDL files.
// Each package is given a name and a set of types.
type Namespace map[string]Scope
// Parameter represents a method parameter. It is used to describe a
// method.
type Parameter struct {
Name string
Type signature.Type
}
// Method represents the signature of a method describe in an IDL
// file.
type Method struct {
Name string
ID uint32
Return signature.Type
Params []Parameter
}
// Meta translate the method signature into a MetaMethod use in a
// MetaObject. There is not a one-to-one mapping between the two
// structures: Method capture the reference to other interface
// (object) while MetaMethod treats all object with a generic
// reference.
func (m Method) Meta(id uint32) object.MetaMethod {
var meta object.MetaMethod
meta.Uid = id
meta.Name = m.Name
meta.ReturnSignature = m.Return.Signature()
meta.ReturnDescription = m.Return.SignatureIDL()
params := make([]signature.Type, 0)
meta.Parameters = make([]object.MetaMethodParameter, 0)
for _, p := range m.Params {
var param object.MetaMethodParameter
param.Name = p.Name
param.Description = p.Type.SignatureIDL()
meta.Parameters = append(meta.Parameters, param)
params = append(params, p.Type)
}
meta.ParametersSignature = signature.NewTupleType(params).Signature()
return meta
}
// Tuple returns a TupleType used to generate marshall/unmarshall
// operations.
func (m Method) Tuple() *signature.TupleType {
var tuple signature.TupleType
tuple.Members = make([]signature.MemberType, 0)
for i, p := range m.Params {
tuple.Members = append(tuple.Members,
signature.MemberType{
Name: signature.CleanVarName(i, p.Name),
Type: p.Type,
})
}
return &tuple
}
func (m Method) Type() signature.Type {
if len(m.Params) == 1 {
return m.Params[0].Type
}
return m.Tuple()
}
// Signal represent an interface signal
type Signal struct {
Name string
ID uint32
Params []Parameter
}
// Tuple returns a TupleType used to generate marshall/unmarshall
// operations.
func (s Signal) Tuple() *signature.TupleType {
var tuple signature.TupleType
tuple.Members = make([]signature.MemberType, 0)
for _, p := range s.Params {
tuple.Members = append(tuple.Members,
signature.MemberType{
Name: p.Name,
Type: p.Type,
})
}
return &tuple
}
// Type returns a StructType used to generate marshall/unmarshall
// operations.
func (s Signal) Type() signature.Type {
if len(s.Params) == 1 {
return s.Params[0].Type
}
return signature.NewStructType(s.Name, s.Tuple().Members)
}
// Meta returns a MetaSignal.
func (s Signal) Meta(id uint32) object.MetaSignal {
var meta object.MetaSignal
meta.Uid = id
meta.Name = s.Name
types := make([]signature.Type, 0)
for _, p := range s.Params {
types = append(types, p.Type)
}
meta.Signature = signature.NewTupleType(types).Signature()
return meta
}
// Property represents a property
type Property struct {
Name string
ID uint32
Params []Parameter
}
// Tuple returns a TupleType used to generate marshall/unmarshall
// operations.
func (s Property) Tuple() *signature.TupleType {
var tuple signature.TupleType
tuple.Members = make([]signature.MemberType, 0)
for _, p := range s.Params {
tuple.Members = append(tuple.Members,
signature.MemberType{
Name: p.Name,
Type: p.Type,
})
}
return &tuple
}
// Type returns a StructType used to generate marshall/unmarshall
// operations.
func (p Property) Type() signature.Type {
if len(p.Params) == 1 {
return p.Params[0].Type
}
return signature.NewStructType(p.Name, p.Tuple().Members)
}
// Meta converts a property to a MetaProperty.
func (p Property) Meta(id uint32) object.MetaProperty {
var meta object.MetaProperty
meta.Uid = id
meta.Name = p.Name
types := make([]signature.Type, 0)
for _, p := range p.Params {
types = append(types, p.Type)
}
meta.Signature = signature.NewTupleType(types).Signature()
return meta
}
// InterfaceType represents a parsed IDL interface. It implements
// signature.Type.
type InterfaceType struct {
Name string
PackageName string
Methods map[uint32]Method
Signals map[uint32]Signal
Properties map[uint32]Property
Scope Scope
Namespace Namespace
ForStub bool
}
// Signature returns "o".
func (s *InterfaceType) Signature() string {
return "o"
}
// SignatureIDL returns "obj".
func (s *InterfaceType) SignatureIDL() string {
return "obj"
}
// TypeName returns a statement to be inserted when the type is to be
// declared.
func (s *InterfaceType) TypeName() *jen.Statement {
return jen.Qual(s.PackageName, objName(s.Name))
}
// TypeDeclaration writes the type declaration into file.
// It generates the proxy for the interface.
func (s *InterfaceType) TypeDeclaration(f *jen.File) {
err := generateInterface(s, f)
if err != nil {
panic("render interface " + s.Name + " " + err.Error())
}
}
// RegisterTo adds the type to the type set.
func (s *InterfaceType) RegisterTo(set *signature.TypeSet) {
s.registerMembers(set)
s.Name = set.ResolveCollision(s.Name, s.Signature())
if set.Search(s.Name) == nil {
set.Types = append(set.Types, s)
set.Names = append(set.Names, s.Name)
}
}
func (itf *InterfaceType) registerMembers(set *signature.TypeSet) error {
metaObj := itf.MetaObject()
method := func(m object.MetaMethod, methodName string) error {
method := itf.Methods[m.Uid]
paramType := method.Tuple()
paramType.RegisterTo(set)
returnType := method.Return
if returnType.Signature() == signature.MetaObjectSignature {
returnType = signature.NewMetaObjectType()
}
returnType.RegisterTo(set)
return nil
}
signal := func(s object.MetaSignal, signalName string) error {
signal := itf.Signals[s.Uid]
signalType := signal.Type()
signalType.RegisterTo(set)
return nil
}
property := func(p object.MetaProperty, propertyName string) error {
property := itf.Properties[p.Uid]
propertyType := property.Type()
propertyType.RegisterTo(set)
return nil
}
err := metaObj.ForEachMethodAndSignal(method, signal, property)
if err != nil {
return fmt.Errorf("generate interface object %s: %s",
itf.Name, err)
}
return nil
}
// Marshal returns a statement which represent the code needed to put
// the variable "id" into the io.Writer "writer" while returning an
// error.
func (s *InterfaceType) Marshal(id string, writer string) *jen.Statement {
return jen.Id(`func() error {
meta, err := ` + id + `.MetaObject(` + id + `.Proxy().ObjectID())
if err != nil {
return fmt.Errorf("get meta: %s", err)
}
ref := object.ObjectReference {
MetaObject: meta,
ServiceID: ` + id + `.Proxy().ServiceID(),
ObjectID: ` + id + `.Proxy().ObjectID(),
}
return object.WriteObjectReference(ref, ` + writer + `)
}()`)
}
// InterfaceTypeForStub is a global flags which informs the
// InterfaceType instances if they are used in the context of the
// generation of a stub.
var InterfaceTypeForStub = false
// Unmarshal returns a statement which represent the code needed to read
// from a reader "reader" of type io.Reader and returns both the value
// read and an error.
func (s *InterfaceType) Unmarshal(reader string) *jen.Statement {
var extra string
if InterfaceTypeForStub {
extra = `
if ref.ServiceID == p.serviceID && ref.ObjectID >= (1<<31) {
actor := bus.NewClientObject(ref.ObjectID, c)
ref.ObjectID, err = p.service.Add(actor)
if err != nil {
return nil, fmt.Errorf("add client object: %s", err)
}
}`
}
return jen.Func().Params().Params(s.TypeName(), jen.Error()).Block(
jen.Id("ref").Op(",").Id("err").Op(":=").Qual(
"github.com/lugu/qiloop/type/object",
"ReadObjectReference",
).Call(jen.Id(reader)),
jen.Id(`if err != nil {
return nil, fmt.Errorf("get meta: %s", err)
}`+extra+`
proxy, err := p.session.Object(ref)
if err != nil {
return nil, fmt.Errorf("get proxy: %s", err)
}
return Make`+s.Name+`(p.session, proxy), nil`),
).Call()
}
// Reader returns a TypeReader for object references
func (s *InterfaceType) Reader() signature.TypeReader {
panic("not yet implemented")
}
func (s *InterfaceType) Type() reflect.Type {
panic("not yet implemented")
}
// MetaObject returs the MetaObject describing the interface.
func (s *InterfaceType) MetaObject() object.MetaObject {
var meta object.MetaObject
meta.Description = s.Name
meta.Methods = make(map[uint32]object.MetaMethod)
meta.Signals = make(map[uint32]object.MetaSignal)
meta.Properties = make(map[uint32]object.MetaProperty)
for id, m := range s.Methods {
meta.Methods[id] = m.Meta(id)
}
for id, s := range s.Signals {
meta.Signals[id] = s.Meta(id)
}
for id, p := range s.Properties {
meta.Properties[id] = p.Meta(id)
}
return meta
}