1 : /* ***** BEGIN LICENSE BLOCK *****
2 : * Version: MPL 1.1/GPL 2.0/LGPL 2.1
3 : *
4 : * The contents of this file are subject to the Mozilla Public License Version
5 : * 1.1 (the "License"); you may not use this file except in compliance with
6 : * the License. You may obtain a copy of the License at
7 : * http://www.mozilla.org/MPL/
8 : *
9 : * Software distributed under the License is distributed on an "AS IS" basis,
10 : * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11 : * for the specific language governing rights and limitations under the
12 : * License.
13 : *
14 : * The Original Code is mozilla.org code.
15 : *
16 : * The Initial Developer of the Original Code is mozilla.org.
17 : * Portions created by the Initial Developer are Copyright (C) 2005
18 : * the Initial Developer. All Rights Reserved.
19 : *
20 : * Contributor(s):
21 : * Mark Hammond (initial development)
22 : *
23 : * Alternatively, the contents of this file may be used under the terms of
24 : * either the GNU General Public License Version 2 or later (the "GPL"), or
25 : * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
26 : * in which case the provisions of the GPL or the LGPL are applicable instead
27 : * of those above. If you wish to allow use of your version of this file only
28 : * under the terms of either the GPL or the LGPL, and not to allow others to
29 : * use your version of this file under the terms of the MPL, indicate your
30 : * decision by deleting the provisions above and replace them with the notice
31 : * and other provisions required by the GPL or the LGPL. If you do not delete
32 : * the provisions above, a recipient may use your version of this file under
33 : * the terms of any one of the MPL, the GPL or the LGPL.
34 : *
35 : * ***** END LICENSE BLOCK ***** */
36 :
37 : #ifndef nsIScriptRuntime_h__
38 : #define nsIScriptRuntime_h__
39 :
40 : #include "nsIScriptContext.h"
41 :
42 : #define NS_ISCRIPTRUNTIME_IID \
43 : { 0x2c8d774e, 0xb52a, 0x43ec, \
44 : { 0x8e, 0xbc, 0x82, 0x75, 0xb9, 0x34, 0x20, 0x57 } }
45 :
46 : /**
47 : * A singleton language environment for an application. Responsible for
48 : * initializing and cleaning up the global language environment, and a factory
49 : * for language contexts
50 : */
51 : class nsIScriptRuntime : public nsISupports
52 50 : {
53 : public:
54 : NS_DECLARE_STATIC_IID_ACCESSOR(NS_ISCRIPTRUNTIME_IID)
55 : /*
56 : * Return the language ID of this script language
57 : */
58 : virtual PRUint32 GetScriptTypeID() = 0;
59 :
60 : /* Parses a "version string" for the language into a bit-mask used by
61 : * the language implementation. If the specified version is not supported
62 : * an error should be returned. If the specified version is blank, a default
63 : * version should be assumed
64 : */
65 : virtual nsresult ParseVersion(const nsString &aVersionStr, PRUint32 *verFlags) = 0;
66 :
67 : /* Factory for a new context for this language */
68 : virtual already_AddRefed<nsIScriptContext> CreateContext() = 0;
69 :
70 : /* Memory managment for script objects returned from various
71 : * nsIScriptContext methods. These are identical to those in
72 : * nsIScriptContext, but are useful when a script context is not known.
73 : */
74 : virtual nsresult DropScriptObject(void *object) = 0;
75 : virtual nsresult HoldScriptObject(void *object) = 0;
76 : };
77 :
78 : NS_DEFINE_STATIC_IID_ACCESSOR(nsIScriptRuntime, NS_ISCRIPTRUNTIME_IID)
79 :
80 : /* helper functions */
81 : nsresult NS_GetScriptRuntime(const nsAString &aLanguageName,
82 : nsIScriptRuntime **aRuntime);
83 :
84 : nsresult NS_GetScriptRuntimeByID(PRUint32 aLanguageID,
85 : nsIScriptRuntime **aRuntime);
86 :
87 : #endif // nsIScriptRuntime_h__
|