shell/SystemClass.h

   1 /* -*- Mode: C++; c-basic-offset: 4; indent-tabs-mode: nil; tab-width: 4 -*- */
   2 /* vi: set ts=4 sw=4 expandtab: (add to ~/.vimrc: set modeline modelines=5) */
   3 /* ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is [Open Source Virtual Machine.].
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Adobe System Incorporated.
  20  * Portions created by the Initial Developer are Copyright (C) 2004-2006
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Adobe AS3 Team
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #ifndef __avmshell_SystemClass__
  41 #define __avmshell_SystemClass__
  42
  43
  44 namespace avmshell
  45 {
  46     // this class exists solely to test native classes that use MI.
  47     class MIClass : public ClassClosure
  48     {
  49     public:
  50         MIClass(VTable* cvtable) : ClassClosure(cvtable) {}
  51         ~MIClass() {}
  52
  53         DECLARE_SLOTS_MIClass;
  54     };
  55
  56     // this class exists solely to test native classes that use MI.
  57     class MixinClassThatDoesNotDescendFromScriptObject
  58     {
  59     public:
  60         const double factor;
  61         MixinClassThatDoesNotDescendFromScriptObject(double f) : factor(f) {}
  62         // evil, wrong version that we DO NOT WANT
  63         double plus(double v) { return v * factor; }
  64     };
  65
  66     // this class exists solely to test native classes that use MI.
  67     class MIObjectImpl : public ScriptObject
  68     {
  69     public:
  70         const double amount;
  71         MIObjectImpl(VTable* vtable, ScriptObject* prototype, double a) : ScriptObject(vtable, prototype), amount(a) {}
  72         double plus(double v) { return v + amount; }
  73     };
  74
  75     // this class exists solely to test native classes that use MI.
  76     class MIObject : public MIObjectImpl, public MixinClassThatDoesNotDescendFromScriptObject
  77     {
  78     public:
  79         MIObject(VTable* vtable, ScriptObject* prototype) : MIObjectImpl(vtable, prototype, 1), MixinClassThatDoesNotDescendFromScriptObject(2) {}
  80         ~MIObject() {}
  81
  82         DECLARE_SLOTS_MIObject;
  83     };
  84
  85     /**
  86      * A simple class that has some native methods.
  87      * Included as an example for writers of native methods,
  88      * and also to provide some useful QA instrumentation.
  89      */
  90     class SystemClass : public ClassClosure
  91     {
  92         uint64_t initialTime;
  93
  94     public:
  95         SystemClass(VTable* cvtable);
  96         ~SystemClass();
  97
  98         // set by shell
  99         static int user_argc;
 100         static char **user_argv;
 101
 102         /**
 103          * Implementation of System.exit
 104          * AS usage: System.exit(status);
 105          * Exits the VM with OS exit code specified by  status.
 106          */
 107         void exit(int status);
 108
 109         /**
 110          * Implementation of System.getAvmplusVersion
 111          * AS usage: System.getAvmplusVersion();
 112          * Returns the current version of AVM+ in the form
 113          * "1.0 d100"
 114          */
 115         Stringp getAvmplusVersion();
 116
 117         /**
 118          * Implementation of System.exec
 119          * AS usage: exitCode = System.exec("command");
 120          * Executes the specified command line and returns
 121          * the status code
 122          */
 123         int exec(Stringp command);
 124
 125         void trace(ArrayObject* a);
 126         void write(Stringp s);
 127
 128
 129         /**
 130          * @name Debugging Extensions
 131          */
 132         /*@{*/
 133         void debugger();
 134         bool isDebugger();
 135         /*@}*/
 136
 137                 /**
 138          * @name ActionScript Extensions
 139          * ActionScript extensions to ECMAScript
 140          */
 141         /*@{*/
 142         unsigned getTimer();
 143         /*@}*/
 144
 145         ArrayObject * getArgv();
 146
 147         Stringp readLine();
 148
 149         double get_totalMemory();
 150         double get_freeMemory();
 151         double get_privateMemory();
 152
 153         String* get_bugCompatibility();
 154
 155         // Initiate a garbage collection; future versions will not return before completed.
 156         void forceFullCollection();
 157
 158         // Queue a garbage collection request.
 159         void queueCollection();
 160
 161         // function exists solely to test native-methods with custom namespaces
 162         void ns_example_nstest() { }
 163
 164         // function exists solely to test ScriptObject::isGlobalObject
 165         bool isGlobal(Atom o);
 166
 167         DECLARE_SLOTS_SystemClass;
 168     };
 169 }
 170
 171 #endif /* __avmshell_SystemClass__ */