|
0
|
1 /* |
|
|
2 * alias.h -- create irccdctl aliases |
|
|
3 * |
|
|
4 * Copyright (c) 2013-2016 David Demelier <markand@malikania.fr> |
|
|
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 _IRCCDCTL_ALIAS_H_ |
|
|
20 #define _IRCCDCTL_ALIAS_H_ |
|
|
21 |
|
|
22 #include <ostream> |
|
|
23 #include <string> |
|
|
24 #include <vector> |
|
|
25 |
|
|
26 namespace irccd { |
|
|
27 |
|
|
28 /** |
|
|
29 * @class AliasArg |
|
|
30 * @brief Describe an alias argument. |
|
|
31 * |
|
|
32 * When the user specify arguments, it can precise an applied argument or a placeholder that will be substituted |
|
|
33 * during command line invocation. |
|
|
34 * |
|
|
35 * Placeholders are placed using %n where n is an integer starting from 0. |
|
|
36 */ |
|
|
37 class AliasArg { |
|
|
38 private: |
|
|
39 std::string m_value; |
|
|
40 bool m_isPlaceholder; |
|
|
41 |
|
|
42 public: |
|
|
43 /** |
|
|
44 * Construct an argument. |
|
|
45 * |
|
|
46 * @pre value must not be empty |
|
|
47 * @param value the value |
|
|
48 */ |
|
|
49 AliasArg(std::string value); |
|
|
50 |
|
|
51 /** |
|
|
52 * Check if the argument is a placeholder. |
|
|
53 * |
|
|
54 * @return true if the argument is a placeholder |
|
|
55 */ |
|
|
56 inline bool isPlaceholder() const noexcept |
|
|
57 { |
|
|
58 return m_isPlaceholder; |
|
|
59 } |
|
|
60 |
|
|
61 /** |
|
|
62 * Get the placeholder index (e.g %0 returns 0) |
|
|
63 * |
|
|
64 * @pre isPlaceholder() must return true |
|
|
65 * @return the position |
|
|
66 */ |
|
|
67 unsigned index() const noexcept; |
|
|
68 |
|
|
69 /** |
|
|
70 * Get the real value. |
|
|
71 * |
|
|
72 * @pre isPlaceholder() must return false |
|
|
73 * @return the value |
|
|
74 */ |
|
|
75 const std::string &value() const noexcept; |
|
|
76 |
|
|
77 friend std::ostream &operator<<(std::ostream &out, const AliasArg &); |
|
|
78 }; |
|
|
79 |
|
|
80 /** |
|
|
81 * @class AliasCommand |
|
|
82 * @brief Describe a user-provided alias command. |
|
|
83 * |
|
|
84 * An alias command is just a command with a set of applied or placeholders arguments. |
|
|
85 */ |
|
|
86 class AliasCommand { |
|
|
87 private: |
|
|
88 std::string m_command; |
|
|
89 std::vector<AliasArg> m_args; |
|
|
90 |
|
|
91 public: |
|
|
92 /** |
|
|
93 * Create an alias command. |
|
|
94 * |
|
|
95 * @param command the command |
|
|
96 * @param args the arguments |
|
|
97 */ |
|
|
98 inline AliasCommand(std::string command, std::vector<AliasArg> args = {}) noexcept |
|
|
99 : m_command(std::move(command)) |
|
|
100 , m_args(std::move(args)) |
|
|
101 { |
|
|
102 } |
|
|
103 |
|
|
104 /** |
|
|
105 * Get the command to execute. |
|
|
106 * |
|
|
107 * @return the command name |
|
|
108 */ |
|
|
109 inline const std::string &command() const noexcept |
|
|
110 { |
|
|
111 return m_command; |
|
|
112 } |
|
|
113 |
|
|
114 /** |
|
|
115 * Get the arguments. |
|
|
116 * |
|
|
117 * @return the arguments |
|
|
118 */ |
|
|
119 inline const std::vector<AliasArg> &args() const noexcept |
|
|
120 { |
|
|
121 return m_args; |
|
|
122 } |
|
|
123 }; |
|
|
124 |
|
|
125 /** |
|
|
126 * @class Alias |
|
|
127 * @brief A set of commands to execute with their arguments. |
|
|
128 * |
|
|
129 * An alias is a composition of AliasCommand, typically, the user is able to set an alias that execute a list of |
|
|
130 * specified commands in order they are defined. |
|
|
131 */ |
|
|
132 class Alias : public std::vector<AliasCommand> { |
|
|
133 private: |
|
|
134 std::string m_name; |
|
|
135 |
|
|
136 public: |
|
|
137 /** |
|
|
138 * Create an alias. |
|
|
139 * |
|
|
140 * @param name the alias name |
|
|
141 */ |
|
|
142 inline Alias(std::string name) noexcept |
|
|
143 : m_name(std::move(name)) |
|
|
144 { |
|
|
145 } |
|
|
146 |
|
|
147 /** |
|
|
148 * Get the alias name. |
|
|
149 * |
|
|
150 * @return the name |
|
|
151 */ |
|
|
152 inline const std::string &name() const noexcept |
|
|
153 { |
|
|
154 return m_name; |
|
|
155 } |
|
|
156 }; |
|
|
157 |
|
|
158 } // !irccd |
|
|
159 |
|
|
160 #endif // !_IRCCDCTL_ALIAS_H_ |
