gmsec 0.0.1

data/lib/gmsec/field.rb

@@ -0,0 +1,231 @@
+class GMSEC::Field
+  extend GMSEC::API
+
+  bind :GMSEC_FIELD_OBJECT do |pointer|
+     gmsec_CreateField(pointer, status)
+  end
+
+  has :status
+
+  # Map GMSEC values to deftypes. Note that we list backward compatible aliases first.
+  GMSEC_TYPEDEF = {
+    GMSEC_TYPE_DOUBLE => :double,
+    GMSEC_TYPE_FLOAT  => :float,
+    GMSEC_TYPE_LONG   => :long,
+    GMSEC_TYPE_SHORT  => :short,
+    GMSEC_TYPE_ULONG  => :ulong,
+    GMSEC_TYPE_USHORT => :ushort,
+    GMSEC_TYPE_BOOL   => :bool,
+    GMSEC_TYPE_CHAR   => :char,
+    GMSEC_TYPE_F32    => :f32,
+    GMSEC_TYPE_F64    => :f64,
+    GMSEC_TYPE_I16    => :i16,
+    GMSEC_TYPE_I32    => :i32,
+    GMSEC_TYPE_STR    => :str,
+    GMSEC_TYPE_U16    => :u16,
+    GMSEC_TYPE_U32    => :u32,
+    GMSEC_TYPE_UNSET  => :unset}
+
+  TYPE_TO_GMSEC_VALUE = {
+    bool:    GMSEC_TYPE_BOOL,
+    char:    GMSEC_TYPE_CHAR,
+    double:  GMSEC_TYPE_DOUBLE,
+    f32:     GMSEC_TYPE_F32,
+    f64:     GMSEC_TYPE_F64,
+    float:   GMSEC_TYPE_FLOAT,
+    i16:     GMSEC_TYPE_I16,
+    i32:     GMSEC_TYPE_I32,
+    long:    GMSEC_TYPE_LONG,
+    short:   GMSEC_TYPE_SHORT,
+    str:     GMSEC_TYPE_STR,
+    u16:     GMSEC_TYPE_U16,
+    u32:     GMSEC_TYPE_U32,
+    ulong:   GMSEC_TYPE_ULONG,
+    unset:   GMSEC_TYPE_UNSET,
+    ushort:  GMSEC_TYPE_USHORT}
+
+  RUBY_TO_GMSEC_TYPE = {
+     FalseClass => :bool,
+     Fixnum     => :i32,
+     Float      => :double,
+     String     => :str,
+     Symbol     => :str,
+     TrueClass  => :bool}
+
+  def initialize(name=nil, value=nil, type: nil)
+    if name
+      self.name = name
+    end
+
+    if type
+      self.type = type
+    end
+
+    if value
+      self.value = value
+    end
+  end
+
+  def name
+    with_string_pointer do |pointer|
+      gmsec_GetFieldName(self, pointer, status)
+    end
+  end
+
+  def name=(value)
+    gmsec_SetFieldName(self, value.to_s, status)
+  end
+
+  def value
+    field_type = "GMSEC_#{type.to_s.upcase}".to_sym
+    pointer = FFI::MemoryPointer.new(find_type(field_type))
+    send(get_field_value_method, self, pointer, status)
+    read_pointer_value(pointer)
+  end
+
+  def value=(value)
+    if type == :unset
+      # Guess what GMSEC type value is.
+      self.type = RUBY_TO_GMSEC_TYPE[value.class]
+    end
+
+    # Determind method on value type
+    method = "gmsec_SetFieldValue#{type.to_s.upcase}"
+
+    # Cast value based on value type.
+    value = case value
+            when Symbol
+              value.to_s
+            when TrueClass, FalseClass
+              value ? 1 : 0
+            else
+              value
+            end
+
+    # Cast value based on target type.
+    value = case type
+            when :bool
+              value ? 1 : 0
+            when :i16, :i32, :u16, :u32
+              value.to_i
+            when :f32, :f64
+              value.to_f
+            when :char
+              value.ord
+            when :str
+              value.to_s
+            else
+              raise RuntimeError.new("Error in assigning value to field: type '#{type}' not supported")
+            end
+
+    send(method, self, value, status)
+  end
+
+  def type
+    # Create a pointer to GMSEC_TYPE that we're going to read and convert to a symbol.
+    pointer = FFI::MemoryPointer.new(find_type(:GMSEC_TYPE))
+
+    gmsec_GetFieldType(self, pointer, status)
+
+    # Default to GMSEC_STR if type is not registered in GMSEC_DEF
+    GMSEC_TYPEDEF[pointer.read_ushort] || :str
+  end
+
+  def type=(type)
+    if type.nil?
+      raise TypeError.new("#{value.class} is not supported as a GMSEC type.")
+    end
+
+    field_type = TYPE_TO_GMSEC_VALUE[type]
+    gmsec_SetFieldType(self, field_type, status)
+
+    if status.is_error?
+      raise RuntimeError.new("Error in specifying type '#{type}': #{status}")
+    end
+  end
+
+  protected
+
+  def get_field_value_method
+    "gmsec_GetFieldValue#{type.to_s.upcase.split("_").last}"
+  end
+
+  def read_pointer_value(pointer)
+    case type
+    when :char
+      pointer.read_string(1)
+    when :bool
+      pointer.read_int == self.class.enum_type(:GMSEC_BOOL)[:GMSEC_TRUE]
+    when :short
+      pointer.read_short
+    when :ushort
+      pointer.read_ushort
+    when :long
+      pointer.read_long
+    when :double
+      pointer.read_double
+    when :str
+      pointer.read_pointer.read_string_to_null
+    when :i16
+      pointer.read_int16
+    when :i32
+      pointer.read_int32
+    when :i64
+      pointer.read_int64
+    when :u16
+      pointer.read_uint16
+    when :u32
+      pointer.read_uint32
+    when :f32, :float
+      pointer.read_float
+    when :f64
+      pointer.read_double
+    else
+      raise TypeError.new("#{type} is not a supported type.")
+    end
+  end
+
+  attach_function :gmsec_CreateField, [:pointer, GMSEC::Status], :void
+  attach_function :gmsec_DestroyField, [:pointer, GMSEC::Status], :void
+  attach_function :gmsec_GetFieldName, [self, :pointer, GMSEC::Status], :void
+  attach_function :gmsec_SetFieldName, [self, :string, GMSEC::Status], :void
+  attach_function :gmsec_SetFieldType, [self, :GMSEC_TYPE, GMSEC::Status], :void
+  attach_function :gmsec_GetFieldType, [self, :pointer, GMSEC::Status], :void
+  attach_function :gmsec_GetFieldValueCHAR, [self, :pointer, GMSEC::Status], :void
+  attach_function :gmsec_GetFieldValueBOOL, [self, :pointer, GMSEC::Status], :void
+  attach_function :gmsec_GetFieldValueSHORT, [self, :pointer, GMSEC::Status], :void
+  attach_function :gmsec_GetFieldValueUSHORT, [self, :pointer, GMSEC::Status], :void
+  attach_function :gmsec_GetFieldValueLONG, [self, :pointer, GMSEC::Status], :void
+  attach_function :gmsec_GetFieldValueULONG, [self, :pointer, GMSEC::Status], :void
+  attach_function :gmsec_GetFieldValueFLOAT, [self, :pointer, GMSEC::Status], :void
+  attach_function :gmsec_GetFieldValueDOUBLE, [self, :pointer, GMSEC::Status], :void
+  attach_function :gmsec_GetFieldValueSTRING, [self, :pointer, GMSEC::Status], :void
+  attach_function :gmsec_GetFieldValueSTR, [self, :pointer, GMSEC::Status], :void
+  attach_function :gmsec_GetFieldValueI16, [self, :pointer, GMSEC::Status], :void
+  attach_function :gmsec_GetFieldValueU16, [self, :pointer, GMSEC::Status], :void
+  attach_function :gmsec_GetFieldValueI32, [self, :pointer, GMSEC::Status], :void
+  attach_function :gmsec_GetFieldValueU32, [self, :pointer, GMSEC::Status], :void
+  attach_function :gmsec_GetFieldValueF32, [self, :pointer, GMSEC::Status], :void
+  attach_function :gmsec_GetFieldValueF64, [self, :pointer, GMSEC::Status], :void
+  attach_function :gmsec_GetFieldValueSTRING, [self, :pointer, GMSEC::Status], :void
+  attach_function :gmsec_GetFieldValueI64, [self, :pointer, GMSEC::Status], :void
+  attach_function :gmsec_SetFieldValueCHAR, [self, :GMSEC_CHAR, GMSEC::Status], :void
+  attach_function :gmsec_SetFieldValueBOOL, [self, :GMSEC_BOOL, GMSEC::Status], :void
+  attach_function :gmsec_SetFieldValueSHORT, [self, :GMSEC_SHORT, GMSEC::Status], :void
+  attach_function :gmsec_SetFieldValueUSHORT, [self, :GMSEC_USHORT, GMSEC::Status], :void
+  attach_function :gmsec_SetFieldValueLONG, [self, :GMSEC_LONG, GMSEC::Status], :void
+  attach_function :gmsec_SetFieldValueULONG, [self, :GMSEC_ULONG, GMSEC::Status], :void
+  attach_function :gmsec_SetFieldValueFLOAT, [self, :GMSEC_FLOAT, GMSEC::Status], :void
+  attach_function :gmsec_SetFieldValueDOUBLE, [self, :GMSEC_DOUBLE, GMSEC::Status], :void
+  attach_function :gmsec_SetFieldValueSTRING, [self, :GMSEC_STR, GMSEC::Status], :void
+  attach_function :gmsec_SetFieldValueSTR, [self, :GMSEC_STR, GMSEC::Status], :void
+  attach_function :gmsec_SetFieldValueI16, [self, :GMSEC_I16, GMSEC::Status], :void
+  attach_function :gmsec_SetFieldValueU16, [self, :GMSEC_U16, GMSEC::Status], :void
+  attach_function :gmsec_SetFieldValueI32, [self, :GMSEC_I32, GMSEC::Status], :void
+  attach_function :gmsec_SetFieldValueU32, [self, :GMSEC_U32, GMSEC::Status], :void
+  attach_function :gmsec_SetFieldValueF32, [self, :GMSEC_F32, GMSEC::Status], :void
+  attach_function :gmsec_SetFieldValueF64, [self, :GMSEC_F64, GMSEC::Status], :void
+  attach_function :gmsec_SetFieldValueI64, [self, :GMSEC_I64, GMSEC::Status], :void
+  attach_function :gmsec_UnSetField, [self, GMSEC::Status], :void
+  attach_function :gmsec_LookupFieldType, [:string], :GMSEC_TYPE
+end

data/lib/gmsec/message.rb

@@ -0,0 +1,211 @@
+class GMSEC::Message
+  extend GMSEC::API
+
+  has :status
+
+  bind :GMSEC_MESSAGE_OBJECT
+
+  def load_fields_from_config_file(config_file, message_name)
+    config_file.get_message(message_name, message: self)
+  end
+
+  def type
+    pointer = FFI::MemoryPointer.new(find_type(:GMSEC_MSG_KIND))
+    gmsec_GetMsgKind(self, pointer, status)
+
+    if status.is_error?
+      raise RuntimeError.new("Error getting message type: #{status}")
+    end
+
+    case pointer.read_ushort
+    when GMSEC_MSG_PUBLISH
+      :publish
+    when GMSEC_MSG_REPLY
+      :reply
+    when GMSEC_MSG_REQUEST
+      :request
+    when GMSEC_MSG_UNSET
+      :unset
+    else
+      raise TypeError.new("Unrecognized GMSEC data type")
+    end
+  end
+
+  def type=(type)
+    value = case type
+            when :publish
+              GMSEC_MSG_PUBLISH
+            when :reply
+              GMSEC_MSG_REPLY
+            when :request
+              GMSEC_MSG_REQUEST
+            when :unset
+              GMSEC_MSG_REQUEST
+            else
+              raise TypeError.new("#{type} is not supported as a GMSEC type.")
+            end
+
+    gmsec_SetMsgKind(self, value, status)
+
+    if status.is_error?
+      raise RuntimeError.new("Error setting message type: #{status}")
+    end
+  end
+
+  def subject
+    with_string_pointer do |pointer|
+      gmsec_GetMsgSubject(self, pointer, status)
+
+      if status.is_error?
+        raise RuntimeError.new("Error getting message subject: #{status}")
+      end
+    end
+  end
+
+  def subject=(subject)
+    gmsec_SetMsgSubject(self, subject, status)
+
+    if status.is_error?
+      raise RuntimeError.new("Error setting message subject: #{status}")
+    end
+  end
+
+  def config=(config)
+    gmsec_MsgSetConfig(self, config, status)
+
+    if status.is_error?
+      raise RuntimeError.new("Error setting message config: #{status}")
+    end
+  end
+
+  def clear_fields
+    gmsec_MsgClearFields(self, status)
+
+    if status.is_error?
+      raise RuntimeError.new("Error clearing message fields: #{status}")
+    end
+  end
+
+  def clear_field(name)
+    gmsec_MsgClearField(self, name.to_s, status)
+
+    if status.is_error?
+      raise RuntimeError.new("Error clearing message field: #{status}")
+    end
+  end
+
+  def [](name)
+    field = GMSEC::Field.new
+    gmsec_MsgGetField(self, name.to_s, field, status)
+
+    case status.code
+    when GMSEC_STATUS_NO_ERROR
+      field.value
+    when !GMSEC_INVALID_FIELD_NAME
+      raise RuntimeError.new("Error getting message field: #{status}")
+    end
+  end
+
+  def []=(name, value)
+    self << GMSEC::Field.new(name, value)
+  end
+
+  def <<(data)
+    # We can append a single Field or multiple fields encapsulated as a Hash.
+    if data.is_a? GMSEC::Field
+      gmsec_MsgAddField(self, data, status)
+    elsif data.is_a? Hash
+      data.each do |key, value|
+        self << GMSEC::Field.new(key, value)
+      end
+    elsif data
+      raise TypeError.new("#{data.class} is not supported as a GMSEC field type.")
+    end
+
+    if status.is_error?
+      raise RuntimeError.new("Error adding data to message: #{status}")
+    end
+  end
+
+  def length
+    pointer = FFI::MemoryPointer.new(find_type(:GMSEC_I32))
+    gmsec_MsgGetFieldCount(self, pointer, status)
+    pointer.read_int32
+  end
+
+  def fields
+    Enumerator.new do |y|
+      field = GMSEC::Field.new
+      gmsec_MsgGetFirstField(self, field, status)
+
+      while status.code != GMSEC_FIELDS_END_REACHED && status.code == GMSEC_STATUS_NO_ERROR
+        y << field
+        gmsec_MsgGetNextField(self, field, status)
+      end
+
+      unless status.code == GMSEC_FIELDS_END_REACHED
+        raise RuntimeError.new("Error reading message fields: #{status}")
+      end
+    end
+  end
+
+  def to_s
+    ::Terminal::Table.new(title: subject, rows: to_h)
+  end
+
+  def to_h
+    Hash[fields.map{|field| [field.name, field.value]}]
+  end
+
+  def to_xml
+    with_string_pointer do |pointer|
+      gmsec_MsgToXML(self, pointer, status)
+
+      if status.is_error?
+        raise RuntimeError.new("Error converting message to xml: #{status}")
+      end
+    end
+  end
+
+  def from_xml(xml)
+    gmsec_MsgFromXML(self, xml, status).tap do |_|
+      if status.is_error?
+        raise RuntimeError.new("Error converting xml to message: #{status}")
+      end
+    end
+  end
+
+  def size
+    pointer = FFI::MemoryPointer.new(find_type(:GMSEC_U32))
+    gmsec_MsgGetSize(self, pointer, status)
+    pointer.read_uint32
+  end
+
+  def time
+    gmsec_MsgGetTime
+  end
+
+  def valid?
+    gmsec_isMsgValid(self) == self.class.enum_type(:GMSEC_BOOL)[:GMSEC_TRUE]
+  end
+
+  protected
+
+  attach_function :gmsec_SetMsgKind, [self, :GMSEC_MSG_KIND, GMSEC::Status], :void
+  attach_function :gmsec_GetMsgKind, [self, :pointer, GMSEC::Status], :void
+  attach_function :gmsec_SetMsgSubject, [self, :string, GMSEC::Status], :void
+  attach_function :gmsec_GetMsgSubject, [self, :pointer, GMSEC::Status], :void
+  attach_function :gmsec_MsgSetConfig, [self, GMSEC::Config, GMSEC::Status], :void
+  attach_function :gmsec_MsgClearFields, [self, GMSEC::Status], :void
+  attach_function :gmsec_MsgAddField, [self, GMSEC::Field, GMSEC::Status], :void
+  attach_function :gmsec_MsgClearField, [self, :string, GMSEC::Status], :void
+  attach_function :gmsec_MsgGetField, [self, :string, GMSEC::Field, GMSEC::Status], :void
+  attach_function :gmsec_MsgGetFieldCount, [self, :pointer, GMSEC::Status], :void
+  attach_function :gmsec_MsgGetFirstField, [self, GMSEC::Field, GMSEC::Status], :void
+  attach_function :gmsec_MsgGetNextField, [self, GMSEC::Field, GMSEC::Status], :void
+  attach_function :gmsec_MsgToXML, [self, :pointer, GMSEC::Status], :void
+  attach_function :gmsec_MsgFromXML, [self, :string, GMSEC::Status], :void
+  attach_function :gmsec_MsgGetSize, [self, :pointer, GMSEC::Status], :void
+  attach_function :gmsec_MsgGetTime, [], :string
+  attach_function :gmsec_isMsgValid, [self], :int
+end

data/lib/gmsec/status.rb

@@ -0,0 +1,30 @@
+class GMSEC::Status
+  extend GMSEC::API
+
+  bind :GMSEC_STATUS_OBJECT do |pointer|
+    gmsec_CreateStatus(pointer)
+  end
+
+  def is_error?
+    gmsec_isStatusError(self) > 0
+  end
+
+  def to_s
+    gmsec_GetStatusString(self)
+  end
+
+  def code
+    gmsec_GetStatusCode(self)
+  end
+
+  protected
+
+  attach_function :gmsec_CreateStatus, [:pointer], :void
+  attach_function :gmsec_DestroyStatus, [:pointer], :void
+  attach_function :gmsec_GetStatus, [self], :string
+  attach_function :gmsec_GetStatusString, [self], :string
+  attach_function :gmsec_GetStatusClass, [self], find_type(:GMSEC_STATUS_CLASS)
+  attach_function :gmsec_GetStatusCode, [self], :uint
+  attach_function :gmsec_GetStatusCustomCode, [self], :int
+  attach_function :gmsec_isStatusError, [self], :int
+end