kconfig

Documentation

Index

• Constants
• type ConfigType
• type DefaultValue
• type DotConfigFile
  • func ParseConfig(file string) (*DotConfigFile, error)
  • func ParseConfigData(data []byte) (*DotConfigFile, error)
  • func (cf *DotConfigFile) Clone() *DotConfigFile
  • func (cf *DotConfigFile) ModToNo()
  • func (cf *DotConfigFile) ModToYes()
  • func (cf *DotConfigFile) Serialize() []byte
  • func (cf *DotConfigFile) Set(name, val string)
  • func (cf *DotConfigFile) Unset(name string)
  • func (cf *DotConfigFile) Value(name string) string
• type KConfigFile
  • func Parse(file string, env ...*KeyValue) (*KConfigFile, error)
  • func ParseData(data []byte, file string, extra ...*KeyValue) (*KConfigFile, error)
• type KConfigMenu
  • func (m *KConfigMenu) DependsOn() map[string]bool
• type KConfigPrompt
• type KeyValue
  • func NewKeyValue(line string) (string, *KeyValue)
  • func (kv *KeyValue) MarshalYAML() (interface{}, error)
  • func (kv KeyValue) String() string
• type KeyValueMap
  • func NewKeyValueMapFromFile(file string) (KeyValueMap, error)
  • func NewKeyValueMapFromMap(values map[string]interface{}) KeyValueMap
  • func NewKeyValueMapFromSlice(values ...interface{}) KeyValueMap
  • func (kvm KeyValueMap) Get(key string) (*KeyValue, bool)
  • func (kvm KeyValueMap) MarshalYAML() (interface{}, error)
  • func (kvm KeyValueMap) Override(extra ...*KeyValue) KeyValueMap
  • func (kvm KeyValueMap) OverrideBy(other KeyValueMap) KeyValueMap
  • func (kvm KeyValueMap) RemoveEmpty() KeyValueMap
  • func (kvm KeyValueMap) Resolve(lookupFn func(string) (string, bool)) KeyValueMap
  • func (kvm KeyValueMap) Set(key, value string) KeyValueMap
  • func (kvm KeyValueMap) Slice() []*KeyValue
  • func (kvm KeyValueMap) String() string
  • func (kvm KeyValueMap) Unset(key string) KeyValueMap
• type MenuKind

Constants

const (
	Yes    = "y"
	Mod    = "m"
	No     = "---===[[[is not set]]]===---" // to make it more obvious when some code writes it directly
	Prefix = "CONFIG_"
)

const (
	MenuConfig  = MenuKind("config")
	MenuGroup   = MenuKind("group")
	MenuChoice  = MenuKind("choice")
	MenuComment = MenuKind("comment")
)

const (
	TypeBool     = ConfigType("bool")
	TypeTristate = ConfigType("tristate")
	TypeString   = ConfigType("string")
	TypeInt      = ConfigType("int")
	TypeHex      = ConfigType("hex")
)

const DotConfigFileName = ".config"

Types

type ConfigType

type ConfigType string

type DefaultValue

type DefaultValue struct {
	Value     expr `json:"value,omitempty"`
	Condition expr `json:"condition,omitempty"`
}

type DotConfigFile

type DotConfigFile struct {
	Slice []*KeyValue
	Map   KeyValueMap // duplicates Configs for convenience
	// contains filtered or unexported fields
}

DotConfigFile represents a parsed .config file. It should not be modified directly, only by means of calling methods. The only exception is Config.Value which may be modified directly. Note: config names don't include CONFIG_ prefix, here and in other public interfaces, users of this package should never mention CONFIG_. Use Yes/Mod/No consts to check for/set config to particular values.

func ParseConfig

func ParseConfig(file string) (*DotConfigFile, error)

func ParseConfigData

func ParseConfigData(data []byte) (*DotConfigFile, error)

func (*DotConfigFile) Clone

func (cf *DotConfigFile) Clone() *DotConfigFile

func (*DotConfigFile) ModToNo

func (cf *DotConfigFile) ModToNo()

func (*DotConfigFile) ModToYes

func (cf *DotConfigFile) ModToYes()

func (*DotConfigFile) Serialize

func (cf *DotConfigFile) Serialize() []byte

func (*DotConfigFile) Set

func (cf *DotConfigFile) Set(name, val string)

Set changes config value, or adds it if it's not yet present.

func (*DotConfigFile) Unset

func (cf *DotConfigFile) Unset(name string)

Unset sets config value to No, if it's present in the config.

func (*DotConfigFile) Value

func (cf *DotConfigFile) Value(name string) string

Value returns config value, or No if it's not present at all.

type KConfigFile

type KConfigFile struct {
	// Root is the main menu
	Root *KConfigMenu `json:"root,omitempty"`

	// All config/menuconfig entries
	Configs map[string]*KConfigMenu `json:"configs,omitempty"`
}

KConfigFile represents a parsed Kconfig file (including includes).

func Parse

func Parse(file string, env ...*KeyValue) (*KConfigFile, error)

func ParseData

func ParseData(data []byte, file string, extra ...*KeyValue) (*KConfigFile, error)

type KConfigMenu

type KConfigMenu struct {
	// Kind represents the structure type, e.g. config/menu/choice/etc
	Kind MenuKind `json:"kind,omitempty"`

	// Type of menu element, e.g. tristate/bool/string/etc
	Type ConfigType `json:"type,omitempty"`

	// Name without CONFIG_
	Name string `json:"name,omitempty"`

	// Sub-elements for menus
	Children []*KConfigMenu `json:"children,omitempty"`

	// Prompt is the 1-line description of the menu entry.
	Prompt KConfigPrompt `json:"prompt,omitempty"`

	// Help information about the menu item.
	Help string `json:"help,omitempty"`

	// Default value of the entry.
	Default DefaultValue `json:"default,omitempty"`
	// contains filtered or unexported fields
}

KConfigMenu represents a single hierarchical menu or config.

func (*KConfigMenu) DependsOn

func (m *KConfigMenu) DependsOn() map[string]bool

DependsOn returns all transitive configs this config depends on.

type KConfigPrompt

type KConfigPrompt struct {
	Text      string `json:"text,omitempty"`
	Condition expr   `json:"condition,omitempty"`
}

type KeyValue

type KeyValue struct {
	Key   string
	Value string
	// contains filtered or unexported fields
}

KeyValue represents a KConfig option with its name and its value.

func NewKeyValue

func NewKeyValue(line string) (string, *KeyValue)

NewKeyValue returns a populated KeyValue by parsing the input line

func (*KeyValue) MarshalYAML

func (kv *KeyValue) MarshalYAML() (interface{}, error)

MarshalYAML makes KeyValue implement yaml.Marshaller

func (KeyValue) String

func (kv KeyValue) String() string

String implements fmt.Stringer

type KeyValueMap

type KeyValueMap map[string]*KeyValue

KeyValueMap is a map of KeyValues

func NewKeyValueMapFromFile

func NewKeyValueMapFromFile(file string) (KeyValueMap, error)

NewKConfigValuesFromFile build a KConfigValues from a provided file path

func NewKeyValueMapFromMap

func NewKeyValueMapFromMap(values map[string]interface{}) KeyValueMap

NewKeyValueMapFromMap build a new Mapping from a set of KEY=VALUE strings

func NewKeyValueMapFromSlice

func NewKeyValueMapFromSlice(values ...interface{}) KeyValueMap

NewKeyValueMapFromSlice build a new Mapping from a set of KEY=VALUE strings

func (KeyValueMap) Get

func (kvm KeyValueMap) Get(key string) (*KeyValue, bool)

Get returns a KeyValue based on a key and a boolean result value if the entries was resolvable.

func (KeyValueMap) MarshalYAML

func (kvm KeyValueMap) MarshalYAML() (interface{}, error)

MarshalYAML makes KeyValueMap implement yaml.Marshaller

func (KeyValueMap) Override

func (kvm KeyValueMap) Override(extra ...*KeyValue) KeyValueMap

Override accepts a list of key value pairs and overrides the key in the map

func (KeyValueMap) OverrideBy

func (kvm KeyValueMap) OverrideBy(other KeyValueMap) KeyValueMap

OverrideBy update KeyValueMap with values from another KeyValueMap

func (KeyValueMap) RemoveEmpty

func (kvm KeyValueMap) RemoveEmpty() KeyValueMap

RemoveEmpty excludes keys that are not associated with a value

func (KeyValueMap) Resolve

func (kvm KeyValueMap) Resolve(lookupFn func(string) (string, bool)) KeyValueMap

Resolve update a KConfig for keys without value (`key`, but not `key=`)

func (KeyValueMap) Set

func (kvm KeyValueMap) Set(key, value string) KeyValueMap

Set a new key with specified value

func (KeyValueMap) Slice

func (kvm KeyValueMap) Slice() []*KeyValue

Slice returns the map as a slice

func (KeyValueMap) String

func (kvm KeyValueMap) String() string

String returns the serialized string representing a .config file

func (KeyValueMap) Unset

func (kvm KeyValueMap) Unset(key string) KeyValueMap

Unset a specific key

type MenuKind

type MenuKind string