1 // Copyright (C) 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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, or (at your option) any later version.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
25 * Created on: 30 jan. 2012
26 * Author : Renaud BARATE - EDF R&D
29 #ifndef BATCH_UTILS_HXX_
30 #define BATCH_UTILS_HXX_
40 * Call a command with the system shell and stores its output in parameter "output".
41 * Returns the return code of the command.
43 static int getCommandOutput(const std::string & command, std::string & output);
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).
49 static bool isAbsolutePath(const std::string & path);
52 * Returns the directory name of a path.
53 * "/a/b/file.txt" -> "/a/b"
57 static std::string dirname(const std::string & path);
60 * Test if the string in parameter begins with '-' and it should be processed
61 * as an option, not as a path.
63 static bool isOption(const std::string & val);
66 * Test if the path in parameter contains a "/./" sequence.
68 static bool usesRsyncRelativePath(const std::string & path);
71 * Create a temporary file and open an output stream to write into this file.
72 * The file is created with the pattern "<tmpdir>/libbatch-<prefix>-XXXXXX" where <tmpdir> is the
73 * directory for temporary files and the X's are replaced by random characters. The caller is
74 * responsible for closing and deleting the file when it is no more used.
75 * <tmpdir> is found by looking for environment variables TEMP, TMP, TEMPDIR, TMPDIR, and defaults
76 * to "/tmp" if none of them is defined.
77 * \param prefix the prefix to use for the temporary file.
78 * \param outputStream an output stream that will be opened for writing in the temporary file. If
79 * the stream is already open, it will be closed first.
80 * \return the name of the created file.
82 static std::string createAndOpenTemporaryFile(const std::string & prefix,
83 std::ofstream & outputStream);
86 * Change permissions of a file
88 static int chmod(const char *path, int mode);
91 * Sleep for the number of specified seconds
93 static void sleep(unsigned int seconds);
96 * Simple method to fix path strings depending on the platform. On Windows, it will replace
97 * forward slashes '/' by backslashes '\'. On Unix, the path is just copied without change.
99 static std::string fixPath(const std::string & path);
103 // No instanciation possible as this class provides only static methods
110 #endif /* BATCH_UTILS_HXX_ */