/
CmdContext.cpp
352 lines (305 loc) · 11.6 KB
/
CmdContext.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
////////////////////////////////////////////////////////////////////////////////
//
// Copyright 2006 - 2019, Paul Beckingham, Federico Hernandez.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//
// https://www.opensource.org/licenses/mit-license.php
//
////////////////////////////////////////////////////////////////////////////////
#include <cmake.h>
#include <CmdContext.h>
#include <CmdConfig.h>
#include <Table.h>
#include <Context.h>
#include <Filter.h>
#include <sstream>
#include <algorithm>
#include <format.h>
#include <shared.h>
#include <util.h>
////////////////////////////////////////////////////////////////////////////////
CmdContext::CmdContext ()
{
_keyword = "context";
_usage = "task context [<name> | <subcommand>]";
_description = "Set and define contexts (default filters)";
_read_only = true;
_displays_id = false;
_needs_gc = false;
_uses_context = false;
_accepts_filter = false;
_accepts_modifications = false;
_accepts_miscellaneous = true;
_category = Command::Category::context;
}
////////////////////////////////////////////////////////////////////////////////
int CmdContext::execute (std::string& output)
{
std::stringstream out;
// Get the non-attribute, non-fancy command line arguments.
auto words = Context::getContext ().cli2.getWords ();
if (words.size () > 0)
{
auto subcommand = words[0];
if (subcommand == "define") defineContext (words, out);
else if (subcommand == "delete") deleteContext (words, out);
else if (subcommand == "list") listContexts (out);
else if (subcommand == "none") unsetContext (out);
else if (subcommand == "show") showContext (out);
else if (words.size ()) setContext (words, out);
}
else
{
listContexts (out);
out << "Use 'task context none' to unset the current context.";
}
output = out.str ();
return 0;
}
////////////////////////////////////////////////////////////////////////////////
// Joins all the words in the specified interval <from, to) to one string,
// which is then returned.
//
// If to is specified as 0 (default value), all the remaining words will be joined.
//
std::string CmdContext::joinWords (const std::vector <std::string>& words, unsigned int from, unsigned int to /* = 0 */)
{
std::string value = "";
if (to == 0)
to = words.size();
for (unsigned int i = from; i < to; ++i)
{
if (i > from)
value += ' ';
value += words[i];
}
return value;
}
////////////////////////////////////////////////////////////////////////////////
// Returns all user defined contexts.
//
std::vector <std::string> CmdContext::getContexts ()
{
std::vector <std::string> contexts;
for (auto& name : Context::getContext ().config)
if (name.first.substr (0, 8) == "context.")
contexts.push_back (name.first.substr (8));
return contexts;
}
////////////////////////////////////////////////////////////////////////////////
// Defines a new user-provided context.
// - The context definition is written into .taskrc as a context.<name> variable.
// - Deletion of the context requires confirmation if rc.confirmation=yes.
//
// Returns: 0 if the addition of the config variable was successful, 1 otherwise
//
// Invoked with: task context define <name> <filter>
// Example: task context define home project:Home
//
void CmdContext::defineContext (const std::vector <std::string>& words, std::stringstream& out)
{
auto confirmation = Context::getContext ().config.getBoolean ("confirmation");
if (words.size () > 2)
{
auto name = "context." + words[1];
auto value = joinWords (words, 2);
// Make sure nobody creates a context with name 'list', 'none' or 'show'
if (words[1] == "none" or words[1] == "list" or words[1] == "show")
{
throw format ("The name '{1}' is reserved and not allowed to use as a context name.", words[1]);
}
// Check if the value is a proper filter by filtering current pending.data
Filter filter;
std::vector <Task> filtered;
auto pending = Context::getContext ().tdb2.pending.get_tasks ();
try
{
// This result is not used, and is just to check validity.
Context::getContext ().cli2.addFilter (value);
filter.subset (pending, filtered);
}
catch (std::string exception)
{
throw format ("Filter validation failed: {1}", exception);
}
// Make user explicitly confirm filters that are matching no pending tasks
if (filtered.size () == 0)
if (confirmation &&
! confirm (format ("The filter '{1}' matches 0 pending tasks. Do you wish to continue?", value)))
throw std::string ("Context definition aborted.");
// Set context definition config variable
bool success = CmdConfig::setConfigVariable (name, value, confirmation);
if (!success)
throw format ("Context '{1}' not defined.", words[1]);
out << format ("Context '{1}' defined. Use 'task context {1}' to activate.\n", words[1]);
}
else
throw std::string ("Both context name and its definition must be provided.");
}
////////////////////////////////////////////////////////////////////////////////
// Deletes the specified context.
// - If the deleted context is currently active, unset it.
// - Deletion of the context requires confirmation if rc.confirmation=yes.
//
// Returns: 0 if the removal of the config variable was successful, 1 otherwise
//
// Invoked with: task context delete <name>
// Example: task context delete home
//
void CmdContext::deleteContext (const std::vector <std::string>& words, std::stringstream& out)
{
if (words.size () > 1)
{
// Delete the specified context
auto name = "context." + words[1];
auto confirmation = Context::getContext ().config.getBoolean ("confirmation");
auto rc = CmdConfig::unsetConfigVariable(name, confirmation);
// If the currently set context was deleted, unset it
if (Context::getContext ().config.get ("context") == words[1])
CmdConfig::unsetConfigVariable("context", false);
// Output feedback
if (rc != 0)
throw format ("Context '{1}' not deleted.", words[1]);
out << format ("Context '{1}' deleted.\n", words[1]);
}
else
throw std::string("Context name needs to be specified.");
}
////////////////////////////////////////////////////////////////////////////////
// Render a list of context names and their definitions.
//
// Returns: 0 the resulting list is non-empty, 1 otherwise
//
// Invoked with: task context list
// Example: task context list
//
void CmdContext::listContexts (std::stringstream& out)
{
auto contexts = getContexts();
if (contexts.size ())
{
std::sort (contexts.begin (), contexts.end ());
Table table;
table.width (Context::getContext ().getWidth ());
table.add ("Name");
table.add ("Definition");
table.add ("Active");
setHeaderUnderline (table);
std::string activeContext = Context::getContext ().config.get ("context");
for (auto& userContext : contexts)
{
std::string active = "no";
if (userContext == activeContext)
active = "yes";
int row = table.addRow ();
table.set (row, 0, userContext);
table.set (row, 1, Context::getContext ().config.get ("context." + userContext));
table.set (row, 2, active);
}
out << optionalBlankLine ()
<< table.render ()
<< optionalBlankLine ();
}
else
throw std::string ("No contexts defined.");
}
////////////////////////////////////////////////////////////////////////////////
// Sets the specified context as currently active.
// - If some other context was active, the value of currently active context
// is replaced, not added.
// - Setting of the context does not require confirmation.
//
// Returns: 0 if the setting of the context was successful, 1 otherwise
//
// Invoked with: task context <name>
// Example: task context home
//
void CmdContext::setContext (const std::vector <std::string>& words, std::stringstream& out)
{
auto value = words[0];
auto contexts = getContexts ();
// Check that the specified context is defined
if (std::find (contexts.begin (), contexts.end (), value) == contexts.end ())
throw format ("Context '{1}' not found.", value);
// Set the active context.
// Should always succeed, as we do not require confirmation.
bool success = CmdConfig::setConfigVariable ("context", value, false);
if (! success)
throw format ("Context '{1}' not applied.", value);
out << format ("Context '{1}' set. Use 'task context none' to remove.\n", value);
}
////////////////////////////////////////////////////////////////////////////////
// Shows the currently active context.
//
// Returns: Always returns 0.
//
// Invoked with: task context show
// Example: task context show
//
void CmdContext::showContext (std::stringstream& out)
{
auto currentContext = Context::getContext ().config.get ("context");
if (currentContext == "")
out << "No context is currently applied.\n";
else
{
std::string currentFilter = Context::getContext ().config.get ("context." + currentContext);
out << format ("Context '{1}' with filter '{2}' is currently applied.\n", currentContext, currentFilter);
}
}
////////////////////////////////////////////////////////////////////////////////
// Unsets the currently active context.
// - Unsetting of the context does not require confirmation.
//
// Returns: 0 if the unsetting of the context was successful, 1 otherwise (also
// returned if no context is currently active)
//
// Invoked with: task context none
// Example: task context none
//
void CmdContext::unsetContext (std::stringstream& out)
{
if (CmdConfig::unsetConfigVariable ("context", false))
throw std::string ("Context not unset.");
out << "Context unset.\n";
}
////////////////////////////////////////////////////////////////////////////////
CmdCompletionContext::CmdCompletionContext ()
{
_keyword = "_context";
_usage = "task _context";
_description = "Lists all supported contexts, for completion purposes";
_read_only = true;
_displays_id = false;
_needs_gc = false;
_uses_context = false;
_accepts_filter = false;
_accepts_modifications = false;
_accepts_miscellaneous = false;
_category = Command::Category::internal;
}
////////////////////////////////////////////////////////////////////////////////
int CmdCompletionContext::execute (std::string& output)
{
for (auto& contet : CmdContext::getContexts ())
output += contet + '\n';
return 0;
}
////////////////////////////////////////////////////////////////////////////////