Feature #800

- Added feature #800, adding a new command 'columns' that lists all the columns
  available for custom reports, and includes their formatting options (thanks
  to T. Charles Yun).

src/commands/CMakeLists.txt

@@ -13,6 +13,7 @@ set (commands_SRCS Command.cpp        Command.h
                    CmdCalendar.cpp    CmdCalendar.h
                    CmdCommands.cpp    CmdCommands.h
                    CmdColor.cpp       CmdColor.h
+                   CmdColumns.cpp     CmdColumns.h
                    CmdConfig.cpp      CmdConfig.h
                    CmdCount.cpp       CmdCount.h
                    CmdCustom.cpp      CmdCustom.h

src/commands/CmdColumns.cpp

@@ -0,0 +1,97 @@
+////////////////////////////////////////////////////////////////////////////////
+// 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
+//
+////////////////////////////////////////////////////////////////////////////////
+
+#define L10N                                           // Localization complete.
+
+#include <algorithm>
+#include <Context.h>
+#include <ViewText.h>
+#include <Color.h>
+#include <text.h>
+#include <i18n.h>
+#include <main.h>
+#include <CmdColumns.h>
+
+extern Context context;
+
+////////////////////////////////////////////////////////////////////////////////
+CmdColumns::CmdColumns ()
+{
+  _keyword     = "columns";
+  _usage       = "task columns";
+  _description = STRING_CMD_COLUMNS_USAGE;
+  _read_only   = true;
+  _displays_id = false;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+int CmdColumns::execute (std::string& output)
+{
+  // Include all columns in the table.
+  std::vector <std::string> names;
+  std::map <std::string, Column*>::const_iterator col;
+  for (col = context.columns.begin (); col != context.columns.end (); ++col)
+    names.push_back (col->first);
+
+  std::sort (names.begin (), names.end ());
+
+  // Render a list of project names from the map.
+  ViewText formats;
+  formats.width (context.getWidth ());
+  formats.add (Column::factory ("string", STRING_COLUMN_LABEL_COLUMN));
+  formats.add (Column::factory ("string", STRING_COLUMN_LABEL_STYLES));
+  formats.add (Column::factory ("string", STRING_COLUMN_LABEL_EXAMPLES));
+
+  Color alternate (context.config.get ("color.alternate"));
+  formats.colorOdd (alternate);
+  formats.intraColorOdd (alternate);
+
+  std::vector <std::string>::iterator name;
+  for (name = names.begin (); name != names.end (); ++name)
+  {
+    const std::vector <std::string> styles   = context.columns[*name]->styles ();
+    const std::vector <std::string> examples = context.columns[*name]->examples ();
+
+    for (unsigned int i = 0; i < styles.size (); ++i)
+    {
+      int row = formats.addRow ();
+      formats.set (row, 0, i == 0 ? *name : "");
+      formats.set (row, 1, styles[i] + (i == 0 ? "*" : ""));
+      formats.set (row, 2, i < examples.size () ? examples[i] : "");
+    }
+  }
+
+  output = optionalBlankLine ()
+         + formats.render ()
+         + "\n"
+         + STRING_CMD_COLUMNS_NOTE
+         + "\n";
+
+  return 0;
+}
+
+////////////////////////////////////////////////////////////////////////////////

src/commands/CmdColumns.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_CMDCOLUMNS
+#define INCLUDED_CMDCOLUMNS
+#define L10N                                           // Localization complete.
+
+#include <string>
+#include <Command.h>
+
+class CmdColumns : public Command
+{
+public:
+  CmdColumns ();
+  int execute (std::string&);
+};
+
+#endif
+////////////////////////////////////////////////////////////////////////////////

src/commands/Command.cpp

@@ -43,6 +43,7 @@
 #include <CmdBurndown.h>
 #include <CmdCalendar.h>
 #include <CmdColor.h>
+#include <CmdColumns.h>
 #include <CmdCommands.h>
 #include <CmdConfig.h>
 #include <CmdCount.h>
@@ -102,6 +103,7 @@ void Command::factory (std::map <std::string, Command*>& all)
   c = new CmdBurndownWeekly ();     all[c->keyword ()] = c;
   c = new CmdCalendar ();           all[c->keyword ()] = c;
   c = new CmdColor ();              all[c->keyword ()] = c;
+  c = new CmdColumns ();            all[c->keyword ()] = c;
   c = new CmdCompletionCommands (); all[c->keyword ()] = c;
   c = new CmdCompletionConfig ();   all[c->keyword ()] = c;
   c = new CmdCompletionIds ();      all[c->keyword ()] = c;