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 20#include <memory> 21#include <string> 22#include <vector> 23 24#include "android-base/macros.h" 25#include "androidfw/StringPiece.h" 26#include "utils/FileMap.h" 27 28#include "Diagnostics.h" 29#include "Maybe.h" 30#include "Source.h" 31 32namespace aapt { 33namespace file { 34 35#ifdef _WIN32 36constexpr const char sDirSep = '\\'; 37#else 38constexpr const char sDirSep = '/'; 39#endif 40 41enum class FileType { 42 kUnknown = 0, 43 kNonexistant, 44 kRegular, 45 kDirectory, 46 kCharDev, 47 kBlockDev, 48 kFifo, 49 kSymlink, 50 kSocket, 51}; 52 53FileType GetFileType(const android::StringPiece& path); 54 55/* 56 * Appends a path to `base`, separated by the directory separator. 57 */ 58void AppendPath(std::string* base, android::StringPiece part); 59 60/* 61 * Makes all the directories in `path`. The last element in the path 62 * is interpreted as a directory. 63 */ 64bool mkdirs(const android::StringPiece& path); 65 66/** 67 * Returns all but the last part of the path. 68 */ 69android::StringPiece GetStem(const android::StringPiece& path); 70 71/** 72 * Returns the last part of the path with extension. 73 */ 74android::StringPiece GetFilename(const android::StringPiece& path); 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 */ 80android::StringPiece GetExtension(const android::StringPiece& path); 81 82/** 83 * Converts a package name (com.android.app) to a path: com/android/app 84 */ 85std::string PackageToPath(const android::StringPiece& package); 86 87/** 88 * Creates a FileMap for the file at path. 89 */ 90Maybe<android::FileMap> MmapPath(const android::StringPiece& path, std::string* out_error); 91 92/** 93 * Reads the file at path and appends each line to the outArgList vector. 94 */ 95bool AppendArgsFromFile(const android::StringPiece& path, std::vector<std::string>* out_arglist, 96 std::string* out_error); 97 98/* 99 * Filter that determines which resource files/directories are 100 * processed by AAPT. Takes a pattern string supplied by the user. 101 * Pattern format is specified in the FileFilter::SetPattern() method. 102 */ 103class FileFilter { 104 public: 105 explicit FileFilter(IDiagnostics* diag) : diag_(diag) {} 106 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 */ 121 bool SetPattern(const android::StringPiece& pattern); 122 123 /** 124 * Applies the filter, returning true for pass, false for fail. 125 */ 126 bool operator()(const std::string& filename, FileType type) const; 127 128 private: 129 DISALLOW_COPY_AND_ASSIGN(FileFilter); 130 131 IDiagnostics* diag_; 132 std::vector<std::string> pattern_tokens_; 133}; 134 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. 137Maybe<std::vector<std::string>> FindFiles(const android::StringPiece& path, IDiagnostics* diag, 138 const FileFilter* filter = nullptr); 139 140} // namespace file 141} // namespace aapt 142 143#endif // AAPT_FILES_H 144