fune/xpcom/base/nsrootidl.idl
Andrew McCreight 95b49c0fed Bug 1794811, part 2 - Use the automatically generated nsISupports.h. r=nika
Now that the return type of AddRef and Release are consistent between
C++ and XPIDL, we can use the generated nsISupports.h instead of skipping
the guts of it with an #if 0 and importing nsISupportsBase.h.

nsISupportsBase.h had two #includes, nscore.h and nsID.h. nsISupports.h
needs to continue to include both of these files so that things don't
break. It gets nscore.h via nsrootidl.idl. I added the include of nsID.h
to nsrootidl.idl because that file makes related definitions in XPIDL.

Mostly this patch moves over comments from nsISupportsBase.h.

The "Mac specific ": public __comobject" thing" comment seems to have
been obsolete since at least 2001.

I weakened the statement about binary compatibility with MSCOM.

Differential Revision: https://phabricator.services.mozilla.com/D159170
2022-10-17 16:09:22 +00:00

105 lines
3 KiB
Text

/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/**
* Root idl declarations to be used by all.
*/
%{C++
#include "nscore.h"
#include "nsID.h"
typedef int64_t PRTime;
/*
* Forward declarations for new string types
*/
#include "nsStringFwd.h"
struct JSContext;
/*
* Forward declaration of mozilla::dom::Promise
*/
namespace mozilla {
namespace dom {
class Promise;
} // namespace dom
} // namespace mozilla
/*
* Start commenting out the C++ versions of the below in the output header
*/
#if 0
%}
typedef boolean bool ;
typedef octet uint8_t ;
typedef unsigned short uint16_t ;
typedef unsigned short char16_t;
typedef unsigned long uint32_t ;
typedef unsigned long long uint64_t ;
typedef long long PRTime ;
typedef short int16_t ;
typedef long int32_t ;
typedef long long int64_t ;
typedef unsigned long nsresult ;
// If we ever want to use `size_t` in scriptable interfaces, this will need to
// be built into the xpidl compiler, as the size varies based on platform.
native size_t(size_t);
[ptr] native voidPtr(void);
[ptr] native charPtr(char);
[ptr] native unicharPtr(char16_t);
[ref, nsid] native nsIDRef(nsID);
[ref, nsid] native nsIIDRef(nsIID);
[ref, nsid] native nsCIDRef(nsCID);
[ptr, nsid] native nsIDPtr(nsID);
[ptr, nsid] native nsIIDPtr(nsIID);
[ptr, nsid] native nsCIDPtr(nsCID);
// NOTE: Be careful in using the following 3 types. The *Ref and *Ptr variants
// are more commonly used (and better supported). Those variants require
// nsMemory alloc'd copies when used as 'out' params while these types do not.
// However, currently these types can not be used for 'in' params. And, methods
// that use them as 'out' params *must* be declared [notxpcom] (with an explicit
// return type of nsresult). This makes such methods implicitly not scriptable.
// Use of these types in methods without a [notxpcom] declaration will cause
// the xpidl compiler to raise an error.
// See: http://bugzilla.mozilla.org/show_bug.cgi?id=93792
[nsid] native nsIID(nsIID);
[nsid] native nsID(nsID);
[nsid] native nsCID(nsCID);
[ptr] native nsQIResult(void);
[ref, utf8string] native AUTF8String(ignored);
[ref, utf8string] native AUTF8StringRef(ignored);
[ptr, utf8string] native AUTF8StringPtr(ignored);
[ref, cstring] native ACString(ignored);
[ref, cstring] native ACStringRef(ignored);
[ptr, cstring] native ACStringPtr(ignored);
[ref, astring] native AString(ignored);
[ref, astring] native AStringRef(ignored);
[ptr, astring] native AStringPtr(ignored);
[ref, jsval] native jsval(jsval);
native jsid(jsid);
[ptr, promise] native Promise(ignored);
%{C++
/*
* End commenting out the C++ versions of the above in the output header
*/
#endif
%}