Ichthyostega
8e250839f4
During the last months, a lot of gradual changes to policies and guidelines had been finalised and documented. Moreover, recent clarifications regarding memory management in the render engine will lead to a clearer definition of the »Vault« Layer's role, with some ''engine code'' expected to move down. On this occasion, I reworked relevant sections in the documentation to confirm the role that now falls to central parts of the overall architecture. Notably I decided to rename those parts related to the application backbone as »Vessel« — to underpin the more active and defining role they assumed.
58 lines
1.7 KiB
C++
58 lines
1.7 KiB
C++
/*
|
||
SCRIPTRUNNERFACADE.hpp - access point for running a script within Lumiera application context
|
||
|
||
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 scriptrunnerfacade.hpp
|
||
** Global control interface for script driven operation of Lumiera.
|
||
**
|
||
** @todo this just documents a vague plan. We won't be able to implement
|
||
** anything of that kind for the foreseeable future as of 1/2017
|
||
*/
|
||
|
||
|
||
#ifndef VAULT_INTERFACE_SCRIPTRUNNERFACADE_H
|
||
#define VAULT_INTERFACE_SCRIPTRUNNERFACADE_H
|
||
|
||
|
||
#include "vessel/subsys.hpp"
|
||
|
||
|
||
|
||
namespace vault {
|
||
|
||
|
||
/*******************************************************************//**
|
||
* Interface to the vault layer (TODO 2018 really?) (script runner):
|
||
* Global access point for starting a script within Lumiera application
|
||
* context.
|
||
*
|
||
* @todo build a suitable binding interface and a script runner.
|
||
*
|
||
*/
|
||
struct ScriptRunnerFacade
|
||
{
|
||
/** provide a descriptor for the vessel::Voyage,
|
||
* wired accordingly to allow main to start a script and to
|
||
* (prematurely) abort a running script. */
|
||
static vessel::Subsys& getDescriptor();
|
||
|
||
|
||
//////////////////TODO: define the access interface for starting a (LUA, C, ...)-script
|
||
//////////////////TODO: provide a function for accessing this interface
|
||
|
||
};
|
||
|
||
|
||
|
||
} // namespace vault
|
||
#endif
|