gml/internal/build/context.go

/*
 * GML - Go QML
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2019 Roland Singer <roland.singer[at]desertbit.com>
 * Copyright (c) 2019 Sebastian Borchers <sebastian[at]desertbit.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package build

import (
	"fmt"
	"os"
	"path/filepath"
	"runtime"

	"github.com/desertbit/gml/internal/utils"
)

const (
	staticLibName      = "libgml.a"
	proFileName        = "gml.pro"
	qmlDir             = "qml"
	qmlResDir          = "resources"
	qmlResFile         = "gml_gen_resources.qrc"
	cGenDirName        = "gen_c"
	cGenIncludeDirName = "include"
	cppGenDirName      = "gen_cpp"
)

type Context struct {
	SourceDir string
	BuildDir  string
	DestDir   string

	QTModules string

	GmlBindingDir        string
	GmlBindingHeadersDir string
	GmlBindingSourcesDir string

	QMLDir     string
	QMLResDir  string
	QMLResFile string

	CGenDir        string
	CGenIncludeDir string
	CPPGenDir      string

	OutputFile    string
	StaticLibPath string
	QtProFile     string

	DebugBuild bool
}

func newContext(sourceDir, buildDir, destDir, qtModules string, clean bool, debugBuild bool) (ctx *Context, err error) {
	// Get absolute paths.
	sourceDir, err = filepath.Abs(sourceDir)
	if err != nil {
		return
	}
	buildDir, err = filepath.Abs(buildDir)
	if err != nil {
		return
	}
	destDir, err = filepath.Abs(destDir)
	if err != nil {
		return
	}

	cGenDir := filepath.Join(buildDir, cGenDirName)

	ctx = &Context{
		SourceDir:      sourceDir,
		BuildDir:       buildDir,
		DestDir:        destDir,
		QTModules:      qtModules,
		QMLDir:         filepath.Join(sourceDir, qmlDir),
		QMLResDir:      filepath.Join(sourceDir, qmlResDir),
		QMLResFile:     filepath.Join(sourceDir, qmlResFile),
		CGenDir:        cGenDir,
		CGenIncludeDir: filepath.Join(cGenDir, cGenIncludeDirName),
		CPPGenDir:      filepath.Join(buildDir, cppGenDirName),
		OutputFile:     filepath.Join(destDir, filepath.Base(sourceDir)),
		StaticLibPath:  filepath.Join(buildDir, staticLibName),
		QtProFile:      filepath.Join(buildDir, proFileName),
		DebugBuild:     debugBuild,
	}

	// Obtain the full path to the C bindings.
	bindingPath, err := utils.FindBindingPath(sourceDir)
	if err != nil {
		return
	}

	// Obtain the current import path.
	ctx.GmlBindingDir = bindingPath
	ctx.GmlBindingHeadersDir = filepath.Join(ctx.GmlBindingDir, "headers")
	ctx.GmlBindingSourcesDir = filepath.Join(ctx.GmlBindingDir, "sources")

	// Clean if set.
	if clean {
		err = ctx.cleanDirs()
		if err != nil {
			return
		}
	}

	err = ctx.cleanupDirs()
	if err != nil {
		return
	}

	err = ctx.createDirsIfNotExists()
	if err != nil {
		return
	}

	err = ctx.checkForRequiredDirs()
	return
}

func (c *Context) Env(optsEnv ...string) (env []string) {
	// Use current context environment variables.
	env = os.Environ()

	// Our default variables.
	env = append(env, []string{
		fmt.Sprintf("MAKEFLAGS=-j%v", runtime.NumCPU()+1),
		"CPPFLAGS=-D_FORTIFY_SOURCE=2",
		"CFLAGS=-march=x86-64 -mtune=generic -O2 -pipe -fstack-protector-strong -fno-plt",
		"CXXFLAGS=-march=x86-64 -mtune=generic -O2 -pipe -fstack-protector-strong -fno-plt",
		"LDFLAGS=-Wl,-O1,--sort-common,--as-needed,-z,relro,-z,now",
	}...)

	// Add the optional ones.
	if len(optsEnv) > 0 {
		env = append(env, optsEnv...)
	}

	return
}

func (c *Context) cleanDirs() (err error) {
	dirs := []string{
		c.BuildDir,
	}

	for _, d := range dirs {
		e, err := utils.Exists(d)
		if err != nil {
			return err
		} else if e {
			err = os.RemoveAll(d)
			if err != nil {
				return err
			}
		}
	}
	return
}

func (c *Context) cleanupDirs() (err error) {
	dirs := []string{
		c.CGenDir,
		c.CGenIncludeDir,
		c.CPPGenDir,
	}

	for _, d := range dirs {
		e, err := utils.Exists(d)
		if err != nil {
			return err
		} else if e {
			err = os.RemoveAll(d)
			if err != nil {
				return err
			}
		}
	}
	return
}

func (c *Context) createDirsIfNotExists() (err error) {
	dirs := []string{
		c.BuildDir,
		c.DestDir,
		c.QMLDir,
		c.QMLResDir,
		c.CGenDir,
		c.CGenIncludeDir,
		c.CPPGenDir,
	}

	for _, d := range dirs {
		err = os.MkdirAll(d, 0755)
		if err != nil {
			return
		}
	}
	return
}

func (c *Context) checkForRequiredDirs() (err error) {
	dirs := []string{
		c.SourceDir,
		c.QMLDir,
		c.QMLResDir,
	}

	for _, d := range dirs {
		e, err := utils.Exists(d)
		if err != nil {
			return err
		} else if !e {
			return fmt.Errorf("required directory does not exists: '%s'", d)
		}
	}
	return
}