source: trunk/yat/utility/FileUtil.h @ 711

#ifndef _theplu_yat_utility_fileutil_
#define _theplu_yat_utility_fileutil_ 

// $Id: FileUtil.h 711 2006-12-21 08:10:30Z jari $

/*
  Copyright (C) 2004 Jari Häkkinen
  Copyright (C) 2005 Peter Johansson
  Copyright (C) 2006 Jari Häkkinen

  This file is part of the yat library, http://lev.thep.lu.se/trac/yat

  The yat library 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.

  The yat 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
  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 "Exception.h"

#include <string>
#include <sys/stat.h>
#include <unistd.h>

namespace theplu {
namespace yat {
namespace utility {

  ///
  /// FileUtil is a utility class for checking file/directory
  /// existence and access permissions. FileUtil is a wrapper to
  /// access(2) and stat(2).
  ///
  class FileUtil {
  public:

    ///
    /// \brief Constructor, copies \a path only
    ///
    explicit FileUtil(const std::string& path);

    ///
    /// \brief Check file/directory permissions
    ///
    /// Check if access permissions match \a mode. \a mode must be
    /// given as r, w, x, or combinations of these letters. The check
    /// is performed att call time.
    ///
    /// \note Checking permissions on a non-existent file will match
    /// the permissions against the parent directory, but only the
    /// parent directory. This means that when the parent directory
    /// does not exist then fail is returned.
    ///
    /// \return On success (all requested permissions granted), zero
    /// is returned. On error (at least one bit in mode asked for a
    /// permission that is denied, or some other error occurred), -1
    /// is returned, and errno is set appropriately.
    ///
    /// \exception Throws whatever exists() throws.
    ///
    int permissions(const std::string& bits) const;

    ///
    /// \brief Check whether \a file exists.
    ///
    /// The check for the file is done when calling this function.
    ///
    /// \return True if \a file exists, false otherwise.
    ///
    /// \exception IO_error if underlying stat(2) call fails in other
    /// ways than that file does not exist.
    ///
    /// \see stat(2)
    ///
    bool exists(void) const;

    ///
    /// \brief Get path associated with the object.
    ///
    const std::string& path(void) const;

  private:
    ///
    /// \brief The copy constructor, not implemented
    ///
    FileUtil(const FileUtil&);

    std::string path_;
  };

}}} // of namespace utility, yat, and theplu

#endif