rubu 0.0.2 → 0.0.3

data/doc/Rubu/Var.html

@@ -220,12 +220,12 @@
       <pre class="lines">
 
 
-432
-433
-434</pre>
+438
+439
+440</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 432</span>
+      <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 438</span>
 
 <span class='kw'>def</span> <span class='const'>Var</span><span class='period'>.</span><span class='op'>[]</span><span class='lparen'>(</span> <span class='id identifier rubyid_key'>key</span> <span class='rparen'>)</span>
     <span class='cvar'>@@var</span><span class='lbracket'>[</span> <span class='id identifier rubyid_key'>key</span> <span class='rbracket'>]</span>
@@ -261,12 +261,12 @@
       <pre class="lines">
 
 
-427
-428
-429</pre>
+433
+434
+435</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 427</span>
+      <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 433</span>
 
 <span class='kw'>def</span> <span class='const'>Var</span><span class='period'>.</span><span class='op'>[]=</span><span class='lparen'>(</span> <span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_val'>val</span> <span class='rparen'>)</span>
     <span class='cvar'>@@var</span><span class='lbracket'>[</span> <span class='id identifier rubyid_key'>key</span> <span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_val'>val</span>
@@ -281,7 +281,7 @@
 </div>
 
     <div id="footer">
-  Generated on Sun Jul  1 17:48:17 2018 by
+  Generated on Sun Jul  8 19:50:19 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.3).
 </div>

data/doc/Rubu/Walk.html

@@ -175,7 +175,7 @@
 </div>
 
     <div id="footer">
-  Generated on Sun Jul  1 17:48:17 2018 by
+  Generated on Sun Jul  8 19:50:20 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.3).
 </div>

data/doc/_index.html

@@ -296,7 +296,7 @@
 </div>
 
     <div id="footer">
-  Generated on Sun Jul  1 17:48:17 2018 by
+  Generated on Sun Jul  8 19:50:19 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.3).
 </div>

data/doc/file.CHANGELOG.html

@@ -63,7 +63,10 @@
 
     <div id="content"><div id='filecontents'>
 <h1 id="label-Version+history">Version history</h1>
-<dl class="rdoc-list label-list"><dt>0.0.2
+<dl class="rdoc-list label-list"><dt>0.0.3
+<dd>
+<p>Force update option. Auto-update example.</p>
+</dd><dt>0.0.2
 <dd>
 <p>Documentation updates. Some name changes to Rubu classes.</p>
 </dd><dt>0.0.1
@@ -73,7 +76,7 @@
 </div></div>
 
     <div id="footer">
-  Generated on Sun Jul  1 17:48:17 2018 by
+  Generated on Sun Jul  8 19:50:19 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.3).
 </div>

data/doc/file.README.html

@@ -118,6 +118,31 @@ script. File generation is part of the build program.</p>
 
 <p>There are comments which highlight purpose of the build program content.</p>
 
+<p>Sometimes it is useful to run <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> automatically whenever a file changes.
+Linux provides a facility called <strong>inotify</strong>, which can be
+used in Ruby through “rb-inotify” gem. Automatic update example program is
+in:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_example'>example</span><span class='op'>/</span><span class='id identifier rubyid_up'>up</span><span class='op'>-</span><span class='id identifier rubyid_to'>to</span><span class='op'>-</span><span class='id identifier rubyid_date'>date</span>
+</code></pre>
+
+<p>This program runs <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> each time there is a change in “src” or in “bin”
+directory. It compiles and generates C files if necessary. If there are new
+compilation requirements coming, before all previous have been completed,
+it will continue compilation. When all compilations are done (i.e. none
+pending), it will call <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> to perform linking. “up-to-date” displays
+status messages in red and green on the screen. If it is started with “-v”
+option the compile commands are visible, and if it is started with “-d”
+option, there is extra delay in compilation command.</p>
+
+<pre class="code ruby"><code class="ruby">cd example
+up-to-date -v -d</code></pre>
+
+<p>This is useful if you want to play around with the pending compilation
+processes when new changes are coming in. You can make (dummy) changes to
+“hello_world.c” (for example), and follow the updates in the terminal where
+you started “up-to-date”.</p>
+
 <h2 id="label-Concepts">Concepts</h2>
 
 <p><span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> Build Program, RBP, is a Ruby program that uses the <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> library.
@@ -371,7 +396,7 @@ refer to the source, i.e. the only existing source, you can use the
 </div></div>
 
     <div id="footer">
-  Generated on Sun Jul  1 17:48:17 2018 by
+  Generated on Sun Jul  8 19:50:19 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.3).
 </div>

data/doc/index.html

@@ -118,6 +118,31 @@ script. File generation is part of the build program.</p>
 
 <p>There are comments which highlight purpose of the build program content.</p>
 
+<p>Sometimes it is useful to run <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> automatically whenever a file changes.
+Linux provides a facility called <strong>inotify</strong>, which can be
+used in Ruby through “rb-inotify” gem. Automatic update example program is
+in:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_example'>example</span><span class='op'>/</span><span class='id identifier rubyid_up'>up</span><span class='op'>-</span><span class='id identifier rubyid_to'>to</span><span class='op'>-</span><span class='id identifier rubyid_date'>date</span>
+</code></pre>
+
+<p>This program runs <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> each time there is a change in “src” or in “bin”
+directory. It compiles and generates C files if necessary. If there are new
+compilation requirements coming, before all previous have been completed,
+it will continue compilation. When all compilations are done (i.e. none
+pending), it will call <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> to perform linking. “up-to-date” displays
+status messages in red and green on the screen. If it is started with “-v”
+option the compile commands are visible, and if it is started with “-d”
+option, there is extra delay in compilation command.</p>
+
+<pre class="code ruby"><code class="ruby">cd example
+up-to-date -v -d</code></pre>
+
+<p>This is useful if you want to play around with the pending compilation
+processes when new changes are coming in. You can make (dummy) changes to
+“hello_world.c” (for example), and follow the updates in the terminal where
+you started “up-to-date”.</p>
+
 <h2 id="label-Concepts">Concepts</h2>
 
 <p><span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> Build Program, RBP, is a Ruby program that uses the <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> library.
@@ -371,7 +396,7 @@ refer to the source, i.e. the only existing source, you can use the
 </div></div>
 
     <div id="footer">
-  Generated on Sun Jul  1 17:48:17 2018 by
+  Generated on Sun Jul  8 19:50:19 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.3).
 </div>

data/doc/top-level-namespace.html

@@ -105,7 +105,7 @@
 </div>
 
     <div id="footer">
-  Generated on Sun Jul  1 17:48:17 2018 by
+  Generated on Sun Jul  8 19:50:19 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.3).
 </div>

data/example/bin/gen_world

@@ -1,6 +1,10 @@
 #!/usr/bin/env ruby
 
-IO.write( 'build/world.c', "\
+unless Dir.exist? 'gen_cee'
+    Dir.mkdir 'gen_cee'
+end
+
+IO.write( 'gen_cee/world.c', "\
 #include <stdio.h>
 
 void print_world( void )

data/example/bin/rubu_example

@@ -24,6 +24,7 @@ Spec.command( 'rubu_example', 'Tero Isannainen', '2018',
 # Set trail related options.
 Var[ :bin_dir ]    = 'bin'
 Var[ :source_dir ] = 'src'
+Var[ :gen_dir ]    = 'gen_cee'
 Var[ :build_dir ]  = 'build'
 Var[ :exe_name ]   = 'build/hello'
 
@@ -35,6 +36,11 @@ if Opt['verbose'].given
     Order[ :verbose ] = true
 end
 
+# Force serial execution.
+if Opt[ 'serial' ].given
+    Order[ :serial ] = true
+end
+
 # Read setup files and apply Como command line arguments to Var space.
 Trail.setup( :como => 'conf' )
 
@@ -44,7 +50,7 @@ Trail.setup( :como => 'conf' )
 
 # Generator file and the target.
 gen_file      = Mark.path( "#{Var[:bin_dir]}/gen_world" )
-gen_cee_file  = Mark.path( "#{Var[:build_dir]}/world.c" )
+gen_cee_file  = Mark.path( "#{Var[:gen_dir]}/world.c" )
 
 # Collect "normal" C files.
 cee_files     = Mark.glob( "#{Var[:source_dir]}/*.c" )
@@ -74,6 +80,13 @@ class GenWorld < Step
     end
 end
 
+# Code generator with generated file content dependency.
+class GenGreenWorld < StepMark
+    def step
+        shrun "bin/gen_world"
+    end
+end
+
 
 # Typical C compilation with GCC, from source to object.
 class GccCompileFile < StepAged
@@ -135,6 +148,12 @@ Walk.form 'gen-cee' do
     GenWorld.use( gen_file, gen_cee_file )
 end
 
+# Serial trail for code generation (with filtered updates).
+Walk.form 'gen-cee-green' do
+    # Create GenGreenWorld build and register it to 'gen-cee-green'.
+    GenGreenWorld.use( gen_file, gen_cee_file )
+end
+
 # Parallel compilation of all C files.
 Fork.form 'compile-cee' do
     # Create set of GCC builds by joining 'all_cee_files' and
@@ -142,6 +161,11 @@ Fork.form 'compile-cee' do
     GccCompileFile.usezip( all_cee_files, obj_files )
 end
 
+# Link executable.
+Walk.form 'link' do
+    GccLinkExe.use( obj_files, exe_file )
+end
+
 # Default trail, i.e. generate, compile, link to executable.
 Walk.form 'default' do
     # Reference 'gen-cee' trail.
@@ -149,7 +173,15 @@ Walk.form 'default' do
     # Reference 'compile-cee' trail.
     pick 'compile-cee'
     # Create GCC link build and register it.
-    GccLinkExe.use( obj_files, exe_file )
+    pick 'link'
+end
+
+# Trail for 'up-to-date' script (see: example dir).
+Walk.form 'up-to-date' do
+    # Reference 'gen-cee-green' trail.
+    pick 'gen-cee-green'
+    # Reference 'compile-cee' trail.
+    pick 'compile-cee'
 end
 
 # Cleaner trail.
@@ -169,8 +201,4 @@ else
     trails = [ 'default' ]
 end
 
-if Opt[ 'serial' ].given
-    Order[ :serial ] = true
-end
-
 Trail.run( trails )

data/example/up-to-date

@@ -0,0 +1,127 @@
+#!/usr/bin/env ruby
+
+require 'como'
+include Como
+require 'rb-inotify'
+
+Spec.command( 'up-to-date', 'Tero Isannainen', '2018',
+    [
+        [ :switch, 'demo',    '-d', "Demo mode (with slow compile)." ],
+        [ :switch, 'verbose', '-v', "Verbose rubu." ],
+    ] )
+
+# Locks for sync.
+@lock = Mutex.new
+@comp = ConditionVariable.new
+@link = ConditionVariable.new
+
+# Number of pending compiles.
+@comps = 0
+
+ths = []
+
+
+NOC   = "\e[0m"
+RED   = "\e[31m"
+GREEN = "\e[32m"
+
+
+def start_comp
+    puts RED + "PENDING..." + NOC
+    @lock.synchronize do
+        @comps += 1
+        @comp.signal
+    end
+end
+
+
+# Check file changes.
+th = Thread.new do
+    notify = INotify::Notifier.new
+
+    notify.watch( "./src", :modify ) do |event|
+        start_comp
+    end
+
+    notify.watch( "./bin", :modify ) do |event|
+        start_comp
+    end
+
+    notify.run
+end
+ths.push th
+
+
+# Compile files.
+do_comp = false
+th = Thread.new do
+
+    loop do
+
+        @lock.synchronize do
+            @comp.wait( @lock )
+        end
+
+        loop do
+
+            # Check for complation need.
+            @lock.synchronize do
+                if @comps >= 1
+                    do_comp = true
+                else
+                    do_comp = false
+                end
+            end
+
+            # Compline and signal linking if no pending compiles left.
+            if do_comp
+
+                verbose = ''
+                if Opt['verbose'].given
+                    verbose = ' -v'
+                end
+
+                cmd = "bin/rubu_example #{verbose} up-to-date"
+
+                if Opt['demo'].given
+                    cmd += "; sleep 3"
+                end
+
+                system cmd
+
+                @lock.synchronize do
+                    @comps -= 1
+                    if @comps == 0
+                        @link.signal
+                    end
+                end
+            else
+                break
+            end
+
+        end
+    end
+end
+ths.push th
+
+
+# Link files.
+th = Thread.new do
+    loop do
+        @lock.synchronize do
+            @link.wait( @lock )
+
+            verbose = ''
+            if Opt['verbose'].given
+                verbose = ' -v'
+            end
+
+            system "bin/rubu_example #{verbose} link"
+
+            puts GREEN + "READY!" + NOC
+        end
+    end
+end
+ths.push th
+
+ths.each{|i| i.join}

data/lib/rubu.rb

@@ -389,6 +389,12 @@ module Rubu
 
 
     # Configuration space for Rubu.
+    #
+    # Options:
+    # * serial   - Force parallel executions to serial.
+    # * parmax   - Limit the number of parallel executions.
+    # * verbose  - Show command executions.
+    # * force    - Force Step updates.
     class Order
 
         @@order = {}
@@ -573,6 +579,7 @@ module Rubu
         def mark_update?
 
             unless date_update?
+                target.skip = true
                 return false
             end
 
@@ -667,7 +674,7 @@ module Rubu
     class StepAged < Step
         # Update if Step source is newer than target.
         def update?
-            date_update?
+            Order[ :force ] || date_update?
         end
     end
 
@@ -675,9 +682,9 @@ module Rubu
     # Mark (checksum) based Step.
     class StepMark < Step
         # Update if target generated from Step source is different
-        # from old target.
+        # from old target in addition of being newer.
         def update?
-            mark_update?
+            Order[ :force ] || mark_update?
         end
     end