---

Alignment.h

/*
 * Alignment.h -- class interface for alignments
 * Copyright (C) 2002  Eric Lemings <elemings@users.sourceforge.net>
 *
 * This software 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 2
 * of the License, or (at your option) any later version.
 *
 * This software 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 software; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA
 *
 * RCS: $Id: Alignment.h,v 1.2 2003/04/18 01:41:03 elemings Exp $
 */

#ifdef __cplusplus

#  ifndef OGS_CORE_DETAILS_ALIGNMENT_H
#    define OGS_CORE_DETAILS_ALIGNMENT_H

#    include <ogs/core/Detail.h>
#    include <ogs/core/details/Namespace.h>

OGS_BEGIN_CORE_DETAILS_NAMESPACE

class Alignment: public Detail {
  public:
    enum Value {
      // Absolute alignments
      LAW =                         1 << 3,
      CHAOS =                       1 << 2,
      NEUTRAL_ORDER =               (LAW | CHAOS),

      GOOD =                        1 << 1,
      EVIL =                        1 << 0,
      NEUTRAL_MORAL =               (GOOD | EVIL),

      // Relative alignments
      LAWFUL_GOOD =                 LAW | GOOD,
      NEUTRAL_GOOD =                NEUTRAL_ORDER | GOOD,
      CHAOTIC_GOOD =                CHAOS | GOOD,

      LAWFUL_NEUTRAL =              LAW | NEUTRAL_MORAL,
      TRUE_NEUTRAL =                NEUTRAL_ORDER | NEUTRAL_MORAL,
      CHAOTIC_NEUTRAL =             CHAOS | NEUTRAL_MORAL,

      LAWFUL_EVIL =                 LAW | EVIL,
      NEUTRAL_EVIL =                NEUTRAL_ORDER | EVIL,
      CHAOTIC_EVIL =                CHAOS | EVIL,
    };

    Alignment (Value value = TRUE_NEUTRAL);

    bool isAbsolute () const;
    bool isRelative () const;
    bool isAligned (const Alignment& a) const;

    Value getValue () const;
    void setValue (Value value);

    //const char* getName () const;

  private:
    Value _value;

    static bool isValid (int i);
};

inline Alignment::Alignment (Value value):
  _value (value) {
  // empty constructor body
}

inline bool
Alignment::isAbsolute () const {
  return (this->_value == LAW || this->_value == CHAOS ||
          this->_value == NEUTRAL_ORDER || this->_value == GOOD ||
          this->_value == EVIL || this->_value == NEUTRAL_MORAL);
}

inline bool
Alignment::isRelative () const {
  return (isValid (this->_value) && !isAbsolute ());
}

inline bool
Alignment::isAligned (const Alignment& a) const {
  if (this->isAbsolute () && a.isAbsolute ()) {
    return (false);
  }

  return (this->_value & a._value);
}

inline Alignment::Value
Alignment::getValue () const {
  return (this->_value);
}

inline void
Alignment::setValue (Value value) {
  if (isValid (value)) {
    this->_value = value;
  }
}

inline bool
Alignment::isValid (int i) {
  return (i >= EVIL && i <= TRUE_NEUTRAL);
}

OGS_END_CORE_DETAILS_NAMESPACE

#  endif /* !defined OGS_CORE_DETAILS_ALIGNMENT_H */

#endif /* defined __cplusplus */

---