]> Dogcows Code - chaz/yoink/blobdiff - src/Moof/Core.hh
reformatting
[chaz/yoink] / src / Moof / Core.hh
index 109999a7913a26adfe6d16646be19b13a895242d..eaa98b4a474d8f8dad318d9614f13770bba5bbc8 100644 (file)
@@ -1,34 +1,19 @@
 
-/*******************************************************************************
-
- Copyright (c) 2009, Charles McGarvey
- All rights reserved.
- Redistribution   and   use  in  source  and  binary  forms,  with  or  without
- modification, are permitted provided that the following conditions are met:
-   * Redistributions  of  source  code  must retain the above copyright notice,
-     this list of conditions and the following disclaimer.
-   * Redistributions  in binary form must reproduce the above copyright notice,
-     this  list of conditions and the following disclaimer in the documentation
-     and/or other materials provided with the distribution.
- THIS  SOFTWARE  IS  PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- AND  ANY  EXPRESS  OR  IMPLIED  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- DISCLAIMED.  IN  NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- FOR  ANY  DIRECT,  INDIRECT,  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- DAMAGES  (INCLUDING,  BUT  NOT  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- SERVICES;  LOSS  OF  USE,  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- CAUSED  AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- OR  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-*******************************************************************************/
+/*]  Copyright (c) 2009-2010, Charles McGarvey  [**************************
+**]  All rights reserved.
+*
+* vi:ts=4 sw=4 tw=75
+*
+* Distributable under the terms and conditions of the 2-clause BSD license;
+* see the file COPYING for a complete text of the license.
+*
+**************************************************************************/
 
 #ifndef _MOOF_CORE_HH_
 #define _MOOF_CORE_HH_
 
+#include <string>
+
 #include <boost/shared_ptr.hpp>
 
 #include <Moof/Dispatch.hh>
@@ -40,12 +25,12 @@ namespace Mf {
 
 
 /**
- * The core is essentially a stack of layers.  While running, it updates each
- * layer from the bottom up every timestep.  It also draws each layer from the
- * bottom up, adhering to the maximum frame-rate.  Events are sent to each layer
- * from the top down until a layer signals the event was handled.  The core is
- * also responsible for firing timers on time.  The core will continue running
- * as long as there are layers on the stack.
+ * The core is essentially a stack of layers.  While running, it updates
+ * each layer from the bottom up every timestep.  It also draws each layer
+ * from the bottom up, adhering to the maximum frame-rate.  Events are sent
+ * to each layer from the top down until a layer signals the event was
+ * handled.  The core is also responsible for firing timers on time.  The
+ * core will continue running as long as there are layers on the stack.
  */
 
 class Core
@@ -61,7 +46,7 @@ public:
 
        void push(LayerP layer);        // push a layer onto the top
        LayerP pop();                           // pop the top layer
-       LayerP pop(Layer* layer);       // pops a specific layer and all layers above it
+       LayerP pop(Layer* layer);       // pops a specific layer and layers above it
        void clear();                           // remove all layers (the core will stop)
 
        int getSize() const;            // get the size of the stack
@@ -70,12 +55,13 @@ public:
        void run();
 
        Dispatch::Handler addHandler(const std::string& event,
-                       const Dispatch::Function& callback);
+                                                                const Dispatch::Function& callback);
        Dispatch::Handler addHandler(const std::string& event,
-                       const Dispatch::Function& callback, Dispatch::Handler handler);
+                                                                const Dispatch::Function& callback,
+                                                                Dispatch::Handler handler);
 
        void dispatch(const std::string& event,
-                       const Dispatch::Message* message = 0);
+                                 const Dispatch::Message* message = 0);
 
 private:
 
@@ -88,9 +74,10 @@ extern Core core;
 
 /*
  * Some classes and subsystems require certain backend libraries to be
- * initialized.  This is the mechanism to accomplish that.  Classes which rely
- * on any backend libraries just need to instantiate this class as a member.
- * Backend cleanup will occur automagically when there are no more instances.
+ * initialized.  This is the mechanism to accomplish that.  Classes which
+ * rely on any backend libraries just need to instantiate this class as a
+ * member.  Backend cleanup will occur automagically when there are no more
+ * instances.
  */
 
 class Backend
@@ -109,5 +96,3 @@ public:
 
 #endif // _MOOF_CORE_HH_
 
-/** vim: set ts=4 sw=4 tw=80: *************************************************/
-
This page took 0.020626 seconds and 4 git commands to generate.