// ******************************************************************
// *
// *    .,-:::::    .,::      .::::::::.    .,::      .:
// *  ,;;;'````'    `;;;,  .,;;  ;;;'';;'   `;;;,  .,;; 
// *  [[[             '[[,,[['   [[[__[[\.    '[[,,[['  
// *  $$$              Y$$$P     $$""""Y$$     Y$$$P    
// *  `88bo,__,o,    oP"``"Yo,  _88o,,od8P   oP"``"Yo,  
// *    "YUMMMMMP",m"       "Mm,""YUMMMP" ,m"       "Mm,
// *
// *   Cxbx->Core->Error.h
// *
// *  This file is part of the Cxbx project.
// *
// *  Cxbx and Cxbe are free software; you can redistribute them
// *  and/or modify them 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 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 recieved a copy of the GNU General Public License
// *  along with this program; see the file COPYING.
// *  If not, write to the Free Software Foundation, Inc.,
// *  59 Temple Place - Suite 330, Bostom, MA 02111-1307, USA.
// *
// *  (c) 2002-2003 Aaron Robinson <caustik@caustik.com>
// *
// *  All rights reserved
// *
// ******************************************************************
#ifndef ERROR_H
#define ERROR_H

// ******************************************************************
// * class : Error
// ******************************************************************
class Error
{
    public:
        // ******************************************************************
        // * Return current error (or zero if there is none)
        // ******************************************************************
        const char *GetError() const { return m_szError; }

        // ******************************************************************
        // * True  : Error is fatal (class should be dead)
        // * False : Error can safely be cleared and class can continue
        // ******************************************************************
        bool IsFatal() const { return m_bFatal; }

        // ******************************************************************
        // * True  : Error was cleared
        // * False : Error is fatal (class should be dead)
        // ******************************************************************
        bool ClearError();

    protected:
        // ******************************************************************
        // * Protected constructor so this class must be inherited from
        // ******************************************************************
        Error() : m_szError(0), m_bFatal(false) { }

        // ******************************************************************
        // * Protected deconstructor
        // ******************************************************************
       ~Error() { delete[] m_szError; }

        // ******************************************************************
        // * Protected so only derived class may set an error
        // ******************************************************************
        void SetError(const char *x_szError, bool x_bFatal);

    private:
        // ******************************************************************
        // * Current error information
        // ******************************************************************
        bool  m_bFatal;
        char *m_szError;
};

#endif