OSDN Git Service

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