]> SALOME platform Git repositories - tools/libbatch.git/blob - src/Core/Batch_Utils.hxx
Salome HOME
Fix remote directories in file transfer and merge some tests
[tools/libbatch.git] / src / Core / Batch_Utils.hxx
1 //  Copyright (C) 2007-2012  CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 //  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
6 //  This library is free software; you can redistribute it and/or
7 //  modify it under the terms of the GNU Lesser General Public
8 //  License as published by the Free Software Foundation; either
9 //  version 2.1 of the License.
10 //
11 //  This library is distributed in the hope that it will be useful,
12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 //  Lesser General Public License for more details.
15 //
16 //  You should have received a copy of the GNU Lesser General Public
17 //  License along with this library; if not, write to the Free Software
18 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19 //
20 //  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22 /*
23  * Batch_Utils.hxx
24  *
25  *  Created on: 30 jan. 2012
26  *  Author : Renaud BARATE - EDF R&D
27  */
28
29 #ifndef BATCH_UTILS_HXX_
30 #define BATCH_UTILS_HXX_
31
32 #include <string>
33
34 namespace Batch {
35
36 class Utils {
37 public:
38
39   /**
40    * Call a command with the system shell and stores its output in parameter "output".
41    * Returns the return code of the command.
42    */
43   static int getCommandOutput(const std::string & command, std::string & output);
44
45   /**
46    * Test if the path in parameter is an absolute path (does not test the existence of
47    * a file or directory at this path).
48    */
49   static bool isAbsolutePath(const std::string & path);
50
51   /**
52    * Create a temporary file and open an output stream to write into this file.
53    * The file is created with the pattern "<tmpdir>/libbatch-<prefix>-XXXXXX" where <tmpdir> is the
54    * directory for temporary files and the X's are replaced by random characters. The caller is
55    * responsible for closing and deleting the file when it is no more used.
56    * <tmpdir> is found by looking for environment variables TEMP, TMP, TEMPDIR, TMPDIR, and defaults
57    * to "/tmp" if none of them is defined.
58    * \param prefix the prefix to use for the temporary file.
59    * \param outputStream an output stream that will be opened for writing in the temporary file. If
60    * the stream is already open, it will be closed first.
61    * \return the name of the created file.
62    */
63   static std::string createAndOpenTemporaryFile(const std::string & prefix,
64                                                 std::ofstream & outputStream);
65
66 private:
67
68   // No instanciation possible as this class provides only static methods
69   Utils() { }
70
71 };
72
73 }
74
75 #endif /* BATCH_UTILS_HXX_ */