diff options
| author | Joe Ludwig <[email protected]> | 2013-06-26 15:22:04 -0700 |
|---|---|---|
| committer | Joe Ludwig <[email protected]> | 2013-06-26 15:22:04 -0700 |
| commit | 39ed87570bdb2f86969d4be821c94b722dc71179 (patch) | |
| tree | abc53757f75f40c80278e87650ea92808274aa59 /mp/src/public/appframework/IAppSystem.h | |
| download | source-sdk-2013-39ed87570bdb2f86969d4be821c94b722dc71179.tar.xz source-sdk-2013-39ed87570bdb2f86969d4be821c94b722dc71179.zip | |
First version of the SOurce SDK 2013
Diffstat (limited to 'mp/src/public/appframework/IAppSystem.h')
| -rw-r--r-- | mp/src/public/appframework/IAppSystem.h | 122 |
1 files changed, 122 insertions, 0 deletions
diff --git a/mp/src/public/appframework/IAppSystem.h b/mp/src/public/appframework/IAppSystem.h new file mode 100644 index 00000000..16da0710 --- /dev/null +++ b/mp/src/public/appframework/IAppSystem.h @@ -0,0 +1,122 @@ +//========= Copyright Valve Corporation, All rights reserved. ============//
+//
+// Purpose: An application framework
+//
+// $Revision: $
+// $NoKeywords: $
+//=============================================================================//
+
+#ifndef IAPPSYSTEM_H
+#define IAPPSYSTEM_H
+
+#ifdef _WIN32
+#pragma once
+#endif
+
+#include "tier1/interface.h"
+
+
+//-----------------------------------------------------------------------------
+// Client systems are singleton objects in the client codebase responsible for
+// various tasks
+// The order in which the client systems appear in this list are the
+// order in which they are initialized and updated. They are shut down in
+// reverse order from which they are initialized.
+//-----------------------------------------------------------------------------
+
+enum InitReturnVal_t
+{
+ INIT_FAILED = 0,
+ INIT_OK,
+
+ INIT_LAST_VAL,
+};
+
+
+abstract_class IAppSystem
+{
+public:
+ // Here's where the app systems get to learn about each other
+ virtual bool Connect( CreateInterfaceFn factory ) = 0;
+ virtual void Disconnect() = 0;
+
+ // Here's where systems can access other interfaces implemented by this object
+ // Returns NULL if it doesn't implement the requested interface
+ virtual void *QueryInterface( const char *pInterfaceName ) = 0;
+
+ // Init, shutdown
+ virtual InitReturnVal_t Init() = 0;
+ virtual void Shutdown() = 0;
+};
+
+
+//-----------------------------------------------------------------------------
+// Helper empty implementation of an IAppSystem
+//-----------------------------------------------------------------------------
+template< class IInterface >
+class CBaseAppSystem : public IInterface
+{
+public:
+ // Here's where the app systems get to learn about each other
+ virtual bool Connect( CreateInterfaceFn factory ) { return true; }
+ virtual void Disconnect() {}
+
+ // Here's where systems can access other interfaces implemented by this object
+ // Returns NULL if it doesn't implement the requested interface
+ virtual void *QueryInterface( const char *pInterfaceName ) { return NULL; }
+
+ // Init, shutdown
+ virtual InitReturnVal_t Init() { return INIT_OK; }
+ virtual void Shutdown() {}
+};
+
+
+//-----------------------------------------------------------------------------
+// Helper implementation of an IAppSystem for tier0
+//-----------------------------------------------------------------------------
+template< class IInterface >
+class CTier0AppSystem : public CBaseAppSystem< IInterface >
+{
+public:
+ CTier0AppSystem( bool bIsPrimaryAppSystem = true )
+ {
+ m_bIsPrimaryAppSystem = bIsPrimaryAppSystem;
+ }
+
+protected:
+ // NOTE: a single DLL may have multiple AppSystems it's trying to
+ // expose. If this is true, you must return true from only
+ // one of those AppSystems; not doing so will cause all static
+ // libraries connected to it to connect/disconnect multiple times
+
+ // NOTE: We don't do this as a virtual function to avoid
+ // having to up the version on all interfaces
+ bool IsPrimaryAppSystem() { return m_bIsPrimaryAppSystem; }
+
+private:
+ bool m_bIsPrimaryAppSystem;
+};
+
+
+//-----------------------------------------------------------------------------
+// This is the version of IAppSystem shipped 10/15/04
+// NOTE: Never change this!!!
+//-----------------------------------------------------------------------------
+abstract_class IAppSystemV0
+{
+public:
+ // Here's where the app systems get to learn about each other
+ virtual bool Connect( CreateInterfaceFn factory ) = 0;
+ virtual void Disconnect() = 0;
+
+ // Here's where systems can access other interfaces implemented by this object
+ // Returns NULL if it doesn't implement the requested interface
+ virtual void *QueryInterface( const char *pInterfaceName ) = 0;
+
+ // Init, shutdown
+ virtual InitReturnVal_t Init() = 0;
+ virtual void Shutdown() = 0;
+};
+
+#endif // IAPPSYSTEM_H
+
|