Class: Kaitai::Struct::Visualizer::Node

Inherits:
Object
  • Object
show all
Defined in:
lib/kaitai/struct/visualizer/node.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(tree, value, level, value_method = nil, pos1 = nil, pos2 = nil) ⇒ Node

Returns a new instance of Node.



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/kaitai/struct/visualizer/node.rb', line 12

def initialize(tree, value, level, value_method = nil, pos1 = nil, pos2 = nil)
  @tree = tree
  @value = value
  @level = level
  @value_method = value_method

  unless pos1.nil? || pos2.nil?
    @pos1 = pos1
    @pos2 = pos2
  end

  @open = false
  @explored = false

  @children = []
end

Instance Attribute Details

#children ⇒ Object (readonly)

Returns the value of attribute children.



10
11
12
 
# File 'lib/kaitai/struct/visualizer/node.rb', line 10

def children
  @children
end

#id ⇒ Object

Returns the value of attribute id.



9
10
11
 
# File 'lib/kaitai/struct/visualizer/node.rb', line 9

def id
  @id
end

#level ⇒ Object (readonly)

Returns the value of attribute level.



10
11
12
 
# File 'lib/kaitai/struct/visualizer/node.rb', line 10

def level
  @level
end

#parent ⇒ Object

Returns the value of attribute parent.



9
10
11
 
# File 'lib/kaitai/struct/visualizer/node.rb', line 9

def parent
  @parent
end

#pos1 ⇒ Object (readonly)

Returns the value of attribute pos1.



10
11
12
 
# File 'lib/kaitai/struct/visualizer/node.rb', line 10

def pos1
  @pos1
end

#pos2 ⇒ Object (readonly)

Returns the value of attribute pos2.



10
11
12
 
# File 'lib/kaitai/struct/visualizer/node.rb', line 10

def pos2
  @pos2
end

#type ⇒ Object

Returns the value of attribute type.



9
10
11
 
# File 'lib/kaitai/struct/visualizer/node.rb', line 9

def type
  @type
end

#value ⇒ Object (readonly)

Returns the value of attribute value.



10
11
12
 
# File 'lib/kaitai/struct/visualizer/node.rb', line 10

def value
  @value
end

Instance Method Details

#add(child) ⇒ Object 



29
30
31
32
 
# File 'lib/kaitai/struct/visualizer/node.rb', line 29

def add(child)
  @children << child
  child.parent = self
end

#clamp_string(s, max_len) ⇒ Object 



134
135
136
137
138
139
140
141
 
# File 'lib/kaitai/struct/visualizer/node.rb', line 134

def clamp_string(s, max_len)
  s ||= ''
  if s.length > max_len
    s = s[0, max_len - 1] || ''
    s += '…'
  end
  s
end

#close ⇒ Object 



68
69
70
 
# File 'lib/kaitai/struct/visualizer/node.rb', line 68

def close
  @open = false
end

#detect_str_mode ⇒ Object

Empirically detects a mode that would be best to show a designated string



155
156
157
158
159
160
161
 
# File 'lib/kaitai/struct/visualizer/node.rb', line 155

def detect_str_mode
  if @value.encoding == Encoding::ASCII_8BIT
    :hex
  else
    :str_esc
  end
end

#draw(_ui) ⇒ Object 



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
 
# File 'lib/kaitai/struct/visualizer/node.rb', line 72

def draw(_ui)
  print '  ' * level
  print(if @value.nil?
          '[?]'
        elsif open?
          '[-]'
        elsif openable?
          '[+]'
        else
          '[.]'
        end)
  print " #{@id}"

  pos = 2 * level + 4 + @id.length

  if open? || !openable?
    if @value.is_a?(Float) || @value.is_a?(Integer)
      print " = #{@value}"
    elsif @value.is_a?(Symbol)
      print " = #{@value}"
    elsif @value.is_a?(String)
      print ' = '
      pos += 3
      @str_mode ||= detect_str_mode
      max_len = @tree.tree_width - pos

      case @str_mode
      when :str
        v = @value.encode('UTF-8')
        s = v[0, max_len]
      when :str_esc
        v = @value.encode('UTF-8')
        s = v.inspect[0, max_len]
      when :hex
        s = first_n_bytes_dump(@value, max_len / 3 + 1)
      else
        raise "Invalid str_mode: #{@str_mode.inspect}"
      end

      s = clamp_string(s, max_len)
      print s
    elsif (@value == true) || (@value == false)
      print " = #{@value}"
    elsif @value.nil?
      print ' = null'
    elsif @value.is_a?(Array)
      printf ' (%d = 0x%x entries)', @value.size, @value.size
    elsif @value.public_methods(false).include?(:to_s)
      s = @value.to_s
      pos += 2
      max_len = @tree.tree_width - pos
      if s.is_a?(String)
        print ": #{clamp_string(s, max_len)}"
      else
        print ": #{clamp_string(s.class.to_s, max_len)}"
      end
    end
  end

  puts
end

#explore ⇒ Object 



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
 
# File 'lib/kaitai/struct/visualizer/node.rb', line 175

def explore
  return if @explored

  if @value.nil?
    @value = @parent.value.send(@value_method)
    clean_id = @id[0] == '@' ? @id[1..-1] : @id
    debug_el = @parent.value._debug[clean_id]
    # raise "Unable to get debugging aid for: #{@parent.value._debug.inspect} using ID '#{clean_id}'" unless debug_el
    if debug_el
      @pos1 = debug_el[:start]
      @pos2 = debug_el[:end]
    end
  end

  @explored = true

  if @value.is_a?(Float) ||
     @value.is_a?(Integer) ||
     @value.is_a?(String) ||
     (@value == true) ||
     (@value == false) ||
     @value.nil? ||
     @value.is_a?(Symbol)
    clean_id = @id[0] == '@' ? @id[1..-1] : @id
    debug_el = @parent.value._debug[clean_id]
    # raise "Unable to get debugging aid for: #{@parent.value._debug.inspect} using ID '#{clean_id}'" unless debug_el
    if debug_el
      @pos1 = debug_el[:start]
      @pos2 = debug_el[:end]
    end
  elsif @value.is_a?(Array)
    # Bail out early for empty array: it doesn't have proper
    # debugging aids structure anyway
    return if @value.empty?

    clean_id = @id[0] == '@' ? @id[1..-1] : @id
    debug_el = @parent.value._debug[clean_id]
    # raise "Unable to get debugging aid for array: #{@parent.value._debug.inspect} using ID '#{clean_id}'" unless debug_el

    aid = (debug_el && debug_el[:arr]) || {}
    # raise "Unable to get debugging aid for array: #{debug_el.inspect}" unless aid

    max_val_digits = @value.size.to_s.size
    fmt = "%#{max_val_digits}d"

    @value.each_with_index do |el, i|
      aid_el = aid[i] || {}
      n = Node.new(@tree, el, level + 1, nil, aid_el[:start], aid_el[:end])
      n.id = format(fmt, i)
      add(n)
    end
  else
    # Gather seq attributes
    @value.class::SEQ_FIELDS.each do |k|
      el = @value.instance_eval("@#{k}", __FILE__, __LINE__)
      aid = @value._debug[k]
      if aid
        aid_s = aid[:start]
        aid_e = aid[:end]
      else
        # raise "Unable to get debugging aid for '#{k}'"
        aid_s = nil
        aid_e = nil
      end
      next if el.nil?

      n = Node.new(@tree, el, level + 1, nil, aid_s, aid_e)
      n.id = k
      n.type = :seq
      add(n)
    end

    attrs = Set.new(@value.class::SEQ_FIELDS)

    # Gather instances
    prop_meths = @value.public_methods(false)
    prop_meths.each do |meth|
      k = meth.to_s
      # NB: we don't need to consider `_unnamed*` attributes here
      # (https://github.com/kaitai-io/kaitai_struct/issues/1064) because
      # only `seq` fields can be unnamed, not `instances`
      next if k.start_with?('_') || attrs.include?(k) || meth == :to_s

      n = Node.new(@tree, nil, level + 1, meth)
      n.id = k
      n.type = :instance
      add(n)
    end
  end
end

#first_n_bytes_dump(s, n) ⇒ Object 



143
144
145
146
147
148
149
150
151
152
 
# File 'lib/kaitai/struct/visualizer/node.rb', line 143

def first_n_bytes_dump(s, n)
  i = 0
  r = +''
  s.each_byte do |x|
    r << format('%02x ', x)
    i += 1
    break if i >= n
  end
  r
end

#height ⇒ Object

Determine total height of an element, including all children if it’s open and visible



267
268
269
270
271
272
273
274
275
 
# File 'lib/kaitai/struct/visualizer/node.rb', line 267

def height
  if @open
    r = 1
    @children.each { |n| r += n.height }
    r
  else
    1
  end
end

#hex? ⇒ Boolean

Returns:

  • (Boolean) 


49
50
51
 
# File 'lib/kaitai/struct/visualizer/node.rb', line 49

def hex?
  @value.is_a?(String)
end

#io ⇒ Object 



163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/kaitai/struct/visualizer/node.rb', line 163

def io
  return @io if @io

  if @parent.nil?
    @io = @value._io
  else
    obj = @parent
    obj = obj.parent until obj.value.respond_to?(:_io)
    @io = obj.value._io
  end
end

#last_descendant ⇒ Object

Find out last (deepest) descendant of current node



278
279
280
281
282
 
# File 'lib/kaitai/struct/visualizer/node.rb', line 278

def last_descendant
  n = self
  n = n.children.last while n.open?
  n
end

#open ⇒ Object 



61
62
63
64
65
66
 
# File 'lib/kaitai/struct/visualizer/node.rb', line 61

def open
  return unless openable?

  explore
  @open = true if @explored
end

#open? ⇒ Boolean

Returns:

  • (Boolean) 


34
35
36
 
# File 'lib/kaitai/struct/visualizer/node.rb', line 34

def open?
  @open
end

#openable? ⇒ Boolean

Returns:

  • (Boolean) 


38
39
40
41
42
43
44
45
46
47
 
# File 'lib/kaitai/struct/visualizer/node.rb', line 38

def openable?
  !(
    @value.is_a?(Float) or
    @value.is_a?(Integer) or
    @value.is_a?(String) or
    @value.is_a?(Symbol) or
    @value == true or
    @value == false
  )
end

#toggle ⇒ Object 



53
54
55
56
57
58
59
 
# File 'lib/kaitai/struct/visualizer/node.rb', line 53

def toggle
  if @open
    close
  else
    open
  end
end