| // Copyright 2014 Unknwon |
| // |
| // 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 ini |
| |
| import ( |
| "bytes" |
| "errors" |
| "fmt" |
| "reflect" |
| "time" |
| "unicode" |
| ) |
| |
| // NameMapper represents a ini tag name mapper. |
| type NameMapper func(string) string |
| |
| // Built-in name getters. |
| var ( |
| // AllCapsUnderscore converts to format ALL_CAPS_UNDERSCORE. |
| AllCapsUnderscore NameMapper = func(raw string) string { |
| newstr := make([]rune, 0, len(raw)) |
| for i, chr := range raw { |
| if isUpper := 'A' <= chr && chr <= 'Z'; isUpper { |
| if i > 0 { |
| newstr = append(newstr, '_') |
| } |
| } |
| newstr = append(newstr, unicode.ToUpper(chr)) |
| } |
| return string(newstr) |
| } |
| // TitleUnderscore converts to format title_underscore. |
| TitleUnderscore NameMapper = func(raw string) string { |
| newstr := make([]rune, 0, len(raw)) |
| for i, chr := range raw { |
| if isUpper := 'A' <= chr && chr <= 'Z'; isUpper { |
| if i > 0 { |
| newstr = append(newstr, '_') |
| } |
| chr -= ('A' - 'a') |
| } |
| newstr = append(newstr, chr) |
| } |
| return string(newstr) |
| } |
| ) |
| |
| func (s *Section) parseFieldName(raw, actual string) string { |
| if len(actual) > 0 { |
| return actual |
| } |
| if s.f.NameMapper != nil { |
| return s.f.NameMapper(raw) |
| } |
| return raw |
| } |
| |
| func parseDelim(actual string) string { |
| if len(actual) > 0 { |
| return actual |
| } |
| return "," |
| } |
| |
| var reflectTime = reflect.TypeOf(time.Now()).Kind() |
| |
| // setWithProperType sets proper value to field based on its type, |
| // but it does not return error for failing parsing, |
| // because we want to use default value that is already assigned to strcut. |
| func setWithProperType(t reflect.Type, key *Key, field reflect.Value, delim string) error { |
| switch t.Kind() { |
| case reflect.String: |
| if len(key.String()) == 0 { |
| return nil |
| } |
| field.SetString(key.String()) |
| case reflect.Bool: |
| boolVal, err := key.Bool() |
| if err != nil { |
| return nil |
| } |
| field.SetBool(boolVal) |
| case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64: |
| durationVal, err := key.Duration() |
| if err == nil { |
| field.Set(reflect.ValueOf(durationVal)) |
| return nil |
| } |
| |
| intVal, err := key.Int64() |
| if err != nil { |
| return nil |
| } |
| field.SetInt(intVal) |
| // byte is an alias for uint8, so supporting uint8 breaks support for byte |
| case reflect.Uint, reflect.Uint16, reflect.Uint32, reflect.Uint64: |
| durationVal, err := key.Duration() |
| if err == nil { |
| field.Set(reflect.ValueOf(durationVal)) |
| return nil |
| } |
| |
| uintVal, err := key.Uint64() |
| if err != nil { |
| return nil |
| } |
| field.SetUint(uintVal) |
| |
| case reflect.Float64: |
| floatVal, err := key.Float64() |
| if err != nil { |
| return nil |
| } |
| field.SetFloat(floatVal) |
| case reflectTime: |
| timeVal, err := key.Time() |
| if err != nil { |
| return nil |
| } |
| field.Set(reflect.ValueOf(timeVal)) |
| case reflect.Slice: |
| vals := key.Strings(delim) |
| numVals := len(vals) |
| if numVals == 0 { |
| return nil |
| } |
| |
| sliceOf := field.Type().Elem().Kind() |
| |
| var times []time.Time |
| if sliceOf == reflectTime { |
| times = key.Times(delim) |
| } |
| |
| slice := reflect.MakeSlice(field.Type(), numVals, numVals) |
| for i := 0; i < numVals; i++ { |
| switch sliceOf { |
| case reflectTime: |
| slice.Index(i).Set(reflect.ValueOf(times[i])) |
| default: |
| slice.Index(i).Set(reflect.ValueOf(vals[i])) |
| } |
| } |
| field.Set(slice) |
| default: |
| return fmt.Errorf("unsupported type '%s'", t) |
| } |
| return nil |
| } |
| |
| func (s *Section) mapTo(val reflect.Value) error { |
| if val.Kind() == reflect.Ptr { |
| val = val.Elem() |
| } |
| typ := val.Type() |
| |
| for i := 0; i < typ.NumField(); i++ { |
| field := val.Field(i) |
| tpField := typ.Field(i) |
| |
| tag := tpField.Tag.Get("ini") |
| if tag == "-" { |
| continue |
| } |
| |
| fieldName := s.parseFieldName(tpField.Name, tag) |
| if len(fieldName) == 0 || !field.CanSet() { |
| continue |
| } |
| |
| isAnonymous := tpField.Type.Kind() == reflect.Ptr && tpField.Anonymous |
| isStruct := tpField.Type.Kind() == reflect.Struct |
| if isAnonymous { |
| field.Set(reflect.New(tpField.Type.Elem())) |
| } |
| |
| if isAnonymous || isStruct { |
| if sec, err := s.f.GetSection(fieldName); err == nil { |
| if err = sec.mapTo(field); err != nil { |
| return fmt.Errorf("error mapping field(%s): %v", fieldName, err) |
| } |
| continue |
| } |
| } |
| |
| if key, err := s.GetKey(fieldName); err == nil { |
| if err = setWithProperType(tpField.Type, key, field, parseDelim(tpField.Tag.Get("delim"))); err != nil { |
| return fmt.Errorf("error mapping field(%s): %v", fieldName, err) |
| } |
| } |
| } |
| return nil |
| } |
| |
| // MapTo maps section to given struct. |
| func (s *Section) MapTo(v interface{}) error { |
| typ := reflect.TypeOf(v) |
| val := reflect.ValueOf(v) |
| if typ.Kind() == reflect.Ptr { |
| typ = typ.Elem() |
| val = val.Elem() |
| } else { |
| return errors.New("cannot map to non-pointer struct") |
| } |
| |
| return s.mapTo(val) |
| } |
| |
| // MapTo maps file to given struct. |
| func (f *File) MapTo(v interface{}) error { |
| return f.Section("").MapTo(v) |
| } |
| |
| // MapTo maps data sources to given struct with name mapper. |
| func MapToWithMapper(v interface{}, mapper NameMapper, source interface{}, others ...interface{}) error { |
| cfg, err := Load(source, others...) |
| if err != nil { |
| return err |
| } |
| cfg.NameMapper = mapper |
| return cfg.MapTo(v) |
| } |
| |
| // MapTo maps data sources to given struct. |
| func MapTo(v, source interface{}, others ...interface{}) error { |
| return MapToWithMapper(v, nil, source, others...) |
| } |
| |
| // reflectWithProperType does the opposite thing with setWithProperType. |
| func reflectWithProperType(t reflect.Type, key *Key, field reflect.Value, delim string) error { |
| switch t.Kind() { |
| case reflect.String: |
| key.SetValue(field.String()) |
| case reflect.Bool, |
| reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, |
| reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, |
| reflect.Float64, |
| reflectTime: |
| key.SetValue(fmt.Sprint(field)) |
| case reflect.Slice: |
| vals := field.Slice(0, field.Len()) |
| if field.Len() == 0 { |
| return nil |
| } |
| |
| var buf bytes.Buffer |
| isTime := fmt.Sprint(field.Type()) == "[]time.Time" |
| for i := 0; i < field.Len(); i++ { |
| if isTime { |
| buf.WriteString(vals.Index(i).Interface().(time.Time).Format(time.RFC3339)) |
| } else { |
| buf.WriteString(fmt.Sprint(vals.Index(i))) |
| } |
| buf.WriteString(delim) |
| } |
| key.SetValue(buf.String()[:buf.Len()-1]) |
| default: |
| return fmt.Errorf("unsupported type '%s'", t) |
| } |
| return nil |
| } |
| |
| func (s *Section) reflectFrom(val reflect.Value) error { |
| if val.Kind() == reflect.Ptr { |
| val = val.Elem() |
| } |
| typ := val.Type() |
| |
| for i := 0; i < typ.NumField(); i++ { |
| field := val.Field(i) |
| tpField := typ.Field(i) |
| |
| tag := tpField.Tag.Get("ini") |
| if tag == "-" { |
| continue |
| } |
| |
| fieldName := s.parseFieldName(tpField.Name, tag) |
| if len(fieldName) == 0 || !field.CanSet() { |
| continue |
| } |
| |
| if (tpField.Type.Kind() == reflect.Ptr && tpField.Anonymous) || |
| (tpField.Type.Kind() == reflect.Struct) { |
| // Note: The only error here is section doesn't exist. |
| sec, err := s.f.GetSection(fieldName) |
| if err != nil { |
| // Note: fieldName can never be empty here, ignore error. |
| sec, _ = s.f.NewSection(fieldName) |
| } |
| if err = sec.reflectFrom(field); err != nil { |
| return fmt.Errorf("error reflecting field(%s): %v", fieldName, err) |
| } |
| continue |
| } |
| |
| // Note: Same reason as secion. |
| key, err := s.GetKey(fieldName) |
| if err != nil { |
| key, _ = s.NewKey(fieldName, "") |
| } |
| if err = reflectWithProperType(tpField.Type, key, field, parseDelim(tpField.Tag.Get("delim"))); err != nil { |
| return fmt.Errorf("error reflecting field(%s): %v", fieldName, err) |
| } |
| |
| } |
| return nil |
| } |
| |
| // ReflectFrom reflects secion from given struct. |
| func (s *Section) ReflectFrom(v interface{}) error { |
| typ := reflect.TypeOf(v) |
| val := reflect.ValueOf(v) |
| if typ.Kind() == reflect.Ptr { |
| typ = typ.Elem() |
| val = val.Elem() |
| } else { |
| return errors.New("cannot reflect from non-pointer struct") |
| } |
| |
| return s.reflectFrom(val) |
| } |
| |
| // ReflectFrom reflects file from given struct. |
| func (f *File) ReflectFrom(v interface{}) error { |
| return f.Section("").ReflectFrom(v) |
| } |
| |
| // ReflectFrom reflects data sources from given struct with name mapper. |
| func ReflectFromWithMapper(cfg *File, v interface{}, mapper NameMapper) error { |
| cfg.NameMapper = mapper |
| return cfg.ReflectFrom(v) |
| } |
| |
| // ReflectFrom reflects data sources from given struct. |
| func ReflectFrom(cfg *File, v interface{}) error { |
| return ReflectFromWithMapper(cfg, v, nil) |
| } |