source: trunk/FACT++/src/LocalControl.h@ 13217

Last change on this file since 13217 was 13206, checked in by tbretz, 13 years ago
Pipe comments to the log-file; added the missing jump label.
File size: 6.9 KB
Line 
1#ifndef FACT_LocalControl
2#define FACT_LocalControl
3
4#include <ostream>
5
6// **************************************************************************
7/** @class LocalControl
8
9@brief Implements a local control for a StateMachine based on a Readline class
10
11This template implements all functions which overwrite any function from the
12Readline class needed for a local control of a state machien. Since
13several derivatives of the Readline class implement different kind of
14Readline access, this class can be derived by any of them due to its
15template argument. However, the normal case will be deriving it from
16either Console or Shell.
17
18@tparam T
19 The base class for RemoteControl. Either Readlien or a class
20 deriving from it. This is usually either Console or Shell.
21
22**/
23// **************************************************************************
24#include <boost/version.hpp>
25#include <boost/filesystem.hpp>
26
27#include "tools.h"
28
29#include "WindowLog.h"
30#include "StateMachineImp.h"
31
32using namespace std;
33
34template <class T>
35class LocalControl : public T
36{
37private:
38 char **Completion(const char *text, int pos, int)
39 {
40 return pos>0 ? 0 : T::Complete(fStateMachine->GetEventNames(), text);
41 }
42
43protected:
44 StateMachineImp *fStateMachine;
45
46 std::ostream &lout;
47
48 std::string fName;
49
50 LocalControl(const char *name) : T(name),
51 fStateMachine(0), lout(T::GetStreamIn()),
52#if BOOST_VERSION < 104600
53 fName(boost::filesystem::path(name).filename())
54#else
55 fName(boost::filesystem::path(name).filename().string())
56#endif
57 { }
58
59 bool PrintGeneralHelp()
60 {
61 T::PrintGeneralHelp();
62 lout << " " << kUnderline << "Specific commands:" << endl;
63 lout << kBold << " ac,allowed " << kReset << "Display a list of all currently allowed commands." << endl;
64 lout << kBold << " st,states " << kReset << "Display a list of the available states with description." << endl;
65 lout << kBold << " # <text> " << kReset << "Echo <text> to the output stream" << endl;
66 lout << kBold << " .s " << kReset << "Wait for the state-machine to change to the given state.\n";
67 lout << " " " .s <server> [<state> [<timeout> [<label>]]]\n";
68 lout << " " "<server> The server for which state to wait (e.g. FTM_CONTROL)\n";
69 lout << " " "<state> The state id (see 'states') for which to wait (e.g. 3)\n";
70 lout << " " "<imeout> A timeout in millisenconds how long to wait (e.g. 500)\n";
71 lout << " " "<label> A label until which everything is skipped in case of timeout\n";
72 lout << endl;
73 return true;
74 }
75 bool PrintCommands()
76 {
77 lout << endl << kBold << "List of commands:" << endl;
78 fStateMachine->PrintListOfEvents(lout);
79 lout << endl;
80
81 return true;
82 }
83
84 bool Process(const std::string &str)
85 {
86 if (str.substr(0, 2)=="h " || str.substr(0, 5)=="help ")
87 {
88 lout << endl;
89 fStateMachine->PrintListOfEvents(lout, str.substr(str.find_first_of(' ')+1));
90 lout << endl;
91
92 return true;
93 }
94 if (str=="states" || str=="st")
95 {
96 fStateMachine->PrintListOfStates(lout);
97 return true;
98 }
99 if (str=="allowed" || str=="ac")
100 {
101 lout << endl << kBold << "List of commands allowed in current state:" << endl;
102 fStateMachine->PrintListOfAllowedEvents(lout);
103 lout << endl;
104 return true;
105 }
106
107 if (str.substr(0, 3)==".s ")
108 {
109 istringstream in(str.substr(3));
110
111 int state=-100, ms=0;
112 in >> state >> ms;
113
114 if (state==-100)
115 {
116 lout << kRed << "Couldn't parse state id in '" << str.substr(3) << "'" << endl;
117 return true;
118 }
119
120 const Time timeout = ms<=0 ? Time(Time::none) : Time()+boost::posix_time::millisec(ms);
121
122 const int target = stoi(str.substr(3));
123 while (fStateMachine->GetCurrentState()!=target && timeout>Time())
124 usleep(1);
125
126 if (fStateMachine->GetCurrentState()!=target)
127 {
128 int label = -1;
129 in >> label;
130 T::SetLabel(label);
131 }
132 return true;
133 }
134
135 if (str[0]=='#')
136 {
137 fStateMachine->Comment(Tools::Trim(str.substr(1)));
138 return true;
139 }
140
141 if (T::Process(str))
142 return true;
143
144 return !fStateMachine->PostEvent(lout, str);
145 }
146
147public:
148
149 void SetReceiver(StateMachineImp &imp) { fStateMachine = &imp; }
150};
151
152// **************************************************************************
153/** @class LocalStream
154
155@brief Derives the LocalControl from ConsoleStream
156
157This is basically a LocalControl, which derives through the template
158argument from the ConsoleStream class.
159
160 */
161// **************************************************************************
162#include "Console.h"
163
164class LocalStream : public LocalControl<ConsoleStream>
165{
166public:
167 LocalStream(const char *name, bool null = false)
168 : LocalControl<ConsoleStream>(name) { SetNullOutput(null); }
169};
170
171// **************************************************************************
172/** @class LocalConsole
173
174@brief Derives the LocalControl from Control and adds prompt
175
176This is basically a LocalControl, which derives through the template
177argument from the Console class. It enhances the functionality of
178the local control with a proper updated prompt.
179
180 */
181// **************************************************************************
182#include "tools.h"
183
184class LocalConsole : public LocalControl<Console>
185{
186public:
187 LocalConsole(const char *name, bool continous=false)
188 : LocalControl<Console>(name)
189 {
190 SetContinous(continous);
191 }
192
193 string GetUpdatePrompt() const
194 {
195 return GetLinePrompt()+" "
196 "\033[34m\033[1m"+fName+"\033[0m:"
197 "\033[32m\033[1m"+fStateMachine->GetStateName()+"\033[0m> ";
198 }
199};
200
201// **************************************************************************
202/** @class LocalShell
203
204@brief Derives the LocalControl from Shell and adds a colored prompt
205
206This is basically a LocalControl, which derives through the template
207argument from the Shell class. It enhances the functionality of
208the local control with a proper updated prompt.
209
210 */
211// **************************************************************************
212#include "Shell.h"
213
214class LocalShell : public LocalControl<Shell>
215{
216public:
217 LocalShell(const char *name, bool = false)
218 : LocalControl<Shell>(name) { }
219
220 string GetUpdatePrompt() const
221 {
222 return GetLinePrompt()+' '+fName+':'+fStateMachine->GetStateName()+"> ";
223 }
224};
225
226#endif
Note: See TracBrowser for help on using the repository browser.