Basics_DirUtils.hxx

Go to the documentation of this file.

// Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//

//  SALOME Utils : general SALOME's definitions and tools
//  File   : Basics_DirUtils.hxx
//  Autor  : Alexander A. BORODIN
//  Module : SALOME
//
#ifndef _Basics_DIRUTILS_HXX_
#define _Basics_DIRUTILS_HXX_

#include "SALOME_Basics.hxx"

#include <string>

namespace Kernel_Utils
{
  // Extracts and returns the base name of the specified file name.
  BASICS_EXPORT std::string GetBaseName( const std::string& file_path );

  // Extracts and returns the dir name of the specified file name.
  BASICS_EXPORT std::string GetDirName( const std::string& file_path );

  // Returns the unique temporary directory, that is defined in tmp_path_env if this variable is set
  // otherwise return /tmp/something/ for Unix or c:\something\ for WIN32
  BASICS_EXPORT std::string GetTmpDirByEnv( const std::string& tmp_path_env );

  // Returns the unique temporary directory, that is defined in tmp_path if this variable is set
  // otherwise return /tmp/something/ for Unix or c:\something\ for WIN32
  BASICS_EXPORT std::string GetTmpDirByPath( const std::string& tmp_path );
  
  // Returns the unique temporary directory in 
  // /tmp/something/ for Unix or c:\something\ for WIN32
  BASICS_EXPORT std::string GetTmpDir();


  // Returns the unique temporary file name without any extension
  // /tmp/something/file for Unix or c:\something\file for WIN32
  BASICS_EXPORT std::string GetTmpFileName();

  // Returns True(False) if the path (not)exists
  BASICS_EXPORT bool IsExists( const std::string& path );

  // Returns True(False) if the path is writable
  BASICS_EXPORT bool IsWritable( const std::string& path );

  // Returns directory by path and converts it to native system format
  BASICS_EXPORT std::string GetDirByPath( const std::string& path );

  // Returns True(False) if the path (not) empty
  // Also returns False if the path is not valid
  BASICS_EXPORT bool IsEmptyDir( const std::string& path );
}

#endif