1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
/*LICENSE_START*/
/*
* Copyright 1995-2002 Washington University School of Medicine
*
* http://brainmap.wustl.edu
*
* This file is part of CARET.
*
* CARET 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.
*
* CARET 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 CARET; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
/*LICENSE_END*/
#include <iostream>
#include <QApplication>
#include "CommandHelp.h"
#include "CommandHelpGlobalOptions.h"
#include "FileFilters.h"
#include "ProgramParameters.h"
#include "ScriptBuilderParameters.h"
/**
* constructor.
*/
CommandHelp::CommandHelp()
: CommandBase("-help",
"HELP")
{
}
/**
* destructor.
*/
CommandHelp::~CommandHelp()
{
}
/**
* get the script builder parameters.
*/
void
CommandHelp::getScriptBuilderParameters(ScriptBuilderParameters& paramsOut) const
{
paramsOut.clear();
}
/**
* get full help information.
*/
QString
CommandHelp::getHelpInformation() const
{
QString helpInfo =
(indent3 + getShortDescription() + "\n"
+ indent6 + parameters->getProgramNameWithoutPath() + " " + getOperationSwitch() + " \n"
+ indent9 + "\n"
+ indent9 + " Show help information.\n"
+ indent9 + "\n");
return helpInfo;
}
/**
* print short help information.
*/
void
CommandHelp::printCommandShortHelpInformation(const CommandBase* command)
{
std::cout << " "
<< command->getShortDescription().toAscii().constData()
<< " "
<< command->getOperationSwitch().toAscii().constData()
<< std::endl;
}
/**
* print long help information.
*/
void
CommandHelp::printCommandLongHelpInformation(const CommandBase* command)
{
std::cout << command->getHelpInformation().toAscii().constData();
CommandHelpGlobalOptions hgo;
const QString moreHelp =
(indent9 + "Run \""
+ QApplication::applicationName()
+ " "
+ hgo.getOperationSwitch() + "\"\n"
+ indent9 + " for parameters available to all commands.\n"
+ "\n");
/*
const QString moreHelp =
(indent9 + "Adding the parameter \"-CHDIR <directory-name>\" to \n"
+ indent9 + "the command will result in the command running from \n"
+ indent9 + "that directory. This parameter does not affect the \n"
+ indent9 + "current directory in the shell that executes the \n"
+ indent9 + "command.\n"
+ indent9 + "\n"
+ indent9 + "Adding the parameter \"-CHMOD <permissions>\" to the \n"
+ indent9 + "command will result in all files written by the command\n"
+ indent9 + "receiving the specified permissions. \"permissions\"\n"
+ indent9 + "is a list of one or move of the following values separated \n"
+ indent9 + "by commas:\n"
+ indent9 + " UR - user read\n"
+ indent9 + " UW - user write\n"
+ indent9 + " UX - user execute\n"
+ indent9 + " GR - group read\n"
+ indent9 + " GW - group write\n"
+ indent9 + " GX - group execute\n"
+ indent9 + " AR - all read\n"
+ indent9 + " AW - all write\n"
+ indent9 + " AX - all execute\n"
+ indent9 + "\n");
*/
std::cout << moreHelp.toAscii().constData();
}
/**
* execute the command.
*/
void
CommandHelp::executeCommand() throw (BrainModelAlgorithmException,
CommandException,
FileException,
ProgramParametersException,
StatisticException)
{
//
// Store the commands
//
std::vector<CommandBase*> commands;
CommandBase::getAllCommandsSortedBySwitch(commands);
//
// Loop through the commands
//
const int numCommands = static_cast<int>(commands.size());
for (int i = 0; i < numCommands; i++) {
//
// Print the command's help information
//
printCommandShortHelpInformation(commands[i]);
}
}
|
