Ichthyostega
806db414dd
* Lumiera source code always was copyrighted by individual contributors * there is no entity "Lumiera.org" which holds any copyrights * Lumiera source code is provided under the GPL Version 2+ == Explanations == Lumiera as a whole is distributed under Copyleft, GNU General Public License Version 2 or above. For this to become legally effective, the ''File COPYING in the root directory is sufficient.'' The licensing header in each file is not strictly necessary, yet considered good practice; attaching a licence notice increases the likeliness that this information is retained in case someone extracts individual code files. However, it is not by the presence of some text, that legally binding licensing terms become effective; rather the fact matters that a given piece of code was provably copyrighted and published under a license. Even reformatting the code, renaming some variables or deleting parts of the code will not alter this legal situation, but rather creates a derivative work, which is likewise covered by the GPL! The most relevant information in the file header is the notice regarding the time of the first individual copyright claim. By virtue of this initial copyright, the first author is entitled to choose the terms of licensing. All further modifications are permitted and covered by the License. The specific wording or format of the copyright header is not legally relevant, as long as the intention to publish under the GPL remains clear. The extended wording was based on a recommendation by the FSF. It can be shortened, because the full terms of the license are provided alongside the distribution, in the file COPYING.
113 lines
3.2 KiB
C++
113 lines
3.2 KiB
C++
/*
|
||
Lifecycle - registering and triggering lifecycle callbacks
|
||
|
||
Copyright (C)
|
||
2008, Hermann Vosseler <Ichthyostega@web.de>
|
||
|
||
**Lumiera** is free software; you can redistribute it and/or modify it
|
||
under the terms of the GNU General Public License as published by the
|
||
Free Software Foundation; either version 2 of the License, or (at your
|
||
option) any later version. See the file COPYING for further details.
|
||
|
||
* *****************************************************************/
|
||
|
||
|
||
/** @file lifecycle.cpp
|
||
** Implementation of installable callbacks for lifecycle events.
|
||
*/
|
||
|
||
|
||
#include "lib/error.hpp"
|
||
#include "include/lifecycle.h"
|
||
#include "lib/lifecycleregistry.hpp"
|
||
#include "lib/util.hpp"
|
||
|
||
|
||
|
||
|
||
namespace lumiera {
|
||
|
||
// ==== implementation Lifecycle Registry =======
|
||
|
||
/** @remark since the LifecycleRegistry is used to implement
|
||
* the most basic initialisation, we need to ensure it is fully initialised
|
||
* as early as possible. Especially we can not use lib::Depend for that purpose,
|
||
* since the latter needs the LifecycleRegistry to pull up the NoBug-Library.
|
||
* More specifically, if we `#include "lib/depend.hpp"`, on static initialisation
|
||
* the handle planted within that include would invoke `DependencyFactory<LifecycleRegistry>`,
|
||
* which is defined later in the same header and thus not yet initialised.
|
||
*/
|
||
LifecycleRegistry&
|
||
LifecycleRegistry::instance()
|
||
{
|
||
static LifecycleRegistry theRegistry;
|
||
return theRegistry; // Meyer's singleton
|
||
}
|
||
|
||
|
||
|
||
// ==== implementation LifecycleHook class =======
|
||
|
||
typedef LifecycleRegistry::Hook Callback;
|
||
|
||
|
||
LifecycleHook::LifecycleHook (Symbol eventLabel, Callback callbackFun)
|
||
{
|
||
add (eventLabel,callbackFun);
|
||
}
|
||
|
||
void
|
||
LifecycleHook::add (Symbol eventLabel, Callback callbackFun)
|
||
{
|
||
bool isNew = LifecycleRegistry::instance().enrol (eventLabel,callbackFun);
|
||
|
||
if (isNew and eventLabel == ON_BASIC_INIT)
|
||
callbackFun(); // when this code executes,
|
||
// then per definition we are already post "basic init"
|
||
// (which happens in the AppState ctor); thus fire it immediately
|
||
}
|
||
|
||
|
||
void
|
||
LifecycleHook::trigger (Symbol eventLabel)
|
||
{
|
||
LifecycleRegistry::instance().execute (eventLabel);
|
||
}
|
||
|
||
|
||
|
||
const char * ON_BASIC_INIT ("ON_BASIC_INIT");
|
||
const char * ON_GLOBAL_INIT ("ON_GLOBAL_INIT");
|
||
const char * ON_GLOBAL_SHUTDOWN ("ON_GLOBAL_SHUTDOWN");
|
||
|
||
const char * ON_EMERGENCY ("ON_EMERGENCY");
|
||
|
||
|
||
} // namespace lumiera
|
||
|
||
|
||
extern "C" { /* ==== implementation C interface for lifecycle hooks ======= */
|
||
|
||
|
||
const char * lumiera_ON_BASIC_INIT = lumiera::ON_BASIC_INIT;
|
||
const char * lumiera_ON_GLOBAL_INIT = lumiera::ON_GLOBAL_INIT;
|
||
const char * lumiera_ON_GLOBAL_SHUTDOWN = lumiera::ON_GLOBAL_SHUTDOWN;
|
||
|
||
const char * lumiera_ON_EMERGENCY = lumiera::ON_EMERGENCY;
|
||
|
||
|
||
|
||
void
|
||
lumiera_LifecycleHook_add (const char* eventLabel, void callbackFun(void))
|
||
{
|
||
lumiera::LifecycleHook (eventLabel, callbackFun);
|
||
}
|
||
|
||
|
||
void
|
||
lumiera_Lifecycle_trigger (const char* eventLabel)
|
||
{
|
||
lumiera::LifecycleRegistry::instance().execute (eventLabel);
|
||
}
|
||
|
||
}
|