OSDN Git Service

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