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.
101 lines
3.4 KiB
C++
101 lines
3.4 KiB
C++
/*
|
||
LIFECYCLE.h - interface for 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.h
|
||
** Installing and invoking of application lifecycle event callbacks.
|
||
** This service is a facade for and implemented by the lumiera::LifecycleRegistry.
|
||
** By placing a static LifecycleHook variable or by calling LifecycleHook::add,
|
||
** a callback can be registered to be executed on a specific application lifecycle
|
||
** event. Examples being #ON_BASIC_INIT, #ON_GLOBAL_INIT. Other subsystems may
|
||
** register additional events for more specific purpose.
|
||
**
|
||
** @note the implementation resides in lib/lifecycle.cpp and gets linked into liblumiera.so
|
||
** @see lumiera::AppState
|
||
** @see main.cpp
|
||
*/
|
||
|
||
|
||
#ifndef LUMIERA_LIFECYCLE_H
|
||
#define LUMIERA_LIFECYCLE_H
|
||
|
||
|
||
#ifdef __cplusplus
|
||
|
||
#include "lib/symbol.hpp"
|
||
#include "lib/nocopy.hpp"
|
||
|
||
|
||
|
||
namespace lumiera {
|
||
|
||
using lib::Symbol;
|
||
|
||
//defined in liblumiera.so
|
||
extern const char * ON_BASIC_INIT; ///< automatic static init. treated specially to run as soon as possible
|
||
extern const char * ON_GLOBAL_INIT; ///< to be triggered in main() @note no magic!
|
||
extern const char * ON_GLOBAL_SHUTDOWN; ///< to be triggered at the end of main() @note no magic!
|
||
|
||
extern const char * ON_EMERGENCY; ///< activated on shutdown after premature failure of a subsystem
|
||
|
||
|
||
// client code is free to register and use additional lifecycle events
|
||
|
||
|
||
|
||
/**
|
||
* define and register a callback for a specific lifecycle event.
|
||
* The purpose of this class is to be defined as a static variable in the implementation
|
||
* of some subsystem (i.e. in the cpp file), providing the ctor with the pointer to a
|
||
* callback function. Thus the specified callback gets enrolled when the corresponding
|
||
* object file is loaded. The event ON_BASIC_INIT is handled specifically, firing off the
|
||
* referred callback function as soon as possible. All other labels are just arbitrary (string)
|
||
* constants and it is necessary that "someone" cares to fire off the lifecycle events
|
||
* at the right place. For example, lumiera-main (and the test runner) calls
|
||
* \c LifecycleHook::trigger(ON_GLOBAL_INIT) (and..SHUTDOWN)
|
||
* @note duplicate or repeated calls with the same callback are NOP
|
||
*/
|
||
class LifecycleHook
|
||
: util::NonCopyable
|
||
{
|
||
public:
|
||
typedef void (*Hook)(void);
|
||
|
||
LifecycleHook (Symbol eventLabel, Hook callbackFun);
|
||
|
||
/** alternative, static interface for registering a callback */
|
||
static void add (Symbol eventLabel, Hook callbackFun);
|
||
|
||
/** trigger lifecycle callbacks registered under the given label */
|
||
static void trigger (Symbol eventLabel);
|
||
};
|
||
|
||
|
||
|
||
} // namespace lumiera
|
||
|
||
|
||
|
||
#else /* =========== C interface ====================== */
|
||
|
||
|
||
//defined in liblumiera.so
|
||
extern const char * lumiera_ON_BASIC_INIT;
|
||
extern const char * lumiera_ON_GLOBAL_INIT;
|
||
extern const char * lumiera_ON_GLOBAL_SHUTDOWN;
|
||
|
||
|
||
void lumiera_LifecycleHook_add (const char* eventLabel, void callbackFun(void));
|
||
void lumiera_Lifecycle_trigger (const char* eventLabel);
|
||
|
||
#endif
|
||
#endif
|