#ifndef PATHDIRSRCH_H
#define PATHDIRSRCH_H

//$Id: PathDirSrch.h,v 1.14 2003/11/14 20:27:55 markus Rel $

// 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 2 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, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.


#include <string>

#include <YGP/DirSrch.h>
#include <YGP/PathSrch.h>


namespace YGP {

/**Class to search for files in directories listed in a path. This
   search can be restricted to files matching certain name-criterias
   or by attributes.

   The name-part of the files to search supports UNIX-like wildcards;
   that are the asterisk (*) for any number of any characters, the
   question-mark for any single character and a set of characters in
   brackets (([) and (])). This set can contain a list of characters
   (like [abcde]) or a region (like [a-e]). To invert this set use a
   leading caret (^) or a leading exclamation mark (!), like ([^a-e]).

   The found (and matching) files are retrieved by objects of type File.

   Note: The class does not do any word expansion for the search-path
         (like expanding the tilde (~) to the home-directory)!
*/
class PathDirectorySearch : public DirectorySearch {
 public:
   //@Section manager-functions
   /// Default constructur; creates an empty object, not ready to search for files
   PathDirectorySearch () : DirectorySearch (), searchPath ("") { }
   /// Constructur; creates an object with an path to files in.
   PathDirectorySearch (const std::string& path) : DirectorySearch ()
      , searchPath (path) { }
   /// Constructur; creates an object with an path to files in and the files
   /// to search for.
   PathDirectorySearch (const std::string& path, const std::string& search)
      : DirectorySearch (), srch (search), searchPath (path) { }
   virtual ~PathDirectorySearch ();

   /// Sets/Changes the path to search in.
   void setPath (const std::string& path) { searchPath = path; }

   /// \name Searching
   //@{
   /// Searches for the specified files with the passed attributes in all the
   /// nodes specified by \c path.
   /// \returns <tt>const File*</tt>: Pointer to found file or NULL
   const File* find (const std::string& path, const std::string& search,
	             unsigned long attribs = FILE_NORMAL) {
      setPath (path);
      srch = search;
      return find (attribs); }
   const File* find (const std::string& search,
                     unsigned long attribs = FILE_NORMAL) {
      srch = search;
      searchPath.reset ();
      return find (attribs); }

   virtual const File* find (unsigned long attribs = FILE_NORMAL);
   virtual const File* next ();
   //@}

 protected:
   virtual int checkIntegrity () const;

   enum { NO_PATH = DirectorySearch::LAST, LAST };

 private:
   std::string srch;
   PathSearch  searchPath;
};

}

#endif