api

Documentation

Index

• Constants
• func Callbacks(target string) map[string]Callback
• func Constants(target string) map[string]Constant
• func DeprecatedFunctions(target string) map[string]DeprecatedFunction
• func LegacyIncludes() map[string]string
• func Natives(target string) map[string]Native
• func UnsupportedFunctions(target string) map[string]UnsupportedFunction
• type Buffer
• type Callback
• type Constant
• type DeprecatedFunction
• type Function
• type Metadata
  • func Builtin(target string) *Metadata
  • func Load(path string) (*Metadata, error)
  • func Merge(target string, custom ...*Metadata) (*Metadata, error)
• type Native
• type Parameter
• type UnsupportedFunction

Constants

const (
	OpenMPRevision = "689c824f6cc558b1ca1b36cfd1aae7f1cda16d65"
	SAMPRevision   = "8ffb055624308b25521665b60e78b5e6e6b3717f"
)

Functions

func Callbacks

func Callbacks(target string) map[string]Callback

func Constants

func Constants(target string) map[string]Constant

func DeprecatedFunctions

func DeprecatedFunctions(target string) map[string]DeprecatedFunction

func LegacyIncludes

func LegacyIncludes() map[string]string

func Natives

func Natives(target string) map[string]Native

func UnsupportedFunctions

func UnsupportedFunctions(target string) map[string]UnsupportedFunction

Types

type Buffer

type Buffer struct {
	Parameter     int `json:"parameter"`
	SizeParameter int `json:"sizeParameter"`
}

type Callback

type Callback struct {
	Name       string      `json:"name,omitempty"`
	ReturnTag  string      `json:"returnTag,omitempty"`
	Parameters []Parameter `json:"parameters,omitempty"`
}

type Constant

type Constant struct {
	Name       string `json:"name,omitempty"`
	OpenMPOnly bool   `json:"openMPOnly,omitempty"`
}

type DeprecatedFunction

type DeprecatedFunction struct {
	Name      string
	Suggested string
}

type Function

type Function struct {
	Name       string      `json:"name,omitempty"`
	ReturnTag  string      `json:"returnTag,omitempty"`
	Parameters []Parameter `json:"parameters,omitempty"`
	Release    string      `json:"release,omitempty"`
	Pure       bool        `json:"pure,omitempty"`
}

type Metadata

type Metadata struct {
	Callbacks map[string]Callback `json:"callbacks,omitempty"`
	Natives   map[string]Native   `json:"natives,omitempty"`
	Functions map[string]Function `json:"functions,omitempty"`
	Constants map[string]Constant `json:"constants,omitempty"`
}

func Builtin

func Builtin(target string) *Metadata

func Load

func Load(path string) (*Metadata, error)

func Merge

func Merge(target string, custom ...*Metadata) (*Metadata, error)

type Native

type Native struct {
	Name            string      `json:"name,omitempty"`
	ReturnTag       string      `json:"returnTag,omitempty"`
	Parameters      []Parameter `json:"parameters,omitempty"`
	Deprecated      string      `json:"deprecated,omitempty"`
	FormatParameter int         `json:"formatParameter,omitempty"`
	Buffers         []Buffer    `json:"buffers,omitempty"`
	OpenMPOnly      bool        `json:"openMPOnly,omitempty"`
	Release         string      `json:"release,omitempty"`
	MustUse         bool        `json:"mustUse,omitempty"`
	RequiresBefore  []string    `json:"requiresBefore,omitempty"`
	Pure            bool        `json:"pure,omitempty"`
}

type Parameter

type Parameter struct {
	Name        string `json:"name,omitempty"`
	Tag         string `json:"tag,omitempty"`
	ArrayRank   int    `json:"arrayRank,omitempty"`
	Const       bool   `json:"const,omitempty"`
	Reference   bool   `json:"reference,omitempty"`
	Output      bool   `json:"output,omitempty"`
	Variadic    bool   `json:"variadic,omitempty"`
	Default     bool   `json:"default,omitempty"`
	Minimum     *int64 `json:"minimum,omitempty"`
	Maximum     *int64 `json:"maximum,omitempty"`
	Ownership   string `json:"ownership,omitempty"`
	TaintSource string `json:"taintSource,omitempty"`
	TaintSink   string `json:"taintSink,omitempty"`
}

type UnsupportedFunction

type UnsupportedFunction struct {
	Name      string
	Suggested string
}