mucgly 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d438186a60f6f48bf2b68fd7090f7cc3e375cca3
-  data.tar.gz: 69d49907c80a1faee873a275f228090f48d930e0
+  metadata.gz: 1dfea2d4d0a44528b05456bbd1704cbbd449a232
+  data.tar.gz: e663a7a7e3815a9dc63b9564730ae738b51a9e87
 SHA512:
-  metadata.gz: 04b142e789d684fc49819c5289070fcd324cebb199c6a732301279b3b40938356902152d4d2dad2ad171becb8b290305ac0bb70c2fe51ed616141bf125bbcea7
-  data.tar.gz: 96a4e3c1271542ccd0e4174ef450f1e0344ac39121c66ca5784ba65bfbe116e5fa9b73f2037f1874a10ebedb3715b79e95356146f942530671b5a2f4e6a7f204
+  metadata.gz: 18654eba88520a6ffed3f834a28916caa5e17df680e4f90b359794f34e199d162d11fdeb25cccf337cf5be3ff8431fa364254fcbf9dac20e76b82be8b4a32b17
+  data.tar.gz: 013cd857f5d0c5003d86cc2d2f82ea42dea9642ec0c3f2b8a05277b0f3ce974e05e586b1ee5cf542d8c8ab42c514661ba65c2c3ad1773ebc558e63f3094c1417

data/CHANGELOG.rdoc

@@ -1,5 +1,9 @@
 = Version history
 
+[0.1.1] Documentation updates.
+        Tiny code cleanups.
+        Better test coverage for Mugcly module.
+
 [0.1.0] C-based implementation.
         100 times faster than older versions.
         Multiple command line interface and internal cmd changes.

data/README.rdoc

@@ -3,8 +3,9 @@
 == Introduction
 
 Mucgly is a macro expander for inline macros that exist in the middle
-of body text. The macros are expected to be mostly regular Ruby code,
-but a few special commands are also available.
+of body text. Mucgly is useful for code generation and all kinds of
+templating systems. The macros are expected to be mostly regular Ruby
+code, but a few special commands are also available.
 
 A very simple example:
   Adding 1 + 3 results to: -<.1+3>-
@@ -19,7 +20,7 @@ syntax and the rest is pure Ruby code. The special character (command)
 "." is used to print the Ruby code evaluation value to current output
 file (stream).
 
-Sample session to execute the example above:
+Sample session to execute the above example interactively:
   shell> mucgly
   Adding 1 + 3 results to: -<.1+3>-
   Adding 1 + 3 results to: 4
@@ -27,7 +28,8 @@ Sample session to execute the example above:
   shell>
 
 
-Ruby code is always executed in the Ruby interpreters "<main>" scope.
+Ruby code is always executed in the Ruby interpreters "<main>" scope,
+i.e. Execution Environment.
 
 Previous example with multiple macros:
   -<@a = 1>--<@b = 3>-\
@@ -44,7 +46,14 @@ The macro on the second line refers to settings from previous
 macros. Instance variables has to be used to share data between macro
 calls (due to "<main>" evaluation). Local variables are not persistent
 enough. Mucgly module method, "Mucgly.write", is used to write out the
-calculation result. Mucgly module is defined within Mucgly utility.
+calculation result. Mucgly module is part of Mucgly.
+
+Typically Mucgly is executed in batch mode, e.g:
+   mucgly -f foo.rx.txt -f bar.rx.txt -g .rx
+
+For all command line options, see:
+   mucgly -h
+
 
 
 == Features
@@ -79,6 +88,8 @@ calculation result. Mucgly module is defined within Mucgly utility.
 
 * Document formatting.
 
+* Template generation.
+
 * Etc.
 
 
@@ -128,8 +139,8 @@ default hook values can be used for nested macros (if desired).
 == Special commands
 
 In addition to regular Ruby code the macros are allowed to include so
-called Special Commands. These commands start with the ":" characters
-or with ".".
+called Special Commands. These commands start with ":" or with "."
+character.
 
 
 === Named commands
@@ -137,17 +148,17 @@ or with ".".
 Example for named command:
   ...
   -<:hook [ ]>-\
- ...
+  ...
 
-Would change the hookbeg and hookend to "[" and "]" respectively. Note
-that hooks are changed only for the current input file. If for example
-an included input file changes hooks, the includer file still uses the
-original hooks.
+This example would change the hookbeg and hookend to "[" and "]"
+respectively. Note that hooks are changed only for the current input
+file. If an included input file changes hooks, the includer file still
+uses the original hooks.
 
-One special command is allowed per macro and it can't be mixed normal
-Ruby code. Command name is separated by ":" in the beginning and by
-space (" ") in the end. The rest of the macro is taken as argument to
-the command.
+One special command is allowed per macro and it can't be mixed with
+normal Ruby code. Command name is separated by ":" in the beginning
+and by space (" ") in the end. The rest of the macro is taken as
+argument to the command.
 
 List of ":" style special commands:
 
@@ -194,10 +205,11 @@ is same as ":comment ".
 === Multipass
 
 If the macro starts with "#" character, the macro is not excuted. The
-macro content is output with "#" removed from the output, including
-the current macro hooks. If 3 passes are needed, then "##" can be
-placed to the initial macro file. Multipass macro files are processes
-by (shell) piping the output of Mucgly to another Mucgly process.
+macro content is output with one "#" removed from the output,
+surrounded with the current macro hooks. If 3 passes are needed, then
+"##" can be placed to the initial macro file. Multipass macro files
+are processes by (shell) piping the output of one Mucgly process to
+another.
 
 Multipass can be used for example to create a Table Of Contents. First
 pass collects information about document content and second pass will

data/doc/Mucgly.html

@@ -92,7 +92,7 @@
         <dt id="VERSION-constant" class="">VERSION =
           
         </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.1.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.1.1</span><span class='tstring_end'>&quot;</span></span></pre></dd>
       
     </dl>
   
@@ -177,7 +177,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Feb 27 16:43:23 2015 by
+  Generated on Sun Apr  5 20:11:53 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.2).
 </div>

data/doc/_index.html

@@ -104,7 +104,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Feb 27 16:43:23 2015 by
+  Generated on Sun Apr  5 20:11:53 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.2).
 </div>

data/doc/file.CHANGELOG.html

@@ -63,7 +63,11 @@
 
     <div id="content"><div id='filecontents'>
 <h1 id="label-Version+history">Version history</h1>
-<dl class="rdoc-list label-list"><dt>0.1.0
+<dl class="rdoc-list label-list"><dt>0.1.1
+<dd>
+<p>Documentation updates. Tiny code cleanups. Better test coverage for Mugcly
+module.</p>
+</dd><dt>0.1.0
 <dd>
 <p>C-based implementation. 100 times faster than older versions. Multiple
 command line interface and internal cmd changes. Not fully backwards
@@ -81,7 +85,7 @@ compatible with older versions.</p>
 </div></div>
 
     <div id="footer">
-  Generated on Fri Feb 27 16:43:23 2015 by
+  Generated on Sun Apr  5 20:11:53 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.2).
 </div>

data/doc/file.README.html

@@ -67,8 +67,9 @@
 <h2 id="label-Introduction">Introduction</h2>
 
 <p>Mucgly is a macro expander for inline macros that exist in the middle of
-body text. The macros are expected to be mostly regular Ruby code, but a
-few special commands are also available.</p>
+body text. Mucgly is useful for code generation and all kinds of templating
+systems. The macros are expected to be mostly regular Ruby code, but a few
+special commands are also available.</p>
 
 <p>A very simple example:</p>
 
@@ -84,7 +85,7 @@ is mostly regular Ruby code. The first character is special syntax and the
 rest is pure Ruby code. The special character (command) “.” is used to
 print the Ruby code evaluation value to current output file (stream).</p>
 
-<p>Sample session to execute the example above:</p>
+<p>Sample session to execute the above example interactively:</p>
 
 <pre class="code ruby"><code class="ruby">shell&gt; mucgly
 Adding 1 + 3 results to: -&lt;.1+3&gt;-
@@ -92,7 +93,8 @@ Adding 1 + 3 results to: 4
 &lt;Ctrl-D&gt;
 shell&gt;</code></pre>
 
-<p>Ruby code is always executed in the Ruby interpreters “&lt;main&gt;” scope.</p>
+<p>Ruby code is always executed in the Ruby interpreters “&lt;main&gt;” scope,
+i.e. Execution Environment.</p>
 
 <p>Previous example with multiple macros:</p>
 
@@ -110,7 +112,15 @@ the first line outputs nothing.</p>
 Instance variables has to be used to share data between macro calls (due to
 “&lt;main&gt;” evaluation). Local variables are not persistent enough.
 Mucgly module method, “Mucgly.write”, is used to write out the calculation
-result. Mucgly module is defined within Mucgly utility.</p>
+result. Mucgly module is part of Mucgly.</p>
+
+<p>Typically Mucgly is executed in batch mode, e.g:</p>
+
+<pre class="code ruby"><code class="ruby">mucgly -f foo.rx.txt -f bar.rx.txt -g .rx</code></pre>
+
+<p>For all command line options, see:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_mucgly'>mucgly</span> <span class='op'>-</span><span class='id identifier rubyid_h'>h</span></code></pre>
 
 <h2 id="label-Features">Features</h2>
 <ul><li>
@@ -143,6 +153,8 @@ command line.</p>
 </li><li>
 <p>Document formatting.</p>
 </li><li>
+<p>Template generation.</p>
+</li><li>
 <p>Etc.</p>
 </li></ul>
 
@@ -189,25 +201,25 @@ be used for nested macros (if desired).</p>
 <h2 id="label-Special+commands">Special commands</h2>
 
 <p>In addition to regular Ruby code the macros are allowed to include so
-called Special Commands. These commands start with the “:” characters or
-with “.”.</p>
+called Special Commands. These commands start with “:” or with “.”
+character.</p>
 
 <h3 id="label-Named+commands">Named commands</h3>
 
 <p>Example for named command:</p>
 
-<pre class="code ruby"><code class="ruby"> ...
- -&lt;:hook [ ]&gt;-\
+<pre class="code ruby"><code class="ruby">...
+-&lt;:hook [ ]&gt;-\
 ...</code></pre>
 
-<p>Would change the hookbeg and hookend to “[” and “]” respectively. Note that
-hooks are changed only for the current input file. If for example an
-included input file changes hooks, the includer file still uses the
+<p>This example would change the hookbeg and hookend to “[” and “]”
+respectively. Note that hooks are changed only for the current input file.
+If an included input file changes hooks, the includer file still uses the
 original hooks.</p>
 
-<p>One special command is allowed per macro and it can&#39;t be mixed normal
-Ruby code. Command name is separated by “:” in the beginning and by space
-(“ ”) in the end. The rest of the macro is taken as argument to the
+<p>One special command is allowed per macro and it can&#39;t be mixed with
+normal Ruby code. Command name is separated by “:” in the beginning and by
+space (“ ”) in the end. The rest of the macro is taken as argument to the
 command.</p>
 
 <p>List of “:” style special commands:</p>
@@ -263,10 +275,10 @@ same as “:comment ”.</p>
 <h3 id="label-Multipass">Multipass</h3>
 
 <p>If the macro starts with “#” character, the macro is not excuted. The macro
-content is output with “#” removed from the output, including the current
-macro hooks. If 3 passes are needed, then “##” can be placed to the initial
-macro file. Multipass macro files are processes by (shell) piping the
-output of Mucgly to another Mucgly process.</p>
+content is output with one “#” removed from the output, surrounded with the
+current macro hooks. If 3 passes are needed, then “##” can be placed to the
+initial macro file. Multipass macro files are processes by (shell) piping
+the output of one Mucgly process to another.</p>
 
 <p>Multipass can be used for example to create a Table Of Contents. First pass
 collects information about document content and second pass will insert the
@@ -404,7 +416,7 @@ GEM executable (i.e. same command line options).</p>
 </div></div>
 
     <div id="footer">
-  Generated on Fri Feb 27 16:43:23 2015 by
+  Generated on Sun Apr  5 20:11:53 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.2).
 </div>

data/doc/index.html

@@ -67,8 +67,9 @@
 <h2 id="label-Introduction">Introduction</h2>
 
 <p>Mucgly is a macro expander for inline macros that exist in the middle of
-body text. The macros are expected to be mostly regular Ruby code, but a
-few special commands are also available.</p>
+body text. Mucgly is useful for code generation and all kinds of templating
+systems. The macros are expected to be mostly regular Ruby code, but a few
+special commands are also available.</p>
 
 <p>A very simple example:</p>
 
@@ -84,7 +85,7 @@ is mostly regular Ruby code. The first character is special syntax and the
 rest is pure Ruby code. The special character (command) “.” is used to
 print the Ruby code evaluation value to current output file (stream).</p>
 
-<p>Sample session to execute the example above:</p>
+<p>Sample session to execute the above example interactively:</p>
 
 <pre class="code ruby"><code class="ruby">shell&gt; mucgly
 Adding 1 + 3 results to: -&lt;.1+3&gt;-
@@ -92,7 +93,8 @@ Adding 1 + 3 results to: 4
 &lt;Ctrl-D&gt;
 shell&gt;</code></pre>
 
-<p>Ruby code is always executed in the Ruby interpreters “&lt;main&gt;” scope.</p>
+<p>Ruby code is always executed in the Ruby interpreters “&lt;main&gt;” scope,
+i.e. Execution Environment.</p>
 
 <p>Previous example with multiple macros:</p>
 
@@ -110,7 +112,15 @@ the first line outputs nothing.</p>
 Instance variables has to be used to share data between macro calls (due to
 “&lt;main&gt;” evaluation). Local variables are not persistent enough.
 Mucgly module method, “Mucgly.write”, is used to write out the calculation
-result. Mucgly module is defined within Mucgly utility.</p>
+result. Mucgly module is part of Mucgly.</p>
+
+<p>Typically Mucgly is executed in batch mode, e.g:</p>
+
+<pre class="code ruby"><code class="ruby">mucgly -f foo.rx.txt -f bar.rx.txt -g .rx</code></pre>
+
+<p>For all command line options, see:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_mucgly'>mucgly</span> <span class='op'>-</span><span class='id identifier rubyid_h'>h</span></code></pre>
 
 <h2 id="label-Features">Features</h2>
 <ul><li>
@@ -143,6 +153,8 @@ command line.</p>
 </li><li>
 <p>Document formatting.</p>
 </li><li>
+<p>Template generation.</p>
+</li><li>
 <p>Etc.</p>
 </li></ul>
 
@@ -189,25 +201,25 @@ be used for nested macros (if desired).</p>
 <h2 id="label-Special+commands">Special commands</h2>
 
 <p>In addition to regular Ruby code the macros are allowed to include so
-called Special Commands. These commands start with the “:” characters or
-with “.”.</p>
+called Special Commands. These commands start with “:” or with “.”
+character.</p>
 
 <h3 id="label-Named+commands">Named commands</h3>
 
 <p>Example for named command:</p>
 
-<pre class="code ruby"><code class="ruby"> ...
- -&lt;:hook [ ]&gt;-\
+<pre class="code ruby"><code class="ruby">...
+-&lt;:hook [ ]&gt;-\
 ...</code></pre>
 
-<p>Would change the hookbeg and hookend to “[” and “]” respectively. Note that
-hooks are changed only for the current input file. If for example an
-included input file changes hooks, the includer file still uses the
+<p>This example would change the hookbeg and hookend to “[” and “]”
+respectively. Note that hooks are changed only for the current input file.
+If an included input file changes hooks, the includer file still uses the
 original hooks.</p>
 
-<p>One special command is allowed per macro and it can&#39;t be mixed normal
-Ruby code. Command name is separated by “:” in the beginning and by space
-(“ ”) in the end. The rest of the macro is taken as argument to the
+<p>One special command is allowed per macro and it can&#39;t be mixed with
+normal Ruby code. Command name is separated by “:” in the beginning and by
+space (“ ”) in the end. The rest of the macro is taken as argument to the
 command.</p>
 
 <p>List of “:” style special commands:</p>
@@ -263,10 +275,10 @@ same as “:comment ”.</p>
 <h3 id="label-Multipass">Multipass</h3>
 
 <p>If the macro starts with “#” character, the macro is not excuted. The macro
-content is output with “#” removed from the output, including the current
-macro hooks. If 3 passes are needed, then “##” can be placed to the initial
-macro file. Multipass macro files are processes by (shell) piping the
-output of Mucgly to another Mucgly process.</p>
+content is output with one “#” removed from the output, surrounded with the
+current macro hooks. If 3 passes are needed, then “##” can be placed to the
+initial macro file. Multipass macro files are processes by (shell) piping
+the output of one Mucgly process to another.</p>
 
 <p>Multipass can be used for example to create a Table Of Contents. First pass
 collects information about document content and second pass will insert the
@@ -404,7 +416,7 @@ GEM executable (i.e. same command line options).</p>
 </div></div>
 
     <div id="footer">
-  Generated on Fri Feb 27 16:43:23 2015 by
+  Generated on Sun Apr  5 20:11:53 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.2).
 </div>

data/doc/top-level-namespace.html

@@ -103,7 +103,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Feb 27 16:43:23 2015 by
+  Generated on Sun Apr  5 20:11:53 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.2).
 </div>

data/ext/mucgly/mucgly.c

@@ -21,7 +21,7 @@ void mucgly_main( int argc, char** argv );
 /* Enable the define is input char based debugging is required. Set
    GDB breakpoint at mucgly_debug. */
 void mucgly_debug( void ) {}
-#if 1
+#if 0
 # define DEBUG_CHAR '~'
 #endif
 
@@ -38,8 +38,8 @@ void mucgly_debug( void ) {}
  * parsing.
  *
  * Pstate contains Filestack. Filestack is a stack of input files. The
- * input file stack grows when the "lower" level files performs
- * include command.
+ * input file stack grows when the "lower" level files perform
+ * include commands.
  *
  * Filestack contains Stackfiles. Stackfile presents the read status
  * of an input file. It contains character position information for
@@ -65,7 +65,7 @@ void mucgly_debug( void ) {}
 struct stackfile_s {
 
   gchar* filename;  /**< Filename. */
-  FILE* fh;         /**< Stream handle. */
+  FILE* fh;         /**< IO stream handle. */
   GString* buf;     /**< Put-back buffer (oldest-is-last). */
 
   int lineno;       /**< Line number (0->). */
@@ -137,7 +137,7 @@ struct pstate_s {
 
   GList* output;      /**< Stack of output streams. */
 
-  gboolean flush;
+  gboolean flush;     /**< Flush out-stream immediately. */
 };
 typedef struct pstate_s pstate_t;
 
@@ -149,9 +149,11 @@ typedef enum hook_e { hook_none, hook_end, hook_beg, hook_esc } hook_t;
 /** Current filestack from pstate_t (for convenience). */
 #define ps_has_file(ps)  ((stackfile_t*)(ps)->fs->file)
 
+
 /** Current stackfile from pstate_t (for convenience). */
 #define ps_topfile(ps)   ((stackfile_t*)(ps)->fs->file->data)
 
+
 /** Current stackfile from filestack_t (for convenience). */
 #define fs_topfile(fs) ((stackfile_t*)(fs)->file->data)
 
@@ -185,7 +187,7 @@ void sf_set_hook( stackfile_t* sf, hook_t hook, char* value );
  * ------------------------------------------------------------ */
 
 
-/** 
+/**
  * Compare two strings upto length of str1.
  * 
  * @param str1 String 1.
@@ -204,8 +206,8 @@ int len_str_cmp( char* str1, char* str2 )
 }
 
 
-/** 
- * Common utility function to output user info messages.
+/**
+ * Common routine for user info message output.
  * 
  * @param sf Currently processed file (or NULL).
  * @param infotype Severity type.
@@ -251,7 +253,7 @@ void mucgly_user_info( stackfile_t* sf, char* infotype, char* format, va_list ap
 }
 
 
-/** 
+/**
  * Report warning to user (no exit).
  * 
  * @param sf Current input file.
@@ -266,7 +268,7 @@ void mucgly_warn( stackfile_t* sf, char* format, ... )
 }
 
 
-/** 
+/**
  * Report error to user (and exit).
  * 
  * @param sf Current input file.
@@ -282,7 +284,7 @@ void mucgly_error( stackfile_t* sf, char* format, ... )
 }
 
 
-/** 
+/**
  * Report fatal error to user (and exit).
  * 
  * @param sf Current input file.
@@ -298,7 +300,7 @@ void mucgly_fatal( stackfile_t* sf, char* format, ... )
 }
 
 
-/** 
+/**
  * Create new Stackfile.
  * 
  * @param filename Filename (NULL for stdin).
@@ -369,7 +371,7 @@ stackfile_t* sf_new( gchar* filename, stackfile_t* inherit )
 }
 
 
-/** 
+/**
  * Store macro start info.
  * 
  * @param sf Stackfile.
@@ -382,7 +384,7 @@ void sf_mark_macro( stackfile_t* sf )
 }
 
 
-/** 
+/**
  * Reset macro start info.
  * 
  * @param sf Stackfile.
@@ -393,7 +395,7 @@ void sf_unmark_macro( stackfile_t* sf )
 }
 
 
-/** 
+/**
  * Free Stackfile and close the file stream.
  * 
  * @param sf Stackfile.
@@ -417,7 +419,7 @@ void sf_rem( stackfile_t* sf )
 }
 
 
-/** 
+/**
  * Get char from Stackfile.
  * 
  * @param sf Stackfile.
@@ -477,7 +479,7 @@ int sf_get( stackfile_t* sf )
 }
 
 
-/** 
+/**
  * Put char back to Stackfile.
  * 
  * @param sf Stackfile.
@@ -505,7 +507,7 @@ gboolean sf_put( stackfile_t* sf, char c )
 }
 
 
-/** 
+/**
  * Set hook value.
  * 
  * @param sf Stackfile.
@@ -545,7 +547,7 @@ void sf_set_hook( stackfile_t* sf, hook_t hook, char* value )
 }
 
 
-/** 
+/**
  * Create new Filestack.
  * 
  * @return Filestack.
@@ -560,7 +562,7 @@ filestack_t* fs_new( void )
 }
 
 
-/** 
+/**
  * Free Filestack and close all Stackfiles.
  * 
  * @param fs Filestack.
@@ -583,7 +585,7 @@ filestack_t* fs_rem( filestack_t* fs )
 }
 
 
-/** 
+/**
  * Push file on top of Filestack.
  * 
  * @param fs Filestack.
@@ -608,7 +610,7 @@ void fs_push_file( filestack_t* fs, gchar* filename )
 }
 
 
-/** 
+/**
  * Pop file from top of Filestack. File is closed.
  * 
  * @param fs Filestack.
@@ -629,7 +631,7 @@ void fs_pop_file( filestack_t* fs )
 }
 
 
-/** 
+/**
  * Get char from (through) Filestack (i.e. top file).
  * 
  * @param fs Filestack.
@@ -662,7 +664,7 @@ int fs_get( filestack_t* fs )
 }
 
 
-/** 
+/**
  * Put back char.
  * 
  * @param fs Filestack.
@@ -677,7 +679,7 @@ gboolean fs_put( filestack_t* fs, char c )
 }
 
 
-/** 
+/**
  * Get n chars from Filestack. If ret is non-null, use that for
  * storage.
  * 
@@ -727,7 +729,7 @@ GString* fs_get_n( filestack_t* fs, int n, GString* ret )
 }
 
 
-/** 
+/**
  * Put chars in str back to Filestack. If n is 0, then use strlen to
  * get the count.
  * 
@@ -753,7 +755,7 @@ gboolean fs_put_n( filestack_t* fs, gchar* str, int n )
 }
 
 
-/** 
+/**
  * Create new Outfile. If filename is NULL, then stream is stdout.
  * 
  * @param filename File name (or NULL for stdout).
@@ -800,7 +802,7 @@ outfile_t* outfile_new( gchar* filename )
 }
 
 
-/** 
+/**
  * Free Outfile and close output stream if non-stdout.
  * 
  * @param of Outfile.
@@ -815,7 +817,7 @@ void outfile_rem( outfile_t* of )
 }
 
 
-/** 
+/**
  * Create Pstate. Create input file stack and output file
  * stack. Initialize parsing state.
  * 
@@ -850,7 +852,7 @@ pstate_t* ps_new( gchar* outfile )
 }
 
 
-/** 
+/**
  * Free Pstate. Close all input and output files.
  * 
  * @param ps Pstate.
@@ -871,7 +873,7 @@ void ps_rem( pstate_t* ps )
 }
 
 
-/** 
+/**
  * Fast check for current input char being first char of any of the
  * hooks.
  * 
@@ -895,7 +897,7 @@ gboolean ps_check_hook( pstate_t* ps, int c )
 }
 
 
-/** 
+/**
  * Check if input has the match string coming next. Erase the matched
  * string if erase is true and input is matched.
  * 
@@ -928,7 +930,7 @@ gboolean ps_check( pstate_t* ps, gchar* match, gboolean erase )
 }
 
 
-/** 
+/**
  * Check input for hookesc.
  * 
  * @param ps Pstate.
@@ -944,7 +946,7 @@ gboolean ps_check_hookesc( pstate_t* ps )
 }
 
 
-/** 
+/**
  * Check input for hookbeg.
  * 
  * @param ps Pstate.
@@ -960,7 +962,7 @@ gboolean ps_check_hookbeg( pstate_t* ps )
 }
 
 
-/** 
+/**
  * Check input for hookend.
  * 
  * @param ps Pstate.
@@ -976,7 +978,7 @@ gboolean ps_check_hookend( pstate_t* ps )
 }
 
 
-/** 
+/**
  * Get char (through Filestack).
  * 
  * @param ps Pstate.
@@ -989,7 +991,7 @@ int ps_in( pstate_t* ps )
 }
 
 
-/** 
+/**
  * Output char to current output stream.
  * 
  * @param ps Pstate.
@@ -1008,7 +1010,7 @@ void ps_out( pstate_t* ps, int c )
 }
 
 
-/** 
+/**
  * Output chars with ps_out.
  * 
  * @param ps  Pstate.
@@ -1028,7 +1030,7 @@ void ps_out_str( pstate_t* ps, gchar* str )
 }
 
 
-/** 
+/**
  * Push new output stream on top of output file stack.
  * 
  * @param ps Pstate.
@@ -1041,7 +1043,7 @@ void ps_push_file( pstate_t* ps, gchar* filename )
 }
 
 
-/** 
+/**
  * Pop file from output file stack. Close the stream.
  * 
  * @param ps Pstate.
@@ -1056,7 +1058,7 @@ void ps_pop_file( pstate_t* ps )
 }
 
 
-/** 
+/**
  * Return current Stackfile (input stream).
  * 
  * @param ps Pstate.
@@ -1074,7 +1076,7 @@ stackfile_t* ps_current_file( pstate_t* ps )
 }
 
 
-/** 
+/**
  * Initialize macro content collection.
  * 
  * @param ps Pstate.
@@ -1085,7 +1087,7 @@ void ps_start_collect( pstate_t* ps )
 }
 
 
-/** 
+/**
  * Add content to macro.
  * 
  * @param ps Pstate.
@@ -1097,7 +1099,7 @@ void ps_collect( pstate_t* ps, int c )
 }
 
 
-/** 
+/**
  * Get current macro content.
  * 
  * @param ps Pstate.
@@ -1110,7 +1112,7 @@ char* ps_get_macro( pstate_t* ps )
 }
 
 
-/** 
+/**
  * Evaluate str as Ruby code and convert result to string. Conversion
  * is performed if execution was successful and conversion was
  * requested.
@@ -1165,7 +1167,7 @@ gchar* ps_eval_ruby_str( pstate_t* ps, gchar* str, gboolean to_str, char* ctxt )
 }
 
 
-/** 
+/**
  * Load file Ruby intepreter.
  * 
  * @param filename Source file.
@@ -1181,7 +1183,7 @@ void ps_load_ruby_file( pstate_t* ps, gchar* filename )
 }
 
 
-/** 
+/**
  * Execute Mucgly command/macro.
  * 
  * @param ps Pstate.
@@ -1313,7 +1315,7 @@ gboolean ps_eval_cmd( pstate_t* ps )
   }
 
 
-/* Convenience macro for non-hook processing. */
+/** Convenience macro for non-hook processing. */
 #define NON_HOOK_SEQ {                                                  \
     /* Non-hook input. */                                               \
     if ( ps->in_macro )                                                 \
@@ -1334,7 +1336,7 @@ gboolean ps_eval_cmd( pstate_t* ps )
   }
 
 
-/** 
+/**
  * Process input file (or stack of files).
  * 
  * @param ps Pstate.
@@ -1543,7 +1545,7 @@ void ps_process_file( pstate_t* ps, gchar* infile, gchar* outfile )
  * ------------------------------------------------------------ */
 
 
-/** 
+/**
  * Mucgly.write method. Write output current output without NL.
  * 
  * @param obj  Not used.
@@ -1568,7 +1570,7 @@ VALUE mucgly_write( VALUE obj, VALUE rstr )
 }
 
 
-/** 
+/**
  * Mucgly.puts method. Write output current output with NL.
  * 
  * @param obj  Not used.
@@ -1595,7 +1597,7 @@ VALUE mucgly_puts( VALUE obj, VALUE rstr )
 }
 
 
-/** 
+/**
  * Mucgly.hookbeg method. Get hookbeg.
  * 
  * @param obj  Not used.
@@ -1608,7 +1610,7 @@ VALUE mucgly_hookbeg( VALUE obj )
 }
 
 
-/** 
+/**
  * Mucgly.hookend method. Get hookend.
  * 
  * @param obj  Not used.
@@ -1621,7 +1623,7 @@ VALUE mucgly_hookend( VALUE obj )
 }
 
 
-/** 
+/**
  * Mucgly.hookesc method. Get hookesc.
  * 
  * @param obj  Not used.
@@ -1634,7 +1636,7 @@ VALUE mucgly_hookesc( VALUE obj )
 }
 
 
-/** 
+/**
  * Mucgly.sethookbeg method. Set hookbeg.
  * 
  * @param obj  Not used.
@@ -1651,7 +1653,7 @@ VALUE mucgly_sethookbeg( VALUE obj, VALUE rstr )
 }
 
 
-/** 
+/**
  * Mucgly.sethookend method. Set hookend.
  * 
  * @param obj  Not used.
@@ -1668,7 +1670,7 @@ VALUE mucgly_sethookend( VALUE obj, VALUE rstr )
 }
 
 
-/** 
+/**
  * Mucgly.sethookesc method. Set hookesc.
  * 
  * @param obj  Not used.
@@ -1685,7 +1687,7 @@ VALUE mucgly_sethookesc( VALUE obj, VALUE rstr )
 }
 
 
-/** 
+/**
  * Mucgly.ifilename method. Gets current input file name.
  * 
  * @param obj  Not used.
@@ -1698,7 +1700,7 @@ VALUE mucgly_ifilename( VALUE obj )
 }
 
 
-/** 
+/**
  * Mucgly.ilinenumber method. Gets current input file line.
  * 
  * @param obj  Not used.
@@ -1711,7 +1713,7 @@ VALUE mucgly_ilinenumber( VALUE obj )
 }
 
 
-/** 
+/**
  * Mucgly.ofilename method. Gets current output file name.
  * 
  * @param obj  Not used.
@@ -1726,7 +1728,7 @@ VALUE mucgly_ofilename( VALUE obj )
 }
 
 
-/** 
+/**
  * Mucgly.olinenumber method. Gets current output file line.
  * 
  * @param obj  Not used.
@@ -1741,7 +1743,7 @@ VALUE mucgly_olinenumber( VALUE obj )
 }
 
 
-/** 
+/**
  * Mucgly.pushinput method. Push new input stream.
  * 
  * @param obj  Not used.
@@ -1759,7 +1761,7 @@ VALUE mucgly_pushinput( VALUE obj, VALUE rstr )
 }
 
 
-/** 
+/**
  * Mucgly.closeinput method. Pop input stream and close file stream.
  * 
  * @param obj  Not used.
@@ -1773,7 +1775,7 @@ VALUE mucgly_closeinput( VALUE obj )
 }
 
 
-/** 
+/**
  * Mucgly.pushoutput method. Push new output stream.
  * 
  * @param obj  Not used.
@@ -1791,7 +1793,7 @@ VALUE mucgly_pushoutput( VALUE obj, VALUE rstr )
 }
 
 
-/** 
+/**
  * Mucgly.closeoutput method. Pop output stream and close file stream.
  * 
  * @param obj  Not used.
@@ -1806,7 +1808,7 @@ VALUE mucgly_closeoutput( VALUE obj )
 
 
 #ifdef MUCGLY_LIB
-/** 
+/**
  * Call mucgly C-side entry point. Convert Ruby ARGV array to C-array
  * for C-side command line arg parsing.
  * 
@@ -1835,7 +1837,7 @@ VALUE mucgly_run_mucgly( VALUE obj, VALUE cli )
 #endif
 
 
-/** 
+/**
  * Create Mucgly Ruby module and register all methods to it.
  * 
  */
@@ -1869,7 +1871,7 @@ void Init_mucgly( void )
 }
 
 
-/** 
+/**
  * Generate outfile name from infile by removing the outfile_tag from
  * infile name.
  * 
@@ -1941,30 +1943,30 @@ void mucgly_main( int argc, char** argv )
 
   GOptionEntry opts_table[] =
     {
-      { "files", 'f', 0, G_OPTION_ARG_FILENAME_ARRAY,
-        &opt_files, "Input file(s) (default: stdin).", NULL },
-      { "configs", 'c', 0, G_OPTION_ARG_FILENAME_ARRAY,
-        &opt_configs, "Ruby configuration file(s).", NULL },
-      { "output", 'o', 0, G_OPTION_ARG_FILENAME,
-        &opt_output, "Output file(s) (default: stdout).", NULL },
-      { "genout", 'g', 0, G_OPTION_ARG_STRING,
-        &opt_genout, "Generate output file names (remove arg from input filename).", NULL },
-      { "cli_cmds", 'l', 0, G_OPTION_ARG_STRING_ARRAY,
-        &opt_cli_cmds, "Command line configuration(s).", NULL },
-      { "beg_sep", 'b', 0, G_OPTION_ARG_STRING,
-        &opt_beg_sep, "Set hookbeg separator (default: '-<').", NULL },
-      { "end_sep", 'e', 0, G_OPTION_ARG_STRING,
-        &opt_end_sep, "Set hookend separator (default: '>-').", NULL },
-      { "esc_sep", 's', 0, G_OPTION_ARG_STRING,
-        &opt_esc_sep, "Set hookesc separator (default: '\\').", NULL },
-      { "all_sep", 'a', 0, G_OPTION_ARG_STRING,
-        &opt_all_sep, "Set all separators.", NULL },
-      { "module", 'm', 0, G_OPTION_ARG_NONE,
-        &opt_module, "Include Mucgly module at start.", NULL },
-      { "interact", 'i', 0, G_OPTION_ARG_NONE,
-        &opt_interact, "Flush output for proper interaction.", NULL },
-      { "no_init", 'n', 0, G_OPTION_ARG_NONE,
-        &opt_no_init, "No init file (MUCGLY env var).", NULL },
+      { "files", 'f', 0, G_OPTION_ARG_FILENAME_ARRAY, &opt_files,
+        "Input file(s) (default: stdin).", NULL },
+      { "configs", 'c', 0, G_OPTION_ARG_FILENAME_ARRAY, &opt_configs,
+        "Ruby configuration file(s).", NULL },
+      { "output", 'o', 0, G_OPTION_ARG_FILENAME, &opt_output,
+        "Output file(s) (default: stdout).", NULL },
+      { "genout", 'g', 0, G_OPTION_ARG_STRING, &opt_genout,
+        "Generate output file names (remove arg from input filename).", NULL },
+      { "cli_cmds", 'l', 0, G_OPTION_ARG_STRING_ARRAY, &opt_cli_cmds,
+        "Command line configuration(s).", NULL },
+      { "beg_sep", 'b', 0, G_OPTION_ARG_STRING, &opt_beg_sep,
+        "Set hookbeg separator (default: '-<').", NULL },
+      { "end_sep", 'e', 0, G_OPTION_ARG_STRING, &opt_end_sep,
+        "Set hookend separator (default: '>-').", NULL },
+      { "esc_sep", 's', 0, G_OPTION_ARG_STRING, &opt_esc_sep,
+        "Set hookesc separator (default: '\\').", NULL },
+      { "all_sep", 'a', 0, G_OPTION_ARG_STRING, &opt_all_sep,
+        "Set all separators.", NULL },
+      { "module", 'm', 0, G_OPTION_ARG_NONE, &opt_module,
+        "Include Mucgly module at startup.", NULL },
+      { "interact", 'i', 0, G_OPTION_ARG_NONE, &opt_interact,
+        "Flush output for convenient interaction.", NULL },
+      { "no_init", 'n', 0, G_OPTION_ARG_NONE, &opt_no_init,
+        "No init file (skip MUCGLY env var).", NULL },
       { NULL }
     };
 
@@ -1997,9 +1999,7 @@ void mucgly_main( int argc, char** argv )
                          "MUCGLY env set, but the file \"%s\" does not exist!",
                          init );
           else
-            {
-              ps_load_ruby_file( ps, init );
-            }
+            ps_load_ruby_file( ps, init );
         }
     }
 
@@ -2051,8 +2051,10 @@ void mucgly_main( int argc, char** argv )
 
 
   if ( opt_interact )
+    /* Flush output immediately in interactive mode. */
     ps->flush = TRUE;
 
+
   /* Process input files. */
   if ( opt_files )
     {
@@ -2080,7 +2082,7 @@ void mucgly_main( int argc, char** argv )
 
 
 #ifndef MUCGLY_LIB
-/** 
+/**
  * C-top entry point.
  * 
  * @param argc Cli arg count.