Class: Divine::RubyHelperMethods

Inherits:
BabelHelperMethods show all
Defined in:
lib/divine/code_generators/ruby.rb

Overview

  • Ruby Helper :

Support base function needed to build Divine enviroment and classes corresponding to DSL structs

Direct Known Subclasses

RubyGenerator

Instance Method Summary collapse

Methods inherited from BabelHelperMethods

#camelize, #format_src, #get_fresh_variable_name, #get_header_comment_text, #sanity_check

Instance Method Details

#get_header_comment ⇒ Object

Return the header comment



12
13
14
15
16
 
# File 'lib/divine/code_generators/ruby.rb', line 12

def get_header_comment
  get_header_comment_text.map do |s|
    "# #{s}"
  end.join("\n")
end

#ruby_base_class_template_str ⇒ Object

Generate the base Divine Ruby Class that contains the main methods:

  • serialize

  • serialize Internal

  • deserialize

  • Read Methods

  • Write Methods



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
105
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/divine/code_generators/ruby.rb', line 27

def ruby_base_class_template_str
  %q{
  class Divine<%= toplevel_class %>
public
def serialize
  out = []
  serialize_internal(out)
  out.flatten.pack("C*")
end

protected
### Read methods ###
def read_int8(data)
  data.getbyte
end

def read_int16(data)
  (data.getbyte << 8) | read_int8(data)
end

def read_int24(data)
  (data.getbyte << 16) | read_int16(data)
end

def read_int32(data)
  (data.getbyte << 24) | read_int24(data)
end

def read_sint32(data)
  max = (2** (32 - 1)) - 1
  num = (data.getbyte << 24) | read_int24(data)
  if num > max
    return num - 2** 32
  end
  return num
end

def read_sint64(data)
  max = (2** (64 - 1)) - 1
  num = (read_int32(data) << 32) | (read_int32(data) & 0xFFFFFFFF);
  if num > max
    return num - 2** 64
  end
  return num
end

def read_dint63(data)
  byte = read_int8(data)
  val  = byte & 0x7F
  while (byte >> 7) == 1
    byte = read_int8(data)
    val = val << 7
    val = val | byte & 0x7F
  end
  val
end

def read_bool(data)
  read_int8(data) == 1
end

def read_string(data)
  data.read(read_int16(data)).force_encoding('UTF-8')
end

def read_binary(data)
  data.read(read_int32(data))
end

def read_short_binary(data)
  data.read(read_int8(data))
end

def read_ip_number(data)
  ips = read_short_binary(data)
  if ips.size == 4
    read_ipv4_number(ips)
  else
    read_ipv6_number(ips)
  end
end

def read_ipv4_number(ips)
  ips.bytes.to_a.join('.')
end

def read_ipv6_number(ips)
  ipv6 = []
  ips.bytes.each_slice(2) do |t|
    fst = t[0]
    lst = t[1]
    tmp = ""
    tmp = fst.to_s 16 if fst != 0
    if fst != 0 and lst < 10
      tmp << "0#{lst.to_s 16}"
    elsif fst != 0 and lst > 10 or fst == 0 and lst > 0
      tmp << lst.to_s(16)
    end
    ipv6.push(tmp)
  end
  ipv6.join(':').gsub(/:{2,}/, "::")
end

### Write methods ###
def write_int8(v, out)
  v = v.to_i
  raise_error "Too large int8 number: #{v}" if v > 0xFF  # Max 255
  raise_error "a negative number passed  to int8 number: #{v}" if v < 0
  out << v
end

def write_int16(v, out)
  v = v.to_i
  raise_error "Too large int16 number: #{v}" if v > 0xFFFF # Max 65.535 
  raise_error "a negative number passed  to int16 number: #{v}" if v < 0
  write_int8( v >> 8 & 0xFF, out)
  write_int8( v & 0xFF, out)
end

def write_int24(v, out)
  v = v.to_i
  raise_error "Too large int24 number: #{v}" if v > 0xFFFFFF # Max 16.777.215
  raise_error "a negative number passed  to int24 number: #{v}" if v < 0 # In Case added to ruby declaration
  write_int8( v >> 16 & 0xFF, out)
  write_int16( v & 0xFFFF, out)
end

def write_int32(v, out)
  v = v.to_i
  raise_error "Too large int32 number: #{v}" if v > 0xFFFFFFFF # Max 4.294.967.295
  raise_error "a negative number passed  to int32 number: #{v}" if v < 0
  write_int8( v >> 24 & 0xFF, out)
  write_int24( v & 0xFFFFFF, out)
end

def write_sint32(v, out)
  v = v.to_i
  max = (2** (32 - 1)) - 1
  min = (2** (32 - 1) ) - (2** 32)
  raise_error "Too large Sint32 number: #{v} , Max = #{max}" if v > max # Max  2.147.483.647
  raise_error "Too small sInt32 number: #{v} , Min = #{min}" if v < min # Min -2.147.483.648
  write_int8( v >> 24 & 0xFF, out)
  write_int24( v & 0xFFFFFF, out)
end

def write_sint64(v, out)
  v = v.to_i
  max = (2** (64 - 1)) - 1
  min = (2** (64 - 1) ) - (2** 64)
  raise_error "Too large Sint64 number: #{v} , Max = #{max}" if v > max # Max  9.223.372.036.854.775.807
  raise_error "Too small sInt64 number: #{v} , Min = #{min}" if v < min # Min -9.223.372.036.854.775.808
  write_int32( v >> 32 & 0xFFFFFFFF, out)
  write_int32( v & 0xFFFFFFFF, out)
end

def write_dint63(v, out)
  v = v.to_i
  max = (2** (64 - 1)) - 1
  min = 0
  raise_error "Too large Dynamic int63 number: #{v} , Max = #{max}" if v > max # Max  9.223.372.036.854.775.807
  raise_error "Too small Dynamic int63 number: #{v} , Min = #{min}" if v < min # Min  0
  
  bytes = v.to_s(2).reverse.split(/([01]{7})/).reject{ |t| t == ""}.each_with_index.map{ |t, i| t = t + "0"*(7-t.length) + [i,1].min.to_s}
  bytes.reverse.map{ |t| 
                      val = t.reverse.to_i 2
                      write_int8(val, out)
                   }
end

def write_bool(v, out)
  write_int8(v ? 1 : 0, out)
end

def write_string(v, out)
  s = force_to_utf8_string(v)
  raise_error "Too large string: #{s.bytesize} bytes" if s.bytesize > 0xFFFF
  write_int16(s.bytesize, out)
  out << s.bytes.to_a
end

def write_binary(v, out)
  if v.is_a?(Array)
    raise_error "Too large binary: #{v.size} (#{v.class.name})" unless v.size < 0xFFFFFFFF 
    write_int32(v.size, out)
    v.each do |x|
      write_int8(x, out)
    end
  elsif v.is_a?(String)
    raise_error "Too large binary: #{v.size} (#{v.class.name})" unless v.size < 0xFFFFFFFF 
    write_int32(v.size, out)
    out << v.bytes.to_a
  else 
    raise_error "Unsupported binary 'nil'" if v == nil
    raise_error "Unsupported binary of type '#{v.class.name}'"
  end
end

def write_16_binary(v, out)
  if v.is_a?(Array)
    raise_error "Too large 16 binary: #{v.size} (#{v.class.name})" unless v.size*2 < 0xFF
    write_int8(v.size * 2, out) # IPv6 consists of 8 parts each of them has zise of 2 bytes
    v.each do |x|
      write_int16(x, out)
    end
  else 
    raise_error "Unsupported binary 'nil'" if v == nil
    raise_error "Unsupported binary of type '#{v.class.name}'"
  end
end

def write_short_binary(v, out)
  if v.is_a?(Array)
    raise_error "Too large short_binary: #{v.size} (#{v.class.name})" unless v.size < 0xFF
    write_int8(v.size, out)
    v.each do |x|
      write_int8(x, out)
    end
  elsif v.is_a?(String)
    raise_error "To large short_binary: #{v.size} (#{v.class.name})" unless v.size < 0xFF
    write_int8(v.size, out)
    out << v.bytes.to_a
  else 
    raise_error "Unsupported binary 'nil'" if v == nil
    raise_error "Unsupported binary of type '#{v.class.name}'"
  end
end

def write_ip_number(v, out)
  if v.is_a?(Array)
    if v.size == 4
      write_ipv4_number(v, out);
    else
      write_ipv6_number(v, out);
    end
  elsif v.is_a?(String)
    if v.include?":"
      write_ipv6_number(v, out);
    else
      write_ipv4_number(v, out);
    end
  else
    raise_error "Unknown IP number '#{v}'"
  end
end

def write_ipv4_number(v,out)
  if v.is_a?(Array)
    raise_error "Unknown IP v4 number #{v}" unless v.size == 0 || v.size == 4 # Only IPv4 for now 
    write_short_binary(v, out)
  elsif v.is_a?(String)
    ss = v.split(/\./).map do |s|
      s.to_i
    end
    write_ipv4_number(ss, out)
  else
    raise_error "Unknown IP number '#{v}'"
  end
end

def write_ipv6_number(v, out)
  if v.is_a?(Array)
    write_16_binary(v, out)
  elsif v.is_a?(String)
    v = v.gsub(" ","") + " " # Temporary: To avoid the split problem when we have : at the end of "v" 
    raise_error "Unknown IPv6 number #{v}" unless v.strip.empty? ||
                                                   v.strip.match(/[^:0-9a-f]+/i) == nil &&  #Should not contains numbers or letters 0-9a-f
                                                   v.strip.match(/[0-9a-f]+/i) != nil &&   #Should contains numbers or letters 0-9a-f
                                                   v.match(":{3,}") == nil && 
                                                   v.split("::").size <= 2
    ss = v.split(/:/).map do |s|
      s = s.strip
	  raise_error "Unknown IPv6 Group #{s}" unless s.size <= 4
      s.to_i 16
    end
    ss = [] if v.strip.empty?
    raise_error "Unknown IPv6 number #{v}" unless (!v.include?("::") && ss.size == 0 || ss.size == 8) || 
		       (v.include?("::") && ss.size > 2 && ss.size < 8)
	write_ipv6_number(ss, out)
  else
    raise_error "Unknown IPv6 number '#{v}'"
  end
end

private
def raise_error(msg)
  raise "[#{self.class.name}] #{msg}" 
end

def force_to_utf8_string(string)
  if string.encoding != Encoding::UTF_8
    string = string.encode(Encoding::UTF_8)
  end
  return string
end
  end
}
end

#ruby_class_template(sh) ⇒ Object

  • sh -> Struct Name



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/divine/code_generators/ruby.rb', line 329

def ruby_class_template(sh)
  code = [
    "class #{sh.name} < Divine",
    :indent,
    "",
    
    # PROPERTIES
    if sh.field_names.size > 0
      "attr_accessor :struct_version, #{sh.field_names.map {|n| ":#{n}" }.join(', ')}"
    else
      "attr_accessor :struct_version"
    end, "",


    # INITIALIZE
    "def initialize()",
    :indent,
    "super",
    "@struct_version ||= #{sh.latest_version}",
    sh.field_names.map do |fn|
      "@#{fn} ||= #{ruby_get_empty_declaration(sh.field(fn).first)}"
    end,
    :deindent,
    "end", "",
  
    # SERiALIZE INTERNAL
    "def serialize_internal(out)",
    :indent,
    "write_int8(@struct_version, out)",
    sh.structs.map do |s|
      [
        "if @struct_version == #{s.version}",
        :indent,
        s.simple_fields.map do |f|
          "write_#{f.type}(#{f.name}, out)"
        end,
        s.complex_fields.map do |f|
          [
            "", "# Serialize #{f.type} '#{f.name}'",
            ruby_serialize_internal(f.name,  f.referenced_types)
          ]
        end,
        "return",
        :deindent,
        "end", ""
      ]
    end, "",
    "raise \"Unsupported version #\{@struct_version\} for type '#{sh.name}'\"",
    :deindent,
    "end", "",
    
    # DESERIALIZE
    "def deserialize(data)",
    :indent,
    "@struct_version = read_int8(data)",
    sh.structs.map do |s|
      [
        "if @struct_version == #{s.version}",
        :indent,
        s.simple_fields.map do |f|
            "@#{f.name} = read_#{f.type}(data)"
        end,
        s.complex_fields.map do |f|
          [
            "", "# Read #{f.type} '#{f.name}'",
            ruby_deserialize_internal("@#{f.name}",  f.referenced_types)
          ]
        end,
        "return",
        :deindent,
        "end"
      ]
    end, "",
    "raise \"Unsupported version #\{@struct_version\} for type '#{sh.name}'\"",
    :deindent,
    "end", "",
    
    
    # END OF CLASS
    :deindent,
    "end"        
    ]
  format_src(0, 3, code)
end

#ruby_deserialize_internal(var, types) ⇒ Object

Generate the way of deserializing different DSL types

* *Args*    :
 - +var+   -> variable name
 - +types+ -> variable type



506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
 
# File 'lib/divine/code_generators/ruby.rb', line 506

def ruby_deserialize_internal(var, types)
  if types.respond_to? :first
    case types.first
    when :list
      count = get_fresh_variable_name
      nv = get_fresh_variable_name
      return [
              "#{var} = []",
              "#{count} = read_int32(data)",
              "(1..#{count}).each do",
              :indent,
              ruby_deserialize_internal(nv, types[1]),
              "#{var} << #{nv}",
              :deindent,
              "end"
             ]
    when :map
      count = get_fresh_variable_name
      nv1 = get_fresh_variable_name      
      nv2 = get_fresh_variable_name
      return ["#{var} = {}",
              "#{count} = read_int32(data)",
              "(1..#{count}).each do",
              :indent,
              ruby_deserialize_internal(nv1, types[1]),
              ruby_deserialize_internal(nv2, types[2]),
              "#{var}[#{nv1}] = #{nv2}",
              :deindent,
              "end"
             ]
    else
      raise "Missing serialization for #{var}"
    end
  else
    case types
    when :map
      "#{var} = {}"
    when :list
      "#{var} = []"
    else
      if $all_structs.key? types
        [
         "#{var} = #{types}.new",
         "#{var}.deserialize(data)"
        ]
      else
        "#{var} = read_#{types}(data)"
      end
    end
  end
end

#ruby_get_empty_declaration(field) ⇒ Object

  • map –> {}



438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/divine/code_generators/ruby.rb', line 438

def ruby_get_empty_declaration(field)
  case field.type
  when :list, :binary, :short_binary
    "[]"
  when :map
    "{}"
  when :dint63, :int8, :int16, :int32, :sint32, :sint64
    "0"
  when :string, :ip_number
    "\"\""
  else
    raise "Unkown field type #{field.type}"
  end
end

#ruby_serialize_internal(var, types) ⇒ Object

Generate the way of serializing different DSL types

* *Args*    :
 - +var+   -> variable name
 - +types+ -> variable type



459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/divine/code_generators/ruby.rb', line 459

def ruby_serialize_internal(var, types)
  if types.respond_to? :first
    case types.first
    when :list
      nv = get_fresh_variable_name
      return [
              "write_int32(#{var}.size, out)",
              "#{var}.each do |#{nv}|",
              :indent,
              ruby_serialize_internal(nv, types[1]),
              :deindent,
              "end"
             ]
    when :map
      nv1 = get_fresh_variable_name      
      nv2 = get_fresh_variable_name
      return [
              "write_int32(#{var}.size, out)",
              "#{var}.each_pair do |#{nv1}, #{nv2}|",
              :indent,
              ruby_serialize_internal(nv1, types[1]),
              ruby_serialize_internal(nv2, types[2]),
              :deindent,
              "end"
             ]
    else
      raise "Missing serialization for #{var}"
    end
  else
    if $all_structs[types]
      "#{var}.serialize_internal(out)"
  
    elsif $available_types[types] && $available_types[types].ancestors.include?(SimpleDefinition)
      "write_#{types}(#{var}, out)"
  
    else
      raise "Missing code generation case #{types}"
    end
  end
end