cfc

Documentation

Overview

Package cfc provides a compiler for Apache Clownfish.

Index

• func DoStuff()
• func InstalledLibPath(packageName string) (string, error)
• func MainIncludeDir() string
• func RegisterParcelPackage(parcel, goPackage string)
• type BindC
  • func NewBindC(hierarchy *Hierarchy, header string, footer string) *BindC
  • func (obj *BindC) WriteCallbacks()
  • func (obj *BindC) WriteHostDefs()
• type BindCore
  • func NewBindCore(hierarchy *Hierarchy, header string, footer string) *BindCore
  • func (obj *BindCore) CopyHeaders(destDir string)
  • func (obj *BindCore) WriteAllModified(modified bool) bool
• type BindGo
  • func NewBindGo(hierarchy *Hierarchy) *BindGo
  • func (obj *BindGo) SetFooter(header string)
  • func (obj *BindGo) SetHeader(header string)
  • func (obj *BindGo) SetSuppressInit(suppressInit bool)
  • func (obj *BindGo) WriteBindings(parcel *Parcel, dest string)
• type BindGoClass
  • func GoClassSingleton(className string) *BindGoClass
  • func NewGoClass(parcel *Parcel, className string) *BindGoClass
  • func (obj *BindGoClass) Register()
  • func (obj *BindGoClass) SetSuppressCtor(suppressCtor bool)
  • func (obj *BindGoClass) SetSuppressStruct(suppressStruct bool)
  • func (obj *BindGoClass) SpecMethod(name, sig string)
• type CFCError
  • func (e CFCError) Error() string
• type Hierarchy
  • func NewHierarchy(dest string) *Hierarchy
  • func (obj *Hierarchy) AddIncludeDir(dir string)
  • func (obj *Hierarchy) AddSourceDir(dir string)
  • func (obj *Hierarchy) Build()
  • func (obj *Hierarchy) WriteLog()
• type Parcel
  • func FetchParcel(name string) *Parcel

Functions

func DoStuff

func DoStuff()

func InstalledLibPath

func InstalledLibPath(packageName string) (string, error)

Given a package name for a Clownfish parcel with Go bindings, return the install path for its C static archive.

TODO: It would be better if we could embed the C archive contents within the installed Go archive.

func MainIncludeDir

func MainIncludeDir() string

Return the path of the main include directory holding clownfish parcel and header files.

func RegisterParcelPackage

func RegisterParcelPackage(parcel, goPackage string)

Types

type BindC

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

func NewBindC

func NewBindC(hierarchy *Hierarchy, header string, footer string) *BindC

func (*BindC) WriteCallbacks

func (obj *BindC) WriteCallbacks()

func (*BindC) WriteHostDefs

func (obj *BindC) WriteHostDefs()

type BindCore

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

func NewBindCore

func NewBindCore(hierarchy *Hierarchy, header string, footer string) *BindCore

func (*BindCore) CopyHeaders

func (obj *BindCore) CopyHeaders(destDir string)

func (*BindCore) WriteAllModified

func (obj *BindCore) WriteAllModified(modified bool) bool

type BindGo

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

func NewBindGo

func NewBindGo(hierarchy *Hierarchy) *BindGo

func (*BindGo) SetFooter

func (obj *BindGo) SetFooter(header string)

func (*BindGo) SetHeader

func (obj *BindGo) SetHeader(header string)

func (*BindGo) SetSuppressInit

func (obj *BindGo) SetSuppressInit(suppressInit bool)

func (*BindGo) WriteBindings

func (obj *BindGo) WriteBindings(parcel *Parcel, dest string)

type BindGoClass

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

func GoClassSingleton

func GoClassSingleton(className string) *BindGoClass

func NewGoClass

func NewGoClass(parcel *Parcel, className string) *BindGoClass

func (*BindGoClass) Register

func (obj *BindGoClass) Register()

func (*BindGoClass) SetSuppressCtor

func (obj *BindGoClass) SetSuppressCtor(suppressCtor bool)

func (*BindGoClass) SetSuppressStruct

func (obj *BindGoClass) SetSuppressStruct(suppressStruct bool)

func (*BindGoClass) SpecMethod

func (obj *BindGoClass) SpecMethod(name, sig string)

type CFCError

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

func (CFCError) Error

func (e CFCError) Error() string

type Hierarchy

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

func NewHierarchy

func NewHierarchy(dest string) *Hierarchy

func (*Hierarchy) AddIncludeDir

func (obj *Hierarchy) AddIncludeDir(dir string)

func (*Hierarchy) AddSourceDir

func (obj *Hierarchy) AddSourceDir(dir string)

func (*Hierarchy) Build

func (obj *Hierarchy) Build()

func (*Hierarchy) WriteLog

func (obj *Hierarchy) WriteLog()

type Parcel

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

func FetchParcel

func FetchParcel(name string) *Parcel