kingpong-bitwise_string_ops 0.1.2

data/CHANGELOG

@@ -0,0 +1,41 @@
+commit 074c9142a5b66b146e70e185566931e285867d06
+Author: kingpong <philip@pastemagazine.com>
+Date:   Sat Aug 22 19:28:48 2009 -0400
+
+    updated gem summary to avoid warning.  now ignoring locally built gems
+
+commit 15eaea26144f53acb6115e69c61849fd6acc271f
+Author: kingpong <philip@pastemagazine.com>
+Date:   Sat Aug 22 19:18:42 2009 -0400
+
+    updated description
+
+commit 6564737f4bde3fc862536f2ca783f25d7f27e876
+Author: kingpong <philip@pastemagazine.com>
+Date:   Sat Aug 22 19:10:43 2009 -0400
+
+    fixed heading
+
+commit 87fa61f9253a8d43764ac52acd09583da8c39d26
+Author: kingpong <philip@pastemagazine.com>
+Date:   Sat Aug 22 19:04:45 2009 -0400
+
+    converted to gem. added readme and license spam.
+
+commit 6ec05ea0131d5b86c6af5b20a872cd266ce76a2a
+Author: kingpong <philip@pastemagazine.com>
+Date:   Sat Aug 22 17:00:01 2009 -0400
+
+    improved organization; added setup.rb
+
+commit bc3246fb8724510be668bd64b4769e712658042e
+Author: Philip Garrett <philip@philip.(none)>
+Date:   Sat Aug 22 15:51:01 2009 -0400
+
+    ignore build files
+
+commit 2c66ca95fb973a0029dd655ab3aaa5427ece778b
+Author: Philip Garrett <philip@philip.(none)>
+Date:   Sat Aug 22 15:42:23 2009 -0400
+
+    working, barely-tested bitwise string operations

data/Manifest

@@ -0,0 +1,18 @@
+bitwise_string_ops.gemspec
+CHANGELOG
+ext/bitwise.c
+ext/bitwise_string_ops.c
+ext/bitwise_string_ops.h
+ext/extconf.rb
+init.rb
+lib/bitwise_string_ops.rb
+Manifest
+Rakefile
+README.rdoc
+setup.rb
+test/test.rb
+test/test_helper.rb
+test/test_string_and.rb
+test/test_string_not.rb
+test/test_string_or.rb
+test/test_string_xor.rb

data/README.rdoc

@@ -0,0 +1,98 @@
+= Name
+
+bitwise_string_ops - Bitwise operators for the String class
+
+= Installation
+
+  gem install kingpong-bitwise_string_ops --source http://gems.github.com
+
+  # in your code:
+  require 'rubygems'
+  require 'bitwise_string_ops'
+
+  # or in Rails' environment.rb:
+  gem "kingpong-bitwise_string_ops", :lib => "bitwise_string_ops"
+
+= Description
+
+This gem extends the String class to include the bitwise operators '|'
+(OR), '&' (AND), '^' (XOR) and '~' (NOT).  The semantics are as close to
+Perl's bitwise string operators as possible (see "perldoc perlop").
+
+The operation is applied to each successive byte (not necessarily
+character) in the source strings in parallel.  For example, the result
+of "AB" & "CD" is ("A" & "C") + ("B" & "D").
+
+If the operands to a binary bitwise op are strings of different sizes, ⎪
+and ^ ops act as though the shorter operand had additional zero bits on
+the right, while the & op acts as though the longer operand were
+truncated to the length of the shorter.  The granularity for such
+extension or truncation is one or more bytes. [source: perldoc perlop]
+
+For strings of the same length, nothing unexpected:
+
+  "r b " ^ " u y"   # "RUBY"
+  #
+  # 01110010 00100000 01100010 00100000 ^    # "r b " ^
+  # 00100000 01110101 00100000 01111001      # " u y"
+  # ======== ======== ======== ========
+  # 01010010 01010101 01000010 01011001      # "RUBY"
+
+OR operation expands to the larger of the two strings:
+
+  "RU" | "  by"     # "ruby"
+  #
+  # 01010010 01010101                   |    # "RU"
+  # 00100000 00100000 01100010 01111001      # "  by"
+  # ======== ======== ======== ========
+  # 01110010 01110101 01100010 01111001      # "ruby"
+
+XOR expands also:
+
+  "%:--!" ^ "woot"  # "RUBY!"
+  #
+  # 00100101 00111010 00101101 00101101 00100001 ^    # "%:--!"
+  # 01110111 01101111 01101111 01110100               # "woot"
+  # ======== ======== ======== ========
+  # 01010010 01010101 01000010 01011001 00100001"     # "RUBY!"
+
+AND truncates to the shorter of the two:
+
+  "ruby!" & '____'  # "ruby"
+  #
+  # 01110010 01110101 01100010 01111001 00100001 &    # "ruby!"
+  # 01011111 01011111 01011111 01011111               # "____"
+  # ======== ======== ======== ========
+  # 01110010 01110101 01100010 01111001               # "ruby"
+
+= Known Issues
+
+* Largely untested
+* Completely untested with non-string rhs operands
+
+= Author
+
+* Philip Garrett <philip at pastemagazine.com>
+
+= Copyright and License
+
+Copyright (c) 2009 Philip Garrett.
+
+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,24 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+project = "bitwise_string_ops"
+version = "0.1.2"
+
+Echoe.new(project, version) do |p|
+  p.description = "Bitwise operations for Ruby strings"
+  p.summary = "#{project} #{version}"
+  p.url = "http://github.com/kingpong/bitwise_string_ops"
+  p.author = "Philip Garrett"
+  p.email = "philip@pastemagazine.com"
+  p.ignore_pattern = ["tmp/*","script/*","InstalledFiles"]
+  p.development_dependencies = []
+end
+
+desc "Export changes from git into CHANGELOG"
+task :changes do
+  sh "git log > CHANGELOG"
+end
+
+task :manifest => :changes
+task :gem => :changes

data/bitwise_string_ops.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{bitwise_string_ops}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Philip Garrett"]
+  s.date = %q{2009-08-22}
+  s.description = %q{Bitwise operations for Ruby strings}
+  s.email = %q{philip@pastemagazine.com}
+  s.extensions = ["ext/extconf.rb"]
+  s.extra_rdoc_files = ["CHANGELOG", "ext/bitwise.c", "ext/bitwise_string_ops.c", "ext/bitwise_string_ops.h", "ext/extconf.rb", "lib/bitwise_string_ops.rb", "README.rdoc"]
+  s.files = ["bitwise_string_ops.gemspec", "CHANGELOG", "ext/bitwise.c", "ext/bitwise_string_ops.c", "ext/bitwise_string_ops.h", "ext/extconf.rb", "init.rb", "lib/bitwise_string_ops.rb", "Manifest", "Rakefile", "README.rdoc", "setup.rb", "test/test.rb", "test/test_helper.rb", "test/test_string_and.rb", "test/test_string_not.rb", "test/test_string_or.rb", "test/test_string_xor.rb"]
+  s.homepage = %q{http://github.com/kingpong/bitwise_string_ops}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Bitwise_string_ops", "--main", "README.rdoc"]
+  s.require_paths = ["lib", "ext"]
+  s.rubyforge_project = %q{bitwise_string_ops}
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{bitwise_string_ops 0.1.2}
+  s.test_files = ["test/test_helper.rb", "test/test_string_and.rb", "test/test_string_not.rb", "test/test_string_or.rb", "test/test_string_xor.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/ext/bitwise.c

@@ -0,0 +1,71 @@
+/*
+ * bitwise.c
+ *
+ * Copyright (c) 2009 Philip Garrett.
+ * 
+ * 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.
+ */
+
+#include <sys/types.h>
+#include "bitwise_string_ops.h"
+
+void string_bitwise_or(const char *left, size_t llen,
+                       const char *right, size_t rlen,
+                       char *dest)
+{
+    const char *s = llen < rlen ? left : right;   /* smaller */
+    const char *b = llen < rlen ? right : left;   /* bigger  */
+    size_t len = MIN(llen,rlen);
+    size_t ext = MAX(llen,rlen) - len;
+    while (len--)
+        *(dest++) = *(s++) | *(b++);
+    while (ext--)
+        *(dest++) = *(b++);
+}
+
+void string_bitwise_xor(const char *left, size_t llen,
+                        const char *right, size_t rlen,
+                        char *dest)
+{
+    const char *s = llen < rlen ? left : right;   /* smaller */
+    const char *b = llen < rlen ? right : left;   /* bigger  */
+    size_t len = MIN(llen,rlen);
+    size_t ext = MAX(llen,rlen) - len;
+    while (len--)
+        *(dest++) = *(s++) ^ *(b++);
+    while (ext--)
+        *(dest++) = *(b++);
+}
+
+void string_bitwise_and(const char *l, size_t llen,
+                        const char *r, size_t rlen,
+                        char *dest)
+{
+    size_t len = MIN(llen,rlen);
+    while (len--)
+        *(dest++) = *(l++) & *(r++);
+}
+
+void string_bitwise_not(const char *s, size_t slen,
+                        char *dest)
+{
+    while (slen--)
+        *(dest++) = ~(*s++);
+}

data/ext/bitwise_string_ops.c

@@ -0,0 +1,96 @@
+/*
+ * bitwise_string_ops.c
+ *
+ * Copyright (c) 2009 Philip Garrett.
+ * 
+ * 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.
+ */
+
+// Include the Ruby headers and goodies
+#include "ruby.h"
+#include "bitwise_string_ops.h"
+
+// Defining a space for information and references about the module to be stored internally
+VALUE BitwiseStringOps = Qnil;
+
+// Prototype for the initialization method - Ruby calls this, not you
+void Init_bitwise_string_ops();
+
+// Prototypes for our methods
+VALUE method_bit_or(VALUE self, VALUE other);
+VALUE method_bit_xor(VALUE self, VALUE other);
+VALUE method_bit_and(VALUE self, VALUE other);
+VALUE method_bit_not(VALUE self);
+
+// The initialization method for this module
+void Init_bitwise_string_ops()
+{
+    BitwiseStringOps = rb_define_module("BitwiseStringOps");
+    rb_define_method(BitwiseStringOps, "bit_or",  method_bit_or,  1);
+    rb_define_method(BitwiseStringOps, "bit_xor", method_bit_xor, 1);
+    rb_define_method(BitwiseStringOps, "bit_and", method_bit_and, 1);
+    rb_define_method(BitwiseStringOps, "bit_not", method_bit_not, 0);
+}
+
+VALUE method_bit_or(VALUE self, VALUE other)
+{
+    VALUE left = StringValue(self), right = StringValue(other);
+    VALUE dest = rb_str_new(NULL,
+                            string_bitwise_or_result_len(RSTRING(left)->len,
+                                                         RSTRING(right)->len));
+    string_bitwise_or(RSTRING(left)->ptr, RSTRING(left)->len,
+                      RSTRING(right)->ptr, RSTRING(right)->len,
+                      RSTRING(dest)->ptr);
+    return dest;
+}
+
+VALUE method_bit_xor(VALUE self, VALUE other)
+{
+    VALUE left = StringValue(self), right = StringValue(other);
+    VALUE dest = rb_str_new(NULL,
+                            string_bitwise_xor_result_len(RSTRING(left)->len,
+                                                          RSTRING(right)->len));
+    string_bitwise_xor(RSTRING(left)->ptr, RSTRING(left)->len,
+                       RSTRING(right)->ptr, RSTRING(right)->len,
+                       RSTRING(dest)->ptr);
+    return dest;
+}
+
+VALUE method_bit_and(VALUE self, VALUE other)
+{
+    VALUE left = StringValue(self), right = StringValue(other);
+    VALUE dest = rb_str_new(NULL,
+                            string_bitwise_and_result_len(RSTRING(left)->len,
+                                                          RSTRING(right)->len));
+    string_bitwise_and(RSTRING(left)->ptr, RSTRING(left)->len,
+                       RSTRING(right)->ptr, RSTRING(right)->len,
+                       RSTRING(dest)->ptr);
+    return dest;
+}
+
+VALUE method_bit_not(VALUE self)
+{
+    VALUE str = StringValue(self);
+    VALUE dest = rb_str_new(NULL,
+                            string_bitwise_not_result_len(RSTRING(str)->len));
+    string_bitwise_not(RSTRING(str)->ptr, RSTRING(str)->len,
+                       RSTRING(dest)->ptr);
+    return dest;
+}

data/ext/bitwise_string_ops.h

@@ -0,0 +1,49 @@
+/*
+ * bitwise_string_ops.h
+ *
+ * Copyright (c) 2009 Philip Garrett.
+ * 
+ * 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.
+ */
+
+#ifndef BITWISE_STRING_OPS_H
+#define BITWISE_STRING_OPS_H
+
+#include <sys/types.h>
+
+#ifndef MAX
+# define MAX(i,j) (i > j ? i : j)
+#endif
+#ifndef MIN
+# define MIN(i,j) (i < j ? i : j)
+#endif
+
+#define string_bitwise_or_result_len(i,j)  (MAX(i,j))
+#define string_bitwise_xor_result_len(i,j) (MAX(i,j))
+#define string_bitwise_and_result_len(i,j) (MIN(i,j))
+#define string_bitwise_not_result_len(i)   (i)
+
+void string_bitwise_or(const char *l, size_t llen, const char *r, size_t rlen, char *dest);
+void string_bitwise_xor(const char *l, size_t llen, const char *r, size_t rlen, char *dest);
+void string_bitwise_and(const char *l, size_t llen, const char *r, size_t rlen, char *dest);
+void string_bitwise_not(const char *s, size_t slen, char *dest);
+
+#endif /* BITWISE_STRING_OPS_H */
+

data/ext/extconf.rb

@@ -0,0 +1,4 @@
+require 'mkmf'
+extension_name = 'bitwise_string_ops'
+dir_config(extension_name)
+create_makefile(extension_name)