gecko-dev/dom/base/nsIBaseDOMException.h

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 2002
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Peter Van der Beken <peterv@netscape.com> (original author)
 *
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#ifndef nsIBaseDOMException_h___
#define nsIBaseDOMException_h___

#include "nsIDOMClassInfo.h"

// {1f13b201-39fa-11d6-a7f2-df501ff820dc}
#define NS_BASE_DOM_EXCEPTION_CID  \
{ 0x1f13b201, 0x39fa, 0x11d6, \
{ 0xa7, 0xf2, 0xdf, 0x50, 0x1f, 0xf8, 0x20, 0xdc } }

// {731d9701-39f8-11d6-a7f2-b39073384c9c}
#define NS_IBASEDOMEXCEPTION_IID  \
{ 0x731d9701, 0x39f8, 0x11d6, \
{ 0xa7, 0xf2, 0xb3, 0x90, 0x73, 0x38, 0x4c, 0x9c } }

class nsIBaseDOMException : public nsISupports {
public:  
  NS_DECLARE_STATIC_IID_ACCESSOR(NS_IBASEDOMEXCEPTION_IID)

  NS_IMETHOD Init(nsresult aNSResult, const char* aName,
                  const char* aMessage,
                  nsIException* aDefaultException) = 0;
};

NS_DEFINE_STATIC_IID_ACCESSOR(nsIBaseDOMException, NS_IBASEDOMEXCEPTION_IID)

#define IMPL_DOM_EXCEPTION_HEAD(classname, ifname)                           \
class classname : public nsIException,                                       \
                  public ifname                                              \
{                                                                            \
public:                                                                      \
  classname(nsIException* aInner);                                           \
  virtual ~classname();                                                      \
                                                                             \
  NS_DECL_ISUPPORTS                                                          \
  NS_FORWARD_NSIEXCEPTION(mBase->)

// Note: the exception implemented by this macro doesn't free the pointers
//       it gets from the mapping_function and assumes they will be valid
//       as long as the exception object is alive.

#define IMPL_DOM_EXCEPTION_TAIL(classname, ifname, domname, module,          \
                                mapping_function)                            \
private:                                                                     \
  nsCOMPtr<nsIException> mBase;                                              \
};                                                                           \
                                                                             \
classname::classname(nsIException* aInner) : mBase(aInner)                   \
{                                                                            \
}                                                                            \
classname::~classname() {}                                                   \
                                                                             \
NS_IMPL_ADDREF(classname)                                                    \
NS_IMPL_RELEASE(classname)                                                   \
NS_INTERFACE_MAP_BEGIN(classname)                                            \
  NS_INTERFACE_MAP_ENTRY(nsIException)                                       \
  NS_INTERFACE_MAP_ENTRY(ifname)                                             \
  NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, nsIException)                \
  NS_INTERFACE_MAP_ENTRY_EXTERNAL_DOM_CLASSINFO(domname)                     \
NS_INTERFACE_MAP_END                                                         \
                                                                             \
NS_DEFINE_CID(kBaseDOMException_CID_##domname, NS_BASE_DOM_EXCEPTION_CID);   \
                                                                             \
nsresult                                                                     \
NS_New##domname(nsresult aNSResult, nsIException* aDefaultException,         \
                nsIException** aException)                                   \
{                                                                            \
  if (!(NS_ERROR_GET_MODULE(aNSResult) == module)) {                         \
    NS_WARNING("Trying to create an exception for the wrong error module."); \
    return NS_ERROR_FAILURE;                                                 \
  }                                                                          \
  const char* name;                                                          \
  const char* message;                                                       \
  mapping_function(aNSResult, &name, &message);                              \
  nsCOMPtr<nsIBaseDOMException> baseException =                              \
    do_CreateInstance(kBaseDOMException_CID_##domname);                      \
  NS_ENSURE_TRUE(baseException, NS_ERROR_OUT_OF_MEMORY);                     \
  baseException->Init(aNSResult, name, message, aDefaultException);          \
  nsCOMPtr<nsIException> inner = do_QueryInterface(baseException);           \
  *aException = new classname(inner);                                        \
  NS_ENSURE_TRUE(*aException, NS_ERROR_OUT_OF_MEMORY);                       \
  NS_ADDREF(*aException);                                                    \
  return NS_OK;                                                              \
}

#endif /* nsIBaseDOMException_h___ */