SearchPath.h++

Go to the documentation of this file.

/* ---------------------------------------------------------------------------
   commonc++ - A C++ Common Class Library
   Copyright (C) 2005-2012  Mark A Lindner

   This file is part of commonc++.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   ---------------------------------------------------------------------------
*/

#ifndef __ccxx_SearchPath_hxx
#define __ccxx_SearchPath_hxx

#include <commonc++/Common.h++>
#include <commonc++/FileName.h++>
#include <commonc++/String.h++>

#include <memory>

#ifdef SearchPath
#undef SearchPath
#endif

namespace ccxx {

class COMMONCPP_API SearchPath
{
  public:

  SearchPath(const String &path = "");

  SearchPath(const SearchPath& other);

  ~SearchPath() throw();

  SearchPath& operator=(const SearchPath& other);

  void append(const String &dir);

  void prepend(const String &dir);

  void remove(const String &dir);

  void clear();

  bool contains(const String &dir) const throw();

  bool find(FileName &file) const;

  inline bool isEmpty() const throw()
  { return(_path.empty()); }

  inline size_t getDirectoryCount() const
  { return(length()); }

  inline size_t length() const
  { return(_path.size()); }

  String getDirectory(int index) const throw(OutOfBoundsException);

  inline String operator[](int index) const throw(OutOfBoundsException)
  { return(getDirectory(index)); }

  String getPath() const;

  void fromString(const String &path);

  inline String toString() const
  { return(getPath()); }

  static const SearchPath empty;

  static const char *separator;

  private:

  StringVec _path;
  mutable String _pathstr;
};

}; // namespace ccxx

#endif // __ccxx_SearchPath_hxx

/* end of header file */