Engine directory for ticket #1

Engine/source/component/dynamicConsoleMethodComponent.h

@@ -0,0 +1,89 @@
+//-----------------------------------------------------------------------------
+// Copyright (c) 2012 GarageGames, LLC
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to
+// deal in the Software without restriction, including without limitation the
+// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+// sell copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+// IN THE SOFTWARE.
+//-----------------------------------------------------------------------------
+
+#ifndef _DYNAMIC_CONSOLEMETHOD_COMPONENT_H_
+#define _DYNAMIC_CONSOLEMETHOD_COMPONENT_H_
+
+#ifndef _SIMCOMPONENT_H_
+#include "component/simComponent.h"
+#endif
+
+#ifndef _CONSOLEINTERNAL_H_
+#include "console/consoleInternal.h"
+#endif
+
+#ifndef _ICALLMETHOD_H_
+#include "console/ICallMethod.h"
+#endif
+
+#ifdef TORQUE_DEBUG
+#ifndef _TDICTIONARY_H_
+#include "core/util/tDictionary.h"
+#endif
+#endif
+
+//-----------------------------------------------------------------------------
+
+class DynamicConsoleMethodComponent : public SimComponent, public ICallMethod
+{
+#ifdef TORQUE_DEBUG
+public:
+   typedef Map<StringTableEntry, S32> callMethodMetricType;
+#endif
+
+private:
+   typedef SimComponent Parent;
+
+#ifdef TORQUE_DEBUG
+   // Call Method Debug Stat.
+   callMethodMetricType mCallMethodMetrics;
+#endif
+
+protected:
+   /// Internal callMethod : Actually does component notification and script method execution
+   ///  @attention This method does some magic to the argc argv to make Con::execute act properly
+   ///   as such it's internal and should not be exposed or used except by this class
+   virtual const char* _callMethod( U32 argc, const char *argv[], bool callThis = true );
+
+public:
+
+#ifdef TORQUE_DEBUG
+   /// Call Method Metrics.
+   const callMethodMetricType& getCallMethodMetrics( void ) const { return mCallMethodMetrics; };
+
+   /// Inject Method Call.
+   void injectMethodCall( const char* method );
+#endif
+
+   /// Call Method
+   virtual const char* callMethodArgList( U32 argc, const char *argv[], bool callThis = true );
+
+   /// Call Method format string
+   const char* callMethod( S32 argc, const char* methodName, ... );
+
+   // query for console method data
+   virtual bool handlesConsoleMethod(const char * fname, S32 * routingId);
+
+   DECLARE_CONOBJECT(DynamicConsoleMethodComponent);
+};
+
+#endif