src/Git/GitFolderStatus.h

   1 // TortoiseSVN - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2003-2006,2008 - Stefan Kueng
   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
  21 #include "GitStatus.h"
  22 #include "TGitPath.h"
  23
  24 /**
  25  * \ingroup TortoiseShell
  26  * a simple utility class:
  27  * stores unique copies of given string values,
  28  * i.e. for a given value, always the same const char*
  29  * will be returned.
  30  *
  31  * The strings returned are owned by the pool!
  32  */
  33 class StringPool
  34 {
  35 public:
  36
  37         StringPool() {emptyString[0] = 0;}
  38         ~StringPool() {clear();}
  39
  40         /**
  41          * Return a string equal to value from the internal pool.
  42          * If no such string is available, a new one is allocated.
  43          * NULL is valid for value.
  44          */
  45         const char* GetString (const char* value);
  46
  47         /**
  48          * invalidates all strings returned by GetString()
  49          * frees all internal data
  50          */
  51         void clear();
  52
  53 private:
  54
  55         // comparator: compare C-style strings
  56
  57         struct LessString
  58         {
  59                 bool operator()(const char* lhs, const char* rhs) const
  60                 {
  61                         return strcmp (lhs, rhs) < 0;
  62                 }
  63         };
  64
  65         // store the strings in a map
  66         // caution: modifying the map must not modify the string pointers
  67
  68         typedef std::set<const char*, LessString> pool_type;
  69         pool_type pool;
  70         char emptyString[1];
  71 };
  72
  73
  74 typedef struct FileStatusCacheEntry
  75 {
  76         git_wc_status_kind              status;
  77         const char*                             author;         ///< points to a (possibly) shared value
  78         const char*                             url;            ///< points to a (possibly) shared value
  79         const char*                             owner;          ///< points to a (possible) lock owner
  80         bool                                    needslock;
  81         git_revnum_t                    rev;
  82         int                                             askedcounter;
  83         //git_lock_t *                  lock;
  84         bool                                    tree_conflict;
  85 } FileStatusCacheEntry;
  86
  87 #define GITFOLDERSTATUS_CACHETIMES                              10
  88 #define GITFOLDERSTATUS_CACHETIMEOUT                    2000
  89 #define GITFOLDERSTATUS_RECURSIVECACHETIMEOUT   4000
  90 #define GITFOLDERSTATUS_FOLDER                                  500
  91 /**
  92  * \ingroup TortoiseShell
  93  * This class represents a caching mechanism for the
  94  * subversion statuses. Once a status for a versioned
  95  * file is requested (GetFileStatus()) first its checked
  96  * if that status is already in the cache. If it is not
  97  * then the subversion statuses for ALL files in the same
  98  * directory is fetched and cached. This is because subversion
  99  * needs almost the same time to get one or all status (in
 100  * the same directory).
 101  * To prevent a cache flush for the explorer folder view
 102  * the cache is only fetched for versioned files and
 103  * not for folders.
 104  */
 105 class GitFolderStatus
 106 {
 107 public:
 108         GitFolderStatus(void);
 109         ~GitFolderStatus(void);
 110         const FileStatusCacheEntry *    GetFullStatus(const CTGitPath& filepath, BOOL bIsFolder, BOOL bColumnProvider = FALSE);
 111         const FileStatusCacheEntry *    GetCachedItem(const CTGitPath& filepath);
 112
 113         FileStatusCacheEntry            invalidstatus;
 114
 115         GitStatus       m_GitStatus;
 116
 117 private:
 118         const FileStatusCacheEntry * BuildCache(const CTGitPath& filepath, const CString& sProjectRoot, BOOL bIsFolder, BOOL bDirectFolder = FALSE);
 119         DWORD                           GetTimeoutValue();
 120         //static git_error_t*   fillstatusmap (void *baton, const char *path, git_wc_status2_t *status, apr_pool_t *pool);
 121         //static git_error_t*   findfolderstatus (void *baton, const char *path, git_wc_status2_t *status, apr_pool_t *pool);
 122         static BOOL                     fillstatusmap(const struct wgFile_s *pFile, void *pUserData);
 123         static void                     fillstatusmap_idx(CString &path,git_wc_status_kind status,void *pdata);
 124
 125         static CTGitPath        folderpath;
 126         void                            ClearCache();
 127
 128         int                                     m_nCounter;
 129         typedef std::map<stdstring, FileStatusCacheEntry> FileStatusMap;
 130         FileStatusMap                   m_cache;
 131         DWORD                                   m_TimeStamp;
 132         FileStatusCacheEntry    dirstat;
 133         FileStatusCacheEntry    filestat;
 134         git_wc_status2_t *              dirstatus;
 135         //apr_pool_t *                  rootpool;
 136
 137         // merging these pools won't save memory
 138         // but access will become slower
 139
 140         StringPool              authors;
 141         StringPool              urls;
 142         StringPool              owners;
 143         char                    emptyString[1];
 144
 145         stdstring               sCacheKey;
 146
 147         HANDLE                  m_hInvalidationEvent;
 148
 149         // The item we most recently supplied status for
 150         CTGitPath               m_mostRecentPath;
 151         const FileStatusCacheEntry* m_mostRecentStatus;
 152 };
 153