Files.h revision 96917c25f09bb2f33e22f20cdfa4ece8f310b084
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 "Diagnostics.h" 21#include "Maybe.h" 22#include "Source.h" 23 24#include "util/StringPiece.h" 25 26#include <utils/FileMap.h> 27#include <cassert> 28#include <memory> 29#include <string> 30#include <vector> 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 StringPiece& path); 54 55/* 56 * Lists files under the directory `root`. Files are listed 57 * with just their leaf (filename) names. 58 */ 59std::vector<std::string> listFiles(const StringPiece& root); 60 61/* 62 * Appends a path to `base`, separated by the directory separator. 63 */ 64void appendPath(std::string* base, StringPiece part); 65 66/* 67 * Makes all the directories in `path`. The last element in the path 68 * is interpreted as a directory. 69 */ 70bool mkdirs(const StringPiece& path); 71 72/** 73 * Returns all but the last part of the path. 74 */ 75StringPiece getStem(const StringPiece& path); 76 77/** 78 * Returns the last part of the path with extension. 79 */ 80StringPiece getFilename(const StringPiece& path); 81 82/** 83 * Returns the extension of the path. This is the entire string after 84 * the first '.' of the last part of the path. 85 */ 86StringPiece getExtension(const StringPiece& path); 87 88/** 89 * Converts a package name (com.android.app) to a path: com/android/app 90 */ 91std::string packageToPath(const StringPiece& package); 92 93/** 94 * Creates a FileMap for the file at path. 95 */ 96Maybe<android::FileMap> mmapPath(const StringPiece& path, std::string* outError); 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 102 * FileFilter::setPattern(const std::string&) method. 103 */ 104class FileFilter { 105public: 106 FileFilter(IDiagnostics* diag) : mDiag(diag) { 107 } 108 109 /* 110 * Patterns syntax: 111 * - Delimiter is : 112 * - Entry can start with the flag ! to avoid printing a warning 113 * about the file being ignored. 114 * - Entry can have the flag "<dir>" to match only directories 115 * or <file> to match only files. Default is to match both. 116 * - Entry can be a simplified glob "<prefix>*" or "*<suffix>" 117 * where prefix/suffix must have at least 1 character (so that 118 * we don't match a '*' catch-all pattern.) 119 * - The special filenames "." and ".." are always ignored. 120 * - Otherwise the full string is matched. 121 * - match is not case-sensitive. 122 */ 123 bool setPattern(const StringPiece& pattern); 124 125 /** 126 * Applies the filter, returning true for pass, false for fail. 127 */ 128 bool operator()(const std::string& filename, FileType type) const; 129 130private: 131 IDiagnostics* mDiag; 132 std::vector<std::string> mPatternTokens; 133}; 134 135} // namespace file 136} // namespace aapt 137 138#endif // AAPT_FILES_H 139