Class: Debugger::XmlPrinter

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-debug-ide/xml_printer.rb

Overview

:nodoc:

Defined Under Namespace

Classes: ExceptionProxy

Constant Summary collapse

@@monitor = 
Monitor.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(interface) ⇒ XmlPrinter

Returns a new instance of XmlPrinter.



39
40
41
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 39

def initialize(interface)
  @interface = interface
end

Instance Attribute Details

#interface ⇒ Object

Returns the value of attribute interface.



37
38
39
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 37

def interface
  @interface
end

Class Method Details

.protect(mname) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 23

def self.protect(mname)
  return if instance_methods.include?("__#{mname}")
  alias_method "__#{mname}", mname
  class_eval %{
    def #{mname}(*args, &block)
      @@monitor.synchronize do
        return unless @interface
        __#{mname}(*args, &block)
      end
    end
  }
end

Instance Method Details



108
109
110
111
112
113
114
115
116
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 108

def print_array(array)
  print_element("variables") do
    index = 0 
    array.each { |e|
      print_variable('[' + index.to_s + ']', e, 'instance') 
      index += 1 
    }
  end
end

#print_at_line(context, file, line) ⇒ Object 



270
271
272
273
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 270

def print_at_line(context, file, line)
  print "<suspended file=\'%s\' line=\'%s\' threadId=\'%d\' frames=\'%d\'/>",
    File.expand_path(file), line, context.thnum, context.stack_size
end

#print_breakpoint(n, breakpoint) ⇒ Object

Events



253
254
255
256
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 253

def print_breakpoint(n, breakpoint)
  print("<breakpoint file=\"%s\" line=\"%s\" threadId=\"%d\"/>", 
  breakpoint.source, breakpoint.pos, Debugger.current_context.thnum)
end

#print_breakpoint_added(b) ⇒ Object 



182
183
184
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 182

def print_breakpoint_added(b)
  print "<breakpointAdded no=\"%s\" location=\"%s:%s\"/>", b.id, b.source, b.pos
end

#print_breakpoint_deleted(b) ⇒ Object 



186
187
188
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 186

def print_breakpoint_deleted(b)
  print "<breakpointDeleted no=\"%s\"/>", b.id
end

#print_breakpoint_disabled(b) ⇒ Object 



194
195
196
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 194

def print_breakpoint_disabled(b)
  print "<breakpointDisabled bp_id=\"%s\"/>", b.id
end

#print_breakpoint_enabled(b) ⇒ Object 



190
191
192
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 190

def print_breakpoint_enabled(b)
  print "<breakpointEnabled bp_id=\"%s\"/>", b.id
end

#print_breakpoints(breakpoints) ⇒ Object 



174
175
176
177
178
179
180
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 174

def print_breakpoints(breakpoints)
  print_element 'breakpoints' do
    breakpoints.sort_by{|b| b.id }.each do |b|
      print "<breakpoint n=\"%d\" file=\"%s\" line=\"%s\" />", b.id, b.source, b.pos.to_s
    end
  end
end

#print_catchpoint(exception) ⇒ Object 



258
259
260
261
262
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 258

def print_catchpoint(exception)
  context = Debugger.current_context
  print("<exception file=\"%s\" line=\"%s\" type=\"%s\" message=\"%s\" threadId=\"%d\"/>", 
  context.frame_file(0), context.frame_line(0), exception.class, CGI.escapeHTML(exception.to_s), context.thnum)
end

#print_catchpoint_set(exception_class_name) ⇒ Object 



202
203
204
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 202

def print_catchpoint_set(exception_class_name)
  print "<catchpointSet exception=\"%s\"/>", exception_class_name
end

#print_contdition_set(bp_id) ⇒ Object 



198
199
200
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 198

def print_contdition_set(bp_id)
  print "<conditionSet bp_id=\"%d\"/>", bp_id
end

#print_context(context) ⇒ Object 



93
94
95
96
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 93

def print_context(context)
  current = 'current="yes"' if context.thread == Thread.current
  print "<thread id=\"%s\" status=\"%s\" pid=\"%s\" #{current}/>", context.thnum, context.thread.status, Process.pid
end

#print_contexts(contexts) ⇒ Object 



85
86
87
88
89
90
91
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 85

def print_contexts(contexts)
  print_element("threads") do
    contexts.each do |c|
      print_context(c) unless c.ignored?
    end
  end
end

#print_current_frame(frame_pos) ⇒ Object 



74
75
76
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 74

def print_current_frame(frame_pos)
  print_debug "Selected frame no #{frame_pos}"
end

#print_debug(*args) ⇒ Object

Sends debug message to the frontend if XML debug logging flag (–xml-debug) is on.



50
51
52
53
54
55
56
57
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 50

def print_debug(*args)
  Debugger.print_debug(*args)
  if Debugger.xml_debug
    msg, *args = args
    xml_message = CGI.escapeHTML(msg % args)
    @interface.print("<message debug='true'>#{xml_message}</message>")
  end
end

#print_element(name) ⇒ Object 



300
301
302
303
304
305
306
307
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 300

def print_element(name)
  print("<#{name}>")
  begin
    yield
  ensure
    print("</#{name}>")
  end
end

#print_error(*args) ⇒ Object 



59
60
61
62
63
64
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 59

def print_error(*args)
  print_element("error") do
    msg, *args = args
    print CGI.escapeHTML(msg % args)
  end
end

#print_eval(exp, value) ⇒ Object 



218
219
220
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 218

def print_eval(exp, value)
  print "<eval expression=\"%s\" value=\"%s\" />",  CGI.escapeHTML(exp), value
end

#print_exception(exception, binding) ⇒ Object 



275
276
277
278
279
280
281
282
283
284
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 275

def print_exception(exception, binding)
  print_element("variables") do
    proxy = ExceptionProxy.new(exception)
    InspectCommand.reference_result(proxy)
    print_variable('error', proxy, 'exception')
  end
rescue Exception => e
  print "<processingException type=\"%s\" message=\"%s\"/>", 
    exception.class, CGI.escapeHTML(exception.to_s)
end

#print_expression(exp, value, idx) ⇒ Object 



214
215
216
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 214

def print_expression(exp, value, idx)
  print "<dispay name=\"%s\" value=\"%s\" no=\"%d\" />", exp, value, idx
end

#print_expressions(exps) ⇒ Object 



206
207
208
209
210
211
212
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 206

def print_expressions(exps)
  print_element "expressions" do
    exps.each_with_index do |(exp, value), idx|
      print_expression(exp, value, idx+1)
    end
  end unless exps.empty?
end

#print_frame(context, frame_id, current_frame_id) ⇒ Object 



78
79
80
81
82
83
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 78

def print_frame(context, frame_id, current_frame_id)
  # idx + 1: one-based numbering as classic-debugger
  file = context.frame_file(frame_id)
  print "<frame no=\'%s\' file=\'%s\' line=\'%s\' #{"current='true' " if frame_id == current_frame_id}/>",
    frame_id + 1, File.expand_path(file), context.frame_line(frame_id)
end

#print_frames(context, current_frame_id) ⇒ Object 



66
67
68
69
70
71
72
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 66

def print_frames(context, current_frame_id)
  print_element("frames") do
    (0...context.stack_size).each do |id|
      print_frame(context, id, current_frame_id)
    end
  end
end

#print_hash(hash) ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 118

def print_hash(hash)
  print_element("variables") do
    hash.keys.each { | k |
      if k.class.name == "String"
        name = '\'' + k + '\''
      else
        name = k.to_s
      end
      print_variable(name, hash[k], 'instance') 
    }
  end
end

#print_inspect(eval_result) ⇒ Object 



286
287
288
289
290
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 286

def print_inspect(eval_result)
  print_element("variables") do 
    print_variable("eval_result", eval_result, 'local')
  end
end

#print_list(b, e, file, line) ⇒ Object 



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 226

def print_list(b, e, file, line)
  print "[%d, %d] in %s\n", b, e, file
  if lines = Debugger.source_for(file)
    b.upto(e) do |n|
      if n > 0 && lines[n-1]
        if n == line
          print "=> %d  %s\n", n, lines[n-1].chomp
        else
          print "   %d  %s\n", n, lines[n-1].chomp
        end
      end
    end
  else
    print "No sourcefile available for %s\n", file
  end
end

#print_load_result(file, exception = nil) ⇒ Object 



292
293
294
295
296
297
298
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 292

def print_load_result(file, exception=nil)
  if exception then
    print("<loadResult file=\"%s\" exceptionType=\"%s\" exceptionMessage=\"%s\"/>", file, exception.class, CGI.escapeHTML(exception.to_s))        
  else
    print("<loadResult file=\"%s\" status=\"OK\"/>", file)        
   end    
end

#print_methods(methods) ⇒ Object 



243
244
245
246
247
248
249
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 243

def print_methods(methods)
  print_element "methods" do
    methods.each do |method|
      print "<method name=\"%s\" />", method
    end
  end
end

#print_msg(*args) ⇒ Object 



43
44
45
46
47
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 43

def print_msg(*args)
  msg, *args = args
  xml_message = CGI.escapeHTML(msg % args)
  print "<message>#{xml_message}</message>"
end

#print_pp(value) ⇒ Object 



222
223
224
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 222

def print_pp(value)
  print value
end

#print_string(string) ⇒ Object 



131
132
133
134
135
136
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 131

def print_string(string)
  print_element("variables") do
     print_variable('bytes', string.bytes.to_a, 'instance') if string.respond_to?('bytes')
     print_variable('encoding', string.encoding, 'instance') if string.respond_to?('encoding')         
  end
end

#print_trace(context, file, line) ⇒ Object 



264
265
266
267
268
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 264

def print_trace(context, file, line)
  Debugger::print_debug "trace: location=\"%s:%s\", threadId=%d", file, line, context.thnum
  # TBD: do we want to clog fronend with the <trace> elements? There are tons of them.
  # print "<trace file=\"%s\" line=\"%s\" threadId=\"%d\" />", file, line, context.thnum
end

#print_variable(name, value, kind) ⇒ Object 



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
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 138

def print_variable(name, value, kind)
  name = name.to_s
  if value.nil?
    print("<variable name=\"%s\" kind=\"%s\"/>", CGI.escapeHTML(name), kind)
    return
  end
  if value.is_a?(Array) || value.is_a?(Hash)
    has_children = !value.empty?
    unless has_children
      value_str = "Empty #{value.class}"
    else
      value_str = "#{value.class} (#{value.size} element(s))"
    end
  elsif value.is_a?(String)
    has_children = value.respond_to?('bytes') || value.respond_to?('encoding')
    value_str = value
  else  
    has_children = !value.instance_variables.empty? || !value.class.class_variables.empty?
    value_str = value.to_s || 'nil' rescue "<#to_s method raised exception: #$!>"
    unless value_str.is_a?(String)
      value_str = "ERROR: #{value.class}.to_s method returns #{value_str.class}. Should return String." 
    end
  end

  if value_str.respond_to?('encode')
    begin
     value_str = value_str.encode("UTF-8")
    rescue
    end 
  end
  value_str = "[Binary Data]" if (value_str.respond_to?('is_binary_data?') && value_str.is_binary_data?)
  print("<variable name=\"%s\" kind=\"%s\" value=\"%s\" type=\"%s\" hasChildren=\"%s\" objectId=\"%#+x\"/>",
      CGI.escapeHTML(name), kind, CGI.escapeHTML(value_str), value.class,
      has_children, value.respond_to?(:object_id) ? value.object_id : value.id)
end

#print_variables(vars, kind) ⇒ Object 



98
99
100
101
102
103
104
105
106
 
# File 'lib/ruby-debug-ide/xml_printer.rb', line 98

def print_variables(vars, kind)
  print_element("variables") do
    # print self at top position
    print_variable('self', yield('self'), kind) if vars.include?('self')
    vars.sort.each do |v|
      print_variable(v, yield(v), kind) unless v == 'self'
    end
  end
end