core/DebugCommands.hh

   1 /******************************************************************************
   2  * Copyright (c) 2000-2016 Ericsson Telecom AB
   3  * All rights reserved. This program and the accompanying materials
   4  * are made available under the terms of the Eclipse Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/epl-v10.html
   7  *
   8  * Contributors:
   9  *
  10  *   Baranyi, Botond – initial implementation
  11  *
  12  ******************************************************************************/
  13
  14 #ifndef DEBUGCOMMANDS_HH
  15 #define DEBUGCOMMANDS_HH
  16
  17 /** list of commands coming from the user interface to the debugger (parameters listed in comments) */
  18
  19 // settings
  20 #define D_SWITCH                   1 // 1, "on" or "off"
  21 #define D_SET_BREAKPOINT           2 // 2-3, module name, and line number or function name, + optional batch file name
  22 #define D_REMOVE_BREAKPOINT        3 // 1-2, 'all', or module name + 'all' or line number or function name
  23 #define D_SET_AUTOMATIC_BREAKPOINT 4 // 2-3, "error" or "fail", + "off", or "on" + optional batch file name
  24 #define D_SET_OUTPUT               5 // 1-2, "console", or "file" or "both", + file name
  25 #define D_SET_GLOBAL_BATCH_FILE    6 // 1-2, "off", or "on" + batch file name
  26 #define D_FUNCTION_CALL_CONFIG     7 // 1-2, ring buffer size or "all", or "file" + file name
  27 #define D_PRINT_SETTINGS           8 // 0
  28 // printing and overwriting data
  29 #define D_LIST_COMPONENTS          9 // 0
  30 #define D_SET_COMPONENT           10 // 1, component name or component reference
  31 #define D_PRINT_CALL_STACK        11 // 0
  32 #define D_SET_STACK_LEVEL         12 // 1, stack level
  33 #define D_LIST_VARIABLES          13 // 0-2, optional "local", "global", "comp" or "all", + optional filter (pattern)
  34 #define D_PRINT_VARIABLE          14 // 1+, list of variable names
  35 #define D_OVERWRITE_VARIABLE      15 // 2, variable name, new value (in module parameter syntax)
  36 #define D_PRINT_FUNCTION_CALLS    16 // 0-1, optional "all" or number of calls
  37 // stepping
  38 #define D_STEP_OVER               17 // 0
  39 #define D_STEP_INTO               18 // 0
  40 #define D_STEP_OUT                19 // 0
  41 #define D_RUN_TO_CURSOR           20 // 2, module name, and line number or function name
  42 // the halted state
  43 #define D_HALT                    21 // 0
  44 #define D_CONTINUE                22 // 0
  45 #define D_EXIT                    23 // 1, "test" or "all"
  46 // initialization
  47 #define D_SETUP                   24 // 11+:
  48                                      // 1 argument for D_SWITCH,
  49                                      // 2 arguments for D_SET_OUTPUT,
  50                                      // 2 arguments (2nd and 3rd) for D_SET_AUTOMATIC_BREAKPOINT, where the first argument is "error",
  51                                      // 2 arguments (2nd and 3rd) for D_SET_AUTOMATIC_BREAKPOINT, where the first argument is "fail",
  52                                      // 2 arguments for D_SET_GLOBAL_BATCH_FILE,
  53                                      // 2 arguments for D_FUNCTION_CALL_CONFIG,
  54                                      // + arguments for any number of D_SET_BREAKPOINT commands (optional)
  55
  56 #define D_ERROR                    0 // any
  57
  58 /** names of commands in the user interface */
  59
  60 #define D_SWITCH_TEXT "debug"
  61 #define D_SET_BREAKPOINT_TEXT "dsetbp"
  62 #define D_REMOVE_BREAKPOINT_TEXT "drembp"
  63 #define D_SET_AUTOMATIC_BREAKPOINT_TEXT "dautobp"
  64 #define D_SET_OUTPUT_TEXT "doutput"
  65 #define D_SET_GLOBAL_BATCH_FILE_TEXT "dglobbatch"
  66 #define D_FUNCTION_CALL_CONFIG_TEXT "dcallcfg"
  67 #define D_PRINT_SETTINGS_TEXT "dsettings"
  68 #define D_LIST_COMPONENTS_TEXT "dlistcomp"
  69 #define D_SET_COMPONENT_TEXT "dsetcomp"
  70 #define D_PRINT_CALL_STACK_TEXT "dprintstack"
  71 #define D_SET_STACK_LEVEL_TEXT "dstacklevel"
  72 #define D_LIST_VARIABLES_TEXT "dlistvar"
  73 #define D_PRINT_VARIABLE_TEXT "dprintvar"
  74 #define D_OVERWRITE_VARIABLE_TEXT "dsetvar"
  75 #define D_PRINT_FUNCTION_CALLS_TEXT "dprintcalls"
  76 #define D_STEP_OVER_TEXT "dstepover"
  77 #define D_STEP_INTO_TEXT "dstepinto"
  78 #define D_STEP_OUT_TEXT "dstepout"
  79 #define D_RUN_TO_CURSOR_TEXT "drunto"
  80 #define D_HALT_TEXT "dhalt"
  81 #define D_CONTINUE_TEXT "dcont"
  82 #define D_EXIT_TEXT "dexit"
  83
  84 /** debugger return value types */
  85
  86 #define DRET_NOTIFICATION   0
  87 #define DRET_SETTING_CHANGE 1
  88 #define DRET_DATA           2
  89 #define DRET_EXIT_ALL       3
  90
  91 #endif /* DEBUGCOMMANDS_HH */
  92