Mxx_ru 1.4.6 → 1.4.7

data/lib/mxx_ru/cpp/qt4.rb

@@ -0,0 +1,31 @@
+#--
+# Copyright (c) 1996-2004, Yauheni Akhotnikau
+# Copyright (c) 2004-2006, JSC Intervale
+# Copyright (c) 2006-2008, 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/qt4details'
+include MxxRu::Cpp::Qt4Modules
+

data/lib/mxx_ru/cpp/qt4details.rb

@@ -0,0 +1,571 @@
+#--
+# Copyright (c) 1996-2004, Yauheni Akhotnikau
+# Copyright (c) 2004-2006, JSC Intervale
+# Copyright (c) 2006-2008, 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 'pathname'
+require 'rexml/document'
+require 'set'
+
+require 'mxx_ru/cpp'
+
+module MxxRu
+module Cpp
+
+  # Auxilary module with classes and constants for Qt4 modules support
+  #
+  module Qt4Modules
+    # Class for objects whose purpose is setting up an appropriate
+    # define and a library for target.
+    #
+    # Usage:
+    #   QT_GUI = ModuleBinder.new( 'QT_GUI_LIB', 'QtGui4' )
+    #   ...
+    #   QT_GUI.setup( target )
+    #
+    class ModuleBinder
+      def initialize( a_define, a_library )
+        @define = a_define
+        @library = a_library
+      end
+
+      def setup( a_target )
+        a_target.define @define
+        a_target.lib @library
+      end
+    end
+
+    # Qt3Support component.
+    QT_QT3SUPPORT = ModuleBinder.new( 'QT_QT3SUPPORT_LIB', 'Qt3Support4' )
+    # QtCore component.
+    QT_CORE = ModuleBinder.new( 'QT_CORE_LIB', 'QtCore4' )
+    # QtDesigner component.
+    QT_DESIGNER = ModuleBinder.new( 'QT_DESIGNER_LIB', 'QtDesigner4' )
+    # QtDesignerComponents component.
+    QT_DESIGNER_COMPONENTS = ModuleBinder.new(
+          'QT_DESIGNERCOMPONENTS_LIB', 'QtDesignerComponents4' )
+    # QtGui component.
+    QT_GUI = ModuleBinder.new( 'QT_GUI_LIB', 'QtGui4' )
+    # QtHelp component.
+    QT_HELP = ModuleBinder.new( 'QT_HELP_LIB', 'QtHelp4' )
+    # Network component.
+    QT_NETWORK = ModuleBinder.new( 'QT_NETWORK_LIB', 'QtNetwork4' )
+    # QtOpenGL component.
+    QT_OPENGL = ModuleBinder.new( 'QT_OPENGL_LIB', 'QtOpenGL4' )
+    # QtScript component.
+    QT_SCRIPT = ModuleBinder.new( 'QT_SCRIPT_LIB', 'QtScript4' )
+    # QtSql component.
+    QT_SQL = ModuleBinder.new( 'QT_SQL_LIB', 'QtSql4' )
+    # QtSvg component.
+    QT_SVG = ModuleBinder.new( 'QT_SVG_LIB', 'QtSvg4' )
+    # QtTest component.
+    QT_TEST = ModuleBinder.new( 'QT_TEST_LIB', 'QtTest4' )
+    # QtXml component.
+    QT_XML = ModuleBinder.new( 'QT_XML_LIB', 'QtXml4' )
+    # QtXmlPatterns component.
+    QT_XML_PATTERNS = ModuleBinder.new(
+          'QT_XMLPATTERNS_LIB',
+          'QtXmlPatterns4' )
+    # QtWebKit component.
+    QT_WEB_KIT = ModuleBinder.new(
+          'QT_WEBKIT_LIB',
+          'QtWebKit4' )
+    # Phonon component.
+    QT_PHONON = ModuleBinder.new(
+          'QT_PHONON_LIB',
+          'phonon4' )
+  end
+
+  # Files generator for Qt4 class.
+  #
+  # Main features:
+  #
+  # - building of moc-files using moc tool.
+  #   Generation from source and header files is supported.
+  # - building header files from ui-files using uic-compiler.
+  #
+  # Generated source files automatically added into
+  # cpp_source list of target.
+  #
+  # Local list defines is supported.
+  #
+  # If only pointer to the target passed into contructor,
+  # default list of defines is used. If it's required to change
+  # default list, new list should be passed through a second argument:
+  #
+  #  generator( MxxRu::Cpp::Qt4.new( self, [ "QT_DEPRECATED_WARNINGS" ] ) )
+  #
+  class Qt4 < MxxRu::AbstractGenerator
+    # Default list of defines.
+    # QT_DLL
+    DEFAULT_DEFINES = [ 'QT_DLL', 'QT_THREAD_SUPPORT' ]
+
+    # moc tool executable
+    # Default: moc
+    attr_accessor :moc_name 
+
+    # uic tool executable
+    # Default: uic.
+    attr_accessor :uic_name
+
+    # rcc tool executable
+    # Default: rcc.
+    attr_accessor :rcc_name
+
+    # File extension for source files generated.
+    # Used in both moc and uic tools.
+    # Default: .cpp
+    attr_accessor :cpp_ext
+
+    # File extension for header files generated.
+    # Used in uic tool.
+    # Default: .h
+    attr_accessor :hpp_ext
+
+    # File extension for moc files generated.
+    # Used in moc tool.
+    # Default: .moc
+    attr_accessor :moc_ext
+
+    # Subfolder name where moc generated files would be located.
+    # If nil, generated files would be in the same folder
+    # where source files were.
+    # Default: nil
+    attr_accessor :moc_result_subdir
+
+    # Subfolder name where results of uic invokation must be placed.
+    # If nil, generated files would be in the same folder where
+    # source ui files were.
+    attr_accessor :uic_result_subdir
+
+    # Subfolder name where results of rcc invokation must be placed.
+    # If nil, generated files would be in the same folder where
+    # source qrc files were.
+    # Used only for qrc2cpp translation.
+    attr_accessor :qrc_result_subdir
+
+    # Files list for generating moc files from header files.
+    #
+    # More exact: a.hpp -> moc_a.cpp. moc_a.cpp file is added
+    # to cpp_source list of a target.
+    attr_reader :qt_h2moc_files
+
+    # Files list for generating moc files from source files.
+    #
+    # More exact: a.cpp -> a.moc.
+    attr_reader :qt_cpp2moc_files
+
+    # Files list for generating header files from ui files.
+    #
+    # More exact: a.ui -> ui_a.hpp
+    attr_reader :qt_ui_files
+
+    # Files list for generating source files from qrc files.
+    #
+    # More exact: a.qrc -> qrc_a.cpp
+    attr_reader :qt_qrc2cpp_files
+
+    # Files list for generating binary resource files from qrc files.
+    #
+    # More exact: a.qrc -> a.rcc
+    attr_reader :qt_qrc2rcc_files
+
+    # Target, generator is created for.
+    attr  :target
+
+    # Constructor.
+    def initialize( a_target, a_defines = DEFAULT_DEFINES )
+      @moc_name = "moc"
+      @uic_name = "uic"
+      @rcc_name = "rcc"
+      @cpp_ext = ".cpp"
+      @hpp_ext = ".h"
+      @moc_ext = ".moc"
+      @moc_result_subdir = nil
+      @uic_result_subdir = nil
+      @qrc_result_subdir = nil
+
+      # If uic_result_subdir not nil than we must add
+      # uic_result_subdir into
+      # target include_path. But must do this only one time.
+      @uic_result_subdir_include_paths = Set.new
+
+      @qt_h2moc_files = []
+      @qt_cpp2moc_files = []
+      @qt_ui_files = []
+      @qt_qrc2cpp_files = []
+      @qt_qrc2rcc_files = []
+
+      defines_to_set = a_defines.flatten
+      defines_to_set.each { |d| a_target.define( d ) }
+
+      @target = a_target
+
+      # QtCore must be used.
+      use_module Qt4Modules::QT_CORE
+    end
+
+    # Add a file for hpp to moc generation.
+    def h2moc( a_file )
+      @qt_h2moc_files << @target.create_full_src_file_name( a_file )
+    end
+
+    # Add a file for cpp to moc generation.
+    def cpp2moc( a_file )
+      @qt_cpp2moc_files << @target.create_full_src_file_name( a_file )
+    end
+
+    # Add a file for ui to hpp generation.
+    def ui( a_file )
+      full_file_name = @target.create_full_src_file_name( a_file )
+      @qt_ui_files << full_file_name
+      if @uic_result_subdir
+        uic_result_path = make_uic_result_path_for( full_file_name )
+
+        if !@uic_result_subdir_include_paths.member?( uic_result_path )
+          @target.include_path( uic_result_path )
+          @uic_result_subdir_include_paths.add( uic_result_path )
+        end
+      end
+    end
+
+    # Add a file for qrc to cpp generation.
+    def qrc2cpp( a_file )
+      full_file_name = @target.create_full_src_file_name( a_file )
+      @qt_qrc2cpp_files << full_file_name
+    end
+
+    # Add a file for qrc to rcc generation.
+    def qrc2rcc( a_file )
+      full_file_name = @target.create_full_src_file_name( a_file )
+      @qt_qrc2rcc_files << full_file_name
+    end
+
+    # Add a Qt4 module to target.
+    #
+    # a_module -- an instance of Qt4Modules::ModuleBinder.
+    def use_module( a_module )
+      a_module.setup( @target )
+    end
+
+    # Add some Qt4 modules to target.
+    #
+    # a_modules -- an enumeration of Qt4Modules::ModuleBinder instances.
+    #
+    def use_modules( *a_modules )
+      a_modules.each { |m| use_module( m ) }
+    end
+
+    # Perform files generation.
+    def build( a_target )
+      build_from_ui( a_target )
+      build_from_qrc2cpp( a_target )
+      build_from_qrc2rcc( a_target )
+      build_from_h( a_target )
+      build_from_cpp( a_target )
+    end
+
+    # Perform generated files cleanup.
+    def clean( a_target )
+      clean_from_ui( a_target )
+      clean_from_qrc2cpp( a_target )
+      clean_from_qrc2rcc( a_target )
+      clean_from_h( a_target )
+      clean_from_cpp( a_target )
+    end
+
+    # Add qtmain component for target.
+    def lib_qtmain
+      @target.lib 'qtmain'
+      self
+    end
+
+  protected
+
+    # Perform generation from ui-files.
+    def build_from_ui( a_target )
+      @qt_ui_files.each { |ui|
+        ui_header = header_from_ui( ui, a_target )
+        MxxRu::Util::ensure_path_exists( File.dirname( ui_header ) )
+
+        # Checking what files are changed and running generation
+        # from them if necessary.
+        if TargetState::EXISTS != TargetState.detect(
+            ui_header, [ ui ] ).state
+          MxxRu::AbstractTarget::run(
+            [ "#{@uic_name} -o #{ui_header} #{ui}" ],
+            [ ui_header ],
+            "building header file #{ui_header}" )
+        end
+      }
+    end
+
+    # Perform cleanup of files, generated from ui files.
+    def clean_from_ui( a_target )
+      @qt_ui_files.each { |ui|
+        ui_header = header_from_ui( ui, a_target )
+
+        MxxRu::Util::delete_file( ui_header )
+      }
+    end
+
+    # Getting file name, generated by uic tool.
+    #
+    def header_from_ui( a_ui_file, a_target )
+      path, file_name = File.split( a_ui_file )
+      updated_file_name = 'ui_' +
+          MxxRu::Util::remove_file_ext( file_name ) +
+          @hpp_ext
+
+      if @uic_result_subdir then
+        result = File.join( path, @uic_result_subdir, updated_file_name )
+      else
+        result = File.join( path, updated_file_name )
+      end
+
+      result
+    end
+
+    # Perform generation from qrc-files.
+    def build_from_qrc2cpp( a_target )
+      @qt_qrc2cpp_files.each { |qrc_file|
+        name = File.basename( MxxRu::Util::remove_file_ext( qrc_file ) )
+        qrc_cpp = source_from_qrc( qrc_file, a_target )
+        MxxRu::Util::ensure_path_exists( File.dirname( qrc_cpp ) )
+
+        # Checking what files are changed and running generation
+        # from them if necessary.
+        if TargetState::EXISTS != TargetState.detect(
+            qrc_cpp,
+            [ qrc_file ] + Qt4.detect_qrc_file_dependencies( qrc_file ) ).state
+          MxxRu::AbstractTarget::run(
+            [ "#{@rcc_name} -name #{name} -o #{qrc_cpp} #{qrc_file}" ],
+            [ qrc_cpp ],
+            "building source file #{qrc_cpp}" )
+        end
+
+        add_cpp_source( a_target, qrc_cpp )
+      }
+    end
+
+    # Perform cleanup of files, generated from qrc files.
+    #
+    def clean_from_qrc2cpp( a_target )
+      @qt_qrc2cpp_files.each { |qrc_file|
+        qrc_cpp = source_from_qrc( qrc_file, a_target )
+
+        # It is necessary to delete obj-file.
+        add_cpp_source( a_target, qrc_cpp )
+
+        MxxRu::Util::delete_file( qrc_cpp )
+      }
+    end
+
+    # Getting file name, generated by rcc tool.
+    #
+    def source_from_qrc( a_qrc_file, a_target )
+      path, file_name = File.split( a_qrc_file )
+      updated_file_name = 'qrc_' +
+          MxxRu::Util::remove_file_ext( file_name ) +
+          @cpp_ext
+
+      if @qrc_result_subdir then
+        result = File.join( path, @qrc_result_subdir, updated_file_name )
+      else
+        result = File.join( path, updated_file_name )
+      end
+
+      result
+    end
+
+    # Perform generation from qrc-files.
+    def build_from_qrc2rcc( a_target )
+      @qt_qrc2rcc_files.each { |qrc_file|
+        name = File.basename( MxxRu::Util::remove_file_ext( qrc_file ) )
+        target_path =
+            File.dirname( a_target.create_full_result_target_file_name )
+        MxxRu::Util::ensure_path_exists( target_path )
+
+        rcc_file = File.join( target_path, name + '.rcc' )
+
+        # Checking what files are changed and running generation
+        # from them if necessary.
+        if TargetState::EXISTS != TargetState.detect(
+            rcc_file,
+            [ qrc_file ] + Qt4.detect_qrc_file_dependencies( qrc_file ) ).state
+          MxxRu::AbstractTarget::run(
+            [ "#{@rcc_name} -binary -name #{name} -o #{rcc_file} #{qrc_file}" ],
+            [ rcc_file ],
+            "building Qt4 resource file #{rcc_file}" )
+        end
+      }
+    end
+
+    # Perform cleanup of files, generated from qrc files.
+    #
+    def clean_from_qrc2rcc( a_target )
+      @qt_qrc2rcc_files.each { |qrc_file|
+        name = File.basename( MxxRu::Util::remove_file_ext( qrc_file ) )
+        target_path =
+            File.dirname( a_target.create_full_result_target_file_name )
+        rcc_file = File.join( target_path, name + '.rcc' )
+
+        MxxRu::Util::delete_file( rcc_file )
+      }
+    end
+
+    # Perform generation from hpp file using moc tool.
+    def build_from_h( a_target )
+      @qt_h2moc_files.each { |header_full|
+        moc_full = moc_from_h( header_full, a_target )
+
+        if TargetState::EXISTS != TargetState.detect(
+          moc_full, [ header_full ] ).state
+          MxxRu::AbstractTarget::run(
+            [ "#{moc_name} -o #{moc_full} " + 
+              "#{header_full}" ],
+            [ moc_full ],
+            "building moc file #{moc_full}" )
+        end
+
+        add_cpp_source( a_target, moc_full )
+      }
+    end
+
+    # Perform cleanup of files produced by generation from hpp file.
+    def clean_from_h( a_target )
+      @qt_h2moc_files.each { |h|
+        moc = moc_from_h( h, a_target )
+
+        MxxRu::Util::delete_file( moc )
+
+        add_cpp_source( a_target, moc )
+      }
+    end
+
+    # Formatting file name, which is generated from hpp file by moc tool
+    def moc_from_h( a_h_file, a_target )
+      path = File.dirname( a_h_file )
+
+      # If path == ".", then Qt will generate wrong include directive
+      path = "" if path == "./"
+      path = make_moc_result_path_for( path )
+
+      MxxRu::Util::ensure_path_exists( path )
+
+      r = File.join( path, "moc_" + File.basename(
+        MxxRu::Util::remove_file_ext( a_h_file ) ) + @cpp_ext )
+    end
+
+    # Perform generation from cpp file using moc tool.
+    def build_from_cpp( a_target )
+      @qt_cpp2moc_files.each { |cpp_full|
+        moc_full = moc_from_cpp( cpp_full, a_target )
+
+        if TargetState::EXISTS != TargetState.detect(
+          moc_full, [ cpp_full ] ).state
+          MxxRu::AbstractTarget::run(
+            [ "#{moc_name} -o #{moc_full} " + 
+              "#{cpp_full}" ],
+            [ moc_full ],
+            "building moc file #{moc_full}" )
+        end
+      }
+    end
+
+    # Perform cleanup of files produced by generation from cpp file.
+    def clean_from_cpp( a_target )
+      @qt_cpp2moc_files.each { |cpp|
+        moc = moc_from_cpp( cpp, a_target )
+
+        MxxRu::Util::delete_file( moc )
+      }
+    end
+
+    # Formatting file name, which is generated from cpp file by moc tool
+    def moc_from_cpp( a_cpp_file, a_target )
+      path = make_moc_result_path_for( File.dirname( a_cpp_file ) )
+
+      MxxRu::Util::ensure_path_exists( path )
+
+      r = File.join( path, File.basename(
+        MxxRu::Util::remove_file_ext( a_cpp_file ) ) + @moc_ext )
+
+      return r
+    end
+
+    # Setting C++ file name, ignoring current sources_root value.
+    def add_cpp_source( a_target, a_file )
+      old_root = a_target.sources_root( "" )
+      a_target.cpp_source( a_file )
+      a_target.sources_root( old_root )
+    end
+
+    # Calculating path for moc results.
+    def make_moc_result_path_for( path )
+      if @moc_result_subdir
+        if path.length > 0
+          File.join( path, @moc_result_subdir )
+        else
+          @moc_result_subdir
+        end
+      else
+        path
+      end
+    end
+
+    # Calculating path for uic results.
+    def make_uic_result_path_for( file )
+      File.join( File.dirname( file ), @uic_result_subdir )
+    end
+
+    # Detect list of dependencies for .qrc file.
+    def Qt4.detect_qrc_file_dependencies( a_qrc_file )
+      qrc_file_path = File.dirname( a_qrc_file )
+      result = []
+      File.open( a_qrc_file, 'r' ) do |file|
+        doc = REXML::Document.new( file )
+        result = doc.elements[ '/RCC/qresource/file' ].inject( [] ) do
+          |list, item|
+          s = item.value
+          p = Pathname.new( s )
+          if !p.absolute?
+            list << File.join( qrc_file_path, s )
+          else
+            list << s
+          end
+          list
+        end
+      end
+
+      result
+    end
+
+  end # class Qt4
+
+end
+end
+