SCINTILLA_TRICKS Class Reference

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, bool aSingleLine, std::function< void()> m_enterCallback=[](){ })
void	DoAutocomplete (const wxString &aPartial, const wxArrayString &aTokens)

Protected Member Functions
void	setupStyles ()
int	firstNonWhitespace (int aLine, int *aWhitespaceCount=nullptr)
void	onCharHook (wxKeyEvent &aEvent)
void	onScintillaUpdateUI (wxStyledTextEvent &aEvent)
void	onThemeChanged (wxSysColourChangedEvent &aEvent)

Protected Attributes
wxStyledTextCtrl *	m_te
wxString	m_braces
int	m_lastCaretPos
bool	m_suppressAutocomplete
bool	m_singleLine
std::function< void()>	m_returnCallback

Detailed Description

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

Definition at line 34 of file scintilla_tricks.h.

Constructor & Destructor Documentation

SCINTILLA_TRICKS()

SCINTILLA_TRICKS::SCINTILLA_TRICKS	(	wxStyledTextCtrl *	aScintilla,
		const wxString &	aBraces,
		bool	aSingleLine,
		std::function< void()>	m_enterCallback = [](){ }
	)

Definition at line 35 of file scintilla_tricks.cpp.

                                                                                            :
        m_te( aScintilla ),
        m_braces( aBraces ),
        m_lastCaretPos( -1 ),
        m_suppressAutocomplete( false ),
        m_singleLine( aSingleLine ),
        m_returnCallback( aReturnCallback )
{
    // 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 );

    setupStyles();

    // 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 );

    m_te->Bind( wxEVT_SYS_COLOUR_CHANGED,
                wxSysColourChangedEventHandler( SCINTILLA_TRICKS::onThemeChanged ), this );
}

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

Member Function Documentation

DoAutocomplete()

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

Definition at line 375 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 filter, m_suppressAutocomplete, and m_te.

Referenced by DIALOG_TEXT_AND_LABEL_PROPERTIES::onScintillaCharAdded(), PROPERTIES_FRAME::onScintillaCharAdded(), and DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded().

firstNonWhitespace()

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

protected

Definition at line 299 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 149 of file scintilla_tricks.cpp.

{
    wxString c = aEvent.GetUnicodeKey();

    if( !isalpha( aEvent.GetKeyCode() ) )
        m_suppressAutocomplete = false;

    if( aEvent.GetKeyCode() == WXK_RETURN && ( m_singleLine || aEvent.ShiftDown() ) )
    {
        m_returnCallback();
    }
    else 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->CharRightExtend();

        if( m_te->GetSelectionEnd() > m_te->GetSelectionStart() )
            m_te->DeleteBack();
    }
    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();
    }
#ifdef __WXMAC__
    else if( aEvent.GetModifiers() == wxMOD_RAW_CONTROL && aEvent.GetKeyCode() == 'A' )
    {
        m_te->LineEndWrap();
    }
    else if( aEvent.GetModifiers() == wxMOD_RAW_CONTROL && aEvent.GetKeyCode() == 'E' )
    {
        m_te->HomeWrap();
    }
#endif
    else if( aEvent.GetKeyCode() == WXK_SPECIAL20 )
    {
        // Proxy for a wxSysColourChangedEvent
        setupStyles();
    }
    else
    {
        aEvent.Skip();
    }
}

References ConvertSmartQuotesAndDashes(), firstNonWhitespace(), isCtrlSlash(), m_returnCallback, m_singleLine, m_suppressAutocomplete, m_te, and setupStyles().

Referenced by SCINTILLA_TRICKS().

onScintillaUpdateUI()

void SCINTILLA_TRICKS::onScintillaUpdateUI ( wxStyledTextEvent &  aEvent )

protected

Definition at line 327 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 );
        }
    }
}

References m_braces, m_lastCaretPos, and m_te.

Referenced by SCINTILLA_TRICKS().

onThemeChanged()

void SCINTILLA_TRICKS::onThemeChanged ( wxSysColourChangedEvent &  aEvent )

protected

Definition at line 67 of file scintilla_tricks.cpp.

{
    setupStyles();

    aEvent.Skip();
}

References setupStyles().

Referenced by SCINTILLA_TRICKS().

setupStyles()

void SCINTILLA_TRICKS::setupStyles ( )

protected

Definition at line 75 of file scintilla_tricks.cpp.

{
    wxTextCtrl dummy( m_te->GetParent(), wxID_ANY );
    wxColour   foreground    = dummy.GetForegroundColour();
    wxColour   background    = dummy.GetBackgroundColour();
    wxColour   highlight     = wxSystemSettings::GetColour( wxSYS_COLOUR_HIGHLIGHT );
    wxColour   highlightText = wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOWTEXT );

    m_te->StyleSetForeground( wxSTC_STYLE_DEFAULT, foreground );
    m_te->StyleSetBackground( wxSTC_STYLE_DEFAULT, background );
    m_te->StyleClearAll();

    m_te->SetSelForeground( true, highlightText );
    m_te->SetSelBackground( true, highlight );

    if( !m_singleLine )
    {
        // Set a monospace font with a tab width of 4.  This is the closest we can get to having
        // Scintilla mimic the stroke font's tab positioning.
        wxFont fixedFont = KIUI::GetMonospacedUIFont();

        for( size_t i = 0; i < wxSTC_STYLE_MAX; ++i )
            m_te->StyleSetFont( i, fixedFont );

        m_te->SetTabWidth( 4 );
    }

    // Set up the brace highlighting
    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 );
}

References dummy(), KIUI::GetMonospacedUIFont(), m_singleLine, and m_te.

Referenced by onCharHook(), onThemeChanged(), and SCINTILLA_TRICKS().

Member Data Documentation

m_braces

wxString SCINTILLA_TRICKS::m_braces

protected

Definition at line 54 of file scintilla_tricks.h.

Referenced by onScintillaUpdateUI(), and SCINTILLA_TRICKS().

m_lastCaretPos

int SCINTILLA_TRICKS::m_lastCaretPos

protected

Definition at line 55 of file scintilla_tricks.h.

Referenced by onScintillaUpdateUI().

m_returnCallback

std::function<void()> SCINTILLA_TRICKS::m_returnCallback

protected

Definition at line 59 of file scintilla_tricks.h.

Referenced by onCharHook().

m_singleLine

bool SCINTILLA_TRICKS::m_singleLine

protected

Definition at line 57 of file scintilla_tricks.h.

Referenced by onCharHook(), and setupStyles().

m_suppressAutocomplete

bool SCINTILLA_TRICKS::m_suppressAutocomplete

protected

Definition at line 56 of file scintilla_tricks.h.

Referenced by DoAutocomplete(), and onCharHook().

m_te

wxStyledTextCtrl* SCINTILLA_TRICKS::m_te

protected

Definition at line 53 of file scintilla_tricks.h.

Referenced by DoAutocomplete(), firstNonWhitespace(), onCharHook(), onScintillaUpdateUI(), SCINTILLA_TRICKS(), and setupStyles().

---

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

• scintilla_tricks.h
• scintilla_tricks.cpp