gen

Documentation

Index

• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func MustAsset(name string) []byte
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• type ArrayAttrib
• type ArrayLen
• type BasicDevice
• type Bit24
• type BitField
  • func (b BitField) IsNotReserved() bool
• type BitFlag
  • func (b BitFlag) IsNotReserved() bool
• type Bitmask
• type Byte
  • func (b *Byte) UnmarshalXMLAttr(attr xml.Attr) error
• type Command
  • func (c Command) GetBaseName(cc CommandClass) string
  • func (c Command) GetFileName(cc CommandClass) string
  • func (c Command) GetStructName(cc CommandClass) string
• type CommandClass
  • func (c CommandClass) CanGen() (can bool)
  • func (c CommandClass) CanGenerate() (can bool, reason string)
  • func (c CommandClass) GetBaseName() string
  • func (c CommandClass) GetConstName() string
  • func (c CommandClass) GetDirName() string
  • func (c CommandClass) GetPackageName() string
• type Config
• type Const
• type DWord
• type Enum
• type FieldEnum
  • func (f FieldEnum) IsNotReserved() bool
• type Generator
  • func NewGenerator(output string, configFile string) (*Generator, error)
  • func (g *Generator) GenCommandClasses() error
  • func (g *Generator) GenDevices() error
  • func (g *Generator) GenParser() error
• type GenericDevice
• type Param
  • func (p Param) GetEncodedByteLength() (uint8, error)
  • func (p Param) GetGoType() (string, error)
  • func (p Param) IsNotReserved() bool
• type SpecificDevice
• type ValueAttrib
• type Variant
• type Word
• type ZwClasses

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

Types

type ArrayAttrib

type ArrayAttrib struct {
	Key     string `xml:"key,attr"`
	Length  int    `xml:"len,attr"`
	IsAscii bool   `xml:"is_ascii,attr"`
}

type ArrayLen

type ArrayLen struct {
	Key          string `xml:"key,attr"`
	ParamOffset  byte   `xml:"paramoffs,attr"`
	LengthOffset byte   `xml:"lenoffs,attr"`
	LengthMask   byte   `xml:"lenmask,attr"`
}

type BasicDevice

type BasicDevice struct {
	Name     string `xml:"name,attr"`
	Key      string `xml:"key,attr"`
	Help     string `xml:"help,attr"`
	ReadOnly bool   `xml:"read_only,attr"`
	Comment  string `xml:"comment,attr"`
}

type Bit24

type Bit24 struct {
	Key        string `xml:"key,attr"`
	HasDefines bool   `xml:"hasdefines,attr"`
	ShowHex    bool   `xml:"showhex,attr"`
}

type BitField

type BitField struct {
	Key       string `xml:"key,attr"`
	FieldName string `xml:"fieldname,attr"`
	FieldMask string `xml:"fieldmask,attr"`
	Shifter   uint8  `xml:"shifter,attr"`
}

func (BitField) IsNotReserved

func (b BitField) IsNotReserved() bool

type BitFlag

type BitFlag struct {
	Key      string `xml:"key,attr"`
	FlagName string `xml:"flagname,attr"`
	FlagMask string `xml:"flagmask,attr"`
}

func (BitFlag) IsNotReserved

func (b BitFlag) IsNotReserved() bool

type Bitmask

type Bitmask struct {
	Key          string `xml:"key,attr"`
	ParamOffset  Byte   `xml:"paramoffs,attr"`
	LengthOffset Byte   `xml:"lenoffs,attr"`
	LengthMask   Byte   `xml:"lenmask,attr"`
	Length       Byte   `xml:"len,attr"`
}

type Byte

type Byte byte

func (*Byte) UnmarshalXMLAttr

func (b *Byte) UnmarshalXMLAttr(attr xml.Attr) error

type Command

type Command struct {
	Name     string `xml:"name,attr"`
	Key      string `xml:"key,attr"`
	Type     string `xml:"type,attr"`
	HashCode string
	Comment  string `xml:"comment,attr"`

	Params []Param `xml:"param"`
}

func (Command) GetBaseName

func (c Command) GetBaseName(cc CommandClass) string

func (Command) GetFileName

func (c Command) GetFileName(cc CommandClass) string

func (Command) GetStructName

func (c Command) GetStructName(cc CommandClass) string

type CommandClass

type CommandClass struct {
	Name     string    `xml:"name,attr"`
	Key      string    `xml:"key,attr"`
	Version  int       `xml:"version,attr"`
	Help     string    `xml:"help,attr"`
	Comment  string    `xml:"comment,attr"`
	Commands []Command `xml:"cmd"`

	Enabled bool `xml:"-"`
}

func (CommandClass) CanGen

func (c CommandClass) CanGen() (can bool)

func (CommandClass) CanGenerate

func (c CommandClass) CanGenerate() (can bool, reason string)

func (CommandClass) GetBaseName

func (c CommandClass) GetBaseName() string

func (CommandClass) GetConstName

func (c CommandClass) GetConstName() string

func (CommandClass) GetDirName

func (c CommandClass) GetDirName() string

func (CommandClass) GetPackageName

func (c CommandClass) GetPackageName() string

type Config

type Config struct {
	CommandClasses map[string]map[int]bool `yaml:"CommandClasses"`
}

type Const

type Const struct {
	Key      string `xml:"key,attr"`
	FlagName string `xml:"flagname,attr"`
	FlagMask string `xml:"flagmask,attr"`
}

type DWord

type DWord struct {
	Key        string `xml:"key,attr"`
	HasDefines bool   `xml:"hasdefines,attr"`
	ShowHex    bool   `xml:"showhex,attr"`
}

type Enum

type Enum struct {
	Key  string `xml:"key,attr"`
	Name string `xml:"name,attr"`
}

type FieldEnum

type FieldEnum struct {
	Key       string `xml:"key,attr"`
	FieldName string `xml:"fieldname,attr"`
	FieldMask string `xml:"fieldmask,attr"`
	Shifter   uint8  `xml:"shifter,attr"`
	Value     string `xml:"value,attr"`

	EnumValues []FieldEnum `xml:"fieldenum"`
}

func (FieldEnum) IsNotReserved

func (f FieldEnum) IsNotReserved() bool

type Generator

type Generator struct {
	// contains filtered or unexported fields
}

func NewGenerator

func NewGenerator(output string, configFile string) (*Generator, error)

func (*Generator) GenCommandClasses

func (g *Generator) GenCommandClasses() error

func (*Generator) GenDevices

func (g *Generator) GenDevices() error

func (*Generator) GenParser

func (g *Generator) GenParser() error

type GenericDevice

type GenericDevice struct {
	Name            string           `xml:"name,attr"`
	Key             string           `xml:"key,attr"`
	Help            string           `xml:"help,attr"`
	ReadOnly        bool             `xml:"read_only,attr"`
	Comment         string           `xml:"comment,attr"`
	SpecificDevices []SpecificDevice `xml:"spec_dev"`
}

type Param

type Param struct {
	Key            string `xml:"key,attr"`
	Name           string `xml:"name,attr"`
	Type           string `xml:"type,attr"`
	TypeHashCode   string `xml:"typehashcode,attr"`
	Comment        string `xml:"comment,attr"`
	EncapType      string `xml:"encaptype,attr"`
	OptionalOffset string `xml:"optionaloffs,attr"`
	OptionalMask   string `xml:"optionalmask,attr"`
	Encapsulated   bool   `xml:"encapsulated,attr"`
	CommandMask    string `xml:"cmd_mask,attr"`
	Affix          bool   `xml:"affix,attr"`

	ArrayAttrib []ArrayAttrib `xml:"arrayattrib"`
	Bit24       []Bit24       `xml:"bit_24"`
	BitField    []BitField    `xml:"bitfield"`
	BitFlag     []BitFlag     `xml:"bitflag"`
	Const       []Const       `xml:"const"`
	DWord       []DWord       `xml:"dword"`
	FieldEnum   []FieldEnum   `xml:"fieldenum"`
	ValueAttrib []ValueAttrib `xml:"valueattrib"`
	Variant     []Variant     `xml:"variant"`
	Bitmask     []Bitmask     `xml:"bitmask"`
	Word        []Word        `xml:"word"`
}

func (Param) GetEncodedByteLength

func (p Param) GetEncodedByteLength() (uint8, error)

func (Param) GetGoType

func (p Param) GetGoType() (string, error)

func (Param) IsNotReserved

func (p Param) IsNotReserved() bool

type SpecificDevice

type SpecificDevice struct {
	Name     string `xml:"name,attr"`
	Key      string `xml:"key,attr"`
	Help     string `xml:"help,attr"`
	ReadOnly bool   `xml:"read_only,attr"`
	Comment  string `xml:"comment,attr"`
}

type ValueAttrib

type ValueAttrib struct {
	Key        string `xml:"key,attr"`
	HasDefines bool   `xml:"hasdefines,attr"`
	ShowHex    bool   `xml:"showhex,attr"`
}

type Variant

type Variant struct {
	Key         string `xml:"key,attr"`
	ParamOffset Byte   `xml:"paramoffs,attr"`
	HasDefines  bool   `xml:"hasdefines,attr"`
	ShowHex     bool   `xml:"showhex,attr"`
	Signed      bool   `xml:"signed,attr"`
	SizeMask    string `xml:"sizemask,attr"`
	SizeOffset  string `xml:"sizeoffs,attr"`

	MarkerDelimited bool
	MarkerValue     string
	RemainingBytes  uint8
}

type Word

type Word struct {
	Key        string `xml:"key,attr"`
	HasDefines bool   `xml:"hasdefines,attr"`
	ShowHex    bool   `xml:"showhex,attr"`
}

type ZwClasses

type ZwClasses struct {
	XMLName        xml.Name        `xml:"zw_classes"`
	BasicDevices   []BasicDevice   `xml:"bas_dev"`
	GenericDevices []GenericDevice `xml:"gen_dev"`
	CommandClasses []CommandClass  `xml:"cmd_class"`
}