forked from diamondburned/gotk4
/
namespace.go
417 lines (352 loc) · 11 KB
/
namespace.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
package girgen
import (
"fmt"
"path/filepath"
"strings"
"github.com/brotholo/gotk4/gir"
"github.com/brotholo/gotk4/gir/girgen/cmt"
"github.com/brotholo/gotk4/gir/girgen/generators"
"github.com/brotholo/gotk4/gir/girgen/generators/iface"
"github.com/brotholo/gotk4/gir/girgen/logger"
"github.com/brotholo/gotk4/gir/girgen/types"
"github.com/pkg/errors"
)
// Postprocessor describes a processor function that modifies a namespace. It is
// called right before files are finalized within the namespace generator.
type Postprocessor func(n *NamespaceGenerator) error
// NamespaceGenerator manages generation of a namespace. A namespace contains
// various files, which are created using the FileWriter method.
type NamespaceGenerator struct {
*Generator
PkgPath string
PkgName string
PkgVersion string
Files map[string]FileGenerator
postprocs []Postprocessor
current *gir.NamespaceFindResult
c struct {
h *CFileGenerator
c *CFileGenerator
}
canResolve map[string]bool
genMode types.LinkMode
}
var (
_ types.FileGenerator = (*NamespaceGenerator)(nil)
_ generators.FileGenerator = (*NamespaceGenerator)(nil)
_ generators.FileGeneratorWriter = (*NamespaceGenerator)(nil)
)
// NewNamespaceGenerator creates a new NamespaceGenerator from the given
// generator and namespace.
func NewNamespaceGenerator(g *Generator, n *gir.NamespaceFindResult) *NamespaceGenerator {
return &NamespaceGenerator{
Generator: g,
PkgPath: g.ModPath(n.Namespace),
PkgName: gir.GoNamespace(n.Namespace),
PkgVersion: gir.MajorVersion(n.Namespace.Version),
Files: map[string]FileGenerator{},
current: n,
canResolve: map[string]bool{},
}
}
// AddPostprocessors adds the given list of postprocessors.
func (n *NamespaceGenerator) AddPostprocessors(pps []Postprocessor) {
n.postprocs = append(n.postprocs, pps...)
}
// Namespace returns the generator's namespace that includes the repository it's
// in.
func (n *NamespaceGenerator) Namespace() *gir.NamespaceFindResult {
return n.current
}
func (n *NamespaceGenerator) Logln(lvl logger.Level, v ...interface{}) {
p := fmt.Sprintf("package %s/v%s:", n.PkgName, n.PkgVersion)
n.Generator.Logln(lvl, logger.Prefix(v, p)...)
}
// CanGenerate checks if a type can be generated or not.
func (n *NamespaceGenerator) CanGenerate(r *types.Resolved) bool {
if r.Extern == nil {
return true // built-in
}
if !r.Extern.IsIntrospectable() {
return false
}
publType := types.GoPublicType(n, r)
// Cache the output of this to both avoid infinite recursions and improve
// the performance.
canResolve, ok := n.canResolve[publType]
if ok {
return canResolve
}
// Mark the type as resolveable to prevent infinite recursions when the
// generator functions call CanGenerate on its own.
n.canResolve[publType] = true
// Set the right namespace for the generator.
var ngen types.FileGenerator = n
if !r.Extern.NamespaceFindResult.Eq(n.current) {
ngen = types.OverrideNamespace(n, r.Extern.NamespaceFindResult)
}
switch v := r.Extern.Type.(type) {
// Fast checks.
case *gir.Alias:
canResolve = generators.CanGenerateAlias(ngen, v)
case *gir.Bitfield:
canResolve = generators.CanGenerateBitfield(ngen, v)
case *gir.Enum:
canResolve = generators.CanGenerateEnum(ngen, v)
case *gir.Record:
canResolve = generators.CanGenerateRecord(ngen, v)
case *gir.Class, *gir.Interface:
canResolve = iface.CanGenerate(ngen, v)
// Slow checks.
case *gir.Callback:
canResolve = generators.GenerateCallback(generators.StubFileGeneratorWriter(ngen), v)
case *gir.Function:
canResolve = generators.GenerateFunction(generators.StubFileGeneratorWriter(ngen), v)
case *gir.Union:
canResolve = generators.GenerateUnion(generators.StubFileGeneratorWriter(ngen), v)
}
// Actually store the correct value once we're done.
n.canResolve[publType] = canResolve
return canResolve
}
// LinkMode implements FileGenerator.
func (n *NamespaceGenerator) LinkMode() types.LinkMode { return n.genMode }
// SetLinkMode sets the link mode for the current namespace and all its files.
// The default is RuntimeLinkMode.
func (n *NamespaceGenerator) SetLinkMode(mode types.LinkMode) {
n.genMode = mode
}
// Pkgconfig returns the current repository's pkg-config names.
func (n *NamespaceGenerator) Pkgconfig() []string {
foundRoot := false
pkgs := make([]string, 0, len(n.current.Repository.Packages)+1)
for _, pkg := range n.current.Repository.Packages {
if pkg.Name == n.current.Repository.Pkg {
foundRoot = true
}
pkgs = append(pkgs, pkg.Name)
}
if !foundRoot {
pkgs = append(pkgs, n.current.Repository.Pkg)
}
return pkgs
}
// FileWriter returns the respective file writer from the given InfoFields.
func (n *NamespaceGenerator) FileWriter(info cmt.InfoFields, export bool) generators.FileWriter {
if n.Generator.Opts.SingleFile || info.Elements == nil {
if export {
return n.makeFile(n.PkgName + "_export.go")
}
return n.makeFile("")
}
var filename string
switch {
case info.Elements.SourcePosition != nil:
filename = info.Elements.SourcePosition.Filename
case info.Elements.Doc != nil:
filename = info.Elements.Doc.Filename
default:
if export {
return n.makeFile(n.PkgName + "_export.go")
}
return n.makeFile("")
}
filename = filepath.Base(filename)
if ext := filepath.Ext(filename); ext != "" {
filename = strings.TrimSuffix(filename, ext)
}
if info.Attrs != nil && info.Attrs.Version != "" {
filename += "_" + strings.ReplaceAll(info.Attrs.Version, ".", "_") // ex: gtk_3_2.go
}
if export {
filename += "_export"
}
return n.makeFile(filename + ".go")
}
// File gets an existing Go file but returns false if no such file exists. It's
// useful for postprocessors to check if generation is working as intended. If
// SingleFile is true, then File will always return the same file.
func (n *NamespaceGenerator) File(filename string) (*GoFileGenerator, bool) {
if n.Generator.Opts.SingleFile || filename == "" {
f, ok := n.Files[n.PkgName+".go"]
if ok {
goFile, ok := f.(*GoFileGenerator)
return goFile, ok
}
}
f, ok := n.Files[filename]
if ok {
goFile, ok := f.(*GoFileGenerator)
return goFile, ok
}
return nil, false
}
// MakeFile makes a new GoFileGenerator for the given filename or returns an
// existing one.
func (n *NamespaceGenerator) MakeFile(filename string) *GoFileGenerator {
// this should lead us down the right branch
if n.Generator.Opts.SingleFile {
filename = ""
}
return n.makeFile(filename)
}
func (n *NamespaceGenerator) makeFile(filename string) *GoFileGenerator {
isRoot := filename == n.PkgName+".go"
if filename == "" {
filename = n.PkgName + ".go"
isRoot = true
}
f, ok := n.Files[filename]
if ok {
return f.(*GoFileGenerator)
}
goFile := NewGoFileGenerator(n, filename, isRoot)
n.Files[filename] = goFile
return goFile
}
func (n *NamespaceGenerator) ch() *CFileGenerator {
if n.c.h == nil {
n.c.h = NewCFileGenerator(n, n.PkgName+".h")
}
return n.c.h
}
func (n *NamespaceGenerator) cc() *CFileGenerator {
if n.c.c == nil {
n.c.c = NewCFileGenerator(n, n.PkgName+".c")
}
return n.c.c
}
// Rename renames a file from src to dst. If src does not exist, then it will
// return an error.
func (n *NamespaceGenerator) Rename(src, dst string) error {
srcFile, ok := n.Files[src]
if !ok {
return fmt.Errorf("file %s does not exist", src)
}
_, ok = n.Files[dst]
if ok {
return fmt.Errorf("file %s already exists", dst)
}
switch f := srcFile.(type) {
case *GoFileGenerator:
f.name = dst
case *CFileGenerator:
f.name = dst
default:
return fmt.Errorf("cannot rename file of unsupported type %T", f)
}
delete(n.Files, src)
n.Files[dst] = srcFile
return nil
}
// Generate generates everything in the current namespace into files. The
// returned map maps the filename to the raw file content.
func (n *NamespaceGenerator) Generate() (map[string][]byte, error) {
// TODO: constants
// TODO: unions
generateFunctions := func(parent string, fns []gir.Function) {
for _, f := range fns {
if !generators.GeneratePrefixedFunction(n, &f, parent) {
n.logIfSkipped(false, "parent "+parent+" function "+f.Name)
}
}
}
for _, v := range n.current.Namespace.Constants {
n.logIfSkipped(generators.GenerateConstant(n, &v), "constant "+v.Name)
}
for _, v := range n.current.Namespace.Aliases {
n.logIfSkipped(generators.GenerateAlias(n, &v), "alias "+v.Name)
}
for _, v := range n.current.Namespace.Enums {
if !generators.GenerateEnum(n, &v) {
n.logIfSkipped(false, "enum "+v.Name)
continue
}
generateFunctions(v.Name, v.Functions)
}
for _, v := range n.current.Namespace.Bitfields {
if !generators.GenerateBitfield(n, &v) {
n.logIfSkipped(false, "bitfield "+v.Name)
continue
}
generateFunctions(v.Name, v.Functions)
}
for _, v := range n.current.Namespace.Callbacks {
n.logIfSkipped(generators.GenerateCallback(n, &v), "callback "+v.Name)
}
for _, v := range n.current.Namespace.Functions {
n.logIfSkipped(generators.GenerateFunction(n, &v), "function "+v.Name)
}
for _, v := range n.current.Namespace.Interfaces {
if !generators.GenerateInterface(n, &v) {
n.logIfSkipped(false, "interface "+v.Name)
continue
}
generateFunctions(v.Name, v.Functions)
}
for _, v := range n.current.Namespace.Classes {
if !generators.GenerateClass(n, &v) {
n.logIfSkipped(false, "class "+v.Name)
continue
}
generateFunctions(v.Name, v.Functions)
}
for _, v := range n.current.Namespace.Records {
if !generators.GenerateRecord(n, &v) {
n.logIfSkipped(false, "record "+v.Name)
continue
}
generateFunctions(v.Name, v.Functions)
}
for _, v := range n.current.Namespace.Unions {
if !generators.GenerateUnion(n, &v) {
n.logIfSkipped(false, "union "+v.Name)
continue
}
generateFunctions(v.Name, v.Functions)
}
// Ensure that all files explicitly import runtime/cgo to not trigger an
// error in a compiler complaining about implicitly importing runtime/cgo.
// https://sourcegraph.com/github.com/golang/go/-/blob/src/cmd/link/internal/ld/lib.go?L563:3.
// We also ensure that a root file must exist so the pkg-config headers can
// be written properly for that package.
root := n.MakeFile("")
root.Header().DashImport("runtime/cgo")
for _, postproc := range n.postprocs {
if err := postproc(n); err != nil {
return nil, err
}
}
files := make(map[string][]byte, len(n.Files))
var firstErr error
doFile := func(file FileGenerator) {
b, err := file.Generate()
files[file.Name()] = b
if err != nil && firstErr == nil {
firstErr = errors.Wrapf(err, "%s/v%s/%s", n.PkgName, n.PkgVersion, file.Name())
}
}
for name, file := range n.Files {
if name != file.Name() {
panic(fmt.Errorf(
"file name mismatch: %s != %s (see NamespaceGenerator.Rename)",
name, file.Name()))
}
if file.IsEmpty() {
continue
}
doFile(file)
}
if !n.c.c.IsEmpty() {
doFile(n.cc())
}
if !n.c.h.IsEmpty() || !n.c.c.IsEmpty() {
doFile(n.ch())
}
return files, firstErr
}
func (n *NamespaceGenerator) logIfSkipped(generated bool, what string) {
if !generated {
n.Logln(logger.Skip, what)
}
}