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
125
126
127
128
129
130
131
132
133
134
135
|
#pragma once
// system
#include <memory>
#include <iterator>
// local
#include <appimage/core/PayloadEntryType.h>
namespace appimage {
namespace core {
// Forward declaration required because this file is included in AppImage.h
class AppImage;
/**
* A FilesIterator object provides a READONLY, SINGLE WAY, ONE PASS iterator over the files contained
* in the AppImage pointed by <path>. Abstracts the users from the AppImage file payload format.
*
* READONLY: files inside the AppImage cannot be modified.
* SINGLE WAY: can't go backwards only forward.
* ONE PASS: A new instance is required to re-traverse the AppImage or re-read an entry.
*/
class PayloadIterator : public std::iterator<std::input_iterator_tag, std::string> {
public:
/**
* Create a FilesIterator for <appImage>
* @param appImage
* @throw AppImageReadError in case of error
*/
explicit PayloadIterator(const AppImage& appImage);
// Creating copies of this object is not allowed
PayloadIterator(PayloadIterator& other) = delete;
// Creating copies of this object is not allowed
PayloadIterator& operator=(PayloadIterator& other) = delete;
// Move constructor
PayloadIterator(PayloadIterator&& other) noexcept;
// Move assignment operator
PayloadIterator& operator=(PayloadIterator&& other) noexcept;
/**
* @return the type of the current file.
*/
PayloadEntryType type();
/**
* @return file path pointed by the iterator
*/
std::string path();
/**
* @return file link path if it's a LINK type file. Otherwise returns an empty string.
*/
std::string linkTarget();
/**
* Extracts the file to the <target> path. Supports raw files, symlinks and directories.
* Parent target dir is created if not exists.
*
* IMPORTANT:
* - Due to implementation restrictions you can call read() or extractTo() in a given entry
* only once. Additional call will throw a PayloadIteratorError.
*
* @throw AppImageError if called on a PayloadEntry of UNKNOWN Type
* @param target
*/
void extractTo(const std::string& target);
/**
* Read file content. Symbolic links will be resolved.
*
* IMPORTANT:
* - The returned istream becomes invalid after next is called, don't try to "reuse" it.
* - Due to implementation restrictions you can call read() or extractTo() a given entry
* only once. Additional call will throw a PayloadIteratorError.
*
* @throw AppImageError if called on a PayloadEntry of UNKNOWN Type
* @return file content stream
*/
std::istream& read();
/**
* Compare this iterator to <other>.
* @param other
* @return true of both are equal, false otherwise
*/
bool operator==(const PayloadIterator& other) const;
/**
* Compare this iterator to <other>.
* @param other
* @return true if are different, false otherwise
*/
bool operator!=(const PayloadIterator& other) const;
/**
* @return file path pointed by the iterator
*/
std::string operator*();
/**
* Move iterator to the next file.
* @return current file_iterator
*/
PayloadIterator& operator++();
/**
* Represents the begin of the iterator. Will always point to the current iterator.
* @return current file_iterator
*/
PayloadIterator begin();
/**
* Represent the end of the iterator. Will always point to an invalid iterator.
* @return invalid file_iterator
*/
PayloadIterator end();
private:
class Private;
std::shared_ptr<Private> d;
/**
* Constructor used to create special representations of an iterator like the end state.
* @param private data of the iterator
*/
explicit PayloadIterator(Private* d);
};
}
}
|
