/*
 * SPDX-FileCopyrightText: none
 * SPDX-License-Identifier: CC0-1.0
 */

package dev.metaschema.core.metapath;

import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;

/**
 * MPST: Exceptions related to the Metapath static context and static
 * evaluation.
 */
// TODO: review use of this exception
// TODO: include a reference to the Metapath expression?
// TODO: Move this to a StaticMetapathException that extends this class; align
// signatures with DynamicMetapathError
@SuppressWarnings("PMD.DataClass")
public class StaticMetapathException
    extends MetapathException {
  @NonNull
  private static final String PREFIX = "MPST";
  /**
   * <a href= "https://www.w3.org/TR/xpath-31/#ERRXPST0003">err:MPST0003</a>: It
   * is a <a href="https://www.w3.org/TR/xpath-31/#dt-static-error">static
   * error</a> if an expression is not a valid instance of the Metapath grammar.
   */
  // TODO: need a Metapath grammar link
  protected static final int INVALID_PATH_GRAMMAR = 3;

  /**
   * <a href= "https://www.w3.org/TR/xpath-31/#ERRXPST0008">err:MPST0008</a>: It
   * is a <a href="https://www.w3.org/TR/xpath-31/#dt-static-error">static
   * error</a> if an expression refers to an element name, attribute name, schema
   * type name, namespace prefix, or variable name that is not defined in the
   * <a href="https://www.w3.org/TR/xpath-31/#dt-static-context">static
   * context</a>, except for an ElementName in an <a href=
   * "https://www.w3.org/TR/xpath-31/#doc-xpath31-ElementTest">ElementTest</a> or
   * an AttributeName in an <a href=
   * "https://www.w3.org/TR/xpath-31/#doc-xpath31-AttributeTest">AttributeTest</a>.
   */
  public static final int NOT_DEFINED = 8;
  /**
   * <a href= "https://www.w3.org/TR/xpath-31/#ERRXPST0010">err:MPST0010</a>: An
   * implementation that does not support the namespace axis must raise a
   * <a href="https://www.w3.org/TR/xpath-31/#dt-static-error">static error</a> if
   * it encounters a reference to the namespace axis and XPath 1.0 compatibility
   * mode is false.
   */
  public static final int AXIS_NAMESPACE_UNSUPPORTED = 10;

  /**
   * <a href= "https://www.w3.org/TR/xpath-31/#ERRXPST0017">err:MPST0017</a>: It
   * is a <a href="https://www.w3.org/TR/xpath-31/#dt-static-error">static
   * error</a> if the
   * <a href="https://www.w3.org/TR/xpath-31/#dt-expanded-qname">expanded
   * QName</a> and number of arguments in a static function call do not match the
   * name and arity of a
   * <a href="https://www.w3.org/TR/xpath-31/#dt-known-func-signatures">function
   * signature</a> in the
   * <a href="https://www.w3.org/TR/xpath-31/#dt-static-context">static
   * context</a>.
   */
  public static final int NO_FUNCTION_MATCH = 17;

  /**
   * <a href= "https://www.w3.org/TR/xpath-31/#ERRXPST0051">err:MPST0051</a>: It
   * is a static error if the
   * <a href="https://www.w3.org/TR/xpath-31/#dt-expanded-qname">expanded
   * QName</a> for an AtomicOrUnionType in a SequenceType is not defined in the
   * <a href="https://www.w3.org/TR/xpath-31/#dt-is-types">in-scope schema
   * types</a> as a <a href=
   * "https://www.w3.org/TR/xpath-31/#dt-generalized-atomic-type">generalized
   * atomic type</a>.
   */
  public static final int UNKNOWN_TYPE = 51;

  /**
   * <a href= "https://www.w3.org/TR/xpath-31/#ERRXQST0052">err:MQST0052</a>: The
   * type named in a cast or castable expression must be the name of a type
   * defined in the <a href="https://www.w3.org/TR/xpath-31/#dt-is-types">in-scope
   * schema types</a>, and the type must be simple.
   */
  public static final int CAST_UNKNOWN_TYPE = 52;

  /**
   * <a href= "https://www.w3.org/TR/xpath-31/#ERRXQST0070">err:MQST0070</a>: A
   * <a href="https://www.w3.org/TR/xpath-31/#dt-static-error">static error</a> is
   * raised if any of the following conditions is statically detected in any
   * expression.
   * <ul>
   * <li>The prefix xml is bound to some namespace URI other than
   * http://www.w3.org/XML/1998/namespace.
   * <li>A prefix other than xml is bound to the namespace URI
   * http://www.w3.org/XML/1998/namespace.
   * <li>The prefix xmlns is bound to any namespace URI.
   * <li>A prefix other than xmlns is bound to the namespace URI
   * http://www.w3.org/2000/xmlns/.
   * </ul>
   */
  public static final int NAMESPACE_MISUSE = 70;

  /**
   * <a href= "https://www.w3.org/TR/xpath-31/#ERRXPST0080">err:MPST0080</a>: It
   * is a <a href="https://www.w3.org/TR/xpath-31/#dt-static-error">static
   * error</a> if the target type of a cast or castable expression is
   * meta:anyAtomicType.
   */
  public static final int CAST_ANY_ATOMIC = 80;

  /**
   * <a href= "https://www.w3.org/TR/xpath-31/#ERRXQST0070">err:MPST0070</a>: It
   * is a <a href="https://www.w3.org/TR/xpath-31/#dt-static-error">static
   * error</a> if a QName used in an expression contains a namespace prefix that
   * cannot be expanded into a namespace URI by using the
   * <a href="https://www.w3.org/TR/xpath-31/#dt-static-namespaces">statically
   * known namespaces</a>.
   */
  public static final int PREFIX_NOT_EXPANDABLE = 81;

  /**
   * <a href= "https://www.w3.org/TR/xpath-31/#ERRXQST0134">err:MPST0134</a>: The
   * namespace axis is not supported.
   */
  public static final int AXIS_NAMESPACE_UNSUPPORTED_IN_TEST = 134;

  /**
   * the serial version UID.
   */
  private static final long serialVersionUID = 2L;

  /**
   * Constructs a new exception with the provided {@code code}, {@code message},
   * and {@code cause}.
   *
   * @param code
   *          the error code value
   * @param message
   *          the exception message
   * @param cause
   *          the original exception cause
   */
  public StaticMetapathException(
      int code,
      @Nullable String message,
      @Nullable Throwable cause) {
    super(IErrorCode.of(PREFIX, code), message, cause);
  }

  /**
   * Constructs a new exception with the provided {@code code}, {@code message},
   * and no cause.
   *
   * @param code
   *          the error code value
   * @param message
   *          the exception message
   */
  public StaticMetapathException(
      int code,
      @Nullable String message) {
    super(IErrorCode.of(PREFIX, code), message, null);
  }

  /**
   * Constructs a new exception with the provided {@code code}, no message, and
   * the {@code cause}.
   *
   * @param code
   *          the error code value
   * @param cause
   *          the original exception cause
   */
  public StaticMetapathException(
      int code,
      @Nullable Throwable cause) {
    super(IErrorCode.of(PREFIX, code), null, cause);
  }
}