Source code
Revision control
Copy as Markdown
Other Tools
/* -*- 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
/**
* Root idl declarations to be used by all.
*/
%{C++
#include "nscore.h"
#include "nsID.h"
/*
* 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
%}
typedef long long PRTime;
// 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.
[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);