synthemesc-impulse 0.0.3 → 0.0.4

data/LICENSE

@@ -3,6 +3,9 @@ Please see your CoDeveloper license for more information. The license below
 is only applicable to the Impulse Ruby gem. Please do not contact Impulse
 Accelerated Technologies with questions regarding support for this gem.
 
+Project#to_makefile is derived from the icProj2make.pl script included with
+the CoDeveloper distribution. See lib/project.rb for additional license details.
+
 ----------------------------------------------------------------------------
 
 Impulse Ruby gem Copyright (c) 2009 Joshua Eckstein.

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/impulse.gemspec

@@ -2,12 +2,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{impulse}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joshua Eckstein"]
-  s.date = %q{2009-06-23}
-  s.email = %q{josh@agentcomputer.com}
+  s.date = %q{2009-07-11}
+  s.email = %q{josh@eksdyne.com}
   s.extra_rdoc_files = [
     "LICENSE",
      "README.rdoc"
@@ -19,19 +19,24 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
-     "ext/.gitignore",
-     "ext/extconf.rb",
-     "ext/impulse_ext.c",
-     "ext/impulse_ext.h",
-     "ext/stream.c",
      "impulse.gemspec",
      "lib/app.rb",
+     "lib/ext/.gitignore",
+     "lib/ext/arch.c",
+     "lib/ext/extconf.rb",
+     "lib/ext/fixnum.c",
+     "lib/ext/impulse_ext.c",
+     "lib/ext/impulse_ext.h",
+     "lib/ext/log.c",
+     "lib/ext/stream.c",
      "lib/impulse.rb",
      "lib/project.rb",
      "lib/ruby_to_impulse.rb",
      "lib/stream.rb",
-     "lib/template.rb"
+     "lib/template.rb",
+     "test/ext_test.rb"
   ]
+  s.has_rdoc = true
   s.homepage = %q{http://github.com/synthemesc/impulse}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
@@ -40,6 +45,9 @@ Gem::Specification.new do |s|
   s.summary = %q{Ruby tools for the Impulse platform}
 
   s.add_dependency "facets"
+  s.test_files = [
+    "test/ext_test.rb"
+  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/lib/ext/.gitignore

@@ -0,0 +1,5 @@
+*.o
+*.so
+*.bundle
+Makefile
+mkmf.log

data/lib/ext/arch.c

@@ -0,0 +1,57 @@
+#include <ruby.h>
+#include <string.h>
+
+#include "impulse_ext.h"
+
+static VALUE
+co_architecture_rb_alloc(self)
+  VALUE self;
+{
+  co_architecture arch;
+  return Data_Wrap_Struct(self, 0, 0, arch); /* No mark/free */
+}
+
+/* No-op for now */
+void t_configure(void *arg)
+{
+  rb_need_block();
+  rb_cvar_set(cLog, id_cLog_initialized, (cosim_logwindow_init() != 0 ? Qtrue : Qfalse)
+  #ifdef RB_CVAR_SET_4ARGS
+    , 0
+  #endif
+  );
+  rb_yield(rb_block_proc());
+  return;
+}
+
+/* co_initialize is required to do anything. Ref'd in t_architecture_init */
+co_architecture co_initialize(void *args)
+{
+  return(co_architecture_create("rb_arch","generic_vhdl",t_configure,(void *)args));
+}
+
+/* Set up the co_architecture object and initialize */
+static VALUE
+t_architecture_init(self)
+  VALUE self;        /* the object */
+{
+  DATA_PTR(self) = (co_architecture) co_initialize((void *)self);
+  return (self);
+}
+
+static VALUE
+t_architecture_execute(self)
+  VALUE self;        /* the object */
+{
+  co_execute(DATA_PTR(self));
+  return (Qtrue);
+}
+
+void Init_arch()
+{
+  cArchitecture = rb_define_class_under(mImpulse, "Architecture", rb_cObject);
+
+  rb_define_alloc_func(cArchitecture, co_architecture_rb_alloc);
+  rb_define_method(cArchitecture, "initialize", t_architecture_init, 0);
+  rb_define_method(cArchitecture, "execute", t_architecture_execute, 0);
+}

data/lib/ext/extconf.rb

@@ -0,0 +1,21 @@
+require 'mkmf'
+
+ImpulseC = ENV["IMPULSEC_HOME"] || File.join(%w(usr Impulse CoDeveloper3))
+
+lib_path = File.join(ImpulseC, "Libraries")
+inc_path = File.join(ImpulseC, "Include")
+
+if (have_header("co.h") ||
+    find_header("co.h", inc_path)) &&
+   (have_header("cosim_log.h") ||
+    find_header("cosim_log.h", inc_path)) &&
+   (have_library("ImpulseC", "co_stream_open") ||
+    find_library("ImpulseC", "co_stream_open", lib_path)) then
+  create_makefile("impulse_ext")
+else
+STDERR.puts <<-EOS
+  Couldn't find the ImpulseC headers or library. Are you sure you have
+  them installed either in $IMPULSEC_HOME ('#{ENV["IMPULSEC_HOME"]}') or
+  the standard system locations (e.g., /usr/include, /usr/lib, etc.)?
+EOS
+end

data/lib/ext/fixnum.c

@@ -0,0 +1,73 @@
+#include <ruby.h>
+#include "impulse_ext.h"
+
+static ID id_beg, id_end;
+
+/* co_bit_extract is duck-equivalent to Ruby's slice methods.
+ * Keep in mind we don't implement fix_bit_extract_u because
+ * it's not exactly Ruby idiom-esque to make a distinction.
+ * Maybe some other time.
+ */
+
+static VALUE
+fix_bit_extract(self, index)
+  VALUE self;
+  VALUE index;
+{
+  VALUE b, e;
+
+  /* Check that it's a range */
+  if (!rb_obj_is_kind_of(index, rb_cRange))
+    return(rb_super());
+
+  b = rb_ivar_get(index, id_beg);
+  e = rb_ivar_get(index, id_end);
+
+  if (FIXNUM_P(b) && FIXNUM_P(e))
+  {
+    return INT2FIX(co_bit_extract((int32) FIX2INT(self),
+                                  (uint8) FIX2UINT(b),
+                                  (uint8) FIX2UINT(e) - FIX2UINT(b)));
+  }
+  else
+    return(rb_super());
+}
+
+static VALUE
+fix_bit_insert(self, index, from)
+  VALUE self;
+  VALUE index;
+  VALUE from;
+{
+  VALUE b, e;
+
+  if (!rb_obj_is_kind_of(index, rb_cRange))
+  {
+    rb_raise(rb_eTypeError, "Range required");
+    return (INT2FIX(0));
+  }
+
+  b = rb_ivar_get(index, id_beg);
+  e = rb_ivar_get(index, id_end);
+
+  /* If it's not a range of numbers, well, it's 0 */
+  if (!FIXNUM_P(b) || !FIXNUM_P(e))
+    return(INT2FIX(0));
+
+  self = INT2FIX(co_bit_insert((int32) FIX2INT(self),
+                               (uint8) FIX2UINT(b),
+                               (uint8) FIX2INT(e) - FIX2INT(b),
+                               (int32) FIX2INT(from)));
+
+  return (self);
+}
+
+void
+Init_fixnum_ext()
+{
+  rb_define_method(rb_cFixnum, "[]",  fix_bit_extract, 1);
+  rb_define_method(rb_cFixnum, "[]=", fix_bit_insert,  2);
+
+  id_beg = rb_intern("begin");
+  id_end = rb_intern("end");
+}

data/lib/ext/impulse_ext.c

@@ -0,0 +1,39 @@
+#include <ruby.h>
+#include "impulse_ext.h"
+
+static VALUE
+t_impulse_simulation(self)
+  VALUE self;  /* the object */
+{
+  IF_SIM(return (Qtrue));
+  return (Qfalse);
+}
+
+void Init_impulse_ext()
+{
+  /* Impulse module */
+  mImpulse = rb_define_module("Impulse");
+
+  /* Base classes, probably placeholders for now */
+  cArchitecture = rb_define_class_under(mImpulse, "Architecture", rb_cObject);
+  cLog = rb_define_class_under(mImpulse, "Log", rb_cObject);
+  cMemory = rb_define_class_under(mImpulse, "Memory", rb_cObject);
+  cProcess = rb_define_class_under(mImpulse, "Process", rb_cObject);
+  cRegister = rb_define_class_under(mImpulse, "Register", rb_cObject);
+  cSignal = rb_define_class_under(mImpulse, "Signal", rb_cObject);
+
+  rb_define_method(cArchitecture, "sim?", t_impulse_simulation, 0);
+  rb_define_method(cLog, "sim?", t_impulse_simulation, 0);
+  rb_define_method(cMemory, "sim?", t_impulse_simulation, 0);
+  rb_define_method(cProcess, "sim?", t_impulse_simulation, 0);
+  rb_define_method(cRegister, "sim?", t_impulse_simulation, 0);
+  rb_define_method(cSignal, "sim?", t_impulse_simulation, 0);
+
+  /* Impulse::Stream */
+  Init_stream();
+  Init_arch();
+  Init_fixnum_ext();
+  Init_log();
+
+  return;
+}

data/{ext → lib/ext}/impulse_ext.h

@@ -1,6 +1,10 @@
 #ifndef IMPULSE_EXT_H
 #define IMPULSE_EXT_H
 
+#ifdef WIN32
+#include <windows.h>
+#endif
+
 #include <ruby.h>
 
 #include "co.h"
@@ -10,7 +14,7 @@
 VALUE mImpulse;
 
 /* Classes */
-VALUE cArch;
+VALUE cArchitecture;
 VALUE cLog;
 VALUE cMemory;
 VALUE cProcess;
@@ -18,8 +22,13 @@ VALUE cRegister;
 VALUE cSignal;
 VALUE cStream;
 
+ID id_cLog_initialized;
+
 /* Init prototypes */
 void Init_impulse_ext();
 void Init_stream();
+void Init_architecture();
+void Init_fixnum_ext();
+void Init_log();
 
-#endif
+#endif

data/lib/ext/log.c

@@ -0,0 +1,87 @@
+#include <ruby.h>
+#include <string.h>
+
+#include "impulse_ext.h"
+
+static ID id_name;
+
+/*
+ * Marks a co_log object for the Ruby garbage collector.
+ * Currently a no-op.
+ */
+static void
+cosim_logwindow_rb_mark(log)
+  cosim_logwindow log;
+{
+  return;
+}
+
+/*
+ * Frees the actual cosim_logwindow object.
+ * Currently a no-op.
+ */
+static void
+cosim_logwindow_rb_free(log)
+  cosim_logwindow log;
+{
+  return;
+}
+
+static VALUE
+cosim_logwindow_rb_alloc(self)
+  VALUE self;
+{
+  cosim_logwindow log;
+  return Data_Wrap_Struct(self, cosim_logwindow_rb_mark, cosim_logwindow_rb_free, log);
+}
+
+static VALUE
+t_log_init(self, name)
+  VALUE self;  /* the object */
+  VALUE name;  /* unique name */
+{
+  DATA_PTR(self) = cosim_logwindow_create(RSTRING(name)->ptr);
+  rb_ivar_set(self, id_name,  name);
+  return (self);
+}
+
+static VALUE
+t_log_puts(self, message)
+  VALUE self;     /* the object */
+  VALUE message;  /* log message */
+{
+  if (!RTEST(rb_cvar_get(cLog, id_cLog_initialized)))
+  {
+    rb_warn("Can't do anything with the simulation log until you create an Architecture.");
+    return (Qnil);
+  }
+  
+  /* TODO: Some actual type checking here would be nice. */
+  if (cosim_logwindow_write(DATA_PTR(self), RSTRING(message)->ptr) != 0)
+    return (self);
+  else
+  {
+    rb_raise(rb_eArgError, "Couldn't write to %s.", RSTRING(rb_ivar_get(self, id_name))->ptr);
+    return (self);
+  }
+}
+
+/*
+static VALUE
+t_log_printf(self, ...)
+*/
+
+void Init_log()
+{
+  cLog = rb_define_class_under(mImpulse, "Log", rb_cObject);
+  rb_cvar_set(cLog, id_cLog_initialized, Qfalse
+  #ifdef RB_CVAR_SET_4ARGS
+    , 0
+  #endif
+  );
+
+  rb_define_alloc_func(cLog, cosim_logwindow_rb_alloc);
+  rb_define_method(cLog, "initialize", t_log_init, 1);
+  rb_define_method(cLog, "puts", t_log_puts, 1);
+  rb_define_method(cLog, "<<", t_log_puts, 1);
+}

data/{ext → lib/ext}/stream.c

@@ -3,6 +3,8 @@
 
 #include "impulse_ext.h"
 
+static ID id_name, id_mode, id_width, id_depth;
+
 /*
  * Marks a co_stream object for the Ruby garbage collector.
  * Currently a no-op.
@@ -45,10 +47,12 @@ t_stream_init(self, name, mode, width, depth)
 
   /* 'r' is read only mode */
   if (!strncmp(RSTRING(mode)->ptr, "r", 1)) {
+    /* TODO: Check for errors/success here */
     co_stream_open(DATA_PTR(self), O_RDONLY, INT_TYPE(FIX2INT(width)));
 
   /* 'w' is write only mode */
   } else if (!strncmp(RSTRING(mode)->ptr, "w", 1)) {
+    /* TODO: Check for errors/success here */
     co_stream_open(DATA_PTR(self), O_WRONLY, INT_TYPE(FIX2INT(width)));
 
   /* there is no other mode these can have. */
@@ -57,13 +61,26 @@ t_stream_init(self, name, mode, width, depth)
     return Qnil;
   }
 
+  rb_ivar_set(self, id_name,  name);
+  rb_ivar_set(self, id_mode,  mode);
+  rb_ivar_set(self, id_width, width);
+  rb_ivar_set(self, id_depth, depth);
+
   return (self);
 }
 
+static VALUE
+t_stream_eos(self)
+  VALUE self;
+{
+  return (co_stream_eos(DATA_PTR(self)) != 0 ? Qtrue : Qfalse);
+}
+
 void Init_stream()
 {
   cStream = rb_define_class_under(mImpulse, "Stream", rb_cObject);
 
   rb_define_alloc_func(cStream, co_stream_rb_alloc);
   rb_define_method(cStream, "initialize", t_stream_init, 4);
-}
+  rb_define_method(cStream, "eos?", t_stream_eos, 0);
+}

data/lib/impulse.rb

@@ -1,3 +1,5 @@
-require "project"
-require "template"
-require "app"
+root = File.dirname(__FILE__)
+require File.join(root, "project")
+require File.join(root, "template")
+#require File.join(root, "app")
+require File.join(root, "ext", "impulse_ext")

data/lib/project.rb

@@ -1,5 +1,5 @@
 require "rubygems"
-require "facets"
+gem "facets"
 
 module Impulse
   # A CoDeveloper project is a simple plaintext file with an <em>.icProj</em>
@@ -22,7 +22,7 @@ module Impulse
       @options = Hash.new
 
       skipped_lines_header = false
-      File.open(project_file).each_with_index do |line, line_number|
+      File.open(project_file.to_s).each_with_index do |line, line_number|
         next unless line.match ValidOptionLine
         print("Skipping lines: ") unless skipped_lines_header
         skipped_lines_header = true
@@ -98,5 +98,20 @@ module Impulse
         end
       end
     end
+
+    #--
+    # From the original icProj2Make.pl file:
+    #
+    # Copyright(c) 2006-2009 Impulse Accelerated Technologies, Inc.
+    # All rights reserved.
+    # www.ImpulseAccelerated.com
+    #
+    # This source file may be used and distributed without restriction provided
+    # that this copyright notice is not removed from the file and that any
+    # derivative work contains this copyright notice.
+    #++
+    def to_makefile
+      raise(ArgumentError, "Generated Makefiles require the IMPULSEC_HOME environment variable.") unless ENV["IMPULSEC_HOME"]
+    end
   end
 end

data/test/ext_test.rb

@@ -0,0 +1,21 @@
+require File.join(File.dirname(__FILE__), "..", "lib", "ext", "impulse_ext")
+
+require "test/unit"
+require "rubygems"
+gem "thoughtbot-shoulda"
+require "shoulda"
+
+class ExtTest < Test::Unit::TestCase
+  context "The C extension" do
+    should "set up classes" do
+      assert_kind_of(Module, Impulse)
+      assert_kind_of(Class, Impulse::Stream)
+      assert_kind_of(Class, Impulse::Architecture)
+      assert_kind_of(Class, Impulse::Log)
+      assert_kind_of(Class, Impulse::Memory)
+      assert_kind_of(Class, Impulse::Process)
+      assert_kind_of(Class, Impulse::Register)
+      assert_kind_of(Class, Impulse::Signal)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: synthemesc-impulse
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Joshua Eckstein
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-23 00:00:00 -07:00
+date: 2009-07-11 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -23,7 +23,7 @@ dependencies:
         version: "0"
     version: 
 description: 
-email: josh@agentcomputer.com
+email: josh@eksdyne.com
 executables: []
 
 extensions: []
@@ -38,19 +38,23 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
-- ext/.gitignore
-- ext/extconf.rb
-- ext/impulse_ext.c
-- ext/impulse_ext.h
-- ext/stream.c
 - impulse.gemspec
 - lib/app.rb
+- lib/ext/.gitignore
+- lib/ext/arch.c
+- lib/ext/extconf.rb
+- lib/ext/fixnum.c
+- lib/ext/impulse_ext.c
+- lib/ext/impulse_ext.h
+- lib/ext/log.c
+- lib/ext/stream.c
 - lib/impulse.rb
 - lib/project.rb
 - lib/ruby_to_impulse.rb
 - lib/stream.rb
 - lib/template.rb
-has_rdoc: false
+- test/ext_test.rb
+has_rdoc: true
 homepage: http://github.com/synthemesc/impulse
 post_install_message: 
 rdoc_options: 
@@ -76,5 +80,5 @@ rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
 summary: Ruby tools for the Impulse platform
-test_files: []
-
+test_files: 
+- test/ext_test.rb

data/ext/.gitignore

@@ -1 +0,0 @@
-mkmf.log

data/ext/extconf.rb

@@ -1,12 +0,0 @@
-require 'mkmf'
-
-ImpulseC = ENV["IMPULSEC_HOME"] || File.join(%w(usr Impulse CoDeveloper3))
-
-lib_path = File.join(ImpulseC, "Libraries")
-inc_path = File.join(ImpulseC, "Include")
-
-((have_header("co.h") || find_header("co.h", inc_path)) &&
-  have_header("cosim_log.h") || find_header("cosim_log.h", inc_path) &&
-  have_library("ImpulseC") || find_library("ImpulseC", nil, lib_path)) || exit
-
-create_makefile("impulse_ext")

data/ext/impulse_ext.c

@@ -1,21 +0,0 @@
-#include <ruby.h>
-#include "impulse_ext.h"
-
-void Init_impulse_ext()
-{
-  /* Impulse module */
-  mImpulse = rb_define_module("Impulse");
-
-  /* Base classes, probably placeholders for now */
-  cArch = rb_define_class_under(mImpulse, "Architecture", rb_cObject);
-  cLog = rb_define_class_under(mImpulse, "Log", rb_cObject);
-  cMemory = rb_define_class_under(mImpulse, "Memory", rb_cObject);
-  cProcess = rb_define_class_under(mImpulse, "Process", rb_cObject);
-  cRegister = rb_define_class_under(mImpulse, "Register", rb_cObject);
-  cSignal = rb_define_class_under(mImpulse, "Signal", rb_cObject);
-
-  /* Impulse::Stream */
-  Init_stream();
-
-  return;
-}