Commands - color

- Migrated handleColor to CmdColor.

src/Cmd.cpp

@@ -135,7 +135,6 @@ void Cmd::load ()
     commands.push_back ("export.ical");
     commands.push_back ("export.yaml");
     commands.push_back ("calendar");
-    commands.push_back ("colors");
     commands.push_back ("config");
     commands.push_back ("delete");
     commands.push_back ("done");
@@ -211,7 +210,6 @@ bool Cmd::isReadOnlyCommand ()
       command == "export.ical"                                               ||
       command == "export.yaml"                                               ||
       command == "calendar"                                                  ||
-      command == "colors"                                                    ||
       command == "config"                                                    ||
 			command == "push"                                                      ||
       command == "summary"                                                   ||

src/Context.cpp

@@ -247,8 +247,7 @@ int Context::dispatch (std::string &out)
   Timer t ("Context::dispatch");
 
   // TODO Chain-of-command pattern dispatch.
-       if (cmd.command == "colors")           { rc = handleColor                 (out); }
-  else if (cmd.command == "config")           { rc = handleConfig                (out); }
+       if (cmd.command == "config")           { rc = handleConfig                (out); }
   else if (cmd.command == "summary")          { rc = handleReportSummary         (out); }
   else if (cmd.command == "calendar")         { rc = handleReportCalendar        (out); }
   else if (cmd.command == "timesheet")        { rc = handleReportTimesheet       (out); }

src/command.cpp

@@ -1009,204 +1009,6 @@ int handleDuplicate (std::string& outs)
   return rc;
 }
 
-////////////////////////////////////////////////////////////////////////////////
-int handleColor (std::string& outs)
-{
-  int rc = 0;
-  std::stringstream out;
-
-  if (context.color ())
-  {
-    // If the description contains 'legend', show all the colors currently in
-    // use.
-    std::string description = context.task.get ("description");
-    if (description.find ("legend") != std::string::npos)
-    {
-      out << "\nHere are the colors currently in use:\n";
-
-      std::vector <std::string> all;
-      context.config.all (all);
-
-      ViewText view;
-      view.width (context.getWidth ());
-      view.add (Column::factory ("string", "Color"));
-      view.add (Column::factory ("string", "Definition"));
-
-      foreach (item, all)
-      {
-        // Skip items with 'color' in their name, that are not referring to
-        // actual colors.
-        if (*item != "_forcecolor" &&
-            *item != "color"       &&
-            item->find ("color") == 0)
-        {
-          Color color (context.config.get (*item));
-          int row = view.addRow ();
-          view.set (row, 0, *item, color);
-          view.set (row, 1, context.config.get (*item), color);
-        }
-      }
-
-      out << view.render ()
-          << "\n";
-    }
-
-    // If there is something in the description, then assume that is a color,
-    // and display it as a sample.
-    else if (description != "")
-    {
-      Color one    ("black on bright yellow");
-      Color two    ("underline cyan on bright blue");
-      Color three  ("color214 on color202");
-      Color four   ("rgb150 on rgb020");
-      Color five   ("underline grey10 on grey3");
-      Color six    ("red on color173");
-      Color sample (description);
-
-      out << "\n"
-          << "Use this command to see how colors are displayed by your terminal.\n\n"
-          << "\n"
-          << "16-color usage (supports underline, bold text, bright background):\n"
-          << "  " << one.colorize ("task color black on bright yellow")            << "\n"
-          << "  " << two.colorize ("task color underline cyan on bright blue")     << "\n"
-          << "\n"
-          << "256-color usage (supports underline):\n"
-          << "  " << three.colorize ("task color color214 on color202")            << "\n"
-          << "  " << four.colorize ("task color rgb150 on rgb020")                 << "\n"
-          << "  " << five.colorize ("task color underline grey10 on grey3")        << "\n"
-          << "  " << six.colorize ("task color red on color173")                   << "\n"
-          << "\n"
-          << "Your sample:"                                                        << "\n"
-          << "  " << sample.colorize ("task color " + description)                 << "\n\n";
-    }
-
-    // Show all supported colors.  Possibly show some unsupported ones too.
-    else
-    {
-      out << "\n"
-          << "Basic colors"
-          << "\n"
-          << " " << Color::colorize (" black ",   "black")
-          << " " << Color::colorize (" red ",     "red")
-          << " " << Color::colorize (" blue ",    "blue")
-          << " " << Color::colorize (" green ",   "green")
-          << " " << Color::colorize (" magenta ", "magenta")
-          << " " << Color::colorize (" cyan ",    "cyan")
-          << " " << Color::colorize (" yellow ",  "yellow")
-          << " " << Color::colorize (" white ",   "white")
-          << "\n"
-          << " " << Color::colorize (" black ",   "white on black")
-          << " " << Color::colorize (" red ",     "white on red")
-          << " " << Color::colorize (" blue ",    "white on blue")
-          << " " << Color::colorize (" green ",   "black on green")
-          << " " << Color::colorize (" magenta ", "black on magenta")
-          << " " << Color::colorize (" cyan ",    "black on cyan")
-          << " " << Color::colorize (" yellow ",  "black on yellow")
-          << " " << Color::colorize (" white ",   "black on white")
-          << "\n\n";
-
-      out << "Effects"
-          << "\n"
-          << " " << Color::colorize (" red ",               "red")
-          << " " << Color::colorize (" bold red ",          "bold red")
-          << " " << Color::colorize (" underline on blue ", "underline on blue")
-          << " " << Color::colorize (" on green ",          "black on green")
-          << " " << Color::colorize (" on bright green ",   "black on bright green")
-          << " " << Color::colorize (" inverse ",           "inverse")
-          << "\n\n";
-
-      // 16 system colors.
-      out << "color0 - color15"
-          << "\n"
-          << "  0 1 2 . . .\n";
-      for (int r = 0; r < 2; ++r)
-      {
-        out << "  ";
-        for (int c = 0; c < 8; ++c)
-        {
-          std::stringstream s;
-          s << "on color" << (r*8 + c);
-          out << Color::colorize ("  ", s.str ());
-        }
-
-        out << "\n";
-      }
-
-      out << "          . . . 15\n\n";
-
-      // Color cube.
-      out << "Color cube rgb"
-          << Color::colorize ("0", "bold red")
-          << Color::colorize ("0", "bold green")
-          << Color::colorize ("0", "bold blue")
-          << " - rgb"
-          << Color::colorize ("5", "bold red")
-          << Color::colorize ("5", "bold green")
-          << Color::colorize ("5", "bold blue")
-          << " (also color16 - color231)"
-          << "\n"
-          << "  " << Color::colorize ("0            "
-                                      "1            "
-                                      "2            "
-                                      "3            "
-                                      "4            "
-                                      "5", "bold red")
-          << "\n"
-          << "  " << Color::colorize ("0 1 2 3 4 5  "
-                                      "0 1 2 3 4 5  "
-                                      "0 1 2 3 4 5  "
-                                      "0 1 2 3 4 5  "
-                                      "0 1 2 3 4 5  "
-                                      "0 1 2 3 4 5", "bold blue")
-          << "\n";
-
-      char label [12];
-      for (int g = 0; g < 6; ++g)
-      {
-        sprintf (label, " %d", g);
-        out << Color::colorize (label, "bold green");
-        for (int r = 0; r < 6; ++r)
-        {
-          for (int b = 0; b < 6; ++b)
-          {
-            std::stringstream s;
-            s << "on rgb" << r << g << b;
-            out << Color::colorize ("  ", s.str ());
-          }
-
-          out << " ";
-        }
-
-        out << "\n";
-      }
-
-      out << "\n";
-
-      // Grey ramp.
-      out << "Gray ramp gray0 - gray23 (also color232 - color255)\n"
-          << "  0 1 2 . . .                             . . . 23\n"
-          << "  ";
-      for (int g = 0; g < 24; ++g)
-      {
-        std::stringstream s;
-        s << "on gray" << g;
-        out << Color::colorize ("  ", s.str ());
-      }
-
-      out << "\n\nTry running 'task color white on red'.\n\n";
-    }
-  }
-  else
-  {
-    out << "Color is currently turned off in your .taskrc file.  To enable "
-           "color, remove the line 'color=off', or change the 'off' to 'on'.\n";
-    rc = 1;
-  }
-
-  outs = out.str ();
-  return rc;
-}
-
 ////////////////////////////////////////////////////////////////////////////////
 int deltaAppend (Task& task)
 {

src/commands/CMakeLists.txt

@@ -11,6 +11,7 @@ set (commands_SRCS Command.cpp        Command.h
                    CmdAppend.cpp      CmdAppend.h
                    CmdBurndown.cpp    CmdBurndown.h
                    CmdCommands.cpp    CmdCommands.h
+                   CmdColor.cpp       CmdColor.h
                    CmdCount.cpp       CmdCount.h
                    CmdCustom.cpp      CmdCustom.h
                    CmdDenotate.cpp    CmdDenotate.h

src/commands/CmdColor.cpp

@@ -0,0 +1,245 @@
+////////////////////////////////////////////////////////////////////////////////
+// taskwarrior - a command line task list manager.
+//
+// Copyright 2006 - 2011, Paul Beckingham, Federico Hernandez.
+// 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 <sstream>
+#include <ViewText.h>
+#include <Context.h>
+#include <CmdColor.h>
+
+extern Context context;
+
+////////////////////////////////////////////////////////////////////////////////
+CmdColor::CmdColor ()
+{
+  _keyword     = "colors";
+  _usage       = "task colors [sample | legend]";
+  _description = "Displays all possible colors, a named sample, or a legend "
+                 "containing all currently defined colors.";
+  _read_only   = true;
+  _displays_id = false;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+int CmdColor::execute (const std::string&, std::string& output)
+{
+  int rc = 0;
+  std::stringstream out;
+
+  if (context.color ())
+  {
+    // If the description contains 'legend', show all the colors currently in
+    // use.
+    std::string description = context.task.get ("description");
+    if (description.find ("legend") != std::string::npos)
+    {
+      out << "\nHere are the colors currently in use:\n";
+
+      std::vector <std::string> all;
+      context.config.all (all);
+
+      ViewText view;
+      view.width (context.getWidth ());
+      view.add (Column::factory ("string", "Color"));
+      view.add (Column::factory ("string", "Definition"));
+
+      std::vector <std::string>::iterator item;
+      for (item = all.begin (); item != all.end (); ++item)
+      {
+        // Skip items with 'color' in their name, that are not referring to
+        // actual colors.
+        if (*item != "_forcecolor" &&
+            *item != "color"       &&
+            item->find ("color") == 0)
+        {
+          Color color (context.config.get (*item));
+          int row = view.addRow ();
+          view.set (row, 0, *item, color);
+          view.set (row, 1, context.config.get (*item), color);
+        }
+      }
+
+      out << view.render ()
+          << "\n";
+    }
+
+    // If there is something in the description, then assume that is a color,
+    // and display it as a sample.
+    else if (description != "")
+    {
+      Color one    ("black on bright yellow");
+      Color two    ("underline cyan on bright blue");
+      Color three  ("color214 on color202");
+      Color four   ("rgb150 on rgb020");
+      Color five   ("underline grey10 on grey3");
+      Color six    ("red on color173");
+      Color sample (description);
+
+      out << "\n"
+          << "Use this command to see how colors are displayed by your terminal.\n\n"
+          << "\n"
+          << "16-color usage (supports underline, bold text, bright background):\n"
+          << "  " << one.colorize ("task color black on bright yellow")            << "\n"
+          << "  " << two.colorize ("task color underline cyan on bright blue")     << "\n"
+          << "\n"
+          << "256-color usage (supports underline):\n"
+          << "  " << three.colorize ("task color color214 on color202")            << "\n"
+          << "  " << four.colorize ("task color rgb150 on rgb020")                 << "\n"
+          << "  " << five.colorize ("task color underline grey10 on grey3")        << "\n"
+          << "  " << six.colorize ("task color red on color173")                   << "\n"
+          << "\n"
+          << "Your sample:"                                                        << "\n"
+          << "  " << sample.colorize ("task color " + description)                 << "\n\n";
+    }
+
+    // Show all supported colors.  Possibly show some unsupported ones too.
+    else
+    {
+      out << "\n"
+          << "Basic colors"
+          << "\n"
+          << " " << Color::colorize (" black ",   "black")
+          << " " << Color::colorize (" red ",     "red")
+          << " " << Color::colorize (" blue ",    "blue")
+          << " " << Color::colorize (" green ",   "green")
+          << " " << Color::colorize (" magenta ", "magenta")
+          << " " << Color::colorize (" cyan ",    "cyan")
+          << " " << Color::colorize (" yellow ",  "yellow")
+          << " " << Color::colorize (" white ",   "white")
+          << "\n"
+          << " " << Color::colorize (" black ",   "white on black")
+          << " " << Color::colorize (" red ",     "white on red")
+          << " " << Color::colorize (" blue ",    "white on blue")
+          << " " << Color::colorize (" green ",   "black on green")
+          << " " << Color::colorize (" magenta ", "black on magenta")
+          << " " << Color::colorize (" cyan ",    "black on cyan")
+          << " " << Color::colorize (" yellow ",  "black on yellow")
+          << " " << Color::colorize (" white ",   "black on white")
+          << "\n\n";
+
+      out << "Effects"
+          << "\n"
+          << " " << Color::colorize (" red ",               "red")
+          << " " << Color::colorize (" bold red ",          "bold red")
+          << " " << Color::colorize (" underline on blue ", "underline on blue")
+          << " " << Color::colorize (" on green ",          "black on green")
+          << " " << Color::colorize (" on bright green ",   "black on bright green")
+          << " " << Color::colorize (" inverse ",           "inverse")
+          << "\n\n";
+
+      // 16 system colors.
+      out << "color0 - color15"
+          << "\n"
+          << "  0 1 2 . . .\n";
+      for (int r = 0; r < 2; ++r)
+      {
+        out << "  ";
+        for (int c = 0; c < 8; ++c)
+        {
+          std::stringstream s;
+          s << "on color" << (r*8 + c);
+          out << Color::colorize ("  ", s.str ());
+        }
+
+        out << "\n";
+      }
+
+      out << "          . . . 15\n\n";
+
+      // Color cube.
+      out << "Color cube rgb"
+          << Color::colorize ("0", "bold red")
+          << Color::colorize ("0", "bold green")
+          << Color::colorize ("0", "bold blue")
+          << " - rgb"
+          << Color::colorize ("5", "bold red")
+          << Color::colorize ("5", "bold green")
+          << Color::colorize ("5", "bold blue")
+          << " (also color16 - color231)"
+          << "\n"
+          << "  " << Color::colorize ("0            "
+                                      "1            "
+                                      "2            "
+                                      "3            "
+                                      "4            "
+                                      "5", "bold red")
+          << "\n"
+          << "  " << Color::colorize ("0 1 2 3 4 5  "
+                                      "0 1 2 3 4 5  "
+                                      "0 1 2 3 4 5  "
+                                      "0 1 2 3 4 5  "
+                                      "0 1 2 3 4 5  "
+                                      "0 1 2 3 4 5", "bold blue")
+          << "\n";
+
+      char label [12];
+      for (int g = 0; g < 6; ++g)
+      {
+        sprintf (label, " %d", g);
+        out << Color::colorize (label, "bold green");
+        for (int r = 0; r < 6; ++r)
+        {
+          for (int b = 0; b < 6; ++b)
+          {
+            std::stringstream s;
+            s << "on rgb" << r << g << b;
+            out << Color::colorize ("  ", s.str ());
+          }
+
+          out << " ";
+        }
+
+        out << "\n";
+      }
+
+      out << "\n";
+
+      // Grey ramp.
+      out << "Gray ramp gray0 - gray23 (also color232 - color255)\n"
+          << "  0 1 2 . . .                             . . . 23\n"
+          << "  ";
+      for (int g = 0; g < 24; ++g)
+      {
+        std::stringstream s;
+        s << "on gray" << g;
+        out << Color::colorize ("  ", s.str ());
+      }
+
+      out << "\n\nTry running 'task color white on red'.\n\n";
+    }
+  }
+  else
+  {
+    out << "Color is currently turned off in your .taskrc file.  To enable "
+           "color, remove the line 'color=off', or change the 'off' to 'on'.\n";
+    rc = 1;
+  }
+
+  output = out.str ();
+  return rc;
+}
+
+////////////////////////////////////////////////////////////////////////////////

src/commands/CmdColor.h

@@ -0,0 +1,42 @@
+////////////////////////////////////////////////////////////////////////////////
+// taskwarrior - a command line task list manager.
+//
+// Copyright 2006 - 2011, Paul Beckingham, Federico Hernandez.
+// 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
+//
+////////////////////////////////////////////////////////////////////////////////
+#ifndef INCLUDED_CMDCOLOR
+#define INCLUDED_CMDCOLOR
+#define L10N                                           // Localization complete.
+
+#include <string>
+#include <Command.h>
+
+class CmdColor : public Command
+{
+public:
+  CmdColor ();
+  int execute (const std::string&, std::string&);
+};
+
+#endif
+////////////////////////////////////////////////////////////////////////////////

src/commands/CmdHelp.cpp

@@ -171,11 +171,6 @@ int CmdHelp::execute (const std::string&, std::string& output)
   view.set (row, 1, "task pull URL");
   view.set (row, 2, "Overwrites the local *.data files with those found at the URL.");
 
-  row = view.addRow ();
-  view.set (row, 1, "task color [sample | legend]");
-  view.set (row, 2, "Displays all possible colors, a named sample, or a "
-                         "legend containing all currently defined colors.");
-
   row = view.addRow ();
   view.set (row, 1, "task config [name [value | '']]");
   view.set (row, 2, "Add, modify and remove settings in the task configuration.");

src/commands/Command.cpp

@@ -32,6 +32,7 @@
 #include <CmdAnnotate.h>
 #include <CmdAppend.h>
 #include <CmdBurndown.h>
+#include <CmdColor.h>
 #include <CmdCommands.h>
 #include <CmdCount.h>
 #include <CmdCustom.h>
@@ -70,6 +71,7 @@ void Command::factory (std::map <std::string, Command*>& all)
   c = new CmdBurndownDaily ();      all[c->keyword ()] = c;
   c = new CmdBurndownMonthly ();    all[c->keyword ()] = c;
   c = new CmdBurndownWeekly ();     all[c->keyword ()] = c;
+  c = new CmdColor ();              all[c->keyword ()] = c;
   c = new CmdCompletionCommands (); all[c->keyword ()] = c;
   c = new CmdCompletionIds ();      all[c->keyword ()] = c;
   c = new CmdCompletionProjects (); all[c->keyword ()] = c;

src/main.h

@@ -58,7 +58,6 @@ int handleConfig (std::string&);
 int handleDelete (std::string&);
 int handleStart (std::string&);
 int handleStop (std::string&);
-int handleColor (std::string&);
 int handleDuplicate (std::string&);
 void handleUndo ();
 void handleMerge (std::string&);