core

Documentation

Index

• Constants
• Variables
• func BuildProject()
• func ExecuteTemplate(templateName string, templateData string, info interface{}) (string, error)
• func GenerateBuildScripts()
• func GetCxxOptions(options map[string]interface{}) string
• func RemoveBuildFiles()
• func RunTests() error
• func VerifyConanExists() error
• func VerifyNinjaExists() error
• type BuildInfo
  • func NewBuildInfo() BuildInfo
• type CommandRunner
  • func NewOsCommandRunner() CommandRunner
• type ConanBuildInfo
  • func ReadConanBuildInfo(path string) (ConanBuildInfo, error)
• type ConanPackage
  • func ParsePackageString(name string) (ConanPackage, error)
• type Dependency
  • func GetTestingPackage(info ConanBuildInfo) (Dependency, error)
• type OsCommandRunner
  • func (OsCommandRunner) Run(command []string) error
  • func (OsCommandRunner) RunWithOutput(command []string) error
• type Setting

Constants

const (
	Name    = "gb"
	Version = "0.0.1"
	Author  = "Andrzej 'angelo' Lichnerowicz"
	Website = "https://andrzej.lichnerowicz.pl/"
	Desc    = "gb: Yet another build generator for cross-platform C++"
)

Variables

var (
	Banner = ""
)

Functions

func BuildProject

func BuildProject()

func ExecuteTemplate

func ExecuteTemplate(templateName string, templateData string, info interface{}) (string, error)

func GenerateBuildScripts

func GenerateBuildScripts()

func GetCxxOptions

func GetCxxOptions(options map[string]interface{}) string

func RemoveBuildFiles

func RemoveBuildFiles()

func RunTests

func RunTests() error

func VerifyConanExists

func VerifyConanExists() error

func VerifyNinjaExists

func VerifyNinjaExists() error

Types

type BuildInfo

type BuildInfo struct {
	Cxx        string
	CxxOptions string
	Project    layout.ProjectInfo
}

func NewBuildInfo

func NewBuildInfo() BuildInfo

type CommandRunner

type CommandRunner interface {
	Run(command []string) error
	RunWithOutput(command []string) error
}

func NewOsCommandRunner

func NewOsCommandRunner() CommandRunner

type ConanBuildInfo

type ConanBuildInfo struct {
	Dependencies []Dependency
	Settings     Setting
}

func ReadConanBuildInfo

func ReadConanBuildInfo(path string) (ConanBuildInfo, error)

type ConanPackage

type ConanPackage struct {
	Name    string
	Version string
	Channel string
}

func ParsePackageString

func ParsePackageString(name string) (ConanPackage, error)

type Dependency

type Dependency struct {
	RootPath     string
	Version      string
	IncludePaths []string `json:"include_paths"`
	Name         string
	Description  string
}

func GetTestingPackage

func GetTestingPackage(info ConanBuildInfo) (Dependency, error)

type OsCommandRunner

type OsCommandRunner struct{}

func (OsCommandRunner) Run

func (OsCommandRunner) Run(command []string) error

func (OsCommandRunner) RunWithOutput

func (OsCommandRunner) RunWithOutput(command []string) error

type Setting

type Setting struct {
	Architecture    string `json:"arch"`
	OsBuild         string `json:"os_build"`
	Os              string
	Compiler        string
	CompilerVersion string `json:"compiler.version"`
	CompilerLibCxx  string `json:"compiler.libcxx"`
}