lumiera_/src/backend/scriptrunnerfacade.hpp
Ichthyostega 48e9b7594a Doxygen: identify all files lacking a @file comment
reason is, only files with a @file comment will be processed
with further documentation commands. For this reason, our Doxygen
documentation is lacking a lot of entries.

HOWTO:
find src -type f \( -name '*.cpp' -or -name '*.hpp' \) -not -exec egrep -q '\*.+@file' {} \; -print -exec sed -i -r -e'\_\*/_,$ { 1,+0 a\
\
\
/** @file §§§\
 ** TODO §§§\
 */
}' {} \;
2016-11-03 18:20:10 +01:00

64 lines
1.8 KiB
C++

/*
SCRIPTRUNNERFACADE.hpp - access point for running a script within Lumiera application context
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 §§§
** TODO §§§
*/
#ifndef BACKEND_INTERFACE_SCRIPTRUNNERFACADE_H
#define BACKEND_INTERFACE_SCRIPTRUNNERFACADE_H
#include "common/subsys.hpp"
namespace backend {
/*******************************************************************//**
* Interface to the backend layer (script runner):
* Global access point for starting a script within Lumiera application
* context.
*
* @todo build the (LUA,C)-script runner.
*
*/
struct ScriptRunnerFacade
{
/** provide a descriptor for lumiera::AppState,
* wired accordingly to allow main to start a script and to
* (prematurely) abort a running script. */
static lumiera::Subsys& getDescriptor();
//////////////////TODO: define the access interface for starting a (LUA, C, ...)-script
//////////////////TODO: provide a function for accessing this interface
};
} // namespace backend
#endif