Mxx_ru 1.6.10.1 → 1.6.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4a5d6f710b5089948eef9011789f6b721aa283d
-  data.tar.gz: 4b6dcd63781c43e5073131dbefab3abc965abbbc
+  metadata.gz: 697cc2084b112e7ca1cfba8406bed2eb81348381
+  data.tar.gz: d5f235271c3609516dc81474a69461f0e5215cd7
 SHA512:
-  metadata.gz: be0a4bb10bd7f3e4a2706051ade9eee586b54fc808ef5c0e930ab239611ae7f21058a0fd108e4f027be5743d31296c046247ae540c9b1550802d36296b35316d
-  data.tar.gz: 1a40070ec8fcbe916e69945f983e17c35c472409a9dea3a7b8d090490de087d4466a1ab26b4f41aa96b87f295d6aa41031e57fb6b13e1048ca8a837a5691505e
+  metadata.gz: ac2ed6842dceedf6a7712aa808f4b4c7d5e583f2cae29a05603428b2cd25dfa1345df1e7c4d51ec65cbff0d457c3e3d3c90d652ab5f0e300b4a8f61fb13e630e
+  data.tar.gz: d3b1017f16864ebe875a379053f5ac059464adb6d4d45d333385fec3ed3f2e4517a9525a4365ac9c57af2337f092fa855b05d32c4847edf097cbf4e8aa337ab9

data/NEWS

@@ -1,5 +1,22 @@
 Changes in Mxx_ru
 
+1.6.11 version (2016.04.25)
+
+  New ext_cmake_project target type added for C++ projects.
+
+  New method make_identification_string for toolset added.
+
+  New templates for mxxrugen: ext-cmake-prj and externals.
+
+1.6.10 version (2016.04.19)
+
+  Method map for MxxRu::externals is deprecated.
+
+  New tool mxxruexternals added to executables.
+
+  New working scheme for MxxRu::externals (now MxxRu::externals stores
+  info about previous version of externals description).
+
 1.6.9 version (2016.03.31)
 
   Support of stars in src- and dst-names in map_dir/map_file (MxxRu::externals).

data/lib/mxx_ru/cpp.rb

@@ -1,7 +1,7 @@
 #--
 # Copyright (c) 1996-2004, Yauheni Akhotnikau
 # Copyright (c) 2004-2006, JSC Intervale
-# Copyright (c) 2006-2015, The Mxx_ru Project
+# Copyright (c) 2006-2016, The Mxx_ru Project
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -35,5 +35,7 @@ require 'mxx_ru/cpp/lib_collection'
 
 require 'mxx_ru/cpp/obj_placements/custom_subdir'
 
+require 'mxx_ru/cpp/ext_cmake_project'
+
 # Determining which toolset should be used.
 MxxRu::Cpp::detect_toolset

data/lib/mxx_ru/cpp/ext_cmake_project.rb

@@ -0,0 +1,473 @@
+#--
+# Copyright (c) 1996-2004, Yauheni Akhotnikau
+# Copyright (c) 2004-2006, JSC Intervale
+# Copyright (c) 2006-2016, The Mxx_ru Project
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+# 3. The name of the author may not be used to endorse or promote products derived
+#    from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
+# WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+# AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+# ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#++
+
+require 'mxx_ru/cpp/composite'
+require 'mxx_ru/cpp/toolset'
+
+require 'mxx_ru/cpp/toolsets/gcc_family'
+
+require 'mxx_ru/util'
+
+require 'fileutils'
+
+module MxxRu
+module Cpp
+
+# Target type is an external CMake project.
+#
+# Since v.1.6.11
+class ExtCMakeProjectTargetType < TargetType
+  TYPE = "ext_cmake_project"
+
+  def name
+    return TYPE
+  end
+end
+
+class CMakeProjectLocationNotDefined < Ex
+  def initialize( prj_alias )
+    super( "Location of CMakeLists.txt is not defined for #{prj_alias}" )
+  end
+end
+
+# External CMake project.
+#
+# Since v.1.6.11
+class ExtCMakeProjectTarget < CompositeTarget
+  class BuildingContext
+    attr_accessor :cmakelists_location
+    attr_accessor :cmake_build_dir
+    attr_accessor :install_prefix
+    attr_accessor :install_includedir
+    attr_accessor :install_libdir
+    attr_accessor :install_bindir
+  end
+
+  def initialize( a_alias, &block )
+    @mxx_cmake_defs = {}
+    @mxx_includedir_subfolders = []
+
+    super( a_alias )
+
+    if @mxx_cmakelists_location.nil?
+      raise CMakeProjectLocationNotDefined.new( a_alias )
+    end
+  end
+
+  # Set the location of external project's CMakeLists.txt file.
+  #
+  # This is mandatory parameter.
+  #
+  # NOTE. _location_ must be a relative path.
+  #
+  # Usage example:
+  #
+  #   MxxRu::Cpp::ext_cmake_project {
+  #     where 'soci' # It means that 'soci' must be subfolder of
+  #                  # the prject's root folder.
+  #     ...
+  #   }
+  #
+  def where( location )
+    @mxx_cmakelists_location = location
+  end
+
+  # Set values to be passes to cmake commands via -D option.
+  #
+  # Usage example:
+  #
+  #   MxxRu::Cpp::ext_cmake_project {
+  #     where 'soci'
+  #
+  #     with WITH_BOOST: :ON, WITH_ORACLE: :OFF
+  #     with :SOCI_EMPTY => 'OFF'
+  #     with :SOCI_SHARED => 'ON', :SOCI_STATIC => 'OFF'
+  #     with SOCI_TESTS: :OFF
+  #   }
+  #
+  def with( options )
+    @mxx_cmake_defs.merge!( options )
+  end
+
+  # Set the name of folder in which cmake-controlled build
+  # will be performed. If this name is not specified then
+  # name of that folder will be generated automatically
+  # (it will be based on toolset name and build mode).
+  # 
+  # Note: this folder is always created in location defined
+  # by obj_placement. Because of that is cannot be absolute path.
+  #
+  def build_dir_name( name )
+    @mxx_cmake_build_dir_name = name
+  end
+
+  # Set name of folder for header files.
+  #
+  # This name will be passed to cmake command via -DINCLUDEDIR option.
+  #
+  # Usage example:
+  #
+  #   MxxRu::Cpp::ext_cmake_project {
+  #     where 'soci'
+  #
+  #     install_includedir 'soci_headers'
+  #     ...
+  #   }
+  #
+  def install_includedir( dir )
+    @mxx_cmake_install_includedir = dir
+  end
+
+  # Set a name of includedir subfolder to be added to include path
+  # of all dependent targets.
+  #
+  # Sometimes a project can have several subfolder in its include directory.
+  # Something like that:
+  #
+  #   some_project
+  #   `- include/
+  #      `- subfolder1/
+  #      `- subfolder2/
+  #      `- subfolder3
+  #
+  # When cmake install will be performed all these subfolders will be
+  # installed into install_includedir. But only install_includedir
+  # will be added to include path. It means that header files from
+  # these subfolders must be included as:
+  #
+  #   #include <subfolder1/first_header.hpp>
+  #   #include <subfolder2/second_header.hpp>
+  #   ...
+  #
+  # It could be inappropriate. In that case includedir_subfolder can
+  # be used:
+  #
+  #   MxxRu::Cpp::ext_cmake_project {
+  #     where 'soci'
+  #
+  #     install_includedir 'soci_headers'
+  #     includedir_subfolder 'soci'
+  #     includedir_subfolder 'soci/postgresql'
+  #     ...
+  #   }
+  #
+  def includedir_subfolder( name )
+    @mxx_includedir_subfolders << name
+  end
+
+  # Same as includedir_subfolder but allow to specify several folder
+  # names at once.
+  #
+  # For example:
+  #
+  #   MxxRu::Cpp::ext_cmake_project {
+  #     where 'soci'
+  #
+  #     install_includedir 'soci_headers'
+  #     includedir_subfolders 'soci', 'soci/postgresql'
+  #     ...
+  #   }
+  #
+  def includedir_subfolders( *names )
+    @mxx_includedir_subfolders.push( *names )
+  end
+
+  def target_type
+    return ExtCMakeProjectTargetType.new
+  end
+
+  def build
+    if nil == @mxx_last_build_result
+      super
+
+      # Actual result must be set only after CMake-related build steps.
+      @mxx_last_build_result = nil
+      @mxx_last_build_result = do_cmake_specific_build
+    end
+
+    @mxx_last_build_result
+  end
+
+  def clean
+    do_cmake_specific_clean
+    super
+  end
+
+private
+  INSTALL_MANIFEST = 'install_manifest.txt'
+
+  def do_cmake_specific_build
+    ctx = make_building_context
+
+    if !MxxRu::Util::Mode.instance.is_dry_run
+      try_run_cmake_build( ctx )
+    else
+      TargetState.new( TargetState::REBUILT )
+    end
+  end
+
+  def do_cmake_specific_clean
+    ctx = make_building_context
+
+    if !MxxRu::Util::Mode.instance.is_dry_run
+      try_run_cmake_clean( ctx )
+    end
+  end
+
+  def try_run_cmake_build( ctx )
+    # Assume that target is rebuilt.
+    # Actual state will be detected later.
+    target_state = TargetState::REBUILT
+
+    MxxRu::Util::ensure_path_exists( ctx.cmake_build_dir )
+    FileUtils.cd( ctx.cmake_build_dir ) do
+      pre_build_state = detect_build_results_state
+
+      run_cmake( ctx )
+      run_native_build
+
+      target_state = compare_build_results_states(
+          pre_build_state, detect_build_results_state )
+    end
+
+    # If everything is all right then include path and library paths
+    # must be set for all dependent targets.
+    include_path( ctx.install_includedir, OPT_UPSPREAD )
+    @mxx_includedir_subfolders.each do |folder|
+      include_path( File.join( ctx.install_includedir, folder ), OPT_UPSPREAD )
+    end
+    lib_path( ctx.install_libdir )
+
+    TargetState.new( target_state )
+  end
+
+  def try_run_cmake_clean( ctx )
+    if File.directory?( ctx.cmake_build_dir )
+      FileUtils.cd( ctx.cmake_build_dir ) do
+        clean_installed_files
+        run_native_clean
+      end
+      FileUtils.rm_r( ctx.cmake_build_dir, file_utils_options )
+    end
+  end
+
+  # Returns hash where key is a file name and value is file modification time.
+  def detect_build_results_state
+    result = {}
+    do_with_install_manifest_content do |filename|
+      if File.exists?( filename )
+        result[ filename ] = File.mtime( filename )
+      end
+    end
+    result
+  end
+
+  # Compares old and new states and returns TargetState::EXISTS or
+  # TargetState::REBUILT
+  #
+  def compare_build_results_states( old_state, new_state )
+    # Keeps files which are not present in old_state or
+    # files with new modification time.
+    new_state.keep_if do |name, mtime|
+      old_mtime = old_state.fetch( name, nil )
+      old_mtime.nil? ? true : (old_mtime < mtime)
+    end
+    new_state.empty? ? TargetState::EXISTS : TargetState::REBUILT
+  end
+
+  # NOTE. This method must be called when cmake working dir
+  # is the current directory.
+  def run_cmake( ctx )
+    cmd_line = "cmake -DCMAKE_BUILD_TYPE=#{detect_cmake_build_type} "
+    cmd_line += "-DCMAKE_INSTALL_PREFIX=#{ctx.install_prefix} "
+
+    cmd_line += "-DINCLUDEDIR=#{ctx.install_includedir} " if ctx.install_includedir
+
+    cmd_line += "-DLIBDIR=#{ctx.install_libdir} " if ctx.install_libdir
+    cmd_line += "-DBINDIR=#{ctx.install_bindir} " if ctx.install_bindir
+    cmd_line += transform_options_to_cmd_line_params
+
+    cmd_line += detect_cmake_compilers
+    cmd_line += "#{detect_cmake_generator} "
+
+    cmd_line += ctx.cmakelists_location
+    AbstractTarget::run(
+        [cmd_line],
+        [],
+        "Running CMake for native build files configuration" )
+  end
+
+  # NOTE. This method must be called when cmake working dir
+  # is the current directory.
+  def run_native_build
+    AbstractTarget::run(
+        ["cmake --build . --target install"],
+        [],
+        "Launching native build via CMake" )
+  end
+
+  # NOTE. This method must be called when cmake working dir
+  # is the current directory.
+  def clean_installed_files
+    do_with_install_manifest_content do |file_to_remove|
+      if File.exists?( file_to_remove )
+        FileUtils.rm( file_to_remove, file_utils_options )
+      end
+    end
+  end
+
+  # NOTE. This method must be called when cmake working dir
+  # is the current directory.
+  def run_native_clean
+    AbstractTarget::run(
+        ["cmake --build . --target clean"],
+        [],
+        "Launching native clean via CMake" )
+  end
+
+  # Open INSTALL_MANIFEST if it exists and call _block_ for every
+  # non-empty name from it.
+  def do_with_install_manifest_content(&block)
+    if File.exists?( INSTALL_MANIFEST )
+      File::open( INSTALL_MANIFEST, 'r' ) do |manifest|
+        manifest.each_line do |line|
+          filename = line.chomp
+          block[ line.chomp ] unless filename.empty?
+        end
+      end
+    end
+  end
+
+  # Create instance of BuildingContext with all members initialized
+  # with appropriate values.
+  def make_building_context
+    ctx = BuildingContext.new
+    ctx.cmakelists_location = File.absolute_path( @mxx_cmakelists_location )
+    ctx.install_prefix = File.absolute_path(
+        mxx_obj_placement.get_lib( '.', toolset, self ) )
+
+    includedir = @mxx_cmake_install_includedir
+    includedir = 'include' unless includedir
+    ctx.install_includedir =
+        File.absolute_path(
+            mxx_obj_placement.get_lib( includedir, toolset, self ) )
+
+    ctx.install_libdir = File.absolute_path(
+        mxx_obj_placement.get_lib( '.', toolset, self ) )
+
+    ctx.cmake_build_dir = File.join(
+        mxx_obj_placement.get_obj( @mxx_cmakelists_location, toolset, self ),
+        create_cmake_build_dir_value )
+
+    ctx
+  end
+
+  # Create local name of cmake working directory.
+  # If `cmake_build_dir` is specified then its value will be used.
+  # Otherwise a name based on toolset id string and build mode
+  # will be created.
+  def create_cmake_build_dir_value
+    if @mxx_cmake_build_dir_name.nil?
+      v = "cmake_build_#{toolset.make_identification_string}_"
+      v += RUNTIME_RELEASE == mxx_runtime_mode ? "release" : "debug"
+    else
+      @mxx_cmake_build_dir_name
+    end
+  end
+
+  # Make part of cmake command line with definitions from 'with' values.
+  def transform_options_to_cmd_line_params
+    r = ''
+    @mxx_cmake_defs.each_pair { |k,v| r += "-D#{k}=#{v} " }
+    r
+  end
+
+  # Returns value for CMAKE_BUILD_TYPE definition.
+  def detect_cmake_build_type
+    RUNTIME_RELEASE == mxx_runtime_mode ? "Release" : "Debug"
+  end
+
+  # Make part of cmake command line with '-G' option and appropriate
+  # value for it.
+  #
+  # NOTE: if there is no known generator name for the toolset
+  # then empty string is returned.
+  def detect_cmake_generator
+    if 'vc' == toolset.name
+      '-G "NMake Makefiles"'
+    elsif 'gcc' == toolset.name
+      k = MxxRu::Cpp::Toolsets::GccFamily
+      if k::GCC_PORT_MINGW == toolset.tag( k::GCC_PORT_TAG, 'unix' )
+        '-G "MinGW Makefiles"'
+      else
+        '-G "Unix Makefiles"'
+      end
+    elsif 'clang' == toolset.name
+      '-G "Unix Makefiles"'
+    else
+      # Return empty string in hope that CMake can detect a generator
+      # by itself.
+      ''
+    end
+  end
+
+  # Make part of cmake command line with CMAKE_C_COMPILER and
+  # CMAKE_CXX_COMPILER definitions.
+  def detect_cmake_compilers
+    "-DCMAKE_C_COMPILER=#{toolset.c_compiler_name} " +
+    "-DCMAKE_CXX_COMPILER=#{toolset.cpp_compiler_name} "
+  end
+
+  def file_utils_options
+    { :verbose => MxxRu::Util::Mode::instance.is_brief_desc }
+  end
+
+end # class ExtCMakeProjectTarget
+
+# Simple method to define externals CMake project.
+#
+# Example:
+#   MxxRu::Cpp::ext_cmake_project {
+#     where 'deps/some_library'
+#
+#     with WITH_SSL: 'NO', WITH_THREADS: 'YES'
+#
+#     install_includedir 'some_library/headers'
+#
+#     includedir_subfolders 'interface', 'backends', 'statistics'
+#   }
+#
+# Since v.1.6.11
+def Cpp.ext_cmake_project( prj_alias = nil, &block )
+  prj_alias = MxxRu::Util::prj_alias_form_caller( caller ) unless prj_alias
+  MxxRu::setup_target ExtCMakeProjectTarget.new( prj_alias, &block )
+end
+
+end # module Cpp
+end # module MxxRu
+