LUMIERA.clone/src/lib/lifecycle.cpp
Ichthyostega 59390cd2f8 Library: reorder some pervasively used includes
reduce footprint of lib/util.hpp
 (Note: it is not possible to forward-declare std::string here)

define the shorthand "cStr()" in lib/symbol.hpp

reorder relevant includes to ensure std::hash is "hijacked" first
2024-03-21 19:57:34 +01:00

122 lines
3.5 KiB
C++

/*
Lifecycle - registering and triggering lifecycle callbacks
Copyright (C) Lumiera.org
2008, Hermann Vosseler <Ichthyostega@web.de>
This program 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.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
* *****************************************************/
/** @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);
}
}