variadic

README

Package variadic
================

This packge implements variadic calling conventions for calling foreign C code from within Go.

The primary motivation for this package was to be able to interface with Apple's Objective-C
runtime on Mac OS X, which uses a variadic function (objc_msgSend) for sending messages to objects.

Status
======

amd64:  Works pretty well - http://github.com/mkrautz/objc uses it (only tested on darwin, though!)

386:    Works on linux/386 and darwin/386

        Note: darwin/386 requires 16 byte stack alignment, and no
        effort has been made to support this at the moment. However,
        the tests pass on darwin/386 - not sure if I've been lucky.

Documentation

Overview

Package variadic implements interfaces for various variadic C calling conventions

Index

• Constants
• type Function
  • func (f Function) Addr() unsafe.Pointer
  • func (f Function) IsStRet() bool
  • func (f Function) IsSuper() bool
  • func (f Function) NewCall() *FunctionCall
  • func (f Function) StRet() Function
  • func (f Function) String() string
• type FunctionCall
  • func NewFunctionCall(name string) *FunctionCall
  • func NewFunctionCallAddr(addr unsafe.Pointer) *FunctionCall
  • func (f *FunctionCall) Call() uintptr
  • func (f *FunctionCall) CallFloat32() float32
  • func (f *FunctionCall) CallFloat64() float64

Constants

const (
	RDI = iota
	RDX
	RCX
	R8
	R9
	XMM0
	XMM1
	XMM2
	XMM3
	XMM4
	XMM5
	XMM6
	XMM7
)

Types

type Function

type Function int

const (
	F_msgSend Function = iota
	F_msgSendSuper
	F_msgSend_stret
	F_msgSendSuper_stret
)

func (Function) Addr

func (f Function) Addr() unsafe.Pointer

func (Function) IsStRet

func (f Function) IsStRet() bool

func (Function) IsSuper

func (f Function) IsSuper() bool

func (Function) NewCall

func (f Function) NewCall() *FunctionCall

func (Function) StRet

func (f Function) StRet() Function

func (Function) String

func (f Function) String() string

type FunctionCall

type FunctionCall struct {
	Words     [14]uintptr
	NumFloat  int64
	NumMemory int64
	Memory    uintptr
	// contains filtered or unexported fields
}

func NewFunctionCall

func NewFunctionCall(name string) *FunctionCall

NewFunctionCall creates a new FunctionCall than can be used to call the C function named by the name parameter.

func NewFunctionCallAddr

func NewFunctionCallAddr(addr unsafe.Pointer) *FunctionCall

NewFunctionCallAddr creates a new FunctionCall that can be used to cll the C function at the address given by the addr parameter.

func (*FunctionCall) Call

func (f *FunctionCall) Call() uintptr

Call calls the FunctionCall's underlying function, returning its return value as an uintptr.

func (*FunctionCall) CallFloat32

func (f *FunctionCall) CallFloat32() float32

CallFloat32 calls the FunctionCall's underlying function, returning its return value as a float32.

func (*FunctionCall) CallFloat64

func (f *FunctionCall) CallFloat64() float64

CallFloat64 calls the FunctionCall's underlying function, returning its return value as float64.