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

Last change on this file since 10312 was 10312, checked in by tbretz, 10 years ago
Some updates to the output of help messages.
File size: 3.6 KB
Line 
1#ifndef FACT_LocalControl
2#define FACT_LocalControl
3
4#include <ostream>
5
6class StateMachineImp;
7
8// **************************************************************************
9/** @class LocalControl
10
11@brief Implements a local control for a StateMachine based on a Readline class
12
13This template implements all functions which overwrite any function from the
14Readline class needed for a local control of a state machien. Since
15several derivatives of the Readline class implement different kind of
16Readline access, this class can be derived by any of them due to its
17template argument. However, the normal case will be deriving it from
18either Console or Shell.
19
20@tparam T
21   The base class for RemoteControl. Either Readlien or a class
22   deriving from it. This is usually either Console or Shell.
23
24**/
25// **************************************************************************
26#include <boost/filesystem.hpp>
27
28#include "WindowLog.h"
29#include "StateMachineImp.h"
30
31using namespace std;
32
33template <class T>
34class LocalControl : public T
35{
36private:
37    char **Completion(const char *text, int pos, int)
38    {
39        return pos>0 ? 0 : T::Complete(fStateMachine->GetEventNames(), text);
40    }
41
42protected:
43    StateMachineImp *fStateMachine;
44
45    std::ostream &lout;
46
47    std::string fName;
48
49    LocalControl(const char *name) : T(name), 
50        fStateMachine(0), lout(T::GetStreamIn()),
51        fName(boost::filesystem::path(name).filename())
52    { }
53
54    bool PrintGeneralHelp()
55    {
56        T::PrintGeneralHelp();
57        lout << " " << kUnderline << "Specific commands:" << endl;
58        lout << kBold << "   st,states    " << kReset << "Display a list of the available states with description." << endl;
59        lout << endl;
60        return true;
61    }
62    bool PrintCommands()
63    {
64        lout << endl << kBold << "List of commands:" << endl;
65        fStateMachine->PrintListOfEvents(lout);
66        lout << endl;
67
68        return true;
69    }
70
71    bool Process(const std::string &str)
72    {
73        if (str=="states" || str=="st")
74        {
75            if (fStateMachine)
76                fStateMachine->PrintListOfStates(lout);
77            return true;
78        }
79
80        if (T::Process(str))
81            return true;
82
83        return !fStateMachine->PostEvent(lout, str);
84    }
85
86public:
87
88    void SetReceiver(StateMachineImp &imp) { fStateMachine = &imp; }
89};
90
91// **************************************************************************
92/** @class LocalConsole
93
94@brief Derives the LocalControl from Control and adds prompt
95
96This is basically a LocalControl, which derives through the template
97argument from the Console class. It enhances the functionality of
98the local control with a proper updated prompt.
99
100 */
101// **************************************************************************
102#include "Console.h"
103#include "tools.h"
104
105class LocalConsole : public LocalControl<Console>
106{
107public:
108    LocalConsole(const char *name, bool continous=false)
109        : LocalControl<Console>(name)
110    {
111        SetContinous(continous);
112    }
113
114    string GetUpdatePrompt() const;
115};
116
117// **************************************************************************
118/** @class LocalShell
119
120@brief Derives the LocalControl from Shell and adds a colored prompt
121
122This is basically a LocalControl, which derives through the template
123argument from the Shell class. It enhances the functionality of
124the local control with a proper updated prompt.
125
126 */
127// **************************************************************************
128#include "Shell.h"
129
130class LocalShell : public LocalControl<Shell>
131{
132public:
133    LocalShell(const char *name, bool = false)
134        : LocalControl<Shell>(name) { }
135
136    string GetUpdatePrompt() const;
137};
138
139#endif
Note: See TracBrowser for help on using the repository browser.