taskwarrior/src/Cmd.cpp

////////////////////////////////////////////////////////////////////////////////
// task - a command line task list manager.
//
// Copyright 2006 - 2010, Paul Beckingham.
// All rights reserved.
//
// This program is free software; you can redistribute it and/or modify it under
// the terms of the GNU General Public License as published by the Free Software
// Foundation; either version 2 of the License, or (at your option) any later
// version.
//
// This program is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
// details.
//
// You should have received a copy of the GNU General Public License along with
// this program; if not, write to the
//
//     Free Software Foundation, Inc.,
//     51 Franklin Street, Fifth Floor,
//     Boston, MA
//     02110-1301
//     USA
//
////////////////////////////////////////////////////////////////////////////////

#include <algorithm>
#include "Cmd.h"
#include "Context.h"
#include "util.h"
#include "text.h"
#include "i18n.h"
#include "main.h"

extern Context context;

////////////////////////////////////////////////////////////////////////////////
Cmd::Cmd ()
: command ("")
{
}

////////////////////////////////////////////////////////////////////////////////
Cmd::Cmd (const std::string& input)
{
  parse (input);
}

////////////////////////////////////////////////////////////////////////////////
Cmd::~Cmd ()
{
}

////////////////////////////////////////////////////////////////////////////////
// Determines whether the string represents a unique command name or custom
// report name.
bool Cmd::valid (const std::string& input)
{
  load ();

  std::vector <std::string> matches;
  autoComplete (lowerCase (context.canonicalize (input)), commands, matches);
  return matches.size () == 1 ? true : false;
}

////////////////////////////////////////////////////////////////////////////////
// Determines whether the string represents a valid custom report name.
bool Cmd::validCustom (const std::string& input)
{
  load ();

  std::vector <std::string> matches;
  autoComplete (lowerCase (context.canonicalize (input)), customReports, matches);
  return matches.size () == 1 ? true : false;
}

////////////////////////////////////////////////////////////////////////////////
void Cmd::parse (const std::string& input)
{
  load ();

  std::string candidate = lowerCase (context.canonicalize (input));

  std::vector <std::string> matches;
  autoComplete (candidate, commands, matches);
  if (1 == matches.size ())
    command = matches[0];

  else if (0 == matches.size ())
    command = "";

  else
  {
    std::string error = "Ambiguous command '" + candidate + "' - could be either of "; // TODO i18n

    std::string combined;
    join (combined, ", ", matches);
    throw error + combined;
  }
}

////////////////////////////////////////////////////////////////////////////////
void Cmd::load ()
{
  if (commands.size () == 0)
  {
    // Commands whose names are not localized.
    commands.push_back ("_projects");
    commands.push_back ("_tags");
    commands.push_back ("_commands");
    commands.push_back ("_ids");
    commands.push_back ("_config");
    commands.push_back ("_version");
    commands.push_back ("export.csv");
    commands.push_back ("export.ical");
    commands.push_back ("history.monthly");
    commands.push_back ("history.annual");
    commands.push_back ("ghistory.monthly");
    commands.push_back ("ghistory.annual");

    // Commands whose names are localized.
    commands.push_back (context.stringtable.get (CMD_ADD,              "add"));
    commands.push_back (context.stringtable.get (CMD_APPEND,           "append"));
    commands.push_back (context.stringtable.get (CMD_ANNOTATE,         "annotate"));
    commands.push_back (context.stringtable.get (CMD_DENOTATE,         "denotate"));
    commands.push_back (context.stringtable.get (CMD_CALENDAR,         "calendar"));
    commands.push_back (context.stringtable.get (CMD_COLORS,           "colors"));
    commands.push_back (context.stringtable.get (CMD_CONFIG,           "config"));
    commands.push_back (context.stringtable.get (CMD_SHOW,             "show"));
    commands.push_back (context.stringtable.get (CMD_DELETE,           "delete"));
    commands.push_back (context.stringtable.get (CMD_DONE,             "done"));
    commands.push_back (context.stringtable.get (CMD_DUPLICATE,        "duplicate"));
    commands.push_back (context.stringtable.get (CMD_EDIT,             "edit"));
    commands.push_back (context.stringtable.get (CMD_HELP,             "help"));
    commands.push_back (context.stringtable.get (CMD_IMPORT,           "import"));
    commands.push_back (context.stringtable.get (CMD_INFO,             "info"));
    commands.push_back (context.stringtable.get (CMD_LOG,              "log"));
    commands.push_back (context.stringtable.get (CMD_PREPEND,          "prepend"));
    commands.push_back (context.stringtable.get (CMD_PROJECTS,         "projects"));
#ifdef FEATURE_SHELL
    commands.push_back (context.stringtable.get (CMD_SHELL,            "shell"));
#endif
    commands.push_back (context.stringtable.get (CMD_START,            "start"));
    commands.push_back (context.stringtable.get (CMD_STATS,            "stats"));
    commands.push_back (context.stringtable.get (CMD_STOP,             "stop"));
    commands.push_back (context.stringtable.get (CMD_SUMMARY,          "summary"));
    commands.push_back (context.stringtable.get (CMD_TAGS,             "tags"));
    commands.push_back (context.stringtable.get (CMD_TIMESHEET,        "timesheet"));
    commands.push_back (context.stringtable.get (CMD_UNDO,             "undo"));
    commands.push_back (context.stringtable.get (CMD_VERSION,          "version"));

    // Now load the custom reports.
    std::vector <std::string> all;
    context.config.all (all);

    foreach (i, all)
    {
      if (i->substr (0, 7) == "report.")
      {
        std::string report = i->substr (7);
        std::string::size_type columns = report.find (".columns");
        if (columns != std::string::npos)
        {
          report = report.substr (0, columns);

          // Make sure a custom report does not clash with a built-in
          // command.
          if (std::find (commands.begin (), commands.end (), report) != commands.end ())
            throw std::string ("Custom report '") + report +
                  "' conflicts with built-in task command.";

          // A custom report is also a command.
          customReports.push_back (report);
          commands.push_back (report);
        }
      }
    }
  }
}

////////////////////////////////////////////////////////////////////////////////
void Cmd::allCustomReports (std::vector <std::string>& all) const
{
  all = customReports;
}

////////////////////////////////////////////////////////////////////////////////
void Cmd::allCommands (std::vector <std::string>& all) const
{
  all.clear ();
  foreach (command, commands)
    if (command->substr (0, 1) != "_")
      all.push_back (*command);
}

////////////////////////////////////////////////////////////////////////////////
// Commands that do not directly modify the data files.
bool Cmd::isReadOnlyCommand ()
{
  if (command == "_projects"                                                        ||
      command == "_tags"                                                            ||
      command == "_commands"                                                        ||
      command == "_ids"                                                             ||
      command == "_config"                                                          ||
      command == "_version"                                                         ||
      command == "export.csv"                                                       ||
      command == "export.ical"                                                      ||
      command == "history.monthly"                                                  ||
      command == "history.annual"                                                   ||
      command == "ghistory.monthly"                                                 ||
      command == "ghistory.annual"                                                  ||
      command == context.stringtable.get (CMD_CALENDAR,         "calendar")         ||
      command == context.stringtable.get (CMD_COLORS,           "colors")           ||
      command == context.stringtable.get (CMD_CONFIG,           "config")           ||
      command == context.stringtable.get (CMD_SHOW,             "show")             ||
      command == context.stringtable.get (CMD_HELP,             "help")             ||
      command == context.stringtable.get (CMD_INFO,             "info")             ||
      command == context.stringtable.get (CMD_PROJECTS,         "projects")         ||
      command == context.stringtable.get (CMD_SHELL,            "shell")            ||
      command == context.stringtable.get (CMD_STATS,            "stats")            ||
      command == context.stringtable.get (CMD_SUMMARY,          "summary")          ||
      command == context.stringtable.get (CMD_TAGS,             "tags")             ||
      command == context.stringtable.get (CMD_TIMESHEET,        "timesheet")        ||
      command == context.stringtable.get (CMD_VERSION,          "version")          ||
      validCustom (command))
    return true;

  return false;
}

////////////////////////////////////////////////////////////////////////////////
// Commands that directly modify the data files.
bool Cmd::isWriteCommand ()
{
  if (command == context.stringtable.get (CMD_ADD,       "add")       ||
      command == context.stringtable.get (CMD_APPEND,    "append")    ||
      command == context.stringtable.get (CMD_ANNOTATE,  "annotate")  ||
      command == context.stringtable.get (CMD_DENOTATE,  "denotate")  ||
      command == context.stringtable.get (CMD_DELETE,    "delete")    ||
      command == context.stringtable.get (CMD_DONE,      "done")      ||
      command == context.stringtable.get (CMD_DUPLICATE, "duplicate") ||
      command == context.stringtable.get (CMD_EDIT,      "edit")      ||
      command == context.stringtable.get (CMD_IMPORT,    "import")    ||
      command == context.stringtable.get (CMD_LOG,       "log")       ||
      command == context.stringtable.get (CMD_PREPEND,   "prepend")   ||
      command == context.stringtable.get (CMD_START,     "start")     ||
      command == context.stringtable.get (CMD_STOP,      "stop")      ||
      command == context.stringtable.get (CMD_UNDO,      "undo"))
    return true;

  return false;
}

////////////////////////////////////////////////////////////////////////////////