| // Copyright 2014 The Bazel Authors. 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.analysis.config; |
| |
| import com.google.common.collect.ImmutableList; |
| import com.google.common.collect.ImmutableMap; |
| import com.google.devtools.build.lib.cmdline.Label; |
| import com.google.devtools.common.options.Options; |
| import com.google.devtools.common.options.OptionsBase; |
| import java.io.Serializable; |
| import java.util.Map; |
| import java.util.Set; |
| |
| /** |
| * Command-line build options for a Blaze module. |
| */ |
| public abstract class FragmentOptions extends OptionsBase implements Cloneable, Serializable { |
| |
| /** |
| * Returns the labels contributed to the defaults package by this fragment. |
| * |
| * <p>The set of keys returned by this function should be constant, however, the values are |
| * allowed to change depending on the value of the options. |
| */ |
| @SuppressWarnings("unused") |
| public Map<String, Set<Label>> getDefaultsLabels(BuildConfiguration.Options commonOptions) { |
| return ImmutableMap.of(); |
| } |
| |
| /** |
| * Returns the extra rules contributed to the default package by this fragment. |
| * |
| * <p>The return value should be a list of strings, which are merged into the BUILD files of the |
| * defaults package. |
| * |
| * <p><strong>WARNING;</strong> this method should only be used when absolutely necessary. Always |
| * prefer {@code getDefaultsLabels()} to this. |
| */ |
| public ImmutableList<String> getDefaultsRules() { |
| return ImmutableList.of(); |
| } |
| |
| /** |
| * Returns true if actions should be enabled for this configuration. If <b>any</b> fragment |
| * sets this to false, <i>all</i> actions are disabled for the configuration. |
| * |
| * <p>Disabling actions is unusual behavior that should only be triggered under exceptionally |
| * special circumstances. In practice this only exists to support LIPO in C++. Don't override |
| * this method for any other purpose. |
| */ |
| public boolean enableActions() { |
| return true; |
| } |
| |
| @Override |
| public FragmentOptions clone() { |
| try { |
| return (FragmentOptions) super.clone(); |
| } catch (CloneNotSupportedException e) { |
| // This can't happen. |
| throw new IllegalStateException(e); |
| } |
| } |
| |
| /** |
| * Creates a new FragmentOptions instance with all flags set to default. |
| */ |
| public FragmentOptions getDefault() { |
| return Options.getDefaults(getClass()); |
| } |
| |
| /** |
| * Creates a new FragmentOptions instance with flags adjusted to host platform. |
| */ |
| @SuppressWarnings("unused") |
| public FragmentOptions getHost() { |
| return getDefault(); |
| } |
| } |