src/Utils/MiscUI/SciEdit.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2003-2008 - TortoiseSVN
   4
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License
   7 // as published by the Free Software Foundation; either version 2
   8 // of the License, or (at your option) any later version.
   9
  10 // This program is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software Foundation,
  17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 //
  19 #pragma once
  20 #include "scintilla.h"
  21 #include "SciLexer.h"
  22 #include "hunspell.hxx"
  23 #include "mythes.hxx"
  24 #include "ProjectProperties.h"
  25 #include "PersonalDictionary.h"
  26 #include <regex>
  27
  28 using namespace std;
  29
  30
  31 //forward declaration
  32 class CSciEdit;
  33
  34 /**
  35  * \ingroup Utils
  36  * This class acts as an interface so that CSciEdit can call these methods
  37  * on other objects which implement this interface.
  38  * Classes implementing this interface must call RegisterContextMenuHandler()
  39  * in CSciEdit to register themselves.
  40  */
  41 class CSciEditContextMenuInterface
  42 {
  43 public:
  44         /**
  45          * When the handler is called with this method, it can add entries
  46          * to the \a mPopup context menu itself. The \a nCmd param is the command
  47          * ID number the handler must use for its commands. For every added command,
  48          * the handler is responsible to increment the \a nCmd param by one.
  49          */
  50         virtual void            InsertMenuItems(CMenu& mPopup, int& nCmd);
  51
  52         /**
  53          * The handler is called when the user clicks on any context menu entry
  54          * which isn't handled by CSciEdit itself. That means the handler might
  55          * be called for entries it hasn't added itself!
  56          * \remark the handler should return \a true if it handled the call, otherwise
  57          * it should return \a false
  58          */
  59         virtual bool            HandleMenuItemClick(int cmd, CSciEdit * pSciEdit);
  60 };
  61
  62 /**
  63  * \ingroup Utils
  64  * Encapsulates the Scintilla edit control. Usable as a replacement for the
  65  * MFC CEdit control, but not a drop-in replacement!
  66  * Also provides additional features like spell checking, auto completion, ...
  67  */
  68 class CSciEdit : public CWnd
  69 {
  70         DECLARE_DYNAMIC(CSciEdit)
  71 public:
  72         CSciEdit(void);
  73         ~CSciEdit(void);
  74
  75                 void                            SetAStyle(int style, COLORREF fore, COLORREF back=::GetSysColor(COLOR_WINDOW), int size=-1, const char *face=0);
  76         void SetUDiffStyle();
  77
  78         /**
  79          * Initialize the scintilla control. Must be called prior to any other
  80          * method!
  81          */
  82         void            Init(const ProjectProperties& props);
  83         void            Init(LONG lLanguage = 0,BOOL bLoadSpellCheck=TRUE);
  84         /**
  85          * Execute a scintilla command, e.g. SCI_GETLINE.
  86          */
  87         LRESULT         Call(UINT message, WPARAM wParam = 0, LPARAM lParam = 0);
  88         /**
  89          * The specified text is written to the scintilla control.
  90          */
  91         void            SetText(const CString& sText);
  92         /**
  93          * The specified text is inserted at the cursor position. If a text is
  94          * selected, that text is replaced.
  95          * \param bNewLine if set to true, a newline is appended.
  96          */
  97         void            InsertText(const CString& sText, bool bNewLine = false);
  98         /**
  99          * Retrieves the text in the scintilla control.
 100          */
 101         CString         GetText(void);
 102         /**
 103          * Sets the font for the control.
 104          */
 105         void            SetFont(CString sFontName, int iFontSizeInPoints);
 106         /**
 107          * Adds a list of words for use in auto completion.
 108          */
 109         void            SetAutoCompletionList(const std::set<CString>& list, const TCHAR separator = ';');
 110         /**
 111          * Returns the word located under the cursor.
 112          */
 113         CString         GetWordUnderCursor(bool bSelectWord = false);
 114
 115         void            RegisterContextMenuHandler(CSciEditContextMenuInterface * object) {m_arContextHandlers.Add(object);}
 116
 117         CStringA        StringForControl(const CString& text);
 118         CString         StringFromControl(const CStringA& text);
 119         int                     LoadFromFile(CString &filename);
 120
 121 private:
 122         bool IsUTF8(LPVOID pBuffer, size_t cb);
 123         HMODULE         m_hModule;
 124         LRESULT         m_DirectFunction;
 125         LRESULT         m_DirectPointer;
 126         Hunspell *      pChecker;
 127         MyThes *        pThesaur;
 128         UINT            m_spellcodepage;
 129         std::set<CString> m_autolist;
 130         TCHAR           m_separator;
 131         CStringA        m_sCommand;
 132         CStringA        m_sBugID;
 133         CString         m_sUrl;
 134         CArray<CSciEditContextMenuInterface *, CSciEditContextMenuInterface *> m_arContextHandlers;
 135         CPersonalDictionary m_personalDict;
 136         bool            m_bDoStyle;
 137         static bool IsValidURLChar(unsigned char ch);
 138 protected:
 139         virtual BOOL OnChildNotify(UINT message, WPARAM wParam, LPARAM lParam, LRESULT* pLResult);
 140         virtual BOOL PreTranslateMessage(MSG* pMsg);
 141         void            CheckSpelling(void);
 142         void            SuggestSpellingAlternatives(void);
 143         void            DoAutoCompletion(int nMinPrefixLength);
 144         BOOL            LoadDictionaries(LONG lLanguageID);
 145         BOOL            MarkEnteredBugID(int startstylepos, int endstylepos);
 146         bool            StyleEnteredText(int startstylepos, int endstylepos);
 147         void            StyleURLs(int startstylepos, int endstylepos);
 148         bool            WrapLines(int startpos, int endpos);
 149         bool            FindStyleChars(const char * line, char styler, int& start, int& end);
 150         void            AdvanceUTF8(const char * str, int& pos);
 151         BOOL            IsMisspelled(const CString& sWord);
 152         DWORD           GetStyleAt(int pos) { return (DWORD)Call(SCI_GETSTYLEAT, pos) & 0x1f; }
 153         bool            IsUrl(const CStringA& sText);
 154
 155         virtual afx_msg void OnKeyDown(UINT nChar, UINT nRepCnt, UINT nFlags);
 156         afx_msg void OnContextMenu(CWnd* /*pWnd*/, CPoint /*point*/);
 157         DECLARE_MESSAGE_MAP()
 158 };