1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2020 KiCad Developers, see change_log.txt for contributors.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, you may find one here:
18  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19  * or you may search the http://www.gnu.org website for the version 2 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
22  */
23 
24 #ifndef SCINTILLA_TRICKS_H
25 #define SCINTILLA_TRICKS_H
26 
27 
28 #include <wx/stc/stc.h>
29 #include <functional>
30 
31 /**
32  * Add cut/copy/paste, dark theme, autocomplete and brace highlighting to a wxStyleTextCtrl
33  * instance.
34  */
35 class SCINTILLA_TRICKS : public wxEvtHandler
36 {
37 public:
38 
39     SCINTILLA_TRICKS( wxStyledTextCtrl* aScintilla, const wxString& aBraces, bool aSingleLine,
40                       std::function<void()> m_enterCallback = [](){ } );
41 
42     void DoAutocomplete( const wxString& aPartial, const wxArrayString& aTokens );
43 
44     void CancelAutocomplete();
45 
46 protected:
47     void setupStyles();
48 
49     int firstNonWhitespace( int aLine, int* aWhitespaceCount = nullptr );
50 
51     void onCharHook( wxKeyEvent& aEvent );
52     void onScintillaUpdateUI( wxStyledTextEvent& aEvent );
53     void onThemeChanged( wxSysColourChangedEvent &aEvent );
54 
55 protected:
56     wxStyledTextCtrl*     m_te;
57     wxString              m_braces;
58     int                   m_lastCaretPos;
59     bool                  m_suppressAutocomplete;
60     bool                  m_singleLine;            // Treat <return> as OK, and skip special tab
61                                                    //  stop handling (including monospaced font).
62     std::function<void()> m_returnCallback;        // Process <return> in singleLine, and
63                                                    //  <shift> + <return> irrespective.
64 };
65 
66 #endif  // SCINTILLA_TRICKS_H
67