aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/syntax/FilesetEntry.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/com/google/devtools/build/lib/syntax/FilesetEntry.java')
-rw-r--r--src/main/java/com/google/devtools/build/lib/syntax/FilesetEntry.java175
1 files changed, 175 insertions, 0 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/syntax/FilesetEntry.java b/src/main/java/com/google/devtools/build/lib/syntax/FilesetEntry.java
new file mode 100644
index 0000000000..4586b64f44
--- /dev/null
+++ b/src/main/java/com/google/devtools/build/lib/syntax/FilesetEntry.java
@@ -0,0 +1,175 @@
+// Copyright 2014 Google Inc. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.devtools.build.lib.syntax;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableSet;
+import com.google.devtools.build.lib.vfs.PathFragment;
+
+import java.util.Collection;
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Set;
+
+import javax.annotation.Nullable;
+
+/**
+ * FilesetEntry is a value object used to represent a "FilesetEntry" inside a "Fileset" BUILD rule.
+ */
+public final class FilesetEntry {
+ /** SymlinkBehavior decides what to do when a source file of a FilesetEntry is a symlink. */
+ public enum SymlinkBehavior {
+ /** Just copies the symlink as-is. May result in dangling links. */
+ COPY,
+ /** Follow the link and make the destination point to the absolute path of the final target. */
+ DEREFERENCE;
+
+ public static SymlinkBehavior parse(String value) throws IllegalArgumentException {
+ return valueOf(value.toUpperCase());
+ }
+
+ @Override
+ public String toString() {
+ return super.toString().toLowerCase();
+ }
+ }
+
+ private final Label srcLabel;
+ @Nullable private final ImmutableList<Label> files;
+ @Nullable private final ImmutableSet<String> excludes;
+ private final PathFragment destDir;
+ private final SymlinkBehavior symlinkBehavior;
+ private final String stripPrefix;
+
+ /**
+ * Constructs a FilesetEntry with the given values.
+ *
+ * @param srcLabel the label of the source directory. Must be non-null.
+ * @param files The explicit files to include. May be null.
+ * @param excludes The files to exclude. Man be null. May only be non-null if files is null.
+ * @param destDir The target-relative output directory.
+ * @param symlinkBehavior how to treat symlinks on the input. See
+ * {@link FilesetEntry.SymlinkBehavior}.
+ * @param stripPrefix the prefix to strip from the package-relative path. If ".", keep only the
+ * basename.
+ */
+ public FilesetEntry(Label srcLabel,
+ @Nullable List<Label> files,
+ @Nullable List<String> excludes,
+ String destDir,
+ SymlinkBehavior symlinkBehavior,
+ String stripPrefix) {
+ this.srcLabel = checkNotNull(srcLabel);
+ this.destDir = new PathFragment((destDir == null) ? "" : destDir);
+ this.files = files == null ? null : ImmutableList.copyOf(files);
+ this.excludes = (excludes == null || excludes.isEmpty()) ? null : ImmutableSet.copyOf(excludes);
+ this.symlinkBehavior = symlinkBehavior;
+ this.stripPrefix = stripPrefix;
+ }
+
+ /**
+ * @return the source label.
+ */
+ public Label getSrcLabel() {
+ return srcLabel;
+ }
+
+ /**
+ * @return the destDir. Non null.
+ */
+ public PathFragment getDestDir() {
+ return destDir;
+ }
+
+ /**
+ * @return how symlinks should be handled.
+ */
+ public SymlinkBehavior getSymlinkBehavior() {
+ return symlinkBehavior;
+ }
+
+ /**
+ * @return an immutable list of excludes. Null if none specified.
+ */
+ @Nullable
+ public ImmutableSet<String> getExcludes() {
+ return excludes;
+ }
+
+ /**
+ * @return an immutable list of file labels. Null if none specified.
+ */
+ @Nullable
+ public ImmutableList<Label> getFiles() {
+ return files;
+ }
+
+ /**
+ * @return true if this Fileset should get files from the source directory.
+ */
+ public boolean isSourceFileset() {
+ return "BUILD".equals(srcLabel.getName());
+ }
+
+ /**
+ * @return all prerequisite labels in the FilesetEntry.
+ */
+ public Collection<Label> getLabels() {
+ Set<Label> labels = new LinkedHashSet<>();
+ if (files != null) {
+ labels.addAll(files);
+ } else {
+ labels.add(srcLabel);
+ }
+ return labels;
+ }
+
+ /**
+ * @return the prefix that should be stripped from package-relative path names.
+ */
+ public String getStripPrefix() {
+ return stripPrefix;
+ }
+
+ /**
+ * @return null if the entry is valid, and a human-readable error message otherwise.
+ */
+ @Nullable
+ public String validate() {
+ if (excludes != null && files != null) {
+ return "Cannot specify both 'files' and 'excludes' in a FilesetEntry";
+ } else if (files != null && !isSourceFileset()) {
+ return "Cannot specify files with Fileset label '" + srcLabel + "'";
+ } else if (destDir.isAbsolute()) {
+ return "Cannot specify absolute destdir '" + destDir + "'";
+ } else if (!stripPrefix.equals(".") && files == null) {
+ return "If the strip prefix is not '.', files must be specified";
+ } else if (new PathFragment(stripPrefix).containsUplevelReferences()) {
+ return "Strip prefix must not contain uplevel references";
+ } else {
+ return null;
+ }
+ }
+
+ @Override
+ public String toString() {
+ return String.format("FilesetEntry(srcdir=%s, destdir=%s, strip_prefix=%s, symlinks=%s, "
+ + "%d file(s) and %d excluded)", srcLabel, destDir, stripPrefix, symlinkBehavior,
+ files != null ? files.size() : 0,
+ excludes != null ? excludes.size() : 0);
+ }
+}