Nemiver  0.3
Public Member Functions | List of all members
nemiver::IDBGPerspective Class Referenceabstract

#include <nmv-dbg-perspective.h>

Inheritance diagram for nemiver::IDBGPerspective:
nemiver::IPerspective nemiver::common::Plugin::EntryPoint nemiver::common::DynModIface nemiver::common::Object

Public Member Functions

 IDBGPerspective (DynamicModule *a_dynmod)
 
virtual ~IDBGPerspective ()
 
virtual void do_init (IWorkbench *a_workbench)=0
 
virtual const UStringget_perspective_identifier ()=0
 
virtual void get_toolbars (list< Gtk::Widget * > &a_tbs)=0
 
virtual Gtk::Widget * get_body ()=0
 
virtual Gtk::Widget & get_source_view_widget ()=0
 
virtual IWorkbenchget_workbench ()=0
 
virtual void edit_workbench_menu ()=0
 
virtual void open_file ()=0
 open a source file More...
 
virtual bool open_file (const UString &a_uri, int current_line=-1)=0
 open a source file from a url More...
 
virtual void close_current_file ()=0
 close the currently selected file More...
 
virtual void close_file (const UString &a_uri)=0
 closes a file More...
 
virtual Gtk::Widget * load_menu (const UString &a_filename, const UString &a_widget_name)=0
 load a menu file More...
 
virtual void close_opened_files ()=0
 
virtual ISessMgrsession_manager ()=0
 
virtual void execute_session (ISessMgr::Session &a_session)=0
 
virtual void execute_program ()=0
 
virtual void execute_program (const UString &a_prog, const vector< UString > &a_args, const map< UString, UString > &a_env, const UString &a_cwd=".", bool a_close_opened_files=false, bool a_break_in_main_run=true)=0
 
virtual void execute_program (const UString &a_prog, const vector< UString > &a_args, const map< UString, UString > &a_env, const UString &a_cwd, const vector< IDebugger::Breakpoint > &a_breaks, bool a_check_is_new_program=true, bool a_close_opened_files=false, bool a_break_in_main_run=true)=0
 
virtual void attach_to_program (unsigned int a_pid, bool a_close_open_files=false)=0
 
virtual void connect_to_remote_target (const UString &a_server_address, unsigned a_server_port, const UString &a_prog_path, const UString &a_solib_prefix)=0
 
virtual void connect_to_remote_target (const UString &a_serial_line, const UString &a_prog_path, const UString &a_solib_prefix)=0
 
virtual void load_core_file ()=0
 
virtual void load_core_file (const UString &a_prog_path, const UString &a_core_file_path)=0
 
virtual void run ()=0
 
virtual void step_over ()=0
 
virtual void step_into ()=0
 
virtual void step_out ()=0
 
virtual void do_continue ()=0
 
virtual void set_breakpoint ()=0
 
virtual void set_breakpoint (const UString &a_file, int a_line, const UString &a_condition, bool a_is_count_point)=0
 
virtual void set_breakpoint (const UString &a_func_name, const UString &a_condition, bool a_is_count_point)=0
 
virtual void set_breakpoint (const IDebugger::Breakpoint &a_breakpoint)=0
 
virtual void append_breakpoints (const map< string, IDebugger::Breakpoint > &a_breaks)=0
 
virtual bool delete_breakpoint ()=0
 
virtual bool delete_breakpoint (const string &a_breakpoint_num)=0
 
virtual bool delete_breakpoint (const UString &a_file_uri, int a_linenum)=0
 
virtual IDebuggerSafePtrdebugger ()=0
 
virtual bool set_where (const UString &a_uri, int line, bool a_do_scroll=true)=0
 
virtual Gtk::Widget * get_contextual_menu ()=0
 
virtual IConfMgrget_conf_mgr ()=0
 
virtual bool uses_launch_terminal () const =0
 
virtual void uses_launch_terminal (bool a_flag)=0
 
virtual sigc::signal< void, bool > & activated_signal ()=0
 
virtual sigc::signal< void > & layout_changed_signal ()=0
 
virtual bool agree_to_shutdown ()=0
 Should return true to allow shutdown. This Method will be called for each perspective before workbench initiates a shutdown (). This is a chance given to the perspective to veto the shutdown (). Each perspective has to implement this function wherein it can decide for itself whether it wants to veto the shutdown or not. Returning 'true' from here means that the perspective is ok with the shutdown returning 'false' vetoes the shutdown and nemiver does not go down. More...
 
signals
- Public Member Functions inherited from nemiver::common::Plugin::EntryPoint
bool build_absolute_resource_path (const UString &a_relative_path, std::string &a_absolute_path)
 
const UStringplugin_path ()
 
virtual ~EntryPoint ()
 
DescriptorSafePtr descriptor ()
 
- Public Member Functions inherited from nemiver::common::DynModIface
 DynModIface (DynamicModuleSafePtr &a_dynmod)
 
 DynModIface (DynamicModule *a_dynmod)
 
DynamicModuleget_dynamic_module () const
 
- Public Member Functions inherited from nemiver::common::Object
 Object ()
 
 Object (Object const &)
 
Objectoperator= (Object const &)
 
virtual ~Object ()
 
void ref ()
 
void unref ()
 
void enable_refcount (bool a_enabled=true)
 
bool is_refcount_enabled () const
 
long get_refcount () const
 
void attach_object (const UString &a_key, const Object *a_object)
 
bool get_attached_object (const UString &a_key, const Object *&a_object)
 

Additional Inherited Members

- Public Types inherited from nemiver::common::Plugin::EntryPoint
typedef SafePtr< Loader, ObjectRef, ObjectUnrefLoaderSafePtr
 
- Protected Member Functions inherited from nemiver::IPerspective
 IPerspective (DynamicModule *a_dynmod)
 
- Protected Member Functions inherited from nemiver::common::Plugin::EntryPoint
Plugin::EntryPoint::LoaderSafePtr plugin_entry_point_loader ()
 
void plugin_entry_point_loader (Plugin::EntryPoint::LoaderSafePtr &)
 
 EntryPoint (DynamicModuleSafePtr &a_module)
 
 EntryPoint (DynamicModule *a_module)
 
virtual void activate (bool a_activate, ObjectSafePtr &a_activation_context)
 
virtual bool is_activated ()
 
void descriptor (DescriptorSafePtr &a_desc)
 
- Protected Attributes inherited from nemiver::common::Object
SafePtr< ObjectPrivm_priv
 

Constructor & Destructor Documentation

◆ IDBGPerspective()

nemiver::IDBGPerspective::IDBGPerspective ( DynamicModule a_dynmod)
inline

◆ ~IDBGPerspective()

virtual nemiver::IDBGPerspective::~IDBGPerspective ( )
inlinevirtual

Member Function Documentation

◆ activated_signal()

virtual sigc::signal<void, bool>& nemiver::IDBGPerspective::activated_signal ( )
pure virtual

This signal is emited to notify the perspective about its activation state (whether it is activated or not).

Implements nemiver::IPerspective.

◆ agree_to_shutdown()

virtual bool nemiver::IDBGPerspective::agree_to_shutdown ( )
pure virtual

Should return true to allow shutdown. This Method will be called for each perspective before workbench initiates a shutdown (). This is a chance given to the perspective to veto the shutdown (). Each perspective has to implement this function wherein it can decide for itself whether it wants to veto the shutdown or not. Returning 'true' from here means that the perspective is ok with the shutdown returning 'false' vetoes the shutdown and nemiver does not go down.

Implements nemiver::IPerspective.

◆ append_breakpoints()

virtual void nemiver::IDBGPerspective::append_breakpoints ( const map< string, IDebugger::Breakpoint > &  a_breaks)
pure virtual

◆ attach_to_program()

virtual void nemiver::IDBGPerspective::attach_to_program ( unsigned int  a_pid,
bool  a_close_open_files = false 
)
pure virtual

◆ close_current_file()

virtual void nemiver::IDBGPerspective::close_current_file ( )
pure virtual

close the currently selected file

Implements nemiver::IPerspective.

◆ close_file()

virtual void nemiver::IDBGPerspective::close_file ( const UString a_uri)
pure virtual

closes a file

Parameters
a_urithe uri that identifies the file to close

Implements nemiver::IPerspective.

◆ close_opened_files()

virtual void nemiver::IDBGPerspective::close_opened_files ( )
pure virtual

◆ connect_to_remote_target() [1/2]

virtual void nemiver::IDBGPerspective::connect_to_remote_target ( const UString a_serial_line,
const UString a_prog_path,
const UString a_solib_prefix 
)
pure virtual

◆ connect_to_remote_target() [2/2]

virtual void nemiver::IDBGPerspective::connect_to_remote_target ( const UString a_server_address,
unsigned  a_server_port,
const UString a_prog_path,
const UString a_solib_prefix 
)
pure virtual

◆ debugger()

virtual IDebuggerSafePtr& nemiver::IDBGPerspective::debugger ( )
pure virtual

◆ delete_breakpoint() [1/3]

virtual bool nemiver::IDBGPerspective::delete_breakpoint ( )
pure virtual

◆ delete_breakpoint() [2/3]

virtual bool nemiver::IDBGPerspective::delete_breakpoint ( const string &  a_breakpoint_num)
pure virtual

◆ delete_breakpoint() [3/3]

virtual bool nemiver::IDBGPerspective::delete_breakpoint ( const UString a_file_uri,
int  a_linenum 
)
pure virtual

◆ do_continue()

virtual void nemiver::IDBGPerspective::do_continue ( )
pure virtual

◆ do_init()

virtual void nemiver::IDBGPerspective::do_init ( IWorkbench a_workbench)
pure virtual

initialize the perspective within the context of of the workbench that loads it.

Parameters
a_workbench,theworkbench that loaded the current perspective.

Implements nemiver::IPerspective.

◆ edit_workbench_menu()

virtual void nemiver::IDBGPerspective::edit_workbench_menu ( )
pure virtual

This method is only called once, during the perspective's initialisation time, by the workbench.

Implements nemiver::IPerspective.

◆ execute_program() [1/3]

virtual void nemiver::IDBGPerspective::execute_program ( )
pure virtual

◆ execute_program() [2/3]

virtual void nemiver::IDBGPerspective::execute_program ( const UString a_prog,
const vector< UString > &  a_args,
const map< UString, UString > &  a_env,
const UString a_cwd,
const vector< IDebugger::Breakpoint > &  a_breaks,
bool  a_check_is_new_program = true,
bool  a_close_opened_files = false,
bool  a_break_in_main_run = true 
)
pure virtual

◆ execute_program() [3/3]

virtual void nemiver::IDBGPerspective::execute_program ( const UString a_prog,
const vector< UString > &  a_args,
const map< UString, UString > &  a_env,
const UString a_cwd = ".",
bool  a_close_opened_files = false,
bool  a_break_in_main_run = true 
)
pure virtual

◆ execute_session()

virtual void nemiver::IDBGPerspective::execute_session ( ISessMgr::Session a_session)
pure virtual

◆ get_body()

virtual Gtk::Widget* nemiver::IDBGPerspective::get_body ( )
pure virtual
Returns
the body of the perspective.

Implements nemiver::IPerspective.

◆ get_conf_mgr()

virtual IConfMgr& nemiver::IDBGPerspective::get_conf_mgr ( )
pure virtual

◆ get_contextual_menu()

virtual Gtk::Widget* nemiver::IDBGPerspective::get_contextual_menu ( )
pure virtual

◆ get_perspective_identifier()

virtual const UString& nemiver::IDBGPerspective::get_perspective_identifier ( )
pure virtual

Get a unique identifier of the perspective. It is a good practice that this remains legible.

Returns
the unique identifier of the of the perspective.

Implements nemiver::IPerspective.

◆ get_source_view_widget()

virtual Gtk::Widget& nemiver::IDBGPerspective::get_source_view_widget ( )
pure virtual

◆ get_toolbars()

virtual void nemiver::IDBGPerspective::get_toolbars ( list< Gtk::Widget * > &  a_tbs)
pure virtual

this method is called by the Workbench when the perspective is first set in it. \params a_tbs the list of toolbars. The implementation of this method must fill this parameter with the list of toolbars it wants the workbench to display when this perspective becomes active.

Implements nemiver::IPerspective.

◆ get_workbench()

virtual IWorkbench& nemiver::IDBGPerspective::get_workbench ( )
pure virtual
Returns
the workbench associated to this perspective

Implements nemiver::IPerspective.

◆ layout_changed_signal()

virtual sigc::signal<void>& nemiver::IDBGPerspective::layout_changed_signal ( )
pure virtual

This signal is emited to notify the workbench when the layout of the perspective changes.

Implements nemiver::IPerspective.

◆ load_core_file() [1/2]

virtual void nemiver::IDBGPerspective::load_core_file ( )
pure virtual

◆ load_core_file() [2/2]

virtual void nemiver::IDBGPerspective::load_core_file ( const UString a_prog_path,
const UString a_core_file_path 
)
pure virtual

◆ load_menu()

virtual Gtk::Widget* nemiver::IDBGPerspective::load_menu ( const UString a_filename,
const UString a_widget_name 
)
pure virtual

load a menu file

Parameters
a_filenamethe file name of the menu file. It's relative to the "menus" subdirectory of the perspective
a_widget_namethe name of the widget to return as the root of the menu.

Implements nemiver::IPerspective.

◆ open_file() [1/2]

virtual void nemiver::IDBGPerspective::open_file ( )
pure virtual

open a source file

Let the user choose the set of files to open via a file chooser dialog and open them.

Implements nemiver::IPerspective.

◆ open_file() [2/2]

virtual bool nemiver::IDBGPerspective::open_file ( const UString a_uri,
int  a_cur_line = -1 
)
pure virtual

open a source file from a url

Parameters
a_urithe uri of the file to open
a_cur_linethe line to flag as being the current exceution line if set to -1, this parameter is ignored.

Implements nemiver::IPerspective.

◆ run()

virtual void nemiver::IDBGPerspective::run ( )
pure virtual

◆ session_manager()

virtual ISessMgr& nemiver::IDBGPerspective::session_manager ( )
pure virtual

◆ set_breakpoint() [1/4]

virtual void nemiver::IDBGPerspective::set_breakpoint ( )
pure virtual

◆ set_breakpoint() [2/4]

virtual void nemiver::IDBGPerspective::set_breakpoint ( const IDebugger::Breakpoint a_breakpoint)
pure virtual

◆ set_breakpoint() [3/4]

virtual void nemiver::IDBGPerspective::set_breakpoint ( const UString a_file,
int  a_line,
const UString a_condition,
bool  a_is_count_point 
)
pure virtual

◆ set_breakpoint() [4/4]

virtual void nemiver::IDBGPerspective::set_breakpoint ( const UString a_func_name,
const UString a_condition,
bool  a_is_count_point 
)
pure virtual

◆ set_where()

virtual bool nemiver::IDBGPerspective::set_where ( const UString a_uri,
int  line,
bool  a_do_scroll = true 
)
pure virtual

◆ step_into()

virtual void nemiver::IDBGPerspective::step_into ( )
pure virtual

◆ step_out()

virtual void nemiver::IDBGPerspective::step_out ( )
pure virtual

◆ step_over()

virtual void nemiver::IDBGPerspective::step_over ( )
pure virtual

◆ uses_launch_terminal() [1/2]

virtual bool nemiver::IDBGPerspective::uses_launch_terminal ( ) const
pure virtual

◆ uses_launch_terminal() [2/2]

virtual void nemiver::IDBGPerspective::uses_launch_terminal ( bool  a_flag)
pure virtual

The documentation for this class was generated from the following file: