geode-client-native/examples/dist/cacheRunner/CommandReader.hpp

/*=========================================================================
 * Copyright (c) 2002-2014 Pivotal Software, Inc. All Rights Reserved.  
 * This product is protected by U.S. and international copyright
 * and intellectual property laws. Pivotal products are covered by
 * more patents listed at http://www.pivotal.io/patents.
 *=========================================================================
 */

/** 
 * @file CommandReader.hpp
 * @since   1.0
 * @version 1.0
 * @see
*/

#ifndef __COMMAND_READER_HPP__
#define __COMMAND_READER_HPP__

#include <vector>
#include <string>

// ----------------------------------------------------------------------------

typedef std::vector<std::string> tCommandReaderList;

// ----------------------------------------------------------------------------

/**
 * @class CommandReader
 *
 * @brief Helper class for reading stdin and parsing commands 
 */ 
class CommandReader
{
public:
  CommandReader(void);
  CommandReader(std::string);
  ~CommandReader();

  /** 
    * @brief helper function to compare strings 
    * @param pszToken NULL terminated string token
    * @param pszText NULL terminated string to compare token with
    * @retval returns true if match, false if no match
    */
  static bool startsWith(const char* pszToken, const char* pszText);

  /**
    * @brief read command line from stdin up to 80 characters and stores value to 
    * current command list and current command string
    */
  void readCommandLineFromStdin( );

  /**
    * @brief compares a command string to the current command, 
    * case is compared, length is compared
    * @param pszCommand NULL terminated string to search command
    * @retval true if success, false if unsucessful
    */
  bool isCommand( const char* pszCommand);

  /**
    * @brief compares a command string to the current command, 
    * case is compared, length of input string is compared
    * @param pszCommand NULL terminated string to search command
    * @retval true if success, false if unsucessful
    */
  bool isCommandStartsWith( const char* pszCommand);

  /**
    * @brief compares a command string to the current command, 
    * no case is compared, length is compared
    * @param pszCommand NULL terminated string to search command
    * @retval true if success, false if unsucessful
    */
  bool isCommandNoCase( const char* pszCommand );

  /**
    * @brief compares a command string to the current token, 
    * no case is compared, length of input is compared
    * @param pszCommand NULL terminated string to search command
    * @retval true if success, false if unsucessful
    */
  bool isCommandStartsWithNoCase( const char* pszCommand );

  /**
    * @brief compares a token string to the current token, 
    * case is compared, length is compared
    * @param pszToken NULL terminated string to search token
    * @param iIndex index refenence of token
    * @retval true if success, false if unsucessful
    */
  bool isToken( const char* pszToken, int iIndex = 0 );

  /**
    * @brief compares a token string to the current token, 
    * case is compared, length of input string is compared
    * @param pszToken NULL terminated string to search token
    * @param iIndex index refenence of token
    * @retval true if success, false if unsucessful
    */
  bool isTokenStartsWith( const char* pszToken, int iIndex = 0 );

  /**
    * @brief compares a token string to the current token, 
    * no case is compared, length is compared
    * @param pszToken NULL terminated string to search token
    * @param iIndex index refenence of token
    * @retval true if success, false if unsucessful
    */
  bool isTokenNoCase( const char* pszToken, int iIndex = 0);

  /**
    * @brief compares a token string to the current token, 
    * no case is compared, length of input string is compared
    * @param pszToken NULL terminated string to search token
    * @param iIndex index refenence of token
    * @retval true if success, false if unsucessful
    */
  bool isTokenStartsWithNoCase( const char* pszToken, int iIndex = 0 );

  /**
    * @brief gets command line string
    * @retval returns the current command line string
    */
  std::string getCommandString( );
  
  /**
    * @brief gets token of the command line string
    * @retval returns a token from the command line string
    */
  std::string getTokenString( int iIndex , bool isQuery = false);

  /**
    * @brief returns the number of tokens, including the command token
    * @retval returns the number of tokens from command line input
    */
  int getNumberOfTokens( );

private:
  /**
    * @brief clears current command list and command string
    */
  void clearCommand( );
  
  /**
    * @brief parses a text string delimited by spaces into a vector array
    */
  void parseStringToList( const std::string& sText, tCommandReaderList& commandList );

private:
  tCommandReaderList m_commandList;
  std::string        m_sCommand;
};

// ----------------------------------------------------------------------------

#endif // __COMMAND_READER_HPP__