src/TortoiseShell/ShellExt.h

   1 // TortoiseSVN - a Windows shell extension for easy version control\r
   2 \r
   3 // Copyright (C) 2003-2008 - TortoiseSVN\r
   4 \r
   5 // This program is free software; you can redistribute it and/or\r
   6 // modify it under the terms of the GNU General Public License\r
   7 // as published by the Free Software Foundation; either version 2\r
   8 // of the License, or (at your option) any later version.\r
   9 \r
  10 // This program is distributed in the hope that it will be useful,\r
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  13 // GNU General Public License for more details.\r
  14 \r
  15 // You should have received a copy of the GNU General Public License\r
  16 // along with this program; if not, write to the Free Software Foundation,\r
  17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\r
  18 //\r
  19 #pragma once\r
  20 \r
  21 #include "Globals.h"\r
  22 #include "registry.h"\r
  23 #include "resource.h"\r
  24 #include "ShellCache.h"\r
  25 #include "RemoteCacheLink.h"\r
  26 #include "GitStatus.h"\r
  27 #include "GitFolderStatus.h"\r
  28 #include "uxtheme.h"\r
  29 \r
  30 extern  UINT                            g_cRefThisDll;                  // Reference count of this DLL.\r
  31 extern  HINSTANCE                       g_hmodThisDll;                  // Instance handle for this DLL\r
  32 extern  ShellCache                      g_ShellCache;                   // caching of registry entries, ...\r
  33 extern  DWORD                           g_langid;\r
  34 extern  DWORD                           g_langTimeout;\r
  35 extern  HINSTANCE                       g_hResInst;\r
  36 extern  stdstring                       g_filepath;\r
  37 extern  git_wc_status_kind      g_filestatus;                   ///< holds the corresponding status to the file/dir above\r
  38 extern  bool                            g_readonlyoverlay;              ///< whether to show the read only overlay or not\r
  39 extern  bool                            g_lockedoverlay;                ///< whether to show the locked overlay or not\r
  40 \r
  41 extern bool                                     g_normalovlloaded;\r
  42 extern bool                                     g_modifiedovlloaded;\r
  43 extern bool                                     g_conflictedovlloaded;\r
  44 extern bool                                     g_readonlyovlloaded;\r
  45 extern bool                                     g_deletedovlloaded;\r
  46 extern bool                                     g_lockedovlloaded;\r
  47 extern bool                                     g_addedovlloaded;\r
  48 extern bool                                     g_ignoredovlloaded;\r
  49 extern bool                                     g_unversionedovlloaded;\r
  50 extern LPCTSTR                          g_MenuIDString;\r
  51 \r
  52 extern  void                            LoadLangDll();\r
  53 extern  CComCriticalSection     g_csGlobalCOMGuard;\r
  54 typedef CComCritSecLock<CComCriticalSection> AutoLocker;\r
  55 \r
  56 typedef DWORD ARGB;\r
  57 \r
  58 typedef HRESULT (WINAPI *FN_GetBufferedPaintBits) (HPAINTBUFFER hBufferedPaint, RGBQUAD **ppbBuffer, int *pcxRow);\r
  59 typedef HPAINTBUFFER (WINAPI *FN_BeginBufferedPaint) (HDC hdcTarget, const RECT *prcTarget, BP_BUFFERFORMAT dwFormat, BP_PAINTPARAMS *pPaintParams, HDC *phdc);\r
  60 typedef HRESULT (WINAPI *FN_EndBufferedPaint) (HPAINTBUFFER hBufferedPaint, BOOL fUpdateTarget);\r
  61 \r
  62 \r
  63 // The actual OLE Shell context menu handler\r
  64 /**\r
  65  * \ingroup TortoiseShell\r
  66  * The main class of our COM object / Shell Extension.\r
  67  * It contains all Interfaces we implement for the shell to use.\r
  68  * \remark The implementations of the different interfaces are\r
  69  * split into several *.cpp files to keep them in a reasonable size.\r
  70  */\r
  71 class CShellExt : public IContextMenu3,\r
  72                                                         IPersistFile,\r
  73                                                         IColumnProvider,\r
  74                                                         IShellExtInit,\r
  75                                                         IShellIconOverlayIdentifier,\r
  76                                                         IShellPropSheetExt,\r
  77                                                         ICopyHookW\r
  78 \r
  79 // COMPILER ERROR? You need the latest version of the\r
  80 // platform SDK which has references to IColumnProvider \r
  81 // in the header files.  Download it here:\r
  82 // http://www.microsoft.com/msdownload/platformsdk/sdkupdate/\r
  83 {\r
  84 protected:\r
  85 \r
  86         enum GitCommands\r
  87         {\r
  88                 ShellSeparator = 0,\r
  89                 ShellSubMenu = 1,\r
  90                 ShellSubMenuFolder,\r
  91                 ShellSubMenuFile,\r
  92                 ShellSubMenuLink,\r
  93                 ShellSubMenuMultiple,\r
  94                 ShellMenuCheckout,\r
  95                 ShellMenuUpdate,\r
  96                 ShellMenuCommit,\r
  97                 ShellMenuAdd,\r
  98                 ShellMenuAddAsReplacement,\r
  99                 ShellMenuRevert,\r
 100                 ShellMenuCleanup,\r
 101                 ShellMenuResolve,\r
 102                 ShellMenuSwitch,\r
 103                 ShellMenuImport,\r
 104                 ShellMenuExport,\r
 105                 ShellMenuAbout,\r
 106                 ShellMenuCreateRepos,\r
 107                 ShellMenuCopy,\r
 108                 ShellMenuMerge,\r
 109                 ShellMenuMergeAll,\r
 110                 ShellMenuSettings,\r
 111                 ShellMenuRemove,\r
 112                 ShellMenuRemoveKeep,\r
 113                 ShellMenuRename,\r
 114                 ShellMenuUpdateExt,\r
 115                 ShellMenuDiff,\r
 116                 ShellMenuPrevDiff,\r
 117                 ShellMenuUrlDiff,\r
 118                 ShellMenuDropCopyAdd,\r
 119                 ShellMenuDropMoveAdd,\r
 120                 ShellMenuDropMove,\r
 121                 ShellMenuDropMoveRename,\r
 122                 ShellMenuDropCopy,\r
 123                 ShellMenuDropCopyRename,\r
 124                 ShellMenuDropExport,\r
 125                 ShellMenuDropExportExtended,\r
 126                 ShellMenuLog,\r
 127                 ShellMenuConflictEditor,\r
 128                 ShellMenuRelocate,\r
 129                 ShellMenuHelp,\r
 130                 ShellMenuShowChanged,\r
 131                 ShellMenuIgnoreSub,\r
 132                 ShellMenuIgnore,\r
 133                 ShellMenuIgnoreFile,\r
 134                 ShellMenuIgnoreCaseSensitive,\r
 135                 ShellMenuIgnoreCaseInsensitive,\r
 136                 ShellMenuRefLog,\r
 137                 ShellMenuRefBrowse,\r
 138                 ShellMenuBlame,\r
 139                 ShellMenuApplyPatch,\r
 140                 ShellMenuCreatePatch,\r
 141                 ShellMenuRevisionGraph,\r
 142                 ShellMenuUnIgnoreSub,\r
 143                 ShellMenuUnIgnoreCaseSensitive,\r
 144                 ShellMenuUnIgnore,\r
 145 //              ShellMenuLock,\r
 146 //              ShellMenuUnlock,\r
 147 //              ShellMenuUnlockForce,\r
 148                 ShellMenuProperties,\r
 149                 ShellMenuDelUnversioned,\r
 150                 ShellMenuClipPaste,\r
 151                 ShellMenuPull,\r
 152                 ShellMenuPush,\r
 153                 ShellMenuClone,\r
 154                 ShellMenuBranch,\r
 155                 ShellMenuTag,\r
 156                 ShellMenuFormatPatch,\r
 157                 ShellMenuImportPatch,\r
 158                 ShellMenuCherryPick,\r
 159                 ShellMenuFetch,\r
 160                 ShellMenuRebase,\r
 161                 ShellMenuStashSave,\r
 162                 ShellMenuStashApply,\r
 163                 ShellMenuStashList,\r
 164                 ShellMenuSubAdd,\r
 165                 ShellMenuSubSync,\r
 166                 ShellMenuSendMail,\r
 167                 ShellMenuGitSVNRebase,\r
 168                 ShellMenuGitSVNDCommit,\r
 169                 ShellMenuLastEntry                      // used to mark the menu array end\r
 170         };\r
 171 \r
 172         // helper struct for context menu entries\r
 173         typedef struct MenuInfo\r
 174         {\r
 175                 GitCommands                     command;                ///< the command which gets executed for this menu entry\r
 176                 unsigned __int64        menuID;                 ///< the menu ID to recognize the entry. NULL if it shouldn't be added to the context menu automatically\r
 177                 UINT                            iconID;                 ///< the icon to show for the menu entry\r
 178                 UINT                            menuTextID;             ///< the text of the menu entry\r
 179                 UINT                            menuDescID;             ///< the description text for the menu entry\r
 180                 /// the following 8 params are for checking whether the menu entry should\r
 181                 /// be added automatically, based on states of the selected item(s).\r
 182                 /// The 'yes' states must be set, the 'no' states must not be set\r
 183                 /// the four pairs are OR'ed together, the 'yes'/'no' states are AND'ed together.\r
 184                 DWORD                           firstyes;\r
 185                 DWORD                           firstno;\r
 186                 DWORD                           secondyes;\r
 187                 DWORD                           secondno;\r
 188                 DWORD                           thirdyes;\r
 189                 DWORD                           thirdno;\r
 190                 DWORD                           fourthyes;\r
 191                 DWORD                           fourthno;\r
 192         };\r
 193 \r
 194         static MenuInfo menuInfo[];\r
 195         WORD fullver;\r
 196         FileState m_State;\r
 197         ULONG   m_cRef;\r
 198         //std::map<int,std::string> verbMap;\r
 199         std::map<UINT_PTR, UINT_PTR>    myIDMap;\r
 200         std::map<UINT_PTR, UINT_PTR>    mySubMenuMap;\r
 201         std::map<stdstring, UINT_PTR> myVerbsMap;\r
 202         std::map<UINT_PTR, stdstring> myVerbsIDMap;\r
 203         stdstring       folder_;\r
 204         std::vector<stdstring> files_;\r
 205         DWORD itemStates;                               ///< see the globals.h file for the ITEMIS_* defines\r
 206         DWORD itemStatesFolder;                 ///< used for states of the folder_ (folder background and/or drop target folder)\r
 207         stdstring uuidSource;\r
 208         stdstring uuidTarget;\r
 209         int space;\r
 210         TCHAR stringtablebuffer[255];\r
 211         stdstring columnfilepath;               ///< holds the last file/dir path for the column provider\r
 212         stdstring columnauthor;                 ///< holds the corresponding author of the file/dir above\r
 213         stdstring itemurl;\r
 214         stdstring itemshorturl;\r
 215         stdstring ignoredprops;\r
 216         stdstring owner;\r
 217         git_revnum_t columnrev;                 ///< holds the corresponding revision to the file/dir above\r
 218         git_wc_status_kind      filestatus;\r
 219         std::map<UINT, HBITMAP> bitmaps;\r
 220 \r
 221         GitFolderStatus         m_CachedStatus;         // status cache\r
 222         CRemoteCacheLink        m_remoteCacheLink;\r
 223 \r
 224         FN_GetBufferedPaintBits pfnGetBufferedPaintBits;\r
 225         FN_BeginBufferedPaint pfnBeginBufferedPaint;\r
 226         FN_EndBufferedPaint pfnEndBufferedPaint;\r
 227 \r
 228 #define MAKESTRING(ID) LoadStringEx(g_hResInst, ID, stringtablebuffer, sizeof(stringtablebuffer)/sizeof(TCHAR), (WORD)CRegStdWORD(_T("Software\\TortoiseGit\\LanguageID"), MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT)))\r
 229 private:\r
 230         void                    InsertGitMenu(BOOL istop, HMENU menu, UINT pos, UINT_PTR id, UINT stringid, UINT icon, UINT idCmdFirst, GitCommands com, UINT uFlags);\r
 231         void                    InsertIgnoreSubmenus(UINT &idCmd, UINT idCmdFirst, HMENU hMenu, HMENU subMenu, UINT &indexMenu, int &indexSubMenu, unsigned __int64 topmenu, bool bShowIcons, UINT uFlags);\r
 232         stdstring               WriteFileListToTempFile();\r
 233         bool                    WriteClipboardPathsToTempFile(stdstring& tempfile);\r
 234         LPCTSTR                 GetMenuTextFromResource(int id);\r
 235         void                    GetColumnStatus(const TCHAR * path, BOOL bIsDir);\r
 236         HBITMAP                 IconToBitmap(UINT uIcon);\r
 237         STDMETHODIMP    QueryDropContext(UINT uFlags, UINT idCmdFirst, HMENU hMenu, UINT &indexMenu);\r
 238         bool                    IsIllegalFolder(std::wstring folder, int * cslidarray);\r
 239         HBITMAP                 IconToBitmapPARGB32(UINT uIcon);\r
 240         HRESULT                 Create32BitHBITMAP(HDC hdc, const SIZE *psize, __deref_opt_out void **ppvBits, __out HBITMAP* phBmp);\r
 241         HRESULT                 ConvertBufferToPARGB32(HPAINTBUFFER hPaintBuffer, HDC hdc, HICON hicon, SIZE& sizIcon);\r
 242         bool                    HasAlpha(__in ARGB *pargb, SIZE& sizImage, int cxRow);\r
 243         HRESULT                 ConvertToPARGB32(HDC hdc, __inout ARGB *pargb, HBITMAP hbmp, SIZE& sizImage, int cxRow);\r
 244 \r
 245 \r
 246 public:\r
 247         CShellExt(FileState state);\r
 248         virtual ~CShellExt();\r
 249 \r
 250         /** \name IUnknown \r
 251          * IUnknown members\r
 252          */\r
 253         //@{\r
 254         STDMETHODIMP         QueryInterface(REFIID, LPVOID FAR *);\r
 255         STDMETHODIMP_(ULONG) AddRef();\r
 256         STDMETHODIMP_(ULONG) Release();\r
 257         //@}\r
 258 \r
 259         /** \name IContextMenu2 \r
 260          * IContextMenu2 members\r
 261          */\r
 262         //@{\r
 263         STDMETHODIMP    QueryContextMenu(HMENU hMenu, UINT indexMenu, UINT idCmdFirst, UINT idCmdLast, UINT uFlags);\r
 264         STDMETHODIMP    InvokeCommand(LPCMINVOKECOMMANDINFO lpcmi);\r
 265         STDMETHODIMP    GetCommandString(UINT_PTR idCmd, UINT uFlags, UINT FAR *reserved, LPSTR pszName, UINT cchMax);\r
 266         STDMETHODIMP    HandleMenuMsg(UINT uMsg, WPARAM wParam, LPARAM lParam);\r
 267         //@}\r
 268 \r
 269     /** \name IContextMenu3 \r
 270          * IContextMenu3 members\r
 271          */\r
 272         //@{\r
 273         STDMETHODIMP    HandleMenuMsg2(UINT uMsg, WPARAM wParam, LPARAM lParam, LRESULT *pResult);\r
 274         //@}\r
 275 \r
 276         /** \name IColumnProvider\r
 277          * IColumnProvider members\r
 278          */\r
 279         //@{\r
 280         STDMETHODIMP    GetColumnInfo(DWORD dwIndex, SHCOLUMNINFO *psci);\r
 281         STDMETHODIMP    GetItemData(LPCSHCOLUMNID pscid, LPCSHCOLUMNDATA pscd, VARIANT *pvarData);\r
 282         STDMETHODIMP    Initialize(LPCSHCOLUMNINIT psci);\r
 283         //@}\r
 284 \r
 285         /** \name IShellExtInit\r
 286          * IShellExtInit methods\r
 287          */\r
 288         //@{\r
 289         STDMETHODIMP    Initialize(LPCITEMIDLIST pIDFolder, LPDATAOBJECT pDataObj, HKEY hKeyID);\r
 290         //@}\r
 291 \r
 292     /** \name IPersistFile\r
 293          * IPersistFile methods\r
 294          */\r
 295         //@{\r
 296     STDMETHODIMP        GetClassID(CLSID *pclsid);\r
 297     STDMETHODIMP        Load(LPCOLESTR pszFileName, DWORD dwMode);\r
 298     STDMETHODIMP        IsDirty(void) { return S_OK; };\r
 299     STDMETHODIMP        Save(LPCOLESTR /*pszFileName*/, BOOL /*fRemember*/) { return S_OK; };\r
 300     STDMETHODIMP        SaveCompleted(LPCOLESTR /*pszFileName*/) { return S_OK; };\r
 301     STDMETHODIMP        GetCurFile(LPOLESTR * /*ppszFileName*/) { return S_OK; };\r
 302         //@}\r
 303 \r
 304         /** \name IShellIconOverlayIdentifier \r
 305          * IShellIconOverlayIdentifier methods\r
 306          */\r
 307         //@{\r
 308         STDMETHODIMP    GetOverlayInfo(LPWSTR pwszIconFile, int cchMax, int *pIndex, DWORD *pdwFlags);\r
 309         STDMETHODIMP    GetPriority(int *pPriority); \r
 310         STDMETHODIMP    IsMemberOf(LPCWSTR pwszPath, DWORD dwAttrib);\r
 311         //@}\r
 312 \r
 313         /** \name IShellPropSheetExt \r
 314          * IShellPropSheetExt methods\r
 315          */\r
 316         //@{\r
 317         STDMETHODIMP    AddPages(LPFNADDPROPSHEETPAGE lpfnAddPage, LPARAM lParam);\r
 318         STDMETHODIMP    ReplacePage (UINT, LPFNADDPROPSHEETPAGE, LPARAM);\r
 319         //@}\r
 320 \r
 321         /** \name ICopyHook \r
 322          * ICopyHook members\r
 323          */\r
 324         //@{\r
 325         STDMETHODIMP_(UINT) CopyCallback(HWND hWnd, UINT wFunc, UINT wFlags, LPCTSTR pszSrcFile, DWORD dwSrcAttribs, LPCTSTR pszDestFile, DWORD dwDestAttribs);\r
 326         //@}\r
 327 \r
 328 };\r