StringTokenizer.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (C) 2011 by Benjamin Hadorn (b_hadorn@bluewin.ch)
 *****************************************************************************
 * Project    : Zeus Base Library
 * Module     : StringTokenizer
 * Package    : Zeus.ZeusBase.System
 * Author     : Benjamin Hadorn
 * Date       : 27.12.2011
 * System     : Zeus-Framework
 *****************************************************************************
 * Licence:                                                                  *
 *   This library is free software; you can redistribute it and/or modify    *
 *   it under the terms of the GNU Lesser General Public License as          *
 *   published by the Free Software Foundation; either version               *
 *   2.1 of the License, or (at your option) any later version.              *
 *                                                                           *
 *   This library 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 Lesser General Public License for more details.                     *
 *                                                                           *
 *   You should have received a copy of the GNU Lesser General Public        *
 *   License along with this library; if not, write to the Free Software     *
 *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA    *
 *****************************************************************************/

/*****************************************************************************
 * Changes:
 *  27.12.2011 bha: created zeus 2.0
 *****************************************************************************/

#ifndef StringTokenizerH
#define StringTokenizerH

#include <zeusbase/System/ZObject.h>
#include <zeusbase/System/StringList.h>

BEGIN_NAMESPACE_Zeus


/**************************************************************************/
/**************************************************************************/
zeusbase_class TStringTokenizer : public TZObject
{
  public:
    TStringTokenizer(const IString& rData, const IString& rDelimiter  , bool bRemoveEmptyTokens = false);
    TStringTokenizer(const IString& rData, const wchar_t* pwcDelimiter, bool bRemoveEmptyTokens = false);

    virtual ~TStringTokenizer();

    TString getNextToken() const;
    TString getToken(Int iTokenIndex) const;
    TString getFirstToken() const;
    TString getLastToken() const;
    void getTokens(IStringList& rList) const;
    Int getTokenCount() const;
    bool hasNextToken() const;
    bool hasToken(const IString& rToken) const;
    void removeEmptyTokens();
    void resetIterator();
    void setTokens(const IStringList& rList);
    TString toString() const;
    TString toString(TString strNewDelimiter) const;
    Retval removeTokens(Int iFirstIndex, Int iLastIndex);
    Retval removeToken(Int uiIndex);
    Retval removeFirstToken();
    Retval removeLastToken();

    Retval getTokenIndex(const IString& strToken, Int& iIndex, bool bExactNotLike = true);

  private:
    void tokenize(const IString& rData);
    void tokenizeWithoutEmptyTokens(const IString& rData);
    TString toString_internal(const IString& rDelimiter) const;

  private:
    TStringList m_lstTokens;

    const IStringListIterator* m_pListIterator;

    TString m_strDelimiter;
};

//inline methods
/**************************************************************************/
/**************************************************************************/
inline TString TStringTokenizer::getNextToken() const
{
  return m_pListIterator->getNextItem();
}

/**************************************************************************/
/**************************************************************************/
inline TString TStringTokenizer::getFirstToken() const
{
  return getToken(0);
}

/**************************************************************************/
/**************************************************************************/
inline TString TStringTokenizer::getLastToken() const
{
  return getToken(getTokenCount() - 1);
}

/**************************************************************************/
/**************************************************************************/
inline TString TStringTokenizer::getToken(Int iTokenIndex) const
{
  //This violates the one-in-one-out principle
  // It is done to have a good performance

  if (iTokenIndex < getTokenCount())
  {
    return m_lstTokens.getItemConst(iTokenIndex);
  } // ulTokenIndex < getTokenCount().
  else
  {
    return TString();
  }
}

/**************************************************************************/
/**************************************************************************/
inline void TStringTokenizer::getTokens(IStringList& rList) const
{
  m_lstTokens.copyToList(rList);
}

/**************************************************************************/
/**************************************************************************/
inline Int TStringTokenizer::getTokenCount() const
{
  return m_lstTokens.getCount();
}

/**************************************************************************/
/**************************************************************************/
inline bool TStringTokenizer::hasNextToken() const
{
  return m_pListIterator->hasNextItem();
}

/**************************************************************************/
/**************************************************************************/
inline bool TStringTokenizer::hasToken(const IString& rToken) const
{
  return m_lstTokens.hasItem(rToken);
}

/**************************************************************************/
/**************************************************************************/
inline void TStringTokenizer::resetIterator()
{
  m_pListIterator->reset();
}

/**************************************************************************/
/**************************************************************************/
inline Retval TStringTokenizer::removeFirstToken()
{
  return removeToken(0);
}


/**************************************************************************/
/**************************************************************************/
inline Retval TStringTokenizer::removeLastToken()
{
  return removeToken(getTokenCount() - 1);
}

/**************************************************************************/
/**************************************************************************/
inline void TStringTokenizer::setTokens(const IStringList& rList)
{
  rList.copyToList(m_lstTokens);
}

/**************************************************************************/
/**************************************************************************/
inline TString TStringTokenizer::toString() const
{
  return toString_internal(m_strDelimiter);
}

/**************************************************************************/
/**************************************************************************/
inline TString TStringTokenizer::toString(TString strNewDelimiter) const
{
  return toString_internal(strNewDelimiter);
}

END_NAMESPACE_Zeus

#endif