rant 0.3.6 → 0.3.8

data/NEWS

@@ -1,6 +1,19 @@
 
 = Rant NEWS
 
+== Rant 0.3.8
+
+This version should be fully backwards compatible to 0.3.6.
+
+New features:
+* Dependency checking for C/C++ sources.
+  Read doc/c.rdoc[link:files/doc/c_rdoc.html] documentation.
+* Installing ".cmd" files on Windows with the Win32::RubyCmdWrapper.
+  Read doc/rubyproject.rdoc[link:files/doc/rubyproject_rdoc.html].
+* Convenient directory/file creation with SubFile.
+  Read doc/advanced.rdoc[link:files/doc/advanced_rdoc.html].
+* rant-import inlines specially marked, +require+ files.
+
 == Rant 0.3.6
 
 This version should be fully backwards compatible to 0.3.4.

data/README

@@ -14,6 +14,7 @@ Rant currently features:
   applications and libraries.
 * Primitive support for compiling C# sources portably with csc, cscc
   and mcs.
+* Dependency checking for C/C++ source files.
 * A _configure_ plugin for easy environment and build-parameter
   checking (but not like autoconf!) which saves data in a yaml file.
 * The <em>rant-import</em> command creates a monolithic rant script,
@@ -36,7 +37,7 @@ Running rant in the directory of this file:
 will ensure that the "data" file in the "backup" directory is up to
 date.
 
-This document was written for version 0.3.6 of Rant. Most things
+This document was written for version 0.3.8 of Rant. Most things
 described here will work for older/newer versions of Rant, but look at
 the README file in the Rant distribution you've installed for exact
 documentation of your Rant version.
@@ -67,6 +68,10 @@ Automation for your Ruby library/application::
     read doc/rubyproject.rdoc[link:files/doc/rubyproject_rdoc.html]
 Independent from Rant? The <tt>rant-import</tt> command::
     read doc/rant-import.rdoc[link:files/doc/rant-import_rdoc.html]
+Advanced Rantfiles::
+    read doc/advanced.rdoc[link:files/doc/advanced_rdoc.html]
+Compiling C/C++::
+    read doc/c.rdoc[link:files/doc/c_rdoc.html]
 Using the Configure plugin::
     read doc/configure.rdoc[link:files/doc/configure_rdoc.html]
 Compiling C#::
@@ -196,6 +201,7 @@ Rant was tested on:
     System		Ruby version
     =======================================================
     Linux		1.8.2
+			1.8.3 preview 1
 			1.9
     MacOS X		1.8.2
     Windows XP		1.8.2 (OneClick Installer)

data/Rantfile

@@ -1,7 +1,7 @@
 
 # Rantfile for Rant :)
 
-import %w(rubytest rubydoc rubypackage autoclean)
+import %w(rubytest rubydoc rubypackage autoclean win32/rubycmdwrapper)
 
 task :default => :test
 
@@ -70,7 +70,7 @@ desc "Run all tests and generate coverage with rcov."
 task :cov do
     lp = File.expand_path "lib"
     sys.cd "test" do
-	sys %W(rcov -xts_*,tc_*,test_* -I#{lp} ts_all.rb)
+	sys %W(rcov -xtutil.rb,*.t,ts_*,tc_*,test_* -I#{lp} ts_all.rb)
     end
 end
 
@@ -92,6 +92,12 @@ gen RubyTest, :timport do |t|
     t.test_files = sys["test/import/**/test_*.rb"]
 end
 
+desc "Test C support."
+gen RubyTest, :tc do |t|
+    t.libs << "test"
+    t.test_files = sys["test/c/test_*.rb", "test/import/c/**/test_*.rb"]
+end
+
 desc "Run all tests."
 gen RubyTest, :tall do |g|
     g.libs << "test"
@@ -128,22 +134,12 @@ task "to-win" => :package do
 end
 
 desc "Install Rant."
-install = task :install do
+task :install do
     sys.ruby "setup.rb"
 end
 
 if Env.on_windows?
-    cmd_files = bin_files.find_all { |f| f !~ /\.cmd$/}
-    cmd_files.map! { |f| "#{f}.cmd" }
-    cmd_files.zip(bin_files).each { |cmd, bin|
-	file cmd do |t|
-	    File.open(t.name, "w") { |f|
-		i_bin = File.join(Env::RUBY_BINDIR, File.basename(bin))
-		f.puts "@#{sys.sp Env::RUBY} #{sys.sp i_bin} %*"
-	    }
-	end
-	install << cmd
-    }
+    enhance :install => (gen Win32::RubyCmdWrapper, sys["bin/*"])
 end
 
 # vim:ft=ruby:

data/TODO

@@ -1,6 +1,9 @@
 
 = TODO
 
+== GET RID OF CLASS Rant::Path
+Done.
+
 == Packaging
 Try minitar if tar is not available.
 

data/devel-notes

@@ -3,6 +3,11 @@
 Don't use here documents in the Rant sources, imports and plugins.
 They'll get messed up by the rant-import command.
 
+== More notes on rant-import
+rant-import removes all lines matching /^\s*#/ per default. Remember
+that, I was already bitten by that one in multiline regex!
+(FileList#mk_all_rx)
+
 == Running RDoc programmatically
 require 'rdoc/rdoc'
 rdoc = RDoc::RDoc.new

data/doc/advanced.rdoc

@@ -102,6 +102,7 @@ Use the +Clean+ generator in your Rantfiles:
 
 Use the +AutoClean+ generator which will remove all files generated by
 any filetask (include those created by rules):
+
     import "autoclean"
 
     file "junk" do
@@ -114,12 +115,39 @@ any filetask (include those created by rules):
 
     desc "Cleanup generated files."
     gen AutoClean, :clean
+
     # The clean task automatically detects which files where created
     # by our rule and the junk task.
     # Additionally we can add files to remove to the variable with the
     # same name as the AutoClean taskname (here: clean):
     var[:clean].include "**/*.bak"
 
+TAKE CARE:: AutoClean will recursively remove directories for which
+	    a task exists. Meaning:
+               gen Directory, "doc/html"
+            AutoClean will recursively remove the doc directory!
+    
+The Directory generator takes an optional base directory as first
+argument. Example:
+    gen Directory, "doc", "html"
+Now Rant assumes that the "doc" directory already exists and creates
+only a task for the "doc/html" directory. If you run AutoClean now, it
+will only remove the "html" directory.
+
+The same goes for the SubFile generator:
+
+    gen SubFile, "doc/html/index.html" do |t|
+        # do something
+    end
+This creates (amongst the other two tasks) a task for the "doc"
+directory, thus AutoClean will recursively unlink the "doc" directory.
+
+    gen SubFile, "doc", "html/index.html" do |t|
+	# do something
+    end
+This doesn't create a task for the "doc" directory, thus AutoClean
+will only unlink the "doc/html" directory.
+
 === The DirectedRule generator
 
 A directed rule is some sort of special rule. It searches for source
@@ -142,6 +170,22 @@ Practically, this means that it compiles the C files in src_x/, src_y,
 Look in the doc/examples/directedrule directory of the Rant
 distribution for a small example project.
 
+=== The SubFile generator
+
+A _SubFile_ is just a shortcut for the combination of a _Directory_
+and a _file_ task.
+The following example without the SubFile generator:
+    gen Directory, "backup"
+    file "backup/data" => %w(data backup) do |t|
+        sys.cp t.source, t.name
+    end
+can be directly translated to:
+    gen SubFile, "backup/data" => "data" do |t|
+        sys.cp t.source, t.name
+    end
+The SubFile generator automatically creates all necessary directory
+tasks and adds them as prerequisites to the final file task.
+
 === Constraining variables
 
 Rant allows you to constrain variables which are managed by the +var+
@@ -239,5 +283,7 @@ rant-import.
 
 Rantfile basics::
     doc/rantfile.rdoc[link:files/doc/rantfile_rdoc.html]
+Support for C/C++::
+    doc/c.rdoc[link:files/doc/c_rdoc.html]
 Rant Overview::
     README[link:files/README.html]

data/doc/c.rdoc

@@ -0,0 +1,64 @@
+
+== Support for C/C++
+
+Rant can automatically determine the dependencies between C/C++ source
+files. Use the C::Dependencies generator:
+    
+    import "c/dependencies"
+    gen C::Dependencies
+
+This generates a task called "c_dependencies" which will scan all
+C/C++ source files in the current directory and all subdirectories for
+#include statements and write the dependencies to the file
+"c_dependencies". It searches for include files in the current
+directory.
+
+If you want to specify which directories it should search for include
+files, give the +search+ option:
+    gen C::Dependencies, :search => %w(. include)
+Rant will search for include files in the current and in the "include"
+directory now.
+
+If you want to create the dependencies only for a specific set of
+source files or for source files with non-standard filename
+extensions, give a list with the +sources+ option:
+    gen C::Dependencies, :sources => sys["**/*.cxx"]
+This task will create the dependencies for all files ending in ".cxx".
+
+Of course you can combine this options and you can give another
+task/filename as first argument:
+    gen C::Dependencies, "depend.rf"
+	:search => "include",
+	:sources => sys["**/*.cxx"]
+This creates a file task with the name "depend.rf".
+
+Note that all our previous examples only created a filetask with the
+dependencies, to use them you have to load them in your Rantfile. So
+you probably want to call the +source+ command:
+
+    gen C::Dependencies
+
+    # invoke task "c_dependencies" and load the created file
+    source "c_dependencies"
+
+And a good habit would be to wrap the +source+ expression in an
++Action+ block:
+
+    gen C::Dependencies
+
+    # Do dependency checking only if at least one task will be
+    # invoked.
+    gen Action do source "c_dependencies" end
+
+For a little example project using the C::Dependency generator look
+into the doc/examples/c_dependencies[link:../examples/c_dependencies]
+directory of the Rant distribution.
+
+== See also
+
+Rantfile basics::
+    doc/rantfile.rdoc[link:files/doc/rantfile_rdoc.html]
+Advanced Rantfiles::
+    doc/advanced.rdoc[link:files/doc/advanced_rdoc.html]
+Rant Overview::
+    README[link:files/README.html]

data/doc/examples/c_dependencies/Rantfile

@@ -0,0 +1,27 @@
+
+import %w(c/dependencies clean autoclean)
+
+desc "Compile hello world program."
+file "hello" => %w(src/main.o src/util.o) do |t|
+    sys "cc -Wall -o #{t.name} #{t.prerequisites.arglist}"
+end
+
+gen Rule, :o => :c do |t|
+    sys "cc -Wall -c -Iinclude -o #{t.name} #{t.source}"
+end
+
+# Similar to the "makedepend" program:
+# Create dependencies between C/C++ source/header files by parsing them
+# for #include statements. The dependencies will be written to a file
+# called "c_dependencies".
+gen C::Dependencies, :search => "include"
+# Automatically make and load the dependency file before invoking any
+# task.
+gen Action do source "c_dependencies" end
+
+desc "Remove C compiler products."
+gen Clean
+var[:clean].include "**/*.o", "hello"
+
+desc "Remove all generated files."
+gen AutoClean, :distclean

data/doc/examples/c_dependencies/include/hello.h

@@ -0,0 +1,7 @@
+
+#ifndef HELLO_H
+#define HELLO_H
+
+#define RECEIVER "world"
+
+#endif

data/doc/examples/c_dependencies/include/util.h

@@ -0,0 +1,7 @@
+
+#ifndef UTIL_H
+#define UTIL_H
+
+void println(char* msg);
+
+#endif

data/doc/examples/c_dependencies/src/main.c

@@ -0,0 +1,9 @@
+
+#include "util.h"
+#include "hello.h"
+
+int main(int argc, char** argv)
+{
+    println("Hello, " RECEIVER "!");
+    return 0;
+}

data/doc/examples/c_dependencies/src/util.c

@@ -0,0 +1,9 @@
+
+#include "util.h"
+#include <stdio.h>
+
+void println(char* msg)
+{
+    printf(msg);
+    printf("\n");
+}

data/doc/examples/directedrule/Rantfile

@@ -9,7 +9,6 @@ end
 gen Directory, "obj"
 
 ro = gen DirectedRule, "obj" => sys["src_*"], :o => :c do |t|
-    rac.build "obj"
     sys "cc -c -o #{t.name} #{t.source}"
 end
 

data/doc/rantfile.rdoc

@@ -42,7 +42,7 @@ methods with the Rant application:
 Just call the +task+ function and give it a task name as argument. The
 task name may be a string or symbol:
     task :taskname
-That's it, your first task. Not very usefull, because it doesn't do
+That's it, your first task. Not very useful, because it doesn't do
 anything. To associate an action with the task, add a block:
     task :mytask do
 	puts "Hello, mytask running."
@@ -305,16 +305,19 @@ last dot with the given string.
 
 The +import+ function lets you import additional generators.
 Currently the following are coming with Rant:
-+Clean+::	Remove selected files.
-+AutoClean+::	Remove all files generated by any file task (including
+Clean::		Remove selected files.
+AutoClean::	Remove all files generated by any file task (including
 		those generated by rules).
-+DirectedRule+:: A Rule which takes sources from one or more
-		 directories and puts generated files into a specified
-		 directory.
-+RubyTest+::	Run Test::Unit tests for your Ruby code.
-+RubyDoc+::	Run RDoc.
-+RubyPackage+::	Generate tar, zip and gem packages of your Ruby
+DirectedRule::	A Rule which takes sources from one or more
+		directories and puts generated files into a specified
+		directory.
+SubFile::	Create file task and necessary directory tasks.
+RubyTest::	Run Test::Unit tests for your Ruby code.
+RubyDoc::	Run RDoc.
+RubyPackage::	Generate tar, zip and gem packages of your Ruby
 		application/library.
+Win32::RubyCmdWrapper:: Create .cmd wrapper scripts for installation
+			of Ruby scripts on Windows.
 
 Read doc/advanced.rdoc[link:files/doc/advanced_rdoc.html] and
 doc/rubyproject.rdoc[link:files/doc/rubyproject_rdoc.html] for

data/doc/rubyproject.rdoc

@@ -202,6 +202,32 @@ task is run. If you want to see one, set the verbose attribute to
 +true+:
 	t.verbose = true
 
+=== Installation
+
+Since we get a RubyGem from the RubyPackage generator, our package is
+ready for distribution and installation. But probably you also want to
+provide a "normal" zip/tar archive. In this case you can use a
+conventional install.rb or setup.rb script for installation.
+
+If we install the "wgrep" script on Windows, it won't run out of the
+box, because Windows doesn't know that it has to run it with the Ruby
+interpreter. This problem can be solved with Rant. Add the following
+lines to your Rantfile:
+    
+    import "win32/rubycmdwrapper"
+
+    desc "Install wgrep."
+    task :install do
+	# Run setup.rb with the Ruby interpreter.
+	sys.ruby "setup.rb"
+    end
+
+    if Env.on_windows?
+	# Create .cmd files for all scripts in the bin/ directory and
+	# make the install task dependent on them.
+	enhance :install => (gen Win32::RubyCmdWrapper, sys["bin/*"])
+    end
+
 == See also
 
 Rant Overview::

data/lib/rant/c/include.rb

@@ -0,0 +1,51 @@
+
+# include.rb - Support for C - parsing #include statements.
+#
+# Copyright (C) 2005 Stefan Lang <langstefan@gmx.at>
+
+module Rant end
+module Rant::C
+    module Include
+	# Searches for all `#include' statements in the C/C++ source
+	# from the string +src+.
+	#
+	# Returns two arguments:
+	# 1. A list of all standard library includes (e.g. #include <stdio.h>).
+	# 2. A list of all local includes (e.g. #include "stdio.h").
+	def parse_includes(src)
+	    if src.respond_to? :to_str
+		src = src.to_str
+	    else
+		raise ArgumentError, "src has to be a string"
+	    end
+	    s_includes = []
+	    l_includes = []
+	    in_block_comment = false
+	    prev_line = nil
+	    src.each { |line|
+		line.chomp!
+		if prev_line
+		    line = prev_line << line
+		    prev_line = nil
+		end
+		if line =~ /\\$/
+		    prev_line = line.chomp[0...line.length-1]
+		end
+		if in_block_comment
+		    in_block_comment = false if line =~ %r|\*/|
+		    next
+		end
+		case line
+		when /\s*#\s*include\s+"([^"]+)"/
+		    l_includes << $1
+		when /\s*#\s*include\s+<([^>]+)>/
+		    s_includes << $1
+		when %r|(?!//)[^/]*/\*|
+		    in_block_comment = true
+		end
+	    }
+	    [s_includes, l_includes]
+	end
+	module_function :parse_includes
+    end # module Include
+end # module Rant::C

data/lib/rant/import/autoclean.rb

@@ -22,15 +22,13 @@ class Rant::Generators::AutoClean
 	# create task
 	rac.task :__caller__ => ch, tname => [] do |t|
 	    rac.tasks.each { |n, worker|
-		worker.each_target { |entry|
-		    if test ?e, entry
-			if test ?f, entry
-			    rac.cx.sys.rm_f entry
-			else
-			    rac.cx.sys.rm_rf entry
-			end
-		    end
-		}
+		if Array === worker
+		    worker.each { |subw|
+			subw.each_target { |entry| clean rac, entry }
+		    }
+		else
+		    worker.each_target { |entry| clean rac, entry }
+		end
 	    }
 	    target_rx = nil
 	    rac.resolve_hooks.each { |hook|
@@ -62,4 +60,13 @@ class Rant::Generators::AutoClean
 	    end
 	end
     end
+    def self.clean(rac, entry)
+	if test ?e, entry
+	    if test ?f, entry
+		rac.cx.sys.rm_f entry
+	    else
+		rac.cx.sys.rm_rf entry
+	    end
+	end
+    end
 end

data/lib/rant/import/c/dependencies.rb

@@ -0,0 +1,127 @@
+
+# dependencies.rb - C::Dependencies generator for Rant.
+#
+# Copyright (C) 2005 Stefan Lang <langstefan@gmx.at>
+
+require 'rant/rantlib'
+require 'rant/c/include'
+
+module Rant::Generators::C end
+class Rant::Generators::C::Dependencies
+    def self.rant_generate(rac, ch, args, &block)
+	c_files, out_fn, include_pathes, opts = nil
+	# args validation
+	if block
+	    rac.warn_msg "C::Dependencies: ignoring block"
+	end
+	case args.size
+	when 0 # noop
+	when 1
+	    farg = args.first
+	    Hash === farg ? (opts = farg) : (out_fn = farg)
+	when 2
+	    out_fn = args.first
+	    opts = args[1]
+	else
+	    rac.abort_at(ch,
+		"C::Dependencies takes one or two arguments.")
+	end
+	if opts
+	    if opts.respond_to? :to_hash
+		opts = opts.to_hash
+	    else
+		rac.abort_at(ch,
+		    "C::Dependencies: second argument has to be a hash.")
+	    end
+	    opts.each { |k, v|
+		case k
+		when :sources
+		    c_files = v
+		when :search, :search_pathes, :include_pathes
+		    include_pathes = 
+		    if v.respond_to? :to_str
+			[v.to_str]
+		    else
+			v
+		    end
+		else
+		    rac.abort_at(ch,
+			"C::Dependencies: no such option -- #{k}")
+		end
+	    }
+	end
+	out_fn ||= "c_dependencies"
+	c_files ||= rac.cx.sys["**/*.{c,cpp,cc,h,hpp}"]
+	include_pathes ||= ["."]
+	if out_fn.respond_to? :to_str
+	    out_fn = out_fn.to_str
+	else
+	    rac.abort_at(ch, "filename has to be a string")
+	end
+	unless ::Rant::FileList === c_files
+	    if c_files.respond_to? :to_ary
+		c_files = c_files.to_ary
+	    else
+		rac.abort_at(ch, "sources has to be a list of files")
+	    end
+	end
+	unless ::Rant::FileList === include_pathes
+	    if include_pathes.respond_to? :to_ary
+		include_patehs = include_pathes.to_ary
+	    else
+		rac.abort_at(ch,
+		    "search has to be a list of directories")
+	    end
+	end
+	# define file task
+	rac.cx.file({:__caller__ => ch, out_fn => c_files}) do |t|
+	    tmp_rac = ::Rant::RantApp.new
+	    depfile_ts = Time.at(0)
+	    if File.exist? t.name
+		tmp_rac.source(t.name)
+		depfile_ts = File.mtime(t.name)
+	    end
+	    rf_str = ""
+	    c_files.each { |cf|
+		f_task = nil
+		unless test(?f, cf)
+		    rac.warn_msg "#{t.name}: no such file -- #{cf}"
+		    next
+		end
+		f_task = tmp_rac.tasks[cf.to_str]
+		deps = f_task ? f_task.prerequisites : nil
+		if !deps or File.mtime(cf) > depfile_ts
+		    rac.cmd_msg "parsing #{cf}"
+		    std_includes, local_includes = 
+			::Rant::C::Include.parse_includes(File.read(cf))
+		    deps = []
+		    (std_includes + local_includes).each { |fn|
+			path = existing_file(include_pathes, fn)
+			deps << path if path
+		    }
+		end
+		rf_str << file_deps(cf, deps) << "\n"
+	    }
+	    rac.msg 1, "writing C source dependencies to #{t.name}"
+	    open(t.name, "w") { |f|
+		f.puts
+		f.puts "# #{t.name}"
+		f.puts "# C source dependencies generated by Rant #{Rant::VERSION}"
+		f.puts "# WARNING: Modifications to this file will get lost!"
+		f.puts
+		f.write rf_str
+	    }
+	end
+    end
+    def self.existing_file(dirs, fn)
+	dirs.each { |dir|
+	    path = dir == "." ? fn : File.join(dir, fn)
+	    return path if test ?f, path
+	}
+	nil
+    end
+    def self.file_deps(target, deps)
+	s = "gen SourceNode, #{target.to_str.inspect} => "
+	s << "[#{ deps.map{ |fn| fn.to_str.inspect }.join(', ')}]"
+    end
+end # class Rant::Generators::C::Dependencies

data/lib/rant/import/directedrule.rb

@@ -67,7 +67,7 @@ class Rant::Generators::DirectedRule
 	@target_dir = target_dir
 	# target should be a string (file extension)
 	@target = target.sub(/^\./, '')
-	@target_rx = /#{Regexp.escape(target)}$/o
+	@target_rx = /#{Regexp.escape(target)}$/
 	# source should be a string (file extension)
 	@source = source.sub(/^\./, '')
 	@esc_target_dir = Regexp.escape(target_dir)
@@ -77,8 +77,8 @@ class Rant::Generators::DirectedRule
 	self[name]
     end
     def [](name)
-	#puts "rule for #{name} ?"
-	if name =~ /^#@esc_target_dir\//o && name =~ @target_rx
+	#puts "rule (#@target) for #{name} ?"
+	if name =~ /^#@esc_target_dir\// && name =~ @target_rx
 	    #puts "  matches"
 	    fn = File.basename(name)
 	    src_fn = fn.sub_ext(@source)
@@ -90,7 +90,11 @@ class Rant::Generators::DirectedRule
 		(src = path) && break if test(?e, path)
 	    }
 	    if src
-		[@rac.file(:__caller__ => @ch, name => src, &@block)]
+		# pre 0.3.7
+		#[@rac.file(:__caller__ => @ch, name => src, &@block)]
+		[@rac.prepare_task({name => src}, @block, @ch) { |name,pre,blk|
+		    ::Rant::AutoSubFileTask.new(@rac, name, pre, &blk)
+		}]
 	    else
 		nil
 	    end

data/lib/rant/import/rubypackage.rb

@@ -57,7 +57,8 @@ class Rant::Generators::RubyPackage
     PACKAGE_ATTRS = PACKAGE_SINGLE_ATTRS + PACKAGE_TO_LIST_ATTRS
 
     EXPLICIT_GEM_MAPPING = {
-	"executable" => "executables"
+	"executable" => "executables",
+	"requires" => "requirements",
 	# add requires => requirements ?
     }