1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2013 Lucas Bajolet <lucas.bajolet@gmail.com>
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # Debugging of a nit program using the NaiveInterpreter
21 intrude import naive_interpreter
23 intrude import local_var_init
25 intrude import toolcontext
28 # Cleans the model to remove a module and what it defines when semantic analysis fails on injected code
29 private fun try_remove_module
(m
: MModule): Bool
32 for i
in [0 .. mmodules
.length
[ do
33 if mmodules
[i
] == m
then
38 if index
== -1 then return false
39 var mmodule
= mmodules
[index
]
40 mmodules
.remove_at
(index
)
41 for classdef
in mmodule
.mclassdefs
do
42 var mclass
= classdef
.mclass
43 for i
in [0 .. mclass
.mclassdefs
.length
[ do
44 if mclass
.mclassdefs
[i
] == classdef
then
49 mclass
.mclassdefs
.remove_at
(index
)
50 var propdefs
= classdef
.mpropdefs
51 for propdef
in propdefs
do
52 var prop
= propdef
.mproperty
53 for i
in [0..prop
.mpropdefs
.length
[ do
54 if prop
.mpropdefs
[i
] == propdef
then
59 prop
.mpropdefs
.remove_at
(index
)
66 redef class ScopeVisitor
68 redef init(toolcontext
)
71 if toolcontext
.dbg
!= null then
72 var localvars
= toolcontext
.dbg
.frame
.map
73 for i
in localvars
.keys
do
74 scopes
.first
.variables
[i
.to_s
] = i
81 redef class LocalVarInitVisitor
82 redef fun mark_is_unset
(node
: AExpr, variable
: nullable Variable)
85 if toolcontext
.dbg
!= null then
86 var varname
= variable
.to_s
87 var instmap
= toolcontext
.dbg
.frame
.map
88 for i
in instmap
.keys
do
89 if i
.to_s
== varname
then
90 mark_is_set
(node
, variable
)
98 redef class ToolContext
99 private var dbg
: nullable Debugger = null
101 private var had_error
: Bool = false
103 redef fun check_errors
108 if messages
.length
> 0 then
109 message_sorter
.sort
(messages
)
112 if m
.text
.search
("Warning") == null then had_error
= true
113 sys
.stderr
.write
("{m.to_color_string}\n")
122 var opt_debugger_mode
: OptionBool = new OptionBool("Launches the target program with the debugger attached to it", "-d")
124 var opt_debugger_autorun
: OptionBool = new OptionBool("Launches the target program with the interpreter, such as when the program fails, the debugging prompt is summoned", "-c")
129 self.option_context
.add_option
(self.opt_debugger_mode
)
130 self.option_context
.add_option
(self.opt_debugger_autorun
)
134 redef class ModelBuilder
135 # Execute the program from the entry point (Sys::main) of the `mainmodule`
136 # `arguments` are the command-line arguments in order
138 # 1. the AST is fully loaded.
139 # 2. the model is fully built.
140 # 3. the instructions are fully analysed.
141 fun run_debugger
(mainmodule
: MModule, arguments
: Array[String])
144 self.toolcontext
.info
("*** START INTERPRETING ***", 1)
146 var interpreter
= new Debugger(self, mainmodule
, arguments
)
148 init_naive_interpreter
(interpreter
, mainmodule
)
151 self.toolcontext
.info
("*** END INTERPRETING: {time1-time0} ***", 2)
154 fun run_debugger_autorun
(mainmodule
: MModule, arguments
: Array[String])
157 self.toolcontext
.info
("*** START INTERPRETING ***", 1)
159 var interpreter
= new Debugger(self, mainmodule
, arguments
)
160 interpreter
.autocontinue
= true
162 init_naive_interpreter
(interpreter
, mainmodule
)
165 self.toolcontext
.info
("*** END INTERPRETING: {time1-time0} ***", 2)
169 # The class extending `NaiveInterpreter` by adding debugging methods
171 super NaiveInterpreter
173 # Keeps the frame count in memory to find when to stop
174 # and launch the command prompt after a step out call
175 var step_stack_count
= 1
177 # Triggers a step over an instruction in a nit program
178 var stop_after_step_over_trigger
= true
180 # Triggers a step out of an instruction
181 var stop_after_step_out_trigger
= false
183 # Triggers a step in a instruction (enters a function
184 # if the instruction is a function call)
185 var step_in_trigger
= false
187 # HashMap containing the breakpoints bound to a file
188 var breakpoints
= new HashMap[String, HashSet[Breakpoint]]
190 # Contains the current file
193 # Aliases hashmap (maps an alias to a variable name)
194 var aliases
= new HashMap[String, String]
196 # Set containing all the traced variables and their related frame
197 private var traces
= new HashSet[TraceObject]
199 # Map containing all the positions for the positions of the arguments traced
201 private var fun_call_arguments_positions
= new HashMap[Int, TraceObject]
203 # Triggers the remapping of a trace object in the local context after a function call
204 var aftermath
= false
206 # Used to prevent the case when the body of the function called is empty
207 # If it is not, then, the remapping won't be happening
208 var frame_count_aftermath
= 1
210 # Auto continues the execution until the end or until an error is encountered
211 var autocontinue
= false
213 #######################################################################
214 ## Execution of statement function ##
215 #######################################################################
217 # Main loop, every call to a debug command is done here
218 redef fun stmt
(n
: nullable AExpr)
220 if n
== null then return
222 var frame
= self.frame
223 var old
= frame
.current_node
224 frame
.current_node
= n
226 if sys
.stdin
.poll_in
then process_debug_command
(gets
)
228 if not self.autocontinue
then
229 if not n
isa ABlockExpr then
234 check_funcall_and_traced_args
(n
)
238 check_if_vars_are_traced
(n
)
243 frame
.current_node
= old
246 # Does the same as an usual send, except it will modify the call chain on the first call when injecting code at Runtime using the debugger.
247 # Instead of creating a pristine Frame, it will copy the actual values of the frame, and re-inject them after execution in the current context.
248 fun rt_send
(mproperty
: MMethod, args
: Array[Instance]): nullable Instance
250 var recv
= args
.first
251 var mtype
= recv
.mtype
252 var ret
= send_commons
(mproperty
, args
, mtype
)
253 if ret
!= null then return ret
254 var propdef
= mproperty
.lookup_first_definition
(self.mainmodule
, mtype
)
255 return self.rt_call
(propdef
, args
)
258 # Same as a regular call but for a runtime injected module
260 fun rt_call
(mpropdef
: MMethodDef, args
: Array[Instance]): nullable Instance
262 args
= call_commons
(mpropdef
, args
)
263 return rt_call_without_varargs
(mpropdef
, args
)
266 # Common code to call and this function
268 # Call only executes the variadic part, this avoids
269 # double encapsulation of variadic parameters into an Array
270 fun rt_call_without_varargs
(mpropdef
: MMethodDef, args
: Array[Instance]): nullable Instance
272 if self.modelbuilder
.toolcontext
.opt_discover_call_trace
.value
and not self.discover_call_trace
.has
(mpropdef
) then
273 self.discover_call_trace
.add mpropdef
274 self.debug
("Discovered {mpropdef}")
276 assert args
.length
== mpropdef
.msignature
.arity
+ 1 else debug
("Invalid arity for {mpropdef}. {args.length} arguments given.")
278 # Look for the AST node that implements the property
279 var mproperty
= mpropdef
.mproperty
280 if self.modelbuilder
.mpropdef2npropdef
.has_key
(mpropdef
) then
281 var npropdef
= self.modelbuilder
.mpropdef2npropdef
[mpropdef
]
282 self.parameter_check
(npropdef
, mpropdef
, args
)
283 if npropdef
isa AMethPropdef then
284 return npropdef
.rt_call
(self, mpropdef
, args
)
286 print
"Error, invalid propdef to call at runtime !"
289 else if mproperty
.name
== "init" then
290 var nclassdef
= self.modelbuilder
.mclassdef2nclassdef
[mpropdef
.mclassdef
]
291 self.parameter_check
(nclassdef
, mpropdef
, args
)
292 return nclassdef
.call
(self, mpropdef
, args
)
294 fatal
("Fatal Error: method {mpropdef} not found in the AST")
299 # Evaluates dynamically a snippet of Nit code
300 # `nit_code` : Nit code to be executed
301 fun eval
(nit_code
: String)
303 var local_toolctx
= modelbuilder
.toolcontext
304 local_toolctx
.dbg
= self
305 var e
= local_toolctx
.parse_something
(nit_code
)
306 if e
isa ABlockExpr then
307 nit_code
= "module rt_module\n" + nit_code
308 e
= local_toolctx
.parse_something
(nit_code
)
311 nit_code
= "module rt_module\nprint " + nit_code
312 e
= local_toolctx
.parse_something
(nit_code
)
314 if e
isa AModule then
315 local_toolctx
.had_error
= false
316 modelbuilder
.load_rt_module
(self.mainmodule
, e
, "rt_module")
317 local_toolctx
.run_phases
([e
])
318 if local_toolctx
.had_error
then
319 modelbuilder
.model
.try_remove_module
(e
.mmodule
.as(not null))
320 local_toolctx
.dbg
= null
325 self.mainmodule
= mmod
326 var local_classdefs
= mmod
.mclassdefs
327 var sys_type
= mmod
.sys_type
328 if sys_type
== null then
329 print
"Fatal error, cannot find Class Sys !\nAborting"
332 var mobj
= new MutableInstance(sys_type
)
334 var initprop
= mmod
.try_get_primitive_method
("init", sys_type
.mclass
)
335 if initprop
!= null then
336 self.send
(initprop
, [mobj
])
338 var mainprop
= mmod
.try_get_primitive_method
("run", sys_type
.mclass
) or else
339 mmod
.try_get_primitive_method
("main", sys_type
.mclass
)
340 if mainprop
!= null then
341 self.rt_send
(mainprop
, [mobj
])
344 print
"Error while loading_rt_module"
347 print
"Error when parsing, e = {e.class_name}"
349 local_toolctx
.dbg
= null
352 # Encpasulates the behaviour for step over/out
353 private fun steps_fun_call
(n
: AExpr)
355 if self.stop_after_step_over_trigger
then
356 if self.frames
.length
<= self.step_stack_count
then
357 n
.debug
("Execute stmt {n.to_s}")
358 while read_cmd
do end
360 else if self.stop_after_step_out_trigger
then
361 if frames
.length
< self.step_stack_count
then
362 n
.debug
("Execute stmt {n.to_s}")
363 while read_cmd
do end
365 else if step_in_trigger
then
366 n
.debug
("Execute stmt {n.to_s}")
367 while read_cmd
do end
371 # Checks if a breakpoint is encountered, and launches the debugging prompt if true
372 private fun breakpoint_check
(n
: AExpr)
374 var currFileNameSplit
= self.frame
.current_node
.location
.file
.filename
.to_s
.split_with
("/")
376 self.curr_file
= currFileNameSplit
[currFileNameSplit
.length-1
]
378 var breakpoint
= find_breakpoint
(curr_file
, n
.location
.line_start
)
380 if breakpoints
.keys
.has
(curr_file
) and breakpoint
!= null then
384 if not breakpoint
.is_valid
386 remove_breakpoint
(curr_file
, n
.location
.line_start
)
389 n
.debug
("Execute stmt {n.to_s}")
390 while read_cmd
do end
394 # Check if a variable of current expression is traced
395 # Then prints and/or breaks for command prompt
396 private fun check_if_vars_are_traced
(n
: AExpr)
398 var identifiers_in_instruction
= get_identifiers_in_current_instruction
(n
.location
.text
)
400 for i
in identifiers_in_instruction
do
401 var variable
= seek_variable
(i
, frame
)
402 for j
in self.traces
do
403 if j
.is_variable_traced_in_frame
(i
, frame
) then
404 n
.debug
("Traced variable {i} used")
405 if j
.break_on_encounter
then while read_cmd
do end
412 # Function remapping all the traced objects to match their name in the local context
413 private fun remap
(n
: AExpr)
415 if self.aftermath
then
417 # Trace every argument variable pre-specified
418 if self.frame_count_aftermath
< frames
.length
and fun_call_arguments_positions
.length
> 0 then
420 var ids_in_fun_def
= get_identifiers_in_current_instruction
(get_function_arguments
(frame
.mpropdef
.location
.text
))
422 for i
in fun_call_arguments_positions
.keys
do
423 self.fun_call_arguments_positions
[i
].add_frame_variable
(frame
, ids_in_fun_def
[i
])
427 self.aftermath
= false
431 # If the current instruction is a function call
432 # We analyse its signature and the position of traced arguments if the call
433 # For future remapping when inside the function
434 private fun check_funcall_and_traced_args
(n
: AExpr) do
435 # If we have a function call, we need to see if any of the arguments is traced (including the caller)
436 # if it is, next time we face an instruction, we'll trace the local version on the traced variable in the next frame
437 if n
isa ACallExpr then
438 self.aftermath
= true
439 self.frame_count_aftermath
= frames
.length
440 fun_call_arguments_positions
.clear
441 var fun_arguments
= get_identifiers_in_current_instruction
(get_function_arguments
(n
.location
.text
))
443 for i
in self.traces
do
444 for j
in [0 .. fun_arguments
.length
- 1] do
445 if i
.is_variable_traced_in_frame
(fun_arguments
[j
],frame
) then
446 fun_call_arguments_positions
[j
] = i
453 #######################################################################
454 ## Processing commands functions ##
455 #######################################################################
460 return process_debug_command
(gets
)
463 # Takes a user command as a parameter
465 # Returns a boolean value, representing whether or not to
466 # continue reading commands from the console input
467 fun process_debug_command
(command
:String): Bool
470 if command
== "finish"
474 else if command
== "s"
478 else if command
== "n" then
480 # Opens a new NitIndex prompt on current model
481 else if command
== "nitx" then
482 new NitIndex.with_infos
(modelbuilder
, self.mainmodule
).prompt
484 # Continues execution until the end
485 else if command
== "c" then
487 else if command
== "nit" then
490 var nit_buf
= new FlatBuffer
491 while not command
== ":q" do
492 nit_buf
.append
(command
)
499 else if command
== "quit" then
501 else if command
== "abort" then
505 var parts_of_command
= command
.split_with
(' ')
506 # Shows the value of a variable in the current frame
507 if parts_of_command
[0] == "p" or parts_of_command
[0] == "print" then
508 print_command
(parts_of_command
)
509 # Places a breakpoint on line x of file y
510 else if parts_of_command
[0] == "break" or parts_of_command
[0] == "b"
512 process_place_break_fun
(parts_of_command
)
513 # Places a temporary breakpoint on line x of file y
514 else if parts_of_command
[0] == "tbreak" and (parts_of_command
.length
== 2 or parts_of_command
.length
== 3)
516 process_place_tbreak_fun
(parts_of_command
)
517 # Removes a breakpoint on line x of file y
518 else if parts_of_command
[0] == "d" or parts_of_command
[0] == "delete" then
519 process_remove_break_fun
(parts_of_command
)
520 # Sets an alias for a variable
521 else if parts_of_command
.length
== 3 and parts_of_command
[1] == "as"
523 add_alias
(parts_of_command
[0], parts_of_command
[2])
524 # Modifies the value of a variable in the current frame
525 else if parts_of_command
.length
>= 3 and parts_of_command
[1] == "=" then
526 process_mod_function
(parts_of_command
)
527 # Traces the modifications on a variable
528 else if parts_of_command
.length
>= 2 and parts_of_command
[0] == "trace" then
529 process_trace_command
(parts_of_command
)
530 # Untraces the modifications on a variable
531 else if parts_of_command
.length
== 2 and parts_of_command
[0] == "untrace" then
532 process_untrace_command
(parts_of_command
)
534 print
"Unknown command \"{command}\
""
540 #######################################################################
541 ## Processing specific command functions ##
542 #######################################################################
544 # Sets the flags to step-over an instruction in the current file
547 self.step_stack_count
= frames
.length
548 self.stop_after_step_over_trigger
= true
549 self.stop_after_step_out_trigger
= false
550 self.step_in_trigger
= false
554 #Sets the flags to step-out of a function
557 self.stop_after_step_over_trigger
= false
558 self.stop_after_step_out_trigger
= true
559 self.step_in_trigger
= false
560 self.step_stack_count
= frames
.length
564 # Sets the flags to step-in an instruction
567 self.step_in_trigger
= true
568 self.stop_after_step_over_trigger
= false
569 self.stop_after_step_out_trigger
= false
573 # Sets the flags to continue execution
574 fun continue_exec
: Bool
576 self.stop_after_step_over_trigger
= false
577 self.stop_after_step_out_trigger
= false
578 self.step_in_trigger
= false
582 # Prints the demanded variable in the command
584 # The name of the variable in in position 1 of the array 'parts_of_command'
585 fun print_command
(parts_of_command
: Array[String])
587 if parts_of_command
[1] == "*" then
588 var map_of_instances
= frame
.map
590 var keys
= map_of_instances
.iterator
592 var self_var
= seek_variable
("self", frame
)
593 print
"self: {self_var.to_s}"
595 for instance
in map_of_instances
.keys
do
596 print
"{instance.to_s}: {map_of_instances[instance].to_s}"
598 else if parts_of_command
[1] == "stack" then
599 print
self.stack_trace
600 else if parts_of_command
[1].chars
.has
('[') and parts_of_command
[1].chars
.has
(']') then
601 process_array_command
(parts_of_command
)
603 var instance
= seek_variable
(get_real_variable_name
(parts_of_command
[1]), frame
)
607 print_instance
(instance
)
609 print
"Cannot find variable {parts_of_command[1]}"
614 # Processes the input string to know where to put a breakpoint
615 fun process_place_break_fun
(parts_of_command
: Array[String])
617 var bp
= get_breakpoint_from_command
(parts_of_command
)
623 # Returns a breakpoint containing the informations stored in the command
624 fun get_breakpoint_from_command
(parts_of_command
: Array[String]): nullable Breakpoint
626 if parts_of_command
[1].is_numeric
then
627 return new Breakpoint(parts_of_command
[1].to_i
, curr_file
)
628 else if parts_of_command
.length
>= 3 and parts_of_command
[2].is_numeric
then
629 return new Breakpoint(parts_of_command
[2].to_i
, parts_of_command
[1])
635 # Processes the command of removing a breakpoint on specified line and file
636 fun process_remove_break_fun
(parts_of_command
: Array[String])
638 if parts_of_command
[1].is_numeric
then
639 remove_breakpoint
(self.curr_file
, parts_of_command
[1].to_i
)
640 else if parts_of_command
.length
>= 3 and parts_of_command
[2].is_numeric
then
641 remove_breakpoint
(parts_of_command
[1], parts_of_command
[2].to_i
)
645 # Processes an array print command
646 fun process_array_command
(parts_of_command
: Array[String])
648 var index_of_first_brace
= parts_of_command
[1].chars
.index_of
('[')
649 var variable_name
= get_real_variable_name
(parts_of_command
[1].substring
(0,index_of_first_brace
))
650 var braces
= parts_of_command
[1].substring_from
(index_of_first_brace
)
652 var indexes
= remove_braces
(braces
)
654 var index_array
= new Array[Array[Int]]
656 if indexes
!= null then
657 for index
in indexes
do
658 var temp_indexes_array
= process_index
(index
)
659 if temp_indexes_array
!= null then
660 index_array
.push
(temp_indexes_array
)
661 #print index_array.last
666 var instance
= seek_variable
(variable_name
, frame
)
668 if instance
!= null then
669 print_nested_collection
(instance
, index_array
, 0, variable_name
, "")
671 print
"Cannot find variable {variable_name}"
675 # Processes the modification function to modify a variable dynamically
677 # Command of type variable = value
678 fun process_mod_function
(parts_of_command
: Array[String])
680 parts_of_command
[0] = get_real_variable_name
(parts_of_command
[0])
681 var parts_of_variable
= parts_of_command
[0].split_with
(".")
683 if parts_of_variable
.length
> 1 then
684 var last_part
= parts_of_variable
.pop
685 var first_part
= parts_of_command
[0].substring
(0,parts_of_command
[0].length
- last_part
.length
- 1)
686 var papa
= seek_variable
(first_part
, frame
)
688 if papa
!= null and papa
isa MutableInstance then
689 var attribute
= get_attribute_in_mutable_instance
(papa
, last_part
)
691 if attribute
!= null then
692 modify_argument_of_complex_type
(papa
, attribute
, parts_of_command
[2])
696 var target
= seek_variable
(parts_of_variable
[0], frame
)
697 if target
!= null then
698 modify_in_frame
(target
, parts_of_command
[2])
703 # Processes the untrace variable command
705 # Command pattern : "untrace variable"
706 fun process_untrace_command
(parts_of_command
: Array[String])
708 var variable_name
= get_real_variable_name
(parts_of_command
[1])
709 if untrace_variable
(variable_name
) then
710 print
"Untraced variable {parts_of_command[1]}"
712 print
"{parts_of_command[1]} is not traced"
716 # Processes the trace variable command
718 # Command pattern : "trace variable [break/print]"
719 fun process_trace_command
(parts_of_command
: Array[String])
721 var variable_name
= get_real_variable_name
(parts_of_command
[1])
724 if seek_variable
(variable_name
, frame
) == null then
725 print
"Cannot find a variable called {parts_of_command[1]}"
729 if parts_of_command
.length
== 3 then
730 if parts_of_command
[2] == "break" then
739 trace_variable
(variable_name
, breaker
)
741 print
"Successfully tracing {parts_of_command[1]}"
744 #######################################################################
745 ## Trace Management functions ##
746 #######################################################################
748 # Effectively untraces the variable called *variable_name*
750 # Returns true if the variable exists, false otherwise
751 private fun untrace_variable
(variable_name
: String): Bool
753 var to_remove
: nullable TraceObject = null
754 for i
in self.traces
do
755 if i
.is_variable_traced_in_frame
(variable_name
, frame
) then
760 if to_remove
!= null then
761 self.traces
.remove
(to_remove
)
768 # Effectively traces the variable *variable_name* either in print or break mode depending on the value of breaker (break if true, print if false)
770 private fun trace_variable
(variable_name
: String, breaker
: Bool)
772 for i
in self.traces
do
773 if i
.is_variable_traced_in_frame
(variable_name
, frame
) then
774 print
"This variable is already traced"
779 var trace_object
: TraceObject
782 trace_object
= new TraceObject(true)
784 trace_object
= new TraceObject(false)
787 # We trace the current variable found for the current frame
788 trace_object
.add_frame_variable
(self.frame
, variable_name
)
790 var position_of_variable_in_arguments
= get_position_of_variable_in_arguments
(frame
, variable_name
)
792 # Start parsing the frames starting with the parent of the current one, until the highest
793 # When the variable traced is declared locally, the loop stops
794 for i
in [1 .. frames
.length-1
] do
796 # If the variable was reported to be an argument of the previous frame
797 if position_of_variable_in_arguments
!= -1 then
799 var local_name
= get_identifiers_in_current_instruction
(get_function_arguments
(frames
[i
].current_node
.location
.text
))[position_of_variable_in_arguments
]
801 position_of_variable_in_arguments
= get_position_of_variable_in_arguments
(frames
[i
], local_name
)
803 trace_object
.add_frame_variable
(frames
[i
], local_name
)
809 self.traces
.add
(trace_object
)
812 # If the variable *variable_name* is an argument of the function being executed in the frame *frame*
813 # The function returns its position in the arguments
814 # Else, it returns -1
815 private fun get_position_of_variable_in_arguments
(frame
: Frame, variable_name
: String): Int
817 var identifiers
= get_identifiers_in_current_instruction
(get_function_arguments
(frame
.mpropdef
.location
.text
))
818 for i
in [0 .. identifiers
.length-1
] do
819 # If the current traced variable is an argument of the current function, we trace its parent (at least)
820 if identifiers
[i
] == variable_name
then return i
825 # Gets all the identifiers of an instruction (uses the rules of Nit as of Mar 05 2013)
827 fun get_identifiers_in_current_instruction
(instruction
: Text): Array[String]
829 var result_array
= new Array[String]
830 var instruction_buffer
= new FlatBuffer
832 var trigger_char_escape
= false
833 var trigger_string_escape
= false
834 var trigger_concat_in_string
= false
836 for i
in instruction
.chars
do
837 if trigger_char_escape
then
838 if i
== '\'' then trigger_char_escape = false
839 else if trigger_string_escape then
841 trigger_concat_in_string = true
842 trigger_string_escape = false
843 else if i == '\
"' then trigger_string_escape = false
845 if i.is_alphanumeric or i == '_' then
846 instruction_buffer.add(i)
847 else if i == '.' then
848 if instruction_buffer.is_numeric or (instruction_buffer.chars[0] >= 'A' and instruction_buffer.chars[0] <= 'Z') then
849 instruction_buffer.clear
851 result_array.push(instruction_buffer.to_s)
852 instruction_buffer.add(i)
854 else if i == '\'' then
855 trigger_char_escape = true
856 else if i == '\"' then
857 trigger_string_escape = true
858 else if i == '}' then
859 trigger_concat_in_string = false
860 trigger_string_escape = true
862 if instruction_buffer.length > 0 and not instruction_buffer.is_numeric and not (instruction_buffer.chars[0] >= 'A
' and instruction_buffer.chars[0] <= 'Z
') then result_array.push(instruction_buffer.to_s)
863 instruction_buffer.clear
868 if instruction_buffer.length > 0 and not instruction_buffer.is_numeric and not (instruction_buffer.chars[0] >= 'A
' and instruction_buffer.chars[0] <= 'Z
') then result_array.push(instruction_buffer.to_s)
873 # Takes a function call or declaration and strips all but the arguments
875 fun get_function_arguments(function: Text): String
877 var buf = new FlatBuffer
878 var trigger_copy = false
880 for i in function.chars do
881 if i == ')' then break
882 if trigger_copy then buf.add(i)
883 if i == '(' then trigger_copy = true
889 #######################################################################
890 ## Alias management functions ##
891 #######################################################################
893 # Adds a new alias to the tables
894 fun add_alias(var_represented: String, alias: String)
896 self.aliases[alias] = var_represented
899 # Gets the real name of a variable hidden by an alias
900 fun get_variable_name_by_alias(alias: String): nullable String
902 if self.aliases.keys.has(alias) then
903 return self.aliases[alias]
909 # Gets the variable named by name, whether it is an alias or not
910 fun get_real_variable_name(name: String): String
912 var explode_string = name.split_with(".")
913 var final_string = new FlatBuffer
914 for i in explode_string do
915 var alias_resolved = get_variable_name_by_alias(i)
916 if alias_resolved != null then
917 final_string.append(get_real_variable_name(alias_resolved))
919 final_string.append(i)
921 final_string.append(".")
924 return final_string.substring(0,final_string.length-1).to_s
927 #######################################################################
928 ## Print functions ##
929 #######################################################################
931 # Prints an object instance and its attributes if it has some
933 # If it is a primitive type, its value is directly printed
934 fun print_instance(instance: Instance)
936 if instance isa MutableInstance then
938 print "\ttype : {instance},"
942 print instance.attributes.join(",\n\t"," : ")
950 # Prints the attributes demanded in a SequenceRead
951 # Used recursively to print nested collections
952 fun print_nested_collection(instance: Instance, indexes: Array[Array[Int]], depth: Int, variable_name: String, depth_string: String)
954 var collection: nullable SequenceRead[Object] = null
955 var real_collection_length: nullable Int = null
957 if instance isa MutableInstance then
958 real_collection_length = get_collection_instance_real_length(instance)
959 collection = get_primary_collection(instance)
962 if collection != null and real_collection_length != null then
963 for i in indexes[depth] do
964 if i >= 0 and i < real_collection_length then
965 if depth == indexes.length-1 then
966 print "{variable_name}{depth_string}[{i}] = {collection[i]}"
968 var item_i = collection[i]
970 if item_i isa MutableInstance then
971 print_nested_collection(item_i, indexes, depth+1, variable_name, depth_string+"[{i}]")
973 print "The item at {variable_name}{depth_string}[{i}] is not a collection"
978 print "Out of bounds exception : i = {i} and collection_length = {real_collection_length.to_s}"
982 else if i >= real_collection_length then
988 if collection == null then
989 print "Cannot find {variable_name}{depth_string}"
990 else if real_collection_length != null then
991 print "Cannot find attribute length in {instance}"
993 print "Unknown error."
999 #######################################################################
1000 ## Variable Exploration functions ##
1001 #######################################################################
1003 # Seeks a variable from the current frame called 'variable_path
', can introspect complex objects using function get_variable_in_mutable_instance
1004 private fun seek_variable(variable_path: String, frame: Frame): nullable Instance
1006 var full_variable = variable_path.split_with(".")
1008 var full_variable_iterator = full_variable.iterator
1010 var first_instance = get_variable_in_frame(full_variable_iterator.item, frame)
1012 if first_instance == null then return null
1014 if full_variable.length <= 1 then return first_instance
1016 full_variable_iterator.next
1018 if not (first_instance isa MutableInstance and full_variable_iterator.is_ok) then return null
1020 return get_variable_in_mutable_instance(first_instance, full_variable_iterator)
1023 # Gets a variable 'variable_name
' contained in the frame 'frame
'
1024 private fun get_variable_in_frame(variable_name: String, frame: Frame): nullable Instance
1026 if variable_name == "self" then
1027 if frame.arguments.length >= 1 then return frame.arguments.first
1030 var map_of_instances = frame.map
1032 for key in map_of_instances.keys do
1033 if key.to_s == variable_name then
1034 return map_of_instances[key]
1041 # Gets an attribute 'attribute_name
' contained in variable 'variable
'
1042 fun get_attribute_in_mutable_instance(variable: MutableInstance, attribute_name: String): nullable MAttribute
1044 var map_of_attributes = variable.attributes
1046 for key in map_of_attributes.keys do
1047 if key.to_s.substring_from(1) == attribute_name then
1055 # Recursive function, returns the variable described by 'total_chain
'
1056 fun get_variable_in_mutable_instance(variable: MutableInstance, iterator: Iterator[String]): nullable Instance
1058 var attribute = get_attribute_in_mutable_instance(variable, iterator.item)
1060 if attribute == null then return null
1064 if iterator.is_ok then
1065 var new_variable = variable.attributes[attribute]
1066 if new_variable isa MutableInstance then
1067 return get_variable_in_mutable_instance(new_variable, iterator)
1072 return variable.attributes[attribute]
1076 #######################################################################
1077 ## Array exploring functions ##
1078 #######################################################################
1080 # Gets the length of a collection
1081 # Used by the debugger, else if we call Collection.length, it returns the capacity instead
1082 fun get_collection_instance_real_length(collection: MutableInstance): nullable Int
1084 var collection_length_attribute = get_attribute_in_mutable_instance(collection, "length")
1086 var real_collection_length: nullable Int = null
1088 if collection_length_attribute != null then
1089 var primitive_length_instance = collection.attributes[collection_length_attribute]
1090 if primitive_length_instance isa PrimitiveInstance[Int] then
1091 return primitive_length_instance.val
1098 # Processes the indexes of a print array call
1099 # Returns an array containing all the indexes demanded
1100 fun process_index(index_string: String): nullable Array[Int]
1102 var from_end_index = index_string.chars.index_of('.')
1103 var to_start_index = index_string.chars.last_index_of('.')
1105 if from_end_index != -1 and to_start_index != -1 then
1106 var index_from_string = index_string.substring(0,from_end_index)
1107 var index_to_string = index_string.substring_from(to_start_index+1)
1109 if index_from_string.is_numeric and index_to_string.is_numeric then
1110 var result_array = new Array[Int]
1112 var index_from = index_from_string.to_i
1113 var index_to = index_to_string.to_i
1115 for i in [index_from..index_to] do
1116 result_array.push(i)
1122 if index_string.is_numeric
1124 var result_array = new Array[Int]
1126 result_array.push(index_string.to_i)
1137 # Gets a collection in a MutableInstance
1138 fun get_primary_collection(container: MutableInstance): nullable SequenceRead[Object]
1140 var items_of_array = get_attribute_in_mutable_instance(container, "items")
1141 if items_of_array != null then
1142 var array = container.attributes[items_of_array]
1144 if array isa PrimitiveInstance[Object] then
1145 var sequenceRead_final = array.val
1146 if sequenceRead_final isa SequenceRead[Object] then
1147 return sequenceRead_final
1155 # Removes the braces '[' ']' in a print array command
1156 # Returns an array containing their content
1157 fun remove_braces(braces: String): nullable Array[String]
1159 var buffer = new FlatBuffer
1161 var result_array = new Array[String]
1163 var number_of_opening_brackets = 0
1164 var number_of_closing_brackets = 0
1166 var last_was_opening_bracket = false
1168 for i in braces.chars do
1170 if last_was_opening_bracket then
1174 number_of_opening_brackets += 1
1175 last_was_opening_bracket = true
1176 else if i == ']' then
1177 if not last_was_opening_bracket then
1181 result_array.push(buffer.to_s)
1183 number_of_closing_brackets += 1
1184 last_was_opening_bracket = false
1185 else if i.is_numeric or i == '.' then
1186 buffer.append(i.to_s)
1187 else if not i == ' ' then
1192 if number_of_opening_brackets != number_of_closing_brackets then
1199 #######################################################################
1200 ## Breakpoint placing functions ##
1201 #######################################################################
1203 # Places a breakpoint on line 'line_to_break
' for file 'file_to_break
'
1204 fun place_breakpoint(breakpoint: Breakpoint)
1206 if not self.breakpoints.keys.has(breakpoint.file) then
1207 self.breakpoints[breakpoint.file] = new HashSet[Breakpoint]
1209 if find_breakpoint(breakpoint.file, breakpoint.line) == null then
1210 self.breakpoints[breakpoint.file].add(breakpoint)
1211 print "Breakpoint added on line {breakpoint.line} for file {breakpoint.file}"
1213 print "Breakpoint already present on line {breakpoint.line} for file {breakpoint.file}"
1217 #Places a breakpoint that will trigger once and be destroyed afterwards
1218 fun process_place_tbreak_fun(parts_of_command: Array[String])
1220 var bp = get_breakpoint_from_command(parts_of_command)
1223 bp.set_max_breaks(1)
1224 place_breakpoint(bp)
1228 #######################################################################
1229 ## Breakpoint removing functions ##
1230 #######################################################################
1232 # Removes a breakpoint on line 'line_to_break
' for file 'file_to_break
'
1233 fun remove_breakpoint(file_to_break: String, line_to_break: Int)
1235 if self.breakpoints.keys.has(file_to_break) then
1236 var bp = find_breakpoint(file_to_break, line_to_break)
1239 self.breakpoints[file_to_break].remove(bp)
1240 print "Breakpoint removed on line {line_to_break} for file {file_to_break}"
1245 print "No breakpoint existing on line {line_to_break} for file {file_to_break}"
1248 #######################################################################
1249 ## Breakpoint searching functions ##
1250 #######################################################################
1252 # Finds a breakpoint for 'file
' and 'line
' in the class HashMap
1253 fun find_breakpoint(file: String, line: Int): nullable Breakpoint
1255 if self.breakpoints.keys.has(file)
1257 for i in self.breakpoints[file]
1269 #######################################################################
1270 ## Runtime modification functions ##
1271 #######################################################################
1273 # Modifies the value of a variable contained in a frame
1274 fun modify_in_frame(variable: Instance, value: String)
1276 var new_variable = get_variable_of_type_with_value(variable.mtype.to_s, value)
1277 if new_variable != null
1279 var keys = frame.map.keys
1282 if frame.map[key] == variable
1284 frame.map[key] = new_variable
1290 # Modifies the value of a variable contained in a MutableInstance
1291 fun modify_argument_of_complex_type(papa: MutableInstance, attribute: MAttribute, value: String)
1293 var final_variable = papa.attributes[attribute]
1294 var type_of_variable = final_variable.mtype.to_s
1295 var new_variable = get_variable_of_type_with_value(type_of_variable, value)
1296 if new_variable != null
1298 papa.attributes[attribute] = new_variable
1302 #######################################################################
1303 ## Variable generator functions ##
1304 #######################################################################
1306 # Returns a new variable of the type 'type_of_variable
' with a value of 'value
'
1307 fun get_variable_of_type_with_value(type_of_variable: String, value: String): nullable Instance
1309 if type_of_variable == "Int" then
1310 return get_int(value)
1311 else if type_of_variable == "Float" then
1312 return get_float(value)
1313 else if type_of_variable == "Bool" then
1314 return get_bool(value)
1315 else if type_of_variable == "Char" then
1316 return get_char(value)
1322 # Returns a new int instance with value 'value
'
1323 fun get_int(value: String): nullable Instance
1325 if value.is_numeric then
1326 return int_instance(value.to_i)
1332 # Returns a new float instance with value 'value
'
1333 fun get_float(value:String): nullable Instance
1335 if value.is_numeric then
1336 return float_instance(value.to_f)
1342 # Returns a new char instance with value 'value
'
1343 fun get_char(value: String): nullable Instance
1345 if value.length >= 1 then
1346 return char_instance(value.chars[0])
1352 # Returns a new bool instance with value 'value
'
1353 fun get_bool(value: String): nullable Instance
1355 if value.to_lower == "true" then
1356 return self.true_instance
1357 else if value.to_lower == "false" then
1358 return self.false_instance
1360 print "Invalid value, a boolean must be set at \"true\" or \"false\""
1367 redef class AMethPropdef
1369 # Same as call except it will copy local variables of the parent frame to the frame defined in this call.
1370 # Not supposed to be used by anyone else than the Debugger.
1371 private fun rt_call(v: Debugger, mpropdef: MMethodDef, args: Array[Instance]): nullable Instance
1373 var f = new Frame(self, self.mpropdef.as(not null), args)
1374 var curr_instances = v.frame.map
1375 for i in curr_instances.keys do
1376 f.map[i] = curr_instances[i]
1378 call_commons(v,mpropdef,args,f)
1379 var currFra = v.frames.shift
1380 for i in curr_instances.keys do
1381 if currFra.map.keys.has(i) then
1382 curr_instances[i] = currFra.map[i]
1385 if v.returnmark == f then
1387 var res = v.escapevalue
1388 v.escapevalue = null
1396 # Traces the modifications of an object linked to a certain frame
1397 private class TraceObject
1399 # Map of the local names bound to a frame
1400 var trace_map: HashMap[Frame, String]
1401 # Decides if breaking or printing statement when the variable is encountered
1402 var break_on_encounter: Bool
1404 init(break_on_encounter: Bool)
1406 trace_map = new HashMap[Frame, String]
1407 self.break_on_encounter = break_on_encounter
1410 # Adds the local alias for a variable and the frame bound to it
1411 fun add_frame_variable(frame: Frame, variable_name: String)
1413 self.trace_map[frame] = variable_name
1416 # Checks if the prompted variable is traced in the specified frame
1417 fun is_variable_traced_in_frame(variable_name: String, frame: Frame): Bool
1419 if self.trace_map.has_key(frame) then
1420 if self.trace_map[frame] == variable_name then
1432 # Breaks automatically when encountering an error
1433 # Permits the injunction of commands before crashing
1434 redef private fun fatal(v: NaiveInterpreter, message: String)
1436 if v isa Debugger then
1437 print "An error was encountered, the program will stop now."
1439 while v.process_debug_command(gets) do end