IPSA: source/viewer/instructions/ViewerHelp.cpp Source File

00001 /*
00002  * Copyright (c) 2007, 2008, 2009, University of Karlsruhe (for members see AUTHORS file)
00003  *
00004  * ISC License
00005  *
00006  * Permission to use, copy, modify, and/or distribute this software for any
00007  * purpose with or without fee is hereby granted, provided that the above
00008  * copyright notice and this permission notice appear in all copies.
00009  *
00010  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
00011  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
00012  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
00013  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
00014  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
00015  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
00016  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
00017  */
00018 
00025 #include "../include/IPSA/viewer/instructions/ViewerHelp.h"
00026 
00027 #include <sstream>
00028 
00029 Instruction::tExecResultType ViewerHelp::vExecute(std::vector<std::string>& Instr, std::ostringstream& answer, unsigned int& numberOfReturnValues)
00030 {
00031 #ifdef WIN32
00032                 Instr; //kcq under WIN32
00033 #endif // WIN32
00034                 numberOfReturnValues = lAllInstructions.size() + 2; // all instructions + this one + first line
00035                 answer << (lAllInstructions.size() + 1) << " Registered commands:\r" << std::endl;
00036                 for (std::map<std::string, Instruction*>::const_iterator it = lAllInstructions.begin(); it != lAllInstructions.end(); it++)
00037                 {
00038                                 answer << "   " << it->second->getCmdHelpString() << '\r' << std::endl;
00039                 }
00040                 answer << "   " << this->getCmdHelpString() << '\r' << std::endl;
00041                 return eOK;
00042 }