1// Copyright 2011 The Kyua Authors.
2// All rights reserved.
3//
4// Redistribution and use in source and binary forms, with or without
5// modification, are permitted provided that the following conditions are
6// met:
7//
8// * Redistributions of source code must retain the above copyright
9//   notice, this list of conditions and the following disclaimer.
10// * Redistributions in binary form must reproduce the above copyright
11//   notice, this list of conditions and the following disclaimer in the
12//   documentation and/or other materials provided with the distribution.
13// * Neither the name of Google Inc. nor the names of its contributors
14//   may be used to endorse or promote products derived from this software
15//   without specific prior written permission.
16//
17// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29/// \file utils/cmdline/commands_map.hpp
30/// Maintains a collection of dynamically-instantiated commands.
31///
32/// Commands need to be dynamically-instantiated because they are often
33/// complex data structures.  Instantiating them as static variables causes
34/// problems with the order of construction of globals.  The commands_map class
35/// provided by this module provides a mechanism to maintain these instantiated
36/// objects.
37
38#if !defined(UTILS_CMDLINE_COMMANDS_MAP_HPP)
39#define UTILS_CMDLINE_COMMANDS_MAP_HPP
40
41#include "utils/cmdline/commands_map_fwd.hpp"
42
43#include <map>
44#include <memory>
45#include <set>
46#include <string>
47
48#include "utils/noncopyable.hpp"
49
50
51namespace utils {
52namespace cmdline {
53
54
55/// Collection of dynamically-instantiated commands.
56template< typename BaseCommand >
57class commands_map : noncopyable {
58    /// Map of command names to their implementations.
59    typedef std::map< std::string, BaseCommand* > impl_map;
60
61    /// Map of category names to the command names they contain.
62    typedef std::map< std::string, std::set< std::string > > categories_map;
63
64    /// Collection of all available commands.
65    impl_map _commands;
66
67    /// Collection of defined categories and their commands.
68    categories_map _categories;
69
70public:
71    commands_map(void);
72    ~commands_map(void);
73
74    /// Scoped, strictly-owned pointer to a command from this map.
75    typedef typename std::auto_ptr< BaseCommand > command_ptr;
76    void insert(command_ptr, const std::string& = "");
77    void insert(BaseCommand*, const std::string& = "");
78
79    /// Type for a constant iterator.
80    typedef typename categories_map::const_iterator const_iterator;
81
82    bool empty(void) const;
83
84    const_iterator begin(void) const;
85    const_iterator end(void) const;
86
87    BaseCommand* find(const std::string&);
88    const BaseCommand* find(const std::string&) const;
89};
90
91
92}  // namespace cmdline
93}  // namespace utils
94
95
96#endif  // !defined(UTILS_CMDLINE_BASE_COMMAND_HPP)
97