c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync/** @file
c01664b5e4f966866d4dcb97664fde07c35415a7vboxsync * IPRT - C++ Base Exceptions.
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync */
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync/*
a3bbbe5c597341d9b6041560b790596ee41c2cfavboxsync * Copyright (C) 2006-2011 Oracle Corporation
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync *
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync * available from http://www.virtualbox.org. This file is free software;
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync * you can redistribute it and/or modify it under the terms of the GNU
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync * General Public License (GPL) as published by the Free Software
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync *
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync * The contents of this file may alternatively be used under the terms
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync * of the Common Development and Distribution License Version 1.0
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync * VirtualBox OSE distribution, in which case the provisions of the
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync * CDDL are applicable instead of those of the GPL.
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync *
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync * You may elect to license modified versions of this file under the
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync * terms and conditions of either the GPL or the CDDL or both.
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync */
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync
c01664b5e4f966866d4dcb97664fde07c35415a7vboxsync#ifndef ___iprt_cpp_exception_h
c01664b5e4f966866d4dcb97664fde07c35415a7vboxsync#define ___iprt_cpp_exception_h
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync#include <iprt/cpp/ministring.h>
323bf6a10a0b2a254da0d1d04a570a061f77330dvboxsync#include <exception>
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync
a3bbbe5c597341d9b6041560b790596ee41c2cfavboxsync/** @defgroup grp_rt_cpp_exceptions C++ Exceptions
ecb1e91dd0c0e0435e565aca5d9ebad5c652aa4bvboxsync * @ingroup grp_rt_cpp
ecb1e91dd0c0e0435e565aca5d9ebad5c652aa4bvboxsync * @{
ecb1e91dd0c0e0435e565aca5d9ebad5c652aa4bvboxsync */
ecb1e91dd0c0e0435e565aca5d9ebad5c652aa4bvboxsync
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync/**
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync * Base exception class for IPRT, derived from std::exception.
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync * The XML exceptions are based on this.
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync */
323bf6a10a0b2a254da0d1d04a570a061f77330dvboxsyncclass RT_DECL_CLASS RTCError
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync : public std::exception
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync{
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsyncpublic:
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync
323bf6a10a0b2a254da0d1d04a570a061f77330dvboxsync RTCError(const char *pszMessage)
323bf6a10a0b2a254da0d1d04a570a061f77330dvboxsync : m_strMsg(pszMessage)
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync {
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync }
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync
6c6531128b39093daeac902a8705c0bdf15b31ccvboxsync RTCError(const RTCString &a_rstrMessage)
323bf6a10a0b2a254da0d1d04a570a061f77330dvboxsync : m_strMsg(a_rstrMessage)
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync {
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync }
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync
323bf6a10a0b2a254da0d1d04a570a061f77330dvboxsync RTCError(const RTCError &a_rSrc)
323bf6a10a0b2a254da0d1d04a570a061f77330dvboxsync : std::exception(a_rSrc),
323bf6a10a0b2a254da0d1d04a570a061f77330dvboxsync m_strMsg(a_rSrc.what())
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync {
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync }
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync
323bf6a10a0b2a254da0d1d04a570a061f77330dvboxsync virtual ~RTCError() throw()
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync {
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync }
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync
323bf6a10a0b2a254da0d1d04a570a061f77330dvboxsync void operator=(const RTCError &a_rSrc)
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync {
323bf6a10a0b2a254da0d1d04a570a061f77330dvboxsync m_strMsg = a_rSrc.what();
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync }
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync
323bf6a10a0b2a254da0d1d04a570a061f77330dvboxsync void setWhat(const char *a_pszMessage)
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync {
323bf6a10a0b2a254da0d1d04a570a061f77330dvboxsync m_strMsg = a_pszMessage;
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync }
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync
323bf6a10a0b2a254da0d1d04a570a061f77330dvboxsync virtual const char *what() const throw()
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync {
323bf6a10a0b2a254da0d1d04a570a061f77330dvboxsync return m_strMsg.c_str();
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync }
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsyncprivate:
323bf6a10a0b2a254da0d1d04a570a061f77330dvboxsync /**
323bf6a10a0b2a254da0d1d04a570a061f77330dvboxsync * Hidden default constructor making sure that the extended one above is
323bf6a10a0b2a254da0d1d04a570a061f77330dvboxsync * always used.
323bf6a10a0b2a254da0d1d04a570a061f77330dvboxsync */
323bf6a10a0b2a254da0d1d04a570a061f77330dvboxsync RTCError();
323bf6a10a0b2a254da0d1d04a570a061f77330dvboxsync
323bf6a10a0b2a254da0d1d04a570a061f77330dvboxsync /** The exception message. */
6c6531128b39093daeac902a8705c0bdf15b31ccvboxsync RTCString m_strMsg;
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync};
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync/** @} */
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync
c01664b5e4f966866d4dcb97664fde07c35415a7vboxsync#endif
c700ae1991da82a9281ffd7dddc7785fe201deb6vboxsync