blob: 82d064bf171e470ad2349ae6c647cce608f2edb5 [file] [log] [blame]
// 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.skylarkbuildapi.cpp;
import com.google.devtools.build.lib.events.Location;
import com.google.devtools.build.lib.skylarkbuildapi.FileApi;
import com.google.devtools.build.lib.skylarkinterface.Param;
import com.google.devtools.build.lib.skylarkinterface.SkylarkCallable;
import com.google.devtools.build.lib.skylarkinterface.SkylarkModule;
import com.google.devtools.build.lib.skylarkinterface.SkylarkModuleCategory;
import com.google.devtools.build.lib.syntax.Environment;
import com.google.devtools.build.lib.syntax.EvalException;
import com.google.devtools.build.lib.syntax.SkylarkList;
/** Interface for a structured representation of the compilation outputs of a C++ rule. */
@SkylarkModule(
name = "cc_compilation_outputs",
category = SkylarkModuleCategory.BUILTIN,
documented = false,
doc = "Helper class containing CC compilation outputs.")
public interface CcCompilationOutputsApi<FileT extends FileApi> {
/** @deprecated use {@link #getSkylarkObjects} or {@link #getSkylarkPicObjects}. */
@SkylarkCallable(
name = "object_files",
documented = false,
useEnvironment = true,
useLocation = true,
parameters = {
@Param(name = "use_pic", doc = "use_pic", positional = false, named = true),
})
@Deprecated
SkylarkList<FileT> getSkylarkObjectFiles(
boolean usePic, Location location, Environment environment) throws EvalException;
@SkylarkCallable(
name = "objects",
documented = false,
useEnvironment = true,
useLocation = true,
structField = true)
SkylarkList<FileT> getSkylarkObjects(Location location, Environment environment)
throws EvalException;
@SkylarkCallable(
name = "pic_objects",
documented = false,
useEnvironment = true,
useLocation = true,
structField = true)
SkylarkList<FileT> getSkylarkPicObjects(Location location, Environment environment)
throws EvalException;
}