// 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.apple;

import com.google.devtools.build.lib.skylarkbuildapi.StructApi;
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 javax.annotation.Nullable;

/**
 * A provider containing information about a version of Xcode and its properties.
 */
@SkylarkModule(
    name = "XcodeProperties",
    category = SkylarkModuleCategory.PROVIDER,
    doc = "A provider containing information about a version of Xcode and its properties."
)
public interface XcodePropertiesApi extends StructApi {

  @SkylarkCallable(
      name = "xcode_version",
      doc = "The xcode version, or <code>None</code> if the xcode version is unknown.",
      structField = true,
      allowReturnNones = true
  )
  @Nullable
  public String getXcodeVersionString();

  @SkylarkCallable(
      name = "default_ios_sdk_version",
      doc = "The default iOS sdk version for this version of xcode, or <code>None</code> if "
          + "unknown.",
      structField = true,
      allowReturnNones = true
  )
  @Nullable
  public String getDefaultIosSdkVersionString();

  @SkylarkCallable(
      name = "default_watchos_sdk_version",
      doc = "The default watchOS sdk version for this version of xcode, or <code>None</code> if "
          + "unknown.",
      structField = true,
      allowReturnNones = true
  )
  @Nullable
  public String getDefaultWatchosSdkVersionString();

  @SkylarkCallable(
      name = "default_tvos_sdk_version",
      doc = "The default tvOS sdk version for this version of xcode, or <code>None</code> if "
          + "unknown.",
      structField = true,
      allowReturnNones = true
  )
  @Nullable
  public String getDefaultTvosSdkVersionString();

  @SkylarkCallable(
      name = "default_macos_sdk_version",
      doc = "The default macOS sdk version for this version of xcode, or <code>None</code> if "
          + "unknown.",
      structField = true,
      allowReturnNones = true
  )
  @Nullable
  public String getDefaultMacosSdkVersionString();
}