Files.h revision ce5e56e243d262a9b65459c3bd0bb9eaadd40628 
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 "utils/FileMap.h"
26
27#include "Diagnostics.h"
28#include "Maybe.h"
29#include "Source.h"
30#include "util/StringPiece.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 StringPiece& path);
54
55/*
56 * Appends a path to `base`, separated by the directory separator.
57 */
58void AppendPath(std::string* base, 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 StringPiece& path);
65
66/**
67 * Returns all but the last part of the path.
68 */
69StringPiece GetStem(const StringPiece& path);
70
71/**
72 * Returns the last part of the path with extension.
73 */
74StringPiece GetFilename(const 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 */
80StringPiece GetExtension(const StringPiece& path);
81
82/**
83 * Converts a package name (com.android.app) to a path: com/android/app
84 */
85std::string PackageToPath(const StringPiece& package);
86
87/**
88 * Creates a FileMap for the file at path.
89 */
90Maybe<android::FileMap> MmapPath(const StringPiece& path,
91                                 std::string* out_error);
92
93/**
94 * Reads the file at path and appends each line to the outArgList vector.
95 */
96bool AppendArgsFromFile(const StringPiece& path,
97                        std::vector<std::string>* out_arglist,
98                        std::string* out_error);
99
100/*
101 * Filter that determines which resource files/directories are
102 * processed by AAPT. Takes a pattern string supplied by the user.
103 * Pattern format is specified in the FileFilter::SetPattern() method.
104 */
105class FileFilter {
106 public:
107  explicit FileFilter(IDiagnostics* diag) : diag_(diag) {}
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
130 private:
131  DISALLOW_COPY_AND_ASSIGN(FileFilter);
132
133  IDiagnostics* diag_;
134  std::vector<std::string> pattern_tokens_;
135};
136
137}  // namespace file
138}  // namespace aapt
139
140#endif  // AAPT_FILES_H
141