1
// CommandParser.hh for Fluxbox - an X11 Window manager
2
// Copyright (c) 2003 - 2005 Henrik Kinnunen (fluxgen at fluxbox dot org)
3
// and Simon Bowden (rathnor at users.sourceforge.net)
5
// Permission is hereby granted, free of charge, to any person obtaining a
6
// copy of this software and associated documentation files (the "Software"),
7
// to deal in the Software without restriction, including without limitation
8
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
9
// and/or sell copies of the Software, and to permit persons to whom the
10
// Software is furnished to do so, subject to the following conditions:
12
// The above copyright notice and this permission notice shall be included in
13
// all copies or substantial portions of the Software.
15
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21
// DEALINGS IN THE SOFTWARE.
23
// $Id: CommandParser.hh 3865 2005-01-24 18:34:57Z mathias $
25
#ifndef COMMANDPARSER_HH
26
#define COMMANDPARSER_HH
31
#include "RefCount.hh"
37
/// Creates commands from command and argument.
38
/// Used for modules to add new commands in compile/run time
39
class CommandFactory {
42
virtual ~CommandFactory();
43
virtual FbTk::Command *stringToCommand(const std::string &command,
44
const std::string &arguments) = 0;
46
void addCommand(const std::string &value);
49
/// Parses text into a command
52
typedef std::map<std::string, CommandFactory *> CommandFactoryMap;
54
/// @return parses and returns a command matching the line
55
FbTk::Command *parseLine(const std::string &line);
57
/// @return instance of command parser
58
static CommandParser &instance();
59
/// @return map of factorys
60
const CommandFactoryMap &factorys() const { return m_commandfactorys; }
62
// so CommandFactory can associate it's commands
63
friend class CommandFactory;
64
/// associate a command with a factory
65
void associateCommand(const std::string &name, CommandFactory &factory);
66
/// remove all associations with the factory
67
void removeAssociation(CommandFactory &factory);
69
/// search for a command in our command factory map
70
FbTk::Command *toCommand(const std::string &command,
71
const std::string &arguments);
73
CommandFactoryMap m_commandfactorys; ///< a string to factory map
77
#endif // COMMANDPARSER_HH