This object stores the details of the traversal request, e.g. whether it's a direct or nested * traversal (see {@link #getDirectTraversal()} and {@link #getNestedTraversal()}) or who the owner * of the traversal is. */ public interface FilesetTraversalParams { /** Desired behavior if the traversal hits a directory with a BUILD file, i.e. a subpackage. */ public enum PackageBoundaryMode { /** The traversal should recurse into the directory, optionally reporting a warning. */ CROSS, // TODO(bazel-team): deprecate CROSS and REPORT_ERROR in favor of DONT_CROSS. Clean up the depot // and lock down the semantics of FilesetEntry.srcdir to only accept other Filesets or BUILD // files of a package, in which case also require an explicit list of files. /** The traversal should not recurse into the directory but silently skip it. */ DONT_CROSS, /** The traversal should not recurse into the directory and report an error. */ REPORT_ERROR; public static PackageBoundaryMode forStrictFilesetFlag(boolean flagEnabled) { return flagEnabled ? REPORT_ERROR : CROSS; } public void fingerprint(Fingerprint fp) { fp.addInt(ordinal()); } } /** * Abstraction of the root directory of a {@link DirectTraversal}. * *
For the meaning of "recursive" and "file" traversals see {@link DirectTraversal}. */ interface DirectTraversalRoot { /** * Returns the root part of the full path. * *
This is typically the workspace root or some output tree's root (e.g. genfiles, binfiles). */ Path getRootPart(); /** * Returns the {@link #getRootPart() root}-relative part of the path. * *
This is typically the source directory under the workspace or the output file under an * output directory. */ PathFragment getRelativePart(); /** Returns a {@link RootedPath} composed of the root and relative parts. */ RootedPath asRootedPath(); } /** * Describes a request for a direct filesystem traversal. * *
"Direct" means this corresponds to an actual filesystem traversal as opposed to traversing * another Fileset rule, which is called a "nested" traversal. * *
Direct traversals can further be divided into two categories, "file" traversals and * "recursive" traversals. * *
File traversal requests are created when the FilesetEntry.files attribute is defined; one * file traversal request is created for each entry. * *
Recursive traversal requests are created when the FilesetEntry.files attribute is * unspecified; one recursive traversal request is created for the FilesetEntry.srcdir. * *
See {@link DirectTraversal#getRoot()} for more details. */ interface DirectTraversal { /** Returns the root of the traversal; see {@link DirectTraversalRoot}. */ DirectTraversalRoot getRoot(); /** * Returns true if this traversal refers to a whole package. * *
In that case the root (see {@link #getRoot()}) refers to the path of the package. * *
Package traversals are always recursive (see {@link #isRecursive()}) and are never * generated (see {@link #isGenerated()}). */ boolean isPackage(); /** * Returns true if this is a "recursive traversal", i.e. created from FilesetEntry.srcdir. * *
This type of traversal is created when the FilesetEntry doesn't define a "files" list. * When it does, the traversal is referred to as a "file traversal". When it doesn't, but the * srcdir points to another Fileset, it is called a "nested" traversal. * *
Recursive traversals got their name from recursively traversing a directory structure. * These are usually whole-package traversals, i.e. when FilesetEntry.srcdir refers to a BUILD * file (see {@link #isPackage()}), but sometimes the srcdir references a input or output * directory (the latter being generated by a local genrule) or a symlink (which must point to a * directory; enforced during action execution). * *
The files in the results of a recursive traversal are all under the {@link #getRoot() * root}. The root's path is stripped from the results. * *
N.B.: "file traversals" can also be recursive if the entry in FilesetEntry.files, for
* which the traversal parameters were created, turned out to be a directory. The difference
* lies in how the output paths are computed (with recursive traversals, the directory's name
* is stripped; with file traversals it is not, modulo usage of strip_prefix and the excludes
* attributes), and how directory symlinks are handled (in "recursive traversals" they are
* expanded just like normal directories, subsequent directory symlinks under them are *not*
* expanded though; they are not expanded at all in "file traversals").
*/
boolean isRecursive();
/** Returns true if the root points to a generated file, symlink or directory. */
boolean isGenerated();
/** Returns true if input symlinks should be dereferenced; false if copied. */
boolean isFollowingSymlinks();
/** Returns the desired behavior when the traversal hits a subpackage. */
PackageBoundaryMode getPackageBoundaryMode();
}
/** Label of the Fileset rule that owns this traversal. */
Label getOwnerLabelForErrorMessages();
/** Returns the directory under the output path where the files will be mapped. May be empty. */
PathFragment getDestPath();
/** Returns a list of file basenames to be excluded from the output. May be empty. */
Set A direct traversal is anything that's not a nested traversal, e.g. traversal of a package or
* directory (when FilesetEntry.srcdir is specified) or traversal of a single file (when
* FilesetEntry.files is specified). See {@link DirectTraversal} for more detail.
*
* The value is present if and only if {@link #getNestedTraversal} is absent.
*/
Optional A nested traversal is the traversal of another Fileset referenced by FilesetEntry.srcdir.
*
* The value is present if and only if {@link #getDirectTraversal} is absent.
*/
Optional