rubber-generate 0.0.5 → 0.0.6

data/README.textile

@@ -0,0 +1,54 @@
+h1. Rubber Generate
+
+h2. v0.0.5
+ 
+Template language for generating Ruby bindings for C libraries
+by Geoff Youngs <g@intersect-uk.co.uk>
+
+h3. Introduction
+
+A simple ruby-style bindings generator for Ruby.  It allows bindings to 
+be laid out in a Ruby style, documentation to be included inline and 
+explicit type casts within C code.  It's somewhere between SWIG and pyrex.
+
+It also allows features extconf.rb creation, including checks for headers,
+pkg-config etc.  The modules it creates currently depend on Ruby/GTK, but
+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. Dependencies
+
+ * Ruby 1.8.6
+
+h3. Example
+
+Sample file:
+
+ * example/vte.cr
+
+Usage:
+<pre>
+  $ rubber-generate --generate --build vte.cr
+</pre>
+
+Which should generate
+  [arch]/vte.c      <- Source code for extension
+  [arch]/vte.rd     <- RD documentation from vte.cr
+  [arch]/extconf.rb <- Config script
+  [arch]/vte.o      <- Object file
+  [arch]/vte.so     <- Compiled extension
+
+h3. Installation
+
+<pre>
+  $ sudo gem install rubber-generate
+</pre>
+
+h3. Credits
+
+Author: Geoff Youngs
+
+Contributors: 
+ * Vincent Isambart

data/example/vte.cr

@@ -0,0 +1,366 @@
+%include vte/vte.h
+
+%{
+
+VALUE
+long_array(long values[], int size)
+{
+  VALUE arr;
+  int i;
+  
+  arr = rb_ary_new();
+  
+  for(i=0; i < size; i++)
+    rb_ary_push(arr, LONG2NUM(values[i]));
+  
+  return arr;
+}
+char **
+string_list(VALUE ary)
+{
+  char **list = NULL;
+  int i;
+  
+  if (NIL_P(ary))
+    return NULL;
+  
+  list = ALLOC_N(char*, RARRAY(ary)->len + 1);
+  
+  for (i = 0; i < RARRAY(ary)->len; i++)
+  {
+      list[i] = StringValuePtr(RARRAY(ary)->ptr[i]);
+  }
+  list[i] = NULL;
+  
+  return list;
+}
+
+%}
+
+
+%name vte
+%pkg-config vte
+
+%map VALUE > fontdescription : ((PangoFontDescription*)RVAL2BOXED((%%), PANGO_TYPE_FONT_DESCRIPTION))
+%map fontdescription > VALUE : (BOXED2RVAL((void*)(%%), PANGO_TYPE_FONT_DESCRIPTION))
+
+%map VALUE > GdkColor* : ((GdkColor*)RVAL2BOXED((%%), GDK_TYPE_COLOR))
+%map GdkColor* > VALUE : (BOXED2RVAL((void*)(%%), GDK_TYPE_COLOR))
+
+%map long* > VALUE : long_array(%%, (sizeof(%%) / sizeof(%%[0])))
+%map VALUE > char** : string_list(%%)
+
+%map GdkPixbuf* > VALUE : GOBJ2RVAL(%%)
+%map VALUE > GdkPixbuf* : GDK_PIXBUF(RVAL2GOBJ(%%))
+
+
+=begin
+= VTE Terminal Widget
+
+The VTE widget is a new terminal widget meant to replace zvt. It is used by gnome-terminal as of GNOME 2.2.x 
+
+== Features
+=== Unicode support 
+Recently added support for UTF-8 display, select and paste. Currently supports fixed-width, iso10646-encoded and wide fonts. 
+
+=== Background pixmaps 
+A very fast implementation of background pixmaps and pseudo-transparency means all users can have beautiful desktops without heavily impacting their work. 
+
+=== Secure and portable 
+Only a small external program is required to interact directly with the operating system and pseudo tty interface. This is easily ported to different Unix systems and auditable for security. 
+
+=== Easy to use and feature rich 
+Through a simple api adding a complete terminal execution environment to any application (including secure tty setup and utmp/wtmp logging) is next to trivial (3-4 function calls). It can also be used as a direct text display engine with colour/attributes and cursor addressible display without the need for a separate sub-process. 
+
+Features include configurable colours, pixmaps/transparency, beeps, blinking cursor, selecting by word characters, and more. Plus all the usual stuff like selection/pasting, and scrollback buffer. 
+
+=== xterm compatible 
+It aims towards being a terminal-compatible dropin for the xterm program. This is to aid interoperability with foreign systems. The rarely used Tektronix graphics terminal component has been dropped however. 
+
+=== Dingus Click 
+Allows auto highlighting of a set of text matching a regular expression. Used by the gnome-terminal to launch a web-browser when the user shift-clicks on a URL. 
+
+=== Actively developed 
+Steadily improving feature set and stability. 
+
+=end
+module VTE
+  gobject Terminal < VTE_TYPE_TERMINAL : Gtk::Widget
+    def initialize()
+=begin
+  Create a new terminal widget
+  
+  * Returns: new instance of VTE::Terminal
+=end
+      RBGTK_INITIALIZE(self, vte_terminal_new());
+    end
+    
+    def uint:fork_command(char *command, char ** argv, char ** envv, char *dir, bool lastlog = FALSE, bool utmp = FALSE, bool wtmp = FALSE)
+=begin
+  Fork the child process for the terminal, e.g. terminal.fork_command("/bin/sh", nil, nil, ENV['HOME'])
+  
+  * Returns: pid of child process
+=end
+      pid_t pid = 0;
+      
+      pid = vte_terminal_fork_command(VTE_TERMINAL(_self), command, argv, envv, dir,
+          lastlog, utmp, wtmp);
+      
+      if (argv)
+        free(argv);
+      if (envv)
+        free(envv);
+      
+      return pid;
+    end
+    
+    def feed(T_STRING str)
+=begin
+  Send data to the terminal
+=end
+      vte_terminal_feed(VTE_TERMINAL(_self), RSTRING(str)->ptr, RSTRING(str)->len);
+    end
+    
+    def feed_child(T_STRING str)
+=begin
+  Send data to the child process
+=end
+      vte_terminal_feed_child(VTE_TERMINAL(_self), RSTRING(str)->ptr, RSTRING(str)->len);
+    end
+    
+    def cursor_position()
+=begin
+  Get the current cursor position
+=end
+      long arr[2];
+      vte_terminal_get_cursor_position(VTE_TERMINAL(_self), &arr[0], &arr[1]);
+      return <arr:ruby>;
+    end
+    
+    def get_padding()
+=begin
+  Get the padding the widget is using.
+=end
+      long arr[2];
+      vte_terminal_get_padding(VTE_TERMINAL(_self), (int*)&arr[0], (int*)&arr[1]);
+      return <arr:ruby>;
+    end
+    
+#################### Misc settings
+    def scrollback_lines=(long lines)
+=begin
+  Set the number of scrollback lines, above or at an internal minimum.
+=end
+      vte_terminal_set_scrollback_lines(VTE_TERMINAL(_self), lines);
+    end
+    
+    def set_size(long x, long y)
+=begin
+  Set the terminal size.
+=end
+      vte_terminal_set_size(VTE_TERMINAL(_self), x, y);
+    end
+    
+    def cursor_blinks=(bool blink)
+=begin
+  Set whether or not the cursor blinks.
+=end
+      vte_terminal_set_cursor_blinks(VTE_TERMINAL(_self), blink);
+    end
+    
+    def reset(bool full=TRUE, bool clear_history=TRUE)
+=begin
+  Reset the terminal, optionally clearing the tab stops and line history.
+=end
+      vte_terminal_reset(VTE_TERMINAL(_self), full, clear_history);
+    end
+    
+#################### Fonts
+    def bool:using_xft?()
+=begin
+  Is the terminal using Xft to render text?
+  
+  * Returns: Boolean
+=end
+      return vte_terminal_get_using_xft(VTE_TERMINAL(_self));
+    end
+    
+    def font=(VALUE font)
+=begin
+  Set the terminal font.
+  ((|font|)) is either a String or Pango::FontDescription
+=end
+      if (TYPE(font) == T_DATA)
+        vte_terminal_set_font(VTE_TERMINAL(_self), <font:fontdescription>);
+      else
+        vte_terminal_set_font_from_string(VTE_TERMINAL(_self), <font:string>);
+    end
+    
+    def fontdescription:font()
+=begin
+  Get the terminal's current font description.
+  
+  * Returns: Pango::FontDescription
+=end
+      return vte_terminal_get_font(VTE_TERMINAL(_self));
+    end
+    
+    def bool:allow_bold?()
+=begin
+  Check whether the terminal allows bold text?
+  
+  * Returns: Boolean
+=end
+      return vte_terminal_get_allow_bold(VTE_TERMINAL(_self));
+    end
+    
+    def allow_bold=(bool allow)
+=begin
+  Set whether the terminal allows bold text
+=end
+      vte_terminal_set_allow_bold(VTE_TERMINAL(_self), allow);
+    end
+    
+#################### Clipboard
+    def copy()
+=begin
+  Copy the current selection to the clipboard
+=end
+      vte_terminal_copy_clipboard(VTE_TERMINAL(_self));
+    end
+    def paste()
+=begin
+  Paste the current clipboard contents into the terminal
+=end
+      vte_terminal_paste_clipboard(VTE_TERMINAL(_self));
+    end
+    def copy_primary()
+=begin
+  Copy the current selection as the primary selection
+=end
+      vte_terminal_copy_primary(VTE_TERMINAL(_self));
+    end
+    def paste_primary()
+=begin
+  Paste the current primary selection into the terminal
+=end
+      vte_terminal_paste_primary(VTE_TERMINAL(_self));
+    end
+    def bool:has_selection?()
+=begin
+  Paste the current primary selection into the terminal
+=end
+      return vte_terminal_get_has_selection(VTE_TERMINAL(_self));
+    end
+
+#################### Mouse
+    def mouse_autohide=(bool hide)
+=begin
+  Paste the current primary selection into the terminal
+=end
+      vte_terminal_set_mouse_autohide(VTE_TERMINAL(_self), hide);
+    end
+    
+    def bool:mouse_autohide?()
+=begin
+  Paste the current primary selection into the terminal
+=end
+      return vte_terminal_get_mouse_autohide(VTE_TERMINAL(_self));
+    end
+
+#################### Matched text
+    def int:match_add(T_REGEXP text)
+=begin
+  Add a matching expression, returning the tag the widget assigns to that expression
+=end
+      return vte_terminal_match_add(VTE_TERMINAL(_self), RREGEXP(text)->str);
+    end
+    
+    def match_remove(int tag)
+=begin
+  Remove a matching expression by tag
+=end
+      vte_terminal_match_remove(VTE_TERMINAL(_self), tag);
+    end
+    def match_check(long column, long row)
+=begin
+  Check for a matched tag at a given position
+=end
+      char *text;
+      int tag;
+      
+      text = vte_terminal_match_check(VTE_TERMINAL(_self),
+			       column, row,
+			       &tag);
+      if (text)
+        return rb_ary_new3(2, <text:ruby>, <tag:ruby>);
+      else
+        return Qnil;
+    end
+
+#################### Properities
+    def gobject:adjustment()
+=begin
+  * Returns: the Gtk::Adjustment for the widget
+=end
+      return vte_terminal_get_adjustment(VTE_TERMINAL(_self));
+    end
+    def string:title()
+=begin
+  * Returns: the terminal's title
+=end
+      return vte_terminal_get_window_title(VTE_TERMINAL(_self));
+    end
+    def string:icon_title()
+=begin
+  * Returns: the terminal's icon title
+=end
+      return vte_terminal_get_icon_title(VTE_TERMINAL(_self));
+    end
+    def long:char_width()
+      return vte_terminal_get_char_width(VTE_TERMINAL(_self));
+    end
+    def long:char_height()
+      return vte_terminal_get_char_height(VTE_TERMINAL(_self));
+    end
+    def long:char_ascent()
+      return vte_terminal_get_char_ascent(VTE_TERMINAL(_self));
+    end
+    def long:char_descent()
+      return vte_terminal_get_char_descent(VTE_TERMINAL(_self));
+    end
+    def long:row_count()
+      return vte_terminal_get_row_count(VTE_TERMINAL(_self));
+    end
+    def long:column_count()
+      return vte_terminal_get_column_count(VTE_TERMINAL(_self));
+    end
+    
+################### Fancy backgrounds
+    def background_image=(T_DATA|T_STRING image)
+      if (TYPE(image)==T_STRING)
+        vte_terminal_set_background_image_file(VTE_TERMINAL(_self),
+					    StringValuePtr(image));
+      else
+        vte_terminal_set_background_image(VTE_TERMINAL(_self), <{VALUE>GdkPixbuf*:image}>);
+    end
+    alias :set_background_image :background_image=
+    
+    def set_color_background(GdkColor *color)
+        vte_terminal_set_color_background(VTE_TERMINAL(_self),
+					    color);
+    end
+    alias :background_color= :set_color_background
+    
+    def set_color_foreground(GdkColor *color)
+        vte_terminal_set_color_foreground(VTE_TERMINAL(_self),
+					    color);
+    end
+    alias :foreground_color= :set_color_foreground
+    
+    def set_background_saturation(double saturation)
+        vte_terminal_set_background_saturation(VTE_TERMINAL(_self), saturation);
+    end
+        
+  end
+end

data/lib/rubber/codegen/enum.rb

@@ -39,7 +39,7 @@ static VALUE make_enum_value(VALUE klass, int value, char *name, char *fullname)
 	
 	return Data_Wrap_Struct(klass, NULL, free, data);
 }
-static int value_to_int(VALUE value, VALUE klass)
+static int enum_value_to_int(VALUE value, VALUE klass)
 {
 	switch (TYPE(value))
 	{
@@ -160,7 +160,7 @@ __attribute__ ((unused))
       io.puts "    case #{arg}: return #{default_cname}_#{arg};"
     end    
     io.puts "}; return Qnil; }"
-    io.puts "static int enum_ruby_to_#{name}(VALUE val) { return value_to_int(val, #{cname}); }"
+    io.puts "static int enum_ruby_to_#{name}(VALUE val) { return enum_value_to_int(val, #{cname}); }"
   end
   include RegisterChildren
   def default_cname

data/lib/rubber/codegen/flags.rb

@@ -17,7 +17,7 @@ class C_Flags
     io.puts "static VALUE #{cname};"
     unless @@declared_base
     	@@declared_base = true
-    	io.puts "
+    	io.puts <<-EOHEADER
 
 static VALUE flagsBaseClass;
 
@@ -38,7 +38,7 @@ static VALUE make_flags_value(VALUE klass, int value, char *name, char *fullname
 	
 	return Data_Wrap_Struct(klass, NULL, free, data);
 }
-static int value_to_int(VALUE value, VALUE klass)
+static int flags_value_to_int(VALUE value, VALUE klass)
 {
 	switch (TYPE(value))
 	{
@@ -136,11 +136,78 @@ static VALUE rubber_flags_coerce(VALUE value, VALUE other)
 	}
 }
 
-"
+static VALUE rubber_flags_and(VALUE value, VALUE other)
+{
+	FlagsData *data = NULL;
+	int original = 0;
+	int other_num = 0;
+	
+	Data_Get_Struct(value, FlagsData, data);
+
+	original = data->value;
+
+	other_num = flags_value_to_int(value, CLASS_OF(value));
+	
+//	return INT2NUM(original & other_num);
+	return make_flags_value(CLASS_OF(value), original & other_num, "", "");
+}
+
+static VALUE rubber_flags_or(VALUE value, VALUE other)
+{
+	FlagsData *data = NULL;
+	int original = 0;
+	int other_num = 0;
+	
+	Data_Get_Struct(value, FlagsData, data);
+
+	original = data->value;
+
+	other_num = flags_value_to_int(value, CLASS_OF(value));
+	
+	return make_flags_value(CLASS_OF(value), original | other_num, "", "");
+}
+
+
+
+EOHEADER
     end
     args.each do |arg|
       io.puts "static VALUE #{default_cname}_#{arg} = Qnil;"
-    end    
+    end
+io.puts <<-EO_INSPECT
+	static VALUE rubber_#{default_cname}_flags_inspect(VALUE value)
+{
+	FlagsData *data = NULL;
+	volatile VALUE str = rb_str_new(\"#<\", 2);
+	char number[16] = ""; 
+	int c=0;
+	
+	Data_Get_Struct(value, FlagsData, data);
+	
+	rb_str_cat2(str, rb_obj_classname(value));
+	rb_str_cat2(str, " - ");
+EO_INSPECT
+	args.each do |arg|
+		uniq = arg[@strip..-1]
+		io.puts <<-EOARG 
+		if ((data->value & #{arg})==#{arg}) {
+			if (c>0)
+				rb_str_cat2(str, ", ");
+			rb_str_cat2(str, #{uniq.downcase.gsub(/_/,'-').inspect});
+			c ++;
+		}
+		EOARG
+	end
+io.puts <<-EO_INSPECT
+	rb_str_cat2(str, " (");
+	sprintf(number, "%i", data->value);
+	rb_str_cat2(str, number);
+	rb_str_cat2(str, ")>");
+	
+	return str;
+}
+EO_INSPECT
+
     io.puts "typedef int #{name};
 #ifdef __GNUC__
 // No point in declaring these unless we're using GCC
@@ -158,8 +225,10 @@ __attribute__ ((unused))
     args.each do |arg|
       io.puts "    case #{arg}: return #{default_cname}_#{arg};"
     end    
-    io.puts "}; return Qnil; }"
-    io.puts "static int flags_ruby_to_#{name}(VALUE val) { return value_to_int(val, #{cname}); }"
+    io.puts <<-EOB
+	}; return make_flags_value(#{cname}, value, "various", "Various"); }
+	static int flags_ruby_to_#{name}(VALUE val) { return flags_value_to_int(val, #{cname}); }
+	EOB
   end
   include RegisterChildren
   def default_cname
@@ -209,6 +278,8 @@ __attribute__ ((unused))
       io.puts '    rb_define_method(flagsBaseClass, "fullname", rubber_flags_to_s, 0);'
       io.puts '    rb_define_method(flagsBaseClass, "name", rubber_flags_name, 0);'
       io.puts '    rb_define_method(flagsBaseClass, "<=>", rubber_flags_cmp, 0);'
+	  io.puts '    rb_define_method(flagsBaseClass, "&", rubber_flags_and, 1);'
+	  io.puts '    rb_define_method(flagsBaseClass, "|", rubber_flags_or, 1);'
       io.puts '    '
     end
     if parent
@@ -216,6 +287,8 @@ __attribute__ ((unused))
     else
       io.puts "  #{cname} = rb_define_class(#{name.inspect}, flagsBaseClass);"
     end
+	io.puts '    rb_define_method('+cname+', "inspect", rubber_'+default_cname+'_flags_inspect, 0);'
+
     
     args.each do |arg|
       uniq = arg[@strip..-1]

data/lib/rubber/scanner.rb

@@ -234,7 +234,7 @@ def _scan(fp)
       puts "GCPool #{name}"
       stack.first.classes.push(C_GCRefPool.new(name))
       
-    elsif state.in_func == false and @str.skip(/(enum)(?= )/x) # C Enum as module wrapper
+    elsif state.in_func == false and @str.skip(/(enum|flags)(?= )/x) # C Enum as module wrapper
       what = @str[1]
       @str.skip(/\s+/)
       name = @str.scan(/[A-Z][a-z_0-9A-Z]*/)

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Geoff Youngs
@@ -25,7 +25,7 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- README.md
+- README.textile
 files: 
 - bin/rubber-generate
 - lib/rubber/autord.rb
@@ -50,7 +50,7 @@ files:
 - lib/rubber/scanner.rb
 - lib/rubber/struct.rb
 - lib/rubber/types.rb
-- README.md
+- README.textile
 has_rdoc: true
 homepage: http://github.com/geoffyoungs/rubber-generate
 licenses: []
@@ -81,5 +81,5 @@ rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Template language for generating Ruby bindings for C libraries
-test_files: []
-
+test_files: 
+- example/vte.cr

data/README.md

@@ -1,58 +0,0 @@
-Rubber C Binder v0.0.5
-Template language for generating Ruby bindings for C libraries
-by Geoff Youngs <g@intersect-uk.co.uk>
-
-Introduction
-~~~~~~~~~~~~
-A simple ruby-style bindings generator for Ruby.  It allows bindings to 
-be laid out in a Ruby style, documentation to be included inline and 
-explicit type casts within C code.  It's somewhere between SWIG and pyrex.
-
-It also allows features extconf.rb creation, including checks for headers,
-pkg-config etc.  The modules it creates currently depend on Ruby/GTK, but
-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.
-
-
-Dependencies
-~~~~~~~~~~~~
-Ruby 1.8
-  Doesn't require any modules which aren't in the Ruby 1.8.0 distribution.
-Ruby 1.6
-  Has not been tested.  Requires at least the StringScanner (C version) and
-  StringIO modules. (See raa.ruby-lang.org for 'strscan' and 'stringio')
-
-
-Example
-~~~~~~~
-Sample file:
-  vte/vte.cr
-
-Usage:
-  $ ruby rubber.rb vte.cr
-
-Which should generate
-  vte.c      <- Source code for extension
-  vte.rd     <- RD documentation from vte.cr
-  extconf.rb <- Config script
-
-Running extconf.rb should then allow installation of the extension as normal.
-
-
-Installation
-~~~~~~~~~~~~
-There is currently no installation.  Rubber will automatically look for it's
-libraries in the normal path or in the directory where the 'real' rubber script
-resides.  (So the rubber.rb can be symlinked from where you unpacked it to
-a directory in your path).
-
-When rubber matures then it will come with a proper install.rb setup.
-
-
-Credits
-~~~~~~~
-Rubber was created by Geoff Youngs
-
-Contributors: Vincent Isambart