// Copyright 2016 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.skylarkinterface;

/** A category of a Java type exposed to Starlark */
public enum StarlarkDocumentationCategory {
  CONFIGURATION_FRAGMENT("Configuration Fragments",
      "Configuration fragments give rules access to "
      + "language-specific parts of <a href=\"configuration.html\">"
      + "configuration</a>. "
      + "<p>Rule implementations can get them using "
      + "<code><a href=\"ctx.html#fragments\">ctx."
      + "fragments</a>.<i>[fragment name]</i></code>"),

  PROVIDER("Providers",
      "This section lists providers available on built-in rules. See the "
      + "<a href='../rules.$DOC_EXT#providers'>Rules page</a> for more on providers."
  ),

  BUILTIN("Built-in Types", "This section lists types of Starlark objects."),

  // Used for top-level modules of functions in the global namespace. Such modules will always
  // be usable solely by accessing their members, via modulename.funcname() or
  // modulename.constantname.
  // Examples: attr, cc_common, config, java_common
  TOP_LEVEL_TYPE,

  // Legacy uncategorized type; these are treated like TOP_LEVEL_TYPE in documentation.
  NONE;

  private final String title;
  private final String description;


  StarlarkDocumentationCategory(String title, String description) {
    this.title = title;
    this.description = description;
  }

  StarlarkDocumentationCategory() {
    this.title = null;
    this.description = null;
  }

  public String getTemplateIdentifier() {
    return name().toLowerCase().replace("_", "-");
  }

  public String getTitle() {
    return title;
  }

  public String getDescription() {
    return description;
  }
}