variable length hex

datatype.go

@@ -1,10 +1,11 @@
 package envconf
 
 import (
+	"fmt"
 	"time"
 )
 
-type DataType int
+type DataType uint
 
 const (
 	TypeNone      DataType = iota
@@ -14,28 +15,50 @@ const (
 	TypeString    DataType = iota
 	TypeDirectory DataType = iota
 	TypeBool      DataType = iota
+	TypeHex       DataType = iota
 )
 
+func FixedHex(size uint) DataType {
+	return (DataType)(size<<16) | TypeHex
+}
+
+func (dtype DataType) baseType() DataType {
+	return dtype & 0xffff
+}
+
+func (dtype DataType) typeAndSize() (DataType, uint) {
+	return (dtype & 0xffff), uint(dtype >> 16)
+}
+
 type cValue struct {
 	dtype   DataType
 	intval  int64
 	durval  time.Duration
 	boolval bool
+	binval  []byte
 	strval  string
-	mapval  map[string]cValue
 	err     error
 }
 
 func (dtype DataType) parse(key string, str string) (ret cValue) {
-	info, ok := tInfo[dtype]
+	rdtype, size := dtype.typeAndSize()
+	info, ok := tInfo[rdtype]
 	if ok {
-		return info.parser(key, str)
+		ret = info.parser(key, str, size)
+		if len(ret.binval) == 0 {
+			ret.binval = make([]byte, 0, 0)
+		}
 	}
 	return
 }
+
 func (dtype DataType) String() string {
-	info, ok := tInfo[dtype]
+	rdtype, size := dtype.typeAndSize()
+	info, ok := tInfo[rdtype]
 	if ok {
+		if size > 0 {
+			return fmt.Sprintf("%s%d", info.name, size)
+		}
 		return info.name
 	}
 	return "invalid"

envconf.go

@@ -4,6 +4,7 @@ import (
 	"errors"
 	"fmt"
 	"os"
+	"regexp"
 	"strings"
 	"time"
 	"unicode"
@@ -38,46 +39,42 @@ func NewConfig() *Config {
 		splitted := strings.SplitN(v, "=", 2)
 		if len(splitted) == 2 {
 			key := cleanKey(splitted[0])
-			keysplit := strings.Split(key, "_")
-			left := ""
-			right := ""
-
-			if len(keysplit) > 1 {
-				left = strings.Join(keysplit[:len(keysplit)-1], "_")
-				right = keysplit[len(keysplit)-1]
-			}
+			left, right, mappable := keySplit(key)
 
 			if unicode.IsLetter(getFirstRune(key)) {
-				if len(config.mapEnv[left]) == 0 {
-					config.mapEnv[left] = make(map[string]cEntry)
-				}
 				var entry cEntry
 				entry.value = splitted[1]
 				entry.dtype = TypeNone
 				entry.unset = false
 				entry.empty = false
 				config.env[key] = entry
+				if mappable {
+					if len(config.mapEnv[left]) == 0 {
+						config.mapEnv[left] = make(map[string]cEntry)
+					}
+
 					config.mapEnv[left][right] = entry
 				}
 			}
 		}
+	}
 	return config
 }
 
 // Define the type of an environment variable.
 // Variables without a defined type will be ignored by Parse.
 func (c *Config) Define(key string, dtype DataType) {
-	upper := strings.ToUpper(key)
-	entry, ok := c.env[upper]
+	key = cleanKey(key)
+	entry, ok := c.env[key]
 	if ok {
 		entry.dtype = dtype
-		c.env[upper] = entry
+		c.env[key] = entry
 	} else {
 		var entry cEntry
 		entry.dtype = dtype
 		entry.unset = true
 		entry.empty = true
-		c.env[upper] = entry
+		c.env[key] = entry
 	}
 }
 
@@ -97,8 +94,8 @@ func (c *Config) DefineMap(key string, dtype DataType) {
 // Define the type and default value of an environment variable.
 // Variables without a defined type will be ignored by Parse.
 func (c *Config) DefineDefault(key string, val string, dtype DataType) {
-	upper := strings.ToUpper(key)
-	entry, ok := c.env[upper]
+	key = cleanKey(key)
+	entry, ok := c.env[key]
 	if ok {
 		if entry.unset {
 			entry.value = val
@@ -107,7 +104,7 @@ func (c *Config) DefineDefault(key string, val string, dtype DataType) {
 		entry.empty = false
 		entry.defval = val
 		entry.hasdef = true
-		c.env[upper] = entry
+		c.env[key] = entry
 	} else {
 		var entry cEntry
 		entry.dtype = dtype
@@ -116,7 +113,7 @@ func (c *Config) DefineDefault(key string, val string, dtype DataType) {
 		entry.value = val
 		entry.defval = val
 		entry.hasdef = true
-		c.env[upper] = entry
+		c.env[key] = entry
 	}
 }
 
@@ -261,7 +258,8 @@ func (c *Config) Status() (ok bool) {
 	return
 }
 
-func cleanKey(str string) string {
+func cleanKey(key string) string {
+	expr := regexp.MustCompile("__+")
 	fn := func(r rune) rune {
 		if (r >= '0' && r <= '9') || (r >= 'A' && r <= 'Z') || r == '_' {
 			return r
@@ -269,25 +267,27 @@ func cleanKey(str string) string {
 		return -1
 	}
 
-	str = strings.Map(fn, strings.ToUpper(str))
+	key = strings.Trim(strings.Map(fn, strings.ToUpper(key)), "_")
+	return expr.ReplaceAllString(key, "_")
+}
 
-	oldlen := len(str) + 1
-	newlen := len(str)
-	for newlen < oldlen {
-		oldlen = newlen
-		str = strings.ReplaceAll(str, "__", "_")
-		newlen = len(str)
+func keySplit(key string) (left string, right string, ok bool) {
+	key = cleanKey(key)
+	pos := strings.LastIndex(key, "_")
+	ok = false
+	if (pos+1 < len(key)) && (pos > 1) {
+		return cleanKey(key[:pos]), cleanKey(key[pos:]), true
 	}
-
-	return str
+	return
 }
 
 func (c *Config) getRaw(key string, dtype DataType) (val cValue) {
 	val.dtype = TypeNone
+	val.binval = make([]byte, 0, 0)
 	if c.parsed {
-		upper := strings.ToUpper(key)
-		entry, ok := c.env[upper]
-		if ok && (entry.dtype == dtype) {
+		key = cleanKey(key)
+		entry, ok := c.env[key]
+		if ok && (entry.dtype.baseType() == dtype.baseType()) {
 			return entry.parsed
 		}
 	}
@@ -303,7 +303,7 @@ func (c *Config) getRawMap(key string, dtype DataType) (empty map[string]cValue)
 
 		if ok {
 			for k, v := range entries {
-				if v.dtype == dtype {
+				if (v.dtype.baseType() == dtype.baseType()) && (v.parsed.err == nil) {
 					retval[k] = v.parsed
 				} else {
 					return
@@ -315,21 +315,28 @@ func (c *Config) getRawMap(key string, dtype DataType) (empty map[string]cValue)
 	return
 }
 
-// GetInt returns the value of an environment variable.
+// Returns the value of an environment variable.
 // If the variable is not defined as envconf.TypeInt the function will return 0.
 func (c *Config) GetInt(key string) int64 {
 	val := c.getRaw(key, TypeInt)
 	return val.intval
 }
 
-// GetMetric returns the value of an environment variable.
+// Returns the value of an environment variable.
+// If the variable is not defined as envconf.TypeHex the function will return []byte{}.
+func (c *Config) GetHex(key string) []byte {
+	val := c.getRaw(key, TypeHex)
+	return val.binval
+}
+
+// Returns the value of an environment variable.
 // If the variable is not defined as envconf.TypeMetric the function will return 0.
 func (c *Config) GetMetric(key string) int64 {
 	val := c.getRaw(key, TypeMetric)
 	return val.intval
 }
 
-// GetDirectory returns the value of an environment variable.
+// Returns the value of an environment variable.
 // If the variable is not defined as envconf.TypeDirectory the
 // function will return the empty string.
 func (c *Config) GetDirectory(key string) string {
@@ -337,7 +344,7 @@ func (c *Config) GetDirectory(key string) string {
 	return val.strval
 }
 
-// GetString returns the value of an environment variable.
+// Returns the value of an environment variable.
 // If the variable is not defined as envconf.TypeString the
 // function will return the empty string.
 func (c *Config) GetString(key string) string {
@@ -345,7 +352,7 @@ func (c *Config) GetString(key string) string {
 	return val.strval
 }
 
-// GetDuration returns the value of an environment variable.
+// Returns the value of an environment variable.
 // If the variable is not defined as envconf.TypeDuration the
 // function will return time.Duration(0).
 func (c *Config) GetDuration(key string) time.Duration {
@@ -353,7 +360,7 @@ func (c *Config) GetDuration(key string) time.Duration {
 	return val.durval
 }
 
-// GetBool returns the value of an environment variable.
+// Returns the value of an environment variable.
 // If the variable is not defined as envconf.TypeBool the
 // function will return false.
 func (c *Config) GetBool(key string) bool {
@@ -393,6 +400,14 @@ func (c *Config) GetMapBool(key string) (retval map[string]bool) {
 	return
 }
 
+func (c *Config) GetMapHex(key string) (retval map[string][]byte) {
+	retval = make(map[string][]byte)
+	for k, v := range c.getRawMap(key, TypeHex) {
+		retval[k] = v.binval
+	}
+	return
+}
+
 func getFirstRune(str string) rune {
 	for _, v := range str {
 		return v

parsers.go

@@ -1,6 +1,7 @@
 package envconf
 
 import (
+	"encoding/hex"
 	"errors"
 	"fmt"
 	"os"
@@ -10,7 +11,7 @@ import (
 	"time"
 )
 
-func parseInt(key string, str string) (ret cValue) {
+func parseInt(key string, str string, _ uint) (ret cValue) {
 	val, err := strconv.ParseInt(str, 10, 64)
 	if err == nil {
 		ret.intval = val
@@ -20,7 +21,7 @@ func parseInt(key string, str string) (ret cValue) {
 	return
 }
 
-func parseMetric(key string, str string) (ret cValue) {
+func parseMetric(key string, str string, _ uint) (ret cValue) {
 	mod := int64(1)
 	str = strings.ToUpper(str)
 	if strings.HasSuffix(str, "K") {
@@ -45,7 +46,7 @@ func parseMetric(key string, str string) (ret cValue) {
 	return
 }
 
-func parseDuration(key string, str string) (ret cValue) {
+func parseDuration(key string, str string, _ uint) (ret cValue) {
 	val, err := time.ParseDuration(str)
 	if err == nil {
 		ret.durval = val
@@ -55,7 +56,7 @@ func parseDuration(key string, str string) (ret cValue) {
 	return
 }
 
-func parseBool(key string, str string) (ret cValue) {
+func parseBool(key string, str string, _ uint) (ret cValue) {
 	val, err := strconv.ParseBool(str)
 	if err == nil {
 		ret.boolval = val
@@ -65,7 +66,21 @@ func parseBool(key string, str string) (ret cValue) {
 	return
 }
 
-func parseDirectory(_ string, str string) (ret cValue) {
+func parseHex(key string, str string, size uint) (ret cValue) {
+	val, err := hex.DecodeString(str)
+	if err == nil && (size == 0 || size == uint(len(val))) {
+		ret.binval = val
+	} else {
+		if size == 0 {
+			ret.err = errors.New(fmt.Sprintf(`Environment variable "%s" is not of type hex.`, key))
+		} else {
+			ret.err = errors.New(fmt.Sprintf(`Environment variable "%s" is not of type hex%d.`, key, size))
+		}
+	}
+	return
+}
+
+func parseDirectory(_ string, str string, _ uint) (ret cValue) {
 	wd, err := os.Getwd()
 	if err == nil {
 		if path.IsAbs(str) {
@@ -79,7 +94,7 @@ func parseDirectory(_ string, str string) (ret cValue) {
 	return
 }
 
-func parseString(_ string, str string) (ret cValue) {
+func parseString(_ string, str string, _ uint) (ret cValue) {
 	ret.strval = str
 	return
 }

typeinfo.go

@@ -1,7 +1,7 @@
 package envconf
 
 type dataTypeInfo struct {
-	parser func(string, string) cValue
+	parser func(string, string, uint) cValue
 	name   string
 }
 
@@ -14,6 +14,8 @@ func init() {
 	var durInfo dataTypeInfo
 	var strInfo dataTypeInfo
 	var dirInfo dataTypeInfo
+	var hexInfo dataTypeInfo
+
 	var boolInfo dataTypeInfo
 
 	intInfo.name = "int"
@@ -21,6 +23,7 @@ func init() {
 	durInfo.name = "duration"
 	dirInfo.name = "directory"
 	strInfo.name = "string"
+	hexInfo.name = "hex"
 	boolInfo.name = "bool"
 
 	intInfo.parser = parseInt
@@ -28,6 +31,8 @@ func init() {
 	durInfo.parser = parseDuration
 	dirInfo.parser = parseDirectory
 	strInfo.parser = parseString
+
+	hexInfo.parser = parseHex
 	boolInfo.parser = parseBool
 
 	tInfo[TypeInt] = intInfo
@@ -35,5 +40,6 @@ func init() {
 	tInfo[TypeDuration] = durInfo
 	tInfo[TypeString] = strInfo
 	tInfo[TypeDirectory] = dirInfo
+	tInfo[TypeHex] = hexInfo
 	tInfo[TypeBool] = boolInfo
 }