protomsg 0.5.0

data/LICENSE

@@ -0,0 +1 @@
+Public Domain.

data/README.rdoc

@@ -0,0 +1,61 @@
+= protomsg
+
+Protocol Message Buffers for C. This gem generates C socket code for reading and writing messages described in the protomsg DSL.
+
+== Example
+Input for a 'request' message:
+
+    request {
+      int     type
+      string  key
+      raw     data
+    }
+
+Output is a header file of macros for reading, writing and manipulating request messages:
+
+    // attribute getters
+    get_request_type
+    get_request_key
+    get_request_data
+    
+    // attribute setters
+    set_request_type
+    set_request_key
+    set_request_data
+    
+    // lengths
+    request_key_length
+    request_data_length
+    request_length
+    
+    // memory & IO
+    init_request
+    free_request
+    write_request
+    read_request
+
+The macros generate highly optimised, copy free socket code (using the scatter/gather IO functions readv and writev), and automatically check message sanity, and handle incomplete reads and writes. Message types with many variable length attributes (strings or raw data segments) will benefit more from the generated code than message types primarily made up of fixed length attributes.
+
+== Usage
+Call the protomsg script with the message types input file.
+
+    $ protomsg mymessages.protomsg
+    Created protomsg.h
+    Created request_message.h
+
+Each file may describe multiple message types. The format for each message type is:
+
+    message_type_name {
+        attribute_type  attribute_name
+        ...
+    }
+
+All message type and attribute names must be valid C identifiers. Valid attribute types are:
+
+    int     64 bit signed integer
+    float   64 bit float
+    string  C string
+    raw     Raw bytes
+
+== Known Issues
+All clients are servers are assumed to be on machines of the same endianess.

data/bin/protomsg

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'protomsg'
+
+unless ARGV.size == 1
+  puts "Usage: protomsg input_file"
+else
+  Protomsg.parse_file(ARGV[0])
+end

data/lib/protomsg/attribute.rb

@@ -0,0 +1,44 @@
+module Protomsg
+  class Attribute
+    VALID_TYPES = %w{int float string raw}
+    attr_accessor :name, :type
+    
+    def initialize(message_type, definition_line)
+      definition_line =~ /(\w+)\s+(\w+)/ or raise "Invalid attribute definition: '#{definition_line}'"
+      VALID_TYPES.include?($1) or raise "Invalid attribute type: #{$1}"
+      @message_type = message_type
+      @type = $1
+      @name = $2
+    end
+    
+    def getter
+      render_template('getters', 'getter')
+    end
+    
+    def setter
+      render_template('setters', 'setter')
+    end
+    
+    def header_entry
+      render_template('header_entries', 'header_entry')
+    end
+    
+    def finaliser
+      render_template('finalisers', 'finaliser')
+    end
+    
+    def variable_length?
+      %w{string raw}.include?(@type)
+    end
+    
+    def fixed_length?
+      !variable_length?
+    end
+    
+    private
+      def render_template(folder, suffix)
+        path = File.join(File.dirname(__FILE__), '..', 'templates', folder, "#{@type}_#{suffix}.h")
+        ERB.new(File.open(path) {|file| file.read}).result(binding)
+      end
+  end
+end

data/lib/protomsg/message_type.rb

@@ -0,0 +1,50 @@
+module Protomsg
+  class MessageType
+    attr_accessor :type_number, :attributes, :name
+    def initialize(type_number, name, lines)
+      @name         = name
+      @type_number  = type_number
+      lines = lines.split("\n").collect(&:strip).reject(&:empty?)
+      @attributes   = lines.collect {|line| Attribute.new(self, line)}
+    end
+    
+    def variable_attributes
+      @variable_attributes ||= @attributes.select(&:variable_length?)
+    end
+    
+    def header
+      render_template('header')
+    end
+
+    def getters
+      render_template('getters')
+    end
+
+    def setters
+      render_template('setters')
+    end
+
+    def lengths
+      render_template('lengths')
+    end
+
+    def memory
+      render_template('memory')
+    end
+
+    def io
+      render_template('io')
+    end
+    
+    def to_header_file
+      render_template('message_type')
+    end
+    
+    private
+      def render_template(name)
+        path = File.join(File.dirname(__FILE__), '..', 'templates', "#{name}.h")
+        ERB.new(File.open(path){|file| file.read}).result(binding)
+      end
+      
+  end
+end

data/lib/protomsg/parser.rb

@@ -0,0 +1,25 @@
+module Protomsg
+  def self.parse_file(path)
+    File.open(path) do |file|
+      # write the standard protomsg header
+      FileUtils.cp File.join(File.dirname(__FILE__), '..', 'templates', 'protomsg.h'), 'protomsg.h'
+      puts "Created protomsg.h"
+      
+      # extract each message type definition
+      message_types = []
+      data = file.read
+      data.scan(/(\w+)\s*\{([^\}]+)\}/) do |message_type|
+        message_types << MessageType.new(message_types.size + 1, message_type[0], message_type[1])
+      end
+      
+      # write out each message type's header file
+      message_types.each do |message_type|
+        header_name = "#{message_type.name}_message.h"
+        File.open(header_name, 'w') do |file|
+          file.write message_type.to_header_file
+        end
+        puts "Created #{header_name}"
+      end
+    end
+  end
+end

data/lib/protomsg.rb

@@ -0,0 +1,6 @@
+require 'fileutils'
+require 'erb'
+
+require 'protomsg/message_type'
+require 'protomsg/attribute'
+require 'protomsg/parser'

data/lib/templates/finalisers/raw_finaliser.h

@@ -0,0 +1 @@
+if(msg-><%= @name %>){free(msg-><%= @name %>);}\

data/lib/templates/finalisers/string_finaliser.h

@@ -0,0 +1 @@
+if(msg-><%= @name %>){free(msg-><%= @name %>);}\

data/lib/templates/getters/float_getter.h

@@ -0,0 +1 @@
+#define get_<%= @message_type.name %>_<%= @name %>(msg) (msg->header-><%= @name %>)

data/lib/templates/getters/int_getter.h

@@ -0,0 +1 @@
+#define get_<%= @message_type.name %>_<%= @name %>(msg) (msg->header-><%= @name %>)

data/lib/templates/getters/raw_getter.h

@@ -0,0 +1 @@
+#define get_<%= @message_type.name %>_<%= @name %>(msg) (msg-><%= @name %>)

data/lib/templates/getters/string_getter.h

@@ -0,0 +1 @@
+#define get_<%= @message_type.name %>_<%= @name %>(msg) (msg-><%= @name %>)

data/lib/templates/getters.h

@@ -0,0 +1 @@
+<% @attributes.each do |attr|%><%= attr.getter %><% end%>

data/lib/templates/header.h

@@ -0,0 +1,12 @@
+typedef struct {
+  char  _version;
+  char  _type;<% @attributes.each do |attr|%>
+  <%= attr.header_entry %><% end %>
+} <%= @name %>_header;
+
+typedef struct {
+  <%= @name %>_header *header;
+  size_t  header_length;<% variable_attributes.each do |attr| %>
+  void    *<%= attr.name %>;
+  size_t  <%= attr.name %>_length;<% end %>
+} <%= @name %>;

data/lib/templates/header_entries/float_header_entry.h

@@ -0,0 +1 @@
+double <%= @name %>;

data/lib/templates/header_entries/int_header_entry.h

@@ -0,0 +1 @@
+long long <%= @name %>;

data/lib/templates/header_entries/raw_header_entry.h

@@ -0,0 +1 @@
+int <%= @name %>_length;

data/lib/templates/header_entries/string_header_entry.h

@@ -0,0 +1 @@
+int <%= @name %>_length;

data/lib/templates/io.h

@@ -0,0 +1,18 @@
+#define write_<%= @name %>(msg, sock, error) {\
+  ssize_t written = writev(sock, (const struct iovec *)msg, <%= variable_attributes.size + 1 %>);\
+  if(written != <%= @name %>_length(msg)){\
+    error = errno;\
+  }\
+}
+
+#define read_<%= @name %>(msg, sock, error) {\
+  msg = (<%= @name %> *) malloc(sizeof(<%= @name %>));\
+  msg->header_length = sizeof(<%= @name %>_header);\
+  msg->header = (<%= @name %>_header *)malloc(sizeof(<%= @name %>_header));\
+  read_struct(sock, msg->header, sizeof(<%= @name %>_header), error);\
+  if(error == 0) {\
+    <% variable_attributes.each do |attr| %>msg-><%= attr.name %>_length = msg->header-><%= attr.name %>_length;\
+    msg-><%= attr.name %> = malloc(msg->header-><%= attr.name %>_length);\
+    <% end %>readv(sock, (const struct iovec *)msg + 1, <%= variable_attributes.size %>);\
+  }\
+}

data/lib/templates/lengths.h

@@ -0,0 +1,2 @@
+<% variable_attributes.each do |attr| %>#define <%= @name %>_<%= attr.name %>_length(msg) (msg-><%= attr.name %>_length)
+<% end %>#define <%= @name %>_length(msg) (msg->header_length + <%= variable_attributes.collect {|attr| "msg->#{attr.name}_length"}.join(" + ") %>)

data/lib/templates/memory.h

@@ -0,0 +1,13 @@
+#define init_<%= @name %>(msg) {\
+  msg = (<%= @name %> *) calloc(1, sizeof(<%= @name %>));\
+  msg->header = (<%= @name %>_header *) calloc(1, sizeof(<%= @name %>_header));\
+  msg->header->_version = PROTO_MESSAGE_VERSION;\
+  msg->header->_type = <%= @name.upcase %>_MESSAGE_TYPE;\
+  msg->header_length = sizeof(<%= @name %>_header);\
+}
+
+#define free_<%= @name %>(msg) {\<% variable_attributes.each do |attr| %>
+  <%= attr.finaliser %><% end %>
+  free(msg->header);\
+  free(msg);\
+}

data/lib/templates/message_type.h

@@ -0,0 +1,25 @@
+#include <stdlib.h>
+#include <stdio.h>
+#include <string.h>
+#include <errno.h>
+#include <sys/socket.h>
+#include <sys/types.h>
+#include <arpa/inet.h>
+#include <sys/uio.h>
+#include <unistd.h>
+#include "protomsg.h"
+
+#define <%= @name.upcase %>_MESSAGE_TYPE  <%= @type_number %>
+
+<%= header %>
+
+// getters
+<%= getters %>
+// setters
+<%= setters %>
+// lengths
+<%= lengths %>
+// memory
+<%= memory %>
+// io
+<%= io %>

data/lib/templates/protomsg.h

@@ -0,0 +1,21 @@
+#include <stdio.h>
+
+#ifndef __protomsg__
+#define __protomsg__
+
+#define PROTO_MESSAGE_VERSION 1
+#define read_struct(sock, structure, size, error) {\
+  ssize_t bytes_read = 0, bytes_total = 0;\
+  error = 0;\
+  while(bytes_total < size) {\
+    bytes_read = read(sock, structure + bytes_total, size - bytes_total);\
+    if(bytes_read != -1) {\
+      bytes_total += bytes_read;\
+    } else {\
+      error = errno;\
+      bytes_total = size;\
+    }\
+  }\
+}
+
+#endif

data/lib/templates/setters/float_setter.h

@@ -0,0 +1 @@
+#define set_<%= @message_type.name %>_<%= @name %>(msg, val) {msg->header-><%= @name %> = val;}

data/lib/templates/setters/int_setter.h

@@ -0,0 +1 @@
+#define set_<%= @message_type.name %>_<%= @name %>(msg, val) {msg->header-><%= @name %> = val;}

data/lib/templates/setters/raw_setter.h

@@ -0,0 +1,4 @@
+#define set_<%= @message_type.name %>_<%= @name %>(msg, val, length) {\
+  msg-><%= @name %> = val;\
+  msg-><%= @name %>_length = msg->header-><%= @name %>_length = length;\
+}

data/lib/templates/setters/string_setter.h

@@ -0,0 +1,4 @@
+#define set_<%= @message_type.name %>_<%= @name %>(msg, val) {\
+  msg-><%= @name %> = val;\
+  msg-><%= @name %>_length = msg->header-><%= @name %>_length = (val) ? (strlen(val) + 1) : 0;\
+}

data/lib/templates/setters.h

@@ -0,0 +1 @@
+<% @attributes.each do |attr| %><%= attr.setter %><% end %>

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'protomsg'
+
+class Test::Unit::TestCase
+end

data/test/test_protomsg.rb

@@ -0,0 +1,4 @@
+require 'helper'
+
+class TestProtomsg < Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: protomsg
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
+platform: ruby
+authors: 
+- Will Cannings
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-05 00:00:00 +10:00
+default_executable: protomsg
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Protocol Message Buffers for C. This gem generates C socket code for reading and writing messages described in the protomsg DSL.
+email: me@willcannings.com
+executables: 
+- protomsg
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- bin/protomsg
+- lib/protomsg.rb
+- lib/protomsg/attribute.rb
+- lib/protomsg/message_type.rb
+- lib/protomsg/parser.rb
+- lib/templates/finalisers/raw_finaliser.h
+- lib/templates/finalisers/string_finaliser.h
+- lib/templates/getters.h
+- lib/templates/getters/float_getter.h
+- lib/templates/getters/int_getter.h
+- lib/templates/getters/raw_getter.h
+- lib/templates/getters/string_getter.h
+- lib/templates/header.h
+- lib/templates/header_entries/float_header_entry.h
+- lib/templates/header_entries/int_header_entry.h
+- lib/templates/header_entries/raw_header_entry.h
+- lib/templates/header_entries/string_header_entry.h
+- lib/templates/io.h
+- lib/templates/lengths.h
+- lib/templates/memory.h
+- lib/templates/message_type.h
+- lib/templates/protomsg.h
+- lib/templates/setters.h
+- lib/templates/setters/float_setter.h
+- lib/templates/setters/int_setter.h
+- lib/templates/setters/raw_setter.h
+- lib/templates/setters/string_setter.h
+- LICENSE
+- README.rdoc
+- test/helper.rb
+- test/test_protomsg.rb
+has_rdoc: true
+homepage: http://github.com/willcannings/protomsg
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Protocol Message Buffers for C
+test_files: 
+- test/helper.rb
+- test/test_protomsg.rb