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
|
/*
* Copyright (C) 2015 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef AAPT_IO_FILE_H
#define AAPT_IO_FILE_H
#include "Source.h"
#include "io/Data.h"
#include <memory>
#include <vector>
namespace aapt {
namespace io {
/**
* Interface for a file, which could be a real file on the file system, or a file inside
* a ZIP archive.
*/
class IFile {
public:
virtual ~IFile() = default;
/**
* Open the file and return it as a block of contiguous memory. How this occurs is
* implementation dependent. For example, if this is a file on the file system, it may
* simply mmap the contents. If this file represents a compressed file in a ZIP archive,
* it may need to inflate it to memory, incurring a copy.
*
* Returns nullptr on failure.
*/
virtual std::unique_ptr<IData> openAsData() = 0;
/**
* Returns the source of this file. This is for presentation to the user and may not be a
* valid file system path (for example, it may contain a '@' sign to separate the files within
* a ZIP archive from the path to the containing ZIP archive.
*/
virtual const Source& getSource() const = 0;
};
class IFileCollectionIterator {
public:
virtual ~IFileCollectionIterator() = default;
virtual bool hasNext() = 0;
virtual IFile* next() = 0;
};
/**
* Interface for a collection of files, all of which share a common source. That source may
* simply be the filesystem, or a ZIP archive.
*/
class IFileCollection {
public:
virtual ~IFileCollection() = default;
virtual IFile* findFile(const StringPiece& path) = 0;
virtual std::unique_ptr<IFileCollectionIterator> iterator() = 0;
};
} // namespace io
} // namespace aapt
#endif /* AAPT_IO_FILE_H */
|
