-
Notifications
You must be signed in to change notification settings - Fork 2
/
options.go
735 lines (632 loc) · 16.5 KB
/
options.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
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
package options
import (
"errors"
"fmt"
"math"
"reflect"
"strconv"
"strings"
"sync"
"time"
)
type (
// OptionChangeHook is called when set an option value.
OptionChangeHook func(opt Option, oldVal, newVal interface{}) error
// ReadOnlyOptions is options set read only.
ReadOnlyOptions interface {
GetOption(opt Option) (val interface{}, ok bool)
GetOptionDefault(opt Option) interface{}
OptionValues() OptionValues
}
// Options is option set.
Options interface {
SetOption(opt Option, val interface{}) (err error)
SetOptionIfNotExists(opt Option, val interface{}) (err error)
ReadOnlyOptions
AddOptionChangeHook(hook OptionChangeHook) Options
}
// Option is an option item.
Option interface {
String() string
DefaultValue() interface{}
Validate(val interface{}) (newVal interface{}, err error)
Parse(s string) (val interface{}, err error)
}
// OptionValues is option/value map
OptionValues = map[Option]interface{}
options struct {
sync.RWMutex
opts map[Option]interface{}
accepts map[Option]bool
subOptions []Options
downstream Options
optionChangeHooks []OptionChangeHook
}
// BaseOption is the base of specific options
BaseOption struct {
defaultValue interface{}
}
// AnyOption is option with any value.
AnyOption interface {
Option
ValueFrom(optss ...Options) interface{}
}
anyOption struct {
BaseOption
}
// BoolOption is option with bool value.
BoolOption interface {
Option
Value(val interface{}) bool
ValueFrom(optss ...Options) bool
}
boolOption struct {
BaseOption
}
// StringOption is option with string value.
StringOption interface {
Option
Value(val interface{}) string
ValueFrom(optss ...Options) string
}
stringOption struct {
BaseOption
}
// TimeDurationOption is option with time duration value.
TimeDurationOption interface {
Option
Value(val interface{}) time.Duration
ValueFrom(optss ...Options) time.Duration
}
timeDurationOption struct {
BaseOption
}
// IntOption is option with int value.
IntOption interface {
Option
Value(val interface{}) int
ValueFrom(optss ...Options) int
}
intOption struct {
BaseOption
}
// Uint8Option is option with uint8 value.
Uint8Option interface {
Option
Value(val interface{}) uint8
ValueFrom(optss ...Options) uint8
}
uint8Option struct {
BaseOption
}
// Uint16Option is option with uint16 value.
Uint16Option interface {
Option
Value(val interface{}) uint16
ValueFrom(optss ...Options) uint16
}
uint16Option struct {
BaseOption
}
// Uint32Option is option with uint32 value.
Uint32Option interface {
Option
Value(val interface{}) uint32
ValueFrom(optss ...Options) uint32
}
uint32Option struct {
BaseOption
}
// Int32Option is option with int32 value.
Int32Option interface {
Option
Value(val interface{}) int32
ValueFrom(optss ...Options) int32
}
int32Option struct {
BaseOption
}
)
// errors
var (
ErrInvalidOptionValue = errors.New("invalid option value")
ErrUnsupportedOption = errors.New("unsupported option")
ErrOptionNotFound = errors.New("option not found")
)
var (
lock sync.RWMutex
registeredOptions = map[string]interface{}{}
optionFullNames = map[Option]string{}
)
// RegisterOption register option
func RegisterOption(opt Option, name string, domains []string) {
lock.Lock()
cur := registeredOptions
for _, d := range domains {
d = strings.ToLower(d)
m := cur[d]
if m == nil {
m = make(map[string]interface{})
cur[d] = m
}
cur = m.(map[string]interface{})
}
cur[strings.ToLower(name)] = opt
optionFullNames[opt] = strings.Join(append(domains, name), ".")
lock.Unlock()
}
// RegisterStructuredOptions register structured options
func RegisterStructuredOptions(opts interface{}, domains []string) {
v := reflect.ValueOf(opts)
for i := 0; i < v.NumField(); i++ {
f := v.Type().Field(i)
fv := v.Field(i).Interface()
if opt, ok := fv.(Option); ok {
// option
RegisterOption(opt, f.Name, domains)
} else {
// structured options
RegisterStructuredOptions(fv, append(domains, f.Name))
}
}
}
// ParseOption parse Option from string.
func ParseOption(s string) (opt Option, err error) {
domains := strings.Split(s, ".")
l := len(domains)
name := strings.ToLower(domains[l-1])
domains = domains[:l-1]
lock.Lock()
var ok bool
cur := registeredOptions
for _, d := range domains {
d = strings.ToLower(d)
m := cur[d]
if m == nil {
return nil, fmt.Errorf("%s: %s", ErrOptionNotFound, s)
}
if cur, ok = m.(map[string]interface{}); !ok {
return nil, fmt.Errorf("%s: %s", ErrOptionNotFound, s)
}
}
if opt, ok = cur[name].(Option); !ok {
return nil, fmt.Errorf("%s: %s", ErrOptionNotFound, s)
}
lock.Unlock()
return
}
// NewOptions create an option set.
func NewOptions() Options {
return NewOptionsWithValues(nil)
}
// NewOptionsWithValues create an option set with option values.
func NewOptionsWithValues(ovs OptionValues) Options {
opts := &options{
opts: make(map[Option]interface{}),
}
for opt, val := range ovs {
opts.SetOption(opt, val)
}
return opts
}
// NewOptionsWithDownStreamsAndAccepts create an option set with down stream and accepts.
func NewOptionsWithDownStreamsAndAccepts(downstream Options, accepts ...Option) Options {
opts := &options{
opts: make(map[Option]interface{}),
downstream: downstream,
accepts: make(map[Option]bool),
}
for _, opt := range accepts {
opts.accepts[opt] = true
}
return opts
}
// NewOptionsWithValuesAndSubs create an option set with values and sub options
func NewOptionsWithValuesAndSubs(ovs OptionValues, subs ...Options) Options {
opts := &options{
opts: make(map[Option]interface{}),
subOptions: subs,
}
for opt, val := range ovs {
opts.SetOption(opt, val)
}
return opts
}
// NewOptionsWithAccepts create an option set with accepts.
func NewOptionsWithAccepts(accepts ...Option) Options {
return NewOptionsWithDownStreamsAndAccepts(nil, accepts...)
}
func (opts *options) acceptOption(opt Option) bool {
return opts.accepts == nil || opts.accepts[opt]
}
func (opts *options) AddOptionChangeHook(hook OptionChangeHook) Options {
opts.Lock()
opts.optionChangeHooks = append(opts.optionChangeHooks, hook)
opts.Unlock()
return opts
}
// SetOption add an option value.
func (opts *options) SetOption(opt Option, val interface{}) (err error) {
if val, err = opt.Validate(val); err != nil {
return
}
if !opts.acceptOption(opt) {
if opts.downstream == nil {
err = ErrUnsupportedOption
return
}
// pass to downstream
return opts.downstream.SetOption(opt, val)
}
opts.Lock()
defer opts.Unlock()
return opts.doSetOption(opt, val)
}
// doSetOption used by other setting functions.
func (opts *options) doSetOption(opt Option, val interface{}) (err error) {
oldVal := opts.opts[opt]
opts.opts[opt] = val
if len(opts.optionChangeHooks) > 0 {
for _, hook := range opts.optionChangeHooks {
opts.Unlock()
if err = hook(opt, oldVal, val); err != nil {
opts.Lock()
return
}
opts.Lock()
}
}
return
}
func (opts *options) SetOptionIfNotExists(opt Option, val interface{}) (err error) {
if val, err = opt.Validate(val); err != nil {
return
}
if !opts.acceptOption(opt) {
if opts.downstream == nil {
err = ErrUnsupportedOption
return
}
// pass to downstream
return opts.downstream.SetOptionIfNotExists(opt, val)
}
opts.Lock()
defer opts.Unlock()
if _, ok := opts.opts[opt]; !ok {
if err = opts.doSetOption(opt, val); err != nil {
return
}
}
return
}
// GetOption get an option value.
func (opts *options) GetOption(opt Option) (val interface{}, ok bool) {
if opts.acceptOption(opt) {
opts.RLock()
val, ok = opts.opts[opt]
opts.RUnlock()
if !ok {
for _, sub := range opts.subOptions {
if val, ok = sub.GetOption(opt); ok {
return
}
}
}
return
} else if opts.downstream != nil {
// pass to downstream
return opts.downstream.GetOption(opt)
}
return
}
// GetOptionDefault get an option value or option default value.
func (opts *options) GetOptionDefault(opt Option) interface{} {
if val, ok := opts.GetOption(opt); ok {
return val
}
return opt.DefaultValue()
}
func (opts *options) OptionValues() (res OptionValues) {
opts.RLock()
res = make(map[Option]interface{})
for opt, val := range opts.opts {
res[opt] = val
}
opts.RUnlock()
return
}
func (o *BaseOption) String() string {
return fmt.Sprintf("<%T:%v>", o.defaultValue, o.defaultValue)
}
// DefaultValue returns the default option value.
func (o *BaseOption) DefaultValue() interface{} {
return o.defaultValue
}
// valueFrom get opt from optss else return default value
func valueFrom(opt Option, optss ...Options) interface{} {
for _, opts := range optss {
if val, ok := opts.GetOption(opt); ok {
return val
}
}
return opt.DefaultValue()
}
// NewAnyOption create an any option
func NewAnyOption(val interface{}) AnyOption {
return &anyOption{BaseOption{val}}
}
// Validate validate the option value
func (o *anyOption) Validate(val interface{}) (newVal interface{}, err error) {
return val, nil
}
func (o *anyOption) Parse(s string) (val interface{}, err error) {
return s, nil
}
func (o *anyOption) ValueFrom(optss ...Options) interface{} {
return valueFrom(o, optss...)
}
// NewBoolOption create a bool option
func NewBoolOption(val bool) BoolOption {
return &boolOption{BaseOption{val}}
}
// Validate validate the option value
func (o *boolOption) Validate(val interface{}) (newVal interface{}, err error) {
if _, ok := val.(bool); !ok {
err = ErrInvalidOptionValue
return
}
newVal = val
return
}
func (o *boolOption) Parse(s string) (val interface{}, err error) {
s = strings.ToLower(s)
switch s {
case "", "true", "t", "1":
return true, nil
case "false", "f", "0":
return false, nil
default:
return nil, fmt.Errorf("%s: %s=>%s", ErrInvalidOptionValue, optionFullNames[o], s)
}
}
// Value get option's value, must ensure option value is not empty
func (o *boolOption) Value(val interface{}) bool {
return val.(bool)
}
func (o *boolOption) ValueFrom(optss ...Options) bool {
return valueFrom(o, optss...).(bool)
}
// NewStringOption create a string option
func NewStringOption(val string) StringOption {
return &stringOption{BaseOption{val}}
}
// Validate validate the option value
func (o *stringOption) Validate(val interface{}) (newVal interface{}, err error) {
if _, ok := val.(string); !ok {
err = ErrInvalidOptionValue
return
}
newVal = val
return
}
func (o *stringOption) Parse(s string) (val interface{}, err error) {
return s, nil
}
// Value get option's value, must ensure option value is not empty
func (o *stringOption) Value(val interface{}) string {
return val.(string)
}
func (o *stringOption) ValueFrom(optss ...Options) string {
return valueFrom(o, optss...).(string)
}
// NewTimeDurationOption create a time duration option
func NewTimeDurationOption(name time.Duration) TimeDurationOption {
return &timeDurationOption{BaseOption{name}}
}
// Validate validate the option value
func (o *timeDurationOption) Validate(val interface{}) (newVal interface{}, err error) {
if _, ok := val.(time.Duration); !ok {
err = ErrInvalidOptionValue
return
}
newVal = val
return
}
func (o *timeDurationOption) Parse(s string) (val interface{}, err error) {
if val, err = time.ParseDuration(s); err != nil {
err = fmt.Errorf("%s: %s=>%s", ErrInvalidOptionValue, optionFullNames[o], s)
}
return
}
// Value get option's value, must ensure option value is not empty
func (o *timeDurationOption) Value(val interface{}) time.Duration {
return val.(time.Duration)
}
func (o *timeDurationOption) ValueFrom(optss ...Options) time.Duration {
return valueFrom(o, optss...).(time.Duration)
}
// NewIntOption create an int option
func NewIntOption(val int) IntOption {
return &intOption{BaseOption{val}}
}
// Validate validate the option value
func (o *intOption) Validate(val interface{}) (newVal interface{}, err error) {
switch x := val.(type) {
case int:
newVal = x
case int64:
newVal = int(x)
default:
err = ErrInvalidOptionValue
}
return
}
func (o *intOption) Parse(s string) (val interface{}, err error) {
if val, err = strconv.ParseInt(s, 10, 0); err != nil {
err = fmt.Errorf("%s: %s=>%s", ErrInvalidOptionValue, optionFullNames[o], s)
}
return
}
// Value get option's value, must ensure option value is not empty
func (o *intOption) Value(val interface{}) int {
return val.(int)
}
func (o *intOption) ValueFrom(optss ...Options) int {
return valueFrom(o, optss...).(int)
}
// NewUint8Option create an uint8 option
func NewUint8Option(val uint8) Uint8Option {
return &uint8Option{BaseOption{val}}
}
// Validate validate the option value
func (o *uint8Option) Validate(val interface{}) (newVal interface{}, err error) {
switch x := val.(type) {
case uint8:
newVal = x
case int:
if x >= 0 && x <= math.MaxUint8 {
newVal = uint8(x)
break
}
err = ErrInvalidOptionValue
case uint64:
if x >= 0 && x <= math.MaxUint8 {
newVal = uint8(x)
break
}
err = ErrInvalidOptionValue
default:
err = ErrInvalidOptionValue
}
return
}
func (o *uint8Option) Parse(s string) (val interface{}, err error) {
if val, err = strconv.ParseUint(s, 10, 8); err != nil {
err = fmt.Errorf("%s: %s=>%s", ErrInvalidOptionValue, optionFullNames[o], s)
}
return
}
// Value get option's value, must ensure option value is not empty
func (o *uint8Option) Value(val interface{}) uint8 {
return val.(uint8)
}
func (o *uint8Option) ValueFrom(optss ...Options) uint8 {
return valueFrom(o, optss...).(uint8)
}
// NewUint16Option create an uint16 option
func NewUint16Option(val uint16) Uint16Option {
return &uint16Option{BaseOption{val}}
}
// Validate validate the option value
func (o *uint16Option) Validate(val interface{}) (newVal interface{}, err error) {
switch x := val.(type) {
case uint16:
newVal = x
case int:
if x >= 0 && x <= math.MaxUint16 {
newVal = uint16(x)
break
}
err = ErrInvalidOptionValue
case uint64:
if x >= 0 && x <= math.MaxUint16 {
newVal = uint16(x)
break
}
err = ErrInvalidOptionValue
default:
err = ErrInvalidOptionValue
}
return
}
func (o *uint16Option) Parse(s string) (val interface{}, err error) {
if val, err = strconv.ParseUint(s, 10, 16); err != nil {
err = fmt.Errorf("%s: %s=>%s", ErrInvalidOptionValue, optionFullNames[o], s)
}
return
}
// Value get option's value, must ensure option value is not empty
func (o *uint16Option) Value(val interface{}) uint16 {
return val.(uint16)
}
func (o *uint16Option) ValueFrom(optss ...Options) uint16 {
return valueFrom(o, optss...).(uint16)
}
// NewUint32Option create an uint32 option
func NewUint32Option(val uint32) Uint32Option {
return &uint32Option{BaseOption{val}}
}
// Validate validate the option value
func (o *uint32Option) Validate(val interface{}) (newVal interface{}, err error) {
switch x := val.(type) {
case uint32:
newVal = x
case int:
if x >= 0 && x <= math.MaxUint32 {
newVal = uint32(x)
break
}
err = ErrInvalidOptionValue
case uint64:
if x >= 0 && x <= math.MaxUint64 {
newVal = uint32(x)
break
}
err = ErrInvalidOptionValue
default:
err = ErrInvalidOptionValue
}
return
}
func (o *uint32Option) Parse(s string) (val interface{}, err error) {
if val, err = strconv.ParseUint(s, 10, 32); err != nil {
err = fmt.Errorf("%s: %s=>%s", ErrInvalidOptionValue, optionFullNames[o], s)
}
return
}
// Value get option's value, must ensure option value is not empty
func (o *uint32Option) Value(val interface{}) uint32 {
return val.(uint32)
}
func (o *uint32Option) ValueFrom(optss ...Options) uint32 {
return valueFrom(o, optss...).(uint32)
}
// NewInt32Option create an int32 option
func NewInt32Option(val int32) Int32Option {
return &int32Option{BaseOption{val}}
}
// Validate validate the option value
func (o *int32Option) Validate(val interface{}) (newVal interface{}, err error) {
switch x := val.(type) {
case int32:
newVal = x
case int:
if x >= math.MinInt32 && x <= math.MaxInt32 {
newVal = int32(x)
break
}
err = ErrInvalidOptionValue
case int64:
if x >= math.MinInt32 && x <= math.MaxInt32 {
newVal = int32(x)
break
}
err = ErrInvalidOptionValue
default:
err = ErrInvalidOptionValue
}
return
}
func (o *int32Option) Parse(s string) (val interface{}, err error) {
if val, err = strconv.ParseInt(s, 10, 32); err != nil {
err = fmt.Errorf("%s: %s=>%s", ErrInvalidOptionValue, optionFullNames[o], s)
}
return
}
// Value get option's value, must ensure option value is not empty
func (o *int32Option) Value(val interface{}) int32 {
return val.(int32)
}
func (o *int32Option) ValueFrom(optss ...Options) int32 {
return valueFrom(o, optss...).(int32)
}