src/Git/TGitPath.h

   1 #pragma once
   2 #include "gittype.h"
   3
   4 class CTGitPath
   5 {
   6 public:
   7         CTGitPath(void);
   8         ~CTGitPath(void);
   9         CTGitPath(const CString& sUnknownPath);
  10         int m_Stage;
  11 public:
  12         enum
  13         {
  14                 LOGACTIONS_ADDED        = 0x00000001,
  15                 LOGACTIONS_MODIFIED     = 0x00000002,
  16                 LOGACTIONS_REPLACED     = 0x00000004,
  17                 LOGACTIONS_DELETED      = 0x00000008,
  18                 LOGACTIONS_UNMERGED = 0x00000010,
  19                 LOGACTIONS_CACHE        = 0x00000020,
  20                 LOGACTIONS_COPY         = 0x00000040,
  21                 LOGACTIONS_MERGED   = 0x00000080,
  22                 LOGACTIONS_FORWORD  = 0x00000100,
  23                 LOGACTIONS_UNVER        = 0x80000000,
  24                 LOGACTIONS_IGNORE       = 0x40000000,
  25                 //LOGACTIONS_CONFLICT = 0x20000000,
  26
  27                 // For log filter only
  28                 LOGACTIONS_HIDE         = 0x20000000,
  29                 LOGACTIONS_GRAY         = 0x10000000,
  30
  31                 // For Rebase only
  32                 LOGACTIONS_REBASE_CURRENT = 0x08000000,
  33                 LOGACTIONS_REBASE_PICK    = 0x04000000,
  34                 LOGACTIONS_REBASE_SQUASH  = 0x02000000,
  35                 LOGACTIONS_REBASE_EDIT    = 0x01000000,
  36                 LOGACTIONS_REBASE_DONE    = 0x00800000,
  37                 LOGACTIONS_REBASE_SKIP    = 0x00400000,
  38                 LOGACTIONS_REBASE_MASK    = 0x0FC00000,
  39                 LOGACTIONS_REBASE_MODE_MASK=0x07C00000,
  40
  41         };
  42
  43         CString m_StatAdd;
  44         CString m_StatDel;
  45         int             m_Action;
  46         bool    m_Checked;
  47         int     ParserAction(BYTE action);
  48         CString GetActionName();
  49         static CString GetActionName(int action);
  50         /**
  51          * Set the path as an UTF8 string with forward slashes
  52          */
  53         void SetFromGit(const char* pPath);
  54         void SetFromGit(const char* pPath, bool bIsDirectory);
  55         void SetFromGit(const TCHAR* pPath, bool bIsDirectory);
  56         void SetFromGit(const CString& sPath,CString *OldPath=NULL);
  57
  58         /**
  59          * Set the path as UNICODE with backslashes
  60          */
  61         void SetFromWin(LPCTSTR pPath);
  62         void SetFromWin(const CString& sPath);
  63         void SetFromWin(const CString& sPath, bool bIsDirectory);
  64         /**
  65          * Set the path from an unknown source.
  66          */
  67         void SetFromUnknown(const CString& sPath);
  68         /**
  69          * Returns the path in Windows format, i.e. with backslashes
  70          */
  71         LPCTSTR GetWinPath() const;
  72         /**
  73          * Returns the path in Windows format, i.e. with backslashes
  74          */
  75         const CString& GetWinPathString() const;
  76         /**
  77          * Returns the path with forward slashes.
  78          */
  79         const CString& GetGitPathString() const;
  80
  81         const CString& GetGitOldPathString() const;
  82         /**
  83          * Returns the path completely prepared to be fed the the Git APIs
  84          * It will be in UTF8, with URLs escaped, if necessary
  85          */
  86 //      const char* GetGitApiPath(apr_pool_t *pool) const;
  87         /**
  88          * Returns the path for showing in an UI.
  89          *
  90          * URL's are returned with forward slashes, unescaped if necessary
  91          * Paths are returned with backward slashes
  92          */
  93         const CString& GetUIPathString() const;
  94         /**
  95          * Checks if the path is an URL.
  96          */
  97         bool IsUrl() const;
  98         /**
  99          * Returns true if the path points to a directory
 100          */
 101         bool IsDirectory() const;
 102
 103         CTGitPath GetSubPath(CTGitPath &root);
 104
 105         /**
 106          * Returns the directory. If the path points to a directory, then the path
 107          * is returned unchanged. If the path points to a file, the path to the
 108          * parent directory is returned.
 109          */
 110         CTGitPath GetDirectory() const;
 111         /**
 112         * Returns the the directory which contains the item the path refers to.
 113         * If the path is a directory, then this returns the directory above it.
 114         * If the path is to a file, then this returns the directory which contains the path
 115         * parent directory is returned.
 116         */
 117         CTGitPath GetContainingDirectory() const;
 118         /**
 119          * Get the 'root path' (e.g. "c:\") - Used to pass to GetDriveType
 120          */
 121         CString GetRootPathString() const;
 122         /**
 123          * Returns the filename part of the full path.
 124          * \remark don't call this for directories.
 125          */
 126         CString GetFilename() const;
 127         CString GetBaseFilename() const;
 128         /**
 129          * Returns the item's name without the full path.
 130          */
 131         CString GetFileOrDirectoryName() const;
 132         /**
 133          * Returns the item's name without the full path, unescaped if necessary.
 134          */
 135         CString GetUIFileOrDirectoryName() const;
 136         /**
 137          * Returns the file extension, including the dot.
 138          * \remark Returns an empty string for directories
 139          */
 140         CString GetFileExtension() const;
 141
 142         bool IsEmpty() const;
 143         void Reset();
 144         /**
 145          * Checks if two paths are equal. The slashes are taken care of.
 146          */
 147         bool IsEquivalentTo(const CTGitPath& rhs) const;
 148         bool IsEquivalentToWithoutCase(const CTGitPath& rhs) const;
 149         bool operator==(const CTGitPath& x) const {return IsEquivalentTo(x);}
 150
 151         /**
 152          * Checks if \c possibleDescendant is a child of this path.
 153          */
 154         bool IsAncestorOf(const CTGitPath& possibleDescendant) const;
 155         /**
 156          * Get a string representing the file path, optionally with a base
 157          * section stripped off the front
 158          * Returns a string with fwdslash paths
 159          */
 160         CString GetDisplayString(const CTGitPath* pOptionalBasePath = NULL) const;
 161         /**
 162          * Compares two paths. Slash format is irrelevant.
 163          */
 164         static int Compare(const CTGitPath& left, const CTGitPath& right);
 165
 166         /** As PredLeftLessThanRight, but for checking if paths are equivalent
 167          */
 168         static bool PredLeftEquivalentToRight(const CTGitPath& left, const CTGitPath& right);
 169
 170         /** Checks if the left path is pointing to the same working copy path as the right.
 171          * The same wc path means the paths are equivalent once all the admin dir path parts
 172          * are removed. This is used in the TGitCache crawler to filter out all the 'duplicate'
 173          * paths to crawl.
 174          */
 175         static bool PredLeftSameWCPathAsRight(const CTGitPath& left, const CTGitPath& right);
 176
 177         static bool CheckChild(const CTGitPath &parent, const CTGitPath& child);
 178
 179         /**
 180          * appends a string to this path.
 181          *\remark - missing slashes are not added - this is just a string concatenation, but with
 182          * preservation of the proper caching behavior.
 183          * If you want to join a file- or directory-name onto the path, you should use AppendPathString
 184          */
 185         void AppendRawString(const CString& sAppend);
 186
 187         /**
 188         * appends a part of a path to this path.
 189         *\remark - missing slashes are dealt with properly. Don't use this to append a file extension, for example
 190         *
 191         */
 192         void AppendPathString(const CString& sAppend);
 193
 194         /**
 195          * Get the file modification time - returns zero for files which don't exist
 196          * Returns a FILETIME structure cast to an __int64, for easy comparisons
 197          */
 198         __int64 GetLastWriteTime() const;
 199
 200         bool IsReadOnly() const;
 201
 202         /**
 203          * Checks if the path really exists.
 204          */
 205         bool Exists() const;
 206
 207         /**
 208          * Deletes the file/folder
 209          * \param bTrash if true, uses the Windows trash bin when deleting.
 210          */
 211         bool Delete(bool bTrash) const;
 212
 213         /**
 214          * Checks if a Subversion admin directory is present. For files, the check
 215          * is done in the same directory. For folders, it checks if the folder itself
 216          * contains an admin directory.
 217          */
 218         bool HasAdminDir() const;
 219         bool HasAdminDir(CString *ProjectTopDir) const;
 220         bool HasSubmodules() const;
 221         bool HasGitSVNDir() const;
 222         bool HasStashDir() const;
 223
 224         int  GetAdminDirMask() const;
 225
 226         /**
 227          * Checks if the path point to or below a Subversion admin directory (.Git).
 228          */
 229         bool IsAdminDir() const;
 230
 231         void SetCustomData(LPARAM lp) {m_customData = lp;}
 232         LPARAM GetCustomData() {return m_customData;}
 233
 234         /**
 235          * Checks if the path or URL is valid on Windows.
 236          * A path is valid if conforms to the specs in the windows API.
 237          * An URL is valid if the path checked out from it is valid
 238          * on windows. That means an URL which is valid according to the WWW specs
 239          * isn't necessarily valid as a windows path (e.g. http://myserver.com/repos/file:name
 240          * is a valid URL, but the path is illegal on windows ("file:name" is illegal), so
 241          * this function would return \c false for that URL).
 242          */
 243         bool IsValidOnWindows() const;
 244
 245         /**
 246          * Checks to see if the path or URL represents one of the special directories
 247          * (branches, tags, or trunk).
 248          */
 249         bool IsSpecialDirectory() const;
 250 private:
 251         // All these functions are const, and all the data
 252         // is mutable, in order that the hidden caching operations
 253         // can be carried out on a const CTGitPath object, which is what's
 254         // likely to be passed between functions
 255         // The public 'SetFromxxx' functions are not const, and so the proper
 256         // const-correctness semantics are preserved
 257         void SetFwdslashPath(const CString& sPath) const;
 258         void SetBackslashPath(const CString& sPath) const;
 259         void SetUTF8FwdslashPath(const CString& sPath) const;
 260         void EnsureBackslashPathSet() const;
 261         void EnsureFwdslashPathSet() const;
 262         /**
 263          * Checks if two path strings are equal. No conversion of slashes is done!
 264          * \remark for slash-independent comparison, use IsEquivalentTo()
 265          */
 266         static bool ArePathStringsEqual(const CString& sP1, const CString& sP2);
 267         static bool ArePathStringsEqualWithCase(const CString& sP1, const CString& sP2);
 268
 269         /**
 270          * Adds the required trailing slash to local root paths such as 'C:'
 271          */
 272         void SanitizeRootPath(CString& sPath, bool bIsForwardPath) const;
 273
 274         void UpdateAttributes() const;
 275
 276
 277
 278 private:
 279         mutable CString m_sBackslashPath;
 280         mutable CString m_sFwdslashPath;
 281         mutable CString m_sUIPath;
 282         mutable CStringA m_sUTF8FwdslashPath;
 283         mutable CStringA m_sUTF8FwdslashPathEscaped;
 284         mutable CString m_sProjectRoot;
 285
 286         //used for rename case
 287         mutable CString m_sOldBackslashPath;
 288         mutable CString m_sOldFwdslashPath;
 289
 290         // Have we yet determined if this is a directory or not?
 291         mutable bool m_bDirectoryKnown;
 292         mutable bool m_bIsDirectory;
 293         mutable bool m_bLastWriteTimeKnown;
 294         mutable bool m_bURLKnown;
 295         mutable bool m_bIsURL;
 296         mutable __int64 m_lastWriteTime;
 297         mutable bool m_bIsReadOnly;
 298         mutable bool m_bHasAdminDirKnown;
 299         mutable bool m_bHasAdminDir;
 300         mutable bool m_bIsValidOnWindowsKnown;
 301         mutable bool m_bIsValidOnWindows;
 302         mutable bool m_bIsAdminDirKnown;
 303         mutable bool m_bIsAdminDir;
 304         mutable bool m_bExists;
 305         mutable bool m_bExistsKnown;
 306         mutable LPARAM m_customData;
 307         mutable bool m_bIsSpecialDirectoryKnown;
 308         mutable bool m_bIsSpecialDirectory;
 309
 310         friend bool operator<(const CTGitPath& left, const CTGitPath& right);
 311 };
 312 /**
 313  * Compares two paths and return true if left is earlier in sort order than right
 314  * (Uses CTGitPath::Compare logic, but is suitable for std::sort and similar)
 315  */
 316  bool operator<(const CTGitPath& left, const CTGitPath& right);
 317
 318
 319 //////////////////////////////////////////////////////////////////////////
 320
 321 /**
 322  * \ingroup Utils
 323  * This class represents a list of paths
 324  */
 325 class CTGitPathList
 326 {
 327 public:
 328         CTGitPathList();
 329         // A constructor which allows a path list to be easily built with one initial entry in
 330         explicit CTGitPathList(const CTGitPath& firstEntry);
 331         int m_Action;
 332
 333 public:
 334         void AddPath(const CTGitPath& newPath);
 335         bool LoadFromFile(const CTGitPath& filename);
 336         bool WriteToFile(const CString& sFilename, bool bANSI = false) const;
 337         CTGitPath * LookForGitPath(CString path);
 338         int     ParserFromLog(BYTE_VECTOR &log);
 339         int ParserFromLsFile(BYTE_VECTOR &out,bool staged=true);
 340         int FillUnRev(int Action,CTGitPathList *list=NULL);
 341         int GetAction();
 342         /**
 343          * Load from the path argument string, when the 'path' parameter is used
 344          * This is a list of paths, with '*' between them
 345          */
 346         void LoadFromAsteriskSeparatedString(const CString& sPathString);
 347         CString CreateAsteriskSeparatedString() const;
 348
 349         int GetCount() const;
 350         void Clear();
 351         const CTGitPath& operator[](INT_PTR index) const;
 352         bool AreAllPathsFiles() const;
 353         bool AreAllPathsFilesInOneDirectory() const;
 354         CTGitPath GetCommonDirectory() const;
 355         CTGitPath GetCommonRoot() const;
 356         void SortByPathname(bool bReverse = false);
 357         /**
 358          * Delete all the files in the list, then clear the list.
 359          * \param bTrash if true, the items are deleted using the Windows trash bin
 360          */
 361         void DeleteAllFiles(bool bTrash);
 362         /** Remove duplicate entries from the list (sorts the list as a side-effect */
 363         void RemoveDuplicates();
 364         /** Removes all paths which are on or in a Subversion admin directory */
 365         void RemoveAdminPaths();
 366         void RemovePath(const CTGitPath& path);
 367         void RemoveItem(CTGitPath &path);
 368         /**
 369          * Removes all child items and leaves only the top folders. Useful if you
 370          * create the list to remove them (i.e. if you remove a parent folder, the
 371          * child files and folders don't have to be deleted anymore)
 372          */
 373         void RemoveChildren();
 374
 375         /** Checks if two CTGitPathLists are the same */
 376         bool IsEqual(const CTGitPathList& list);
 377
 378         /** Convert into the Git API parameter format */
 379 //      apr_array_header_t * MakePathArray (apr_pool_t *pool) const;
 380
 381 private:
 382         typedef std::vector<CTGitPath> PathVector;
 383         PathVector m_paths;
 384         // If the list contains just files in one directory, then
 385         // this contains the directory name
 386         mutable CTGitPath m_commonBaseDirectory;
 387 };