netwerk/ipc/NeckoCommon.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set sw=2 ts=8 et tw=80 : */
   3
   4 /* ***** BEGIN LICENSE BLOCK *****
   5  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   6  *
   7  * The contents of this file are subject to the Mozilla Public License Version
   8  * 1.1 (the "License"); you may not use this file except in compliance with
   9  * the License. You may obtain a copy of the License at
  10  * http://www.mozilla.org/MPL/
  11  *
  12  * Software distributed under the License is distributed on an "AS IS" basis,
  13  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  14  * for the specific language governing rights and limitations under the
  15  * License.
  16  *
  17  * The Original Code is mozilla.org code.
  18  *
  19  * The Initial Developer of the Original Code is
  20  *  The Mozilla Foundation
  21  * Portions created by the Initial Developer are Copyright (C) 2009
  22  * the Initial Developer. All Rights Reserved.
  23  *
  24  * Contributor(s):
  25  *   Jason Duell <jduell.mcbugs@gmail.com>
  26  *
  27  * Alternatively, the contents of this file may be used under the terms of
  28  * either the GNU General Public License Version 2 or later (the "GPL"), or
  29  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  30  * in which case the provisions of the GPL or the LGPL are applicable instead
  31  * of those above. If you wish to allow use of your version of this file only
  32  * under the terms of either the GPL or the LGPL, and not to allow others to
  33  * use your version of this file under the terms of the MPL, indicate your
  34  * decision by deleting the provisions above and replace them with the notice
  35  * and other provisions required by the GPL or the LGPL. If you do not delete
  36  * the provisions above, a recipient may use your version of this file under
  37  * the terms of any one of the MPL, the GPL or the LGPL.
  38  *
  39  * ***** END LICENSE BLOCK ***** */
  40
  41 #ifndef mozilla_net_NeckoCommon_h
  42 #define mozilla_net_NeckoCommon_h
  43
  44 #include "nsXULAppAPI.h"
  45 #include "prenv.h"
  46
  47 #if defined(DEBUG) || defined(ENABLE_TESTS)
  48 # define NECKO_ERRORS_ARE_FATAL_DEFAULT true
  49 #else
  50 # define NECKO_ERRORS_ARE_FATAL_DEFAULT false
  51 #endif
  52
  53 // TODO: Eventually remove NECKO_MAYBE_ABORT and DROP_DEAD (bug 575494).
  54 // Still useful for catching listener interfaces we don't yet support across
  55 // processes, etc.
  56
  57 #define NECKO_MAYBE_ABORT(msg)                                                 \
  58   do {                                                                         \
  59     bool abort = NECKO_ERRORS_ARE_FATAL_DEFAULT;                               \
  60     const char *e = PR_GetEnv("NECKO_ERRORS_ARE_FATAL");                       \
  61     if (e)                                                                     \
  62       abort = (*e == '0') ? false : true;                                      \
  63     if (abort) {                                                               \
  64       msg.Append(" (set NECKO_ERRORS_ARE_FATAL=0 in your environment to "      \
  65                       "convert this error into a warning.)");                  \
  66       NS_RUNTIMEABORT(msg.get());                                              \
  67     } else {                                                                   \
  68       msg.Append(" (set NECKO_ERRORS_ARE_FATAL=1 in your environment to "      \
  69                       "convert this warning into a fatal error.)");            \
  70       NS_WARNING(msg.get());                                                   \
  71     }                                                                          \
  72   } while (0)
  73
  74 #define DROP_DEAD()                                                            \
  75   do {                                                                         \
  76     nsPrintfCString msg(1000,"NECKO ERROR: '%s' UNIMPLEMENTED",                \
  77                         __FUNCTION__);                                         \
  78     NECKO_MAYBE_ABORT(msg);                                                    \
  79     return NS_ERROR_NOT_IMPLEMENTED;                                           \
  80   } while (0)
  81
  82 #define ENSURE_CALLED_BEFORE_ASYNC_OPEN()                                      \
  83   if (mIsPending || mWasOpened) {                                              \
  84     nsPrintfCString msg(1000, "'%s' called after AsyncOpen: %s +%d",           \
  85                         __FUNCTION__, __FILE__, __LINE__);                     \
  86     NECKO_MAYBE_ABORT(msg);                                                    \
  87   }                                                                            \
  88   NS_ENSURE_TRUE(!mIsPending, NS_ERROR_IN_PROGRESS);                           \
  89   NS_ENSURE_TRUE(!mWasOpened, NS_ERROR_ALREADY_OPENED);
  90
  91 namespace mozilla {
  92 namespace net {
  93
  94 inline bool
  95 IsNeckoChild()
  96 {
  97   static bool didCheck = false;
  98   static bool amChild = false;
  99
 100   if (!didCheck) {
 101     // This allows independent necko-stacks (instead of single stack in chrome)
 102     // to still be run.
 103     // TODO: Remove eventually when no longer supported (bug 571126)
 104     const char * e = PR_GetEnv("NECKO_SEPARATE_STACKS");
 105     if (!e)
 106       amChild = (XRE_GetProcessType() == GeckoProcessType_Content);
 107     didCheck = true;
 108   }
 109   return amChild;
 110 }
 111
 112
 113 } // namespace net
 114 } // namespace mozilla
 115
 116 #endif // mozilla_net_NeckoCommon_h
 117