defstr 0.1.0

data/History.txt

@@ -0,0 +1,3 @@
+=== 0.1.0 / 2008-12-05
+
+* Initial Release

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/defstr
+lib/defstr.rb
+test/actual
+test/test_command_line.rb
+test/test_defstr.rb
+test/print_program.c
+test/program.c

data/README.txt

@@ -0,0 +1,113 @@
+= defstr
+
+* http://lab.moekaku.com/code/defstr/
+
+== DESCRIPTION:
+
+defstr converts text to a C string literal
+that parses (by a C compiler) to the original text, and creates
+a C macro that defines it as a constant. The liternal preserves 
+the original text's structure (line breaks, paragraphs, etc).
+
+defstr can be used as a tool for C/C++ code generation.
+
+== Library Usage:
+
+Use Defstr.string_literal to convert a string to a C literal. For example:
+
+	require 'defstr'
+	Defstr.string_literal "abc"
+	
+gets you a ruby string that represents the text:
+
+	"\
+	abc"
+
+User Defstr.define_string to define the string as a constant. For example:
+
+	require 'defstr'
+	Defstr.define_string("CG_VERTEX_PROGRAM", <<EOF
+	void main(float3 position : POSITION,
+		      out float3 clipPosition : POSITION)
+	{
+		clipPosition = position;
+	}
+	EOF
+	)
+	
+gets you a ruby string that represents the text:
+
+	#define CG_VERTEX_PROGRAM "\
+	void main(float3 position : POSITION,\n\
+		      out float3 clipPosition : POSITION)\n\
+	{\n\
+		clipPosition = position;\n\
+	}\n\
+	"
+
+== Shell Command Usage:
+
+Suppose the content of vertex_program.cg is the same as 
+the program snipper defined in a string above. After you run
+
+	$ defstr CG_VERTEX_PROGRAM < vertex_program.cg  > vertex_program_string.h
+	
+the content of vertex_program_string.h will be:
+
+	#ifndef __DEFSTR_CG_VERTEX_PROGRAM_H__
+	#define __DEFSTR_CG_VERTEX_PROGRAM_H__
+
+	#define CG_VERTEX_PROGRAM "\
+	void main(float3 position : POSITION,\n\
+			  out float3 clipPosition : POSITION)\n\
+	{\n\
+		clipPosition = position;\n\
+	}\n\
+	"
+
+	#endif
+	
+If you do not want the #ifndef, use the --no-ifndef flag. For example:
+
+	$ defstr CG_VERTEX_PROGRAM < vertex_program.cg  > vertex_program_string.h --no-ifndef
+	
+will write the following text:
+
+	#define CG_VERTEX_PROGRAM "\
+	void main(float3 position : POSITION,\n\
+			  out float3 clipPosition : POSITION)\n\
+	{\n\
+		clipPosition = position;\n\
+	}\
+	"
+
+to vertex_program_string.h
+	
+== INSTALL:
+
+* sudo gem install defstr
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Pramook Khungurn
+
+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/Rakefile

@@ -0,0 +1,13 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/defstr.rb'
+
+Hoe.new('defstr', Defstr::VERSION) do |p|  
+  p.developer('dragonmeteor', 'dragonmeteor@gmail.com')
+  p.remote_rdoc_dir = '' # Release to root
+  p.clean_globs = ["test/actual/*"]
+end
+
+# vim: syntax=Ruby

data/bin/defstr

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby -ws
+
+require 'optparse'
+require File.dirname(__FILE__) + "/../lib/defstr.rb"
+
+ifndef = true
+
+parser = OptionParser.new do |parser|
+	parser.banner = "Usage: defstr constant_name [options]"
+	
+	parser.on("--[no-]ifndef", "Generate #ifndef (default: YES)") do |value|
+		ifndef = value
+	end
+	
+	parser.on_tail("-h", "--help", "Show this message") do
+        puts parser
+        exit
+    end
+end
+
+parser.parse(ARGV)
+const_name = ARGV.shift
+if not const_name
+	puts parser
+	exit
+end
+
+s = STDIN.read
+
+if ifndef
+	puts "#ifndef __DEFSTR_#{const_name}_H__"
+	puts "#define __DEFSTR_#{const_name}_H__"
+	puts
+end
+
+puts Defstr.define_string(const_name, s)
+
+if ifndef
+	puts 
+	puts "#endif"
+end

data/lib/defstr.rb

@@ -0,0 +1,35 @@
+module Defstr
+  VERSION = '0.1.0'
+  
+  # Turn the given string to 
+  # a C string literal that
+  # parses to the original string.
+  def string_literal(s)
+	result = "\"\\\n"
+	s.each_byte do |b|
+		c = b.chr
+		if c == "\n"
+			result += "\\n\\\n"
+		elsif c == "\r"
+			next
+		elsif c == "\\"
+			result += "\\\\"
+		elsif c == "\""
+			result += "\\\""
+		else
+			result += c
+		end
+	end
+	result += "\"\n"
+	result
+  end
+  module_function :string_literal
+  
+  # Generate a C macro that
+  # defines the given string
+  # as a string constant.
+  def define_string(name, s)
+	result = "#define #{name.upcase} " + string_literal(s)	
+  end
+  module_function :define_string
+end

data/test/print_program.c

@@ -0,0 +1,8 @@
+#include <stdio.h>
+#include "actual/program.h"
+
+int main()
+{
+	printf("%s", PROGRAM);
+	return 0;
+}

data/test/program.c

@@ -0,0 +1,7 @@
+#include <stdio.h>
+
+int main()
+{
+	printf("\"\n");
+	return 0;
+}

data/test/test_command_line.rb

@@ -0,0 +1,15 @@
+require 'test/unit'
+require File.dirname(__FILE__) + "/../lib/defstr.rb"
+
+class TestCommandLine < Test::Unit::TestCase
+	def test_defstr
+		dir = File.dirname(__FILE__)
+		system "ruby #{dir}/../bin/defstr PROGRAM < #{dir}/program.c > #{dir}/actual/program.h"
+		system "gcc #{dir}/print_program.c -o #{dir}/actual/print_program"
+		actual = `#{dir}/actual/print_program`
+		f = File.open("#{dir}/program.c")
+		expected = f.read
+		f.close
+		assert expected, actual
+	end
+end

data/test/test_defstr.rb

@@ -0,0 +1,33 @@
+require 'test/unit'
+require File.dirname(__FILE__) + "/../lib/defstr.rb"
+
+class TestLibrary < Test::Unit::TestCase
+	def test_string_literal
+		expected_abc = <<EOF
+"\\
+abc"
+EOF
+		assert_equal(expected_abc, Defstr.string_literal("abc"))
+		
+		expected_abcdef = <<EOF
+"\\
+abc\\n\\
+def\\n\\
+"
+EOF
+		assert_equal(expected_abcdef, Defstr.string_literal("abc\ndef\n"))
+	end
+	
+	def test_define_string
+		expected_cg_program = <<EOF
+#define PROGRAM "\\
+void main()\\n\\
+{\\n\\
+return 0;\\n\\
+}\\n\\
+"
+EOF
+		assert_equal(expected_cg_program, 
+			Defstr.define_string("PROGRAM", "void main()\n{\nreturn 0;\n}\n"))
+	end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: defstr
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- dragonmeteor
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-07 00:00:00 +07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.2
+    version: 
+description: defstr converts text to a C string literal that parses (by a C compiler) to the original text, and creates a C macro that defines it as a constant. The liternal preserves  the original text's structure (line breaks, paragraphs, etc).  defstr can be used as a tool for C/C++ code generation.
+email: 
+- dragonmeteor@gmail.com
+executables: 
+- defstr
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/defstr
+- lib/defstr.rb
+- test/actual
+- test/test_command_line.rb
+- test/test_defstr.rb
+- test/print_program.c
+- test/program.c
+has_rdoc: true
+homepage: http://lab.moekaku.com/code/defstr/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: defstr
+rubygems_version: 1.3.0
+signing_key: 
+specification_version: 2
+summary: defstr converts text to a C string literal that parses (by a C compiler) to the original text, and creates a C macro that defines it as a constant
+test_files: 
+- test/test_command_line.rb
+- test/test_defstr.rb