Mxx_ru 1.3.2 → 1.4.0

data/Rakefile

@@ -4,9 +4,11 @@ Gem::manage_gems
 require 'rake/gempackagetask'
 require 'rake/testtask'
 
+require 'lib/mxx_ru/version'
+
 spec = Gem::Specification.new do |s|
   s.name = "Mxx_ru"
-  s.version = '1.3.2'
+  s.version = MXX_RU_VERSION
   s.author = "The Mxx_ru Project"
   s.email = "eao197@yahoo.com"
   s.homepage = "http://www.rubyforge.com/projects/mxx-ru"
@@ -14,9 +16,8 @@ spec = Gem::Specification.new do |s|
   s.summary = "Mxx_ru (Make++ on Ruby) is a cross-platform build tool"
   s.files = FileList[ "{bin,tests,lib,docs,examples}/**/*" ].
       exclude( "rdoc" ).to_a + [ "THANKS" ]
+  s.executables = 'mxxrugen'
   s.require_path = "lib"
-# s.autorequire = "rucodegen"
-# s.test_file = "tests/ts_rucodegen.rb"
   s.has_rdoc = true
   s.rdoc_options = [ '-S', '--main', 'README' ]
   s.extra_rdoc_files = [ "README", "Rakefile", "COPYING", "NEWS" ] + FileList[ "docs/**/*" ].to_a

data/bin/mxxrugen

@@ -0,0 +1,197 @@
+#--
+# 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.
+#++
+# This code is based on the code from RuCodeGen
+# (http://www.rubyforge.org/projects/rucodegen) project.
+# RuCodeGen is distributed under the following license:
+#--
+#
+# Copyright (c) 2005-2006, Yauheni Akhotnikau
+# 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.
+#
+#++
+
+
+# Since v.1.4.0
+#
+# Template generation scripts runner.
+
+require 'optparse'
+require 'ostruct'
+
+module MxxRuGen
+
+module Impl
+
+# Standard name of generation script inside template.
+STD_CODEGEN_SCRIPT_NAME = 'g.rb'
+
+# Command-line argument parsing.
+#
+# Returns object with the following methods:
+# template_name:: Name of template chosen.
+# list:: Contains _true_ if list of templates must be shown.
+# include_paths:: Contains list of addition path for templates.
+#
+# Finishes script work is --help specified.
+#
+def Impl.parse_args
+	result = OpenStruct.new(
+			:template_name => nil,
+			:list => false,
+			:include_paths => [] )
+
+	parser = OptionParser.new
+
+	parser.banner = <<BANNER
+Mxx_ru Ad-Hoc generation runner
+
+Usage:
+
+mxxrugen [<options>] template-name [<template-options>]
+
+BANNER
+
+	parser.on_head( '-l', '--list', 'Show list of available templates' ) do
+		result.list = true
+	end
+
+	parser.on_head( '-I', '--include-path PATH',
+			'Additional path to looking for templates' ) do |p|
+		result.include_paths << p
+	end
+
+	parser.on_head( '-h', '--help', 'Show this message' ) do
+		puts parser
+		exit( 1 )
+	end
+
+	parser.order!( ARGV ) do |nonarg|
+		# First non-option is a template name.
+		result.template_name = nonarg
+		parser.terminate
+	end
+
+	if !result.template_name && !result.list
+		$stderr.puts "template_name must be specified"
+		exit( 2 )
+	end
+
+	result
+end
+
+# Prints list of available templates.
+def Impl.show_templates_list( include_paths )
+	include_paths.each do |path|
+		templates_found = []
+		Dir.glob( File.join( path, '*' ), File::FNM_PATHNAME ) do |dir|
+			probe_name = File.join( dir, STD_CODEGEN_SCRIPT_NAME )
+			if File.readable?( probe_name )
+				templates_found << File.basename( dir )
+			end
+		end
+
+		templates_found.sort.each do |template|
+			puts template + " (#{path})"
+		end
+	end
+end
+
+# Searches full path to a template by the template name.
+#
+# Returns nil if searching fails.
+#
+def Impl.find_full_template_path( template_name, include_paths )
+	include_paths.each do |path|
+		probe_name = File.join( path, template_name, STD_CODEGEN_SCRIPT_NAME )
+		if File.readable?( probe_name )
+			return probe_name
+		end
+	end
+
+	nil
+end
+
+# Searches and runs the template specified with option list is given.
+def Impl.find_and_run_template( template_name, include_paths )
+	full_path = find_full_template_path( template_name, include_paths )
+	if full_path 
+		require full_path
+	else
+		$stderr.puts "#{template_name}: template not found in:\n\t" +
+				include_paths.join( "\n\t" )
+		exit( 3 )
+	end
+end
+
+end # Impl
+
+# Performs main work.
+def MxxRuGen.run_ad_hoc_generation
+	options = Impl.parse_args
+
+  # Standard path to templates must be added.
+	options.include_paths << File.expand_path( File.join(
+			File.dirname( __FILE__ ),
+			'../lib/mxx_ru/generators' ) )
+
+	if options.list
+		Impl.show_templates_list( options.include_paths )
+	else
+		Impl.find_and_run_template(
+				options.template_name,
+				options.include_paths )
+	end
+end
+
+end # MxxRuGen
+
+MxxRuGen.run_ad_hoc_generation
+
+# vim:ft=ruby:
+

data/lib/mxx_ru/cmd_line_option_processor.rb

@@ -0,0 +1,126 @@
+#--
+# 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.
+#++
+
+require 'optparse'
+require 'singleton'
+
+require 'mxx_ru/version'
+
+module MxxRu
+
+# Singleton for centralized mechanizm of command line options parsing.
+#
+# Since v.1.4.0
+#
+# Each part of Mxx_ru which need some command line option must provider
+# special option processor for CmdLineOptionProcessor singleton:
+#
+#   module MxxRu
+#   module SomeLangSupport
+#     class OptionParser
+#       include Singleton
+#       ...
+#       def prepare( parser ) # Instance of OptionParser from stdlib.
+#         parser.separator ''
+#         parser.separator 'Some Language Support options:'
+#
+#         parser.on( '-i', '--include PATH', 'Set up include path' ) do
+#           |path|
+#           ... some processig ...
+#         end
+#         ... setting another option handlers ...
+#       end
+#     end
+#   end
+#   end
+#
+#   # OptionParser must be added to CmdLineOptionProcessor.
+#   MxxRu::CmdLineOptionProcessor.add_processor(
+#       MxxRu::SomeLangSupport::OptionParser.instance )
+#
+# See examples of using this technique in MxxRu::Util::Mode and
+# MxxRu::Cpp::Mode classes.
+#
+class CmdLineOptionProcessor
+  include Singleton
+
+  def initialize
+    @processors = []
+    @parsed = false
+  end
+
+  # Add yet another option processor for processors list.
+  def add_processor( processor )
+    @processors << processor
+    @parsed = false
+  end
+
+  # Performs parsing of ARGV content by current processors.
+  #
+  # Finishes work of script if --help or --version found in ARGV.
+  def parse
+    unless @parsed
+      parser = OptionParser.new do |p|
+        prepare_option_parser( p )
+      end
+
+      begin
+        parser.parse( ARGV )
+      rescue => x
+        $stderr.puts "command line parsing error '#{x.message}'"
+        exit( 2 )
+      end
+
+      @parsed = true
+    end
+  end
+
+protected 
+  # Calls preparse() method for each processor. And then add common
+  # command line options to the parser.
+  def prepare_option_parser( parser )
+    @processors.each do |p| p.prepare( parser ) end
+
+    parser.separator ''
+    parser.separator 'Auxilary options:'
+
+    parser.on_tail( '-h', '--help', 'Show usage help and options summary' ) do
+      puts parser
+      exit
+    end
+
+    parser.on_tail( '--version', 'Show version' ) do
+      puts 'Mxx_ru v.' + MXX_RU_VERSION
+      exit
+    end
+  end
+
+end
+
+end
+

data/lib/mxx_ru/cpp.rb

@@ -31,6 +31,7 @@ require 'mxx_ru/binary_target'
 require 'mxx_ru/cpp/detect_toolset'
 require 'mxx_ru/cpp/target'
 require 'mxx_ru/cpp/composite'
+require 'mxx_ru/cpp/lib_collection'
 
 require 'mxx_ru/cpp/obj_placements/custom_subdir'
 

data/lib/mxx_ru/cpp/composite.rb

@@ -59,12 +59,7 @@ module  MxxRu
       def build
         if nil == @mxx_last_build_result
 
-          if !@mxx_all_options_defined
-            # It's required for toolset to define all required options
-            # taking all current modes into account.
-            MxxRu::Cpp::toolset.setup_mandatory_options( self )
-            @mxx_all_options_defined = true
-          end
+          check_all_options_definition
 
           @mxx_last_build_result = build_required_projects
         end
@@ -76,12 +71,7 @@ module  MxxRu
       def clean
         if nil == @mxx_last_build_result
 
-          if !@mxx_all_options_defined
-            # It's required for toolset to define all required options
-            # taking all current modes into account.
-            MxxRu::Cpp::toolset.setup_mandatory_options( self )
-            @mxx_all_options_defined = true
-          end
+          check_all_options_definition
 
           clean_required_prjs
 

data/lib/mxx_ru/cpp/lib_collection.rb

@@ -0,0 +1,96 @@
+#--
+# 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.
+#++
+
+require 'mxx_ru/cpp/composite'
+require 'mxx_ru/cpp/toolset'
+
+module MxxRu
+module Cpp
+
+# Target type is a collection of all required libraries from subprojects.
+#
+# Since v.1.4.0
+class LibCollectionTargetType < TargetType
+  TYPE = "lib_collection"
+
+  def name
+    return TYPE
+  end
+end
+
+# Collection of all required libraries form subprojects.
+#
+# Since v.1.4.0
+class LibCollectionTarget < CompositeTarget
+  def initialize( a_alias, &block )
+    super( a_alias )
+
+    instance_eval( &block ) if block
+  end
+
+  def target_type
+    return LibCollectionTargetType.new
+  end
+
+  def build
+    if nil == @mxx_last_build_result
+      # Let base class makes all necessary building actions.
+      super
+
+      # We must collect names of all required libraries from
+      # all subprojects.
+      mxx_required_prjs.each do |d|
+        if Toolset::has_linkable_dependecies?( d )
+          mxx_add_required_libs( d.mxx_required_libs )
+          mxx_add_required_lib_paths( d.mxx_required_lib_paths )
+        end
+      end
+    end
+
+    @mxx_last_build_result
+  end
+
+end # class LibCollectionTarget
+
+# Simple method to define libraries collection target.
+#
+# Example:
+#   MxxRu::Cpp::lib_collection_target {
+#     required_prj 'some_project.rb'
+#     required_prj 'some_another_project.rb'
+#   }
+#
+# Since v.1.4.0
+def Cpp.lib_collection_target( prj_alias = nil, &block )
+  prj_alias = MxxRu::Util::prj_alias_form_caller( caller ) unless prj_alias
+  MxxRu::setup_target LibCollectionTarget.new( prj_alias, &block )
+end
+
+end # module Cpp
+end # module MxxRu
+