X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=gdb%2Finterps.h;h=b44bd687257c92a40cf17548b7620314e07117b9;hb=refs%2Fheads%2Fconcurrent-displaced-stepping-2020-04-01;hp=4ac08453357ca6505c05a8a7241066aaf577ee44;hpb=b2d86570b316c347384c4ba9bb3933ed5e807fca;p=deliverable%2Fbinutils-gdb.git diff --git a/gdb/interps.h b/gdb/interps.h index 4ac0845335..b44bd68725 100644 --- a/gdb/interps.h +++ b/gdb/interps.h @@ -1,6 +1,6 @@ /* Manages interpreters for GDB, the GNU debugger. - Copyright (C) 2000-2016 Free Software Foundation, Inc. + Copyright (C) 2000-2020 Free Software Foundation, Inc. Written by Jim Ingham of Apple Computer, Inc. @@ -25,6 +25,7 @@ struct ui_out; struct interp; struct ui; +class completion_tracker; typedef struct interp *(*interp_factory_func) (const char *name); @@ -35,59 +36,65 @@ typedef struct interp *(*interp_factory_func) (const char *name); extern void interp_factory_register (const char *name, interp_factory_func func); -extern int interp_resume (struct interp *interp); -extern int interp_suspend (struct interp *interp); extern struct gdb_exception interp_exec (struct interp *interp, const char *command); -extern int interp_quiet_p (struct interp *interp); -typedef void *(interp_init_ftype) (struct interp *self, int top_level); -typedef int (interp_resume_ftype) (void *data); -typedef int (interp_suspend_ftype) (void *data); -typedef struct gdb_exception (interp_exec_ftype) (void *data, - const char *command); -typedef void (interp_pre_command_loop_ftype) (struct interp *self); -typedef struct ui_out *(interp_ui_out_ftype) (struct interp *self); +class interp +{ +public: + explicit interp (const char *name); + virtual ~interp () = 0; -typedef int (interp_set_logging_ftype) (struct interp *self, int start_log, - struct ui_file *out, - struct ui_file *logfile); + virtual void init (bool top_level) + {} -typedef int (interp_supports_command_editing_ftype) (struct interp *self); + virtual void resume () = 0; + virtual void suspend () = 0; -struct interp_procs -{ - interp_init_ftype *init_proc; - interp_resume_ftype *resume_proc; - interp_suspend_ftype *suspend_proc; - interp_exec_ftype *exec_proc; + virtual gdb_exception exec (const char *command) = 0; /* Returns the ui_out currently used to collect results for this interpreter. It can be a formatter for stdout, as is the case for the console & mi outputs, or it might be a result formatter. */ - interp_ui_out_ftype *ui_out_proc; + virtual ui_out *interp_ui_out () = 0; /* Provides a hook for interpreters to do any additional setup/cleanup that they might need when logging is enabled or disabled. */ - interp_set_logging_ftype *set_logging_proc; + virtual void set_logging (ui_file_up logfile, bool logging_redirect, + bool debug_redirect) = 0; /* Called before starting an event loop, to give the interpreter a chance to e.g., print a prompt. */ - interp_pre_command_loop_ftype *pre_command_loop_proc; + virtual void pre_command_loop () + {} /* Returns true if this interpreter supports using the readline library; false if it uses GDB's own simplified readline emulation. */ - interp_supports_command_editing_ftype *supports_command_editing_proc; + virtual bool supports_command_editing () + { return false; } + + const char *name () const + { + return m_name; + } + + /* This is the name in "-i=" and "set interpreter". */ +private: + char *m_name; + + /* Interpreters are stored in a linked list, this is the next + one... */ +public: + struct interp *next; + + /* Has the init method been run? */ + bool inited; }; -extern struct interp *interp_new (const char *name, - const struct interp_procs *procs, - void *data); extern void interp_add (struct ui *ui, struct interp *interp); -extern int interp_set (struct interp *interp, int top_level); /* Look up the interpreter for NAME, creating one if none exists yet. If NAME is not a interpreter type previously registered with @@ -95,25 +102,55 @@ extern int interp_set (struct interp *interp, int top_level); the interpreter. */ extern struct interp *interp_lookup (struct ui *ui, const char *name); -extern struct ui_out *interp_ui_out (struct interp *interp); -extern void *interp_data (struct interp *interp); -extern const char *interp_name (struct interp *interp); -extern struct interp *interp_set_temp (const char *name); +/* Set the current UI's top level interpreter to the interpreter named + NAME. Throws an error if NAME is not a known interpreter or the + interpreter fails to initialize. */ +extern void set_top_level_interpreter (const char *name); + +/* Temporarily set the current interpreter, and reset it on + destruction. */ +class scoped_restore_interp +{ +public: + + scoped_restore_interp (const char *name) + : m_interp (set_interp (name)) + { + } + + ~scoped_restore_interp () + { + set_interp (m_interp->name ()); + } + + scoped_restore_interp (const scoped_restore_interp &) = delete; + scoped_restore_interp &operator= (const scoped_restore_interp &) = delete; + +private: + + struct interp *set_interp (const char *name); + + struct interp *m_interp; +}; extern int current_interp_named_p (const char *name); /* Call this function to give the current interpreter an opportunity to do any special handling of streams when logging is enabled or - disabled. START_LOG is 1 when logging is starting, 0 when it ends, - and OUT is the stream for the log file; it will be NULL when - logging is ending. LOGFILE is non-NULL if the output streams - are to be tees, with the log file as one of the outputs. */ - -extern int current_interp_set_logging (int start_log, struct ui_file *out, - struct ui_file *logfile); - -/* Returns opaque data associated with the top-level interpreter. */ -extern void *top_level_interpreter_data (void); + disabled. LOGFILE is the stream for the log file when logging is + starting and is NULL when logging is ending. LOGGING_REDIRECT is + the value of the "set logging redirect" setting. If true, the + interpreter should configure the output streams to send output only + to the logfile. If false, the interpreter should configure the + output streams to send output to both the current output stream + (i.e., the terminal) and the log file. DEBUG_REDIRECT is same as + LOGGING_REDIRECT, but for the value of "set logging debugredirect" + instead. */ +extern void current_interp_set_logging (ui_file_up logfile, + bool logging_redirect, + bool debug_redirect); + +/* Returns the top-level interpreter. */ extern struct interp *top_level_interpreter (void); /* Return the current UI's current interpreter. */ @@ -131,6 +168,13 @@ extern int interp_supports_command_editing (struct interp *interp); chance to e.g., print a prompt. */ extern void interp_pre_command_loop (struct interp *interp); +/* List the possible interpreters which could complete the given + text. */ +extern void interpreter_completer (struct cmd_list_element *ignore, + completion_tracker &tracker, + const char *text, + const char *word); + /* well-known interpreters */ #define INTERP_CONSOLE "console" #define INTERP_MI1 "mi1"