getcommandinfocommand.cpp

   1 /*
   2  *  getcommandinfo.cpp
   3  *  Mothur
   4  *
   5  *  Created by westcott on 4/6/11.
   6  *  Copyright 2011 Schloss Lab. All rights reserved.
   7  *
   8  */
   9
  10 #include "getcommandinfocommand.h"
  11
  12 //**********************************************************************************************************************
  13 vector<string> GetCommandInfoCommand::setParameters(){
  14         try {
  15                 CommandParameter poutput("output", "String", "", "", "", "", "",false,false); parameters.push_back(poutput);
  16                 CommandParameter pinputdir("inputdir", "String", "", "", "", "", "",false,false); parameters.push_back(pinputdir);
  17                 CommandParameter poutputdir("outputdir", "String", "", "", "", "", "",false,false); parameters.push_back(poutputdir);
  18
  19                 vector<string> myArray;
  20                 for (int i = 0; i < parameters.size(); i++) {   myArray.push_back(parameters[i].name);          }
  21                 return myArray;
  22         }
  23         catch(exception& e) {
  24                 m->errorOut(e, "GetCommandInfoCommand", "setParameters");
  25                 exit(1);
  26         }
  27 }
  28 //**********************************************************************************************************************
  29 string GetCommandInfoCommand::getHelpString(){
  30         try {
  31                 string helpString = "";
  32                 helpString += "This command is used by the gui to get the information about current commands available in mothur.\n";
  33                 return helpString;
  34         }
  35         catch(exception& e) {
  36                 m->errorOut(e, "GetCommandInfoCommand", "getHelpString");
  37                 exit(1);
  38         }
  39 }
  40 //**********************************************************************************************************************
  41
  42 GetCommandInfoCommand::GetCommandInfoCommand(string option)  {
  43         try {
  44                 abort = false; calledHelp = false;
  45
  46                 //allow user to run help
  47                 if(option == "help") { help(); abort = true; calledHelp = true; }
  48                 else if(option == "citation") { citation(); abort = true; calledHelp = true;}
  49
  50                 else {
  51                         vector<string> myArray = setParameters();
  52
  53                         OptionParser parser(option);
  54                         map<string, string> parameters = parser.getParameters();
  55
  56                         ValidParameters validParameter;
  57                         //check to make sure all parameters are valid for command
  58                         for (map<string,string>::iterator it = parameters.begin(); it != parameters.end(); it++) {
  59                                 if (validParameter.isValidParameter(it->first, myArray, it->second) != true) {  abort = true;  }
  60                         }
  61
  62                         output = validParameter.validFile(parameters, "output", false);
  63                         if (output == "not found") {  output = ""; m->mothurOut("You must provide an output filename."); m->mothurOutEndLine(); abort=true; }
  64
  65                 }
  66         }
  67         catch(exception& e) {
  68                 m->errorOut(e, "GetCommandInfoCommand", "GetCommandInfoCommand");
  69                 exit(1);
  70         }
  71 }
  72 //**********************************************************************************************************************
  73
  74 int GetCommandInfoCommand::execute(){
  75         try {
  76
  77                 if (abort == true) { if (calledHelp) { return 0; }  return 2;   }
  78
  79                 commandFactory = CommandFactory::getInstance();
  80
  81                 ofstream out;
  82                 m->openOutputFile(output+".temp", out);
  83
  84                 int numNonHidden = 0;
  85
  86                 out << "mothurLocation=" << m->getFullPathName(m->argv) << endl;
  87                 out << "mothurVersion=" << m->getVersion() << endl;
  88
  89                 map<string, string> commands = commandFactory->getListCommands();
  90                 map<string, string>::iterator it;
  91
  92                 //loop through each command outputting info
  93                 for (it = commands.begin(); it != commands.end(); it++) {
  94
  95                         if (m->control_pressed) { m->mothurOut("[ERROR]: did not complete making the file."); m->mothurOutEndLine(); out.close(); m->mothurRemove((output+".temp")); }
  96
  97                         Command* thisCommand = commandFactory->getCommand(it->first);
  98
  99                         //don't add hidden commands
 100                         if (thisCommand->getCommandCategory() != "Hidden") {
 101                                 numNonHidden++;
 102
 103                                 //general info
 104                                 out << "commandName=" << thisCommand->getCommandName() << endl;
 105                                 //cout << thisCommand->getCommandName() << " current citation = " << thisCommand->getCitation() << endl;
 106                                 out << "commandCategory=" << thisCommand->getCommandCategory() << endl;
 107
 108                                 //remove /n from help string since gui reads line by line
 109                                 string myhelpString = thisCommand->getHelpString();
 110                                 string newHelpString = "";
 111                                 for (int i = 0; i < myhelpString.length(); i++) {
 112                                         if (myhelpString[i] != '\n') { newHelpString += myhelpString[i]; }
 113                                 }
 114                                 out << "help=" << newHelpString << endl;
 115
 116                                 //remove /n from citation string since gui reads line by line
 117                                 string mycitationString = thisCommand->getCitation();
 118                                 string newCitationString = "";
 119                                 for (int i = 0; i < mycitationString.length(); i++) {
 120                                         if (mycitationString[i] != '\n') { newCitationString += mycitationString[i]; }
 121                                 }
 122                                 out << "citation=" << newCitationString << endl;
 123
 124                                 out << "description=" << thisCommand->getDescription() << endl;
 125
 126                                 //outputTypes - makes something like outputTypes=fasta-name-qfile
 127                                 map<string, vector<string> > thisOutputTypes = thisCommand->getOutputFiles();
 128                                 map<string, vector<string> >::iterator itTypes;
 129
 130                                 if (thisOutputTypes.size() == 0) { out << "outputTypes=none" << endl; }
 131                                 else {
 132                                         string types = "";
 133                                         for (itTypes = thisOutputTypes.begin(); itTypes != thisOutputTypes.end(); itTypes++) {  types += itTypes->first + "-";  }
 134                                         //rip off last -
 135                                         types = types.substr(0, types.length()-1);
 136                                         out << "outputTypes=" << types << endl;
 137                                 }
 138
 139                                 vector<string> booleans; vector<string> numbers; vector<string> multiples; vector<string> Strings;
 140                                 vector<string> inputGroupNames; map<string, string> inputTypes;
 141
 142                                 getInfo(thisCommand->getParameters(), booleans, numbers, multiples, Strings, inputGroupNames, inputTypes);
 143
 144                                 //output booleans
 145                                 out << "Boolean=" << booleans.size() << endl;
 146                                 for (int i = 0; i < booleans.size(); i++) { out << booleans[i] << endl; }
 147
 148                                 //output mulitples
 149                                 out << "Multiple=" << multiples.size() << endl;
 150                                 for (int i = 0; i < multiples.size(); i++) { out << multiples[i] << endl; }
 151
 152                                 //output numbers
 153                                 out << "Numbers=" << numbers.size() << endl;
 154                                 for (int i = 0; i < numbers.size(); i++) { out << numbers[i] << endl; }
 155
 156                                 //output strings
 157                                 out << "String=" << Strings.size() << endl;
 158                                 for (int i = 0; i < Strings.size(); i++) { out << Strings[i] << endl; }
 159
 160                                 //output groups
 161                                 out << "inputGroupNames=" << inputGroupNames.size() << endl;
 162                                 for (int i = 0; i < inputGroupNames.size(); i++) { out << inputGroupNames[i] << endl; }
 163
 164                                 //output input types
 165                                 if (inputTypes.size() == 0) { out << "inputTypes=" << endl; }
 166                                 else {
 167                                         string types = "";
 168                                         for (map<string, string>::iterator it2 = inputTypes.begin(); it2 != inputTypes.end(); it2++) {  types += it2->first + "-";      }
 169                                         //rip off last -
 170                                         types = types.substr(0, types.length()-1);
 171                                         out << "inputTypes=" << types << endl;
 172
 173                                         for (map<string, string>::iterator it2 = inputTypes.begin(); it2 != inputTypes.end(); it2++) {
 174                                                 out << it2->first << "=" << it2->second << endl;
 175                                         }
 176                                 }
 177
 178                         }
 179                 }
 180
 181                 out.close();
 182
 183                 ofstream out2;
 184                 m->openOutputFile(output, out2);
 185                 out2 << numNonHidden << endl;
 186                 out2.close();
 187
 188                 m->appendFiles(output+".temp", output);
 189                 m->mothurRemove((output+".temp"));
 190
 191                 m->mothurOutEndLine();
 192                 m->mothurOut("Output File Names: "); m->mothurOutEndLine();
 193                 m->mothurOut(output); m->mothurOutEndLine();
 194                 m->mothurOutEndLine();
 195
 196
 197                 return 0;
 198         }
 199         catch(exception& e) {
 200                 m->errorOut(e, "GetCommandInfoCommand", "execute");
 201                 exit(1);
 202         }
 203 }
 204 //**********************************************************************************************************************
 205
 206 int GetCommandInfoCommand::getInfo(vector<CommandParameter> para, vector<string>& booleans, vector<string>& numbers, vector<string>& multiples, vector<string>& strings, vector<string>& inputGroupNames, map<string, string>& inputTypes){
 207         try {
 208
 209                 map<string, set<string> > groups;
 210                 map<string,  set<string> >::iterator itGroups;
 211
 212                 for (int i = 0; i < para.size(); i++) {
 213                         if ((para[i].name == "inputdir") || (para[i].name == "outputdir")) {} //ignore
 214                         else {
 215                                 if (para[i].type == "Boolean") {
 216                                         string temp = para[i].name + "=" + para[i].optionsDefault;
 217                                         booleans.push_back(temp);
 218                                 }else if (para[i].type == "Multiple") {
 219                                         string multAllowed = "F";
 220                                         if (para[i].multipleSelectionAllowed) { multAllowed = "T"; }
 221                                         string temp = para[i].name + "=" + para[i].options + "|" + para[i].optionsDefault + "|" + multAllowed;
 222                                         multiples.push_back(temp);
 223                                 }else if (para[i].type == "Number") {
 224                                         string temp = para[i].name + "=" + para[i].optionsDefault;
 225                                         numbers.push_back(temp);
 226                                 }else if (para[i].type == "String") {
 227                                         string temp = para[i].name + "=" + para[i].optionsDefault;
 228                                         strings.push_back(temp);
 229                                 }else if (para[i].type == "InputTypes") {
 230                                         string required = "F";
 231                                         if (para[i].required) { required = "T"; }
 232                                         string temp = required + "|" + para[i].chooseOnlyOneGroup + "|" + para[i].chooseAtLeastOneGroup + "|" + para[i].linkedGroup;
 233                                         inputTypes[para[i].name] = temp;
 234
 235                                         //add choose only one groups
 236                                         groups[para[i].chooseOnlyOneGroup].insert(para[i].name);
 237
 238                                         //add at least one group names
 239                                         groups[para[i].chooseAtLeastOneGroup].insert(para[i].name);
 240
 241                                         //add at linked group names
 242                                         groups[para[i].linkedGroup].insert(para[i].name);
 243
 244                                 }else { m->mothurOut("[ERROR]: " + para[i].type + " is an unknown parameter type, please correct."); m->mothurOutEndLine(); }
 245                         }
 246                 }
 247
 248                 for (itGroups = groups.begin(); itGroups != groups.end(); itGroups++) {
 249                         if (itGroups->first != "none") {
 250                                 set<string> tempNames = itGroups->second;
 251                                 string temp = itGroups->first + "=";
 252                                 for (set<string>::iterator itNames = tempNames.begin(); itNames != tempNames.end(); itNames++) {
 253                                         temp += *itNames + "-";
 254                                 }
 255                                 //rip off last -
 256                                 temp = temp.substr(0, temp.length()-1);
 257                                 inputGroupNames.push_back(temp);
 258                         }
 259                 }
 260
 261                 return 0;
 262
 263         }
 264         catch(exception& e) {
 265                 m->errorOut(e, "GetCommandInfoCommand", "getInfo");
 266                 exit(1);
 267         }
 268 }
 269 //**********************************************************************************************************************/