easy-swig 1.0

data/lib/easy-swig-cli.rb

@@ -0,0 +1,143 @@
+#!/usr/bin/env ruby
+require 'optparse'
+
+require_relative '../lib/easy-swig'
+
+options = {}
+
+opt_parser = OptionParser.new do |opt|
+  opt.banner = "Welcome to Easy Swig - SWIG made easy!!"
+  opt.banner = "Usage: easy-swig COMMAND [OPTIONS]"
+  opt.separator ""
+  opt.separator "Commands (Use given options to override defaults)"
+  opt.separator "     doxygen: Parses header files (.h) and generates XMLs using Doxygen. Tune with --input, --doxy, --name, --html"
+  opt.separator "     generate: Generates SWIG Interface Files from XMLs. Tune with --csv, --doxy, --gen, --name, --lang, --custom,"
+  opt.separator "     swig: Runs SWIG against the specified interface files. Tune with --target, --input, --output, --include, --lang"
+  opt.separator ""
+  opt.separator "Options"
+
+  opt.on("-d", "--default DIRECTORY", "Uses the given directory for default values for all needed options") do |dir|
+    options[:default] = dir
+  end
+
+  opt.on("-n", "--name MODULE_NAME", "Name of the module. Used to name generated resources") do |name|
+    options[:mod_name] = name
+  end
+
+  opt.on("-c", "--csv FILE", "CSV configuration file input") do |file|
+    options[:csvfile] = file
+  end
+
+  opt.on("-i", "--input DIRECTORY", "Directory for your project's header files") do |dir|
+    options[:hdir] = dir
+  end
+
+  opt.on("-I", "--include DIRECTORY", "Directory for additional header files not part of your project. Example: /usr/include") do |dir|
+  	options[:incdir] ||= []
+    options[:incdir] << dir
+  end
+
+  opt.on("-x", "--doxy DIRECTORY", "Directory generated by Doxygen (which include a /xml subdirectory for all XML files") do |dir|
+    options[:xdir] = dir
+  end
+
+  opt.on("-m", "--html", "Instructs Doxygen to also generate HTML documentation for the header files") do
+    options[:html] = true
+  end
+
+  opt.on("-g", "--gen DIRECTORY", "Output directory for Easy-Swig generated .i file(s) aka. 'target'") do |dir|
+    options[:gdir] = dir
+  end
+
+  opt.on("-o", "--output DIRECTORY", "Output directory for SWIG generated files") do |dir|
+    options[:odir] = dir
+  end
+
+  opt.on("-l", "--lang LANGUAGE", "Target language for SWIG") do |lang|
+    options[:lang] = lang
+  end
+
+  opt.on("-t", "--target PATH", "Target .i file as input for SWIG. For directories, SWIG will be invoked once for every .i file") do |path|
+    options[:target] = path
+  end
+
+  opt.on("-u", "--custom FILE", "Custom .i file to be appended at the beginning of the generated .i target. Used for advanced configuration") do |file|
+    options[:custom] = file
+  end
+  
+  opt.on("-s", "--no_stl", "Disable support for the C++ Standard Template Library STL") do |file|
+    options[:no_stl] = true
+  end
+
+  opt.on("-h", "--help", "Help") do
+    puts opt_parser
+  end
+
+  opt.separator ""
+  opt.separator "Default option values:"
+  opt.separator ""
+  opt.separator "-d (--default DIRECTORY) Defaults to the current working directory"
+  opt.separator "-n (--name MODULE_NAME) Defaults to the name of the default directory"
+  opt.separator "-c (--csv FILE) Defaults to: path/to/default/dir/api.csv"
+  opt.separator "-i (--input DIRECTORY) Defaults to: path/to/default/dir/include"
+  opt.separator "-I (--include DIRECTORY) Defaults to linux include path: usr/include"
+  opt.separator "-x (--doxy DIRECTORY) Defaults to: path/to/default/dir/easy-swig/doxygen"
+  opt.separator "-m (--html) Defaults to false"
+  opt.separator "-s (--no_stl) Defaults to false"
+  opt.separator "-g (--gen DIRECTORY) Defaults to path/to/default/dir/easy-swig/generate"
+  opt.separator "-o (--output DIRECTORY) Defaults to : path/to/default/dir/easy-swig/swig"
+  opt.separator "-l (--lang LANGUAGE) Defaults to C# (csharp)"
+  opt.separator "-t (--target PATH) Defaults to path/to/default/dir/easy-swig/generate/<MODULE_NAME>.i"
+  opt.separator "-u (--custom FILE) Defaults to path/to/default/dir/custom_config.i"
+
+end
+
+opt_parser.parse!
+
+config = ::EasySwig::Config.new
+
+if !options[:default].nil? && Dir.exists?(options[:default])
+	puts 'Default directory: ' + options[:default]
+	config.default_dir = options[:default]
+else
+  puts 'No valid default directory was provided: Use current working directory as default? (y/n)'
+  $stdout.flush
+  answer = $stdin.gets
+  exit! unless answer =~ /^[yY]/
+end
+
+config.module_name = options[:mod_name]
+config.doxy_dir = options[:xdir]
+config.headers_dir = options[:hdir]
+config.csv_file = options[:csvfile]
+config.output_dir = options[:odir]
+config.generate_dir = options[:gdir]
+config.html = options[:html]
+config.lang = options[:lang]
+config.stl_support = options[:no_stl].nil? ? 'YES' : nil
+
+options[:custom] ||= "custom_config.i"
+
+if File.exists?(options[:custom])
+  puts 'Custom configuration file: ' + options[:custom]
+  config.custom_file = options[:custom]
+else
+	config.custom_file = nil
+  puts 'No custom configuration file found' 
+end
+
+config.target_file = options[:target]
+config.includes_dir = options[:incdir]
+
+config.set_defaults
+
+case ARGV[0]
+  when "doxygen"
+    EasySwig::doxygen(config)
+  when "generate"
+    EasySwig::generate(config)
+  when "swig"
+    EasySwig::swig(config)
+else
+puts opt_parser
+end

data/lib/easy-swig.rb

@@ -0,0 +1,71 @@
+require 'rubygems'
+require '/home/david/workspace/ruby-doxygen-parser/lib/doxyparser'
+require 'fileutils'
+require 'logger'
+
+require_relative 'config'
+require_relative 'util/utilities'
+require_relative 'util/print'
+require_relative 'util/logger'
+require_relative 'util/query'
+require_relative 'generators/properties'
+require_relative 'generators/generator_util'
+require_relative 'generators/class_generator'
+require_relative 'generators/namespace_generator'
+require_relative 'generators/hfile_generator'
+require_relative 'generators/generator'
+require_relative 'features'
+require_relative 'apinodes/api_node'
+require_relative 'apinodes/api_namespace'
+require_relative 'apinodes/api_function'
+require_relative 'apinodes/api_class'
+require_relative 'apinodes/api_method'
+require_relative 'apinodes/api_group'
+require_relative 'apinodes/inc_file'
+require_relative 'apinodes/api_variable'
+require_relative 'apinodes/api_attribute'
+require_relative 'apinodes/api_enum'
+
+require_relative 'csharp/generators/csharp_generator'
+require_relative 'csharp/generators/csharp_namespace_generator'
+require_relative 'csharp/generators/csharp_class_generator'
+require_relative 'csharp/csharp_features'
+
+require_relative 'tasks/swig_task'
+
+require_relative 'tasks/doxygen_task'
+require_relative 'readers/csv_parser'
+require_relative 'tasks/hfiles_manager'
+require_relative 'tasks/generate_task'
+
+module EasySwig
+  class << self
+
+		# Parses header files (.h) and generates intermediate XML representation using Doxygen (Doxyparser)
+		# For more information consult Doxyparser documentation {Doxyparser::gen_xml_docs}
+		# @param [Config] config optional configuration for personalized settings. If nothing given, {Config} defaults used
+    def doxygen(config = EasySwig::Config.new)
+      task = DoxygenTask.new(config)
+      task.generate
+      task.dispose
+    end
+
+    # Generates SWIG Interface Files (.i) from Doxygen intermediate XML representation.
+    # 	This process is configured using a specially crafted CSV file (see documentation),
+    #   A subdirectory for every found namespace is created and here are saved the generated .i swig files
+    # @param [Config] config optional configuration for personalized settings. If nothing given, {Config} defaults used 
+    def generate(config = EasySwig::Config.new)
+      task = GenerateTask.new(config)
+      task.generate
+      task.dispose      
+    end
+
+    # Runs SWIG against the specified target interface files (.i) And generated wrappers in the output directory (see {Config})
+    # @param [Config] config optional configuration for personalized settings. If nothing given, {Config} defaults used
+    def swig(config = EasySwig::Config.new)
+      task = SwigTask.new(config)
+      task.run_swig
+      task.dispose
+    end
+  end
+end

data/lib/features.rb

@@ -0,0 +1,39 @@
+module EasySwig
+
+  class Features
+
+    def Features.create_instance(lang)
+      ret = case lang
+      when 'java'
+        EasySwig::Java::JavaFeatures.new
+      when 'csharp'
+        EasySwig::Csharp::CsharpFeatures.new
+      else
+      	EasySwig::Csharp::CsharpFeatures.new
+      end
+      ret
+    end
+
+    def empty?
+      false
+    end
+
+    def to_s
+      ""
+    end
+
+    def to_str
+      to_s
+    end
+
+    def infer_native_name(node)
+      node.basename ||= node.target_name.gsub(".", "::").gsub(/_([a-z])/i) { |match|
+        $1.upcase
+      }
+    end
+
+    def infer_target_name(node)
+      node.target_name ||= node.basename.gsub("::", ".")
+    end
+  end
+end

data/lib/generators/class_generator.rb

@@ -0,0 +1,209 @@
+module EasySwig
+
+  class ClassGenerator
+  	include GeneratorUtil
+
+    def initialize(api_cls, all_types, all_innerclasses, all_friends)
+      @api_class = api_cls
+      @all_types = all_types
+    	@all_innerclasses = all_innerclasses
+    	@all_friends = all_friends
+    	@types = {}
+    end
+    
+    def process_types
+    	swig_file = ''
+    	swig_file << process_types_for(@api_class)
+    	@api_class.api_innerclasses.each { |c|
+    		swig_file << process_types_for(c)
+    	}
+    	swig_file
+    end
+    
+    def process_types_for(klass)
+    	swig_file = ''
+      klass.parent_types(:all).each { |p_type|
+      	begin
+      		process_type(p_type, klass)
+      	rescue ArgumentError;	end 
+      }
+      remove_methods = []
+    	klass.api_methods.each { |m|
+    		begin
+		      process_type(m.type, klass) unless m.constructor? || m.destructor? 
+		      m.params.each { |p|
+		      	process_type(p.type, klass)
+		      }
+        rescue ArgumentError
+        	remove_methods << m
+      		swig_file << %Q{%rename("$ignore") #{klass.name}::#{m.basename};} + "\n"
+      	end
+      }
+      klass.api_methods.reject! { |m| remove_methods.include?(m) }
+      
+      remove_attributes = []
+      klass.api_attributes.each { |a|
+      	begin 
+      		process_type(a.type, klass)
+      	rescue ArgumentError
+      		remove_attributes << a
+      		swig_file << %Q{%rename("$ignore") #{klass.name}::#{a.basename};} + "\n"
+      	end
+      }
+      klass.api_attributes.reject! { |a| remove_attributes.include?(a) }
+      swig_file
+    end
+
+    def gen_methods
+      swig_file = ''      
+      @api_class.ignored_methods.each { |m|
+        swig_file << %Q{%rename("$ignore") #{@api_class.name}::#{m.basename};} + "\n"
+      }
+      properties = {}
+      @api_class.api_methods.each { |m| 
+      	if m.basename=='getTextureAddressingMode'
+      		puts "Aqui"
+      	end
+        features = m.features
+        if features.properties
+          getter = m.getter_for
+          setter = m.setter_for
+          if setter
+            properties[m.target_name] ||= EasySwig::Properties.new
+            properties[m.target_name].setter = m.basename
+            properties[m.target_name].static = m.static
+          	properties[m.target_name].type_setter ||= m.params[0].type
+          elsif getter
+            properties[m.target_name] ||= EasySwig::Properties.new
+          	properties[m.target_name].getter = m.basename
+          	properties[m.target_name].static = m.static
+          	properties[m.target_name].type_getter = m.type
+          else
+            swig_file << %Q{%rename(#{m.target_name}) #{m.name};\n} unless is_operator?(m.basename) || @api_class.is_enum_or_innerclass?(m.target_name)
+          	next
+          end
+        properties[m.target_name].class_name = @api_class.name
+        else
+          swig_file << %Q{%rename(#{m.target_name}) #{m.name};\n} unless is_operator?(m.basename) || @api_class.is_enum_or_innerclass?(m.target_name)
+        end
+      }
+      properties.each { |attribute, property|
+      	next if property.getter.nil? 
+      	next if property.type_setter != property.type_getter
+      	type = property.type_getter
+    		case get_reference_type(type, @api_class)
+				when :ptr
+					macro = 'attribute'
+					escaped_typename = type.escaped_name.gsub('>::type', '>') # TODO only for Ogre
+				when :ref
+					macro = 'attribute2'
+					next # Ref Properties not supported
+				when :str
+					macro = 'attributestring'
+					escaped_typename = type.escaped_name
+				when :prim_ptr
+					macro = 'attribute'
+					escaped_typename = type.name
+				when :val
+					macro = 'attributeval'
+					next # Properties per Value not supported
+				end
+				unless macro.nil?
+					macro << '_static' if property.static
+      		swig_file << "%#{macro}(#{property.class_name}, #{escaped_typename}, #{attribute}, #{property.getter}, #{property.setter});\n"
+      	end
+      }
+      swig_file
+    end
+
+    def gen_attributes
+      swig_file = ''
+      @api_class.ignored_attributes.each { |m|
+        swig_file << %Q{%rename("$ignore") #{m.name};} + "\n"
+      }
+      @api_class.api_attributes.each { |a|
+        swig_file << %Q{%rename(#{a.target_name}) #{a.name};} + "\n"
+      }
+      swig_file
+    end
+
+    def gen_enums
+      swig_file = ''
+      @api_class.ignored_enums.each { |m|
+        swig_file << %Q{%rename("$ignore") #{m.name};} + "\n"
+      }
+      @api_class.api_enums.each { |enum|
+      	if anonymous_enum?(enum)  # @Anonymous Enums
+          swig_file << "\nnamespace #{@api_class.parent.name} {"
+          swig_file << enum_snippet(enum)
+        	swig_file << "\t}\n"
+					swig_file << ignore_enum_values_snippet(enum)
+        else
+        swig_file << %Q{%rename(#{enum.target_name}) #{enum.name};} + "\n"
+				end
+      }
+      swig_file
+    end
+
+    def gen_innerclasses
+      swig_file = ''
+      @api_class.ignored_innerclasses.each { |c|
+        swig_file << %Q{%rename("$ignore") #{@api_class.name}::#{c.basename};} + "\n"
+      }
+      @api_class.api_innerclasses.each { |c|
+        if c.nested_support							# Innerclasses
+          swig_file << nested_workaround(c)
+        else
+          swig_file << %Q{%rename(#{c.target_name}) #{@api_class.name}::#{c.basename};\n}
+        end
+      }
+      swig_file
+    end
+      
+    def gen_parent_templates
+    	swig_file = "\n"
+      @types.invert.each { |expanded, typename|
+      	swig_file << template_snippet(typename, expanded)
+      }
+      swig_file
+    end
+    
+    def gen_type_templates
+      swig_file = "\n"     
+      @types.invert.each { |expanded, typename|
+      	swig_file << template_snippet(typename, expanded)
+      }
+      swig_file
+    end
+
+    def gen_friends
+      swig_file = ''
+      if @api_class.friend_support
+        namespace = @api_class.parent
+        friend_functions = @api_class.friends.delete_if{ |f| f.is_class? || f.is_qualified? }
+        return '' if friend_functions.empty?
+        
+        swig_file << "namespace #{namespace.name} {\n"
+        swig_file << "\tclass #{@api_class.basename};\n"
+        friend_functions.each { |f|
+        	next if @all_friends[f.basename + f.args]
+          swig_file << "\t#{f.type.name} #{name_for_friend(f.basename, f.params.size)}#{f.args};\n"
+        }
+        swig_file << "}\n"
+        swig_file << "%{\nnamespace #{namespace.name} {\n"
+        swig_file << "\tclass #{@api_class.basename};\n"
+        friend_functions.each { |f|
+        	signature = f.basename + f.args
+        	next if @all_friends[signature]
+        	@all_friends[signature] = 1
+        	param_names = f.params.map { |p| p.declname }.join(', ') # TODO What happens when declname is empty
+        	friend_name = name_for_friend(f.basename, f.params.size)
+          swig_file << "\t#{f.type.name} #{friend_name}#{f.args}{\n"
+          swig_file << "\t\treturn #{f.basename}(#{param_names});\n\t}\n"
+        }
+        swig_file << "}\n%}\n"
+      end
+      swig_file
+    end
+  end
+end