File: imports.go

package info (click to toggle)
golang-github-cue-lang-cue 0.12.0.-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 19,072 kB
  • sloc: sh: 57; makefile: 17
file content (185 lines) | stat: -rw-r--r-- 5,199 bytes parent folder | download
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
// Copyright 2020 CUE Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package runtime

import (
	"path"
	"sync"

	"cuelang.org/go/cue/build"
	"cuelang.org/go/cue/errors"
	"cuelang.org/go/internal"
	"cuelang.org/go/internal/core/adt"
	"cuelang.org/go/internal/cueexperiment"
)

type PackageFunc func(ctx adt.Runtime) (*adt.Vertex, errors.Error)

func RegisterBuiltin(importPath string, f PackageFunc) {
	sharedIndex.RegisterBuiltin(importPath, f)
}

func (x *index) RegisterBuiltin(importPath string, f PackageFunc) {
	if x.builtinPaths == nil {
		x.builtinPaths = map[string]PackageFunc{}
		x.builtinShort = map[string]string{}
	}
	x.builtinPaths[importPath] = f
	base := path.Base(importPath)
	if _, ok := x.builtinShort[base]; ok {
		importPath = "" // Don't allow ambiguous base paths.
	}
	x.builtinShort[base] = importPath
}

// We use a sync.OnceValue below so that cueexperiment.Init is only called
// the first time that the API is used, letting the user set $CUE_EXPERIMENT globally
// as part of their package init if they want to.
var SharedRuntime = sync.OnceValue(func() *Runtime {
	r := &Runtime{index: sharedIndex}
	// The version logic below is copied from [Runtime.Init];
	// consider refactoring to share the code if it gets any more complicated.
	//
	// TODO(mvdan,mpvl): Note that SharedRuntime follows the globally set evaluator version,
	// which may be different than what was supplied via Go code for each context like
	// via cuecontext.EvaluatorVersion(cuecontext.EvalV3).
	// This does not cause issues between evalv2 and evalv3 as they use the same ADT,
	// but future evaluator versions may not be compatible at that level.
	// We should consider using one SharedRuntime per evaluator version,
	// or getting rid of SharedRuntime altogether.
	cueexperiment.Init()
	if cueexperiment.Flags.EvalV3 {
		r.version = internal.DevVersion
	} else {
		r.version = internal.DefaultVersion
	}
	return r
})

// BuiltinPackagePath converts a short-form builtin package identifier to its
// full path or "" if this doesn't exist.
func (x *Runtime) BuiltinPackagePath(path string) string {
	return x.index.shortBuiltinToPath(path)
}

// sharedIndex is used for indexing builtins and any other labels common to
// all instances.
var sharedIndex = newIndex()

// index maps conversions from label names to internal codes.
//
// All instances belonging to the same package should share this index.
type index struct {
	// lock is used to guard imports-related maps.
	// TODO: makes these per cuecontext.
	lock           sync.RWMutex
	imports        map[*adt.Vertex]*build.Instance
	importsByPath  map[string]*adt.Vertex
	importsByBuild map[*build.Instance]*adt.Vertex

	nextUniqueID uint64

	// These are initialized during Go package initialization time and do not
	// need to be guarded.
	builtinPaths map[string]PackageFunc // Full path
	builtinShort map[string]string      // Commandline shorthand

	typeCache sync.Map // map[reflect.Type]evaluated
}

func (i *index) getNextUniqueID() uint64 {
	// TODO: use atomic increment instead.
	i.lock.Lock()
	i.nextUniqueID++
	x := i.nextUniqueID
	i.lock.Unlock()
	return x
}

func newIndex() *index {
	i := &index{
		imports:        map[*adt.Vertex]*build.Instance{},
		importsByPath:  map[string]*adt.Vertex{},
		importsByBuild: map[*build.Instance]*adt.Vertex{},
	}
	return i
}

func (x *index) shortBuiltinToPath(id string) string {
	if x == nil || x.builtinPaths == nil {
		return ""
	}
	return x.builtinShort[id]
}

func (r *Runtime) AddInst(path string, key *adt.Vertex, p *build.Instance) {
	r.index.lock.Lock()
	defer r.index.lock.Unlock()

	x := r.index
	if key == nil {
		panic("key must not be nil")
	}
	x.imports[key] = p
	x.importsByBuild[p] = key
	if path != "" {
		x.importsByPath[path] = key
	}
}

func (r *Runtime) GetInstanceFromNode(key *adt.Vertex) *build.Instance {
	r.index.lock.RLock()
	defer r.index.lock.RUnlock()

	return r.index.imports[key]
}

func (r *Runtime) getNodeFromInstance(key *build.Instance) *adt.Vertex {
	r.index.lock.RLock()
	defer r.index.lock.RUnlock()

	return r.index.importsByBuild[key]
}

func (r *Runtime) LoadImport(importPath string) *adt.Vertex {
	r.index.lock.Lock()
	defer r.index.lock.Unlock()

	x := r.index

	key := x.importsByPath[importPath]
	if key != nil {
		return key
	}

	if x.builtinPaths != nil {
		if f := x.builtinPaths[importPath]; f != nil {
			p, err := f(r)
			if err != nil {
				return adt.ToVertex(&adt.Bottom{Err: err})
			}
			inst := &build.Instance{
				ImportPath: importPath,
				PkgName:    path.Base(importPath),
			}
			x.imports[p] = inst
			x.importsByPath[importPath] = p
			x.importsByBuild[inst] = p
			return p
		}
	}

	return key
}