descriptor

Documentation

Index

• type ArrayParameter
  • func (f ArrayParameter) GetClass() string
  • func (f ArrayParameter) GetDirection() string
  • func (f ArrayParameter) GetLocation() string
  • func (f ArrayParameter) GetName() string
  • func (f ArrayParameter) GetSize() int64
  • func (f ArrayParameter) GetType() string
• type BasicParameter
  • func (f BasicParameter) GetClass() string
  • func (f BasicParameter) GetDirection() string
  • func (f BasicParameter) GetLocation() string
  • func (f BasicParameter) GetName() string
  • func (f BasicParameter) GetSize() int64
  • func (f BasicParameter) GetType() string
• type EnumParameter
  • func (f EnumParameter) GetClass() string
  • func (f EnumParameter) GetDirection() string
  • func (f EnumParameter) GetLocation() string
  • func (f EnumParameter) GetName() string
  • func (f EnumParameter) GetSize() int64
  • func (f EnumParameter) GetType() string
• type FunctionDescription
• type FunctionParameter
  • func (f FunctionParameter) GetClass() string
  • func (f FunctionParameter) GetDirection() string
  • func (f FunctionParameter) GetLocation() string
  • func (f FunctionParameter) GetName() string
  • func (f FunctionParameter) GetSize() int64
  • func (f FunctionParameter) GetType() string
• type LocationDescription
• type Parameter
• type PointerParameter
  • func (f PointerParameter) GetClass() string
  • func (f PointerParameter) GetDirection() string
  • func (f PointerParameter) GetLocation() string
  • func (f PointerParameter) GetName() string
  • func (f PointerParameter) GetSize() int64
  • func (f PointerParameter) GetType() string
• type QualifiedParameter
  • func (f QualifiedParameter) GetClass() string
  • func (f QualifiedParameter) GetDirection() string
  • func (f QualifiedParameter) GetLocation() string
  • func (f QualifiedParameter) GetName() string
  • func (f QualifiedParameter) GetSize() int64
  • func (f QualifiedParameter) GetType() string
• type StructureParameter
  • func (f StructureParameter) GetClass() string
  • func (f StructureParameter) GetDirection() string
  • func (f StructureParameter) GetLocation() string
  • func (f StructureParameter) GetName() string
  • func (f StructureParameter) GetSize() int64
  • func (f StructureParameter) GetType() string
• type VariableDescription

Types

type ArrayParameter

type ArrayParameter struct {
	Name      string    `json:"name,omitempty"`
	Type      string    `json:"type,omitempty"`
	Class     string    `json:"class,omitempty"`
	Size      int64     `json:"size,omitempty"`
	Length    int64     `json:"count,omitempty"`
	Location  string    `json:"location,omitempty"`
	Direction string    `json:"direction,omitempty"`
	ItemType  Parameter `json:"items_type,omitemtpy"`
}

func (ArrayParameter) GetClass

func (f ArrayParameter) GetClass() string

func (ArrayParameter) GetDirection

func (f ArrayParameter) GetDirection() string

func (ArrayParameter) GetLocation

func (f ArrayParameter) GetLocation() string

func (ArrayParameter) GetName

func (f ArrayParameter) GetName() string

func (ArrayParameter) GetSize

func (f ArrayParameter) GetSize() int64

func (ArrayParameter) GetType

func (f ArrayParameter) GetType() string

type BasicParameter

type BasicParameter struct {
	Name      string `json:"name,omitempty"`
	Type      string `json:"type,omitempty"`
	Class     string `json:"class,omitempty"`
	Location  string `json:"location,omitempty"`
	Direction string `json:"direction,omitempty"`
	Size      int64  `json:"size,omitempty"`
}

func (BasicParameter) GetClass

func (f BasicParameter) GetClass() string

func (BasicParameter) GetDirection

func (f BasicParameter) GetDirection() string

func (BasicParameter) GetLocation

func (f BasicParameter) GetLocation() string

func (BasicParameter) GetName

func (f BasicParameter) GetName() string

func (BasicParameter) GetSize

func (f BasicParameter) GetSize() int64

func (BasicParameter) GetType

func (f BasicParameter) GetType() string

type EnumParameter

type EnumParameter struct {
	Name      string           `json:"name,omitempty"`
	Type      string           `json:"type,omitempty"`
	Class     string           `json:"class,omitempty"`
	Size      int64            `json:"size,omitempty"`
	Location  string           `json:"location,omitempty"`
	Length    int              `json:"count,omitempty"`
	Direction string           `json:"direction,omitempty"`
	Constants map[string]int64 `json:"constants,omitemtpy"`
}

func (EnumParameter) GetClass

func (f EnumParameter) GetClass() string

func (EnumParameter) GetDirection

func (f EnumParameter) GetDirection() string

func (EnumParameter) GetLocation

func (f EnumParameter) GetLocation() string

func (EnumParameter) GetName

func (f EnumParameter) GetName() string

func (EnumParameter) GetSize

func (f EnumParameter) GetSize() int64

func (EnumParameter) GetType

func (f EnumParameter) GetType() string

type FunctionDescription

type FunctionDescription struct {
	Parameters []Parameter `json:"parameters,omitempty"`
	Name       string      `json:"name"`
	Direction  string      `json:"direction,omitempty"`
	Type       string      `json:"type"`
}

A function description has a list of parameters

type FunctionParameter

type FunctionParameter struct {
	Name      string `json:"name,omitempty"`
	Type      string `json:"type,omitempty"`
	Class     string `json:"class,omitempty"`
	Direction string `json:"direction,omitempty"`
	Location  string `json:"location,omitempty"`
	Size      int64  `json:"size,omitempty"`
}

func (FunctionParameter) GetClass

func (f FunctionParameter) GetClass() string

func (FunctionParameter) GetDirection

func (f FunctionParameter) GetDirection() string

func (FunctionParameter) GetLocation

func (f FunctionParameter) GetLocation() string

func (FunctionParameter) GetName

func (f FunctionParameter) GetName() string

func (FunctionParameter) GetSize

func (f FunctionParameter) GetSize() int64

All types can return a size and name

func (FunctionParameter) GetType

func (f FunctionParameter) GetType() string

type LocationDescription

type LocationDescription interface{}

A General Location description holds a variable or function

type Parameter

type Parameter interface {
	GetSize() int64
	GetClass() string
	GetName() string
	GetLocation() string
	GetType() string
	GetDirection() string
}

A general interface to support different parameter types

type PointerParameter

type PointerParameter struct {
	Name           string    `json:"name,omitempty"`
	Type           string    `json:"type,omitempty"`
	Class          string    `json:"class,omitempty"`
	Direction      string    `json:"direction,omitempty"`
	Location       string    `json:"location,omitempty"`
	Size           int64     `json:"size,omitempty"`
	UnderlyingType Parameter `json:"underlying_type,omitempty"`
	Indirections   int64     `json:"indirections,omitempty"`
}

func (PointerParameter) GetClass

func (f PointerParameter) GetClass() string

func (PointerParameter) GetDirection

func (f PointerParameter) GetDirection() string

func (PointerParameter) GetLocation

func (f PointerParameter) GetLocation() string

func (PointerParameter) GetName

func (f PointerParameter) GetName() string

func (PointerParameter) GetSize

func (f PointerParameter) GetSize() int64

func (PointerParameter) GetType

func (f PointerParameter) GetType() string

type QualifiedParameter

type QualifiedParameter struct {
	Name      string `json:"name,omitempty"`
	Class     string `json:"class,omitempty"`
	Type      string `json:"type,omitempty"`
	Direction string `json:"direction,omitempty"`
	Location  string `json:"location,omitempty"`
	Size      int64  `json:"size,omitempty"`
}

QualifiedParameter and BasicParameter are the same, but we are modeling after debug/dwarf

func (QualifiedParameter) GetClass

func (f QualifiedParameter) GetClass() string

func (QualifiedParameter) GetDirection

func (f QualifiedParameter) GetDirection() string

func (QualifiedParameter) GetLocation

func (f QualifiedParameter) GetLocation() string

func (QualifiedParameter) GetName

func (f QualifiedParameter) GetName() string

func (QualifiedParameter) GetSize

func (f QualifiedParameter) GetSize() int64

func (QualifiedParameter) GetType

func (f QualifiedParameter) GetType() string

type StructureParameter

type StructureParameter struct {
	Name      string      `json:"name,omitempty"`
	Type      string      `json:"type,omitempty"`
	Class     string      `json:"class,omitempty"`
	Size      int64       `json:"size,omitempty"`
	Direction string      `json:"direction,omitempty"`
	Location  string      `json:"location,omitempty"`
	Fields    []Parameter `json:"fields,omitempty"`
}

func (StructureParameter) GetClass

func (f StructureParameter) GetClass() string

func (StructureParameter) GetDirection

func (f StructureParameter) GetDirection() string

func (StructureParameter) GetLocation

func (f StructureParameter) GetLocation() string

func (StructureParameter) GetName

func (f StructureParameter) GetName() string

func (StructureParameter) GetSize

func (f StructureParameter) GetSize() int64

func (StructureParameter) GetType

func (f StructureParameter) GetType() string

type VariableDescription

type VariableDescription struct {
	Name      string `json:"name,omitempty"`
	Class     string `json:"class,omitempty"`
	Type      string `json:"type,omitempty"`
	Size      int64  `json:"size"`
	Direction string `json:"direction,omitempty"`
}

A Variable description is general and can also describe an underlying type TODO should there be location here?