src/Basics/Basics_DirUtils.hxx

   1 //  Copyright (C) 2007-2010  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 //  This library is free software; you can redistribute it and/or
   4 //  modify it under the terms of the GNU Lesser General Public
   5 //  License as published by the Free Software Foundation; either
   6 //  version 2.1 of the License.
   7 //
   8 //  This library is distributed in the hope that it will be useful,
   9 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 //  Lesser General Public License for more details.
  12 //
  13 //  You should have received a copy of the GNU Lesser General Public
  14 //  License along with this library; if not, write to the Free Software
  15 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 //  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 //  SALOME Utils : general SALOME's definitions and tools
  21 //  File   : Basics_DirUtils.hxx
  22 //  Autor  : Alexander A. BORODIN
  23 //  Module : SALOME
  24 //
  25 #ifndef _Basics_DIRUTILS_HXX_
  26 #define _Basics_DIRUTILS_HXX_
  27
  28 #include "SALOME_Basics.hxx"
  29
  30 #include <string>
  31
  32 namespace Kernel_Utils
  33 {
  34   // Extracts and returns the base name of the specified file name.
  35   BASICS_EXPORT std::string GetBaseName( const std::string& file_path );
  36
  37   // Returns the unique temporary directory, that is defined in tmp_path_env if this variable is set
  38   // otherwise return /tmp/something/ for Unix or c:\something\ for WIN32
  39   BASICS_EXPORT std::string GetTmpDirByEnv( const std::string& tmp_path_env );
  40
  41   // Returns the unique temporary directory, that is defined in tmp_path if this variable is set
  42   // otherwise return /tmp/something/ for Unix or c:\something\ for WIN32
  43   BASICS_EXPORT std::string GetTmpDirByPath( const std::string& tmp_path );
  44
  45   // Returns the unique temporary directory in
  46   // /tmp/something/ for Unix or c:\something\ for WIN32
  47   BASICS_EXPORT std::string GetTmpDir();
  48
  49
  50   // Returns the unique temporary file name without any extension
  51   // /tmp/something/file for Unix or c:\something\file for WIN32
  52   BASICS_EXPORT std::string GetTmpFileName();
  53
  54   // Returns True(False) if the path (not)exists
  55   BASICS_EXPORT bool IsExists( const std::string& path );
  56
  57   // Returns directory by path and converts it to native system format
  58   BASICS_EXPORT std::string GetDirByPath( const std::string& path );
  59
  60   // Returns True(False) if the path (not) empty
  61   // Also returns False if the path is not valid
  62   BASICS_EXPORT bool IsEmptyDir( const std::string& path );
  63 }
  64
  65 #endif