Home

nevrax.com

Nevrax.org News Mailing-list Documentation CVS Bugs License

Documentation                       Search   command.cpp Go to the documentation of this file. /* Copyright, 2001 Nevrax Ltd. * * This file is part of NEVRAX NEL. * NEVRAX NEL 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, or (at your option) * any later version. * NEVRAX NEL 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 NEVRAX NEL; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, * MA 02111-1307, USA. */ #include "stdmisc.h" #include "nel/misc/command.h" using namespace std; using namespace NLMISC; namespace NLMISC { ICommand::TCommand *ICommand::Commands; bool ICommand::CommandsInit; ICommand::ICommand(const char *commandName, const char *commandHelp, const char *commandArgs) { // self registration if (!CommandsInit) { //printf("create map\n"); Commands = new TCommand; CommandsInit = true; } TCommand::iterator comm = (*Commands).find(commandName); if (comm != (*Commands).end ()) { // 2 commands have the same name nlstopex (("There are 2 commands that have the same name in the project (command name '%s'), skip the second definition", commandName)); } else { // insert the new command in the map //printf("add command\n"); HelpString = commandHelp; CommandArgs = commandArgs; _CommandName = commandName; Type = Command; (*Commands)[commandName] = this; } } ICommand::~ICommand() { // self deregistration if (!CommandsInit) { // should never happen nlstop; return; } // find the command for (TCommand::iterator comm = (*Commands).begin(); comm != (*Commands).end(); comm++) { if ((*comm).second == this) { //printf("remove command\n"); (*Commands).erase (comm); if ((*Commands).size() == 0) { // if the commands map is empty, destroy it //printf("delete map\n"); delete Commands; CommandsInit = false; } return; } } // commands is not found nlstop; } void ICommand::execute (const std::string &commandWithArgs, CLog &log, bool quiet) { if (!quiet) log.displayNL ("Executing command : '%s'", commandWithArgs.c_str()); // convert the buffer into string vector vector<string> args; string command; bool firstArg = true; uint i = 0; while (true) { // skip whitespace while (true) { if (i == commandWithArgs.size()) { goto end; } if (commandWithArgs[i] != ' ' && commandWithArgs[i] != '\t' && commandWithArgs[i] != '\n' && commandWithArgs[i] != '\r') { break; } i++; } // get param string arg; if (commandWithArgs[i] == '\"') { // starting with a quote " i++; while (true) { if (i == commandWithArgs.size()) { if (!quiet) log.displayNL ("Missing end quote character \""); return; } if (commandWithArgs[i] == '"') { i++; break; } if (commandWithArgs[i] == '\\') { // manage escape char backslash i++; if (i == commandWithArgs.size()) { if (!quiet) log.displayNL ("Missing character after the backslash \\ character"); return; } switch (commandWithArgs[i]) { case '\\': arg += '\\'; break; // double backslash case 'n': arg += '\n'; break; // new line case '"': arg += '"'; break; // " default: if (!quiet) log.displayNL ("Unknown escape code '\\%c'", commandWithArgs[i]); return; } i++; } else { arg += commandWithArgs[i++]; } } } else { // normal word while (true) { if (commandWithArgs[i] == '\\') { // manage escape char backslash i++; if (i == commandWithArgs.size()) { if (!quiet) log.displayNL ("Missing character after the backslash \\ character"); return; } switch (commandWithArgs[i]) { case '\\': arg += '\\'; break; // double backslash case 'n': arg += '\n'; break; // new line case '"': arg += '"'; break; // " default: if (!quiet) log.displayNL ("Unknown escape code '\\%c'", commandWithArgs[i]); return; } i++; } else { arg += commandWithArgs[i++]; } if (i == commandWithArgs.size() || commandWithArgs[i] == ' ' || commandWithArgs[i] == '\t' || commandWithArgs[i] == '\n' || commandWithArgs[i] == '\r') { break; } } } if (firstArg) { command = arg; firstArg = false; } else { args.push_back (arg); } } end: /* displays args fordebug purpose nlinfo ("c '%s'", command.c_str()); for (uint t = 0; t < args.size (); t++) { nlinfo ("p%d '%s'", t, args[t].c_str()); } */ // find the command TCommand::iterator comm = (*Commands).find(command.c_str()); if (comm == (*Commands).end ()) { // the command doesn't exist if (!quiet) log.displayNL("Command '%s' not found, try 'help'", command.c_str()); } else { //printf("execute command\n"); if (!(*comm).second->execute (args, log)) { if (!quiet) log.displayNL("Bad command usage, try 'help %s'", command.c_str()); } } } /* * Command name completion. * Case-sensitive. Displays the list after two calls with the same non-unique completion. * Completes commands used with prefixes (such as "help " for example) as well. */ void ICommand::expand (std::string &commandName, NLMISC::CLog &log) { // Take out the string before the last separator and remember it as a prefix uint32 lastseppos = commandName.find_last_of( " " ); string prefix; bool useprefix; if ( lastseppos != string::npos ) { prefix = commandName.substr( 0, lastseppos+1 ); commandName.erase( 0, lastseppos+1 ); useprefix = true; } else { useprefix = false; } string lowerCommandName = strlwr(const_cast<const string &>(commandName)); // Build the list of matching command names vector<string> matchingnames; for (TCommand::iterator comm = (*Commands).begin(); comm != (*Commands).end(); comm++) { string first = strlwr(const_cast<const string &>((*comm).first)); if (first.find( lowerCommandName ) == 0) { matchingnames.push_back( (*comm).first ); } } // Do not complete if there is no result if ( matchingnames.empty() ) { log.displayNL( "No matching command" ); goto returnFromExpand; } // Complete if there is a single result if ( matchingnames.size() == 1 ) { commandName = matchingnames.front() + " "; goto returnFromExpand; } // Try to complete to the common part if there are several results { // Stop loop when a name size is i or names[i] are different string commonstr = commandName; uint i = commandName.size(); while ( true ) { char letter = 0; vector<string>::iterator imn; for ( imn=matchingnames.begin(); imn!=matchingnames.end(); ++imn ) { // Return common string if the next letter is not the same in all matching names if ( ((*imn).size() == i) || ( (letter!=0) && ((*imn)[i] != letter) ) ) { log.displayNL( "(Matching command not unique)" ); static string lastCommandName; commandName = commonstr; if ( lastCommandName == commandName ) { // Display all the matching names vector<string>::iterator imn2; stringstream ss; ss << "Matching commands:" << endl; for ( imn2=matchingnames.begin(); imn2!=matchingnames.end(); ++imn2 ) { ss << " " << (*imn2); } log.displayNL( "%s", ss.str().c_str() ); } lastCommandName = commandName; goto returnFromExpand; } // Add the next letter to the common string if it is the same in all matching names else if ( letter == 0 ) { letter = (*imn)[i]; } } commonstr += letter; ++i; } } returnFromExpand: // Put back the prefix if ( useprefix ) { commandName = prefix + commandName; } } void ICommand::serialCommands (IStream &f) { vector<CSerialCommand> cmd; for (TCommand::iterator comm = (*Commands).begin(); comm != (*Commands).end(); comm++) { cmd.push_back (CSerialCommand ((*comm).first, (*comm).second->Type)); } f.serialCont (cmd); } NLMISC_COMMAND(help,"display help on a specific variable/commands or on all variables and commands", "[<variable>|<command>]") { if (args.size() == 0) { // display all commands for (TCommand::iterator comm = (*Commands).begin(); comm != (*Commands).end(); comm++) { log.displayNL("%-15s: %s", (*comm).first.c_str(), (*comm).second->HelpString.c_str()); } } else if (args.size() == 1) { // display help of the command TCommand::iterator comm = (*Commands).find(args[0].c_str()); if (comm == (*Commands).end ()) { log.displayNL("command '%s' not found", args[0].c_str()); } else { log.displayNL("%s", (*comm).second->HelpString.c_str()); log.displayNL("usage: %s %s", (*comm).first.c_str(), (*comm).second->CommandArgs.c_str(), (*comm).second->HelpString.c_str()); } } else { return false; } return true; } } // NLMISC