common/wstr/list.h

Go to the documentation of this file.

//
//      aegis - project change supervisor
//      Copyright (C) 1995, 2002-2006, 2008 Peter Miller
//
//      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 3 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 COMMON_WSTR_LIST_H
#define COMMON_WSTR_LIST_H

#include <common/wstr.h>

class wstring_list_ty
{
public:
    ~wstring_list_ty();

    wstring_list_ty();

    wstring_list_ty(const wstring_list_ty &);

    wstring_list_ty &operator=(const wstring_list_ty &);

    size_t size() const { return nitems; }

    bool empty() const { return (nitems == 0); }

    wstring_ty *get(size_t n) const { return item[n]; }

    wstring_ty *operator[](size_t n) const { return get(n); }

    void clear();

    void push_back(wstring_ty *arg);

    void push_back(const wstring_list_ty &arg);

    void pop_back();

    void push_back_unique(wstring_ty *arg);

    void push_front(wstring_ty *arg);

    bool member(wstring_ty *arg) const;

    void remove(wstring_ty *arg);

    wstring_ty *unsplit(size_t start, size_t stop, const char *sep = 0) const;

    wstring_ty *unsplit(const char *sep = 0) const;

    void split(wstring_ty *wis, const char *sep = 0, bool ewhite = false);

    bool equal_to(const wstring_list_ty &rhs) const;

    bool is_a_subset_of(const wstring_list_ty &rhs) const;

private:
    size_t nitems;

    size_t nitems_max;

    wstring_ty **item;
};

inline bool
operator==(const wstring_list_ty &lhs, const wstring_list_ty &rhs)
{
    return lhs.equal_to(rhs);
}

inline bool
operator!=(const wstring_list_ty &lhs, const wstring_list_ty &rhs)
{
    return !lhs.equal_to(rhs);
}

#endif // COMMON_WSTR_LIST_H