Adam Lesinski | 6f6ceb7 | 2014-11-14 14:48:12 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2015 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | #ifndef AAPT_FILES_H |
| 18 | #define AAPT_FILES_H |
| 19 | |
Adam Lesinski | 1ab598f | 2015-08-14 14:26:04 -0700 | [diff] [blame] | 20 | #include <memory> |
Adam Lesinski | 6f6ceb7 | 2014-11-14 14:48:12 -0800 | [diff] [blame] | 21 | #include <string> |
| 22 | #include <vector> |
| 23 | |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 24 | #include "android-base/macros.h" |
Adam Lesinski | d5083f6 | 2017-01-16 15:07:21 -0800 | [diff] [blame] | 25 | #include "androidfw/StringPiece.h" |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 26 | #include "utils/FileMap.h" |
| 27 | |
| 28 | #include "Diagnostics.h" |
| 29 | #include "Maybe.h" |
| 30 | #include "Source.h" |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 31 | |
Adam Lesinski | 6f6ceb7 | 2014-11-14 14:48:12 -0800 | [diff] [blame] | 32 | namespace aapt { |
Adam Lesinski | 1ab598f | 2015-08-14 14:26:04 -0700 | [diff] [blame] | 33 | namespace file { |
Adam Lesinski | 6f6ceb7 | 2014-11-14 14:48:12 -0800 | [diff] [blame] | 34 | |
| 35 | #ifdef _WIN32 |
| 36 | constexpr const char sDirSep = '\\'; |
| 37 | #else |
| 38 | constexpr const char sDirSep = '/'; |
| 39 | #endif |
| 40 | |
| 41 | enum class FileType { |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 42 | kUnknown = 0, |
| 43 | kNonexistant, |
| 44 | kRegular, |
| 45 | kDirectory, |
| 46 | kCharDev, |
| 47 | kBlockDev, |
| 48 | kFifo, |
| 49 | kSymlink, |
| 50 | kSocket, |
Adam Lesinski | 6f6ceb7 | 2014-11-14 14:48:12 -0800 | [diff] [blame] | 51 | }; |
| 52 | |
Adam Lesinski | d5083f6 | 2017-01-16 15:07:21 -0800 | [diff] [blame] | 53 | FileType GetFileType(const android::StringPiece& path); |
Adam Lesinski | 6f6ceb7 | 2014-11-14 14:48:12 -0800 | [diff] [blame] | 54 | |
| 55 | /* |
| 56 | * Appends a path to `base`, separated by the directory separator. |
| 57 | */ |
Adam Lesinski | d5083f6 | 2017-01-16 15:07:21 -0800 | [diff] [blame] | 58 | void AppendPath(std::string* base, android::StringPiece part); |
Adam Lesinski | 6f6ceb7 | 2014-11-14 14:48:12 -0800 | [diff] [blame] | 59 | |
| 60 | /* |
| 61 | * Makes all the directories in `path`. The last element in the path |
| 62 | * is interpreted as a directory. |
| 63 | */ |
Adam Lesinski | d5083f6 | 2017-01-16 15:07:21 -0800 | [diff] [blame] | 64 | bool mkdirs(const android::StringPiece& path); |
Adam Lesinski | 6f6ceb7 | 2014-11-14 14:48:12 -0800 | [diff] [blame] | 65 | |
Adam Lesinski | 4d3a987 | 2015-04-09 19:53:22 -0700 | [diff] [blame] | 66 | /** |
| 67 | * Returns all but the last part of the path. |
| 68 | */ |
Adam Lesinski | d5083f6 | 2017-01-16 15:07:21 -0800 | [diff] [blame] | 69 | android::StringPiece GetStem(const android::StringPiece& path); |
Adam Lesinski | 1ab598f | 2015-08-14 14:26:04 -0700 | [diff] [blame] | 70 | |
| 71 | /** |
| 72 | * Returns the last part of the path with extension. |
| 73 | */ |
Adam Lesinski | d5083f6 | 2017-01-16 15:07:21 -0800 | [diff] [blame] | 74 | android::StringPiece GetFilename(const android::StringPiece& path); |
Adam Lesinski | 1ab598f | 2015-08-14 14:26:04 -0700 | [diff] [blame] | 75 | |
| 76 | /** |
| 77 | * Returns the extension of the path. This is the entire string after |
| 78 | * the first '.' of the last part of the path. |
| 79 | */ |
Adam Lesinski | d5083f6 | 2017-01-16 15:07:21 -0800 | [diff] [blame] | 80 | android::StringPiece GetExtension(const android::StringPiece& path); |
Adam Lesinski | 1ab598f | 2015-08-14 14:26:04 -0700 | [diff] [blame] | 81 | |
| 82 | /** |
| 83 | * Converts a package name (com.android.app) to a path: com/android/app |
| 84 | */ |
Adam Lesinski | d5083f6 | 2017-01-16 15:07:21 -0800 | [diff] [blame] | 85 | std::string PackageToPath(const android::StringPiece& package); |
Adam Lesinski | 1ab598f | 2015-08-14 14:26:04 -0700 | [diff] [blame] | 86 | |
| 87 | /** |
| 88 | * Creates a FileMap for the file at path. |
| 89 | */ |
Adam Lesinski | d5083f6 | 2017-01-16 15:07:21 -0800 | [diff] [blame] | 90 | Maybe<android::FileMap> MmapPath(const android::StringPiece& path, std::string* out_error); |
Adam Lesinski | 4d3a987 | 2015-04-09 19:53:22 -0700 | [diff] [blame] | 91 | |
Adam Lesinski | c51562c | 2016-04-28 11:12:38 -0700 | [diff] [blame] | 92 | /** |
| 93 | * Reads the file at path and appends each line to the outArgList vector. |
| 94 | */ |
Adam Lesinski | d5083f6 | 2017-01-16 15:07:21 -0800 | [diff] [blame] | 95 | bool AppendArgsFromFile(const android::StringPiece& path, std::vector<std::string>* out_arglist, |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 96 | std::string* out_error); |
Adam Lesinski | c51562c | 2016-04-28 11:12:38 -0700 | [diff] [blame] | 97 | |
Adam Lesinski | 6f6ceb7 | 2014-11-14 14:48:12 -0800 | [diff] [blame] | 98 | /* |
| 99 | * Filter that determines which resource files/directories are |
| 100 | * processed by AAPT. Takes a pattern string supplied by the user. |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 101 | * Pattern format is specified in the FileFilter::SetPattern() method. |
Adam Lesinski | 6f6ceb7 | 2014-11-14 14:48:12 -0800 | [diff] [blame] | 102 | */ |
| 103 | class FileFilter { |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 104 | public: |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 105 | explicit FileFilter(IDiagnostics* diag) : diag_(diag) {} |
Adam Lesinski | 1ab598f | 2015-08-14 14:26:04 -0700 | [diff] [blame] | 106 | |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 107 | /* |
| 108 | * Patterns syntax: |
| 109 | * - Delimiter is : |
| 110 | * - Entry can start with the flag ! to avoid printing a warning |
| 111 | * about the file being ignored. |
| 112 | * - Entry can have the flag "<dir>" to match only directories |
| 113 | * or <file> to match only files. Default is to match both. |
| 114 | * - Entry can be a simplified glob "<prefix>*" or "*<suffix>" |
| 115 | * where prefix/suffix must have at least 1 character (so that |
| 116 | * we don't match a '*' catch-all pattern.) |
| 117 | * - The special filenames "." and ".." are always ignored. |
| 118 | * - Otherwise the full string is matched. |
| 119 | * - match is not case-sensitive. |
| 120 | */ |
Adam Lesinski | d5083f6 | 2017-01-16 15:07:21 -0800 | [diff] [blame] | 121 | bool SetPattern(const android::StringPiece& pattern); |
Adam Lesinski | 6f6ceb7 | 2014-11-14 14:48:12 -0800 | [diff] [blame] | 122 | |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 123 | /** |
| 124 | * Applies the filter, returning true for pass, false for fail. |
| 125 | */ |
| 126 | bool operator()(const std::string& filename, FileType type) const; |
Adam Lesinski | 6f6ceb7 | 2014-11-14 14:48:12 -0800 | [diff] [blame] | 127 | |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 128 | private: |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 129 | DISALLOW_COPY_AND_ASSIGN(FileFilter); |
| 130 | |
| 131 | IDiagnostics* diag_; |
| 132 | std::vector<std::string> pattern_tokens_; |
Adam Lesinski | 6f6ceb7 | 2014-11-14 14:48:12 -0800 | [diff] [blame] | 133 | }; |
| 134 | |
Adam Lesinski | b39ad7c | 2017-03-13 11:40:48 -0700 | [diff] [blame] | 135 | // Returns a list of files relative to the directory identified by `path`. |
| 136 | // An optional FileFilter filters out any files that don't pass. |
| 137 | Maybe<std::vector<std::string>> FindFiles(const android::StringPiece& path, IDiagnostics* diag, |
| 138 | const FileFilter* filter = nullptr); |
| 139 | |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 140 | } // namespace file |
| 141 | } // namespace aapt |
Adam Lesinski | 6f6ceb7 | 2014-11-14 14:48:12 -0800 | [diff] [blame] | 142 | |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 143 | #endif // AAPT_FILES_H |