Filesystem.hpp

Go to the documentation of this file.

/*

  This file is part of OpenFLUID software
  Copyright(c) 2007, INRA - Montpellier SupAgro


 == GNU General Public License Usage ==

  OpenFLUID 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.

  OpenFLUID 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 OpenFLUID. If not, see <http://www.gnu.org/licenses/>.


 == Other Usage ==

  Other Usage means a use of OpenFLUID that is inconsistent with the GPL
  license, and requires a written agreement between You and INRA.
  Licensees for Other Usage of OpenFLUID may use this file in accordance
  with the terms contained in the written agreement between You and INRA.
  
*/

/**
  @file Filesystem.hpp

  @author Jean-Christophe FABRE <jean-christophe.fabre@supagro.inra.fr>
*/



#ifndef __OPENFLUID_TOOLS_FILESYSTEM_HPP__
#define __OPENFLUID_TOOLS_FILESYSTEM_HPP__


#include <openfluid/dllexport.hpp>


namespace openfluid { namespace tools {


class OPENFLUID_API Filesystem
{

  public:

    /**
      Returns the name of the file in the given path
      @code{.cpp}
      name = openfluid::tools::Filesystem::filename("/tmp/archive.tar.gz")
      // name = archive.tar.gz
      @endcode
      @param[in] Path the given path
      @return the filename
    */
    static std::string filename(const std::string& Path);

    /**
      Returns the complete base name of the file in the given path
      @code{.cpp}
      name = openfluid::tools::Filesystem::basename("/tmp/archive.tar.gz")
      // name = archive.tar
      @endcode
      @param[in] Path the given path
      @return the base name of the file
    */
    static std::string basename(const std::string& Path);

    /**
      Returns the directory name (parent path) of the given path
      @code{.cpp}
      name = openfluid::tools::Filesystem::dirname("/tmp/archive.tar.gz")
      // name = /tmp
      @endcode
      @param[in] Path the given path
      @return the directory name
    */
    static std::string dirname(const std::string& Path);

    /**
      Returns the extension of the file of the given path
      @code{.cpp}
      name = openfluid::tools::Filesystem::extension("/tmp/archive.tar.gz")
      // name = gz
      @endcode
      @param[in] Path the given path
      @return the extension
    */
    static std::string extension(const std::string& Path);

    /**
      Returns the current application path
      @return the current path
    */
    static std::string currentPath();

    /**
      Returns true if the given path is a directory
      @param[in] Path the given path
      @return true or false
    */
    static bool isDirectory(const std::string& Path);

    /**
      Returns true if the given path is a file or a valid symbolic link
      @param[in] Path the given path
      @return true or false
    */
    static bool isFile(const std::string& Path);

    /**
      Creates the directory of the given path. It creates all parent directories necessary to create the directory.
      If the directory already exists, it does nothing.
      @param[in] Path the given path
      @return true if the directory was successfully created, false otherwise
    */
    static bool makeDirectory(const std::string& Path);

    /**
      Removes the directory of the given path. It recursively deletes all contents of the directory.
      @param[in] Path the given path
      @return true if the directory was successfully deleted, false otherwise
    */
    static bool removeDirectory(const std::string& Path);

    /**
      Removes the file of the given path.
      @param[in] Path the given path
      @return true if the file was successfully deleted, false otherwise
    */
    static bool removeFile(const std::string& Path);

    /**
      Copies a file from source to destination.
      @param[in] SrcPath the source path
      @param[in] DestPath the destination path
      @return true if the file was successfully copied, false otherwise
    */
    static bool copyFile(const std::string& SrcPath, const std::string& DestPath);

    /**
      Recursively copies a directory from source to destination.
      @param[in] SrcPath the source path
      @param[in] DestPath the destination path
      @param[in] DontCopyDotDirs if set to true, it ignores the directories beginning with a dot ('.').
                 Default is false
      @return true if the directory was successfully copied, false otherwise
    */
    static bool copyDirectory(const std::string& SrcPath, const std::string& DestPath,
                              const bool DontCopyDotDirs = false);

};

} }  // namespaces



#endif /* __OPENFLUID_TOOLS_FILESYSTEM_HPP__ */