Add cut/copy/paste, autocomplete and brace highlighting to a wxStyleTextCtrl instance. More...

#include <scintilla_tricks.h>

Inheritance diagram for SCINTILLA_TRICKS:

Public Member Functions
	SCINTILLA_TRICKS (wxStyledTextCtrl *aScintilla, const wxString &aBraces)

void	DoAutocomplete (const wxString &aPartial, const wxArrayString &aTokens)

Protected Member Functions
int	firstNonWhitespace (int aLine, int *aWhitespaceCount=nullptr)

void	onCharHook (wxKeyEvent &aEvent)

void	onScintillaUpdateUI (wxStyledTextEvent &aEvent)

Protected Attributes
wxStyledTextCtrl *	m_te

wxString	m_braces

int	m_lastCaretPos

bool	m_suppressAutocomplete

Detailed Description

Add cut/copy/paste, autocomplete and brace highlighting to a wxStyleTextCtrl instance.

Definition at line 33 of file scintilla_tricks.h.

Constructor & Destructor Documentation

◆ SCINTILLA_TRICKS()

SCINTILLA_TRICKS::SCINTILLA_TRICKS	(	wxStyledTextCtrl *	aScintilla,
		const wxString &	aBraces
	)

Definition at line 34 of file scintilla_tricks.cpp.

                                                                                           :
         m_te( aScintilla ),
         m_braces( aBraces ),
         m_lastCaretPos( -1 ),
         m_suppressAutocomplete( false )
 {
     // A hack which causes Scintilla to auto-size the text editor canvas
     // See: https://github.com/jacobslusser/ScintillaNET/issues/216
     m_te->SetScrollWidth( 1 );
     m_te->SetScrollWidthTracking( true );
 
     // Set up the brace highlighting
     wxColour highlight = wxSystemSettings::GetColour( wxSYS_COLOUR_HIGHLIGHT );
     wxColour highlightText = wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOWTEXT );
 
     unsigned char r = highlight.Red();
     unsigned char g = highlight.Green();
     unsigned char b = highlight.Blue();
     wxColour::MakeGrey( &r, &g, &b );
     highlight.Set( r, g, b );
 
     m_te->StyleSetForeground( wxSTC_STYLE_BRACELIGHT, highlightText );
     m_te->StyleSetBackground( wxSTC_STYLE_BRACELIGHT, highlight );
     m_te->StyleSetForeground( wxSTC_STYLE_BRACEBAD, *wxRED );
 
     // Set up autocomplete
     m_te->AutoCompSetIgnoreCase( true );
     m_te->AutoCompSetFillUps( m_braces[1] );
     m_te->AutoCompSetMaxHeight( 20 );
 
     // Hook up events
     m_te->Bind( wxEVT_STC_UPDATEUI, &SCINTILLA_TRICKS::onScintillaUpdateUI, this );
 
     // Dispatch command-keys in Scintilla control.
     m_te->Bind( wxEVT_CHAR_HOOK, &SCINTILLA_TRICKS::onCharHook, this );
 }

References m_braces, m_te, onCharHook(), and onScintillaUpdateUI().

Member Function Documentation

◆ DoAutocomplete()

void SCINTILLA_TRICKS::DoAutocomplete	(	const wxString &	aPartial,
		const wxArrayString &	aTokens
	)

Definition at line 312 of file scintilla_tricks.cpp.

 {
     if( m_suppressAutocomplete )
         return;
 
     wxArrayString matchedTokens;
 
     wxString filter = wxT( "*" ) + aPartial.Lower() + wxT( "*" );
 
     for( const wxString& token : aTokens )
     {
         if( token.Lower().Matches( filter ) )
             matchedTokens.push_back( token );
     }
 
     if( matchedTokens.size() > 0 )
     {
         // NB: tokens MUST be in alphabetical order because the Scintilla engine is going
         // to do a binary search on them
         matchedTokens.Sort( []( const wxString& first, const wxString& second ) -> int
                             {
                                 return first.CmpNoCase( second );
                             });
 
         m_te->AutoCompShow( aPartial.size(), wxJoin( matchedTokens, ' ' ) );
     }
 }

References m_suppressAutocomplete, and m_te.

Referenced by DIALOG_LABEL_EDITOR::onScintillaCharAdded(), PROPERTIES_FRAME::onScintillaCharAdded(), and DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded().

◆ firstNonWhitespace()

int SCINTILLA_TRICKS::firstNonWhitespace	(	int	aLine,
		int *	aWhitespaceCount = `nullptr`
	)

protected

Definition at line 236 of file scintilla_tricks.cpp.

 {
     int lineStart = m_te->PositionFromLine( aLine );
 
     if( aWhitespaceCharCount )
         *aWhitespaceCharCount = 0;
 
     for( int ii = 0; ii < m_te->GetLineLength( aLine ); ++ii )
     {
         int c = m_te->GetCharAt( lineStart + ii );
 
         if( c == ' ' || c == '\t' )
         {
             if( aWhitespaceCharCount )
                 *aWhitespaceCharCount += 1;
 
             continue;
         }
         else
         {
             return c;
         }
     }
 
     return '\r';
 }

References m_te.

Referenced by onCharHook().

◆ onCharHook()

void SCINTILLA_TRICKS::onCharHook ( wxKeyEvent & aEvent )

protected

Definition at line 106 of file scintilla_tricks.cpp.

 {
     wxString c = aEvent.GetUnicodeKey();
 
     if( !isalpha( aEvent.GetKeyCode() ) )
         m_suppressAutocomplete = false;
 
     if( ConvertSmartQuotesAndDashes( &c ) )
     {
         m_te->AddText( c );
     }
     else if( aEvent.GetKeyCode() == WXK_TAB )
     {
         if( aEvent.ControlDown() )
         {
             int flags = 0;
 
             if( !aEvent.ShiftDown() )
                 flags |= wxNavigationKeyEvent::IsForward;
 
             wxWindow* parent = m_te->GetParent();
 
             while( parent && dynamic_cast<DIALOG_SHIM*>( parent ) == nullptr )
                 parent = parent->GetParent();
 
             if( parent )
                 parent->NavigateIn( flags );
         }
         else
         {
             m_te->Tab();
         }
     }
     else if( aEvent.GetModifiers() == wxMOD_CONTROL && aEvent.GetKeyCode() == 'Z' )
     {
         m_te->Undo();
     }
     else if( ( aEvent.GetModifiers() == wxMOD_SHIFT+wxMOD_CONTROL && aEvent.GetKeyCode() == 'Z' )
             || ( aEvent.GetModifiers() == wxMOD_CONTROL && aEvent.GetKeyCode() == 'Y' ) )
     {
         m_te->Redo();
     }
     else if( aEvent.GetModifiers() == wxMOD_CONTROL && aEvent.GetKeyCode() == 'A' )
     {
         m_te->SelectAll();
     }
     else if( aEvent.GetModifiers() == wxMOD_CONTROL && aEvent.GetKeyCode() == 'X' )
     {
         m_te->Cut();
     }
     else if( aEvent.GetModifiers() == wxMOD_CONTROL && aEvent.GetKeyCode() == 'C' )
     {
         m_te->Copy();
     }
     else if( aEvent.GetModifiers() == wxMOD_CONTROL && aEvent.GetKeyCode() == 'V' )
     {
         if( m_te->GetSelectionEnd() > m_te->GetSelectionStart() )
             m_te->DeleteBack();
 
         wxLogNull doNotLog; // disable logging of failed clipboard actions
 
         if( wxTheClipboard->Open() )
         {
             if( wxTheClipboard->IsSupported( wxDF_TEXT ) )
             {
                 wxTextDataObject data;
                 wxString         str;
 
                 wxTheClipboard->GetData( data );
                 str = data.GetText();
 
                 ConvertSmartQuotesAndDashes( &str );
                 m_te->AddText( str );
             }
 
             wxTheClipboard->Close();
         }
     }
     else if( aEvent.GetKeyCode() == WXK_BACK )
     {
         m_te->DeleteBack();
     }
     else if( aEvent.GetKeyCode() == WXK_DELETE )
     {
         if( m_te->GetSelectionEnd() > m_te->GetSelectionStart() )
             m_te->DeleteBack();
         else
             m_te->DeleteRange( m_te->GetSelectionStart(), 1 );
     }
     else if( aEvent.GetKeyCode() == WXK_ESCAPE )
     {
         if( m_te->AutoCompActive() )
         {
             m_te->AutoCompCancel();
             m_suppressAutocomplete = true; // Don't run autocomplete again on the next char...
         }
         else
         {
             aEvent.Skip();
         }
     }
     else if( isCtrlSlash( aEvent ) )
     {
         int  startLine = m_te->LineFromPosition( m_te->GetSelectionStart() );
         int  endLine = m_te->LineFromPosition( m_te->GetSelectionEnd() );
         bool comment = firstNonWhitespace( startLine ) != '#';
         int  whitespaceCount;
 
         m_te->BeginUndoAction();
 
         for( int ii = startLine; ii <= endLine; ++ii )
         {
             if( comment )
                 m_te->InsertText( m_te->PositionFromLine( ii ), "#" );
             else if( firstNonWhitespace( ii, &whitespaceCount ) == '#' )
                 m_te->DeleteRange( m_te->PositionFromLine( ii ) + whitespaceCount, 1 );
         }
 
         m_te->SetSelection( m_te->PositionFromLine( startLine ),
                             m_te->PositionFromLine( endLine ) + m_te->GetLineLength( endLine ) );
 
         m_te->EndUndoAction();
     }
     else
     {
         aEvent.Skip();
     }
 }

References ConvertSmartQuotesAndDashes(), firstNonWhitespace(), isCtrlSlash(), m_suppressAutocomplete, and m_te.

Referenced by SCINTILLA_TRICKS().

◆ onScintillaUpdateUI()

void SCINTILLA_TRICKS::onScintillaUpdateUI ( wxStyledTextEvent & aEvent )

protected

Definition at line 264 of file scintilla_tricks.cpp.

 {
     auto isBrace = [this]( int c ) -> bool
                    {
                        return m_braces.Find( (wxChar) c ) >= 0;
                    };
 
     // Has the caret changed position?
     int caretPos = m_te->GetCurrentPos();
 
     if( m_lastCaretPos != caretPos )
     {
         m_lastCaretPos = caretPos;
         int bracePos1 = -1;
         int bracePos2 = -1;
 
         // Is there a brace to the left or right?
         if( caretPos > 0 && isBrace( m_te->GetCharAt( caretPos-1 ) ) )
             bracePos1 = ( caretPos - 1 );
         else if( isBrace( m_te->GetCharAt( caretPos ) ) )
             bracePos1 = caretPos;
 
         if( bracePos1 >= 0 )
         {
             // Find the matching brace
             bracePos2 = m_te->BraceMatch( bracePos1 );
 
             if( bracePos2 == -1 )
             {
                 m_te->BraceBadLight( bracePos1 );
                 m_te->SetHighlightGuide( 0 );
             }
             else
             {
                 m_te->BraceHighlight( bracePos1, bracePos2 );
                 m_te->SetHighlightGuide( m_te->GetColumn( bracePos1 ) );
             }
         }
         else
         {
             // Turn off brace matching
             m_te->BraceHighlight( -1, -1 );
             m_te->SetHighlightGuide( 0 );
         }
     }
 }