File indexing completed on 2024-04-14 14:32:18

 //
 // C++ Interface: cCmdParser
 //
 // Description: command parser
 //
 /*
 Copyright 2005-2011 Tomas Mecir <kmuddy@kmuddy.com>
 
 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, see <http://www.gnu.org/licenses/>.
 */
 
 #ifndef CCMDPARSER_H
 #define CCMDPARSER_H
 
 #include <cactionbase.h>
 #include <kmuddy_export.h>
 
 #include <qstringlist.h>
 
 /**
 The command parser. Parses command separators, speed-walk and similar things. Does not expand variables or internal scripting code.
 
 @author Tomas Mecir
 */
 class KMUDDY_EXPORT cCmdParser : public cActionBase
 {
  public:
   /** constructor */
   cCmdParser (int sess);
   /** destructor */
   ~cCmdParser () override;
   
   /** are we parsing commands ? */
   bool parsing () { return isparsing; };
   /** enable/disable command parsing */
   void setParsing (bool value);
 
   void setCmdSeparatorString (QString str);
   void setSpeedWalkString (QString str);
   void setMultiCommandString (QString str);
   void setNoParseString (QString str);
   void setMacroString (QString str);
 
   void setAllowEmptyWalkStr (bool val);
   /** set spaces stripping */
   void setStripSpaces (bool strip) { stripSpaces = strip; };
   /** backslash (\) expansion yes/no */
   void setExpandBackslashes (bool val) { expandbackslashes = val; };
   
   /** parse the command, return list of expanded commands */
   QStringList parse (const QString &command, bool expandAliases = true);
   
   /** Is this a macro call ? Also splits into name and params. */
   bool isMacroCall (const QString &cmd, QString &mname, QString &params);
   
   /** does this command need to be sent as-is ? */
   bool mustSendRaw (const QString &command);
   /** remove the raw flag from the command */
   QString fixRaw (const QString &command);
  protected:
   void eventNothingHandler (QString event, int session) override;
 
   /** split text into commands, using command separators and \n */
   QStringList splitIntoCommands (const QString &text);
 
   QStringList parseCommand (const QString &command, bool expandAliases = true);
 
   /** mark this command as raw, returning the marked command */
   QString markAsRaw (const QString &command);
 
   /** if this is a speed-walk command, returns length of speed-walk char
   or string (it returns 0 if it isn't speedwalk) */
   int isSpeedWalkCommand (const QString &command);
   /** if the command is speed-walk, this will process it, starting
   at position <pos> (computed by isSpeedWalkCommand) */
   QStringList expandSpeedWalk (const QString &command, int pos);
 
   /** handles repeater (multi-command) character. !!! modifies
   parameter command if there is a repeater !!!
   @param command Where to look for the repeater, repeater sequence is
   stripped off the command, if any */
   unsigned int repeater (QString &command);
 
   /** expand backslashes in the command */
   void expandBackslashes (QString &command);
 
   QString separstr, walkstr, multistr, noparsestr, macrostr;
   bool isparsing, allowemptywalkstr, stripSpaces, expandbackslashes;
 };
 
 #endif