File: scummvm-tools-cli.cpp

package info (click to toggle)
scummvm-tools 2.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 4,916 kB
  • sloc: cpp: 54,616; sh: 4,145; perl: 706; ansic: 646; python: 518; makefile: 271
file content (227 lines) | stat: -rw-r--r-- 7,249 bytes parent folder | download | duplicates (3)
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
/* ScummVM Tools
 *
 * ScummVM Tools is the legal property of its developers, whose
 * names are too numerous to list here. Please refer to the
 * COPYRIGHT file distributed with this source distribution.
 *
 * 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.
 */

/* CLI interface for the tools */

#include <iostream>
#include <algorithm>
#include <assert.h>

#include "scummvm-tools-cli.h"
#include "version.h"

ToolsCLI::ToolsCLI() {
}

ToolsCLI::~ToolsCLI() {
}

int ToolsCLI::run(int argc, char *argv[]) {
	if (argc == 1) {
		// Run without any arguments
		printHelp(argv[0]);
		return 2;
	}

// If using Solaris Studio
#if defined(__sun) && !defined(__GNUC__)
	std::deque<std::string> arguments; for (int i = 1; i < argc; i++) arguments.push_back(argv[i]);
#else
	std::deque<std::string> arguments(argv, argv + argc);
	arguments.pop_front(); // Pop our own name
#endif

	ToolType type = TOOLTYPE_ALL;

	if (arguments.empty())
		std::cout << "\tExpected more arguments" << std::endl;

	// Check first argument
	std::string option = arguments.front();
	if (option == "--tool" || option == "-t") {
		arguments.pop_front();
		if (arguments.size()) {
			for (ToolList::iterator iter = _tools.begin(); iter != _tools.end(); ++iter) {
				Tool *tool = *iter;
				if (arguments.front() == tool->getName()) {
					// Run the tool, first argument will be name, very nice!
					return tool->run(arguments);
				}
			}
			std::cout << "\tUnknown tool, make sure you input one of the following:" << std::endl;
		} else {
			std::cout << "\tMissing tool name, make sure you specify one of the following:" << std::endl;
		}
		printTools();
	} else if (option == "--help" || option == "-h") {
		arguments.pop_front();

		if (arguments.size()) {
			for (ToolList::iterator iter = _tools.begin(); iter != _tools.end(); ++iter) {
				Tool *tool = *iter;
				if (arguments.front() == tool->getName()) {
					// Obtain the help text for this tool and print it
					std::cout << tool->getHelp() << std::endl;
					return 2;
				}
			}
			std::cout << std::endl << "Unknown help topic '" << arguments[0] << "'" << std::endl;
		}
		printHelp(argv[0]);
		return 2;
	} else if (option == "--list" || option == "-l") {
		printTools();
	} else if (option == "--version") {
		printVersion();
	} else {
		ToolList choices;
		std::deque<std::string>::reverse_iterator reader = arguments.rbegin();
		std::deque<std::string>::iterator hint_arg;
		std::string infile;

		hint_arg = std::find(arguments.begin(), arguments.end(), "compress");
		if (hint_arg != arguments.end()) {
			type = TOOLTYPE_COMPRESSION;
		} else {
			hint_arg = std::find(arguments.begin(), arguments.end(), "extract");
			if (hint_arg != arguments.end())
				type = TOOLTYPE_EXTRACTION;
		}

		while (reader != arguments.rend()) {
			//std::cout << "Checking backarg " << *reader << std::endl;
			if (hint_arg != arguments.end() && *reader == *hint_arg) {
				//std::cout << "It is the hint! begin anew" << std::endl;
				// It seems hint_arg was an input file, start over but with generic file type
				type = TOOLTYPE_ALL;
				reader = arguments.rbegin();
				hint_arg = arguments.end();
				continue;
			}

			// It must be a filename now
			choices = inspectInput(*reader, type);

			// If anything matched, we stop
			if (choices.size() > 0) {
				infile = *reader;
				break;
			}
			++reader;
		}
		if (hint_arg != arguments.end()) {
			// Remove hint as it's not used after this, and can't be in tool CLI
			arguments.erase(hint_arg);

			// Only possible if compress/extract was parsed
			if (arguments.empty())
				// compress was the arg removed so...
				std::cout << "\tExpected more arguments after '" << option << "'" << std::endl;
		}

		// This should never happen, as args are only removed if we used compress|extract
		assert(arguments.empty() == false);

		// Find out what tools take this file as input
		Tool *tool = NULL;

		if (choices.empty()) {
			std::cout << "\tNo tool could parse input file '" << arguments.front() << "', use --list to list all available tools and --tool to force running the correct one." << std::endl;
			return 0;
		} else if (choices.size() > 1) {
			if (infile.size() && infile[0] == '-')
				std::cout << "\tWARNING: Input file '" << infile << "' looks like an argument, is this what you wanted?" << std::endl;

			std::cout << "\tMultiple tools accept this input:" << std::endl << std::endl;

			// Present a list of possible tools
			int i = 1;
			for (ToolList::iterator choice = choices.begin(); choice != choices.end(); ++choice, ++i) {
				std::cout << "\t" << i << ") " << (*choice)->getName() << std::endl;
			}

			std::cout << "Which tool to use ('q' to abort): ";
			i = 0;
			while (true) {

				// Read input
				std::cin >> i;

				// Was it an integer and in range?
				if (std::cin && i >= 1 && (size_t)i <= choices.size())
					break;

				// If it wasn't an integer, trying reading input again, this time as a string.
				if (!std::cin) {
					// Clear any error flags
					std::cin.clear();

					std::string q;
					std::cin >> q;
					if (q == "q" || q == "exit" || q == "quit" || q == "abort")
						return 0;
				}

				std::cout << "Invalid input, try again ('q' to abort): ";
			}

			// Account for the fact arrays start at 0
			tool = choices[i - 1];
		} else {
			tool = choices.front();
		}

		std::cout << "\tRunning using " << tool->getName() << std::endl;

		// Run the tool, with the remaining arguments
		arguments.push_front(tool->getName());
		return tool->run(arguments);
	}

	return 0;
}

void ToolsCLI::printHelp(const char *exeName) {
	std::cout <<
		gScummVMToolsFullVersion << std::endl <<
		std::endl <<
		"Common use:" << std::endl <<
		"  " << exeName << " [--tool <tool name>] [tool-specific options] [-o <output directory>] <input files>" << std::endl <<
		"  " << exeName << " [tool-specific option] [-o <output directory>] [extract|compress] <input files>" << std::endl <<
		std::endl <<
		"Other Options:" << std::endl <<
		"  --help\tDisplay this text" << std::endl <<
		"  --version\tDisplay version information" << std::endl <<
		"  --list\tList all tools that are available" << std::endl <<
		"";
}

void ToolsCLI::printVersion() {
	std::cout <<
		gScummVMToolsFullVersion << std::endl;
}

void ToolsCLI::printTools() {
	std::cout << std::endl << "All available tools:" << std::endl;
	for (ToolList::iterator tool = _tools.begin(); tool != _tools.end(); ++tool)
		// There *really* should be a short version of the help text available
		std::cout << "\t" << (*tool)->getName() << ":\t" << (*tool)->getShortHelp() << std::endl;
}