tools/opentf/HelpCommand.cs

   1 //
   2 // HelpCommand.cs
   3 //
   4 // Authors:
   5 //      Joel Reed (joelwreed@gmail.com)
   6 //
   7
   8 //
   9 // Permission is hereby granted, free of charge, to any person obtaining
  10 // a copy of this software and associated documentation files (the
  11 // "Software"), to deal in the Software without restriction, including
  12 // without limitation the rights to use, copy, modify, merge, publish,
  13 // distribute, sublicense, and/or sell copies of the Software, and to
  14 // permit persons to whom the Software is furnished to do so, subject to
  15 // the following conditions:
  16 //
  17 // The above copyright notice and this permission notice shall be
  18 // included in all copies or substantial portions of the Software.
  19 //
  20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27 //
  28
  29 using System;
  30 using System.Collections.Generic;
  31 using System.IO;
  32 using System.Text;
  33 using System.Reflection;
  34 using Microsoft.TeamFoundation.Client;
  35 using Microsoft.TeamFoundation.VersionControl.Client;
  36 using Mono.GetOptions;
  37
  38 [Command("help", "Describe the usage of this program or its subcommands.", "<command>")]
  39 class HelpCommand : Command
  40 {
  41         [Option("List all commands without description", "L", "list")]
  42                 public bool OptionList = false;
  43
  44         public HelpCommand(Driver driver, string[] args): base(driver, args)
  45         {
  46         }
  47
  48         public void ShowHelp()
  49         {
  50                 Console.WriteLine("Usage: tf [subcommand] [arguments]");
  51                 Console.WriteLine();
  52                 Console.WriteLine("Available subcommands:");
  53                 Console.WriteLine();
  54
  55                 foreach (CommandAttribute attribute in CommandRegistry.Attributes.Values)
  56                         {
  57                                 ShowCommandHelp(attribute, "  ");
  58                         }
  59         }
  60
  61         public void ShowList()
  62         {
  63                 foreach (string attribute in CommandRegistry.Attributes.Keys)
  64                         {
  65                                 Console.WriteLine(attribute);
  66                         }
  67         }
  68
  69         static public void ShowCommandHelp(CommandAttribute attribute,
  70                                                                                                                                                  string indent)
  71         {
  72                 Console.Write(indent + attribute.Name);
  73                 if (!String.IsNullOrEmpty(attribute.Alias)) Console.Write(" (alias {0})", attribute.Alias);
  74                 Console.WriteLine();
  75
  76                 string description = attribute.Description;
  77                 int x = 0;
  78
  79                 while (x < description.Length)
  80                         {
  81                                 int y = Math.Min(x + 60, description.Length);
  82                                 int z = description.IndexOf(' ', y) + 1;
  83                                 if (z == 0) z = description.Length;
  84
  85                                 Console.WriteLine(indent + "  " + description.Substring(x, z - x));
  86                                 x = z;
  87                         }
  88
  89                 Console.WriteLine();
  90         }
  91
  92         public void ShowCommandHelp(string cmd)
  93         {
  94                 CommandAttribute attr = CommandRegistry.GetCommandAttribute(cmd);
  95                 if (attr == null)
  96                         {
  97                                 Console.WriteLine("Unknown command: " + cmd);
  98                                 Console.WriteLine();
  99                                 ShowHelp();
 100                                 return;
 101                         }
 102
 103                 ShowCommandHelp(attr, "");
 104                 Console.WriteLine("Usage: " + cmd + " " + attr.Args);
 105                 Console.WriteLine();
 106                 Console.WriteLine("Options:");
 107
 108                 Type commandType = CommandRegistry.GetCommandType(cmd);
 109                 foreach(MemberInfo mi in commandType.GetMembers())
 110                         {
 111                                 if (mi.MemberType != MemberTypes.Field) continue;
 112
 113                                 OptionAttribute[] attribs = mi.GetCustomAttributes(typeof(OptionAttribute), true) as OptionAttribute[];
 114                                 if (attribs == null || attribs.Length == 0) continue;
 115
 116                                 foreach (OptionAttribute attrib in attribs)
 117                                         {
 118                                                 Type fieldType = ((FieldInfo)mi).FieldType;
 119                                                 if (!String.IsNullOrEmpty(attrib.AlternateForm))
 120                                                         {
 121                                                                 string altform = "  /" + attrib.AlternateForm + "";
 122                                                                 if (fieldType != typeof(bool)) altform += ":ARG";
 123                                                                 Console.Write(altform.PadRight(20));
 124                                                         }
 125
 126                                                 Console.Write("\t" + attrib.ShortDescription);
 127
 128                                                 if (!String.IsNullOrEmpty(attrib.LongForm))
 129                                                         {
 130                                                                 Console.Write(" (also /" + attrib.LongForm);
 131                                                                 if (fieldType != typeof(bool)) Console.Write(":ARG");
 132                                                                 Console.Write(")");
 133                                                         }
 134
 135                                                 Console.WriteLine();
 136                                         }
 137                         }
 138
 139                 Console.WriteLine();
 140         }
 141
 142         public override void Run()
 143         {
 144                 if (OptionList)
 145                         {
 146                                 ShowList();
 147                                 return;
 148                         }
 149
 150                 if (Arguments.Length > 0)
 151                         ShowCommandHelp(Arguments[0]);
 152                 else
 153                         ShowHelp();
 154         }
 155 }