xapian-core/common/fileutils.h

   1 /** @file fileutils.h
   2  *  @brief File and path manipulation routines.
   3  */
   4 /* Copyright (C) 2008 Lemur Consulting Ltd
   5  * Copyright (C) 2008,2009,2010,2012 Olly Betts
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License as
   9  * published by the Free Software Foundation; either version 2 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  20  */
  21
  22 #ifndef XAPIAN_INCLUDED_FILEUTILS_H
  23 #define XAPIAN_INCLUDED_FILEUTILS_H
  24
  25 #include <string>
  26
  27 /** Remove a directory, and its contents.
  28  *
  29  *  If dirname doesn't refer to a file or directory, no error is generated.
  30  *
  31  *  Note - this doesn't currently cope with directories which contain
  32  *  subdirectories.
  33  */
  34 void removedir(const std::string &dirname);
  35
  36 /** Resolve @a path relative to @a base.
  37  *
  38  *  Return @a path qualified to work as if you did "chdir(<directory which base
  39  *  is in>)" first.
  40  */
  41 void resolve_relative_path(std::string & path, const std::string & base);
  42
  43 #endif /* XAPIAN_INCLUDED_FILEUTILS_H */