Porting Dependent Library

CommonLib.porter.config is quite simple. It begins with an XML declaration, which specifies that the file contains an XML document.  

Then goes the XML root element <porter> which is mandatory for Porter configuration XML document  

    <porter>  

Next, the default Porter configuration file is imported using <import> element. The default configuration assigns default values to all configuration options.  

    <import config="porter.config"/>  

And the XML document is finished with closing tag of the root element <porter>:  

    </porter>

DependentLibrary.porter.config begins with an XML declaration, which specifies that the file contains an XML document   

Then goes the XML root element <porter> which is mandatory for Porter configuration XML document   

    <porter>   

Next, the default Porter configuration file is imported using <import> element. The default configuration will assign default values to all configuration options   

    <import config="porter.config"/>   

Also we need to import a configuration file include_map.config from ported CommonLib project that maps public types exported by CommonLib library to generated C++ header files in which these types are declared. include_map.config is generated by Porter for each project it ports. Thus, before porting DependentLibrary project, CommonLib project has to be ported first so that Porter generates include_map.config. This is how include_map.config is included in DependentLibrary.porter.config  

    <import config="../../output/CommonLib.Cpp/include_map.config" />   

Here ../../output is a directory that was passed as an output directory to Porter when CommonLib project was ported.  

This example assumes that C# project DependentLibrary should be ported into C++ shared/dynamic library project, therefore we assign value ‘true’ to make_shared_lib option:

    <opt name="make_shared_lib" value="true" export_per_member="true"/>

Next, we want Porter to add some commands to the output CMakeLists.txt file. We do that by adding <cmake_commands> element to the configuration file containing raw Cmake commands  

    <cmake_commands>  
       <![CDATA[

The following commands set the output directory for the library’s binary by setting the corresponding properties on the target ${PROJECT_NAME}:  

    set_target_properties(${PROJECT_NAME} PROPERTIES RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/../bin")
    set_target_properties(${PROJECT_NAME} PROPERTIES LIBRARY_OUTPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/../bin")  

Here ${PROJECT_NAME} is the name of the Cmake project which is equal to the name of the main Cmake executable target.  

Because on “DLL-platforms” (i.e. Windows) a DLL shared library is considered by Cmake an executable entity and on “non-DLL-platforms” (i.e. Linux) a shared object is considered by Cmake a library, we set both RUNTIME_OUTPUT_DIRECTORY and LIBRARY_OUTPUT_DIRECTORY properties.

Then the <cmake_commands> element is closed   

      ]]>   
    </cmake_commands>   

Then, we need to tell Porter that DependentLibrary project depends on CommonLib library. We do it using <lib> element:   

    <lib name="CommonLib.Cpp" csname="CommonLib">   
      <cmake_link_template>   
        <![CDATA[
          find_package(CommonLib.Cpp REQUIRED CONFIG PATHS "${CMAKE_CURRENT_SOURCE_DIR}/../CommonLib.Cpp" NO_DEFAULT_PATH)   
          target_link_libraries(${PROJECT_NAME}_dependencies INTERFACE CommonLib.Cpp)           ]]>   
     </cmake_link_template>   
    </lib>   

Here ${PROJECT_NAME}dependencies is the name of the Cmake Interface Library target that is defined in the output _CMakeLists.txt file and is linked to main executable target ${PROJECT_NAME}. Thus libraries linked to ${PROJECT_NAME}_dependencies get automatically linked to ${PROJECT_NAME} target.   
Finally the XML document is finished with closing tag of the root element <porter>   

</porter>