summaryrefslogtreecommitdiffstats
path: root/src/uscxml/plugins/EventHandler.h
blob: 5122e9bfd7616713021c68b5d2ec486a22eba321 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
/**
 *  @file
 *  @author     2012-2014 Stefan Radomski (stefan.radomski@cs.tu-darmstadt.de)
 *  @copyright  Simplified BSD
 *
 *  @cond
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the FreeBSD license as published by the FreeBSD
 *  project.
 *
 *  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.
 *
 *  You should have received a copy of the FreeBSD license along with this
 *  program. If not, see <http://www.opensource.org/licenses/bsd-license>.
 *  @endcond
 */

#ifndef EVENTHANDLER_H_2801243E
#define EVENTHANDLER_H_2801243E

#include "uscxml/Common.h"
#include "uscxml/messages/Event.h"

#include <list>
#include <string>
#include <memory>

namespace uscxml {

class InterpreterImpl;

/**
 * @ingroup ioproc
 * @ingroup invoker
 * @ingroup impl
 * Common base class for invokers and i/o processors.
 */

class USCXML_API EventHandlerImpl {
public:
	EventHandlerImpl() {}
	virtual ~EventHandlerImpl() {}

	/**
	 * Return a list of names for types we implement.
	 */
	virtual std::list<std::string> getNames() = 0;

	/**
	 * Export a Data object for the `_x['name']` data-model namespace
	 * @return An object to be represented at `_x['name']`
	 */
	virtual Data getDataModelVariables() = 0;
};

/**
 * @ingroup ioproc
 * @ingroup invoker
 * @ingroup facade
 */
class USCXML_API EventHandler {
public:
	PIMPL_OPERATORS(EventHandler);

	/// @copydoc EventHandlerImpl::getNames
	virtual std::list<std::string> getNames()   {
		return _impl->getNames();
	}

	/// @copydoc EventHandlerImpl::getDataModelVariables
	virtual Data getDataModelVariables() const {
		return _impl->getDataModelVariables();
	};

protected:
	std::shared_ptr<EventHandlerImpl> _impl;
	friend class InterpreterImpl;
};


}


#endif /* end of include guard: EVENTHANDLER_H_2801243E */