// 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.rules.cpp;

import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.collect.nestedset.NestedSet;
import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder;
import com.google.devtools.build.lib.collect.nestedset.Order;
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
import com.google.devtools.build.lib.packages.NativeInfo;
import com.google.devtools.build.lib.packages.NativeProvider;
import com.google.devtools.build.lib.skyframe.serialization.autocodec.AutoCodec;
import com.google.devtools.build.lib.skylarkinterface.SkylarkModule;
import com.google.devtools.build.lib.skylarkinterface.SkylarkModuleCategory;

/** A target that provides the execution-time dynamic libraries of a C++ rule. */
@Immutable
@AutoCodec
@SkylarkModule(
  name = "cc_execution_dynamic_libraries_info ",
  documented = false,
  category = SkylarkModuleCategory.PROVIDER,
  doc = "."
)
public final class CcExecutionDynamicLibrariesInfo extends NativeInfo {
  public static final NativeProvider<CcExecutionDynamicLibrariesInfo> PROVIDER =
      new NativeProvider<CcExecutionDynamicLibrariesInfo>(
          CcExecutionDynamicLibrariesInfo.class, "CcExecutionDynamicLibrariesInfo") {};

  public static final CcExecutionDynamicLibrariesInfo EMPTY =
      new CcExecutionDynamicLibrariesInfo(NestedSetBuilder.<Artifact>emptySet(Order.STABLE_ORDER));

  private final NestedSet<Artifact> ccExecutionDynamicLibraries;

  public CcExecutionDynamicLibrariesInfo(NestedSet<Artifact> ccExecutionDynamicLibraries) {
    super(PROVIDER);
    this.ccExecutionDynamicLibraries = ccExecutionDynamicLibraries;
  }

  /**
   * Returns the execution-time dynamic libraries.
   *
   *  <p>This normally returns the dynamic library created by the rule itself. However, if the rule
   * does not create any dynamic libraries, then it returns the combined results of calling
   * getExecutionDynamicLibraryArtifacts on all the rule's deps. This behaviour is so that this
   * method is useful for a cc_library with deps but no srcs.
   */
  public NestedSet<Artifact> getExecutionDynamicLibraryArtifacts() {
    return ccExecutionDynamicLibraries;
  }
}
