/* Menes - C++ High-Level Utility Library
 * Copyright (C) 2003-2004  Jay Freeman (saurik)
*/

/*
 *        Redistribution and use in source and binary
 * forms, with or without modification, are permitted
 * provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the
 *    above copyright notice, this list of conditions
 *    and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the
 *    above copyright notice, this list of conditions
 *    and the following disclaimer in the documentation
 *    and/or other materials provided with the
 *    distribution.
 * 3. The name of the author may not be used to endorse
 *    or promote products derived from this software
 *    without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef MENES_EXT_EXCEPTION_HPP
#define MENES_EXT_EXCEPTION_HPP

#include "cxx/platform.hpp"
#include "ext/linkage.hpp"

#ifdef MENES_PRAGMA_ONCE
#pragma once
#endif

#include "api/stacktrace.hpp"

// XXX: this argues I _am_ doing something bad
#include "cse/string.hpp"

// XXX: this argues I might be doing something bad
namespace ios {
    class PrintWriter;
}

namespace ext {

class EXT_DECLARE Exception {
  private:
    api::StackTrace *trace_;

  public:
    explicit Exception(bool trace = true);
    Exception(const Exception &rhs);

    virtual ~Exception();

    virtual cse::String GetMessage() const;
    const api::StackTrace *GetTrace() const;

    void Trace();
};

// XXX: maybe this should be in menes/ios somewhere?
EXT_DECLARE ios::PrintWriter &operator <<(ios::PrintWriter &lhs, const Exception &rhs);

class EXT_DECLARE InvalidArgumentException :
    public Exception
{
};

class EXT_DECLARE OutOfMemoryException :
    public Exception
{
};

class EXT_DECLARE StringException :
    public Exception
{
  private:
    cse::String string_;

  public:
    StringException();
    StringException(const cse::String &string);

    virtual cse::String GetMessage() const;
};

class EXT_DECLARE NotFoundException :
    public Exception
{
};

class EXT_DECLARE NotImplementedException :
    public StringException
{
  public:
    NotImplementedException();
    NotImplementedException(const cse::String &string);
};

class EXT_DECLARE EosException :
    public Exception
{
};

}

#endif//MENES_EXT_EXCEPTION_HPP