crun 0.0.1

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+= Version history
+
+[0.0.1] Initial version.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016 tero.isannainen@gmail.com
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,183 @@
+= Crun
+
+* Introduction
+* Example runs
+* Options
+* Issues
+
+
+= Introduction
+
+Crun is an utility for compiling and running C-programs straight from
+C source files. Crun supports compile-run and compile-debug flows.
+
+You can embed custom compile options into the main c-file, if you
+need, for example, an external library for the program. You can also
+control the command line parameters passed to the program through
+Crun.
+
+Crun is usually used with one c-file, i.e. the main file. However
+program can be split into multiple files, but main has to be first in
+the list of files. Crun is targeted for small C-programs, so it is not
+typical to have multiple files.
+
+User of Crun is most probably trying out some basic C-features or maybe
+prototyping with some algorithm. 
+
+
+= Example runs
+
+In order to run "Hello World" example with Crun, you need to have the
+C source file with "Hello World" program in it. This is available in
+the "examples" directory for you.
+
+"hello.c" content:
+
+  #include <stdio.h>
+  int main( int argc, char** argv )
+  {
+    printf( "Hello World!\n" );
+    return 0;
+  }
+
+You can execute compile-run flow by:
+
+  shell> crun -f examples/hello.c
+
+The output from program is:
+
+  Hello World!
+
+You can execute compile-debug flow by:
+
+  shell> crun -f examples/hello.c -d
+
+Program is compiled and gdb is started so that the program stops at
+"main" (i.e. default behavior).
+
+Check available command line interface, CLI, options for Crun:
+
+  shell> crun -h
+
+
+= Options
+
+You can specify options for Crun in multiple ways. Typically CLI is
+used to control Crun, but if the program uses static compilation
+options, those live most naturally in the source file itself.
+
+Options are stored to a hash called "@crun". Each option name is a key
+in the hash, and the option values are Arrays.
+
+For example the entry:
+
+  @crun['progopts']
+
+specify the command line parameters given to the program compiled and
+run by Crun.
+
+Here is the complete list of options that control Crun:
+
+[ compopts ]
+
+  Array of user's compilation options. E.g. "-l lm" to include the
+  math lib. Default is: [].
+
+[ progopts ]
+
+  Array of command line parameters for the program run. E.g. ["-c
+  12"]. Default is: [].
+
+[ stopopts ]
+
+  Array of breakpoints for the debugger. E.g. ["add"] defines that the
+  debugger stops at "add" function. Default is: ["main"].
+
+[ compprog ]
+
+  Array including the compiler name and base options. This options
+  array should only have one entry, but in theory you could have
+  multiple entries. The entries are concatenated with SPACE. The
+  compiler command has to have same command line parameters as
+  "gcc". Default is: ["gcc", "-Wall", "-std=c11"].
+
+[ dbugprog ]
+
+  Array including the debugger name and base options. This options
+  array should only have one entry, but in theory you could have
+  multiple entries. The entries are concatenated with SPACE. The
+  debugger command has to have same command line parameters as
+  "gdb". Default is: ["gdb", "--nx"].
+
+[ crunopts ]
+
+  Array of compiler options managed by Crun. User don't have to
+  control this option. Default is: [].
+
+Crun sets Options to default values and then applies the user
+overrides from various sources, given below.
+
+User can embed the options to the C source file. This is the
+recommended way because this way the settings will follow the code.
+Additional compilation options and CLI options for the compiled
+program would be given as:
+
+  /*
+   * Options for crun:
+   * -crun-compopts:=-O2
+   * crun-compopts:+-lm
+   * crun-progopts:=-c 12
+   */
+
+The syntax is "crun-<option>". If there is no space before "crun", the
+setting is not used, i.e. first "compopts" is neglected above.
+
+User can specify static overrides in "$HOME/.crun" file and/or in
+"./.crun". In addition to these predefined files, user can use the
+"-c" Crun CLI option to read in option overrides.
+
+For example if the program is always run with "-c 10" command line
+options, you use this in ".crun":
+
+  @crun['progopts'] = [ "-c 10" ]
+
+An alternative way to achieve the same thing is to use Crun CLI and
+use the -o option:
+
+  shell> crun -o "progopts:=-c 10" ...
+
+This sets the list of program options to "-c 10". ":=" syntax means
+setting the Array of options. If you need to add to existing list of
+options, you should do:
+
+  shell> crun -o "progopts:+-c 10" ...
+
+Thus ":+" is the syntax for appending more options to existing list.
+
+The simplest way to pass 'progopts' to target program is using the
+"-p" CLI option. However user must be aware of the shell option
+parsing, since it is very easy to miss the target program and actually
+pass the option to Crun.
+
+If you want to pass '-' based option to target program:
+
+  shell> crun -p "\-c 10" ...
+
+The backslash before "-c" will ensure that "-c" does not become an
+option for Crun.
+
+Summary of option setting from first to last:
+
+* Defaults (from crun program).
+* ".crun" from home directory.
+* ".crun" from current directory.
+* "-c" options from files.
+* "-o" options from Crun CLI.
+* "-p" options for program (only).
+* Options embedded to C source file (main file).
+
+
+= Issues
+
+If you take C source input from STDIN, you can't use the debug
+option. Only compile-run flow is possible.

data/bin/crun

@@ -0,0 +1,225 @@
+#!/usr/bin/env ruby
+
+# crun compiles the given c-file and executes it using RAM FS. It can
+# be considered as c-scripting. crun can dig out compilation options
+# from the c-file if special linking or such is required.
+#
+# See README.rdoc for full documentation.
+
+
+require 'como'
+include Como
+require 'tempfile'
+require_relative '../lib/version'
+
+Spec.command( 'crun', 'Tero Isannainen', '2016',
+  [
+      [ :opt_multi,  'file',    '-f',  "C-file(s) for program." ],
+      [ :opt_single, 'prog',    '-p',  "Add program options (i.e. progopts)." ],
+      [ :switch,     'debug',   '-d',  "Debug program." ],
+      [ :opt_multi,  'opts',    '-o',  "Set/add crun option." ],
+      [ :opt_multi,  'conf',    '-c',  "Crun option file(s)." ],
+      [ :switch,     'input',   '-i',  "Read stdin for C-code." ],
+      [ :exclusive,  'template','-t',  "Output a template file for program." ],
+      [ :switch,     'verbose', '-v',  "Verbose (to stderr)." ],
+  ] )
+
+
+# Execute shell command with optional verbosity.
+def crun_exe( cmd )
+    if Opt['verbose'].given
+        STDERR.puts "crun execution: \"#{cmd}\" ..."
+    end
+    system( cmd )
+end
+
+# Parse and apply option setting.
+def apply_opt( opt )
+    if opt.split(':=').length == 2
+        parts = opt.split(':=')
+        @crun[parts[0]] = [ parts[1] ]
+    elsif opt.split(':+').length == 2
+        parts = opt.split(':+')
+        @crun[parts[0]].push parts[1]
+    end
+end
+
+if Opt['template'].given
+    puts "\
+/*
+ * crun-compopts:+-O2
+ */
+
+#include <stdio.h>
+
+int main( int argc, char** argv )
+{
+  
+  return 0;
+}
+"
+    exit( false )
+end
+
+
+if Opt['file'].given
+    cfiles = Opt['file'].value
+elsif Opt['input'].given
+    # Create a temp c-file for input.
+    input = STDIN.read
+    cfile = "#{Tempfile.new( "crun-source", '/dev/shm' ).path}.c"
+    File.write( cfile, input )
+    cfiles = [ cfile ]
+else
+    Spec.usage
+end
+
+
+# ------------------------------------------------------------
+# Configurations:
+
+# Default crun configuration.
+@crun = {
+
+    # Users compiler options.
+    'compopts' => [],
+
+    # Program's command line options.
+    'progopts' => [],
+
+    # Debugger breakpoints.
+    'stopopts' => %w{main},
+
+    # Used compiler.
+    'compprog' => %w{gcc -Wall -std=c11},
+
+    # Used compiler.
+    'dbugprog' => %w{gdb --nx},
+
+    # Compiler options managed by crun.
+    'crunopts' => [],
+}
+
+
+# Read user conf.
+userconf = "#{ENV['HOME']}/.crun"
+load userconf if File.exist? userconf
+
+# Read local user conf.
+userconf = "./.crun"
+load userconf if File.exist? userconf
+
+
+# Compile with '-g' in debug mode.
+if Opt['debug'].given
+    @crun['crunopts'].push '-g'
+end
+
+# Read in selected user confs.
+if Opt['conf'].given
+    Opt['conf'].value.each do |userconf|
+        load userconf if File.exist? userconf
+    end
+end
+
+
+# ------------------------------------------------------------
+# Collect compilation options from c-file.
+compopts = @crun['compopts']
+crun_re = /[\s]+crun-([a-z]+)/
+
+File.readlines( cfiles[0] ).each do |line|
+    m = line.match( crun_re )
+    if m
+        option = m[1]
+        setting = line.chomp.split( 'crun-' )[1]
+        apply_opt( setting )
+    end
+end
+
+
+# ------------------------------------------------------------
+# Collect compilation options from CLI.
+
+# Get options from CLI.
+if Opt['opts'].given
+    Opt['opts'].value.each do |opt|
+        apply_opt( opt )
+    end
+end
+
+# Get program execution options.
+if Opt['prog'].given
+    @crun['progopts'].push Opt['prog'].value
+end
+
+
+# ------------------------------------------------------------
+# Create tempfile for executable.
+exefile = File.basename( cfiles[0], '.c' )
+exepath = Tempfile.new( "crun-#{exefile}", '/dev/shm' ).path
+
+
+# ------------------------------------------------------------
+# Create list of commands to run:
+cmds = []
+
+class Array
+    # Join array elements with space.
+    def crun
+        self.join(' ')
+    end
+end
+
+cmds.push "#{@crun['compprog'].crun} #{@crun['crunopts'].crun} #{@crun['compopts'].crun} #{cfiles.crun} -o #{exepath}"
+
+# In order to avoid the "text file busy" issue, copy back and forth the exefile.
+cmds.push "cp #{exepath} #{exepath}-tmp"
+cmds.push "rm -f #{exepath}"
+cmds.push "mv #{exepath}-tmp #{exepath}"
+
+if Opt['debug'].given
+
+    # compile-debug flow:
+    cmd = @crun['dbugprog'].crun
+    if @crun['progopts'].any?
+        cmd += " -ex \"set args #{@crun['progopts'].crun}\""
+    end
+    breaks = ""
+    if @crun['stopopts'].any?
+        breaks = @crun['stopopts'].map{|i| " -ex \"break #{i}\""}.crun
+    end
+    cmd += breaks
+    cmd += " -ex run"
+    cmd += " #{exepath}"
+    cmds.push cmd
+
+else
+
+    # compile-run flow:
+    if @crun['progopts'].any?
+        cmds.push "#{exepath} #{@crun['progopts'].crun}"
+    else
+        cmds.push exepath
+    end
+
+end
+
+
+# ------------------------------------------------------------
+# Execute collected commands:
+ret = nil
+cmds.each do |cmd|
+    ret = crun_exe( cmd )
+    if ret == false
+        break
+    end
+end
+
+# ------------------------------------------------------------
+# Always cleanup, but not necessary if using "/dev/shm".
+if Opt['input'].given
+    system( "rm -f #{cfiles[0]}" )
+end
+
+FileUtils.rm_f exepath

data/doc/Array.html

@@ -0,0 +1,202 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: Array
+  
+    &mdash; Documentation by YARD 0.8.7.6
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!Array.html";
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="_index.html">Index (A)</a> &raquo;
+    
+    
+    <span class="title">Array</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Class: Array
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">Array</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+      </dd>
+    
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">bin/crun</dd>
+  
+</dl>
+<div class="clear"></div>
+
+
+
+
+
+
+
+
+  
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#crun-instance_method" title="#crun (instance method)">- (Object) <strong>crun</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Join array elements with space.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="crun-instance_method">
+  
+    - (<tt>Object</tt>) <strong>crun</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Join array elements with space.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+169
+170
+171</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'bin/crun', line 169</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_crun'>crun</span>
+    <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'> </span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+
+    <div id="footer">
+  Generated on Sun Dec 25 20:31:45 2016 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.6 (ruby-2.3.1).
+</div>
+
+  </body>
+</html>