1 // Copyright (C) 2007-2020 CEA/DEN, EDF R&D, OPEN CASCADE
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, or (at your option) any later version.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 // SALOME Utils : general SALOME's definitions and tools
21 // File : Basics_DirUtils.hxx
22 // Author : Alexander A. BORODIN
25 #ifndef _Basics_DIRUTILS_HXX_
26 #define _Basics_DIRUTILS_HXX_
28 #include "SALOME_Basics.hxx"
32 namespace Kernel_Utils
34 // Extracts and returns the base name of the specified file name.
35 BASICS_EXPORT std::string GetBaseName( const std::string& file_path, bool with_extension = true );
37 // Extracts and returns the dir name of the specified file name.
38 BASICS_EXPORT std::string GetDirName( const std::string& file_path );
40 // Returns the unique temporary directory, that is defined in tmp_path_env if this variable is set
41 // otherwise return /tmp/something/ for Unix or c:\something\ for WIN32
42 BASICS_EXPORT std::string GetTmpDirByEnv( const std::string& tmp_path_env );
44 // Returns the unique temporary directory, that is defined in tmp_path if this variable is set
45 // otherwise return /tmp/something/ for Unix or c:\something\ for WIN32
46 BASICS_EXPORT std::string GetTmpDirByPath( const std::string& tmp_path );
48 // Returns the unique temporary directory in
49 // /tmp/something/ for Unix or c:\something\ for WIN32
50 BASICS_EXPORT std::string GetTmpDir();
52 // Returns the unique temporary file name without any extension
53 // /tmp/something/file for Unix or c:\something\file for WIN32
54 BASICS_EXPORT std::string GetTmpFileName();
56 // Adds extension in the end of the specified file name.
57 BASICS_EXPORT std::string AddExtension( const std::string& name );
59 // Returns True(False) if the path (not)exists
60 BASICS_EXPORT bool IsExists( const std::string& path );
62 // Returns True(False) if the path is writable
63 BASICS_EXPORT bool IsWritable( const std::string& path );
65 // Returns directory by path and converts it to native system format
66 BASICS_EXPORT std::string GetDirByPath( const std::string& path );
68 // Returns True(False) if the path (not) empty
69 // Also returns False if the path is not valid
70 BASICS_EXPORT bool IsEmptyDir( const std::string& path );
72 BASICS_EXPORT std::string BackSlashToSlash( const std::string& path );