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"

namespace tecplot
{
namespace toolbox
{

class TPTOOLBOX_DLLAPI StringList
{
public:
    StringList();

    explicit StringList(StringList_pa stringList);

    StringList(const StringList& stringList);

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

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

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

    virtual void append(const StringList& stringList);

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

    virtual void clear();

    virtual void assign(const StringList& stringList);

    virtual void assign(const char* strValue,
                        const char* delimiters          = ",",
                        bool        discardEmptyStrings = false);
    virtual inline void assign(std::string strValue,
                               std::string delimiters          = ",",
                               bool        discardEmptyStrings = false)
    {
        assign(strValue.c_str(), delimiters.c_str(), discardEmptyStrings);
    }

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

    virtual void replace(LgIndex_t   index,
                         const char* strValue);
    virtual inline void replace(LgIndex_t   index,
                                std::string strValue)
    {
        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* 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 StringList_pa getRef() const;

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

    StringList_pa m_stringList;

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

}
}

#endif

---