|
348
|
1 /* |
|
|
2 * alias.hpp -- create irccdctl aliases |
|
|
3 * |
|
394
|
4 * Copyright (c) 2013-2017 David Demelier <markand@malikania.fr> |
|
348
|
5 * |
|
|
6 * Permission to use, copy, modify, and/or distribute this software for any |
|
|
7 * purpose with or without fee is hereby granted, provided that the above |
|
|
8 * copyright notice and this permission notice appear in all copies. |
|
|
9 * |
|
|
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
|
|
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
|
|
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
|
|
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
|
|
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
|
|
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
|
|
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
|
|
17 */ |
|
|
18 |
|
|
19 #ifndef IRCCD_ALIAS_HPP |
|
|
20 #define IRCCD_ALIAS_HPP |
|
|
21 |
|
|
22 /** |
|
|
23 * \file alias.hpp |
|
|
24 * \brief Create irccdctl aliases. |
|
|
25 */ |
|
|
26 |
|
|
27 #include <ostream> |
|
|
28 #include <string> |
|
|
29 #include <vector> |
|
|
30 |
|
|
31 #include "sysconfig.hpp" |
|
|
32 |
|
|
33 namespace irccd { |
|
|
34 |
|
|
35 /** |
|
|
36 * \brief Describe an alias argument. |
|
|
37 * |
|
|
38 * When the user specify arguments, it can precise an applied argument or a |
|
|
39 * placeholder that will be substituted during command line invocation. |
|
|
40 * |
|
|
41 * Placeholders are placed using %n where n is an integer starting from 0. |
|
|
42 */ |
|
|
43 class AliasArg { |
|
|
44 private: |
|
|
45 std::string m_value; |
|
|
46 bool m_isPlaceholder; |
|
|
47 |
|
|
48 public: |
|
|
49 /** |
|
|
50 * Construct an argument. |
|
|
51 * |
|
|
52 * \pre value must not be empty |
|
|
53 * \param value the value |
|
|
54 */ |
|
|
55 IRCCD_EXPORT AliasArg(std::string value); |
|
|
56 |
|
|
57 /** |
|
|
58 * Check if the argument is a placeholder. |
|
|
59 * |
|
|
60 * \return true if the argument is a placeholder |
|
|
61 */ |
|
|
62 inline bool isPlaceholder() const noexcept |
|
|
63 { |
|
|
64 return m_isPlaceholder; |
|
|
65 } |
|
|
66 |
|
|
67 /** |
|
|
68 * Get the placeholder index (e.g %0 returns 0) |
|
|
69 * |
|
|
70 * \pre isPlaceholder() must return true |
|
|
71 * \return the position |
|
|
72 */ |
|
|
73 IRCCD_EXPORT unsigned index() const noexcept; |
|
|
74 |
|
|
75 /** |
|
|
76 * Get the real value. |
|
|
77 * |
|
|
78 * \pre isPlaceholder() must return false |
|
|
79 * \return the value |
|
|
80 */ |
|
|
81 IRCCD_EXPORT const std::string &value() const noexcept; |
|
|
82 |
|
|
83 /** |
|
|
84 * Output the alias to the stream. |
|
|
85 * |
|
|
86 * \param out the output stream |
|
|
87 * \return out |
|
|
88 */ |
|
|
89 IRCCD_EXPORT friend std::ostream &operator<<(std::ostream &out, const AliasArg &); |
|
|
90 }; |
|
|
91 |
|
|
92 /** |
|
|
93 * \brief Describe a user-provided alias command. |
|
|
94 * |
|
|
95 * An alias command is just a command with a set of applied or placeholders |
|
|
96 * arguments. |
|
|
97 */ |
|
|
98 class AliasCommand { |
|
|
99 private: |
|
|
100 std::string m_command; |
|
|
101 std::vector<AliasArg> m_args; |
|
|
102 |
|
|
103 public: |
|
|
104 /** |
|
|
105 * Create an alias command. |
|
|
106 * |
|
|
107 * \param command the command |
|
|
108 * \param args the arguments |
|
|
109 */ |
|
|
110 inline AliasCommand(std::string command, std::vector<AliasArg> args = {}) noexcept |
|
|
111 : m_command(std::move(command)) |
|
|
112 , m_args(std::move(args)) |
|
|
113 { |
|
|
114 } |
|
|
115 |
|
|
116 /** |
|
|
117 * Get the command to execute. |
|
|
118 * |
|
|
119 * \return the command name |
|
|
120 */ |
|
|
121 inline const std::string &command() const noexcept |
|
|
122 { |
|
|
123 return m_command; |
|
|
124 } |
|
|
125 |
|
|
126 /** |
|
|
127 * Get the arguments. |
|
|
128 * |
|
|
129 * \return the arguments |
|
|
130 */ |
|
|
131 inline const std::vector<AliasArg> &args() const noexcept |
|
|
132 { |
|
|
133 return m_args; |
|
|
134 } |
|
|
135 }; |
|
|
136 |
|
|
137 /** |
|
|
138 * \brief A set of commands to execute with their arguments. |
|
|
139 * |
|
|
140 * An alias is a composition of AliasCommand, typically, the user is able to set |
|
|
141 * an alias that execute a list of specified commands in order they are defined. |
|
|
142 */ |
|
|
143 class Alias : public std::vector<AliasCommand> { |
|
|
144 private: |
|
|
145 std::string m_name; |
|
|
146 |
|
|
147 public: |
|
|
148 /** |
|
|
149 * Create an alias. |
|
|
150 * |
|
|
151 * \param name the alias name |
|
|
152 */ |
|
|
153 inline Alias(std::string name) noexcept |
|
|
154 : m_name(std::move(name)) |
|
|
155 { |
|
|
156 } |
|
|
157 |
|
|
158 /** |
|
|
159 * Get the alias name. |
|
|
160 * |
|
|
161 * \return the name |
|
|
162 */ |
|
|
163 inline const std::string &name() const noexcept |
|
|
164 { |
|
|
165 return m_name; |
|
|
166 } |
|
|
167 }; |
|
|
168 |
|
|
169 } // !irccd |
|
|
170 |
|
|
171 #endif // !IRCCD_ALIAS_HPP |
