src/TGitCache/CacheInterface.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // External Cache Copyright (C) 2005-2006,2008-2010 - TortoiseSVN
   4 // Copyright (C) 2008-2013, 2016-2017 - TortoiseGit
   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, write to the Free Software Foundation,
  18 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19 //
  20
  21 #pragma once
  22 #include <wininet.h>
  23 #include "GitStatus.h"
  24
  25 // The name of the named-pipe for the cache
  26
  27 #define TGIT_CACHE_PIPE_NAME L"\\\\.\\pipe\\TGitCache"
  28 #define TGIT_CACHE_COMMANDPIPE_NAME L"\\\\.\\pipe\\TGitCacheCommand"
  29 #define TGIT_CACHE_WINDOW_NAME L"TGitCacheWindow"
  30 #define TGIT_CACHE_MUTEX_NAME L"TGitCacheMutex"
  31
  32
  33 CString GetCachePipeName();
  34 CString GetCacheCommandPipeName();
  35 CString GetCacheMutexName();
  36
  37 CString GetCacheID();
  38 bool    SendCacheCommand(BYTE command, const WCHAR* path = nullptr);
  39
  40 /**
  41  * \ingroup TGitCache
  42  * RAII class that temporarily disables updates for the given path
  43  * by sending TGITCACHECOMMAND_BLOCK and TGITCACHECOMMAND_UNBLOCK.
  44  */
  45 class CBlockCacheForPath
  46 {
  47 private:
  48         WCHAR path[MAX_PATH];
  49         bool m_bBlocked;
  50
  51 public:
  52         CBlockCacheForPath(const WCHAR * aPath);
  53         ~CBlockCacheForPath();
  54 };
  55
  56 /**
  57  * \ingroup TGitCache
  58  * A structure passed as a request from the shell (or other client) to the external cache
  59  */
  60 struct TGITCacheRequest
  61 {
  62         DWORD flags;
  63         WCHAR path[MAX_PATH];
  64 };
  65
  66 // CustomActions will use this header but does not need nor understand the SVN types ...
  67
  68 /**
  69  * \ingroup TGitCache
  70  * The structure returned as a response
  71  */
  72 struct TGITCacheResponse
  73 {
  74         UINT8 m_status;
  75         bool m_bAssumeValid;
  76         bool m_bSkipWorktree;
  77 };
  78 static_assert((UINT8)git_wc_status_unknown == git_wc_status_unknown, "type git_wc_status_kind fits into UINT8");
  79 static_assert(sizeof(TGITCacheResponse) == 3 && offsetof(TGITCacheResponse, m_status) == 0 && offsetof(TGITCacheResponse, m_bAssumeValid) == 1 && offsetof(TGITCacheResponse, m_bSkipWorktree) == 2, "Cross platform compatibility");
  80
  81 /**
  82  * \ingroup TGitCache
  83  * a cache command
  84  */
  85 struct TGITCacheCommand
  86 {
  87         BYTE command;                           ///< the command to execute
  88         WCHAR path[MAX_PATH];           ///< path to do the command for
  89 };
  90
  91 #define         TGITCACHECOMMAND_END            0               ///< ends the thread handling the pipe communication
  92 #define         TGITCACHECOMMAND_CRAWL          1               ///< start crawling the specified path for changes
  93 #define         TGITCACHECOMMAND_REFRESHALL     2               ///< Refreshes the whole cache, usually necessary after the "treat unversioned files as modified" option changed.
  94 #define         TGITCACHECOMMAND_RELEASE        3               ///< Releases all open handles for the specified path and all paths below
  95 #define         TGITCACHECOMMAND_BLOCK          4               ///< Blocks a path from getting crawled for a specific amount of time or until the TGITCACHECOMMAND_UNBLOCK command is sent for that path
  96 #define         TGITCACHECOMMAND_UNBLOCK                5               ///< Removes a path from the list of paths blocked from getting crawled
  97
  98 /// Set this flag if you already know whether or not the item is a folder
  99 #define TGITCACHE_FLAGS_FOLDERISKNOWN           0x01
 100 /// Set this flag if the item is a folder
 101 #define TGITCACHE_FLAGS_ISFOLDER                        0x02
 102 /// Set this flag if you want recursive folder status (safely ignored for file paths)
 103 #define TGITCACHE_FLAGS_RECUSIVE_STATUS         0x04
 104 /// Set this flag if notifications to the shell are not allowed
 105 #define TGITCACHE_FLAGS_NONOTIFICATIONS         0x08