xpcom/base/nsrootidl.idl

   1 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   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  *   Dan Rosen <dr@netscape.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 /**
  40  * Root idl declarations to be used by all.
  41  */
  42
  43 %{C++
  44
  45 #include "nscore.h"
  46 #include "prtime.h"
  47
  48 /*
  49  * Forward declarations for new string types
  50  */
  51 class nsAString;
  52 class nsACString;
  53
  54 /*
  55  * Start commenting out the C++ versions of the below in the output header
  56  */
  57 #if 0
  58 %}
  59
  60 typedef boolean             PRBool   ;
  61 typedef octet               PRUint8  ;
  62 typedef unsigned short      PRUint16 ;
  63 typedef unsigned short      PRUnichar;
  64 typedef unsigned long       PRUint32 ;
  65 typedef unsigned long long  PRUint64 ;
  66 typedef unsigned long long  PRTime   ;
  67 typedef short               PRInt16  ;
  68 typedef long                PRInt32  ;
  69 typedef long long           PRInt64  ;
  70
  71 typedef unsigned long       nsrefcnt ;
  72 typedef unsigned long       nsresult ;
  73
  74 // XXX need this built into xpidl compiler so that it's really size_t or PRSize
  75 // and it's scriptable:
  76 typedef unsigned long       size_t;
  77
  78 [ptr]         native voidPtr(void);
  79 [ptr]         native charPtr(char);
  80 [ptr]         native unicharPtr(PRUnichar);
  81
  82 [ref, nsid]   native nsIDRef(nsID);
  83 [ref, nsid]   native nsIIDRef(nsIID);
  84 [ref, nsid]   native nsCIDRef(nsCID);
  85
  86 [ptr, nsid]   native nsIDPtr(nsID);
  87 [ptr, nsid]   native nsIIDPtr(nsIID);
  88 [ptr, nsid]   native nsCIDPtr(nsCID);
  89
  90 // NOTE: Be careful in using the following 3 types. The *Ref and *Ptr variants
  91 // are more commonly used (and better supported). Those variants require
  92 // nsMemory alloc'd copies when used as 'out' params while these types do not.
  93 // However, currently these types can not be used for 'in' params. And, methods
  94 // that use them as 'out' params *must* be declared [notxpcom] (with an explicit
  95 // return type of nsresult). This makes such methods implicitly not scriptable.
  96 // Use of these types in methods without a [notxpcom] declaration will cause
  97 // the xpidl compiler to raise an error.
  98 // See: http://bugzilla.mozilla.org/show_bug.cgi?id=93792
  99
 100 [nsid]        native nsIID(nsIID);
 101 [nsid]        native nsID(nsID);
 102 [nsid]        native nsCID(nsCID);
 103
 104 [ptr]         native nsQIResult(void);
 105
 106 [ref, domstring] native DOMString(ignored);
 107 [ref, domstring] native DOMStringRef(ignored);
 108 [ptr, domstring] native DOMStringPtr(ignored);
 109
 110 [ref, utf8string] native AUTF8String(ignored);
 111 [ref, utf8string] native AUTF8StringRef(ignored);
 112 [ptr, utf8string] native AUTF8StringPtr(ignored);
 113
 114 [ref, cstring] native ACString(ignored);
 115 [ref, cstring] native ACStringRef(ignored);
 116 [ptr, cstring] native ACStringPtr(ignored);
 117
 118 [ref, astring] native AString(ignored);
 119 [ref, astring] native AStringRef(ignored);
 120 [ptr, astring] native AStringPtr(ignored);
 121
 122 [ref, jsval]  native jsval(jsval);
 123               native jsid(jsid);
 124
 125 %{C++
 126 /*
 127  * End commenting out the C++ versions of the above in the output header
 128  */
 129 #endif
 130 %}