michael@0: /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
michael@0:  * vim: set ts=8 sts=4 et sw=4 tw=99:
michael@0:  * This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: // This file contains public type declarations that are used *frequently*.  If
michael@0: // it doesn't occur at least 10 times in Gecko, it probably shouldn't be in
michael@0: // here.
michael@0: //
michael@0: // It includes only:
michael@0: // - forward declarations of structs and classes;
michael@0: // - typedefs;
michael@0: // - enums (maybe).
michael@0: // It does *not* contain any struct or class definitions.
michael@0: 
michael@0: #ifndef js_TypeDecls_h
michael@0: #define js_TypeDecls_h
michael@0: 
michael@0: #include <stddef.h>
michael@0: #include <stdint.h>
michael@0: 
michael@0: #include "js-config.h"
michael@0: 
michael@0: struct JSContext;
michael@0: class JSFunction;
michael@0: class JSObject;
michael@0: class JSScript;
michael@0: class JSString;
michael@0: 
michael@0: struct jsid;
michael@0: 
michael@0: typedef char16_t jschar;
michael@0: 
michael@0: namespace JS {
michael@0: 
michael@0: class Value;
michael@0: template <typename T> class Handle;
michael@0: template <typename T> class MutableHandle;
michael@0: template <typename T> class Rooted;
michael@0: template <typename T> class PersistentRooted;
michael@0: 
michael@0: typedef Handle<JSFunction*> HandleFunction;
michael@0: typedef Handle<jsid>        HandleId;
michael@0: typedef Handle<JSObject*>   HandleObject;
michael@0: typedef Handle<JSScript*>   HandleScript;
michael@0: typedef Handle<JSString*>   HandleString;
michael@0: typedef Handle<Value>       HandleValue;
michael@0: 
michael@0: typedef MutableHandle<JSFunction*> MutableHandleFunction;
michael@0: typedef MutableHandle<jsid>        MutableHandleId;
michael@0: typedef MutableHandle<JSObject*>   MutableHandleObject;
michael@0: typedef MutableHandle<JSScript*>   MutableHandleScript;
michael@0: typedef MutableHandle<JSString*>   MutableHandleString;
michael@0: typedef MutableHandle<Value>       MutableHandleValue;
michael@0: 
michael@0: typedef Rooted<JSObject*>       RootedObject;
michael@0: typedef Rooted<JSFunction*>     RootedFunction;
michael@0: typedef Rooted<JSScript*>       RootedScript;
michael@0: typedef Rooted<JSString*>       RootedString;
michael@0: typedef Rooted<jsid>            RootedId;
michael@0: typedef Rooted<JS::Value>       RootedValue;
michael@0: 
michael@0: typedef PersistentRooted<JSFunction*> PersistentRootedFunction;
michael@0: typedef PersistentRooted<jsid>        PersistentRootedId;
michael@0: typedef PersistentRooted<JSObject*>   PersistentRootedObject;
michael@0: typedef PersistentRooted<JSScript*>   PersistentRootedScript;
michael@0: typedef PersistentRooted<JSString*>   PersistentRootedString;
michael@0: typedef PersistentRooted<Value>       PersistentRootedValue;
michael@0: 
michael@0: } // namespace JS
michael@0: 
michael@0: #endif /* js_TypeDecls_h */