Mirrors
/
kicad
mirror of https://github.com/KiCad/kicad-source-mirror
3
0
Fork 0
Code Releases Activity
Browse Source

Hook up text variable auto-complete for PCBNew. 

Fixes https://gitlab.com/kicad/code/kicad/-/issues/14777
newinvert
Jeff Young 3 years ago
parent
5a9ed66cfd
commit
14f004d2a5
9 changed files with 152 additions and 11 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 4
      eeschema/tools/sch_drawing_tools.cpp
  2. 2
      eeschema/tools/sch_edit_tool.cpp
  3. 18
      pcbnew/board.cpp
  4. 1
      pcbnew/board.h
  5. 65
      pcbnew/dialogs/dialog_text_properties.cpp
  6. 1
      pcbnew/dialogs/dialog_text_properties.h
  7. 68
      pcbnew/dialogs/dialog_textbox_properties.cpp
  8. 1
      pcbnew/dialogs/dialog_textbox_properties.h
  9. 3
      pcbnew/tools/drawing_tool.cpp

4
eeschema/tools/sch_drawing_tools.cpp
View File

@ -1003,7 +1003,7 @@ SCH_TEXT* SCH_DRAWING_TOOLS::createNewText( const VECTOR2I& aPosition, int aType
{
DIALOG_TEXT_PROPERTIES dlg( m_frame, textItem );
// Must be quasi modal for syntax help
// QuasiModal required for syntax help and Scintilla auto-complete
if( dlg.ShowQuasiModal() != wxID_OK )
{
delete textItem;
@ -1648,7 +1648,7 @@ int SCH_DRAWING_TOOLS::DrawShape( const TOOL_EVENT& aEvent )
getViewControls()->SetAutoPan( false );
getViewControls()->CaptureCursor( false );
// Must be quasi modal for syntax help
// QuasiModal required for syntax help and Scintilla auto-complete
if( dlg.ShowQuasiModal() != wxID_OK )
{
cleanup();

2
eeschema/tools/sch_edit_tool.cpp
View File

@ -1873,7 +1873,7 @@ int SCH_EDIT_TOOL::Properties( const TOOL_EVENT& aEvent )
{
DIALOG_TEXT_PROPERTIES dlg( m_frame, static_cast<SCH_ITEM*>( curr_item ) );
// Must be quasi modal for syntax help
// QuasiModal required for syntax help and Scintilla auto-complete
if( dlg.ShowQuasiModal() == wxID_OK )
{
m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );

18
pcbnew/board.cpp
View File

@ -352,6 +352,24 @@ std::vector<PCB_MARKER*> BOARD::ResolveDRCExclusions( bool aCreateMarkers )
}
void BOARD::GetContextualTextVars( wxArrayString* aVars ) const
{
auto add =
[&]( const wxString& aVar )
{
if( !alg::contains( *aVars, aVar ) )
aVars->push_back( aVar );
};
add( wxT( "LAYER" ) );
GetTitleBlock().GetContextualTextVars( aVars );
for( std::pair<wxString, wxString> entry : GetProject()->GetTextVars() )
add( entry.first );
}
bool BOARD::ResolveTextVar( wxString* token, int aDepth ) const
{
if( token->Contains( ':' ) )

1
pcbnew/board.h
View File

@ -339,6 +339,7 @@ public:
const std::map<wxString, wxString>& GetProperties() const { return m_properties; }
void SetProperties( const std::map<wxString, wxString>& aProps ) { m_properties = aProps; }
void GetContextualTextVars( wxArrayString* aVars ) const;
bool ResolveTextVar( wxString* token, int aDepth ) const;
/// Visibility settings stored in board prior to 6.0, only used for loading legacy files

65
pcbnew/dialogs/dialog_text_properties.cpp
View File

@ -26,17 +26,15 @@
#include <widgets/font_choice.h>
#include <dialog_text_properties.h>
#include <confirm.h>
#include <widgets/unit_binder.h>
#include <board_commit.h>
#include <board.h>
#include <footprint.h>
#include <string_utils.h>
#include <pcb_text.h>
#include <pcbnew.h>
#include <project.h>
#include <pcb_edit_frame.h>
#include <pcb_layer_box_selector.h>
#include <wx/valnum.h>
#include <math/util.h> // for KiROUND
#include <scintilla_tricks.h>
@ -167,6 +165,11 @@ DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES( PCB_BASE_EDIT_FRAME* aParent, PC
Connect( wxEVT_CHAR_HOOK, wxKeyEventHandler( DIALOG_TEXT_PROPERTIES::OnCharHook ),
nullptr, this );
m_MultiLineText->Bind( wxEVT_STC_CHARADDED,
&DIALOG_TEXT_PROPERTIES::onScintillaCharAdded, this );
m_MultiLineText->Bind( wxEVT_STC_AUTOCOMP_CHAR_DELETED,
&DIALOG_TEXT_PROPERTIES::onScintillaCharAdded, this );
finishDialogSettings();
}
@ -209,6 +212,62 @@ void DIALOG_TEXT_PROPERTIES::OnSetFocusText( wxFocusEvent& event )
}
void DIALOG_TEXT_PROPERTIES::onScintillaCharAdded( wxStyledTextEvent &aEvent )
{
wxStyledTextCtrl* te = m_MultiLineText;
wxArrayString autocompleteTokens;
int text_pos = te->GetCurrentPos();
int start = te->WordStartPosition( text_pos, true );
wxString partial;
auto textVarRef =
[&]( int pos )
{
return pos >= 2 && te->GetCharAt( pos-2 ) == '$' && te->GetCharAt( pos-1 ) == '{';
};
// Check for cross-reference
if( start > 1 && te->GetCharAt( start-1 ) == ':' )
{
int refStart = te->WordStartPosition( start-1, true );
if( textVarRef( refStart ) )
{
partial = te->GetRange( start, text_pos );
wxString ref = te->GetRange( refStart, start-1 );
BOARD* board = m_item->GetBoard();
for( FOOTPRINT* candidate : board->Footprints() )
{
if( candidate->GetReference() == ref )
{
candidate->GetContextualTextVars( &autocompleteTokens );
break;
}
}
}
}
else if( textVarRef( start ) )
{
partial = te->GetTextRange( start, text_pos );
BOARD* board = m_item->GetBoard();
board->GetContextualTextVars( &autocompleteTokens );
if( FOOTPRINT* footprint = m_item->GetParentFootprint() )
footprint->GetContextualTextVars( &autocompleteTokens );
for( std::pair<wxString, wxString> entry : board->GetProject()->GetTextVars() )
autocompleteTokens.push_back( entry.first );
}
m_scintillaTricks->DoAutocomplete( partial, autocompleteTokens );
m_MultiLineText->SetFocus();
}
bool DIALOG_TEXT_PROPERTIES::TransferDataToWindow()
{
BOARD* board = m_frame->GetBoard();

1
pcbnew/dialogs/dialog_text_properties.h
View File

@ -56,6 +56,7 @@ private:
void onAlignButton( wxCommandEvent &aEvent ) override;
void onValignButton( wxCommandEvent &aEvent ) override;
void onThickness( wxCommandEvent &aEvent ) override;
void onScintillaCharAdded( wxStyledTextEvent &aEvent );
bool TransferDataToWindow() override;
bool TransferDataFromWindow() override;

68
pcbnew/dialogs/dialog_textbox_properties.cpp
View File

@ -25,19 +25,16 @@
#include <widgets/font_choice.h>
#include <dialog_textbox_properties.h>
#include <confirm.h>
#include <widgets/unit_binder.h>
#include <board_commit.h>
#include <board_design_settings.h>
#include <board.h>
#include <footprint.h>
#include <string_utils.h>
#include <pcb_textbox.h>
#include <pcbnew.h>
#include <project.h>
#include <pcb_edit_frame.h>
#include <pcb_layer_box_selector.h>
#include <math/util.h> // for KiROUND
#include <scintilla_tricks.h>
#include "macros.h"
DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES( PCB_BASE_EDIT_FRAME* aParent,
PCB_TEXTBOX* aTextBox ) :
@ -125,6 +122,11 @@ DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES( PCB_BASE_EDIT_FRAME* aPare
Connect( wxEVT_CHAR_HOOK, wxKeyEventHandler( DIALOG_TEXTBOX_PROPERTIES::OnCharHook ),
nullptr, this );
m_MultiLineText->Bind( wxEVT_STC_CHARADDED,
&DIALOG_TEXTBOX_PROPERTIES::onScintillaCharAdded, this );
m_MultiLineText->Bind( wxEVT_STC_AUTOCOMP_CHAR_DELETED,
&DIALOG_TEXTBOX_PROPERTIES::onScintillaCharAdded, this );
finishDialogSettings();
}
@ -141,10 +143,68 @@ DIALOG_TEXTBOX_PROPERTIES::~DIALOG_TEXTBOX_PROPERTIES()
int PCB_BASE_EDIT_FRAME::ShowTextBoxPropertiesDialog( PCB_TEXTBOX* aTextBox )
{
DIALOG_TEXTBOX_PROPERTIES dlg( this, aTextBox );
// QuasiModal required for Scintilla auto-complete
return dlg.ShowQuasiModal();
}
void DIALOG_TEXTBOX_PROPERTIES::onScintillaCharAdded( wxStyledTextEvent &aEvent )
{
wxStyledTextCtrl* te = m_MultiLineText;
wxArrayString autocompleteTokens;
int text_pos = te->GetCurrentPos();
int start = te->WordStartPosition( text_pos, true );
wxString partial;
auto textVarRef =
[&]( int pos )
{
return pos >= 2 && te->GetCharAt( pos-2 ) == '$' && te->GetCharAt( pos-1 ) == '{';
};
// Check for cross-reference
if( start > 1 && te->GetCharAt( start-1 ) == ':' )
{
int refStart = te->WordStartPosition( start-1, true );
if( textVarRef( refStart ) )
{
partial = te->GetRange( start, text_pos );
wxString ref = te->GetRange( refStart, start-1 );
BOARD* board = m_textBox->GetBoard();
for( FOOTPRINT* candidate : board->Footprints() )
{
if( candidate->GetReference() == ref )
{
candidate->GetContextualTextVars( &autocompleteTokens );
break;
}
}
}
}
else if( textVarRef( start ) )
{
partial = te->GetTextRange( start, text_pos );
BOARD* board = m_textBox->GetBoard();
board->GetContextualTextVars( &autocompleteTokens );
if( FOOTPRINT* footprint = m_textBox->GetParentFootprint() )
footprint->GetContextualTextVars( &autocompleteTokens );
for( std::pair<wxString, wxString> entry : board->GetProject()->GetTextVars() )
autocompleteTokens.push_back( entry.first );
}
m_scintillaTricks->DoAutocomplete( partial, autocompleteTokens );
m_MultiLineText->SetFocus();
}
bool DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow()
{
BOARD* board = m_frame->GetBoard();

1
pcbnew/dialogs/dialog_textbox_properties.h
View File

@ -47,6 +47,7 @@ private:
void onAlignButton( wxCommandEvent &aEvent ) override;
void onThickness( wxCommandEvent &aEvent ) override;
void onBorderChecked( wxCommandEvent& event ) override;
void onScintillaCharAdded( wxStyledTextEvent &aEvent );
bool TransferDataToWindow() override;
bool TransferDataFromWindow() override;

3
pcbnew/tools/drawing_tool.cpp
View File

@ -888,7 +888,8 @@ int DRAWING_TOOL::PlaceText( const TOOL_EVENT& aEvent )
RunMainStack( [&]()
{
cancelled = !textDialog.ShowModal();
// QuasiModal required for Scintilla auto-complete
cancelled = !textDialog.ShowQuasiModal();
} );
if( cancelled || NoPrintableChars( text->GetText() ) )

Write Preview
Loading…
Cancel
Save