// Copyright 2018 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.query2; import com.google.common.collect.ImmutableList; import com.google.devtools.build.lib.query2.engine.QueryEnvironment.Setting; import com.google.devtools.build.lib.query2.output.AspectResolver; import com.google.devtools.build.lib.query2.output.AspectResolver.Mode; import com.google.devtools.common.options.Converters; import com.google.devtools.common.options.Converters.CommaSeparatedOptionListConverter; import com.google.devtools.common.options.EnumConverter; import com.google.devtools.common.options.Option; import com.google.devtools.common.options.OptionDocumentationCategory; import com.google.devtools.common.options.OptionEffectTag; import com.google.devtools.common.options.OptionsBase; import java.util.EnumSet; import java.util.List; import java.util.Set; /** Options shared between blaze query and blaze cquery. */ public class CommonQueryOptions extends OptionsBase { @Option( name = "universe_scope", defaultValue = "", documentationCategory = OptionDocumentationCategory.QUERY, converter = Converters.CommaSeparatedOptionListConverter.class, effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS}, help = "A comma-separated set of target patterns (additive and subtractive). The query may " + "be performed in the universe defined by the transitive closure of the specified " + "targets. This option is used for the query and cquery commands. \n" + "For cquery, the input to this option is the targets all answers are built under and " + "so this option may affect configurations and transitions. If this option is not " + "specified, the top-level targets are assumed to be the targets parsed from the " + "query expression. Note: For cquery, not specifying this option may cause the build " + "to break if targets parsed from the query expression are not buildable with " + "top-level options." ) public List universeScope; @Option( name = "host_deps", defaultValue = "true", documentationCategory = OptionDocumentationCategory.QUERY, effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, help = "Query: If disabled, dependencies on 'host configuration' targets will not be included in " + "the dependency graph over which the query operates. A 'host configuration' " + "dependency edge, such as the one from any 'proto_library' rule to the Protocol " + "Compiler, usually points to a tool executed during the build (on the host machine) " + "rather than a part of the same 'target' program. \n" + "Cquery: If disabled, filters out all configured targets which cross a host " + "transition from the top-level target that discovered this configured target. That " + "means if the top-level target is in the target configuration, only configured " + "targets also in the target configuration will be returned. If the top-level target " + "is in the host configuration, only host configured targets will be returned." ) public boolean includeHostDeps; @Option( name = "implicit_deps", defaultValue = "true", documentationCategory = OptionDocumentationCategory.QUERY, effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, help = "If enabled, implicit dependencies will be included in the dependency graph over " + "which the query operates. An implicit dependency is one that is not explicitly " + "specified in the BUILD file but added by bazel.") public boolean includeImplicitDeps; /** Return the current options as a set of QueryEnvironment settings. */ public Set toSettings() { Set settings = EnumSet.noneOf(Setting.class); if (!includeHostDeps) { settings.add(Setting.NO_HOST_DEPS); } if (!includeImplicitDeps) { settings.add(Setting.NO_IMPLICIT_DEPS); } return settings; } /////////////////////////////////////////////////////////// // PROTO OUTPUT FORMATTER OPTIONS // /////////////////////////////////////////////////////////// @Option( name = "relative_locations", defaultValue = "false", documentationCategory = OptionDocumentationCategory.QUERY, effectTags = {OptionEffectTag.TERMINAL_OUTPUT}, help = "If true, the location of BUILD files in xml and proto outputs will be relative. " + "By default, the location output is an absolute path and will not be consistent " + "across machines. You can set this option to true to have a consistent result " + "across machines." ) public boolean relativeLocations; @Option( name = "proto:default_values", defaultValue = "true", documentationCategory = OptionDocumentationCategory.QUERY, effectTags = {OptionEffectTag.TERMINAL_OUTPUT}, help = "If true, attributes whose value is not explicitly specified in the BUILD file are " + "included; otherwise they are omitted. This option is applicable to --output=proto" ) public boolean protoIncludeDefaultValues; @Option( name = "proto:flatten_selects", defaultValue = "true", documentationCategory = OptionDocumentationCategory.QUERY, effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, help = "If enabled, configurable attributes created by select() are flattened. For list types " + "the flattened representation is a list containing each value of the select map " + "exactly once. Scalar types are flattened to null." ) public boolean protoFlattenSelects; @Option( name = "proto:output_rule_attrs", converter = CommaSeparatedOptionListConverter.class, defaultValue = "all", documentationCategory = OptionDocumentationCategory.QUERY, effectTags = {OptionEffectTag.TERMINAL_OUTPUT}, help = "Comma separated list of attributes to include in output. Defaults to all attributes. " + "Set to empty string to not output any attribute. " + "This option is applicable to --output=proto." ) public List protoOutputRuleAttributes = ImmutableList.of("all"); /** An enum converter for {@code AspectResolver.Mode} . Should be used internally only. */ public static class AspectResolutionModeConverter extends EnumConverter { public AspectResolutionModeConverter() { super(AspectResolver.Mode.class, "Aspect resolution mode"); } } @Option( name = "aspect_deps", converter = AspectResolutionModeConverter.class, defaultValue = "conservative", documentationCategory = OptionDocumentationCategory.QUERY, effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, help = "How to resolve aspect dependencies when the output format is one of {xml,proto,record}. " + "'off' means no aspect dependencies are resolved, 'conservative' (the default) " + "means all declared aspect dependencies are added regardless of whether they are " + "given the rule class of direct dependencies, 'precise' means that only those " + "aspects are added that are possibly active given the rule class of the direct " + "dependencies. Note that precise mode requires loading other packages to evaluate " + "a single target thus making it slower than the other modes. Also note that even " + "precise mode is not completely precise: the decision whether to compute an aspect " + "is decided in the analysis phase, which is not run during 'bazel query'.") public AspectResolver.Mode aspectDeps; }