Modular-Kicad milestone B), minor portions: (a2227a75) · Commits · Elphel / kicad-source-mirror

common/basicframe.cpp

+11 −0

Original line number	Original line	Diff line number	Diff line
	@@ -151,6 +151,17 @@ bool EDA_BASE_FRAME::ProcessEvent( wxEvent& aEvent )
	}		}


			bool EDA_BASE_FRAME::Enable( bool enable )
			{
			#if defined(DEBUG)
			const char* type_id = typeid( *this ).name();
			printf( "wxFrame %s: %s\n", type_id, enable ? "enabled" : "disabled" );
			#endif

			return wxFrame::Enable( enable );
			}


	void EDA_BASE_FRAME::onAutoSaveTimer( wxTimerEvent& aEvent )		void EDA_BASE_FRAME::onAutoSaveTimer( wxTimerEvent& aEvent )
	{		{
	if( !doAutoSave() )		if( !doAutoSave() )

common/dialog_shim.cpp

+123 −3

Original line number	Original line	Diff line number	Diff line
	@@ -25,17 +25,45 @@

	#include <dialog_shim.h>		#include <dialog_shim.h>
	#include <kiway_player.h>		#include <kiway_player.h>
			#include <wx/evtloop.h>

			/*
			Quasi-Modal Mode Explained:

			The gtk calls in wxDialog::ShowModal() cause event routing problems if that
			modal dialog then tries to use KIWAY_PLAYER::ShowModal(). The latter shows up
			and mostly works but does not respond to the window decoration close button.
			There is no way to get around this without reversing the gtk calls temporarily.

			Quasi-Modal mode is our own almost modal mode which disables only the parent
			of the DIALOG_SHIM, leaving other frames operable and while staying captured in the
			nested event loop. This avoids the gtk calls and leaves event routing pure
			and sufficient to operate the KIWAY_PLAYER::ShowModal() properly. When using
			ShowQuasiModal() you have to use EndQuasiModal() in your dialogs and not
			EndModal(). There is also IsQuasiModal() but its value can only be true
			when the nested event loop is active. Do not mix the modal and quasi-modal
			functions. Use one set or the other.

			You might find this behavior preferable over a pure modal mode, and it was said
			that only the Mac has this natively, but now other platforms have something
			similar. You CAN use it anywhere for any dialog. But you MUST use it when
			you want to use KIWAY_PLAYER::ShowModal() from a dialog event.
			*/



	DIALOG_SHIM::DIALOG_SHIM( wxWindow* aParent, wxWindowID id, const wxString& title,		DIALOG_SHIM::DIALOG_SHIM( wxWindow* aParent, wxWindowID id, const wxString& title,
	const wxPoint& pos, const wxSize& size, long style, const wxString& name ) :		const wxPoint& pos, const wxSize& size, long style, const wxString& name ) :
	wxDialog( aParent, id, title, pos, size, style, name ),		wxDialog( aParent, id, title, pos, size, style, name ),
	KIWAY_HOLDER( 0 )		KIWAY_HOLDER( 0 ),
			m_qmodal_loop( 0 ),
			m_qmodal_showing( false )
	{		{
	// pray that aParent is either a KIWAY_PLAYER or DIALOG_SHIM derivation.		// pray that aParent is either a KIWAY_PLAYER or DIALOG_SHIM derivation.
	KIWAY_HOLDER* h = dynamic_cast<KIWAY_HOLDER*>( aParent );		KIWAY_HOLDER* h = dynamic_cast<KIWAY_HOLDER*>( aParent );

	wxASSERT_MSG( h,		wxASSERT_MSG( h,
	wxT( "DIALOG_SHIM's parent not derived from KIWAY_PLAYER nor DIALOG_SHIM" ) );		wxT( "DIALOG_SHIM's parent is NULL or not derived from KIWAY_PLAYER nor DIALOG_SHIM" ) );

	if( h )		if( h )
	SetKiway( this, &h->Kiway() );		SetKiway( this, &h->Kiway() );
	@@ -46,6 +74,14 @@ DIALOG_SHIM::DIALOG_SHIM( wxWindow* aParent, wxWindowID id, const wxString& titl
	}		}


			DIALOG_SHIM::~DIALOG_SHIM()
			{
			// if the dialog is quasi-modal, this will end its event loop
			if( IsQuasiModal() )
			EndQuasiModal( wxID_CANCEL );
			}


	// our hashtable is an implementation secret, don't need or want it in a header file		// our hashtable is an implementation secret, don't need or want it in a header file
	#include <hashtables.h>		#include <hashtables.h>
	#include <base_struct.h> // EDA_RECT		#include <base_struct.h> // EDA_RECT
	@@ -92,6 +128,90 @@ bool DIALOG_SHIM::Show( bool show )
	}		}


			bool DIALOG_SHIM::Enable( bool enable )
			{
			#if defined(DEBUG)
			const char* type_id = typeid( *this ).name();
			printf( "wxDialog %s: %s\n", type_id, enable ? "enabled" : "disabled" );
			#endif

			return wxDialog::Enable( enable );
			}


			int DIALOG_SHIM::ShowQuasiModal()
			{
			// toggle a window's "enable" status to disabled, then enabled on exit.
			// exception safe.
			struct ENABLE_DISABLE
			{
			wxWindow* m_win;
			ENABLE_DISABLE( wxWindow* aWindow ) : m_win( aWindow ) { if( m_win ) m_win->Disable(); }
			~ENABLE_DISABLE() { if( m_win ) m_win->Enable(); }
			};

			// This is an exception safe way to zero a pointer before returning.
			// Yes, even though DismissModal() clears this first normally, this is
			// here in case there's an exception before the dialog is dismissed.
			struct NULLER
			{
			void*& m_what;
			NULLER( void*& aPtr ) : m_what( aPtr ) {}
			~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
			} clear_this( (void*&) m_qmodal_loop );


			// release the mouse if it's currently captured as the window having it
			// will be disabled when this dialog is shown -- but will still keep the
			// capture making it impossible to do anything in the modal dialog itself
			wxWindow* win = wxWindow::GetCapture();
			if( win )
			win->ReleaseMouse();

			wxWindow* parent = GetParentForModalDialog();

			ENABLE_DISABLE toggle( parent );

			Show( true );

			m_qmodal_showing = true;

			wxGUIEventLoop event_loop;
			wxEventLoopActivator event_loop_stacker( &event_loop );

			m_qmodal_loop = &event_loop;

			event_loop.Run();

			if( toggle.m_win ) // let's focus back on the parent window
			toggle.m_win->SetFocus();

			return GetReturnCode();
			}


			void DIALOG_SHIM::EndQuasiModal( int retCode )
			{
			SetReturnCode( retCode );

			if( !IsQuasiModal() )
			{
			wxFAIL_MSG( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal wasn't called" );
			return;
			}

			m_qmodal_showing = false;

			if( m_qmodal_loop )
			{
			m_qmodal_loop->Exit();
			m_qmodal_loop = NULL;
			}

			Show( false );
			}


	#if DLGSHIM_USE_SETFOCUS		#if DLGSHIM_USE_SETFOCUS

	static bool findWindowRecursively( const wxWindowList& children, const wxWindow* wanted )		static bool findWindowRecursively( const wxWindowList& children, const wxWindow* wanted )
	@@ -113,7 +233,7 @@ static bool findWindowRecursively( const wxWindowList& children, const wxWindow*
	}		}


	static bool findWindowRecursively( const wxWindow* topmost, const wxWindow* wanted )		static bool findWindowReursively( const wxWindow* topmost, const wxWindow* wanted )
	{		{
	// wanted may be NULL and that is ok.		// wanted may be NULL and that is ok.

common/kiway_player.cpp

+41 −30

Original line number	Original line	Diff line number	Diff line
	@@ -23,13 +23,14 @@
	*/		*/



	#include <kiway_player.h>		#include <kiway_player.h>
	#include <kiway_express.h>		#include <kiway_express.h>
	#include <kiway.h>		#include <kiway.h>
	#include <id.h>		#include <id.h>
			#include <macros.h>
	#include <typeinfo>		#include <typeinfo>
	#include <wx/utils.h>		#include <wx/utils.h>
			#include <wx/evtloop.h>


	BEGIN_EVENT_TABLE( KIWAY_PLAYER, EDA_BASE_FRAME )		BEGIN_EVENT_TABLE( KIWAY_PLAYER, EDA_BASE_FRAME )
	@@ -43,10 +44,10 @@ KIWAY_PLAYER::KIWAY_PLAYER( KIWAY* aKiway, wxWindow* aParent, FRAME_T aFrameType
	long aStyle, const wxString& aWdoName ) :		long aStyle, const wxString& aWdoName ) :
	EDA_BASE_FRAME( aParent, aFrameType, aTitle, aPos, aSize, aStyle, aWdoName ),		EDA_BASE_FRAME( aParent, aFrameType, aTitle, aPos, aSize, aStyle, aWdoName ),
	KIWAY_HOLDER( aKiway ),		KIWAY_HOLDER( aKiway ),
	m_modal_dismissed( 0 )		m_modal( false ),
			m_modal_loop( 0 )
	{		{
	DBG( printf("KIWAY_EXPRESS::wxEVENT_ID:%d\n", KIWAY_EXPRESS::wxEVENT_ID );)		// DBG( printf("KIWAY_EXPRESS::wxEVENT_ID:%d\n", KIWAY_EXPRESS::wxEVENT_ID );)
	//Connect( KIWAY_EXPRESS::wxEVENT_ID, wxKiwayExressHandler( KIWAY_PLAYER::kiway_express ) );
	}		}


	@@ -55,10 +56,10 @@ KIWAY_PLAYER::KIWAY_PLAYER( wxWindow* aParent, wxWindowID aId, const wxString& a
	const wxString& aWdoName ) :		const wxString& aWdoName ) :
	EDA_BASE_FRAME( aParent, (FRAME_T) aId, aTitle, aPos, aSize, aStyle, aWdoName ),		EDA_BASE_FRAME( aParent, (FRAME_T) aId, aTitle, aPos, aSize, aStyle, aWdoName ),
	KIWAY_HOLDER( 0 ),		KIWAY_HOLDER( 0 ),
	m_modal_dismissed( 0 )		m_modal( false ),
			m_modal_loop( 0 )
	{		{
	DBG( printf("KIWAY_EXPRESS::wxEVENT_ID:%d\n", KIWAY_EXPRESS::wxEVENT_ID );)		// DBG( printf("KIWAY_EXPRESS::wxEVENT_ID:%d\n", KIWAY_EXPRESS::wxEVENT_ID );)
	//Connect( KIWAY_EXPRESS::wxEVENT_ID, wxKiwayExressHandler( KIWAY_PLAYER::kiway_express ) );
	}		}


	@@ -73,49 +74,54 @@ void KIWAY_PLAYER::KiwayMailIn( KIWAY_EXPRESS& aEvent )

	bool KIWAY_PLAYER::ShowModal( wxString* aResult )		bool KIWAY_PLAYER::ShowModal( wxString* aResult )
	{		{
			wxASSERT_MSG( IsModal(), "ShowModal() shouldn't be called on non-modal frame" );

	/*		/*
	This function has a nice interface but an unsightly implementation.		This function has a nice interface but a necessarily unsightly implementation.
	Now it is encapsulated, making it easier to improve. I am not sure		Now the implementation is encapsulated, localizing future changes.
	a wxSemaphore was needed, especially since no blocking happens. It seems
	like a volatile bool is sufficient.

	It works in tandem with DismissModal(). But only ShowModal() is in the		It works in tandem with DismissModal(). But only ShowModal() is in the
	vtable and therefore cross-module capable.		vtable and therefore cross-module capable.
	*/		*/

	volatile bool dismissed = false;		// This is an exception safe way to zero a pointer before returning.
			// Yes, even though DismissModal() clears this first normally, this is
			// here in case there's an exception before the dialog is dismissed.
			struct NULLER
			{
			void*& m_what;
			NULLER( void*& aPtr ) : m_what( aPtr ) {}
			~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
			} clear_this( (void*&) m_modal_loop );

	// disable all frames except the modal one, re-enable on exit, exception safe.		// exception safe way to disable all frames except the modal one,
			// re-enable on exit
	wxWindowDisabler toggle( this );		wxWindowDisabler toggle( this );

	m_modal_dismissed = &dismissed;

	Show( true );		Show( true );
	Raise();

	// Wait for the one and only active frame to call DismissModal() from		wxGUIEventLoop event_loop;
	// some concluding event.		wxEventLoopActivator event_loop_stacker( &event_loop );
	while( !dismissed )
	{
	wxYield();
	wxMilliSleep( 50 );
	}

	// no longer modal, not to mention that the pointer would be invalid outside this scope.		m_modal_loop = &event_loop;
	m_modal_dismissed = NULL;
			event_loop.Run();

	if( aResult )		if( aResult )
	*aResult = m_modal_string;		*aResult = m_modal_string;

			DBG(printf( "~%s: aResult:'%s' ret:%d\n",
			__func__, TO_UTF8( m_modal_string ), m_modal_ret_val );)

	return m_modal_ret_val;		return m_modal_ret_val;
	}		}


	bool KIWAY_PLAYER::IsDismissed()		bool KIWAY_PLAYER::IsDismissed()
	{		{
	// if already dismissed, then m_modal_dismissed may be NULL, and if not,		bool ret = !m_modal_loop;
	// it can still be dismissed if the bool is true.
	bool ret = !m_modal_dismissed \|\| *m_modal_dismissed;		DBG(printf( "%s: ret:%d\n", __func__, ret );)

	return ret;		return ret;
	}		}
	@@ -126,8 +132,13 @@ void KIWAY_PLAYER::DismissModal( bool aRetVal, const wxString& aResult )
	m_modal_ret_val = aRetVal;		m_modal_ret_val = aRetVal;
	m_modal_string = aResult;		m_modal_string = aResult;

	if( m_modal_dismissed )		if( m_modal_loop )
	*m_modal_dismissed = true;		{
			m_modal_loop->Exit();
			m_modal_loop = 0; // this marks it as dismissed.
			}

			Show( false );
	}		}

eeschema/dialogs/dialog_edit_component_in_schematic.cpp

+21 −14

Original line number	Original line	Diff line number	Diff line
	@@ -148,10 +148,10 @@ void SCH_EDIT_FRAME::EditComponent( SCH_COMPONENT* aComponent )
	// make sure the chipnameTextCtrl is wide enough to hold any unusually long chip names:		// make sure the chipnameTextCtrl is wide enough to hold any unusually long chip names:
	EnsureTextCtrlWidth( dlg->chipnameTextCtrl );		EnsureTextCtrlWidth( dlg->chipnameTextCtrl );

	dlg->ShowModal();		dlg->ShowQuasiModal();

	m_canvas->MoveCursorToCrossHair();
	m_canvas->SetIgnoreMouseEvents( false );		m_canvas->SetIgnoreMouseEvents( false );
			m_canvas->MoveCursorToCrossHair();
	dlg->Destroy();		dlg->Destroy();
	}		}

	@@ -214,7 +214,7 @@ void DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnListItemSelected( wxListEvent& event

	void DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCancelButtonClick( wxCommandEvent& event )		void DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCancelButtonClick( wxCommandEvent& event )
	{		{
	EndModal( 1 );		EndQuasiModal( 1 );
	}		}


	@@ -379,7 +379,7 @@ void DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick( wxCommandEvent& event
	m_Parent->GetScreen()->TestDanglingEnds();		m_Parent->GetScreen()->TestDanglingEnds();
	m_Parent->GetCanvas()->Refresh( true );		m_Parent->GetCanvas()->Refresh( true );

	EndModal( 0 );		EndQuasiModal( 0 );
	}		}


	@@ -436,23 +436,21 @@ void DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::deleteFieldButtonHandler( wxCommandEven

	void DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::showButtonHandler( wxCommandEvent& event )		void DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::showButtonHandler( wxCommandEvent& event )
	{		{
	#if 1		#if 0
	wxString datasheet_uri = fieldValueTextCtrl->GetValue();		wxString datasheet_uri = fieldValueTextCtrl->GetValue();
	::wxLaunchDefaultBrowser( datasheet_uri );		::wxLaunchDefaultBrowser( datasheet_uri );

	#else		#else
	unsigned fieldNdx = getSelectedFieldNdx();

	/*		unsigned fieldNdx = getSelectedFieldNdx();
	if( fieldNdx == DATASHEET )		if( fieldNdx == DATASHEET )
	{		{
	wxString datasheet_uri = fieldValueTextCtrl->GetValue();		wxString datasheet_uri = fieldValueTextCtrl->GetValue();
	::wxLaunchDefaultBrowser( datasheet_uri );		::wxLaunchDefaultBrowser( datasheet_uri );
	}		}
	else if( fieldNdx == FOOTPRINT )		else if( fieldNdx == FOOTPRINT )
	*/
	{		{
	// pick a footprint		// pick a footprint using the footprint picker.
	wxString fpid;		wxString fpid;

	KIWAY_PLAYER* frame = Kiway().Player( FRAME_PCB_MODULE_VIEWER_MODAL, true );		KIWAY_PLAYER* frame = Kiway().Player( FRAME_PCB_MODULE_VIEWER_MODAL, true );
	@@ -460,11 +458,11 @@ void DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::showButtonHandler( wxCommandEvent& even
	if( frame->ShowModal( &fpid ) )		if( frame->ShowModal( &fpid ) )
	{		{
	printf( "%s: %s\n", __func__, TO_UTF8( fpid ) );		printf( "%s: %s\n", __func__, TO_UTF8( fpid ) );
	}		fieldValueTextCtrl->SetValue( fpid );

	frame->Show( false ); // keep the frame open, but hidden.		}

	Raise();		frame->Destroy();
	}		}
	#endif		#endif

	@@ -764,7 +762,16 @@ void DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copySelectedFieldToPanel()

	fieldValueTextCtrl->SetValue( field.GetText() );		fieldValueTextCtrl->SetValue( field.GetText() );

	m_show_datasheet_button->Enable( fieldNdx == DATASHEET );		m_show_datasheet_button->Enable( fieldNdx == DATASHEET \|\| fieldNdx == FOOTPRINT );

			if( fieldNdx == DATASHEET )
			m_show_datasheet_button->SetLabel( _( "Show in Browser" ) );
			else if( fieldNdx == FOOTPRINT )
			m_show_datasheet_button->SetLabel( _( "Assign Footprint" ) );
			else
			m_show_datasheet_button->SetLabel( wxEmptyString );

			m_show_datasheet_button->Enable( fieldNdx == DATASHEET \|\| fieldNdx == FOOTPRINT );

	// For power symbols, the value is NOR editable, because value and pin		// For power symbols, the value is NOR editable, because value and pin
	// name must be same and can be edited only in library editor		// name must be same and can be edited only in library editor
	@@ -1006,5 +1013,5 @@ void DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp( wxCommandEvent& event )
	m_Parent->OnModify();		m_Parent->OnModify();

	m_Cmp->Draw( m_Parent->GetCanvas(), &dc, wxPoint( 0, 0 ), GR_DEFAULT_DRAWMODE );		m_Cmp->Draw( m_Parent->GetCanvas(), &dc, wxPoint( 0, 0 ), GR_DEFAULT_DRAWMODE );
	EndModal( 1 );		EndQuasiModal( 1 );
	}		}

eeschema/getpart.cpp

+8 −7

Original line number	Original line	Diff line number	Diff line
	@@ -56,7 +56,7 @@
	wxString SCH_BASE_FRAME::SelectComponentFromLibBrowser( LIB_ALIAS* aPreselectedAlias,		wxString SCH_BASE_FRAME::SelectComponentFromLibBrowser( LIB_ALIAS* aPreselectedAlias,
	int* aUnit, int* aConvert )		int* aUnit, int* aConvert )
	{		{
	// Close the any current non-modal Lib browser if open, and open a new one, in "modal" mode:		// Close any open non-modal Lib browser, and open a new one, in "modal" mode:
	LIB_VIEW_FRAME* viewlibFrame = (LIB_VIEW_FRAME*) Kiway().Player( FRAME_SCH_VIEWER, false );		LIB_VIEW_FRAME* viewlibFrame = (LIB_VIEW_FRAME*) Kiway().Player( FRAME_SCH_VIEWER, false );
	if( viewlibFrame )		if( viewlibFrame )
	viewlibFrame->Destroy();		viewlibFrame->Destroy();
	@@ -79,13 +79,14 @@ wxString SCH_BASE_FRAME::SelectComponentFromLibBrowser( LIB_ALIAS* aPreselectedA

	wxString cmpname;		wxString cmpname;

	viewlibFrame->ShowModal( &cmpname );		if( viewlibFrame->ShowModal( &cmpname ) )
			{
	if( aUnit )		if( aUnit )
	*aUnit = viewlibFrame->GetUnit();		*aUnit = viewlibFrame->GetUnit();

	if( aConvert )		if( aConvert )
	*aConvert = viewlibFrame->GetConvert();		*aConvert = viewlibFrame->GetConvert();
			}

	viewlibFrame->Destroy();		viewlibFrame->Destroy();

Admin message