Merge branch '2.4.2' into lexer2

src/commands/CMakeLists.txt

@@ -18,6 +18,7 @@ set (commands_SRCS Command.cpp        Command.h
                    CmdColor.cpp       CmdColor.h
                    CmdColumns.cpp     CmdColumns.h
                    CmdConfig.cpp      CmdConfig.h
+                   CmdContext.cpp     CmdContext.h
                    CmdCount.cpp       CmdCount.h
                    CmdCustom.cpp      CmdCustom.h
                    CmdDelete.cpp      CmdDelete.h

src/commands/CmdConfig.cpp

@@ -46,6 +46,100 @@ CmdConfig::CmdConfig ()
   _displays_id = false;
 }
 
+////////////////////////////////////////////////////////////////////////////////
+bool CmdConfig::setConfigVariable (std::string name, std::string value, bool confirmation /* = false */)
+{
+  // Read .taskrc (or equivalent)
+  std::vector <std::string> contents;
+  File::read (context.config._original_file, contents);
+
+  bool found = false;
+  bool change = false;
+
+  std::vector <std::string>::iterator line;
+  for (line = contents.begin (); line != contents.end (); ++line)
+  {
+    // If there is a comment on the line, it must follow the pattern.
+    std::string::size_type comment = line->find ("#");
+    std::string::size_type pos     = line->find (name + "=");
+
+    if (pos != std::string::npos &&
+        (comment == std::string::npos ||
+         comment > pos))
+    {
+      found = true;
+      if (!confirmation ||
+          confirm (format (STRING_CMD_CONFIG_CONFIRM, name, context.config.get (name), value)))
+      {
+        if (comment != std::string::npos)
+          *line = name + "=" + json::encode (value) + " " + line->substr (comment);
+        else
+          *line = name + "=" + json::encode (value);
+
+        change = true;
+      }
+    }
+  }
+
+  // Not found, so append instead.
+  if (!found &&
+      (!confirmation ||
+       confirm (format (STRING_CMD_CONFIG_CONFIRM2, name, value))))
+  {
+    contents.push_back (name + "=" + json::encode (value));
+    change = true;
+  }
+
+  if (change)
+    File::write (context.config._original_file, contents);
+
+  return change;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+int CmdConfig::unsetConfigVariable (std::string name, bool confirmation /* = false */)
+{
+  // Read .taskrc (or equivalent)
+  std::vector <std::string> contents;
+  File::read (context.config._original_file, contents);
+
+  bool found = false;
+  bool change = false;
+
+  std::vector <std::string>::iterator line;
+  for (line = contents.begin (); line != contents.end (); ++line)
+  {
+    // If there is a comment on the line, it must follow the pattern.
+    std::string::size_type comment = line->find ("#");
+    std::string::size_type pos     = line->find (name + "=");
+
+    if (pos != std::string::npos &&
+        (comment == std::string::npos ||
+         comment > pos))
+    {
+      found = true;
+
+      // Remove name
+      if (!confirmation ||
+          confirm (format (STRING_CMD_CONFIG_CONFIRM3, name)))
+      {
+        *line = "";
+        change = true;
+      }
+    }
+  }
+
+  if (change)
+    File::write (context.config._original_file, contents);
+
+  if ( change && found )
+    return 0;
+  else if ( found )
+    return 1;
+  else
+    return 2;
+}
+
 ////////////////////////////////////////////////////////////////////////////////
 int CmdConfig::execute (std::string& output)
 {
@@ -62,10 +156,13 @@ int CmdConfig::execute (std::string& output)
   if (words.size ())
   {
     bool confirmation = context.config.getBoolean ("confirmation");
+    bool change = false;
+    bool found = false;
 
     std::string name = words[0];
     std::string value = "";
 
+    // Join the remaining words into config variable's value
     if (words.size () > 1)
     {
       for (unsigned int i = 1; i < words.size (); ++i)
@@ -81,85 +178,30 @@ int CmdConfig::execute (std::string& output)
     {
       bool change = false;
 
-      // Read .taskrc (or equivalent)
-      std::vector <std::string> contents;
-      File::read (context.config._original_file, contents);
-
       // task config name value
       // task config name ""
       if (words.size () > 1)
-      {
-        bool found = false;
-        std::vector <std::string>::iterator line;
-        for (line = contents.begin (); line != contents.end (); ++line)
-        {
-          // If there is a comment on the line, it must follow the pattern.
-          std::string::size_type comment = line->find ("#");
-          std::string::size_type pos     = line->find (name + "=");
-
-          if (pos != std::string::npos &&
-              (comment == std::string::npos ||
-               comment > pos))
-          {
-            found = true;
-            if (!confirmation ||
-                confirm (format (STRING_CMD_CONFIG_CONFIRM, name, context.config.get (name), value)))
-            {
-              if (comment != std::string::npos)
-                *line = name + "=" + json::encode (value) + " " + line->substr (comment);
-              else
-                *line = name + "=" + json::encode (value);
-
-              change = true;
-            }
-          }
-        }
-
-        // Not found, so append instead.
-        if (!found &&
-            (!confirmation ||
-             confirm (format (STRING_CMD_CONFIG_CONFIRM2, name, value))))
-        {
-          contents.push_back (name + "=" + json::encode (value));
-          change = true;
-        }
-      }
+        change = setConfigVariable(name, value, confirmation);
 
       // task config name
       else
       {
-        bool found = false;
-        std::vector <std::string>::iterator line;
-        for (line = contents.begin (); line != contents.end (); ++line)
+        rc = unsetConfigVariable(name, confirmation);
+        if (rc == 0)
         {
-          // If there is a comment on the line, it must follow the pattern.
-          std::string::size_type comment = line->find ("#");
-          std::string::size_type pos     = line->find (name + "=");
-
-          if (pos != std::string::npos &&
-              (comment == std::string::npos ||
-               comment > pos))
-          {
-            found = true;
-
-            // Remove name
-            if (!confirmation ||
-                confirm (format (STRING_CMD_CONFIG_CONFIRM3, name)))
-            {
-              *line = "";
-              change = true;
-            }
-          }
+          change = true;
+          found = true;
         }
+        else if (rc == 1)
+          found = true;
 
         if (!found)
           throw format (STRING_CMD_CONFIG_NO_ENTRY, name);
       }
 
-      // Write .taskrc (or equivalent)
+      // Show feedback depending on whether .taskrc has been rewritten
       if (change)
       {
-        File::write (context.config._original_file, contents);
         out << format (STRING_CMD_CONFIG_FILE_MOD,
                        context.config._original_file._data)
             << "\n";

src/commands/CmdConfig.h

@@ -34,6 +34,8 @@ class CmdConfig : public Command
 {
 public:
   CmdConfig ();
+  static bool setConfigVariable (std::string name, std::string value, bool confirmation = false);
+  static int unsetConfigVariable (std::string name, bool confirmation = false);
   int execute (std::string&);
 };
 

src/commands/CmdContext.cpp

@@ -0,0 +1,351 @@
+////////////////////////////////////////////////////////////////////////////////
+//
+// Copyright 2006 - 2015, 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.
+//
+// http://www.opensource.org/licenses/mit-license.php
+//
+////////////////////////////////////////////////////////////////////////////////
+
+#include <cmake.h>
+#include <Context.h>
+#include <sstream>
+#include <algorithm>
+#include <i18n.h>
+#include <text.h>
+#include <CmdContext.h>
+#include <CmdConfig.h>
+
+extern Context context;
+
+////////////////////////////////////////////////////////////////////////////////
+CmdContext::CmdContext ()
+{
+  _keyword     = "context";
+  _usage       = "task          context [<name> | subcommand]";
+  _description = STRING_CMD_CONTEXT_USAGE;
+  _read_only   = true;
+  _displays_id = false;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+int CmdContext::execute (std::string& output)
+{
+  int rc = 0;
+  std::stringstream out;
+
+  // Get the non-attribute, non-fancy command line arguments.
+  std::vector <std::string> words = context.cli.getWords ();
+
+  if (words.size () > 0)
+  {
+    std::string subcommand = words[0];
+
+    if (subcommand == "define")
+      rc = defineContext (words, out);
+    else if (subcommand == "delete")
+      rc = deleteContext (words, out);
+    else if (subcommand == "list")
+      rc = listContexts (words, out);
+    else if (subcommand == "none")
+      rc = unsetContext (words, out);
+    else if (subcommand == "show")
+      rc = showContext (words, out);
+    else
+      rc = setContext (words, out);
+  }
+
+  output = out.str ();
+  return rc;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+// 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 (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;
+
+  Config::const_iterator name;
+  for (name = context.config.begin (); name != context.config.end (); ++name)
+    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
+//
+int CmdContext::defineContext (std::vector <std::string>& words, std::stringstream& out)
+{
+  int rc = 0;
+
+  if (words.size () > 2)
+  {
+    std::string name = "context." + words[1];
+    std::string value = joinWords (words, 2);
+    // TODO: Check if the value is a proper filter
+
+    // Set context definition config variable
+    bool confirmation = context.config.getBoolean ("confirmation");
+    bool success = CmdConfig::setConfigVariable (name, value, confirmation);
+
+    if (success)
+      out << format (STRING_CMD_CONTEXT_DEF_SUCC, words[1]) << "\n";
+    else
+    {
+      out << format (STRING_CMD_CONTEXT_DEF_FAIL, words[1]) << "\n";
+      rc = 1;
+    }
+  }
+  else
+    throw STRING_CMD_CONTEXT_DEF_USAG;
+
+  return rc;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+// 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
+//
+int CmdContext::deleteContext (std::vector <std::string>& words, std::stringstream& out)
+{
+  int rc = 0;
+
+  if (words.size () > 1)
+  {
+    // Delete the specified context
+    std::string name = "context." + words[1];
+
+    bool confirmation = context.config.getBoolean ("confirmation");
+    rc = CmdConfig::unsetConfigVariable(name, confirmation);
+
+    // If the currently set context was deleted, unset it
+    std::string currentContext = context.config.get ("context");
+
+    if (currentContext == words[1])
+      CmdConfig::unsetConfigVariable("context", false);
+
+    // Output feedback
+    if (rc == 0)
+      out << format (STRING_CMD_CONTEXT_DEL_SUCC, words[1]) << "\n";
+    else
+      out << format (STRING_CMD_CONTEXT_DEL_FAIL, words[1]) << "\n";
+  }
+  else
+    throw STRING_CMD_CONTEXT_DEL_USAG;
+
+  return rc;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+// 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
+//
+int CmdContext::listContexts (std::vector <std::string>& words, std::stringstream& out)
+{
+  int rc = 0;
+  std::vector <std::string> contexts = getContexts();
+
+  if (contexts.size ())
+  {
+    std::sort (contexts.begin (), contexts.end ());
+
+    ViewText view;
+    view.width (context.getWidth ());
+    view.add (Column::factory ("string", "Name"));
+    view.add (Column::factory ("string", "Definition"));
+
+    Color label (context.config.get ("color.label"));
+    view.colorHeader (label);
+
+    std::vector <std::string>::iterator userContext;
+    for (userContext = contexts.begin (); userContext != contexts.end (); ++userContext)
+    {
+      std::string definition = context.config.get ("context." + *userContext);
+
+      int row = view.addRow ();
+      view.set (row, 0, *userContext);
+      view.set (row, 1, definition);
+    }
+
+    out << optionalBlankLine ()
+        << view.render ()
+        << optionalBlankLine ();
+  }
+  else
+  {
+    out << STRING_CMD_CONTEXT_LIST_EMPT << "\n";
+    rc = 1;
+  }
+
+  return rc;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+// 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
+//
+int CmdContext::setContext (std::vector <std::string>& words, std::stringstream& out)
+{
+  int rc = 0;
+  std::string value = words[0];
+  std::vector <std::string> contexts = getContexts ();
+
+  // Check that the specified context is defined
+  if (std::find (contexts.begin (), contexts.end (), value) == contexts.end ())
+    throw format (STRING_CMD_CONTEXT_SET_NFOU, value);
+
+  // Set the active context.
+  // Should always succeed, as we do not require confirmation.
+  bool success = CmdConfig::setConfigVariable ("context", value, false);
+
+  if (success)
+    out << format (STRING_CMD_CONTEXT_SET_SUCC, value) << "\n";
+  else
+  {
+    out << format (STRING_CMD_CONTEXT_SET_FAIL, value) << "\n";
+    rc = 1;
+  }
+
+  return rc;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+// Shows the currently active context.
+//
+// Returns: Always returns 0.
+//
+// Invoked with: task context show
+// Example:      task context show
+//
+int CmdContext::showContext (std::vector <std::string>& words, std::stringstream& out)
+{
+  std::string currentContext = context.config.get ("context");
+
+  if (currentContext == "")
+    out << STRING_CMD_CONTEXT_SHOW_EMPT << "\n";
+  else
+  {
+    std::string currentFilter = context.config.get ("context." + currentContext);
+    out << format (STRING_CMD_CONTEXT_SHOW, currentContext, currentFilter) << "\n";
+  }
+
+  return 0;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+// 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
+//
+int CmdContext::unsetContext (std::vector <std::string>& words, std::stringstream& out)
+{
+  int rc = 0;
+  int status = CmdConfig::unsetConfigVariable ("context", false);
+
+  if (status == 0)
+    out << STRING_CMD_CONTEXT_NON_SUCC << "\n";
+  else
+  {
+    out << STRING_CMD_CONTEXT_NON_FAIL << "\n";
+    rc = 1;
+  }
+
+  return rc;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+CmdCompletionContext::CmdCompletionContext ()
+{
+  _keyword     = "_context";
+  _usage       = "task          _context";
+  _description = STRING_CMD_HCONTEXT_USAGE;
+  _read_only   = true;
+  _displays_id = false;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+int CmdCompletionContext::execute (std::string& output)
+{
+  std::vector <std::string> userContexts = CmdContext::getContexts ();
+
+  std::vector <std::string>::iterator userContext;
+  for (userContext = userContexts.begin (); userContext != userContexts.end (); ++userContext)
+    output += *userContext + "\n";
+
+  return 0;
+}
+
+////////////////////////////////////////////////////////////////////////////////

src/commands/CmdContext.h

@@ -0,0 +1,56 @@
+////////////////////////////////////////////////////////////////////////////////
+//
+// Copyright 2006 - 2015, 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.
+//
+// http://www.opensource.org/licenses/mit-license.php
+//
+////////////////////////////////////////////////////////////////////////////////
+
+#ifndef INCLUDED_CMDCONTEXT
+#define INCLUDED_CMDCONTEXT
+
+#include <string>
+#include <Command.h>
+
+class CmdContext : public Command
+{
+public:
+  CmdContext ();
+  int execute (std::string&);
+  std::string joinWords (std::vector <std::string>& words, unsigned int from, unsigned int to = 0);
+  static std::vector <std::string> getContexts ();
+  int defineContext (std::vector <std::string>& words, std::stringstream& out);
+  int deleteContext (std::vector <std::string>& words, std::stringstream& out);
+  int listContexts (std::vector <std::string>& words, std::stringstream& out);
+  int setContext (std::vector <std::string>& words, std::stringstream& out);
+  int showContext (std::vector <std::string>& words, std::stringstream& out);
+  int unsetContext (std::vector <std::string>& words, std::stringstream& out);
+};
+
+class CmdCompletionContext : public Command
+{
+public:
+  CmdCompletionContext ();
+  int execute (std::string&);
+};
+
+#endif
+////////////////////////////////////////////////////////////////////////////////

src/commands/CmdCustom.cpp

@@ -82,15 +82,7 @@ int CmdCustom::execute (std::string& output)
   validateSortColumns (sortOrder);
 
   // Prepend the argument list with those from the report filter.
-  std::string lexeme;
-  Lexer::Type type;
-  Lexer lex (reportFilter);
-  lex.ambiguity (false);
-  while (lex.token (lexeme, type))
-    context.cli.add (lexeme);
-
-  // Reparse after tree change.
-  context.cli.analyze ();
+  context.cli.addRawFilter(reportFilter);
 
   // Apply filter.
   handleRecurrence ();

src/commands/CmdShow.cpp

@@ -127,6 +127,7 @@ int CmdShow::execute (std::string& output)
     " column.padding"
     " complete.all.tags"
     " confirmation"
+    " context"
     " data.location"
     " dateformat"
     " dateformat.annotation"
@@ -230,6 +231,7 @@ int CmdShow::execute (std::string& output)
           i->first.substr (0, 14) != "color.project."        &&
           i->first.substr (0, 10) != "color.tag."            &&
           i->first.substr (0, 10) != "color.uda."            &&
+          i->first.substr (0,  8) != "context."              &&
           i->first.substr (0,  8) != "holiday."              &&
           i->first.substr (0,  7) != "report."               &&
           i->first.substr (0,  6) != "alias."                &&

src/commands/Command.cpp

@@ -46,6 +46,7 @@
 #include <CmdColumns.h>
 #include <CmdCommands.h>
 #include <CmdConfig.h>
+#include <CmdContext.h>
 #include <CmdCount.h>
 #include <CmdCustom.h>
 #include <CmdDelete.h>
@@ -109,6 +110,7 @@ void Command::factory (std::map <std::string, Command*>& all)
   c = new CmdCompletionColumns ();  all[c->keyword ()] = c;
   c = new CmdCompletionCommands (); all[c->keyword ()] = c;
   c = new CmdCompletionConfig ();   all[c->keyword ()] = c;
+  c = new CmdCompletionContext ();  all[c->keyword ()] = c;
   c = new CmdCompletionIds ();      all[c->keyword ()] = c;
   c = new CmdCompletionUDAs ();     all[c->keyword ()] = c;
   c = new CmdCompletionUuids ();    all[c->keyword ()] = c;
@@ -116,6 +118,7 @@ void Command::factory (std::map <std::string, Command*>& all)
   c = new CmdCompletionTags ();     all[c->keyword ()] = c;
   c = new CmdCompletionVersion ();  all[c->keyword ()] = c;
   c = new CmdConfig ();             all[c->keyword ()] = c;
+  c = new CmdContext ();            all[c->keyword ()] = c;
   c = new CmdCount ();              all[c->keyword ()] = c;
   c = new CmdDelete ();             all[c->keyword ()] = c;
   c = new CmdDenotate ();           all[c->keyword ()] = c;