nscore.h
上传用户:goldcmy89
上传日期:2017-12-03
资源大小:2246k
文件大小:14k
源码类别:

PlugIns编程

开发平台:

Visual C++

  1. /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is mozilla.org code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 1998
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *
  24.  * Alternatively, the contents of this file may be used under the terms of
  25.  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26.  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27.  * in which case the provisions of the GPL or the LGPL are applicable instead
  28.  * of those above. If you wish to allow use of your version of this file only
  29.  * under the terms of either the GPL or the LGPL, and not to allow others to
  30.  * use your version of this file under the terms of the MPL, indicate your
  31.  * decision by deleting the provisions above and replace them with the notice
  32.  * and other provisions required by the GPL or the LGPL. If you do not delete
  33.  * the provisions above, a recipient may use your version of this file under
  34.  * the terms of any one of the MPL, the GPL or the LGPL.
  35.  *
  36.  * ***** END LICENSE BLOCK ***** */
  37. #ifndef nscore_h___
  38. #define nscore_h___
  39. /**
  40.  * Make sure that we have the proper platform specific 
  41.  * c++ definitions needed by nscore.h
  42.  */
  43. #ifndef _XPCOM_CONFIG_H_
  44. #include "xpcom-config.h"
  45. #endif
  46. /**
  47.  * Incorporate the core NSPR data types which XPCOM uses.
  48.  */
  49. #include "prtypes.h"
  50. /* Core XPCOM declarations. */
  51. /**
  52.  * Macros defining the target platform...
  53.  */
  54. #ifdef _WIN32
  55. #define NS_WIN32 1
  56. #elif defined(__unix)
  57. #define NS_UNIX 1
  58. #elif defined(XP_OS2)
  59. #define NS_OS2 1
  60. #endif
  61. /*----------------------------------------------------------------------*/
  62. /* Import/export defines */
  63. /**
  64.  * Using the visibility("hidden") attribute allows the compiler to use
  65.  * PC-relative addressing to call this function.  If a function does not
  66.  * access any global data, and does not call any methods which are not either
  67.  * file-local or hidden, then on ELF systems we avoid loading the address of
  68.  * the PLT into a register at the start of the function, which reduces code
  69.  * size and frees up a register for general use.
  70.  *
  71.  * As a general rule, this should be used for any non-exported symbol
  72.  * (including virtual method implementations).  NS_IMETHOD uses this by
  73.  * default; if you need to have your NS_IMETHOD functions exported, you can
  74.  * wrap your class as follows:
  75.  *
  76.  * #undef  IMETHOD_VISIBILITY
  77.  * #define IMETHOD_VISIBILITY NS_VISIBILITY_DEFAULT
  78.  *
  79.  * class Foo {
  80.  * ...
  81.  * };
  82.  *
  83.  * #undef  IMETHOD_VISIBILITY
  84.  * #define IMETHOD_VISIBILITY NS_VISIBILITY_HIDDEN
  85.  *
  86.  * Don't forget to change the visibility back to hidden before the end
  87.  * of a header!
  88.  *
  89.  * Other examples:
  90.  *
  91.  * NS_HIDDEN_(int) someMethod();
  92.  * SomeCtor() NS_HIDDEN;
  93.  */
  94. #ifdef HAVE_VISIBILITY_HIDDEN_ATTRIBUTE
  95. #define NS_VISIBILITY_HIDDEN   __attribute__ ((visibility ("hidden")))
  96. #else
  97. #define NS_VISIBILITY_HIDDEN
  98. #endif
  99. #if defined(HAVE_VISIBILITY_HIDDEN_ATTRIBUTE) && defined(HAVE_VISIBILITY_PRAGMA)
  100. #define NS_VISIBILITY_DEFAULT __attribute__ ((visibility ("default")))
  101. #else
  102. #define NS_VISIBILITY_DEFAULT
  103. #endif
  104. #define NS_HIDDEN_(type)   NS_VISIBILITY_HIDDEN type
  105. #define NS_EXTERNAL_VIS_(type) NS_VISIBILITY_DEFAULT type
  106. #define NS_HIDDEN           NS_VISIBILITY_HIDDEN
  107. #define NS_EXTERNAL_VIS     NS_VISIBILITY_DEFAULT
  108. #undef  IMETHOD_VISIBILITY
  109. #define IMETHOD_VISIBILITY  NS_VISIBILITY_HIDDEN
  110. /**
  111.  * Mark a function as using a potentially non-standard function calling
  112.  * convention.  This can be used on functions that are called very
  113.  * frequently, to reduce the overhead of the function call.  It is still worth
  114.  * using the macro for C++ functions which take no parameters since it allows
  115.  * passing |this| in a register.
  116.  *
  117.  *  - Do not use this on any scriptable interface method since xptcall won't be
  118.  *    aware of the different calling convention.
  119.  *  - This must appear on the declaration, not the definition.
  120.  *  - Adding this to a public function _will_ break binary compatibility.
  121.  *  - This may be used on virtual functions but you must ensure it is applied
  122.  *    to all implementations - the compiler will _not_ warn but it will crash.
  123.  *  - This has no effect for inline functions or functions which take a
  124.  *    variable number of arguments.
  125.  *
  126.  * Examples: int NS_FASTCALL func1(char *foo);
  127.  *           NS_HIDDEN_(int) NS_FASTCALL func2(char *foo);
  128.  */
  129. #if defined(__i386__) && defined(__GNUC__) && (__GNUC__ >= 3) && !defined(XP_OS2)
  130. #define NS_FASTCALL __attribute__ ((regparm (3), stdcall))
  131. #else
  132. #define NS_FASTCALL
  133. #endif
  134. /*
  135.  * NS_DEFCALL undoes the effect of a global regparm/stdcall setting
  136.  * so that xptcall works correctly.
  137.  */
  138. #if defined(__i386__) && defined(__GNUC__) && (__GNUC__ >= 3) && !defined(XP_OS2)
  139. #define NS_DEFCALL __attribute__ ((regparm (0), cdecl))
  140. #else
  141. #define NS_DEFCALL
  142. #endif
  143. #ifdef NS_WIN32
  144. #define NS_IMPORT __declspec(dllimport)
  145. #define NS_IMPORT_(type) type __declspec(dllimport) __stdcall
  146. #define NS_EXPORT __declspec(dllexport)
  147. #define NS_EXPORT_(type) type __declspec(dllexport) __stdcall
  148. #define NS_IMETHOD_(type) virtual type __stdcall
  149. #define NS_IMETHODIMP_(type) type __stdcall
  150. #define NS_METHOD_(type) type __stdcall
  151. #define NS_CALLBACK_(_type, _name) _type (__stdcall * _name)
  152. #define NS_STDCALL __stdcall
  153. /*
  154.   These are needed to mark static members in exported classes, due to
  155.   gcc bug XXX insert bug# here.
  156.  */
  157. #define NS_EXPORT_STATIC_MEMBER_(type) type
  158. #define NS_IMPORT_STATIC_MEMBER_(type) type
  159. #else
  160. #define NS_IMPORT NS_EXTERNAL_VIS
  161. #define NS_IMPORT_(type) NS_EXTERNAL_VIS_(type)
  162. #define NS_EXPORT NS_EXTERNAL_VIS
  163. #define NS_EXPORT_(type) NS_EXTERNAL_VIS_(type)
  164. #define NS_IMETHOD_(type) virtual IMETHOD_VISIBILITY type NS_DEFCALL
  165. #define NS_IMETHODIMP_(type) type
  166. #define NS_METHOD_(type) type
  167. #define NS_CALLBACK_(_type, _name) _type (* _name)
  168. #define NS_STDCALL
  169. #define NS_EXPORT_STATIC_MEMBER_(type) NS_EXTERNAL_VIS_(type)
  170. #define NS_IMPORT_STATIC_MEMBER_(type) NS_EXTERNAL_VIS_(type)
  171. #endif
  172. /**
  173.  * Macro for creating typedefs for pointer-to-member types which are
  174.  * declared with stdcall.  It is important to use this for any type which is
  175.  * declared as stdcall (i.e. NS_IMETHOD).  For example, instead of writing:
  176.  *
  177.  *  typedef nsresult (nsIFoo::*someType)(nsISupports* arg);
  178.  *
  179.  *  you should write:
  180.  *
  181.  *  typedef
  182.  *  NS_STDCALL_FUNCPROTO(nsresult, someType, nsIFoo, typeFunc, (nsISupports*));
  183.  *
  184.  *  where nsIFoo::typeFunc is any method declared as
  185.  *  NS_IMETHOD typeFunc(nsISupports*);
  186.  *
  187.  *  XXX this can be simplified to always use the non-typeof implementation
  188.  *  when http://gcc.gnu.org/bugzilla/show_bug.cgi?id=11893 is fixed.
  189.  */
  190. #ifdef __GNUC__
  191. #define NS_STDCALL_FUNCPROTO(ret, name, class, func, args) 
  192.   typeof(&class::func) name
  193. #else
  194. #define NS_STDCALL_FUNCPROTO(ret, name, class, func, args) 
  195.   ret (NS_STDCALL class::*name) args
  196. #endif
  197. /**
  198.  * Generic API modifiers which return the standard XPCOM nsresult type
  199.  */
  200. #define NS_IMETHOD          NS_IMETHOD_(nsresult)
  201. #define NS_IMETHODIMP       NS_IMETHODIMP_(nsresult)
  202. #define NS_METHOD           NS_METHOD_(nsresult)
  203. #define NS_CALLBACK(_name)  NS_CALLBACK_(nsresult, _name)
  204. /**
  205.  * Import/Export macros for XPCOM APIs
  206.  */
  207. #ifdef _IMPL_NS_COM
  208. #define NS_COM NS_EXPORT
  209. #elif  _IMPL_NS_COM_OFF
  210. #define NS_COM
  211. #elif  XPCOM_GLUE
  212. #define NS_COM
  213. #else
  214. #define NS_COM NS_IMPORT
  215. #endif
  216. #ifdef MOZILLA_INTERNAL_API
  217. #  define NS_COM_GLUE NS_COM
  218.    /*
  219.      The frozen string API has different definitions of nsAC?String
  220.      classes than the internal API. On systems that explicitly declare
  221.      dllexport symbols this is not a problem, but on ELF systems
  222.      internal symbols can accidentally "shine through"; we rename the
  223.      internal classes to avoid symbol conflicts.
  224.    */
  225. #  define nsAString nsAString_internal
  226. #  define nsACString nsACString_internal
  227. #else
  228. #  define NS_COM_GLUE
  229. #endif
  230. /**
  231.  * NS_NO_VTABLE is emitted by xpidl in interface declarations whenever
  232.  * xpidl can determine that the interface can't contain a constructor.
  233.  * This results in some space savings and possible runtime savings -
  234.  * see bug 49416.  We undefine it first, as xpidl-generated headers
  235.  * define it for IDL uses that don't include this file.
  236.  */
  237. #ifdef NS_NO_VTABLE
  238. #undef NS_NO_VTABLE
  239. #endif
  240. #if defined(_MSC_VER) && _MSC_VER >= 1100
  241. #define NS_NO_VTABLE __declspec(novtable)
  242. #else
  243. #define NS_NO_VTABLE
  244. #endif
  245. /**
  246.  * Generic XPCOM result data type
  247.  */
  248. typedef PRUint32 nsresult;
  249. /**
  250.  * The preferred symbol for null.
  251.  */
  252. #define nsnull 0
  253. #include "nsError.h"
  254. /* ------------------------------------------------------------------------ */
  255. /* Casting macros for hiding C++ features from older compilers */
  256.   /*
  257.     All our compiler support template specialization, but not all support the
  258.     |template <>| notation.  The compiler that don't understand this notation
  259.     just omit it for specialization.
  260.     Need to add an autoconf test for this.
  261.   */
  262.   /* under Metrowerks (Mac), we don't have autoconf yet */
  263. #ifdef __MWERKS__
  264.   #define HAVE_CPP_PARTIAL_SPECIALIZATION
  265.   #define HAVE_CPP_MODERN_SPECIALIZE_TEMPLATE_SYNTAX
  266.   #define HAVE_CPP_ACCESS_CHANGING_USING
  267.   #define HAVE_CPP_AMBIGUITY_RESOLVING_USING
  268.   #define HAVE_CPP_EXPLICIT
  269.   #define HAVE_CPP_TYPENAME
  270.   #define HAVE_CPP_BOOL
  271.   #define HAVE_CPP_NAMESPACE_STD
  272.   #define HAVE_CPP_UNAMBIGUOUS_STD_NOTEQUAL
  273.   #define HAVE_CPP_2BYTE_WCHAR_T
  274. #endif
  275.   /* under VC++ (Windows), we don't have autoconf yet */
  276. #if defined(_MSC_VER) && (_MSC_VER>=1100)
  277.   /* VC++ 5.0 and greater implement template specialization, 4.2 is unknown */
  278.   #define HAVE_CPP_MODERN_SPECIALIZE_TEMPLATE_SYNTAX
  279.   #define HAVE_CPP_EXPLICIT
  280.   #define HAVE_CPP_TYPENAME
  281.   #define HAVE_CPP_ACCESS_CHANGING_USING
  282.   #if (_MSC_VER==1100)
  283.       /* VC++5.0 has an internal compiler error (sometimes) without this */
  284.     #undef HAVE_CPP_ACCESS_CHANGING_USING
  285.   #endif
  286.   #define HAVE_CPP_NAMESPACE_STD
  287.   #define HAVE_CPP_UNAMBIGUOUS_STD_NOTEQUAL
  288.   #define HAVE_CPP_2BYTE_WCHAR_T
  289. #endif
  290. #ifndef __PRUNICHAR__
  291. #define __PRUNICHAR__
  292.   /* For now, don't use wchar_t on Unix because it breaks the Netscape
  293.    * commercial build.  When this is fixed there will be no need for the
  294.    * |NS_REINTERPRET_CAST| in nsLiteralString.h either.
  295.    */
  296.   #if defined(HAVE_CPP_2BYTE_WCHAR_T) && defined(NS_WIN32)
  297.     typedef wchar_t PRUnichar;
  298.   #else
  299.     typedef PRUint16 PRUnichar;
  300.   #endif
  301. #endif
  302.   /*
  303.     If the compiler doesn't support |explicit|, we'll just make it go away, trusting
  304.     that the builds under compilers that do have it will keep us on the straight and narrow.
  305.   */
  306. #ifndef HAVE_CPP_EXPLICIT
  307.   #define explicit
  308. #endif
  309. #ifndef HAVE_CPP_TYPENAME
  310.   #define typename
  311. #endif
  312. #ifdef HAVE_CPP_MODERN_SPECIALIZE_TEMPLATE_SYNTAX
  313.   #define NS_SPECIALIZE_TEMPLATE  template <>
  314. #else
  315.   #define NS_SPECIALIZE_TEMPLATE
  316. #endif
  317. /* unix and beos now determine this automatically */
  318. #if ! defined XP_UNIX && ! defined XP_BEOS && !defined(XP_OS2)
  319. #ifndef HAVE_CPP_NEW_CASTS
  320. #define HAVE_CPP_NEW_CASTS 1 /* we'll be optimistic. */
  321. #endif
  322. #endif
  323. #if defined(HAVE_CPP_NEW_CASTS)
  324. #define NS_STATIC_CAST(__type, __ptr)      static_cast< __type >(__ptr)
  325. #define NS_CONST_CAST(__type, __ptr)       const_cast< __type >(__ptr)
  326. #define NS_REINTERPRET_POINTER_CAST(__type, __ptr)    reinterpret_cast< __type >(__ptr)
  327. #define NS_REINTERPRET_NONPOINTER_CAST(__type, __obj) reinterpret_cast< __type >(__obj)
  328. #define NS_REINTERPRET_CAST(__type, __expr)           reinterpret_cast< __type >(__expr)
  329. #else
  330. #define NS_STATIC_CAST(__type, __ptr)      ((__type)(__ptr))
  331. #define NS_CONST_CAST(__type, __ptr)       ((__type)(__ptr))
  332. #define NS_REINTERPRET_POINTER_CAST(__type, __ptr)     ((__type)((void*)(__ptr)))
  333. #define NS_REINTERPRET_NONPOINTER_CAST(__type, __obj)  ((__type)(__obj))
  334.   /* Note: the following is only appropriate for pointers. */
  335. #define NS_REINTERPRET_CAST(__type, __expr)            NS_REINTERPRET_POINTER_CAST(__type, __expr)
  336.   /*
  337.     Why cast to a |void*| first?  Well, when old-style casting from
  338.     a pointer to a base to a pointer to a derived class, the cast will be
  339.     ambiguous if the source pointer type appears multiple times in the
  340.     destination, e.g.,
  341.     
  342.       class Base {};
  343.       class Derived : public Base, public Base {};
  344.       
  345.       void foo( Base* b )
  346.         {
  347.           ((Derived*)b)->some_derived_member ... // Error: Ambiguous, expand from which |Base|?
  348.         }
  349.     an old-style cast (like |static_cast|) will change the pointer, but
  350.     here, doesn't know how.  The cast to |void*| prevents it from thinking
  351.     it needs to expand the original pointer.
  352.     The cost is, |NS_REINTERPRET_CAST| is no longer appropriate for non-pointer
  353.     conversions.  Also, mis-applying |NS_REINTERPRET_CAST| to cast |this| to something
  354.     will still expand the pointer to the outer object in standards complying compilers.
  355.   */
  356.   /*
  357.     No sense in making an NS_DYNAMIC_CAST() macro: you can't duplicate
  358.     the semantics. So if you want to dynamic_cast, then just use it
  359.     "straight", no macro.
  360.   */
  361. #endif
  362.  
  363. /* 
  364.  * Use these macros to do 64bit safe pointer conversions.
  365.  */
  366. #define NS_PTR_TO_INT32(x)  ((PRInt32)  (PRWord) (x))
  367. #define NS_PTR_TO_UINT32(x) ((PRUint32) (PRWord) (x))
  368. #define NS_INT32_TO_PTR(x)  ((void *)   (PRWord) (x))
  369. /*
  370.  * Use NS_STRINGIFY to form a string literal from the value of a macro.
  371.  */
  372. #define NS_STRINGIFY_HELPER(x_) #x_
  373. #define NS_STRINGIFY(x_) NS_STRINGIFY_HELPER(x_)
  374. /*
  375.  * These macros allow you to give a hint to the compiler about branch
  376.  * probability so that it can better optimize.  Use them like this:
  377.  *
  378.  *  if (NS_LIKELY(v == 1)) {
  379.  *    ... expected code path ...
  380.  *  }
  381.  *
  382.  *  if (NS_UNLIKELY(v == 0)) {
  383.  *    ... non-expected code path ...
  384.  *  }
  385.  *
  386.  */
  387. #if defined(__GNUC__) && (__GNUC__ > 2)
  388. #define NS_LIKELY(x)    (__builtin_expect((x), 1))
  389. #define NS_UNLIKELY(x)  (__builtin_expect((x), 0))
  390. #else
  391. #define NS_LIKELY(x)    (x)
  392. #define NS_UNLIKELY(x)  (x)
  393. #endif
  394. #endif /* nscore_h___ */