/*
  class Error provides a means to unify error messages

  If students print error messages using class Error then all their
  error messages will be identical to my error messages and thus it
  will be much easier to test and grade the assignments.

  To issue an error message, call the following static function

    static void error(Error_type type,
             string s1 = "",
             string s2 = "",
             string s3 = "");

  Static functions can be called w/o instantiating an Error object:

    Error::error(Error::PREVIOUSLY_DECLARED_VARIABLE, name);

  Error_type is an enumerated type.  When you need to issue an error
  message look through the elements of Error_type to find the error
  message that matches what you want to issue.

  Each error message interprets the arguments (s1, s2, s3) differently.
  Most don't use all of them, some don't use any.  You need to look in
  error.cpp to see which argument is used for a particular message.

  For example, consider the error previously declared variable.  This
  error assumes that s1 contains the textual name of the variable that
  has been previously declared.

    case PREVIOUSLY_DECLARED_VARIABLE:
      error_header();
      cerr << "Variable '"<< s1 << "'" << " previously declared."
        << endl;
      break;
*/

#ifndef ERROR_H
#define ERROR_H

#include <string>

class Error
{
  public:
    enum Error_type {
             ANIMATION_PARAM_DOES_NOT_MATCH_FORWARD,
             ANIMATION_PARAMETER_NAME_NOT_UNIQUE,
             ARRAY_INDEX_MUST_BE_AN_INTEGER,
             ARRAY_INDEX_OUT_OF_BOUNDS,
             ASSIGNMENT_TYPE_ERROR,
             CANNOT_CHANGE_DERIVED_ATTRIBUTE,
             EXIT_STATUS_MUST_BE_AN_INTEGER,
             ILLEGAL_TOKEN,
             INCORRECT_CONSTRUCTOR_PARAMETER_TYPE,
             INVALID_ARRAY_SIZE,
             INVALID_LHS_OF_ASSIGNMENT,
             INVALID_LHS_OF_MINUS_ASSIGNMENT,
             INVALID_LHS_OF_PLUS_ASSIGNMENT,
             INVALID_RIGHT_OPERAND_TYPE,
             INVALID_LEFT_OPERAND_TYPE,
             INVALID_TYPE_FOR_INITIAL_VALUE,
             INVALID_TYPE_FOR_FOR_STMT_EXPRESSION,
             INVALID_TYPE_FOR_IF_STMT_EXPRESSION,
             INVALID_TYPE_FOR_PRINT_STMT_EXPRESSION,
             INVALID_TYPE_FOR_RESERVED_VARIABLE,
             LHS_OF_PERIOD_MUST_BE_OBJECT,
             MINUS_ASSIGNMENT_TYPE_ERROR,
             NO_BODY_PROVIDED_FOR_FORWARD,
             NO_FORWARD_FOR_ANIMATION_BLOCK,
             OPERAND_MUST_BE_A_GAME_OBJECT,
             PARSE_ERROR,
             PLUS_ASSIGNMENT_TYPE_ERROR,
             PREVIOUSLY_DECLARED_VARIABLE,
             PREVIOUSLY_DEFINED_ANIMATION_BLOCK,
             TYPE_MISMATCH_BETWEEN_ANIMATION_BLOCK_AND_OBJECT,
             UNDECLARED_MEMBER,
             UNDECLARED_VARIABLE,
             UNKNOWN_CONSTRUCTOR_PARAMETER,
             VARIABLE_NOT_AN_ARRAY,
             UNDEFINED_ERROR
            };

    static void error(Error_type type,
                      std::string s1 = "",
                      std::string s2 = "",
                      std::string s3 = "");

    static void starting_execution() {m_runtime = true;}

    static int num_errors() {return m_num_errors;}
    static bool runtime() {return m_runtime;}

  protected:
    static bool m_runtime;
    static int m_num_errors;
    static void error_header();
};

#endif // #ifndef ERROR_H