// TortoiseSVN - a Windows shell extension for easy version control // Copyright (C) 2003-2011, 2013, 2015-2022 - TortoiseSVN // This program is free software; you can redistribute it and/or // modify it under the terms of the GNU General Public License // as published by the Free Software Foundation; either version 2 // of the License, or (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program; if not, write to the Free Software Foundation, // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. // #pragma once #include "../SmartHandle.h" #include "scintilla.h" #include "../../../ext/hunspell/hunspell.hxx" #include "ProjectProperties.h" #include "PersonalDictionary.h" #include #include #include "LruCache.h" #define AUTOCOMPLETE_SPELLING 0 #define AUTOCOMPLETE_FILENAME 1 #define AUTOCOMPLETE_PROGRAMCODE 2 #define AUTOCOMPLETE_SNIPPET 3 _COM_SMARTPTR_TYPEDEF(ISpellCheckerFactory, __uuidof(ISpellCheckerFactory)); _COM_SMARTPTR_TYPEDEF(ISpellChecker, __uuidof(ISpellChecker)); _COM_SMARTPTR_TYPEDEF(IEnumSpellingError, __uuidof(IEnumSpellingError)); _COM_SMARTPTR_TYPEDEF(ISpellingError, __uuidof(ISpellingError)); //forward declaration class CSciEdit; /** * \ingroup Utils * This class acts as an interface so that CSciEdit can call these methods * on other objects which implement this interface. * Classes implementing this interface must call RegisterContextMenuHandler() * in CSciEdit to register themselves. */ class CSciEditContextMenuInterface { public: virtual ~CSciEditContextMenuInterface() = default; /** * When the handler is called with this method, it can add entries * to the \a mPopup context menu itself. The \a nCmd param is the command * ID number the handler must use for its commands. For every added command, * the handler is responsible to increment the \a nCmd param by one. */ virtual void InsertMenuItems(CMenu& mPopup, int& nCmd); /** * The handler is called when the user clicks on any context menu entry * which isn't handled by CSciEdit itself. That means the handler might * be called for entries it hasn't added itself! * \remark the handler should return \a true if it handled the call, otherwise * it should return \a false */ virtual bool HandleMenuItemClick(int cmd, CSciEdit* pSciEdit); virtual void HandleSnippet(int type, const CString& text, CSciEdit* pSciEdit); }; /** * \ingroup Utils * Encapsulates the Scintilla edit control. Usable as a replacement for the * MFC CEdit control, but not a drop-in replacement! * Also provides additional features like spell checking, auto completion, ... */ class CSciEdit : public CWnd { DECLARE_DYNAMIC(CSciEdit) public: CSciEdit(); ~CSciEdit() override; /** * Initialize the scintilla control. Must be called prior to any other * method! */ void Init(const ProjectProperties& props); void Init(LONG lLanguage = 0); void SetIcon(const std::map& icons) const; /** * Execute a scintilla command, e.g. SCI_GETLINE. */ LRESULT Call(UINT message, WPARAM wParam = 0, LPARAM lParam = 0) const; /** * The specified text is written to the scintilla control. */ void SetText(const CString& sText); /** * The specified text is inserted at the cursor position. If a text is * selected, that text is replaced. * \param sText test to insert * \param bNewLine if set to true, a newline is appended. */ void InsertText(const CString& sText, bool bNewLine = false); /** * Retrieves the text in the scintilla control. */ CString GetText() const; /** * Sets the font for the control. */ void SetFont(CString sFontName, int iFontSizeInPoints) const; /** * Adds a list of words for use in auto completion. */ void SetAutoCompletionList(std::map&& list, wchar_t separator = ';', wchar_t typeSeparator = '?'); /** * Returns the word located under the cursor. */ CString GetWordUnderCursor(bool bSelectWord = false, bool allchars = false) const; void RegisterContextMenuHandler(CSciEditContextMenuInterface* object) { m_arContextHandlers.Add(object); } CStringA StringForControl(const CString& text) const; CString StringFromControl(const CStringA& text) const; void SetRepositoryRoot(const CString& url) { m_sRepositoryRoot = url; } void RestyleBugIDs() const; void SetReadOnly(bool bReadOnly); private: CAutoLibrary m_hModule; LRESULT m_directFunction; LRESULT m_directPointer; std::unique_ptr m_pChecker; UINT m_spellCodepage; std::map m_autolist; wchar_t m_separator; wchar_t m_typeSeparator; CStringA m_sCommand; CStringA m_sBugID; CString m_sUrl; CString m_sRepositoryRoot; CArray m_arContextHandlers; CPersonalDictionary m_personalDict; bool m_bDoStyle; int m_nAutoCompleteMinChars; ISpellCheckerFactoryPtr m_spellCheckerFactory; ISpellCheckerPtr m_spellChecker; LruCache m_spellingCache; bool m_blockModifiedHandler; bool m_bReadOnly; int m_themeCallbackId; static bool IsValidURLChar(unsigned char ch); protected: BOOL OnChildNotify(UINT message, WPARAM wParam, LPARAM lParam, LRESULT* pLResult) override; BOOL PreTranslateMessage(MSG* pMsg) override; virtual ULONG GetGestureStatus(CPoint ptTouch) override; void CheckSpelling(Sci_Position startpos, Sci_Position endpos); void SuggestSpellingAlternatives() const; void DoAutoCompletion(Sci_Position nMinPrefixLength); BOOL LoadDictionaries(LONG lLanguageID); BOOL MarkEnteredBugID(Sci_Position startstylepos, Sci_Position endstylepos) const; bool StyleEnteredText(Sci_Position startStylePos, Sci_Position endStylePos) const; void StyleURLs(Sci_Position startStylePos, Sci_Position endStylePos) const; bool WrapLines(Sci_Position startpos, Sci_Position endpos) const; static bool FindStyleChars(const char* line, char styler, Sci_Position& start, Sci_Position& end); static void AdvanceUTF8(const char* str, int& pos); BOOL CheckWordSpelling(const CString& sWord) const; BOOL IsMisspelled(const CString& sWord); DWORD GetStyleAt(Sci_Position pos) const { return static_cast(Call(SCI_GETSTYLEAT, pos)) & 0x1f; } static bool IsUrlOrEmail(const CStringA& sText); std::string GetWordForSpellChecker(const CString& sWord) const; CString GetWordFromSpellChecker(const std::string& sWordA) const; static void SetWindowStylesForAutocompletionPopup(); static BOOL CALLBACK AdjustThemeProc(HWND hwnd, LPARAM lParam); afx_msg void OnKeyDown(UINT nChar, UINT nRepCnt, UINT nFlags); afx_msg void OnContextMenu(CWnd* /*pWnd*/, CPoint /*point*/); afx_msg void OnSysColorChange(); DECLARE_MESSAGE_MAP() }; // helper function to load and parse a snippet file void ParseSnippetFile(const CString& sFile, std::map& mapSnippet);