blob: 18cd837fbe642366505c5bd757b10a79003d2002 [file] [log] [blame]
// Copyright 2016 The Tulsi 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
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
import Foundation
enum BazelWorkspaceInfoExtractorError: Error {
case aspectExtractorFailed(String)
/// Defines an object that can extract information from a Bazel workspace.
protocol BazelWorkspaceInfoExtractorProtocol {
/// Extracts information about the set of top level target rules from the given project.
func extractRuleInfoFromProject(_ project: TulsiProject) -> [RuleInfo]
/// Retrieves RuleEntry information for the given list of labels, returning a dictionary mapping
/// each given label to the resolved RuleEntry if it resolved correctly (invalid labels will be
/// omitted from the returned dictionary).
func ruleEntriesForLabels(_ labels: [BuildLabel],
startupOptions: TulsiOption,
buildOptions: TulsiOption,
compilationModeOption: TulsiOption,
platformConfigOption: TulsiOption,
prioritizeSwiftOption: TulsiOption,
useArm64_32Option: TulsiOption,
features: Set<BazelSettingFeature>) throws -> RuleEntryMap
/// Extracts labels for the files referenced by the build infrastructure for the given set of
/// BUILD targets.
func extractBuildfiles<T: Collection>(_ forTargets: T) -> Set<BuildLabel> where T.Iterator.Element == BuildLabel
/// Print out detailed [Info] messaging normally hidden from the info extraction process.
func logQueuedInfoMessages()
/// Report if we have any [Info] messaging hidden from the info extraction process.
func hasQueuedInfoMessages() -> Bool
/// URL to the Bazel binary used by this extractor.
var bazelURL: URL {get set}
/// Workspace-relative path to the directory in which Bazel will install generated artifacts.
var bazelBinPath: String {get}
/// Absolute path to the Bazel execution root.
var bazelExecutionRoot: String {get}
/// The location of the Bazel workspace to be examined.
var workspaceRootURL: URL {get}
/// Bazel flag provider for all invocations.
var bazelSettingsProvider: BazelSettingsProviderProtocol {get}