cmake

Documentation

Overview

package cmake provides tools to create, configure and build C & C++ projects using CMake

Index

• func CopyDir(cwd string, src string, dst string) ([]byte, []byte, error)
• func CopyFile(cwd string, file string, dst string) ([]byte, []byte, error)
• func LibraryExists(name string, includeFiles, includeDirs, linkDirs, predefines []string) error
• type Cmake
  • func (cmake *Cmake) BuildDefaults() ([]byte, []byte, error)
  • func (cmake *Cmake) BuildDefaultsWithConfig(config string) ([]byte, []byte, error)
  • func (cmake *Cmake) BuildTarget() ([]byte, []byte, error)
  • func (cmake *Cmake) BuildTargetWithConfig(config, target string) ([]byte, []byte, error)
  • func (cmake *Cmake) BuildWithTarget(target string) ([]byte, []byte, error)
  • func (cmake *Cmake) Configure() ([]byte, []byte, error)
  • func (cmake *Cmake) ConfigureRaw() ([]byte, []byte, error)
  • func (cmake *Cmake) CreateTempDirs() error
  • func (cmake *Cmake) GetCMakeListsTxt() (string, error)
  • func (cmake *Cmake) RemoveTempDirs() error
  • func (cmake *Cmake) WriteCMakeListsTxt() error

Functions

func CopyDir

func CopyDir(cwd string, src string, dst string) ([]byte, []byte, error)

func CopyFile

func CopyFile(cwd string, file string, dst string) ([]byte, []byte, error)

func LibraryExists

func LibraryExists(name string, includeFiles, includeDirs, linkDirs, predefines []string) error

LibraryExists tries to compile a simple program linking to the given library

Types

type Cmake

type Cmake struct {
	// Configs required for CMakeLists.txt
	Name           string // Executable name
	IsCpp          bool
	Standard       int // CMAKE_C/CXX_STANDARD
	Files          []string
	IncludeDirs    []string
	LinkLibs       []string // Library names or full paths
	LinkDirs       []string // Where should the linker look for libraries
	Generator      string
	ConfigureFlags []string

	// Build configuration
	ConfDir  string
	BuildDir string
	// contains filtered or unexported fields
}

Cmake contains all configuration necessary to configure and build a CMake project

func (*Cmake) BuildDefaults

func (cmake *Cmake) BuildDefaults() ([]byte, []byte, error)

Build runs cmake build step.

func (*Cmake) BuildDefaultsWithConfig

func (cmake *Cmake) BuildDefaultsWithConfig(config string) ([]byte, []byte, error)

Build runs cmake default build step with config

func (*Cmake) BuildTarget

func (cmake *Cmake) BuildTarget() ([]byte, []byte, error)

Build runs cmake build "Name" target step.

func (*Cmake) BuildTargetWithConfig

func (cmake *Cmake) BuildTargetWithConfig(config, target string) ([]byte, []byte, error)

Build runs cmake default build step with config

func (*Cmake) BuildWithTarget

func (cmake *Cmake) BuildWithTarget(target string) ([]byte, []byte, error)

Build runs cmake build "Name" target step.

func (*Cmake) Configure

func (cmake *Cmake) Configure() ([]byte, []byte, error)

Configure runs cmake configuration step.

func (*Cmake) ConfigureRaw

func (cmake *Cmake) ConfigureRaw() ([]byte, []byte, error)

Configure runs cmake configuration step without any CI quirks as is.

func (*Cmake) CreateTempDirs

func (cmake *Cmake) CreateTempDirs() error

CreateTempDirs creates temporary directories for conf and build dir

func (*Cmake) GetCMakeListsTxt

func (cmake *Cmake) GetCMakeListsTxt() (string, error)

func (*Cmake) RemoveTempDirs

func (cmake *Cmake) RemoveTempDirs() error

func (*Cmake) WriteCMakeListsTxt

func (cmake *Cmake) WriteCMakeListsTxt() error

WriteCMakeListsTxt writes cmake specification to file and returns the file name.