StringList.h

Go to the documentation of this file.

/*
 *****************************************************************
 *****************************************************************
 *******                                                  ********
 *******     (C) Copyright 1989-2007  by Tecplot Inc.     ********
 *******             All Rights Reserved.                 ********
 *******                                                  ********
 *****************************************************************
 *****************************************************************
 */
#ifndef TECPLOT_TOOLBOX_STRINGLIST_H
#define TECPLOT_TOOLBOX_STRINGLIST_H

#if defined MSWIN
  #pragma once
#endif

#include <string>
#include "tptoolbox.h"
#include "OutOfMemoryException.h"

namespace tecplot { namespace toolbox {

class TPTOOLBOX_DLLAPI StringList
{
public:
  StringList() throw (OutOfMemoryException);

  explicit StringList(StringList_pa stringList) throw (OutOfMemoryException);

  StringList(const StringList& stringList) throw (OutOfMemoryException);

  explicit StringList(const char* first,
                      ...) throw (OutOfMemoryException);

  virtual ~StringList(); // the StringList_pa will be deallocated in the destructor

public:
  virtual Boolean_t operator==(const StringList& rhs) const;
  virtual Boolean_t operator!=(const StringList& rhs) const;

  virtual void append(const StringList& stringList) throw (OutOfMemoryException);

  virtual void append(const char* strValue) throw (OutOfMemoryException);
  virtual inline void append(std::string strValue) throw (OutOfMemoryException)
  {
    append(strValue.c_str());
  }

  virtual void clear();

  virtual void assign(const StringList& stringList) throw (OutOfMemoryException);

  virtual void assign(const char* strValue, 
                      const char* delimiters          = ",",
                      Boolean_t   discardEmptyStrings = FALSE) throw (OutOfMemoryException);
  virtual inline void assign(std::string strValue, 
                             std::string delimiters          = ",",
                             Boolean_t   discardEmptyStrings = FALSE) throw (OutOfMemoryException)
  {
    assign(strValue.c_str(), delimiters.c_str(), discardEmptyStrings);
  }  

  virtual void insert(LgIndex_t   index,
                      const char* strValue) throw (OutOfMemoryException);
  virtual inline void insert(LgIndex_t   index,
                             std::string strValue) throw (OutOfMemoryException)
  {
    insert(index, strValue.c_str());
  }

  virtual void replace(LgIndex_t   index,
                       const char* strValue) throw (OutOfMemoryException);
  virtual inline void replace(LgIndex_t   index,
                              std::string strValue) throw (OutOfMemoryException)
  {
    replace(index, strValue.c_str());
  }

  virtual void remove(LgIndex_t index);

  virtual void remove(LgIndex_t index,
                      LgIndex_t count);


  virtual void sort(const StringListStringComparator_pf comparator = NULL,
                    const ArbParam_t                    clientData = 0);


  virtual LgIndex_t size() const;

  virtual const char* const getStringRef(LgIndex_t index) const;

  virtual std::string get(LgIndex_t index) const;

  virtual std::string toString(const char* delimiters) const;
  virtual inline std::string toString(std::string delimiters) const
  {
    return toString(delimiters.c_str());
  }

  virtual const StringList_pa getRef() const;

private:  
  void alloc() throw (OutOfMemoryException);
  void dealloc();

  StringList_pa m_stringList;

  StringList& operator = (const StringList& other);
};

}}

#endif

---