cartobase  5.0.5
fileutil.h
Go to the documentation of this file.
1 /* This software and supporting documentation are distributed by
2  * Institut Federatif de Recherche 49
3  * CEA/NeuroSpin, Batiment 145,
4  * 91191 Gif-sur-Yvette cedex
5  * France
6  *
7  * This software is governed by the CeCILL-B license under
8  * French law and abiding by the rules of distribution of free software.
9  * You can use, modify and/or redistribute the software under the
10  * terms of the CeCILL-B license as circulated by CEA, CNRS
11  * and INRIA at the following URL "http://www.cecill.info".
12  *
13  * As a counterpart to the access to the source code and rights to copy,
14  * modify and redistribute granted by the license, users are provided only
15  * with a limited warranty and the software's author, the holder of the
16  * economic rights, and the successive licensors have only limited
17  * liability.
18  *
19  * In this respect, the user's attention is drawn to the risks associated
20  * with loading, using, modifying and/or developing or reproducing the
21  * software by the user in light of its specific status of free software,
22  * that may mean that it is complicated to manipulate, and that also
23  * therefore means that it is reserved for developers and experienced
24  * professionals having in-depth computer knowledge. Users are therefore
25  * encouraged to load and test the software's suitability as regards their
26  * requirements in conditions enabling the security of their systems and/or
27  * data to be ensured and, more generally, to use and operate it in the
28  * same conditions as regards security.
29  *
30  * The fact that you are presently reading this means that you have had
31  * knowledge of the CeCILL-B license and that you accept its terms.
32  */
33 
34 #ifndef CARTOBASE_STREAM_FILEUTIL_H
35 #define CARTOBASE_STREAM_FILEUTIL_H
36 
38 #include <string>
39 #include <list>
40 
41 
42 #ifdef _WIN32
43 #define CARTOBASE_STREAM_NULLDEVICE "nul"
44 #else
45 #define CARTOBASE_STREAM_NULLDEVICE "/dev/null"
46 #endif
47 
48 namespace carto
49 {
50  class Object;
51 
53  class FileUtil
54  {
55  public:
56  //==========================================================================
57  // P A T H S
58  //==========================================================================
60  static char separator();
64  static char pathSeparator();
73  static std::string basename( const std::string & );
79  static std::string dirname( const std::string & );
84  static std::string fileStat( const std::string & );
86  static std::string extension( const std::string & );
88  static std::string removeExtension( const std::string & );
90  static bool isAbsPath( const std::string & path );
105  static std::string temporaryFile( const std::string & prefix, int & fd );
107  static std::string temporaryDirectory( const std::string & prefix );
110  static std::list<std::string>
111  filenamesSplit( const std::string & filenames,
112  const std::string & separator );
113 
115  static std::string windowsFilename(const std::string & filename);
116 
119  static std::string linuxFilename(const std::string & filename);
120 
121  //==========================================================================
122  // U R I
123  //==========================================================================
127 
130  static std::string uriFilename( const std::string & filein );
134  static Object uriOptions( const std::string & filein );
137  static std::string uriCopyOptions( const std::string & filein );
138 
139  };
140 
141 }
142 
143 #endif
static std::string linuxFilename(const std::string &filename)
Replaces backslashes with slashes characters on Windows OS on other OS, leaves filename unchanged...
static std::string extension(const std::string &)
returns the file extension (without the dot)
static std::string basename(const std::string &)
this is NOT conform to basename() from libgen: ::basename( "/" ) = "/", carto::FileUtil::basename( "/...
Files and filenames portable utilities.
Definition: fileutil.h:53
static std::string fileStat(const std::string &)
Checks file existence, type and read/write permission.
static std::string removeExtension(const std::string &)
returns the filename without its extension
static std::string windowsFilename(const std::string &filename)
Replaces slashes with backslashes characters.
static char separator()
returns &#39;/&#39; on Unix systems and &#39;\&#39; on Windows systems
static std::string temporaryFile(const std::string &prefix, int &fd)
opens a temporary file.
static std::string uriCopyOptions(const std::string &filein)
Extracts the options from the URI and returns them as a string : "?options1=this&option2=that".
*static char pathSeparator()
character separating paths in a list (generally in an environment variable).
static std::string dirname(const std::string &)
this is NOT conform to dirname() from libgen: ::dirname( "/usr/" ) = "/", carto::FileUtil::dirname( "...
static bool isAbsPath(const std::string &path)
true if path is an absolute path, false if it is relative
static std::list< std::string > filenamesSplit(const std::string &filenames, const std::string &separator)
interpret the filenames string as a list of filenames and split it.
static std::string uriFilename(const std::string &filein)
It is possible to treat an URI (Uniform Resource Identifier) instead of a simple path.
static std::string temporaryDirectory(const std::string &prefix)
Creates a temporary directory.
static Object uriOptions(const std::string &filein)
Extracts the options from the URI and returns them as a dictionary of strings : ( "options1" => "this...