- support OSX frameworks

Signed-off-by: SSE4 <tomskside@gmail.com>
conan-io · Sep 13, 2019 · f24cfb2 · f24cfb2
1 parent 000bec3
commit f24cfb2
Show file tree

Hide file tree

Showing 10 changed files with 68 additions and 29 deletions.
diff --git a/howtos/manage_shared_libraries/env_vars.rst b/howtos/manage_shared_libraries/env_vars.rst
@@ -138,15 +138,16 @@ runtime. In Windows, it is enough if the package added its binary folder to the
 
 Security restrictions might apply in OSX
 (`read this thread <https://stackoverflow.com/questions/35568122/why-isnt-dyld-library-path-being-propagated-here>`_), so the
-``DYLD_LIBRARY_PATH`` environment variable is not directly transferred to the child process. In that case, you have to use it explicitly in
+``DYLD_LIBRARY_PATH`` and ``DYLD_FRAMEWORK_PATH` environment variables are not directly transferred to the child process. In that case, you have to use it explicitly in
 your *conanfile.py*:
 
 .. code-block:: python
 
-    def test(self):
-        # self.run("./myexe") # won't work, even if 'DYLD_LIBRARY_PATH' is in the env
-        with tools.environment_append({"DYLD_LIBRARY_PATH": [self.deps_cpp_info["toolA"].lib_paths]}):
-            self.run("DYLD_LIBRARY_PATH=%s ./myexe" % os.environ['DYLD_LIBRARY_PATH'])
+    def build(self):
+        env_build = RunEnvironment(self)
+        with tools.environment_append(env_build.vars):
+            # self.run("./myexetool") # won't work, even if 'DYLD_LIBRARY_PATH' and 'DYLD_FRAMEWORK_PATH' are in the env
+            self.run("DYLD_LIBRARY_PATH=%s DYLD_FRAMEWORK_PATH=%s ./myexetool" % (os.environ['DYLD_LIBRARY_PATH'], os.environ['DYLD_FRAMEWORK_PATH']))
 
 Or you could use ``RunEnvironment`` helper described above.
 

diff --git a/reference/build_helpers/run_environment.rst b/reference/build_helpers/run_environment.rst
@@ -3,7 +3,7 @@
 RunEnvironment
 ==============
 
-The ``RunEnvironment`` helper prepares ``PATH``, ``LD_LIBRARY_PATH`` and ``DYLD_LIBRARY_PATH`` environment variables to locate shared libraries and executables of your requirements at runtime.
+The ``RunEnvironment`` helper prepares ``PATH``, ``LD_LIBRARY_PATH``, ``DYLD_LIBRARY_PATH`` and ``DYLD_FRAMEWORK_PATH`` environment variables to locate shared libraries, frameworks and executables of your requirements at runtime.
 
 .. warning::
 
@@ -29,6 +29,7 @@ This helper is specially useful if:
             self.run("....")
             # All the requirements bin folder will be available at PATH
             # All the lib folders will be available in LD_LIBRARY_PATH and DYLD_LIBRARY_PATH
+            # All the framework_paths folders will be available in DYLD_FRAMEWORK_PATH
 
 
 It sets the following environment variables:
@@ -42,21 +43,23 @@ It sets the following environment variables:
 +--------------------+---------------------------------------------------------------------+
 | DYLD_LIBRARY_PATH  | Containing all the requirements ``lib`` folders. (OSX)              |
 +--------------------+---------------------------------------------------------------------+
+| DYLD_FRAMEWORK_PATH| Containing all the requirements ``framework_paths`` folders. (OSX)  |
++--------------------+---------------------------------------------------------------------+
 
 .. important::
 
     Security restrictions might apply in OSX
     (`read this thread <https://stackoverflow.com/questions/35568122/why-isnt-dyld-library-path-being-propagated-here>`_), so the
-    ``DYLD_LIBRARY_PATH`` environment variable is not directly transferred to the child process. In that case, you have to use it explicitly in
+    ``DYLD_LIBRARY_PATH`` and ``DYLD_FRAMEWORK_PATH` environment variables are not directly transferred to the child process. In that case, you have to use it explicitly in
     your *conanfile.py*:
 
     .. code-block:: python
 
         def build(self):
             env_build = RunEnvironment(self)
             with tools.environment_append(env_build.vars):
-                # self.run("./myexetool") # won't work, even if 'DYLD_LIBRARY_PATH' is in the env
-                self.run("DYLD_LIBRARY_PATH=%s ./myexetool" % os.environ['DYLD_LIBRARY_PATH'])
+                # self.run("./myexetool") # won't work, even if 'DYLD_LIBRARY_PATH' and 'DYLD_FRAMEWORK_PATH' are in the env
+                self.run("DYLD_LIBRARY_PATH=%s DYLD_FRAMEWORK_PATH=%s ./myexetool" % (os.environ['DYLD_LIBRARY_PATH'], os.environ['DYLD_FRAMEWORK_PATH']))
 
     This is already handled automatically by the ``self.run(..., run_environment=True)`` argument.
 

diff --git a/reference/conanfile/attributes.rst b/reference/conanfile/attributes.rst
@@ -868,6 +868,10 @@ This object should be filled in ``package_info()`` method.
 +--------------------------------+---------------------------------------------------------------------------------------------------------+
 | self.cpp_info.exelinkflags     | Ordered list with linker flags (executables). Defaulted to ``[]`` (empty)                               |
 +--------------------------------+---------------------------------------------------------------------------------------------------------+
+| self.cpp_info.frameworks       | Ordered list with the framework names (OSX), Defaulted to ``[]`` (empty)                                |
++--------------------------------+---------------------------------------------------------------------------------------------------------+
+| self.cpp_info.frameworkdirs    | Ordered list with frameworks search paths (OSX). Defaulted to ``["Frameworks"]``                        |
++--------------------------------+---------------------------------------------------------------------------------------------------------+
 | self.cpp_info.rootpath         | Filled with the root directory of the package, see ``deps_cpp_info``                                    |
 +--------------------------------+---------------------------------------------------------------------------------------------------------+
 
@@ -899,6 +903,8 @@ absolute paths:
 +-------------------------------------------+---------------------------------------------------------------------+
 | self.cpp_info.res_paths                   | Same as ``resdirs`` but transformed to absolute paths               |
 +-------------------------------------------+---------------------------------------------------------------------+
+| self.cpp_info.framework_paths             | Same as ``frameworkdirs`` but transformed to absolute paths         |
++-------------------------------------------+---------------------------------------------------------------------+
 
 To get a list of all the dependency names from ```deps_cpp_info```, you can call the `deps` member:
 

diff --git a/reference/generators/cmake.rst b/reference/generators/cmake.rst
@@ -45,6 +45,10 @@ Variables in *conanbuildinfo.cmake*
   +--------------------------------+----------------------------------------------------------------------+
   | CONAN_C_FLAGS_XXX              | C flags                                                              |
   +--------------------------------+----------------------------------------------------------------------+
+  | CONAN_FRAMEWORKS_XXX           | Frameworks (OSX)                                                     |
+  +--------------------------------+----------------------------------------------------------------------+
+  | CONAN_FRAMEWORK_PATHS_XXX      | Framework folders (OSX)  (default {CONAN_XXX_ROOT}/Frameworks        |
+  +--------------------------------+----------------------------------------------------------------------+
 
 - **Global declared variables**:
 
@@ -74,6 +78,10 @@ Variables in *conanbuildinfo.cmake*
   +--------------------------------+----------------------------------------------------------------------+
   | CONAN_C_FLAGS                  | Aggregated C flags                                                   |
   +--------------------------------+----------------------------------------------------------------------+
+  | CONAN_FRAMEWORKS               | Aggregated frameworks (OSX)                                          |
+  +--------------------------------+----------------------------------------------------------------------+
+  | CONAN_FRAMEWORK_PATHS          | Aggregated framework folders (OSX)                                   |
+  +--------------------------------+----------------------------------------------------------------------+
 
 - **User information declared variables**:
 

diff --git a/reference/generators/compiler_args.rst b/reference/generators/compiler_args.rst
@@ -66,6 +66,10 @@ You can use the **compiler_args** generator directly to build simple programs:
 +--------------------------------+----------------------------------------------------------------------+
 | -D_GLIBCXX_USE_CXX11_ABI=1     | When setting libcxx == "libstdc++11"                                 |
 +--------------------------------+----------------------------------------------------------------------+
+| -framework XXX                 | Corresponding to requirements `frameworks` (OSX)                     |
++--------------------------------+----------------------------------------------------------------------+
+| -F XXX                         | Corresponding to requirements `framework dirs` (OSX)                 |
++--------------------------------+----------------------------------------------------------------------+
 | Other flags                    | cxxflags, cflags, sharedlinkflags, exelinkflags (applied directly)   |
 +--------------------------------+----------------------------------------------------------------------+
 

diff --git a/reference/generators/json.rst b/reference/generators/json.rst
@@ -69,8 +69,8 @@ The dependencies is a list, with each item belonging to one dependency, and each
  - ``description``
  - ``rootpath``
  - ``sysroot``
- - ``include_paths``, ``lib_paths``, ``bin_paths``, ``build_paths``, ``res_paths``
- - ``libs``
+ - ``include_paths``, ``lib_paths``, ``bin_paths``, ``build_paths``, ``res_paths``, ``framework_paths``
+ - ``libs``, ``frameworks``
  - ``defines``, ``cflags``, ``cppflags``, ``sharedlinkflags``, ``exelinkflags``
  - ``configs`` (only for multi config dependencies, see below)
 

diff --git a/reference/generators/make.rst b/reference/generators/make.rst
@@ -45,6 +45,10 @@ Variables per package. The ``<PKG-NAME>`` placeholder is filled with the name of
 +--------------------------------------+-------------------------------------------------------------------------+
 | CONAN_EXELINK_FLAGS_<PKG-NAME>       | Executable linker flags                                                 |
 +--------------------------------------+-------------------------------------------------------------------------+
+| CONAN_FRAMEWORKS_<PKG-NAME>          | Frameworks (OSX)                                                        |
++--------------------------------------+-------------------------------------------------------------------------+
+| CONAN_FRAMEWORK_PATHS_<PKG-NAME>     | Framework folders (OSX)  (default {CONAN_XXX_ROOT}/Frameworks           |
++--------------------------------------+-------------------------------------------------------------------------+
 
 Conan also declares some **global variables** with the aggregated values of all our requirements. The values are ordered in the right order
 according to the dependency tree.
@@ -78,6 +82,10 @@ according to the dependency tree.
 +--------------------------------+----------------------------------------------------------------------+
 | CONAN_EXELINKFLAGS             | Aggregated Executable linker flags                                   |
 +--------------------------------+----------------------------------------------------------------------+
+| CONAN_FRAMEWORKS               | Aggregated frameworks (OSX)                                          |
++--------------------------------+----------------------------------------------------------------------+
+| CONAN_FRAMEWORK_PATHS          | Aggregated framework folders (OSX)                                   |
++--------------------------------+----------------------------------------------------------------------+
 
 .. important::
 

diff --git a/reference/generators/text.rst b/reference/generators/text.rst
@@ -44,6 +44,10 @@ For each requirement ``conanbuildinfo.txt`` file declares the following sections
 +-----------------------------+---------------------------------------------------------------------+
 | [cppflags_XXX]              | List with C++ compilation flags                                     |
 +-----------------------------+---------------------------------------------------------------------+
+| [frameworks_XXX]            | List with the framework names (OSX)                                 |
++-----------------------------+---------------------------------------------------------------------+
+| [frameworkdirs_XXX]         | List with the frameworks search paths (OSX).                        |
++-----------------------------+---------------------------------------------------------------------+
 | [rootpath_XXX]              | Root path of the package                                            |
 +-----------------------------+---------------------------------------------------------------------+
 
@@ -77,3 +81,7 @@ The values are ordered in the right order according to the dependency tree.
 +-----------------------------+---------------------------------------------------------------------+
 | [cppflags]                  | List with aggregated C++ compilation flags                          |
 +-----------------------------+---------------------------------------------------------------------+
+| [frameworks]                | List with aggregated framework names (OSX)                          |
++-----------------------------+---------------------------------------------------------------------+
+| [frameworkdirs]             | List with aggregated frameworks search paths (OSX).                 |
++-----------------------------+---------------------------------------------------------------------+
diff --git a/reference/generators/virtualrunenv.rst b/reference/generators/virtualrunenv.rst
@@ -45,4 +45,5 @@ Variables declared
 +--------------------+---------------------------------------------------------------------+
 | DYLD_LIBRARY_PATH  | ``lib`` folders of  your requirements.                              |
 +--------------------+---------------------------------------------------------------------+
-
+| DYLD_FRAMEWORK_PATH| ``framework_paths`` folders of  your requirements.                  |
++--------------------+---------------------------------------------------------------------+
diff --git a/reference/generators/xcode.rst b/reference/generators/xcode.rst
@@ -15,20 +15,20 @@ The **xcode** generator creates a file named ``conanbuildinfo.xcconfig`` that ca
 
 The file declare these variables:
 
-+--------------------------------+----------------------------------------------------------------------+
-| VARIABLE                       | VALUE                                                                |
-+================================+======================================================================+
-| HEADER_SEARCH_PATHS            | The requirements `include dirs`                                      |
-+--------------------------------+----------------------------------------------------------------------+
-| LIBRARY_SEARCH_PATHS           | The requirements `lib dirs`                                          |
-+--------------------------------+----------------------------------------------------------------------+
-| OTHER_LDFLAGS                  | `-lXXX` corresponding to library names                               |
-+--------------------------------+----------------------------------------------------------------------+
-| GCC_PREPROCESSOR_DEFINITIONS   | The requirements definitions                                         |
-+--------------------------------+----------------------------------------------------------------------+
-| OTHER_CFLAGS                   | The requirements cflags                                              |
-+--------------------------------+----------------------------------------------------------------------+
-| OTHER_CPLUSPLUSFLAGS           | The requirements cxxflags                                            |
-+--------------------------------+----------------------------------------------------------------------+
-| FRAMEWORK_SEARCH_PATHS         | The requirements root folders, so xcode can find packaged frameworks |
-+--------------------------------+----------------------------------------------------------------------+
++--------------------------------+---------------------------------------------------------------------------+
+| VARIABLE                       | VALUE                                                                     |
++================================+===========================================================================+
+| HEADER_SEARCH_PATHS            | The requirements `include dirs`                                           |
++--------------------------------+---------------------------------------------------------------------------+
+| LIBRARY_SEARCH_PATHS           | The requirements `lib dirs`                                               |
++--------------------------------+---------------------------------------------------------------------------+
+| OTHER_LDFLAGS                  | `-lXXX` corresponding to library names                                    |
++--------------------------------+---------------------------------------------------------------------------+
+| GCC_PREPROCESSOR_DEFINITIONS   | The requirements definitions                                              |
++--------------------------------+---------------------------------------------------------------------------+
+| OTHER_CFLAGS                   | The requirements cflags                                                   |
++--------------------------------+---------------------------------------------------------------------------+
+| OTHER_CPLUSPLUSFLAGS           | The requirements cxxflags                                                 |
++--------------------------------+---------------------------------------------------------------------------+
+| FRAMEWORK_SEARCH_PATHS         | The requirements framework folders, so xcode can find packaged frameworks |
++--------------------------------+---------------------------------------------------------------------------+