Plugin.h

00001 /*
00002  * This source file is part of libRocket, the HTML/CSS Interface Middleware
00003  *
00004  * For the latest information, see http://www.librocket.com
00005  *
00006  * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
00007  *
00008  * Permission is hereby granted, free of charge, to any person obtaining a copy
00009  * of this software and associated documentation files (the "Software"), to deal
00010  * in the Software without restriction, including without limitation the rights
00011  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00012  * copies of the Software, and to permit persons to whom the Software is
00013  * furnished to do so, subject to the following conditions:
00014  *
00015  * The above copyright notice and this permission notice shall be included in
00016  * all copies or substantial portions of the Software.
00017  * 
00018  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00019  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00020  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00021  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00022  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00023  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
00024  * THE SOFTWARE.
00025  *
00026  */
00027 
00028 #ifndef ROCKETDEBUGGERPLUGIN_H
00029 #define ROCKETDEBUGGERPLUGIN_H
00030 
00031 #include <Rocket/Core/EventListener.h>
00032 #include <Rocket/Core/Plugin.h>
00033 #include <set>
00034 
00035 namespace Rocket {
00036 namespace Core {
00037 
00038 class ElementDocument;
00039 
00040 }
00041 
00042 namespace Debugger {
00043 
00044 class ElementLog;
00045 class ElementInfo;
00046 class ElementContextHook;
00047 class SystemInterface;
00048 
00055 class Plugin : public Core::Plugin, public Core::EventListener
00056 {
00057 public:
00058         Plugin();
00059         virtual ~Plugin();
00060 
00064         bool Initialise(Core::Context* context);
00065 
00069         bool SetContext(Core::Context* context);
00070 
00073         void SetVisible(bool visibility);
00076         bool IsVisible();
00077 
00079         void Render();
00080 
00082         virtual void OnShutdown();
00083 
00086         virtual void OnContextDestroy(Core::Context* context);
00087 
00090         virtual void OnElementCreate(Core::Element* element);
00093         virtual void OnElementDestroy(Core::Element* element);
00094 
00097         virtual void ProcessEvent(Core::Event& event);
00098 
00099 private:
00100         bool LoadFont();
00101         bool LoadMenuElement();
00102         bool LoadInfoElement();
00103         bool LoadLogElement();
00104         bool LoadHookElement();
00105 
00106         // Release all loaded elements
00107         void ReleaseElements();
00108 
00109         // The context hosting the debug documents.
00110         Core::Context* host_context;
00111         // The context we're debugging.
00112         Core::Context* debug_context;
00113 
00114         // The debug elements.
00115         Core::ElementDocument* menu_element;
00116         ElementInfo* info_element;
00117         ElementLog* log_element;
00118         ElementContextHook* hook_element;
00119         SystemInterface* log_hook;
00120 
00121         bool render_outlines;
00122 
00123         // Keep track of instanced elements for leak tracking.
00124         typedef std::set< Core::Element* > ElementInstanceMap;
00125         ElementInstanceMap elements;
00126 };
00127 
00128 }
00129 }
00130 
00131 #endif