forked from platformio/platformio-core
233 lines
7.5 KiB
Python
233 lines
7.5 KiB
Python
# Copyright (c) 2014-present PlatformIO <contact@platformio.org>
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import base64
|
|
import json
|
|
import sys
|
|
from os import environ
|
|
from os.path import expanduser, join
|
|
from time import time
|
|
|
|
from SCons.Script import ARGUMENTS # pylint: disable=import-error
|
|
from SCons.Script import COMMAND_LINE_TARGETS # pylint: disable=import-error
|
|
from SCons.Script import DEFAULT_TARGETS # pylint: disable=import-error
|
|
from SCons.Script import AllowSubstExceptions # pylint: disable=import-error
|
|
from SCons.Script import AlwaysBuild # pylint: disable=import-error
|
|
from SCons.Script import Default # pylint: disable=import-error
|
|
from SCons.Script import DefaultEnvironment # pylint: disable=import-error
|
|
from SCons.Script import Import # pylint: disable=import-error
|
|
from SCons.Script import Variables # pylint: disable=import-error
|
|
|
|
from platformio import util
|
|
from platformio.compat import PY2, path_to_unicode
|
|
from platformio.proc import get_pythonexe_path
|
|
from platformio.project.config import ProjectConfig
|
|
from platformio.project.helpers import (
|
|
get_project_dir, get_projectbuild_dir, get_projectdata_dir,
|
|
get_projectinclude_dir, get_projectlib_dir, get_projectlibdeps_dir,
|
|
get_projectsrc_dir, get_projecttest_dir, get_projectworkspace_dir)
|
|
|
|
AllowSubstExceptions(NameError)
|
|
|
|
# allow common variables from INI file
|
|
commonvars = Variables(None)
|
|
commonvars.AddVariables(
|
|
("PLATFORM_MANIFEST",),
|
|
("BUILD_SCRIPT",),
|
|
("EXTRA_SCRIPTS",),
|
|
("PIOENV",),
|
|
("PIOTEST",),
|
|
("PIOPLATFORM",),
|
|
("PIOFRAMEWORK",),
|
|
|
|
# build options
|
|
("BUILD_FLAGS",),
|
|
("SRC_BUILD_FLAGS",),
|
|
("BUILD_UNFLAGS",),
|
|
("SRC_FILTER",),
|
|
|
|
# library options
|
|
("LIB_LDF_MODE",),
|
|
("LIB_COMPAT_MODE",),
|
|
("LIB_DEPS",),
|
|
("LIB_IGNORE",),
|
|
("LIB_EXTRA_DIRS",),
|
|
("LIB_ARCHIVE",),
|
|
|
|
# board options
|
|
("BOARD",),
|
|
# deprecated options, use board_{object.path} instead
|
|
("BOARD_MCU",),
|
|
("BOARD_F_CPU",),
|
|
("BOARD_F_FLASH",),
|
|
("BOARD_FLASH_MODE",),
|
|
# end of deprecated options
|
|
|
|
# upload options
|
|
("UPLOAD_PORT",),
|
|
("UPLOAD_PROTOCOL",),
|
|
("UPLOAD_SPEED",),
|
|
("UPLOAD_FLAGS",),
|
|
("UPLOAD_RESETMETHOD",),
|
|
|
|
# test options
|
|
("TEST_BUILD_PROJECT_SRC",),
|
|
|
|
# debug options
|
|
("DEBUG_TOOL",),
|
|
("DEBUG_SVD_PATH",),
|
|
|
|
) # yapf: disable
|
|
|
|
MULTILINE_VARS = [
|
|
"EXTRA_SCRIPTS", "PIOFRAMEWORK", "BUILD_FLAGS", "SRC_BUILD_FLAGS",
|
|
"BUILD_UNFLAGS", "UPLOAD_FLAGS", "SRC_FILTER", "LIB_DEPS", "LIB_IGNORE",
|
|
"LIB_EXTRA_DIRS"
|
|
]
|
|
|
|
DEFAULT_ENV_OPTIONS = dict(
|
|
tools=[
|
|
"ar", "gas", "gcc", "g++", "gnulink", "platformio", "pioplatform",
|
|
"piowinhooks", "piolib", "pioupload", "piomisc", "pioide"
|
|
], # yapf: disable
|
|
toolpath=[join(util.get_source_dir(), "builder", "tools")],
|
|
variables=commonvars,
|
|
|
|
# Propagating External Environment
|
|
PIOVARIABLES=list(commonvars.keys()),
|
|
ENV=environ,
|
|
UNIX_TIME=int(time()),
|
|
PIOHOME_DIR=util.get_home_dir(),
|
|
PROJECT_DIR=get_project_dir(),
|
|
PROJECTWORKSPACE_DIR=get_projectworkspace_dir(),
|
|
PROJECTLIBDEPS_DIR=get_projectlibdeps_dir(),
|
|
PROJECTINCLUDE_DIR=get_projectinclude_dir(),
|
|
PROJECTSRC_DIR=get_projectsrc_dir(),
|
|
PROJECTTEST_DIR=get_projecttest_dir(),
|
|
PROJECTDATA_DIR=get_projectdata_dir(),
|
|
PROJECTBUILD_DIR=get_projectbuild_dir(),
|
|
BUILD_DIR=join("$PROJECTBUILD_DIR", "$PIOENV"),
|
|
BUILDSRC_DIR=join("$BUILD_DIR", "src"),
|
|
BUILDTEST_DIR=join("$BUILD_DIR", "test"),
|
|
LIBPATH=["$BUILD_DIR"],
|
|
LIBSOURCE_DIRS=[
|
|
get_projectlib_dir(),
|
|
join("$PROJECTLIBDEPS_DIR", "$PIOENV"),
|
|
join("$PIOHOME_DIR", "lib")
|
|
],
|
|
PROGNAME="program",
|
|
PROG_PATH=join("$BUILD_DIR", "$PROGNAME$PROGSUFFIX"),
|
|
PYTHONEXE=get_pythonexe_path())
|
|
|
|
if not int(ARGUMENTS.get("PIOVERBOSE", 0)):
|
|
DEFAULT_ENV_OPTIONS['ARCOMSTR'] = "Archiving $TARGET"
|
|
DEFAULT_ENV_OPTIONS['LINKCOMSTR'] = "Linking $TARGET"
|
|
DEFAULT_ENV_OPTIONS['RANLIBCOMSTR'] = "Indexing $TARGET"
|
|
for k in ("ASCOMSTR", "ASPPCOMSTR", "CCCOMSTR", "CXXCOMSTR"):
|
|
DEFAULT_ENV_OPTIONS[k] = "Compiling $TARGET"
|
|
|
|
env = DefaultEnvironment(**DEFAULT_ENV_OPTIONS)
|
|
|
|
# decode common variables
|
|
for k in list(commonvars.keys()):
|
|
if k in env:
|
|
env[k] = base64.b64decode(env[k])
|
|
if isinstance(env[k], bytes):
|
|
env[k] = env[k].decode()
|
|
if k in MULTILINE_VARS:
|
|
env[k] = ProjectConfig.parse_multi_values(env[k])
|
|
|
|
if env.GetOption('clean'):
|
|
env.PioClean(env.subst("$BUILD_DIR"))
|
|
env.Exit(0)
|
|
elif not int(ARGUMENTS.get("PIOVERBOSE", 0)):
|
|
print("Verbose mode can be enabled via `-v, --verbose` option")
|
|
|
|
# Handle custom variables from system environment
|
|
for var in ("BUILD_FLAGS", "SRC_BUILD_FLAGS", "SRC_FILTER", "EXTRA_SCRIPTS",
|
|
"UPLOAD_PORT", "UPLOAD_FLAGS", "LIB_EXTRA_DIRS"):
|
|
k = "PLATFORMIO_%s" % var
|
|
if k not in environ:
|
|
continue
|
|
if var in ("UPLOAD_PORT", ):
|
|
env[var] = environ.get(k)
|
|
continue
|
|
env.Append(**{var: ProjectConfig.parse_multi_values(environ.get(k))})
|
|
|
|
env.Prepend(LIBSOURCE_DIRS=env.get("LIB_EXTRA_DIRS", []))
|
|
env['LIBSOURCE_DIRS'] = [
|
|
expanduser(d) if d.startswith("~") else d for d in env['LIBSOURCE_DIRS']
|
|
]
|
|
|
|
env.LoadPioPlatform(commonvars)
|
|
|
|
env.SConscriptChdir(0)
|
|
env.SConsignFile(
|
|
join("$PROJECTBUILD_DIR",
|
|
".sconsign.dblite" if PY2 else ".sconsign3.dblite"))
|
|
|
|
for item in env.GetExtraScripts("pre"):
|
|
env.SConscript(item, exports="env")
|
|
|
|
env.SConscript("$BUILD_SCRIPT")
|
|
|
|
if "UPLOAD_FLAGS" in env:
|
|
env.Prepend(UPLOADERFLAGS=["$UPLOAD_FLAGS"])
|
|
|
|
for item in env.GetExtraScripts("post"):
|
|
env.SConscript(item, exports="env")
|
|
|
|
##############################################################################
|
|
|
|
# Checking program size
|
|
if env.get("SIZETOOL") and "nobuild" not in COMMAND_LINE_TARGETS:
|
|
env.Depends(["upload", "program"], "checkprogsize")
|
|
# Replace platform's "size" target with our
|
|
_new_targets = [t for t in DEFAULT_TARGETS if str(t) != "size"]
|
|
Default(None)
|
|
Default(_new_targets)
|
|
Default("checkprogsize")
|
|
|
|
# Print configured protocols
|
|
env.AddPreAction(
|
|
["upload", "program"],
|
|
env.VerboseAction(lambda source, target, env: env.PrintUploadInfo(),
|
|
"Configuring upload protocol..."))
|
|
|
|
AlwaysBuild(env.Alias("debug", DEFAULT_TARGETS))
|
|
AlwaysBuild(env.Alias("__debug", DEFAULT_TARGETS))
|
|
AlwaysBuild(env.Alias("__test", DEFAULT_TARGETS))
|
|
|
|
##############################################################################
|
|
|
|
if "envdump" in COMMAND_LINE_TARGETS:
|
|
print(env.Dump())
|
|
env.Exit(0)
|
|
|
|
if "idedata" in COMMAND_LINE_TARGETS:
|
|
try:
|
|
Import("projenv")
|
|
print("\n%s\n" % path_to_unicode(
|
|
json.dumps(
|
|
env.DumpIDEData(projenv), # pylint: disable=undefined-variable
|
|
ensure_ascii=False)))
|
|
env.Exit(0)
|
|
except UnicodeDecodeError:
|
|
sys.stderr.write(
|
|
"\nUnicodeDecodeError: Non-ASCII characters found in build "
|
|
"environment\n"
|
|
"See explanation in FAQ > Troubleshooting > Building\n"
|
|
"https://docs.platformio.org/page/faq.html\n\n")
|
|
env.Exit(1)
|