Mxx_ru 1.3.2 → 1.4.0

data/lib/mxx_ru/util.rb

@@ -30,6 +30,7 @@ require 'rbconfig'
 require 'singleton'
 
 require 'mxx_ru/ex'
+require 'mxx_ru/cmd_line_option_processor'
 
 module MxxRu
 
@@ -57,36 +58,119 @@ module MxxRu
     class Mode
       include Singleton
 
-      attr_reader :is_clean
-      attr_reader :is_rebuild
-      attr_reader :is_show_cmd
-      attr_reader :is_keep_tmps
-      attr_reader :is_show_tmps
-      attr_reader :is_brief_desc
+      # Option parser for common Mxx_ru options.
+      #
+      # Since v.1.4.0
+      class OptionParser
+        include Singleton
+
+        # Exception for case when '--mxx-clean' and '--mxx-rebuild' used
+        # together.
+        class CleanAndRebuildUsedTogetherEx < Ex
+          def initialize
+            super "Mode #{MXXARG_CLEAN} and #{MXXARG_REBUILD} cannot be " +
+                "used together"
+          end
+        end
+
+        attr_reader :is_brief_desc
+        attr_reader :is_brief_desc_disabled
+        attr_reader :is_clean
+        attr_reader :is_dry_run
+        attr_reader :is_keep_tmps
+        attr_reader :is_rebuild
+        attr_reader :is_show_cmd
+        attr_reader :is_show_tmps
 
-      # Exception for case when '--mxx-clean' and '--mxx-rebuild' used
-      # together.
-      class CleanAndRebuildUsedTogetherEx < Ex
         def initialize
-          super "Mode #{MXXARG_CLEAN} and #{MXXARG_REBUILD} cannot be " +
-              "used together"
+          @is_brief_desc = false
+          @is_brief_desc_disabled = false
+          @is_clean = false
+          @is_dry_run = false
+          @is_keep_tmps = false
+          @is_rebuild = false
+          @is_show_cmd = false
+          @is_show_tmps = false
+        end
+
+        def prepare( parser )
+          parser.separator ''
+          parser.separator 'Common Mxx_ru options:'
+
+          parser.on( MXXARG_CLEAN, 'Clean up project' ) do
+            @is_clean = true
+            check_clean_and_rebuild_correctness
+          end
+
+          parser.on( MXXARG_REBUILD,
+              'Clean up and then build project again' ) do
+            @is_rebuild = true
+            check_clean_and_rebuild_correctness
+          end
+
+          parser.on( MXXARG_SHOW_CMD,
+              'Show commands during build process' ) do
+            @is_show_cmd = true
+          end
+
+          parser.on( MXXARG_KEEP_TMPS,
+              'Keep temporary files after build finihed' ) do
+            @is_keep_tmps = true
+          end
+
+          parser.on( MXXARG_SHOW_TMPS,
+              'Show content of temporary files during build process' ) do
+            @is_show_tmps = true
+          end
+
+          parser.on( MXXARG_BRIEF_DESC,
+              'Enable displaying short description of build steps' ) do
+            @is_brief_desc = true
+          end
+
+          parser.on( MXXARG_BRIEF_DESC_DISABLED,
+              'Disable displaying short description of build steps' ) do
+            @is_brief_desc_disabled = true
+          end
+
+          parser.on( MXXARG_DRY_RUN,
+              'Build imitation mode, no actual actions perfomed' ) do
+            @is_dry_run = true
+          end
+        end
+
+      private
+        # Throws exception if --mxx-clean and --mxx-rebuild specified
+        # at the same time.
+        def check_clean_and_rebuild_correctness
+          raise CleanAndRebuildUsedTogetherEx.new if @is_clean && @is_rebuild
+        end
+      end # class OptionParser
+
+      # Method for generation methods like is_clean, is_rebuild, etc.
+      def Mode.generate_option_reader( option )
+        class_eval do
+          define_method( option ) do
+            OptionParser.instance.send( option )
+          end
         end
       end
 
+      generate_option_reader :is_clean
+      generate_option_reader :is_rebuild
+      generate_option_reader :is_show_cmd
+      generate_option_reader :is_keep_tmps
+      generate_option_reader :is_show_tmps
+      attr_reader :is_brief_desc
+
       # Constructor checks for special arguments in command line.
       def initialize
-        @is_clean = ARGV.include?( MXXARG_CLEAN )
-        @is_rebuild = ARGV.include?( MXXARG_REBUILD )
-        raise CleanAndRebuildUsedTogetherEx.new if @is_clean and @is_rebuild
+        CmdLineOptionProcessor.instance.parse
 
-        @is_show_cmd = ARGV.include?( MXXARG_SHOW_CMD )
-        @is_keep_tmps = ARGV.include?( MXXARG_KEEP_TMPS )
-        @is_show_tmps = ARGV.include?( MXXARG_SHOW_TMPS )
-        @is_dry_run = ARGV.include?( MXXARG_DRY_RUN )
-        @is_brief_desc = ARGV.include?( MXXARG_BRIEF_DESC )
-        @is_brief_desc_disabled = ARGV.include?( MXXARG_BRIEF_DESC_DISABLED )
+        @is_brief_desc = OptionParser.instance.is_brief_desc
+        @is_brief_desc = false if OptionParser.instance.is_brief_desc_disabled
 
-        @is_brief_desc = false if @is_brief_desc_disabled
+        @is_dry_run = OptionParser.instance.is_dry_run
 
         @is_manual_dry_run = false
       end
@@ -109,7 +193,7 @@ module MxxRu
       # Try to manually enable 'show-brief' mode. Attempt ignored if
       # '--mxx-show-brief-disabled' was specified.
       def try_enable_show_brief
-        @is_brief_desc = true unless @is_brief_desc_disabled
+        @is_brief_desc = true unless OptionParser.instance.is_brief_desc_disabled
       end
 
     end
@@ -338,3 +422,7 @@ module MxxRu
 
 end # module MxxRu
 
+# Common Mxx_ru option parser must be added.
+MxxRu::CmdLineOptionProcessor.instance.add_processor(
+    MxxRu::Util::Mode::OptionParser.instance )
+

data/lib/mxx_ru/version.rb

@@ -0,0 +1,38 @@
+#--
+# Copyright (c) 1996-2004, Yauheni Akhotnikau
+# Copyright (c) 2004-2006, JSC Intervale
+# Copyright (c) 2006, 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.
+#++
+
+# Must be used anywhere where version of Mxx_ru required.
+#
+# For example:
+#
+#   require 'mxx_ru/version'
+#
+#   puts 'Mxx_ru version is: ' + MXX_RU_VERSION
+#
+MXX_RU_VERSION = '1.4.0'
+

data/tests/mxx_ru/generators/cpp/tc_generator.rb

@@ -0,0 +1,34 @@
+require 'test/unit'
+
+require 'mxx_ru/generators/impl/cpp/generation'
+
+class TC_GeneratorsCppTemplateParams < Test::Unit::TestCase
+  MODULE = MxxRu::Generators::Impl::Cpp
+
+  class TestReceiver
+    attr_reader :result
+
+    def receive( generation_result, output_file_name )
+      @result = generation_result
+    end
+  end
+
+  def test_empty_args
+    r = TestReceiver.new
+    assert_nothing_raised do
+      MODULE.generate_for( MODULE::EXE, [], r )
+    end
+  end
+
+  def test_implib_path_defined
+    r = TestReceiver.new
+    path = 'lib'
+
+    assert_nothing_raised do
+      MODULE.generate_for( MODULE::EXE, ['--implib-path', path], r )
+    end
+
+    assert_equal( true, r.result.include?( "implib_path '#{path}'" ) )
+  end
+end
+

data/tests/mxx_ru/generators/cpp/tc_options.rb

@@ -0,0 +1,79 @@
+require 'test/unit'
+
+require 'mxx_ru/generators/impl/cpp/generation'
+
+class TC_GeneratorsCpp < Test::Unit::TestCase
+  MODULE = MxxRu::Generators::Impl::Cpp
+
+  def test_empty_args
+    # All values expected to be nil.
+
+    result = MODULE::Options.parse( [], 'dummy banner', {} )
+
+    assert_nil( result.target_name )
+    assert_nil( result.project_path )
+    assert_nil( result.implib_path )
+    assert_nil( result.output_file )
+  end
+
+  def test_target_name
+    result = MODULE::Options.parse(
+        %w{-t some_target_name},
+        '',
+        {} )
+
+    assert_equal( 'some_target_name', result.target_name )
+  end
+
+  def test_target_name_and_project_path
+    result1 = MODULE::Options.parse(
+        %w{some/path --target some_target},
+        '',
+        {} )
+
+    assert_equal( 'some/path', result1.project_path )
+    assert_equal( 'some_target', result1.target_name )
+
+    result2 = MODULE::Options.parse(
+        %w{--target another_target another/path},
+        '',
+        {} )
+
+    assert_equal( 'another/path', result2.project_path )
+    assert_equal( 'another_target', result2.target_name )
+  end
+
+  def test_output_file
+    result = MODULE::Options.parse(
+        %w{some/path -t some_target -o out.rb},
+        '',
+        {} )
+
+    assert_equal( 'some/path', result.project_path )
+    assert_equal( 'some_target', result.target_name )
+    assert_equal( 'out.rb', result.output_file )
+  end
+
+  def test_implib_path_disabled
+    assert_raise( OptionParser::InvalidOption ) do
+      result = MODULE::Options.parse(
+          %w{--implib-path lib}, '', {} )
+    end
+
+    assert_raise( OptionParser::InvalidOption ) do
+      result = MODULE::Options.parse(
+          %w{--implib-path lib}, '', { :implib_path => false } )
+    end
+  end
+
+  def test_implib_path_enabled
+    result = nil
+    assert_nothing_raised( OptionParser::InvalidOption ) do
+      result = MODULE::Options.parse(
+          %w{--implib-path lib}, '', { :implib_path => true } )
+
+      assert_equal( 'lib', result.implib_path )
+    end
+  end
+end
+

data/tests/mxx_ru/generators/cpp/tc_template_params.rb

@@ -0,0 +1,45 @@
+require 'test/unit'
+
+require 'mxx_ru/generators/impl/cpp/generation'
+
+class TC_GeneratorsCppTemplateParams < Test::Unit::TestCase
+  MODULE = MxxRu::Generators::Impl::Cpp
+
+  def test_empty_options
+    t1 = MODULE::TemplateParams.new( MODULE::LIB, MODULE::Options.new )
+    assert_equal( 'lib_target', t1.setup_target_function )
+    assert_equal( false, t1.has_or_require_implib )
+    assert_equal( MODULE::TemplateParams::YOUR_TARGET_NAME, t1.target_name )
+
+    t2 = MODULE::TemplateParams.new( MODULE::DLL, MODULE::Options.new )
+    assert_equal( 'dll_target', t2.setup_target_function )
+    assert_equal( true, t2.has_or_require_implib )
+    assert_equal( MODULE::TemplateParams::YOUR_IMPLIB_PATH, t2.implib_path )
+  end
+
+  def test_target_name_in_options
+    o = MODULE::Options.new
+    o.target_name = 'my.target'
+    o.project_path = 'some/path'
+    t = MODULE::TemplateParams.new( MODULE::LIB, o )
+
+    assert_equal( o.target_name, t.target_name )
+  end
+
+  def test_project_path_in_options
+    o = MODULE::Options.new
+    o.project_path = 'some/path\for/target'
+    t = MODULE::TemplateParams.new( MODULE::LIB, o )
+
+    assert_equal( 'some.path.for.target', t.target_name )
+  end
+
+  def test_implib_path_in_options
+    o = MODULE::Options.new
+    o.implib_path = 'some/path'
+    t = MODULE::TemplateParams.new( MODULE::EXE, o )
+
+    assert_equal( o.implib_path, t.implib_path )
+  end
+end
+

data/tests/mxx_ru/lib_collection/a.cpp

@@ -0,0 +1,8 @@
+#include <cstdio>
+
+void
+a()
+  {
+    std::printf( "a()\n" );
+  }
+

data/tests/mxx_ru/lib_collection/a.hpp

@@ -0,0 +1,8 @@
+#if !defined( A_HPP )
+#define A_HPP
+
+void
+a();
+
+#endif
+

data/tests/mxx_ru/lib_collection/a.rb

@@ -0,0 +1,8 @@
+require 'mxx_ru/cpp'
+
+MxxRu::Cpp::lib_target {
+  target 'A'
+
+  cpp_source 'a.cpp'
+}
+

data/tests/mxx_ru/lib_collection/b.cpp

@@ -0,0 +1,8 @@
+#include <cstdio>
+
+void
+b()
+  {
+    std::printf( "b()\n" );
+  }
+

data/tests/mxx_ru/lib_collection/b.hpp

@@ -0,0 +1,8 @@
+#if !defined( B_HPP )
+#define B_HPP
+
+void
+b();
+
+#endif
+

data/tests/mxx_ru/lib_collection/b.rb

@@ -0,0 +1,8 @@
+require 'mxx_ru/cpp'
+
+MxxRu::Cpp::lib_target {
+  target 'B'
+
+  cpp_source 'b.cpp'
+}
+

data/tests/mxx_ru/lib_collection/c.cpp

@@ -0,0 +1,8 @@
+#include <cstdio>
+
+void
+c()
+  {
+    std::printf( "c()\n" );
+  }
+

data/tests/mxx_ru/lib_collection/c.hpp

@@ -0,0 +1,8 @@
+#if !defined( C_HPP )
+#define C_HPP
+
+void
+c();
+
+#endif
+