OSDN Git Service

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