add_build_properties_from_platform_sketch_txt_file.go

/*
 * This file is part of Arduino Builder.
 *
 * Arduino Builder is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * As a special exception, you may use this file as part of a free software
 * library without restriction.  Specifically, if other files instantiate
 * templates or use macros or inline functions from this file, or you compile
 * this file and link it with other files to produce an executable, this
 * file does not by itself cause the resulting executable to be covered by
 * the GNU General Public License.  This exception does not however
 * invalidate any other reasons why the executable file might be covered by
 * the GNU General Public License.
 *
 * Copyright 2018 Piotr Henryk Dabrowski <phd@phd.re>
 */

package builder

import (
	"path/filepath"

	"github.com/arduino/arduino-builder/constants"
	"github.com/arduino/arduino-builder/i18n"
	"github.com/arduino/arduino-builder/types"
	"github.com/arduino/arduino-builder/utils"
	properties "github.com/arduino/go-properties-map"
)

type AddBuildPropertiesFromPlatformSketchTxtFile struct{}

func (s *AddBuildPropertiesFromPlatformSketchTxtFile) Run(ctx *types.Context) error {
	if !ctx.UsePlatformSketchTxt {
		return nil
	}

	path := filepath.Join(filepath.Dir(ctx.Sketch.MainFile.Name), constants.FILE_PLATFORM_SKETCH_TXT)
	if !utils.IsFileReadable(path) {
		return nil
	}
	if ctx.Verbose {
		ctx.GetLogger().Println(constants.LOG_LEVEL_INFO, constants.MSG_USING_SKETCH_BUILD_PROPERTIES, path)
	}

	newBuildProperties := ctx.BuildProperties.Clone()
	sketchPlatformProperties, err := properties.SafeLoad(path)
	if err != nil {
		return i18n.WrapError(err)
	}
	newBuildProperties.Merge(sketchPlatformProperties)
	ctx.BuildProperties = newBuildProperties

	return nil
}