gdb/interps.c

   1 /* Manages interpreters for GDB, the GNU debugger.
   2
   3    Copyright (C) 2000, 2002-2003, 2007-2012 Free Software Foundation,
   4    Inc.
   5
   6    Written by Jim Ingham <jingham@apple.com> of Apple Computer, Inc.
   7
   8    This file is part of GDB.
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 3 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  22
  23 /* This is just a first cut at separating out the "interpreter"
  24    functions of gdb into self-contained modules.  There are a couple
  25    of open areas that need to be sorted out:
  26
  27    1) The interpreter explicitly contains a UI_OUT, and can insert itself
  28    into the event loop, but it doesn't explicitly contain hooks for readline.
  29    I did this because it seems to me many interpreters won't want to use
  30    the readline command interface, and it is probably simpler to just let
  31    them take over the input in their resume proc.  */
  32
  33 #include "defs.h"
  34 #include "gdbcmd.h"
  35 #include "ui-out.h"
  36 #include "event-loop.h"
  37 #include "event-top.h"
  38 #include "interps.h"
  39 #include "completer.h"
  40 #include "gdb_string.h"
  41 #include "gdb_assert.h"
  42 #include "top.h"                /* For command_loop.  */
  43 #include "exceptions.h"
  44 #include "continuations.h"
  45
  46 /* True if the current interpreter in is async mode.  See interps.h
  47    for more details.  This starts out disabled, until all the explicit
  48    command line arguments (e.g., `gdb -ex "start" -ex "next"') are
  49    processed.  */
  50 int interpreter_async = 0;
  51
  52 struct interp
  53 {
  54   /* This is the name in "-i=" and set interpreter.  */
  55   const char *name;
  56
  57   /* Interpreters are stored in a linked list, this is the next
  58      one...  */
  59   struct interp *next;
  60
  61   /* This is a cookie that an instance of the interpreter can use.
  62      This is a bit confused right now as the exact initialization
  63      sequence for it, and how it relates to the interpreter's uiout
  64      object is a bit confused.  */
  65   void *data;
  66
  67   /* Has the init_proc been run?  */
  68   int inited;
  69
  70   const struct interp_procs *procs;
  71   int quiet_p;
  72 };
  73
  74 /* Functions local to this file.  */
  75 static void initialize_interps (void);
  76
  77 /* The magic initialization routine for this module.  */
  78
  79 void _initialize_interpreter (void);
  80
  81 /* Variables local to this file: */
  82
  83 static struct interp *interp_list = NULL;
  84 static struct interp *current_interpreter = NULL;
  85 static struct interp *top_level_interpreter_ptr = NULL;
  86
  87 static int interpreter_initialized = 0;
  88
  89 /* interp_new - This allocates space for a new interpreter,
  90    fills the fields from the inputs, and returns a pointer to the
  91    interpreter.  */
  92 struct interp *
  93 interp_new (const char *name, const struct interp_procs *procs)
  94 {
  95   struct interp *new_interp;
  96
  97   new_interp = XMALLOC (struct interp);
  98
  99   new_interp->name = xstrdup (name);
 100   new_interp->data = NULL;
 101   new_interp->quiet_p = 0;
 102   new_interp->procs = procs;
 103   new_interp->inited = 0;
 104
 105   return new_interp;
 106 }
 107
 108 /* Add interpreter INTERP to the gdb interpreter list.  The
 109    interpreter must not have previously been added.  */
 110 void
 111 interp_add (struct interp *interp)
 112 {
 113   if (!interpreter_initialized)
 114     initialize_interps ();
 115
 116   gdb_assert (interp_lookup (interp->name) == NULL);
 117
 118   interp->next = interp_list;
 119   interp_list = interp;
 120 }
 121
 122 /* This sets the current interpreter to be INTERP.  If INTERP has not
 123    been initialized, then this will also run the init proc.  If the
 124    init proc is successful, return 1, if it fails, set the old
 125    interpreter back in place and return 0.  If we can't restore the
 126    old interpreter, then raise an internal error, since we are in
 127    pretty bad shape at this point.
 128
 129    The TOP_LEVEL parameter tells if this new interpreter is
 130    the top-level one.  The top-level is what is requested
 131    on the command line, and is responsible for reporting general
 132    notification about target state changes.  For example, if
 133    MI is the top-level interpreter, then it will always report
 134    events such as target stops and new thread creation, even if they
 135    are caused by CLI commands.  */
 136 int
 137 interp_set (struct interp *interp, int top_level)
 138 {
 139   struct interp *old_interp = current_interpreter;
 140   int first_time = 0;
 141   char buffer[64];
 142
 143   /* If we already have an interpreter, then trying to
 144      set top level interpreter is kinda pointless.  */
 145   gdb_assert (!top_level || !current_interpreter);
 146   gdb_assert (!top_level || !top_level_interpreter_ptr);
 147
 148   if (current_interpreter != NULL)
 149     {
 150       ui_out_flush (current_uiout);
 151       if (current_interpreter->procs->suspend_proc
 152           && !current_interpreter->procs->suspend_proc (current_interpreter->
 153                                                         data))
 154         {
 155           error (_("Could not suspend interpreter \"%s\"."),
 156                  current_interpreter->name);
 157         }
 158     }
 159   else
 160     {
 161       first_time = 1;
 162     }
 163
 164   current_interpreter = interp;
 165   if (top_level)
 166     top_level_interpreter_ptr = interp;
 167
 168   /* We use interpreter_p for the "set interpreter" variable, so we need
 169      to make sure we have a malloc'ed copy for the set command to free.  */
 170   if (interpreter_p != NULL
 171       && strcmp (current_interpreter->name, interpreter_p) != 0)
 172     {
 173       xfree (interpreter_p);
 174
 175       interpreter_p = xstrdup (current_interpreter->name);
 176     }
 177
 178   /* Run the init proc.  If it fails, try to restore the old interp.  */
 179
 180   if (!interp->inited)
 181     {
 182       if (interp->procs->init_proc != NULL)
 183         {
 184           interp->data = interp->procs->init_proc (interp, top_level);
 185         }
 186       interp->inited = 1;
 187     }
 188
 189   /* Do this only after the interpreter is initialized.  */
 190   current_uiout = interp->procs->ui_out_proc (interp);
 191
 192   /* Clear out any installed interpreter hooks/event handlers.  */
 193   clear_interpreter_hooks ();
 194
 195   if (interp->procs->resume_proc != NULL
 196       && (!interp->procs->resume_proc (interp->data)))
 197     {
 198       if (old_interp == NULL || !interp_set (old_interp, 0))
 199         internal_error (__FILE__, __LINE__,
 200                         _("Failed to initialize new interp \"%s\" %s"),
 201                         interp->name, "and could not restore old interp!\n");
 202       return 0;
 203     }
 204
 205   /* Finally, put up the new prompt to show that we are indeed here.
 206      Also, display_gdb_prompt for the console does some readline magic
 207      which is needed for the console interpreter, at least...  */
 208
 209   if (!first_time)
 210     {
 211       if (!interp_quiet_p (interp))
 212         {
 213           sprintf (buffer, "Switching to interpreter \"%.24s\".\n",
 214                    interp->name);
 215           ui_out_text (current_uiout, buffer);
 216         }
 217       display_gdb_prompt (NULL);
 218     }
 219
 220   return 1;
 221 }
 222
 223 /* interp_lookup - Looks up the interpreter for NAME.  If no such
 224    interpreter exists, return NULL, otherwise return a pointer to the
 225    interpreter.  */
 226 struct interp *
 227 interp_lookup (const char *name)
 228 {
 229   struct interp *interp;
 230
 231   if (name == NULL || strlen (name) == 0)
 232     return NULL;
 233
 234   for (interp = interp_list; interp != NULL; interp = interp->next)
 235     {
 236       if (strcmp (interp->name, name) == 0)
 237         return interp;
 238     }
 239
 240   return NULL;
 241 }
 242
 243 /* Returns the current interpreter.  */
 244
 245 struct ui_out *
 246 interp_ui_out (struct interp *interp)
 247 {
 248   if (interp != NULL)
 249     return interp->procs->ui_out_proc (interp);
 250
 251   return current_interpreter->procs->ui_out_proc (current_interpreter);
 252 }
 253
 254 /* Temporarily overrides the current interpreter.  */
 255 struct interp *
 256 interp_set_temp (const char *name)
 257 {
 258   struct interp *interp = interp_lookup (name);
 259   struct interp *old_interp = current_interpreter;
 260
 261   if (interp)
 262     current_interpreter = interp;
 263   return old_interp;
 264 }
 265
 266 /* Returns the interpreter's cookie.  */
 267
 268 void *
 269 interp_data (struct interp *interp)
 270 {
 271   return interp->data;
 272 }
 273
 274 /* Returns the interpreter's name.  */
 275
 276 const char *
 277 interp_name (struct interp *interp)
 278 {
 279   return interp->name;
 280 }
 281
 282 /* Returns true if the current interp is the passed in name.  */
 283 int
 284 current_interp_named_p (const char *interp_name)
 285 {
 286   if (current_interpreter)
 287     return (strcmp (current_interpreter->name, interp_name) == 0);
 288
 289   return 0;
 290 }
 291
 292 /* This is called in display_gdb_prompt.  If the proc returns a zero
 293    value, display_gdb_prompt will return without displaying the
 294    prompt.  */
 295 int
 296 current_interp_display_prompt_p (void)
 297 {
 298   if (current_interpreter == NULL
 299       || current_interpreter->procs->prompt_proc_p == NULL)
 300     return 0;
 301   else
 302     return current_interpreter->procs->prompt_proc_p (current_interpreter->
 303                                                       data);
 304 }
 305
 306 /* Run the current command interpreter's main loop.  */
 307 void
 308 current_interp_command_loop (void)
 309 {
 310   /* Somewhat messy.  For the moment prop up all the old ways of
 311      selecting the command loop.  `deprecated_command_loop_hook'
 312      should be deprecated.  */
 313   if (deprecated_command_loop_hook != NULL)
 314     deprecated_command_loop_hook ();
 315   else if (current_interpreter != NULL
 316            && current_interpreter->procs->command_loop_proc != NULL)
 317     current_interpreter->procs->command_loop_proc (current_interpreter->data);
 318   else
 319     cli_command_loop ();
 320 }
 321
 322 int
 323 interp_quiet_p (struct interp *interp)
 324 {
 325   if (interp != NULL)
 326     return interp->quiet_p;
 327   else
 328     return current_interpreter->quiet_p;
 329 }
 330
 331 static int
 332 interp_set_quiet (struct interp *interp, int quiet)
 333 {
 334   int old_val = interp->quiet_p;
 335
 336   interp->quiet_p = quiet;
 337   return old_val;
 338 }
 339
 340 /* interp_exec - This executes COMMAND_STR in the current
 341    interpreter.  */
 342 int
 343 interp_exec_p (struct interp *interp)
 344 {
 345   return interp->procs->exec_proc != NULL;
 346 }
 347
 348 struct gdb_exception
 349 interp_exec (struct interp *interp, const char *command_str)
 350 {
 351   if (interp->procs->exec_proc != NULL)
 352     {
 353       return interp->procs->exec_proc (interp->data, command_str);
 354     }
 355   return exception_none;
 356 }
 357
 358 /* A convenience routine that nulls out all the common command hooks.
 359    Use it when removing your interpreter in its suspend proc.  */
 360 void
 361 clear_interpreter_hooks (void)
 362 {
 363   deprecated_init_ui_hook = 0;
 364   deprecated_print_frame_info_listing_hook = 0;
 365   /*print_frame_more_info_hook = 0; */
 366   deprecated_query_hook = 0;
 367   deprecated_warning_hook = 0;
 368   deprecated_interactive_hook = 0;
 369   deprecated_readline_begin_hook = 0;
 370   deprecated_readline_hook = 0;
 371   deprecated_readline_end_hook = 0;
 372   deprecated_register_changed_hook = 0;
 373   deprecated_context_hook = 0;
 374   deprecated_target_wait_hook = 0;
 375   deprecated_call_command_hook = 0;
 376   deprecated_error_begin_hook = 0;
 377   deprecated_command_loop_hook = 0;
 378 }
 379
 380 /* This is a lazy init routine, called the first time the interpreter
 381    module is used.  I put it here just in case, but I haven't thought
 382    of a use for it yet.  I will probably bag it soon, since I don't
 383    think it will be necessary.  */
 384 static void
 385 initialize_interps (void)
 386 {
 387   interpreter_initialized = 1;
 388   /* Don't know if anything needs to be done here...  */
 389 }
 390
 391 static void
 392 interpreter_exec_cmd (char *args, int from_tty)
 393 {
 394   struct interp *old_interp, *interp_to_use;
 395   char **prules = NULL;
 396   char **trule = NULL;
 397   unsigned int nrules;
 398   unsigned int i;
 399   int old_quiet, use_quiet;
 400
 401   if (args == NULL)
 402     error_no_arg (_("interpreter-exec command"));
 403
 404   prules = gdb_buildargv (args);
 405   make_cleanup_freeargv (prules);
 406
 407   nrules = 0;
 408   for (trule = prules; *trule != NULL; trule++)
 409     nrules++;
 410
 411   if (nrules < 2)
 412     error (_("usage: interpreter-exec <interpreter> [ <command> ... ]"));
 413
 414   old_interp = current_interpreter;
 415
 416   interp_to_use = interp_lookup (prules[0]);
 417   if (interp_to_use == NULL)
 418     error (_("Could not find interpreter \"%s\"."), prules[0]);
 419
 420   /* Temporarily set interpreters quiet.  */
 421   old_quiet = interp_set_quiet (old_interp, 1);
 422   use_quiet = interp_set_quiet (interp_to_use, 1);
 423
 424   if (!interp_set (interp_to_use, 0))
 425     error (_("Could not switch to interpreter \"%s\"."), prules[0]);
 426
 427   for (i = 1; i < nrules; i++)
 428     {
 429       struct gdb_exception e = interp_exec (interp_to_use, prules[i]);
 430
 431       if (e.reason < 0)
 432         {
 433           interp_set (old_interp, 0);
 434           interp_set_quiet (interp_to_use, use_quiet);
 435           interp_set_quiet (old_interp, old_quiet);
 436           error (_("error in command: \"%s\"."), prules[i]);
 437         }
 438     }
 439
 440   interp_set (old_interp, 0);
 441   interp_set_quiet (interp_to_use, use_quiet);
 442   interp_set_quiet (old_interp, old_quiet);
 443 }
 444
 445 /* List the possible interpreters which could complete the given text.  */
 446 static VEC (char_ptr) *
 447 interpreter_completer (struct cmd_list_element *ignore, char *text, char *word)
 448 {
 449   int textlen;
 450   VEC (char_ptr) *matches = NULL;
 451   struct interp *interp;
 452
 453   textlen = strlen (text);
 454   for (interp = interp_list; interp != NULL; interp = interp->next)
 455     {
 456       if (strncmp (interp->name, text, textlen) == 0)
 457         {
 458           char *match;
 459
 460           match = (char *) xmalloc (strlen (word) + strlen (interp->name) + 1);
 461           if (word == text)
 462             strcpy (match, interp->name);
 463           else if (word > text)
 464             {
 465               /* Return some portion of interp->name.  */
 466               strcpy (match, interp->name + (word - text));
 467             }
 468           else
 469             {
 470               /* Return some of text plus interp->name.  */
 471               strncpy (match, word, text - word);
 472               match[text - word] = '\0';
 473               strcat (match, interp->name);
 474             }
 475           VEC_safe_push (char_ptr, matches, match);
 476         }
 477     }
 478
 479   return matches;
 480 }
 481
 482 struct interp *
 483 top_level_interpreter (void)
 484 {
 485   return top_level_interpreter_ptr;
 486 }
 487
 488 void *
 489 top_level_interpreter_data (void)
 490 {
 491   gdb_assert (top_level_interpreter_ptr);
 492   return top_level_interpreter_ptr->data;
 493 }
 494
 495 /* This just adds the "interpreter-exec" command.  */
 496 void
 497 _initialize_interpreter (void)
 498 {
 499   struct cmd_list_element *c;
 500
 501   c = add_cmd ("interpreter-exec", class_support,
 502                interpreter_exec_cmd, _("\
 503 Execute a command in an interpreter.  It takes two arguments:\n\
 504 The first argument is the name of the interpreter to use.\n\
 505 The second argument is the command to execute.\n"), &cmdlist);
 506   set_cmd_completer (c, interpreter_completer);
 507 }