rubber-generate 0.0.6 → 0.0.7

data/README.textile

@@ -1,6 +1,6 @@
 h1. Rubber Generate
 
-h2. v0.0.5
+h2. v0.0.7
  
 Template language for generating Ruby bindings for C libraries
 by Geoff Youngs <g@intersect-uk.co.uk>
@@ -18,6 +18,17 @@ it is planned to remove this dependency unless they genuinely require Ruby/GTK.
 Other features include custom named type-maps, pre/post code inclusion within
 functions and some rudimentary understanding of C code.
 
+h3. Changes
+
+ * 0.0.7 - 7th May 2010
+   - Add support for array constants (including autmatic type detection) - e.g array <ConstantName> = [ "Text", NULL, 3 ]
+   - Add syntax_error function to parser which reports slightly more helpful syntax error messages for a .cr file
+   - Add tracking of code location so that C compiler throws errors which refer to the original line in the .cr file
+   - Add support for GSList{type} or GList{type} conversion to arrays as return values for functions
+
+ * 0.0.6 - 6th May 2010
+   - Flags class allows wrapping a bit field with slightly more information.  Plus automatic conversion to/from ruby and support for integer values.
+
 h3. Dependencies
 
  * Ruby 1.8.6

data/lib/rubber/codegen/array.rb

@@ -0,0 +1,59 @@
+module Rubber
+
+class C_Array
+  define_members :name, :values, :parent
+  def code(io)
+  end
+  def declare(io)
+    #io.puts "static VALUE #{cname};"
+  end
+  include RegisterChildren
+  def default_cname
+    #"enum"+name
+  end
+  def doc_rd(io)
+    depth = (fullname.gsub(/[^:]/,'').size >> 1)
+    io.puts "=#{'=' * depth} #{fullname}"
+  end
+  def get_root(); is_root? ? self : parent.get_root; end; def is_root?()
+    not parent.respond_to?(:fullname)
+  end
+  def fullname()
+    if parent and parent.respond_to?(:fullname)
+      "#{parent.fullname}::#{name}"
+    else
+      name
+    end
+  end
+  def get_root(); is_root? ? self : parent.get_root; end; 
+  def is_root?()
+    not parent.respond_to?(:fullname)
+  end
+  def register(io, already_defined=false)
+    if parent
+		args = "#{@values.size}"
+		@values.each_with_index do |hash, index|
+			args << ", "
+			case hash.keys[0]
+			when :int
+				args << "INT2NUM(#{hash.values[0]})"
+			when :bool
+				args << "((#{hash.values[0]}) ? Qtrue : Qfalse)"
+			when :float
+				args << "FLOAT2NUM(#{hash.values[0]})"
+			when :string
+				args << "rb_str_new2(#{hash.values[0]})"
+			when :nil
+				args << "Qnil"
+			else
+				raise "Unknown key type for static array - #{hash.keys[0]}"
+			end
+		end
+		io.puts "    rb_define_const(#{parent.cname}, #{name.inspect}, rb_ary_new3(#{args}));"
+    else
+      raise "No parent for string constant #{name}"
+    end
+  end
+end
+
+end # Rubber

data/lib/rubber/codegen/function.rb

@@ -2,6 +2,7 @@ module Rubber
 
 class C_Function
   define_members(:name, :args, :text, :parent, {:autofree=>[]}, {:returntype=>'VALUE'}, :doc=>'')
+  attr_accessor :source_line, :source_file
   attr_reader :multi, :block, :rest, :singleton
   def check()
     return if @checked
@@ -136,7 +137,9 @@ class C_Function
         end
      }
     end
+
     io.puts ""
+	io.puts "#line #{source_line} #{source_file.inspect}" if source_line
     setupvars = io.string
     io = oio
     
@@ -153,7 +156,7 @@ class C_Function
 	to_type = (!(to_type.nil? or to_type.empty?) && to_type || (arg && arg.ctype || guess(cast)))
         io.write(Rubber.explicit_cast(cast, from_type, to_type))
      elsif txt = sc.scan(CAST)
-	warn("<TYPE:VALUE> is deprecated - please use <{FROM_TYPE>TO_TYPE:VALUE}> instead.")
+		warn("<TYPE:VALUE> is deprecated - please use <{FROM_TYPE>TO_TYPE:VALUE}> instead.")
         name, cast = sc[1], sc[2]
         arg = @arghash[name]
         io.write(Rubber::explicit_cast(name, arg && arg.ctype || guess(name), cast))
@@ -187,8 +190,8 @@ class C_Function
               retval << (mini_scanner.get_byte)
             end
           end
-          unless Rubber::native_type?(returntype)
-            io << Rubber::explicit_cast(retval, returntype, 'VALUE')
+          unless Rubber.native_type?(returntype)
+            io << Rubber.explicit_cast(retval, returntype, 'VALUE')
           else
             io << retval
           end

data/lib/rubber/codegen.rb

@@ -18,9 +18,14 @@ def generate_c_source(scanner, io)
   io.puts "typedef int rubber_bool;"
   io.puts "#define bool rubber_bool"
   io.puts "\n/* Prototypes */"
-  io.puts '#include "rbglib.h"' if scanner.options.glib?
+if scanner.options.glib?
+  io.puts <<-EOGLIB
+#include "rbglib.h"
+
+EOGLIB
+
   
-if scanner.options.glib? and scanner.options.gtk?
+if scanner.options.gtk?
   io.write <<-EOI
 #include "rbgtk.h"
 
@@ -40,6 +45,7 @@ RUBY_GTK2_VAR VALUE mGdk;
 #define RBGTK_INITIALIZE(obj,gtkobj)\
  (rbgtk_initialize_gtkobject(obj, GTK_OBJECT(gtkobj)))
 EOI
+end
 end
 
 
@@ -69,6 +75,7 @@ end
 module_function :generate_c_source
 
 module RegisterChildren
+	attr_accessor :source_line, :source_file
 	attr_reader :child_names
 	def register_children(io)
 	    @child_names = {}
@@ -112,6 +119,7 @@ require 'rubber/codegen/function'
 require 'rubber/codegen/string'
 require 'rubber/codegen/integer'
 require 'rubber/codegen/float'
+require 'rubber/codegen/array'
 
 # Special
 require 'rubber/codegen/struct'

data/lib/rubber/scanner.rb

@@ -33,7 +33,9 @@ def initialize(file)
   @options.glib= true
   @options.gtk= true
   @options.gnu= false
+  @current_file = file
 end
+attr_reader :current_file
 def scan_args()
   args = []
   return args unless @str.peep(1) == '('
@@ -76,7 +78,7 @@ def scan(fp)
 end
 def _scan(fp)
   @lines = IO.readlines(@file)
-  @str = StringScanner.new(@lines.join)
+  @str = StringScanner.new(@string = @lines.join)
   tokens = []
   @state = ScanState.new(0,0,false,0)
   @stack = [C_RootModule.new]
@@ -129,7 +131,7 @@ def _scan(fp)
       when 'glib','gtk','gnu'
       	@options[@str[1]] = (@str[2] == 'yes')
       else
-        raise "Unknown option #{@str[1]}"
+        syntax_error "Unknown option #{@str[1]}"
       end
     elsif @str.skip(/%lib\s+(.+)\n/) # Skip single-line comment
       @libs ||= []
@@ -152,7 +154,7 @@ def _scan(fp)
     	if stack.last.respond_to?(flag)
 	   stack.last.__send__(flag, true)
 	else
-	   raise "%flags directive cannot be used here (#{stack.last.class} doesn't respond to #{flag})"
+	   syntax_error "%flags directive cannot be used here (#{stack.last.class} doesn't respond to #{flag})"
 	end
     elsif state.in_class > 0 and state.in_func == false and @str.skip(/%feature\s+([a-z0-9_A-Z]+)/)
     	flag = ("feature_"+@str[1]).intern
@@ -165,7 +167,7 @@ def _scan(fp)
     	if stack.last.respond_to?(flag)
 	   stack.last.__send__(flag, *args)
 	else
-	   raise "%feature '#{@str[1]}' directive cannot be used here (#{stack.last.class} doesn't support it)"
+	   syntax_error "%feature '#{@str[1]}' directive cannot be used here (#{stack.last.class} doesn't support it)"
 	end
     elsif @str.skip(/%/) # Skip single-line comment
       @str.skip_until(/\n/) 
@@ -286,7 +288,7 @@ def _scan(fp)
       when "gboxed"
         @classes[name] = C_GBoxed.new(name, gtype, [], [], [])
       else
-        raise "#{name} is not a GObject or GInterface..."
+        syntax_error "#{name} is not a GObject or GInterface..."
       end
       @classes[name].gparent_class = gparent_class
       @classes[name].parent = stack.last
@@ -324,7 +326,7 @@ def _scan(fp)
         STDERR.puts "Remaining code: #{@str.rest}"
         STDERR.puts "Defined Classes: #{@classes.keys.join(', ')}"
         p stack
-        raise "Invalid stack entry #{last.class}"
+        syntax_error "Invalid stack entry #{last.class}"
       end
     elsif @str.skip(/alias\s+:([A-Za-z0-9_]*[\[\]]{0,2}[?!=]?)\s+:([A-Za-z0-9_]*[\[\]]{0,2}[?!=]?)/) # Alias
       @class.add_alias(@str[1], @str[2]) if @class.respond_to?(:add_alias)
@@ -332,7 +334,7 @@ def _scan(fp)
 		where = @str[1]
 		str = @str.scan_until(/\bend/)#[0,-4]
 		unless str
-			raise "Invalid #{where}_func definition: #{@str.peek(200).inspect}"
+			syntax_error "Invalid #{where}_func definition"
 		end
 		str = str[0..-4].strip
 		except = only = nil
@@ -361,6 +363,30 @@ def _scan(fp)
       @str.skip(/\s+/)
       if @str.scan(/([a-zA-Z_* ]+):/)
         returntype = @str[1]
+	  elsif @str.skip(/(GS?List){([^}]+)}:/)
+		container = @str[1]
+		ct = @str[2]
+		cn = ct.gsub(/\s+/,'').gsub(/[*]/,'__p')
+		rule = container+'{'+ct+'}'
+		returntype = rule
+		
+		#syntax_error "Auto converting (#{rule}) GSList of #{ct} is not yet supported"
+		#  sane
+		unless $custom_maps[rule] && $custom_maps[rule]['VALUE']
+		   function = "rubber_#{container}_of_#{cn}_to_array"	
+			@raw = @raw.to_s + <<-EOADD
+inline VALUE #{function}(#{container} *list) {
+	#{container} *p; volatile VALUE ary;
+	ary = rb_ary_new();
+	for(p = list ; p ; p = p->next) {
+		rb_ary_push(ary, #{Rubber.explicit_cast('(('+ct+') p->data )', ct, 'VALUE')});
+	}
+	return ary;
+}
+EOADD
+			$custom_maps[rule] ||={}
+			$custom_maps[rule]['VALUE'] = function+"(%%)"
+		end
       else
         returntype = 'VALUE'
       end
@@ -380,6 +406,8 @@ def _scan(fp)
       stack.last.functions.push(func)
       puts "def "+ func.fullname
       stack.push(func)
+	  func.source_line = current_line
+	  func.source_file = current_file
       state.in_func = true
       
     elsif state.in_func == false and @str.skip(/(string|integer|float|double|int)(?= )/x) # C String as module wrapper
@@ -404,16 +432,61 @@ def _scan(fp)
         klass = C_Float
       end
       stack.last.classes.push(klass.new(name, string, stack.last)) if klass
-      
+    elsif state.in_func == false && @str.skip(/(array)(?= )/x)
+	  type = @str[1]
+	  @str.skip(/\s+/)
+      name = @str.scan(/[A-Z][a-z_0-9A-Z]*/)
+      @str.skip(/\s*=\s*/)
+	  values = []
+	  if @str.skip(/\[/)
+		 @str.skip(/\s+/)
+		 until @str.skip(/\s*\]/)
+			if @str.skip(/(".*?[^\\]")/)
+				values << { :string => @str[1] } # unescape escaped chars?
+		    elsif @str.skip(/(\d[.]\d+)/)
+				values << { :float => @str[1] }
+			elsif @str.skip(/(\d+)/)
+				values << { :int => @str[1] }
+			elsif @str.skip(/NULL/)
+				values << { :nil => true }
+			elsif @str.skip(/(TRUE|FALSE)/)
+				values << { :bool => @str[1] == 'TRUE' }
+			elsif @str.skip(/([A-Za-z0-9_]+)/)
+				values << { :int => @str[1] } # Assume a constant
+			else
+				syntax_error "Unrecognised array value" 
+			end
+			@str.skip(/\s*,\s*/)
+		 end
+		 stack.last.classes.push(C_Array.new(name, values, stack.last))
+		 p [ :create_array, values ]
+	  else
+		  syntax_error "Arrays should be in the form: [value1, value2, ... valueN]" 
+	  end
     elsif txt = @str.get_byte # Spare chars
       if state.in_func
         func.text += txt
       else
-      	puts '"' << txt << '"'
+		 syntax_error "Invalid character #{txt}"
       end
     end
   end
 end
+  def current_line
+	count = 0
+	@string[0..@str.pos].each_byte { |b| count += 1 if b == 10 }
+	count
+  end
+  def syntax_error(message)
+	STDERR.puts "Syntax Error: #{message} at line #{current_line}\n"
+	if @str.rest.size > 255
+		STDERR.puts @str.rest[0..255]+"..."
+	else
+		STDERR.puts @str.rest
+	end
+	exit 1
+  end
+
 end
 
 end # m Rubber

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Geoff Youngs
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-05 00:00:00 +01:00
+date: 2010-05-07 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -29,6 +29,7 @@ extra_rdoc_files:
 files: 
 - bin/rubber-generate
 - lib/rubber/autord.rb
+- lib/rubber/codegen/array.rb
 - lib/rubber/codegen/class.rb
 - lib/rubber/codegen/enum.rb
 - lib/rubber/codegen/flags.rb