Mxx_ru 1.2.1 → 1.3.0

data/lib/mxx_ru/ex.rb

@@ -26,51 +26,66 @@
 # ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #++
 
-module  Mxx_ru
+module  MxxRu
 
   # Base class for all exceptions.
   class Ex < Exception
   end
 
   # Exception, thrown on execution of 'pure abstract method'.
-  class Abstract_method_ex < Ex
+  class AbstractMethodEx < Ex
     def initialize( method_name )
       super( "Pure virtual method call: " + method_name )
     end
   end
 
+  # For compatibility with previous versions.
+  Abstract_method_ex = AbstractMethodEx
+
   # Exception, thrown if returned object type is not expected.
-  class Invalid_cast_ex < Ex
+  class InvalidCastEx < Ex
     def initialize( msg )
       super( msg )
     end
   end
 
+  # For compatibility with previous versions.
+  Invalid_cast_ex = InvalidCastEx
+
   # Exception, thrown if build commands fail.
-  class Build_ex < Ex
+  class BuildEx < Ex
     def initialize( cmd_line, desc )
       super( "Build error: '#{cmd_line}' returns '#{desc}'" )
     end
   end
 
+  # For compatibility with previous versions.
+  Build_ex = BuildEx
+
   # Exception, thrown if unknown target type is detected.
-  class Unsupported_target_type_ex < Ex
+  class UnsupportedTargetTypeEx < Ex
     def initialize( target_class, target_type )
       super( "Unsupported target type '#{target_type}'" +
         " in '#{target_class}'" )
     end
   end
 
+  # For compatibility with previous versions.
+  Unsupported_target_type_ex = UnsupportedTargetTypeEx 
+
   # Exception, thrown if no target object is found for given alias.
-  class Target_unknown_ex < Ex
+  class TargetUnknownEx < Ex
     def initialize( target_name )
       super( "Target unknown for: " + target_name )
     end
   end
 
+  # For compatibility with previous versions.
+  Target_unknown_ex = TargetUnknownEx
+
   # Exception, thrown if value conflict for global options such as 
   # runtime_mode, rtl_mode, etc is detected
-  class Global_option_conflict_ex < Ex
+  class GlobalOptionConflictEx < Ex
     # [_a_name_] Option name.
     # [_a_current_] Current option value.
     # [_a_current_owner_] Who was set current value.
@@ -89,9 +104,12 @@ module  Mxx_ru
     end
   end
 
-  # Exception, thrown if anyone tries to set invalid value to global options such as
-  # runtime_mode, rtl_mode, etc.
-  class Global_option_disallowed_value_ex < Ex
+  # For compatibility with previous versions.
+  Global_option_conflict_ex = GlobalOptionConflictEx
+
+  # Exception, thrown if anyone tries to set invalid value to global options
+  # such as runtime_mode, rtl_mode, etc.
+  class GlobalOptionDisallowedValueEx < Ex
     # [_a_name_] Option name.
     # [_a_available_values_] Available values list. Should be Array of String.
     # [_a_new_] New option value.
@@ -108,27 +126,40 @@ module  Mxx_ru
     end
   end
 
+  # For compatibility with previous versions.
+  Global_option_disallowed_value_ex = GlobalOptionDisallowedValueEx
+
   # Exception, thrown if some mode is not supported by the toolset.
-  class Unsupported_mode_ex < Ex
+  class UnsupportedModeEx < Ex
     def initialize( msg )
       super( msg )
     end
   end
 
+  # For compatibility with previous versions.
+  Unsupported_mode_ex = UnsupportedModeEx
+
   # Exception, thrown if some dependency file is missing.
-  class Missing_depend_file_ex < Ex
+  class MissingDependFileEx < Ex
     def initialize( missing_file, depend_for )
       super( "File '#{missing_file}' required by '#{depend_for}' " +
         "missing" )
     end
   end
 
+  # For compatibility with previous versions.
+  Missing_depend_file_ex = MissingDependFileEx
+
   # Exception, thrown if some value is invalid in current context.
-  class Invalid_value_ex < Ex
+  class InvalidValueEx < Ex
     def initialize( msg )
       super( msg )
     end
   end
 
+  # For compatibility with previous versions.
+  Invalid_value_ex = InvalidValueEx
+
 end
 
+load File.dirname( __FILE__ ) + '/compat.rb'

data/lib/mxx_ru/makestyle_generator.rb

@@ -28,19 +28,19 @@
 
 require 'mxx_ru/abstract_target.rb'
 
-module Mxx_ru
+module MxxRu
 
 # A Generator, which allows to define simple make rules in a project.
 #
 # For example, if it's needed to get from ddl file two other files, 
 # cpp and hpp, using typegen program, it should be done like that:
-#  generator( Mxx_ru::Makestyle_generator.new(
+#  generator( MxxRu::MakestyleGenerator.new(
 #    [ "myfile.cpp", "myfile.hpp" ],
 #    [ "myfile.ddl" ],
 #    [ "typegen --from myfile.ddl --cpp myfile.cpp --header myfile.hpp" ] ) )
 #
 # NOTE: For C++ projects current value of sources_root isn't taken into account.
-class Makestyle_generator < Abstract_generator
+class MakestyleGenerator < AbstractGenerator
   # File names list, which should be built by given generator.
   attr_reader :target_files
 
@@ -52,21 +52,25 @@ class Makestyle_generator < Abstract_generator
 
   # Command list, which should be ran in a sequence to remove result files.
   #
-  # If this list is empty, removal of result files would occur on clean operation.
+  # If this list is empty, removal of result files would occur on clean
+  # operation.
   attr_reader :clean_cmds
 
   # Constructor.
   #
   # [_a_target_files_] Result files list.
   # [_a_dependencies_] Dependencies list.
-  # [_a_build_cmds_] Command list, which should be ran in a sequence to get result files.
-  # [_a_clean_cmds_] Command list, which should be ran in a sequence to remove result files.
+  # [_a_build_cmds_] Command list, which should be ran in a sequence to get
+  #                  result files.
+  # [_a_clean_cmds_] Command list, which should be ran in a sequence to remove
+  #                  result files.
   #
-  # NOTE: Single values may be defined as a strings instead of vectors. For example:
-  #  Mxx_ru::Makestyle_generator.new( "myfile.cpp", "myfile.ddl",
+  # NOTE: Single values may be defined as a strings instead of vectors. For
+  # example:
+  #  MxxRu::MakestyleGenerator.new( "myfile.cpp", "myfile.ddl",
   #    [ "typegen --from myfile.ddl --to myfile.cpp" ] )
   # It's the same as:
-  #  Mxx_ru::Makestyle_generator.new( [ "myfile.cpp" ], [ "myfile.ddl" ],
+  #  MxxRu::MakestyleGenerator.new( [ "myfile.cpp" ], [ "myfile.ddl" ],
   #    "typegen --from myfile.ddl --to myfile.cpp" )
   #
   def initialize(
@@ -90,7 +94,7 @@ class Makestyle_generator < Abstract_generator
     # Checking all result files. If one of them is obsolete, performing rebuild.
     index = 0
     while !need_build && index != @target_files.size
-      if Target_state::EXISTS != Target_state.detect(
+      if TargetState::EXISTS != TargetState.detect(
         @target_files[ index ], @dependencies ).state
         need_build = true
       else
@@ -100,7 +104,7 @@ class Makestyle_generator < Abstract_generator
 
     if need_build
       # It's required to run all commands to build target.
-      Abstract_target.run(
+      AbstractTarget.run(
           @build_cmds,
           [],
           "building #{@target_files.join(', ')}" )
@@ -137,5 +141,6 @@ protected
   end
 end
 
+# For compatibility with previous versions.
+Makestyle_generator = MakestyleGenerator
 end
-

data/lib/mxx_ru/textfile_unittest.rb

@@ -29,30 +29,31 @@
 require 'mxx_ru/ex'
 require 'mxx_ru/abstract_target'
 
-module Mxx_ru
+module MxxRu
 
 # The class of a target, which is binary unit-test application, which create
 # one or many text files.
-# Given target performs a build of application, and then runs it and compares results
-# with files which contains correct results.
 #
-# The basic idea consists in the presence of project file, which controls the build
-# of unit-test application. In that project file, target object is created, inherited
-# from Mxx_ru::Binary_target.
-# To start unit-test it's necessary to create one more file, where target object of 
-# Mxx_ru::Textfile_unittest_target class is created. 
+# Given target performs a build of application, and then runs it and compares
+# results with files which contains correct results.
+#
+# The basic idea consists in the presence of project file, which controls the
+# build of unit-test application. In that project file, target object is
+# created, inherited from MxxRu::BinaryTarget.  To start unit-test it's
+# necessary to create one more file, where target object of
+# MxxRu::TextfileUnittestTarget class is created. 
 # For example:
 #
 # Unit-test application build file:
-#  Mxx_ru::setup_target(
-#    Mxx_ru::Cpp::Exe_target.new( "test/pack/prj.rb" ) {
+#  MxxRu::setup_target(
+#    MxxRu::Cpp::ExeTarget.new( "test/pack/prj.rb" ) {
 #      ...
 #    }
 #  )
 #
 # File to run unit-test:
-#  Mxx_ru::setup_target(
-#    Mxx_ru::Textfile_unittest_target.new( 
+#  MxxRu::setup_target(
+#    MxxRu::TextfileUnittestTarget.new( 
 #      "test/pack/pack.ut.rb",
 #      "test/pack/prj.rb" ) {
 # 
@@ -67,26 +68,29 @@ module Mxx_ru
 #  )
 #
 # File which is using that unit-test.
-#  Mxx_ru::setup_target(
-#    Mxx_ru::Cpp::Composite_target( Mxx_ru::BUILD_ROOT ) {
+#  MxxRu::setup_target(
+#    MxxRu::Cpp::CompositeTarget.new( MxxRu::BUILD_ROOT ) {
 #      required_prj( "some/project/prj.rb" )
 #      required_prj( "test/pack/prj.ut.rb" )
 #    }
 #  )
 #
-class Textfile_unittest_target < Abstract_target
+class TextfileUnittestTarget < AbstractTarget
 
   # Exception, thrown if one subordinated project generated more
   # than one result name.
-  class Must_be_one_target_name_ex < Ex
+  class MustBeOneTargetNameEx < Ex
     # [_a_names_] Names generated.
     def initialize( a_names )
       super( "Only one name expected in [#{a_names.join(';')}]" )
     end
   end
 
+  # For compatibility with previous versions.
+  Must_be_one_target_name_ex = MustBeOneTargetNameEx
+
   # Exception, thrown if files are not equal.
-  class File_mismatch_ex < Build_ex
+  class FileMismatchEx < BuildEx
     # [_a_cmdline_] Command string of test application.
     # [_a_produced_] Name of file generated.
     # [_a_etalon_] Name of file containing correct results.
@@ -106,6 +110,9 @@ class Textfile_unittest_target < Abstract_target
     end
   end
 
+  # For compatibility with previous versions.
+  File_mismatch_ex = FileMismatchEx
+
   # Description of single pair of values compared.
   class Pair
     # Name of file generated.
@@ -184,7 +191,8 @@ class Textfile_unittest_target < Abstract_target
 
   # Build subordinated project and run it.
   #
-  # If unit-test application returns exit code not equal to 0, exception is thrown.
+  # If unit-test application returns exit code not equal to 0, exception is
+  # thrown.
   def build
     if !@mxx_build_state
       @mxx_target_project.build
@@ -192,16 +200,16 @@ class Textfile_unittest_target < Abstract_target
       # Determining the name of application, which should be run.
       full_names = @mxx_target_project.mxx_full_targets_names
       if 1 != full_names.size
-        raise Must_be_one_target_name_ex.new( full_names )
+        raise MustBeOneTargetNameEx.new( full_names )
       end
 
       # No execution of commands in dry-run mode.
-      if !Mxx_ru::Util::Mode.instance.is_dry_run
+      if !MxxRu::Util::Mode.instance.is_dry_run
         puts "running unit test: #{full_names[0]}..."
         do_all_launches( full_names[ 0 ] )
       end
 
-      @mxx_build_state = Target_state.new( Target_state::REBUILT )
+      @mxx_build_state = TargetState.new( TargetState::REBUILT )
     end
 
     return @mxx_build_state
@@ -221,6 +229,12 @@ class Textfile_unittest_target < Abstract_target
     }
   end
 
+  # Reset build status.
+  def reset
+    @mxx_target_project.reset
+    @mxx_build_state = nil
+  end
+
 protected
   # Perform all defined runs of test application.
   # This method should not be executed in dry-run mode.
@@ -235,7 +249,7 @@ protected
       puts "\tlaunching '#{cmdline}'..."
       if !system( cmdline )
         puts "\n\nunit test '#{cmdline}' FAILED! #{$?}"
-        raise Build_ex.new( cmdline, $? )
+        raise BuildEx.new( cmdline, $? )
       end
 
       # Execution of application was successful.
@@ -248,9 +262,9 @@ protected
   end
 
   # Perform comparation of two files.
-  # If they are not identical, File_mismatch_ex exception is thrown.
+  # If they are not identical, FileMismatchEx exception is thrown.
   # If some system exceptions would occur (absence of file for example),
-  # Build_ex ewxception will be thrown.
+  # BuildEx ewxception will be thrown.
   def do_file_compare( a_cmdline, a_produced, a_etalon )
     begin
       produced_file = File.new( a_produced, "r" )
@@ -259,10 +273,12 @@ protected
       line_num = 1
       while true
         l1 = produced_file.gets
+		  l1.chop! if l1
         l2 = etalon_file.gets
+		  l2.chop! if l2
 
         if l1 != l2
-          raise File_mismatch_ex.new( a_cmdline,
+          raise FileMismatchEx.new( a_cmdline,
             a_produced, a_etalon, line_num,
             l1, l2 )
         else
@@ -274,11 +290,14 @@ protected
       end
 
     rescue Exception => ex
-      raise Build_ex.new( a_cmdline,
+      raise BuildEx.new( a_cmdline,
         "Error during comparing files " +
         "'#{a_produced}', '#{a_etalon}': #{ex}" )
     end
   end
 end
 
-end # module Mxx_ru
+# For compatibility with previous versions.
+Textfile_unittest_target = TextfileUnittestTarget
+
+end # module MxxRu

data/lib/mxx_ru/util.rb

@@ -29,18 +29,21 @@
 require 'rbconfig'
 require 'singleton'
 
-module Mxx_ru
+require 'mxx_ru/ex'
+
+module MxxRu
 
   module Util
     # Regular expression to divide file name and it's extension.
     MATCH_FILE_EXT_REGEX = Regexp.new( "^(.+)\\.([^\\./]+)$" )
 
-    # Ruby command line parameters, handled by Mxx_ru.
-    MXXARG_CLEAN = "--mxx-clean"
-    MXXARG_SHOW_CMD = "--mxx-show-cmd"
-    MXXARG_KEEP_TMPS = "--mxx-keep-tmps"
-    MXXARG_SHOW_TMPS = "--mxx-show-tmps"
-    MXXARG_DRY_RUN = "--mxx-dry-run"
+    # Ruby command line parameters, handled by MxxRu.
+    MXXARG_CLEAN = '--mxx-clean'
+    MXXARG_REBUILD = '--mxx-rebuild'
+    MXXARG_SHOW_CMD = '--mxx-show-cmd'
+    MXXARG_KEEP_TMPS = '--mxx-keep-tmps'
+    MXXARG_SHOW_TMPS = '--mxx-show-tmps'
+    MXXARG_DRY_RUN = '--mxx-dry-run'
     MXXARG_BRIEF_DESC = '--mxx-brief-show'
     MXXARG_BRIEF_DESC_DISABLED = '--mxx-brief-hide'
 
@@ -50,19 +53,32 @@ module Mxx_ru
     # Regular expression to parse entries in Kernel#caller result.
     CALLER_ENTRY_REGEX = /^(.+):\d+(:in\s.+){0,1}$/
 
-    # Class, which detects Mxx_ru current mode.
+    # Class, which detects MxxRu current mode.
     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
 
+      # 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
+
       # 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
+
         @is_show_cmd = ARGV.include?( MXXARG_SHOW_CMD )
         @is_keep_tmps = ARGV.include?( MXXARG_KEEP_TMPS )
         @is_show_tmps = ARGV.include?( MXXARG_SHOW_TMPS )
@@ -125,7 +141,7 @@ module Mxx_ru
     # Temporary files are created in current folder.
     # Temporary files are removed before application is exitted,
     # if --mxx-keep-tmps option isn't set.
-    class Tmp_files
+    class TmpFiles
       include Singleton
 
       # Temporary file names.
@@ -133,7 +149,7 @@ module Mxx_ru
 
       def initialize
         if !Mode.instance.is_keep_tmps
-          ObjectSpace.define_finalizer( self, Proc.new{ Tmp_files.finalizer } )
+          ObjectSpace.define_finalizer( self, Proc.new{ TmpFiles.finalizer } )
         end
 
         # Counter to ensure unique file names.
@@ -143,7 +159,7 @@ module Mxx_ru
         @index_stack = Array.new
       end
 
-      def Tmp_files.finalizer
+      def TmpFiles.finalizer
         @@names.each { |d|
             begin
               File.delete( d )
@@ -188,24 +204,27 @@ module Mxx_ru
           index = @index_stack.pop
           while @@names.size > index
             file_to_delete = @@names.pop
-            Mxx_ru::Util::delete_file( file_to_delete )
+            MxxRu::Util::delete_file( file_to_delete )
           end
         end
       end
 
-    end # class Tmp_files
+    end # class TmpFiles
+
+    # For compatibility with previous versions.
+    Tmp_files = TmpFiles
 
     # Auxiliary function for correct execution of build method of target
-    # object.  Before execution Tmp_files.push is executed, and after execution
-    # of build method Tmp_files.pop is called. This way we are removing
+    # object.  Before execution TmpFiles.push is executed, and after execution
+    # of build method TmpFiles.pop is called. This way we are removing
     # temporary files created during a compilation of given target.
     def Util.build_call_wrapper( a_target )
       begin
-        Tmp_files.instance.push
+        TmpFiles.instance.push
         state = a_target.build
         return state
       ensure
-        Tmp_files.instance.pop
+        TmpFiles.instance.pop
       end
     end
 
@@ -220,7 +239,7 @@ module Mxx_ru
       chain.unshift( a_name )
 
       to_split = a_name.clone
-      while to_split != "."
+      while to_split != '.' 
         r = File.split( to_split )
 
         # We must stop if to_split cannot be splitted anymore
@@ -244,12 +263,12 @@ module Mxx_ru
     # If dry-run mode wasn't set, checking for existance.
     # If it isn't exists, trying to create it.
     #
-    # In a dry-run mode Mxx_ru always assumes folder is exists, even if it
+    # In a dry-run mode MxxRu always assumes folder is exists, even if it
     # isn't.
     def Util.ensure_path_exists( a_path_name )
-      if !Mxx_ru::Util::Mode.instance.is_dry_run
+      if !MxxRu::Util::Mode.instance.is_dry_run
         if !FileTest.exists?( a_path_name )
-          Mxx_ru::Util.create_dir( a_path_name )
+          MxxRu::Util.create_dir( a_path_name )
         end
       end
     end
@@ -296,20 +315,26 @@ module Mxx_ru
   # Manually enable 'show-brief' mode.
   #
   # Intended to use in project files:
-  #   Mxx_ru::Cpp::exe_target( 'some.prj' ) {
+  #   MxxRu::Cpp::exe_target( 'some.prj' ) {
   #     ...
-  #     Mxx_ru::enable_show_brief
+  #     MxxRu::enable_show_brief
   #     ...
   #   }
   # 'show-brief' is global mode. Once enabled it cannot be disabled
   # form inside another project file.
   #
-  # Call to Mxx_ru::enable_show_brief ignored if '--mxx-show-brief-disabled'
+  # Call to MxxRu::enable_show_brief ignored if '--mxx-show-brief-disabled'
   # specified in command-line.
   #
-  def Mxx_ru.enable_show_brief
+  def MxxRu.enable_show_brief
     Util::Mode.instance.try_enable_show_brief
   end
 
-end # module Mxx_ru
+  # Show a brief message. The message shown only if 'show-brief' mode is on.
+  def MxxRu.show_brief( message )
+    puts message[ 0, 1 ].capitalize << message[ 1..message.size ] << ' ...' if
+        Util::Mode.instance.is_brief_desc and message
+  end
+
+end # module MxxRu
 

data/tests/cpp/cpp_sources_glob/tc_cpp_sources_glob.rb

@@ -0,0 +1,18 @@
+require 'test/unit'
+
+require File.dirname( __FILE__ ) + '/../../test_with_compilation'
+
+class TC_CppSourcesGlob < Test::Unit::TestCase
+  include TestWithCompilation
+
+  test_path 'tests/cpp/cpp_sources_glob'
+
+  test_case :successful_compile_and_link do
+    assert_nothing_raised {
+      build( 'build.rb' )
+      clean( 'build.rb' )
+    }
+  end
+
+end
+

data/tests/cpp/mswin_res_dll/tc_mswin_res_dll.rb

@@ -0,0 +1,18 @@
+require 'test/unit'
+
+require File.dirname( __FILE__ ) + '/../../test_with_compilation'
+
+class TC_MSWinResDll < Test::Unit::TestCase
+  include TestWithCompilation
+
+  test_path 'tests/cpp/mswin_res_dll'
+
+  test_case :successful_compile_and_link do
+    assert_nothing_raised {
+      build( 'build.rb' )
+      clean( 'build.rb' )
+    }
+  end
+
+end
+

data/tests/cpp/mswin_res_exe/tc_mswin_res_exe.rb

@@ -0,0 +1,18 @@
+require 'test/unit'
+
+require File.dirname( __FILE__ ) + '/../../test_with_compilation'
+
+class TC_MSWinResExe < Test::Unit::TestCase
+  include TestWithCompilation
+
+  test_path 'tests/cpp/mswin_res_exe'
+
+  test_case :successful_compile_and_link do
+    assert_nothing_raised {
+      build( 'build.rb' )
+      clean( 'build.rb' )
+    }
+  end
+
+end
+

data/tests/cpp/rucodegen/prj.rb

@@ -1,7 +1,7 @@
 require 'mxx_ru/cpp'
 require 'mxx_ru/cpp/rucodegen'
 
-Mxx_ru::setup_target Mxx_ru::Cpp::Exe_target.new( "tests/cpp/rucodegen/prj.rb" ) {
+Mxx_ru::Cpp::exe_target {
 	target "host_config"
 
 	rucodegen = generator Mxx_ru::Cpp::RuCodeGen.new( self )
@@ -14,4 +14,3 @@ Mxx_ru::setup_target Mxx_ru::Cpp::Exe_target.new( "tests/cpp/rucodegen/prj.rb" )
 		rucodegen.add "conn_params.rb"
 	}
 }
-

data/tests/cpp/rucodegen/tc_rucodegen.rb

@@ -0,0 +1,18 @@
+require 'test/unit'
+
+require File.dirname( __FILE__ ) + '/../../test_with_compilation'
+
+class TC_RuCodeGen < Test::Unit::TestCase
+  include TestWithCompilation
+
+  test_path 'tests/cpp/rucodegen'
+
+  test_case :successful_compile_and_link do
+    assert_nothing_raised {
+      build( 'prj.rb' )
+      clean( 'prj.rb' )
+    }
+  end
+
+end
+