Class: NWRFC::DataContainer

Inherits:
Object
  • Object
show all
Defined in:
lib/nwrfc/datacontainer.rb

Overview

Representation of a data container (function, structure or table)

Direct Known Subclasses

FunctionCall, Structure, Table

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(handle) ⇒ DataContainer

Returns a new instance of DataContainer.



7
8
9
10
11
12
13
 
# File 'lib/nwrfc/datacontainer.rb', line 7

def initialize(handle)
  @error = NWRFCLib::RFCError.new
  @handle = handle
  @desc = NWRFCLib.describe_type(@handle, @error)
  @member_metadata = {} #Cache of metadata for members
  NWRFC.check_error(@error)
end

Instance Attribute Details

#desc ⇒ Object (readonly)

Returns the value of attribute desc.



5
6
7
 
# File 'lib/nwrfc/datacontainer.rb', line 5

def desc
  @desc
end

#handle ⇒ Object (readonly)

Returns the value of attribute handle.



5
6
7
 
# File 'lib/nwrfc/datacontainer.rb', line 5

def handle
  @handle
end

Instance Method Details

#[](element) ⇒ Object

Return the member specified by string or symbol



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/nwrfc/datacontainer.rb', line 16

def [](element)
  member = element.to_s.upcase
  metadata = member_metadata(element)
  case metadata[:type]
  when :RFCTYPE_CHAR
    # TODO: Try use :string parameter in get_chars
    return read_chars(metadata)
  when :RFCTYPE_DATE
    return Date.parse(read_chars(metadata))
    #return Date.new(date[0..3].to_i, date[4..5].to_i, date[6..7].to_i)
  when :RFCTYPE_BCD
    size = metadata[:ucLength]
    cb = FFI::MemoryPointer.new :char, size * 2
    rc = NWRFCLib.get_chars(@handle, metadata[:name].cU, cb, size * 2, @error.to_ptr)
    NWRFC.check_error(@error) if rc > 0
    cb.read_string(size).uC
  when :RFCTYPE_TIME
    # TODO: See whether we can optimize this
    timec = read_chars(metadata)
    return Time.parse("#{timec[0..1]}:#{timec[2..3]}:#{timec[4..5]}")
  when :RFCTYPE_BYTE
    return read_chars(metadata)
  when :RFCTYPE_TABLE
    new_handle = NWRFCLib::RFCDataContainer.new
    rc = NWRFCLib.get_table(@handle, member.cU, new_handle.to_ptr, @error.to_ptr)
    NWRFC.check_error(@error) if rc > 0
    # CAVEAT: Other calls using the handle require "handle" field
    # of the RFC_DATA_CONTAINER struct for some reason.
    new_handle = new_handle[:handle]
    value = Table.new(new_handle)
  when :RFCTYPE_NUM
    return read_chars(metadata).to_i
  when :RFCTYPE_FLOAT
    double = FFI::MemoryPointer.new :double
    rc = NWRFCLib.get_float(@handle, member.cU, double, @error)
    NWRFC.check_error(@error) if rc > 0
    return double.get_double(0)
  when :RFCTYPE_INT
    int = FFI::MemoryPointer.new :int
    rc = NWRFCLib.get_int(@handle, member.cU, int, @error)
    NWRFC.check_error(@error) if rc > 0
    return int.get_int(0)
  when :RFCTYPE_INT2
    short = FFI::MemoryPointer.new :short
    rc = NWRFCLib.get_int2(@handle, member.cU, short, @error)
    NWRFC.check_error(@error) if rc > 0
    return short.get_short(0)
  when :RFCTYPE_INT1
    int1 = FFI::MemoryPointer.new :uint8
    rc = NWRFCLib.get_int1(@handle, member.cU, int1, @error)
    NWRFC.check_error(@error) if rc > 0
    return int1.get_uint8(0)
  when :RFCTYPE_NULL
    raise "Unsupported type RFCTYPE_NULL" #You should never run into this
  when :RFCTYPE_STRUCTURE
    new_handle = NWRFCLib::RFCDataContainer.new
    rc = NWRFCLib.get_structure(@handle, member.cU, new_handle.to_ptr, @error.to_ptr)
    NWRFC.check_error(@error) if rc > 0
    new_handle = new_handle[:handle]
    value = Structure.new(new_handle)
  when :RFCTYPE_DECF16
    double = FFI::MemoryPointer.new :double
    rc = NWRFCLib.get_dec_f16(@handle, member.cU, double, @error)
    NWRFC.check_error(@error) if rc > 0
    return double.get_double(0)
  when :RFCTYPE_DECF34
    double = FFI::MemoryPointer.new :double, 2
    rc = NWRFCLib.get_dec_f34(@handle, member.cU, double, @error)
    NWRFC.check_error(@error) if rc > 0
    return double.get_double(0)
  when :RFCTYPE_XMLDATA
    raise "Unsupported type RFCTYPE_XMLDATA (no longer used)" #You should never run into this
  when :RFCTYPE_STRING
    return read_string(metadata)
  when :RFCTYPE_XSTRING
    size = FFI::MemoryPointer.new(:uint)
    rc = NWRFCLib.get_string_length(@handle, metadata[:name].cU, size, @error)
    NWRFC.check_error(@error) if rc > 0
    buf_len = size.read_uint
    sbuf = FFI::MemoryPointer.new :uchar, buf_len
    rc = NWRFCLib.get_x_string(@handle, metadata[:name].cU, sbuf, buf_len, size, @error)
    NWRFC.check_error(@error) if rc > 0
    return sbuf.read_string(sbuf.size)
  else
    raise "Illegal member type #{metadata[:type]}"
  end
  NWRFC.check_error(@error)
  value
end

#[]=(element, value) ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/nwrfc/datacontainer.rb', line 106

def []=(element, value)
  member = element.to_s.upcase
  metadata = member_metadata(element)
  case metadata[:type]
  when :RFCTYPE_CHAR
    NWRFCLib.set_chars(@handle, member.cU, value.cU, value.length, @error.to_ptr)
  when :RFCTYPE_DATE
    value = value_to_date(value)
    NWRFCLib.set_date(@handle, member.cU, value.cU, @error.to_ptr)
  when :RFCTYPE_BCD
  when :RFCTYPE_TIME
    value = value_to_time(value)
    NWRFCLib.set_time(@handle, member.cU, value.cU, @error.to_ptr)
  when :RFCTYPE_BYTE
  when :RFCTYPE_TABLE
  when :RFCTYPE_NUM
  when :RFCTYPE_FLOAT
    NWRFCLib.set_float(@handle, member.cU, value.to_f, @error.to_ptr)
    #NWRFCLib.set_chars(@handle, member.cU, value.to_s.cU, value.to_s.length, @error.to_ptr)
  when :RFCTYPE_INT
    NWRFCLib.set_int(@handle, member.cU, value.to_i, @error.to_ptr)
  when :RFCTYPE_INT2
    NWRFCLib.set_int2(@handle, member.cU, value.to_i, @error.to_ptr)
  when :RFCTYPE_INT1
    NWRFCLib.set_int1(@handle, member.cU, value.to_i, @error.to_ptr)
  when :RFCTYPE_NULL
    raise "Unsupported type RFCTYPE_NULL" #You should never run into this
  when :RFCTYPE_STRUCTURE
  when :RFCTYPE_DECF16
    raise "#{@members[:type]}: decfloat16 not supported yet"
    double = NWRFCLib::RFC_DECF16.new #FFI::MemoryPointer.new :double
    double[:align] = value.to_f
    #double.put_double(0, value.to_f)
    #double = FFI::Pointer.new 4
    NWRFCLib.set_dec_f16(@handle, member.cU, double.pointer, @error)
  when :RFCTYPE_DECF34
    raise "#{@members[:type]}: decfloat34 not supported yet"
    #        double = FFI::MemoryPointer.new :double, 2
    #        double.put_double(0, value.to_f)
    double = NWRFCLib::RFC_DECF34.new #FFI::MemoryPointer.new :double
    double[:align] = value.to_f
    NWRFCLib.set_dec_f34(@handle, member.cU, double, @error)
  when :RFCTYPE_XMLDATA
    raise "Unsupported type RFCTYPE_XMLDATA (no longer used)" #You should never run into this
  when :RFCTYPE_STRING
  when :RFCTYPE_XSTRING
    m = FFI::MemoryPointer.new value.size
    m.put_bytes 0, value
    NWRFCLib.set_x_string(@handle, member.cU, m, value.size, @error)
  else
    raise "Illegal member type #{@members[:type]}"
  end
  NWRFC.check_error(@error)
end

#member_metadata(member_name) ⇒ Object

Get the metadata of a member (function, structure or table)



185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/nwrfc/datacontainer.rb', line 185

def member_metadata(member_name)
  member = member_name.to_s.upcase
  if self.class == NWRFC::FunctionCall
    fpar = NWRFCLib::RFCFuncParam.new
    rc = NWRFCLib.get_parameter_desc_by_name(@desc, member.cU, fpar.to_ptr, @error.to_ptr)
    NWRFC.check_error(@error) if rc > 0
    member_to_hash(fpar)
  elsif self.class == NWRFC::Table || self.class == NWRFC::Structure
    fd = NWRFCLib::RFCFieldDesc.new
    rc = NWRFCLib.get_field_desc_by_name(@desc, member.cU, fd.to_ptr, @error.to_ptr)
    NWRFC.check_error(@error) if rc > 0
    member_to_hash(fd)
  end
end

#value_to_date(value) ⇒ Object 



166
167
168
169
170
171
172
173
 
# File 'lib/nwrfc/datacontainer.rb', line 166

def value_to_date(value)
  return value.strftime(NW_DATE_FORMAT) if value.respond_to? :strftime
  # Force the resulting string into 8 characters otherwise
  value = value.to_s
  value << ' ' until value.size == 8 if value.size < 8
  value = value[0..7] if value.size > 8
  value
end

#value_to_time(value) ⇒ Object 



161
162
163
164
 
# File 'lib/nwrfc/datacontainer.rb', line 161

def value_to_time(value)
  return value.strftime(NW_TIME_FORMAT) if value.respond_to? :strftime
  value.to_s
end