rubywmq 0.3.0

data/ext/extconf_client.rb

@@ -0,0 +1,40 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+################################################################################
+
+#
+# NOTE:  Do NOT use this file unless the platform being requested is not supported
+#        directly by Ruby WMQ. Ruby WMQ already supports automatic dynamic loading on
+#        Windows, Solaris and Linux
+#
+require 'mkmf'
+require '../../generate/generate_reason'
+require '../../generate/generate_const'
+require '../../generate/generate_structs'
+
+include_path = ''
+unless (RUBY_PLATFORM =~ /win/i) || (RUBY_PLATFORM =~ /solaris/i) || (RUBY_PLATFORM =~ /linux/i)
+  include_path = '/opt/mqm/inc'
+  dir_config('mqm', include_path, '/opt/mqm/lib')
+  have_library('mqic')
+  
+  # Generate Source Files # Could check if not already present
+  GenerateReason.generate(include_path+'/')
+  GenerateConst.generate(include_path+'/', '../../lib/wmq')
+  GenerateStructs.new(include_path+'/', '../../generate').generate
+  
+  have_header('cmqc.h')
+  create_makefile('wmq_client')
+end

data/ext/generate/generate_const.rb

@@ -0,0 +1,167 @@
+class GenerateConst
+  
+  #Extract Constants from Header files  
+  def GenerateConst.extract_const(filename, const_prefix, start_exp=nil, end_exp=nil)
+    @constants = []
+    active = if start_exp then false else true end    # Sure there is a better way
+    File.open(filename) do |file|
+      file.each do |line|
+        line.rstrip!
+        if line.length > 0   # Skip empty lines
+          if active
+            break if start_exp && line.match(end_exp)
+            # Skip Comment lines, then check for a match
+            if (line !~ /^\s*\/\*/) && (match = /\s*#define\s+(#{const_prefix}\w+)[\(\s]+([-\\\w\dx\'\"\s]+)/.match(line))
+              @constants << [match[1], match[2]]
+            end
+          else
+            next unless line.match(start_exp)
+            active = true
+          end
+        end
+      end
+    end
+    @constants
+  end
+  
+  #Extract MQ Constants from Header files  
+  def GenerateConst.rb_const(filename, const_prefix, exclude_exp=nil)
+    str = ''
+    GenerateConst.extract_const(filename, const_prefix).each do |item|
+      const, val = item
+      next if const.include?('_STRUC_ID')
+      next if exclude_exp && const.match(exclude_exp)
+      if val.include?('"') || val.include?("'")
+        if match = val.match(/(\w+)/)
+          val = "'#{match[0]}'"
+        else
+          val = "''"
+        end
+      end
+      str << "   %-30s = #{val}\n" % const
+    end
+    str
+  end
+  
+  def GenerateConst.config(filename, prefix)
+    str = "# WMQ::QueueManager execute commands\n"
+    str << "execute_commands:\n"
+    GenerateConst.extract_const(filename,prefix).each do |item|
+      name = item[0].gsub(prefix,'').downcase
+      str << "  :%-26s " % "#{name}:"
+      match = name.match(/\w+?_([\w_]+)/)
+      str << ":#{match[1]}" if match
+      str << "\n"
+    end
+    str
+  end
+  
+  def GenerateConst.wmq_const(path)
+    str = <<END_OF_STRING
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+################################################################################
+#
+#  WARNING: DO NOT MODIFY THIS FILE
+#
+#  This file was generated by generate_const.rb.
+#
+################################################################################
+module WMQ
+END_OF_STRING
+    [ ['Connect Options','cmqc.h','MQCNO_',/(VERSION)|(CONN_TAG)|(HANDLE_SHARE)/],
+      ['Open Options', 'cmqc.h','MQOO_' ],
+      ['Close Options', 'cmqc.h','MQCO_'],
+      ['Match Options', 'cmqc.h','MQMO_'],
+      ['Message Format Options', 'cmqc.h','MQFMT_',/(_ARRAY)/],
+      ['Get Message Options', 'cmqc.h','MQGMO_',/(VERSION)/],
+      ['Transport Types', 'cmqxc.h','MQXPT_'] ,
+      ['Report Options', 'cmqc.h', 'MQRO_'],
+      ['Message Types', 'cmqc.h', 'MQMT_'],
+      ['Expiry', 'cmqc.h', 'MQEI_'],
+      ['Feedback Values', 'cmqc.h', 'MQFB_'],
+      ['Encoding Values', 'cmqc.h', 'MQENC_'],
+      ['Coded Character Set Identifiers', 'cmqc.h', 'MQCCSI_'],
+      ['Priority', 'cmqc.h', 'MQPRI_'],
+      ['Persistence', 'cmqc.h', 'MQPER_'],
+      ['Put Application Types', 'cmqc.h', 'MQAT_'],
+      ['Message Flags', 'cmqc.h', 'MQMF_'],
+      ['Original Length', 'cmqc.h', 'MQOL_'],
+      ['Put Message Options', 'cmqc.h', 'MQPMO_',/(VERSION)|(LENGTH)/],
+      ['Put Message Record Fields', 'cmqc.h', 'MQPMRF_',/(VERSION)|(LENGTH)/],
+      ['Reason Codes', 'cmqc.h','MQRC_'],
+      ].each do |item|
+      str << "\n# #{item[0]}\n"
+      str << GenerateConst.rb_const("#{path}/#{item[1]}", item[2], item[3])
+    end
+    str << "end\n"
+  end
+  
+  def GenerateConst.admin_consts(path)
+    str = <<END_OF_STRING
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+################################################################################
+#
+#  WARNING: DO NOT MODIFY THIS FILE
+#
+#  This file was generated by generate_const.rb.
+#
+################################################################################
+module WMQ
+END_OF_STRING
+    str << "# Admin constants from cmqc.h\n"
+    [ ['Object Types', 'cmqc.h', 'MQOT_'],
+      ['Security Identifier Types', 'cmqc.h', 'MQSIDT_'],
+      ['Channel Types', 'cmqxc.h', 'MQCHT_'],
+      ].each do |item|
+      str << "\n# #{item[0]}\n"
+      str << GenerateConst.rb_const("#{path}/#{item[1]}", item[2], item[3])
+    end
+    GenerateConst.extract_const(path+'cmqc.h', 'MQ', /Queue\sAttributes/, /typedef/).each do |item|
+      str << "   %-30s = #{item[1]}\n" % item[0]
+    end
+    str << "# Admin constants from cmqcfc.h\n"
+    GenerateConst.extract_const(path+'cmqcfc.h', 'MQ', /Parameter\s+Values/, /typedef\s+struct/).each do |item|
+      str << "   %-30s = #{item[1]}\n" % item[0]
+    end
+    str << "end\n"
+  end
+  
+  def self.generate(path, target_path='')
+    File.open(File.join(target_path,'wmq_const_admin.rb'), 'w') {|file| file.write(GenerateConst.admin_consts(path))}
+    puts 'Generated wmq_const_admin.rb'
+    File.open(File.join(target_path,'wmq_const.rb'), 'w') {|file| file.write(GenerateConst.wmq_const(path))}
+    puts 'Generated wmq_const.rb'
+  end
+end  
+
+if $0 == __FILE__
+  path = ARGV[0] || raise("Mandatory parameter: 'WebSphere MQ Include path' is missing")
+  path = path + '/'
+  GenerateConst.generate(path)
+end

data/ext/generate/generate_reason.rb

@@ -0,0 +1,240 @@
+class GenerateReason
+
+  #Extract Error Code Constants from Header files  
+  def GenerateReason.extract_const(filename, const_prefix)
+    @constants = []
+    File.open(filename) do |file|
+      file.each do |line|
+        line.rstrip!
+        # Skip empty and comment lines
+        if line.length > 0 && line !~ /^\s*\/\*/
+          if match = /\s*#define\s+(#{const_prefix}\w+)[\(\s]+([-\dx]+)/.match(line)
+            @constants << [match[1], match[2]]
+          end
+        end
+      end
+    end
+    @constants
+  end
+  
+  #Extract Error Code Constants from Header files  
+  # Uses lazy print to collect duplicate values
+  def GenerateReason.reason_case(filename, prefix)
+    last_rc = nil
+    last_reason = nil
+    str = ''
+    GenerateReason.extract_const(filename,prefix).each do |item|
+      if last_rc == item[1]
+        str << "        case %-30s: return \"#{item[0]} or #{last_reason}[#{item[1]}]\";\n" % item[0]
+        last_rc = nil
+        last_reason = nil
+      else
+        str << "        case %-30s: return \"#{last_reason}[#{last_rc}]\";\n" % last_reason if last_rc
+        last_rc = item[1]
+        last_reason = item[0]
+      end
+    end
+    str
+  end
+  
+# The WebSphere MQ header files have several duplicate values, 
+# so need to exclude duplicates.
+  def GenerateReason.selector_case(filename, prefix, excludes=nil, &block)
+    GenerateReason.extract_const(filename,prefix).each do |item|
+      next if item[0].include?('FIRST') || item[0].include?('LAST')
+      next if excludes && excludes.include?(item[0])
+      block.call item
+    end
+  end
+  
+  def GenerateReason.wmq_reason(path)
+    str = <<END_OF_STRING
+/* --------------------------------------------------------------------------
+ *  Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ * --------------------------------------------------------------------------
+ *
+ *  WARNING: DO NOT MODIFY THIS FILE
+ *
+ *  This file was generated by generate_reason.rb.
+ *
+ * --------------------------------------------------------------------------*/
+
+#include "wmq.h"
+
+char* wmq_reason(MQLONG reason_code)
+{
+    switch (reason_code)
+    {
+END_OF_STRING
+
+    [['cmqc.h', 'MQRC_'],
+     ['cmqcfc.h', 'MQRCCF_']].each do |item|
+      str << GenerateReason.reason_case(path+item[0], item[1])
+    end
+    str << <<END_OF_STRING
+    }
+    printf("WMQ::wmq_reason Unknown Reason code:%ld\\n",reason_code);
+    return "Unknown reason code";
+}
+
+END_OF_STRING
+
+    str_switch = ''
+    str_id_init = ''
+# Integer Selectors for Object Attributes
+    [['cmqc.h', 'MQIA_'],
+     ['cmqcfc.h', 'MQIACF_', ['MQIACF_ERROR_ID',
+                              'MQIACF_QUIESCE']],
+     ['cmqcfc.h', 'MQIACH_', ['MQIACH_CURRENT_SEQ_NUMBER', 
+                              'MQIACH_BYTES_RCVD', 
+                              'MQIACH_BUFFERS_RCVD']],
+     ['cmqcfc.h', 'MQIAMO_'],
+     ['cmqcfc.h', 'MQIAMO64_'],
+# Integer System Selectors
+     ['cmqbc.h', 'MQIASY_'],
+# Character Selectors for Object Attributes
+     ['cmqc.h', 'MQCA_'],
+     ['cmqcfc.h', 'MQCACF_'],
+     ['cmqcfc.h', 'MQCACH_'],
+     ['cmqcfc.h', 'MQCAMO_'],
+# Byte String Selectors for Object Attributes
+     ['cmqc.h', 'MQBA_'],
+     ['cmqcfc.h', 'MQBACF_'],
+# Group Selectors for Object Attributes
+     ['cmqcfc.h', 'MQGACF_'] ].each do |item|
+      str << "/* Constants #{item[1]}* from #{item[0]} */\n"
+      str_switch << "        /* Constants #{item[1]}* from #{item[0]} */\n"
+      str_id_init << "    /* Constants #{item[1]}* from #{item[0]} */\n"
+      GenerateReason.selector_case(path+item[0], item[1], item[2]) do |const|
+        id = const[0].gsub(item[1],'').downcase
+        str_switch << "        case %-30s: return ID_#{id};\n" % const[0]
+        str_id_init << "    ID_%-25s = rb_intern(\"#{id}\");\n" % id
+        str << "static ID ID_#{id};\n"
+      end        
+    end
+
+    str << <<END_OF_STRING
+
+void QueueManager_selector_id_init()
+{
+#{str_id_init}
+}
+
+ID wmq_selector_id(MQLONG selector)
+{
+    switch (selector)
+    {
+#{str_switch}
+    }
+    printf("WMQ::wmq_select_text Unknown Selector:%ld\\n",selector);
+    return rb_intern("unknown_selector_code");
+}
+
+void wmq_selector(ID selector_id, PMQLONG selector_type, PMQLONG selector)
+{
+    *selector_type = MQIT_INTEGER;
+END_OF_STRING
+    first = true
+    str_if = ''
+    str_id_init = ''
+# Integer Selectors for Object Attributes
+    [['cmqc.h',   'MQIA_'],
+     ['cmqcfc.h', 'MQIACF_', ['MQIACF_ERROR_ID',
+                              'MQIACF_QUIESCE']],
+     ['cmqcfc.h', 'MQIACH_', ['MQIACH_CURRENT_SEQ_NUMBER', 
+                              'MQIACH_BYTES_RCVD', 
+                              'MQIACH_BUFFERS_RCVD']],
+     ['cmqcfc.h', 'MQIAMO_'],
+     ['cmqcfc.h', 'MQIAMO64_'],
+# Integer System Selectors
+#     ['cmqbc.h', 'MQIASY_'],
+    ].each do |item|
+      str << "    /* Consteants #{item[1]}* from #{item[0]} */\n"
+      GenerateReason.selector_case(path+item[0], item[1], item[2]) do |const|
+        str << "    if(selector_id == %-32s{ *selector = #{const[0]}; return;}\n" % "ID_#{const[0].gsub(item[1],'').downcase})" 
+      end        
+    end
+    str << "\n    *selector_type = MQIT_STRING;\n\n"
+# Character Selectors for Object Attributes
+    [['cmqc.h',   'MQCA_'],
+     ['cmqcfc.h', 'MQCACF_'],
+     ['cmqcfc.h', 'MQCACH_'],
+     ['cmqcfc.h', 'MQCAMO_'],
+# Byte String Selectors for Object Attributes
+#     ['cmqc.h', 'MQBA_'],
+#     ['cmqcfc.h', 'MQBACF_'],
+# Group Selectors for Object Attributes
+#     ['cmqcfc.h', 'MQGACF_'] 
+    ].each do |item|
+      str << "    /* Constants #{item[1]}* from #{item[0]} */\n"
+      GenerateReason.selector_case(path+item[0], item[1], item[2]) do |const|
+        str << "    if(selector_id == %-32s{ *selector = #{const[0]}; return;}\n" % "ID_#{const[0].gsub(item[1],'').downcase})" 
+      end        
+    end
+
+    str << <<END_OF_STRING
+    
+    rb_raise(rb_eArgError, "WMQ::QueueManager#execute [wmq_selector] Unknown selector supplied");
+}
+
+END_OF_STRING
+      first = true
+      str_if = ''
+      str_id_init = ''
+      GenerateReason.selector_case(path+'cmqcfc.h', 'MQCMD_') do |const|
+        if first
+          first = false
+          str_if << "    "
+        else
+          str_if << "    else "
+        end
+        id = const[0].gsub('MQCMD_','').downcase
+        str_id_init << "    ID_%-25s = rb_intern(\"#{id}\");\n" % id
+        str_if << "if(command_id == %-28s{ command = #{const[0]}; }\n" % "ID_#{const[0].gsub('MQCMD_','').downcase})" 
+        str << "static ID ID_#{id};\n"
+      end        
+    str << <<END_OF_STRING
+
+void QueueManager_command_id_init()
+{
+#{str_id_init}
+}
+
+MQLONG wmq_command_lookup(ID command_id)
+{
+    MQLONG command = 0;
+#{str_if}    
+    else
+    {
+        rb_raise(rb_eArgError, "WMQ::QueueManager#execute [wmq_command_lookup] Unknown command supplied");
+    }
+
+    return command;
+}
+END_OF_STRING
+  str
+  end
+  
+  def self.generate(path)
+    File.open('wmq_reason.c', 'w') {|file| file.write(GenerateReason.wmq_reason(path))}
+    puts 'Generated wmq_reason.c'
+  end
+end
+
+if $0 == __FILE__
+  path = ARGV[0] || raise("Mandatory parameter: 'WebSphere MQ Include path' is missing")
+  path = path + '/'
+  GenerateReason.generate(path)
+end

data/ext/generate/generate_structs.rb

@@ -0,0 +1,99 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+################################################################################
+require 'erb'
+
+class GenerateStructs
+  
+  @@field_ignore_list = [ 'StrucId', 'Version' , 'StrucLength']
+  
+  # Store path to WebSphere MQ Structures
+  def initialize(wmq_includepath, templates_path='.')
+    @path = wmq_includepath
+    @templates_path = templates_path
+  end
+  
+  def extract_struct (filename, struct_name)
+    properties_list = []
+    line_number = 0
+    group_name = nil
+    found = false
+    File.open(filename) do |file|
+      file.each do |line|
+        line_number += 1
+        line.rstrip!
+        # Skip empty and comment lines
+        if line.length > 0 && line !~ /^\s*\/\*/
+          if !found
+            found = true if line =~ /^\s*struct\s*tag#{struct_name}/
+          else
+            return(properties_list) if line =~ /^\s*\};/
+            #puts line
+            match = /\s*(MQ\w+)\s+(\w+);/.match(line)
+            if match
+              type = match[1]
+              element = match[2]
+              properties_list.push([type, element])
+            end
+          end
+        end
+      end
+    end
+    properties_list
+  end
+  
+  def rubyize_name(name)
+    name.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+  
+  def self.test_rubyize_name
+    test = self.new
+    [['a', 'a'],
+    ['A', 'a'],
+    ['Aa', 'aa'],
+    ['AA', 'aa'],
+    ['AaA', 'aa_a'],
+    ['MyFieldName', 'my_field_name'],
+    ['MMyFieldNName', 'm_my_field_n_name'],
+    ['ABCdefGHIjKlMnOPQrSTuvwxYz', 'ab_cdef_gh_ij_kl_mn_op_qr_s_tuvwx_yz']
+    ].each do |item|
+      str = test.rubyize_name(item[0])
+      raise("rubyize_name('#{item[0]}') == #{str} != '#{item[1]})") if str != item[1]
+    end
+  end
+  
+  def generate_structs(erb)
+    erb.result(binding)
+  end
+  
+  def generate(target_filename = 'wmq_structs.c')
+    erb = nil
+    File.open(@templates_path+'/wmq_structs.erb') { |file| erb = ERB.new(file.read) }
+    File.open(target_filename, 'w') {|file| file.write(generate_structs(erb)) }
+    puts "Generated #{target_filename}"
+  end
+end
+
+# TODO Auto Daisy-Chain Headers: Format, CodedCharSetId, Encoding
+# TODO During Deblock validate that data size left at least matches struct size
+if $0 == __FILE__
+  path = ARGV[0] || raise("Mandatory parameter: 'WebSphere MQ Include path' is missing")
+  path = path + '/'
+  GenerateStructs.new(path, 'generate').generate
+end