-
Notifications
You must be signed in to change notification settings - Fork 5
/
HRef.ts
292 lines (257 loc) · 5.66 KB
/
HRef.ts
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
/*
* Copyright (c) 2020, J2 Innovations. All Rights Reserved
*/
import { Kind } from './Kind'
import {
HVal,
CANNOT_CHANGE_READONLY_VALUE,
valueInspect,
valueIsKind,
valueMatches,
} from './HVal'
import { HaysonRef } from './hayson'
import { HStr } from './HStr'
import { Node } from '../filter/Node'
import { HGrid } from './HGrid'
import { HList } from './HList'
import { HDict } from './HDict'
import { EvalContext } from '../filter/EvalContext'
import { JsonV3Ref } from './jsonv3'
/**
* Haystack ref.
*/
export class HRef implements HVal {
/**
* The ref's value.
*/
readonly #value: string
/**
* The ref's display name.
*/
readonly #displayName: string
/**
* Constructs a new haystack ref.
*
* @param value The value.
* @param displayName The optional display name.
*/
private constructor(
value: string | HaysonRef | HStr,
displayName?: string
) {
if (valueIsKind<HStr>(value, Kind.Str)) {
value = value.value
}
if (typeof value === 'string') {
if (value.startsWith('@')) {
value = value.substring(1, value.length)
}
this.#value = value
this.#displayName = displayName ?? ''
} else {
const obj = value as HaysonRef
this.#value = obj.val
this.#displayName = obj.dis ?? ''
}
}
/**
* Makes a Haystack ref.
*
* @param value The value or hayson ref.
* @param displayName Optional display string for a reference.
* @returns A haystack ref.
*/
public static make(
value: string | HaysonRef | HRef | HStr,
displayName?: string
): HRef {
if (valueIsKind<HRef>(value, Kind.Ref)) {
return value
} else {
return new HRef(value as string | HaysonRef, displayName)
}
}
/**
* @returns The ref value.
*/
public get value(): string {
return this.#value
}
public set value(value: string) {
throw new Error(CANNOT_CHANGE_READONLY_VALUE)
}
/**
* @returns The display name value in shorthand.
*/
public get dis(): string {
return this.#displayName || this.#value
}
public set dis(value: string) {
throw new Error(CANNOT_CHANGE_READONLY_VALUE)
}
/**
* @returns The display name value.
*/
public get displayName(): string {
return this.dis
}
public set displayName(value: string) {
throw new Error(CANNOT_CHANGE_READONLY_VALUE)
}
/**
* @returns The value's kind.
*/
public getKind(): Kind {
return Kind.Ref
}
/**
* Compares the value's kind.
*
* @param kind The kind to compare against.
* @returns True if the kind matches.
*/
public isKind(kind: Kind): boolean {
return valueIsKind<HRef>(this, kind)
}
/**
* Returns true if the haystack filter matches the value.
*
* @param filter The filter to test.
* @param cx Optional haystack filter evaluation context.
* @returns True if the filter matches ok.
*/
public matches(filter: string | Node, cx?: Partial<EvalContext>): boolean {
return valueMatches(this, filter, cx)
}
/**
* Dump the value to the local console output.
*
* @param message An optional message to display before the value.
* @returns The value instance.
*/
public inspect(message?: string): this {
return valueInspect(this, message)
}
/**
* Encodes to an encoded zinc value that can be used
* in a haystack filter string.
*
* The encoding for a haystack filter is mostly zinc but contains
* some exceptions.
*
* @returns The encoded value that can be used in a haystack filter.
*/
public toFilter(): string {
return this.toZinc(/*excludeDis*/ true)
}
/**
* Value equality check.
*
* @param value The value to test.
* @returns True if the ref is the same.
*/
public equals(value: unknown): boolean {
return valueIsKind<HRef>(value, Kind.Ref) && this.value === value.value
}
/**
* Compares two values.
*
* @param value The value to compare against.
* @returns The sort order as negative, 0, or positive
*/
public compareTo(value: unknown): number {
if (!valueIsKind<HRef>(value, Kind.Ref)) {
return -1
}
if (this.value < value.value) {
return -1
}
if (this.value === value.value) {
return 0
}
return 1
}
/**
* @returns A string representation of the value.
*/
public toString(): string {
return this.toZinc()
}
/**
* @returns The ref's value.
*/
public valueOf(): string {
return this.value
}
/**
* Encode to zinc encoding.
*
* @params excludeDis Excludes the display name from the encoding.
* @returns The encoded zinc string.
*/
public toZinc(excludeDis?: boolean): string {
let zinc = `@${this.value}`
// If there's a display name then also add it.
if (!excludeDis && this.#displayName) {
zinc += ` ${HStr.make(this.#displayName).toZinc()}`
}
return zinc
}
/**
* @returns A JSON reprentation of the object.
*/
public toJSON(): HaysonRef {
const obj: HaysonRef = {
_kind: this.getKind(),
val: this.value,
}
if (this.#displayName) {
obj.dis = this.#displayName
}
return obj
}
/**
* @returns A JSON v3 representation of the object.
*/
public toJSONv3(): JsonV3Ref {
return `r:${this.value}${
this.#displayName ? ` ${this.#displayName}` : ''
}`
}
/**
* @returns An Axon encoded string.
*/
public toAxon(): string {
return this.toZinc(/*excludeDis*/ true)
}
/**
* @returns Returns the value instance.
*/
public newCopy(): HRef {
return this
}
/**
* @returns A ref with no display name.
*/
public noDis(): HRef {
return this.#displayName ? HRef.make(this.#value) : this
}
/**
* @returns The value as a grid.
*/
public toGrid(): HGrid {
return HGrid.make(this)
}
/**
* @returns The value as a list.
*/
public toList(): HList<HRef> {
return HList.make(this)
}
/**
* @returns The value as a dict.
*/
public toDict(): HDict {
return HDict.make(this)
}
}