//
//	aegis - project change supervisor
//	Copyright (C) 1994, 1996, 2002, 2005-2008 Peter Miller
//
//	This program is free software; you can redistribute it and/or modify
//	it under the terms of the GNU General Public License as published by
//	the Free Software Foundation; either version 3 of the License, or
//	(at your option) any later version.
//
//	This program is distributed in the hope that it will be useful,
//	but WITHOUT ANY WARRANTY; without even the implied warranty of
//	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//	GNU General Public License for more details.
//
//	You should have received a copy of the GNU General Public License
//	along with this program. If not, see
//	<http://www.gnu.org/licenses/>.
//

#ifndef AEGIS_AER_VALUE_ENUM_H
#define AEGIS_AER_VALUE_ENUM_H

#include <common/nstring.h>
#include <libaegis/aer/value.h>


/**
  * The rpt_value_enumeration class is used to represent a value which
  * is an enum tag.
  */
class rpt_value_enumeration:
    public rpt_value
{
public:
    /**
      * The destructor.
      */
    virtual ~rpt_value_enumeration();

private:
    /**
      * The constructor.  It is private on purpose, use the "create"
      * class method nstead.
      */
    rpt_value_enumeration(int ival, const nstring &sval);

public:
    /**
      * The create class method is used to create new dynamically
      * allocated instances of this class.
      */
    static rpt_value::pointer create(int ival, const nstring &sval);

    /**
      * The create class method is used to create new dynamically
      * allocated instances of this class.
      */
    static rpt_value::pointer create(int ival, const char *sval);

    /**
      * The query method may be used to obtain the value of this class.
      */
    int query() const;

protected:
    // See base class for documentation.
    rpt_value::pointer integerize_or_null() const;

    // See base class for documentation.
    const char *name() const;

    // See base class for documentation.
    rpt_value::pointer stringize_or_null() const;

    // See base class for documentation.
    rpt_value::pointer arithmetic_or_null() const;

    // See base class for documentation.
    rpt_value::pointer booleanize_or_null() const;

    // See base class for documentation.
    rpt_value::pointer realize_or_null() const;

private:
    /**
      * The ival instance variable is used to remember the integer value
      * of this object.
      */
    int ival;

    /**
      * The sval instance variable is used to remember the string value
      * of this object.
      */
    nstring sval;

    /**
      * The default constructor.  Do not use.
      */
    rpt_value_enumeration();

    /**
      * The copy constructor.  Do not use.
      */
    rpt_value_enumeration(const rpt_value_enumeration &);

    /**
      * The assignment operator.  Do not use.
      */
    rpt_value_enumeration &operator=(const rpt_value_enumeration &);
};

#endif // AEGIS_AER_VALUE_ENUM_H