package io.github.chrimle.classforge;

import java.util.Set;

/**
 * The single-entrypoint for generating Java <i>classes</i> via {@code
 * io.github.chrimle:class-forge}.
 *
 * <p><strong>Instructions</strong>
 *
 * <ul>
 *   <li>Ensure <strong>NO</strong> reserved keywords are used when generating classes.
 *   <li>Generate <em>classes</em> via:
 *       <ul>
 *         <li>{@link #newClassBuilder()} - to generate Java {@code class}es.
 *         <li>{@link #newEnumBuilder()} - to generate Java {@code enum} classes.
 *       </ul>
 * </ul>
 *
 * @since 0.1.0
 * @author Chrimle
 * @see #RESERVED_KEYWORDS
 * @see #newClassBuilder() Generating a Java class.
 * @see #newEnumBuilder() Generating an Enum class.
 */
public final class ClassForge {

  /**
   * Creates a new {@link Builder} instance for generating Java <i>classes</i>.
   *
   * @since 0.1.0
   * @return a new {@link Builder} instance.
   */
  Builder<?> newClassBuilder() {
    return ClassBuilder.newClass();
  }

  /**
   * Creates a new {@link Builder} instance for generating Java {@code enum} classes.
   *
   * @return a new {@link Builder} instance.
   * @since 0.1.0
   */
  Builder<?> newEnumBuilder() {
    return EnumBuilder.newClass();
  }

  /**
   * The <i>RegularExpression (RegEx)</i> for determining validity of <i>class</i>-names.
   *
   * <p><strong>Example</strong>
   *
   * <pre>{@code
   * public class Example { } // Valid
   * }</pre>
   *
   * @since 0.1.0
   */
  public static final String VALID_CLASS_NAME_REGEX = "^[A-Z][A-Za-z_0-9]*$";

  /**
   * The <i>RegularExpression (RegEx)</i> for determining validity of <i>package</i>-names.
   *
   * <p><strong>Example</strong>
   *
   * <pre>{@code
   * package example.sub_module; // Valid
   * }</pre>
   *
   * @since 0.1.0
   */
  public static final String VALID_PACKAGE_NAME_REGEX = "^[A-Za-z_0-9]+(\\.[A-Za-z_0-9]+)*$";

  /**
   * Keywords reserved by the Java Language. These words <b>MUST NOT</b> be used.
   *
   * @since 0.1.0
   */
  public static final Set<String> RESERVED_KEYWORDS =
      Set.of(
          "abstract",
          "boolean",
          "break",
          "byte",
          "case",
          "catch",
          "char",
          "class",
          "continue",
          "default",
          "do",
          "double",
          "else",
          "enum",
          "extends",
          "false",
          "final",
          "finally",
          "float",
          "for",
          "if",
          "implements",
          "import",
          "instanceof",
          "int",
          "interface",
          "long",
          "native",
          "new",
          "null",
          "package",
          "private",
          "protected",
          "public",
          "record",
          "return",
          "sealed",
          "static",
          "super",
          "switch",
          "synchronized",
          "this",
          "throw",
          "throws",
          "transient",
          "true",
          "try",
          "var",
          "void",
          "volatile",
          "while",
          "assert");
}