platformio/platformio-core
1
0
Fork 1
mirror of https://github.com/platformio/platformio-core.git synced 2025-07-29 17:47:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add new LDF Modes

Browse Source
This commit is contained in:
Ivan Kravets
2016-12-01 17:37:12 +02:00
parent 48b87db2fb
commit 738c0f9616
3 changed files with 109 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
HISTORY.rst
View File

@ -20,8 +20,11 @@ PlatformIO 3.0
and `PLATFORMIO_AUTH_TOKEN <http://docs.platformio.org/en/latest/envvars.html#envvar-PLATFORMIO_AUTH_TOKEN>`__
environment variable for CI systems
* Refactored `Library Dependency Finder (LDF) <http://docs.platformio.org/en/stable/librarymanager/ldf.html>`__
C/C++ Preprocessor for conditional syntax ("#ifdef", #if, #else, #elif, #define, etc.)
C/C++ Preprocessor for conditional syntax (``#ifdef``, ``#if``, ``#else``,
``#elif``, ``#define``, etc.)
(`issue #837 <https://github.com/platformio/platformio/issues/837>`_)
* Added new `LDF Modes <http://docs.platformio.org/en/latest/librarymanager/ldf.html#ldf-mode>`__:
``chain+`` and ``deep+`` and set ``chain+`` as default
* Inject system environment variables to configuration settings in
`Project Configuration File "platformio.ini" <http://docs.platformio.org/en/stable/projectconf.html>`__
(`issue #792 <https://github.com/platformio/platformio/issues/792>`_)

49
docs/librarymanager/ldf.rst
View File

@ -21,7 +21,7 @@ operates with the C/C++ source files and looks for ``#include ...``
directives.
In spite of the fact that Library Dependency Finder is written in pure Python,
it interprets (emulates) :ref:`ldf_c_cond_syntax` (``#ifdef``, ``if``, ``defined``,
it evaluates :ref:`ldf_c_cond_syntax` (``#ifdef``, ``if``, ``defined``,
``else``, and ``elif``) without calling ``gcc -E``. This approach allows
significantly reduce total compilation time.
@ -63,18 +63,39 @@ Dependency Finder Mode
Library Dependency Finder starts work from analyzing source files of the
project (:ref:`projectconf_pio_src_dir`) and can work in the next modes:
* ``0`` - "manual mode", does not process source files of a project and
dependencies. Builds only the libraries that are specified in
manifests (:ref:`library_config`, ``module.json``) or in the :ref:`projectconf`.
* ``1`` - **default** - parses ALL C/C++ source code of the project and follows
only by nested includes (``#include ...``, chain...) from the libraries.
* ``2`` - parses ALL C/C++ source code of the project and parses
ALL C/C++ source code of the each found dependency (recursively).
.. list-table::
:header-rows: 1
This mode can be changed using :ref:`projectconf_lib_ldf_mode` option in
* - Mode
- Description
* - ``off``
- "Manual mode", does not process source files of a project and
dependencies. Builds only the libraries that are specified in
manifests (:ref:`library_config`, ``module.json``) or using
:ref:`projectconf_lib_deps` option.
* - ``chain``
- Parses ALL C/C++ source code of the project and follows
only by nested includes (``#include ...``, chain...) from the libraries.
Does not evaluates :ref:`ldf_c_cond_syntax`.
* - ``deep``
- Parses ALL C/C++ source code of the project and parses ALL C/C++
source code of the each found dependency (recursively).
Does not process :ref:`ldf_c_cond_syntax`.
* - ``chain+`` (**default**)
- The same behavior as for the ``chain`` but evaluates :ref:`ldf_c_cond_syntax`.
* - ``deep+``
- The same behavior as for the ``deep`` but evaluates :ref:`ldf_c_cond_syntax`.
The mode can be changed using :ref:`projectconf_lib_ldf_mode` option in
:ref:`projectconf`.
A difference between ``1`` and ``2`` modes. For example, there are 2 libraries:
A difference between ``chain/chain+`` and ``deep/deep+`` modes. For example,
there are 2 libraries:
* Library "Foo" with files:
@ -88,7 +109,7 @@ A difference between ``1`` and ``2`` modes. For example, there are 2 libraries:
:Case 1:
* ``lib_ldf_mode = 1``
* ``lib_ldf_mode = chain``
* ``Foo/foo.h`` depends on "Bar" library (contains ``#include <bar.h>``)
* ``#include <foo.h>`` is located in one of the project source files
@ -97,7 +118,7 @@ A difference between ``1`` and ``2`` modes. For example, there are 2 libraries:
:Case 2:
* ``lib_ldf_mode = 1``
* ``lib_ldf_mode = chain``
* ``Foo/foo.cpp`` depends on "Bar" library (contains ``#include <bar.h>``)
* ``#include <foo.h>`` is located in one of the project source files
@ -106,7 +127,7 @@ A difference between ``1`` and ``2`` modes. For example, there are 2 libraries:
:Case 3:
* ``lib_ldf_mode = 2``
* ``lib_ldf_mode = deep``
* ``Foo/foo.cpp`` depends on "Bar" library (contains ``#include <bar.h>``)
* ``#include <foo.h>`` is located in one of the project source files
@ -140,7 +161,7 @@ C/C++ Preprocessor conditional syntax
-------------------------------------
In spite of the fact that Library Dependency Finder is written in pure Python,
it interprets (emulates) `C/C++ Preprocessor conditional syntax <https://gcc.gnu.org/onlinedocs/cpp/Conditional-Syntax.html#Conditional-Syntax>`_
it evaluates `C/C++ Preprocessor conditional syntax <https://gcc.gnu.org/onlinedocs/cpp/Conditional-Syntax.html#Conditional-Syntax>`_
(``#ifdef``, ``if``, ``defined``, ``else``, and ``elif``) without calling
``gcc -E``. For example,

103
platformio/builder/tools/piolib.py
View File

@ -23,7 +23,7 @@ from os.path import basename, commonprefix, isdir, isfile, join, realpath, sep
from platform import system
import SCons.Scanner
from SCons.Script import ARGUMENTS
from SCons.Script import ARGUMENTS, DefaultEnvironment
from platformio import util
from platformio.builder.tools import platformio as piotool
@ -79,7 +79,8 @@ class LibBuilderFactory(object):
class LibBuilderBase(object):
DEFAULT_LDF_MODE = 1
LDF_MODES = ["off", "chain", "deep", "chain+", "deep+"]
LDF_MODE_DEFAULT = "chain+"
CLASSIC_SCANNER = SCons.Scanner.C.CScanner()
ADVANCED_SCANNER = SCons.Scanner.C.CScanner(advanced=True)
@ -90,7 +91,10 @@ class LibBuilderBase(object):
self.envorigin = env.Clone()
self.path = realpath(env.subst(path))
self.verbose = verbose
self._manifest = manifest if manifest else self.load_manifest()
self._ldf_mode = self.validate_ldf_mode(
self.env.get("LIB_LDF_MODE", self.LDF_MODE_DEFAULT))
self._is_dependent = False
self._is_built = False
self._depbuilders = list()
@ -159,9 +163,21 @@ class LibBuilderBase(object):
def lib_archive(self):
return True
@staticmethod
def validate_ldf_mode(mode):
if isinstance(mode, basestring):
mode = mode.strip().lower()
if mode in LibBuilderBase.LDF_MODES:
return mode
try:
return LibBuilderBase.LDF_MODES[int(mode)]
except (IndexError, ValueError):
pass
return LibBuilderBase.LDF_MODE_DEFAULT
@property
def lib_ldf_mode(self):
return int(self.env.get("LIB_LDF_MODE", self.DEFAULT_LDF_MODE))
return self._ldf_mode
@property
def depbuilders(self):
@ -171,6 +187,10 @@ class LibBuilderBase(object):
def dependent(self):
return self._is_dependent
@property
def is_built(self):
return self._is_built
@staticmethod
def items_in_list(items, ilist):
@ -211,7 +231,7 @@ class LibBuilderBase(object):
exports={"env": self.env,
"pio_lib_builder": self})
def _process_dependencies(self, lib_builders):
def _process_dependencies(self):
if not self.dependencies:
return
for item in self.dependencies:
@ -230,7 +250,7 @@ class LibBuilderBase(object):
continue
found = False
for lb in lib_builders:
for lb in self.envorigin.GetLibBuilders():
if item['name'] != lb.name:
continue
elif "frameworks" in item and \
@ -240,7 +260,7 @@ class LibBuilderBase(object):
not lb.is_platforms_compatible(item["platforms"]):
continue
found = True
self.depend_recursive(lb, lib_builders)
self.depend_recursive(lb)
break
if not found:
@ -262,12 +282,12 @@ class LibBuilderBase(object):
return _search_paths
def _get_found_includes(self, lib_builders, search_paths=None):
def _get_found_includes(self, search_paths=None):
# all include directories
if not LibBuilderBase.INC_DIRS_CACHE:
inc_dirs = []
used_inc_dirs = []
for lb in lib_builders:
for lb in self.envorigin.GetLibBuilders():
items = [self.env.Dir(d) for d in lb.get_inc_dirs()]
if lb.dependent:
used_inc_dirs.extend(items)
@ -293,7 +313,7 @@ class LibBuilderBase(object):
result.append(inc)
return result
def depend_recursive(self, lb, lib_builders, search_paths=None):
def depend_recursive(self, lb, search_paths=None):
def _already_depends(_lb):
if self in _lb.depbuilders:
@ -314,23 +334,23 @@ class LibBuilderBase(object):
elif lb not in self._depbuilders:
self._depbuilders.append(lb)
LibBuilderBase.INC_DIRS_CACHE = None
lb.search_deps_recursive(lib_builders, search_paths)
lb.search_deps_recursive(search_paths)
def search_deps_recursive(self, lib_builders, search_paths=None):
def search_deps_recursive(self, search_paths=None):
if not self._is_dependent:
self._is_dependent = True
self._process_dependencies(lib_builders)
self._process_dependencies()
if self.lib_ldf_mode == 2:
if self.lib_ldf_mode.startswith("deep"):
search_paths = self.get_src_files()
# when LDF is disabled
if self.lib_ldf_mode == 0:
if self.lib_ldf_mode == "off":
return
lib_inc_map = {}
for inc in self._get_found_includes(lib_builders, search_paths):
for lb in lib_builders:
for inc in self._get_found_includes(search_paths):
for lb in self.envorigin.GetLibBuilders():
if inc.get_abspath() in lb:
if lb not in lib_inc_map:
lib_inc_map[lb] = []
@ -338,7 +358,7 @@ class LibBuilderBase(object):
break
for lb, lb_search_paths in lib_inc_map.items():
self.depend_recursive(lb, lib_builders, lb_search_paths)
self.depend_recursive(lb, lb_search_paths)
def build(self):
libs = []
@ -353,6 +373,14 @@ class LibBuilderBase(object):
if not self._is_built:
self.env.AppendUnique(CPPPATH=self.get_inc_dirs())
if self.lib_ldf_mode == "off":
for lb in self.envorigin.GetLibBuilders():
if self == lb or not lb.is_built:
continue
for key in ("CPPPATH", "LIBPATH", "LIBS", "LINKFLAGS"):
self.env.AppendUnique(**{key: lb.env.get(key)})
if self.lib_archive:
libs.append(
self.env.BuildLibrary(self.build_dir, self.src_dir,
@ -376,7 +404,11 @@ class ProjectAsLibBuilder(LibBuilderBase):
@property
def lib_ldf_mode(self):
return 2 # parse all project files
mode = LibBuilderBase.lib_ldf_mode.fget(self)
if not mode.startswith("chain"):
return mode
# parse all project files
return "deep+" if "+" in mode else "deep"
@property
def src_filter(self):
@ -386,18 +418,17 @@ class ProjectAsLibBuilder(LibBuilderBase):
# skip for project, options are already processed
pass
def search_deps_recursive(self, lib_builders, search_paths=None):
def search_deps_recursive(self, search_paths=None):
for dep in self.env.get("LIB_DEPS", []):
for token in ("@", "="):
if token in dep:
dep, _ = dep.split(token, 1)
for lb in lib_builders:
for lb in self.envorigin.GetLibBuilders():
if lb.name == dep:
if lb not in self.depbuilders:
self.depend_recursive(lb, lib_builders)
self.depend_recursive(lb)
break
return LibBuilderBase.search_deps_recursive(self, lib_builders,
search_paths)
return LibBuilderBase.search_deps_recursive(self, search_paths)
class ArduinoLibBuilder(LibBuilderBase):
@ -509,7 +540,8 @@ class PlatformIOLibBuilder(LibBuilderBase):
@property
def lib_ldf_mode(self):
if "libLDFMode" in self._manifest.get("build", {}):
return int(self._manifest.get("build").get("libLDFMode"))
return self.validate_ldf_mode(
self._manifest.get("build").get("libLDFMode"))
return LibBuilderBase.lib_ldf_mode.fget(self)
def is_platforms_compatible(self, platforms):
@ -539,7 +571,11 @@ class PlatformIOLibBuilder(LibBuilderBase):
return inc_dirs
def GetLibBuilders(env):
def GetLibBuilders(env): # pylint: disable=too-many-branches
if "__PIO_LIB_BUILDERS" in DefaultEnvironment():
return DefaultEnvironment()['__PIO_LIB_BUILDERS']
items = []
compat_mode = int(env.get("LIB_COMPAT_MODE", 1))
verbose = (int(ARGUMENTS.get("PIOVERBOSE", 0)) and
@ -598,17 +634,19 @@ def GetLibBuilders(env):
"http://docs.platformio.org/en/stable/librarymanager/ldf.html#"
"ldf-compat-mode\n")
DefaultEnvironment()['__PIO_LIB_BUILDERS'] = items
return items
def BuildDependentLibraries(env, src_dir):
lib_builders = env.GetLibBuilders()
def correct_found_libs(lib_builders):
def correct_found_libs():
# build full dependency graph
found_lbs = [lb for lb in lib_builders if lb.dependent]
for lb in lib_builders:
if lb in found_lbs:
lb.search_deps_recursive(lib_builders, lb.get_src_files())
lb.search_deps_recursive(lb.get_src_files())
for lb in lib_builders:
for deplb in lb.depbuilders[:]:
if deplb not in found_lbs:
@ -626,18 +664,17 @@ def BuildDependentLibraries(env, src_dir):
if lb.depbuilders:
print_deps_tree(lb, level + 1)
lib_builders = env.GetLibBuilders()
print "Collected %d compatible libraries" % len(lib_builders)
print "Looking for dependencies..."
project = ProjectAsLibBuilder(env, src_dir)
project.env = env
project.search_deps_recursive(lib_builders)
project.search_deps_recursive()
if int(env.get("LIB_LDF_MODE", LibBuilderBase.DEFAULT_LDF_MODE)) == 1 \
and project.depbuilders:
correct_found_libs(lib_builders)
if (LibBuilderBase.validate_ldf_mode(
env.get("LIB_LDF_MODE", LibBuilderBase.LDF_MODE_DEFAULT))
.startswith("chain") and project.depbuilders):
correct_found_libs()
if project.depbuilders:
print "Library Dependency Graph"