FolderHunk.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/* FolderHunk.h - Class that represents a block of files and folders
* resulting from a folder comparison. Unlike the "Hunk" object, this object
* contains everything in the comparison, not just differences.
*/
#ifndef _FOLDERHUNK_H_
#define _FOLDERHUNK_H_
#include "Hunk.h"
#include "Diff.h"
namespace MojoMerge
{
class FolderHunk
{
public:
/* FolderHunk
* Constructs a FolderHunk object.
* Params
* Prev
* Pointer to the previous hunk in the list. This value may
* be NULL if the new FolderHunk is the first in the list.
* Path
* Path of file or folder being represented. If this is a
* folder, it must contain a trailing path separator.
* IsFolder
* This value should be true if the specified path represents
* a folder.
* FileHunk
* This represents a file hunk of differences encountered in
* the file between each folder being compared. This value
* may be NULL if no file diffs were encountered, or if a
* file diff was not performed.
* FirstChild
* If IsFolder is true, this value can be a pointer to the
* first file or folder contained inside the current folder.
* ExistsFolderX
* Set to true if the Path exists in the respective folder
* represented by X. ExistsFolder3 is optional if performing
* a two-way folder comparison.
* Returns
* none
*/
FolderHunk(FolderHunk *Prev, const char *Path, bool IsFolder,
Hunk *FileHunk, FolderHunk *FirstChild, bool ExistsFolder1,
bool ExistsFolder2, bool ExistsFolder3 = false);
/* GetExists
* Returns true if the path specified in the constructor exists
* in the specified folder
* Params
* FolderNumber
* Folder to determine if the path exists in
* Returns
* True if path exists, false if it does not.
*/
bool GetExists(DiffFileNumber FolderNumber);
/* GetFirstChild
* Returns the first hunk contained inside this folder.
* Params
* none
* Returns
* See description. May return NULL if folder is empty, or if
* the GetIsFolder method returns false.
*/
FolderHunk *GetFirstChild();
/* GetPrevious
* Returns the hunk located just before this one.
* Params
* none
* Returns
* See description. May return NULL if this is the first item.
*/
FolderHunk *GetPrevious();
/* GetNext
* Returns the hunk located just after this one.
* Params
* none
* Returns
* See description. May return NULL if this is the last item.
*/
FolderHunk *GetNext();
/* GetPath
* Returns the value of path
* Params
* none
* Returns
* See description
*/
const char *GetPath();
/* GetIsFolder
* Returns true if hunk represents a folder
* Params
* none
* Returns
* See description
*/
bool GetIsFolder();
private:
// Path represented by this hunk
const char *Path;
// True if this hunk represents a folder
bool IsFolder;
// Value that indicates if the path exists in the specified folder
bool Exists[MAX_DIFF_FILES];
// Hunks that represent internal file differences. Can be NULL if no
// diffs were encountered, or file comparison was not done.
Hunk *FileHunk;
// Hunk that is contained inside this hunk. This is only valid if
// the IsFolder value is true.
FolderHunk *FirstChild;
// Previous folder or file in the list
FolderHunk *Prev;
// Next folder or file in the list
FolderHunk *Next;
};
}
#endif