OpenMS  2.4.0
File.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2018.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Chris Bielow $
32 // $Authors: Andreas Bertsch, Chris Bielow, Marc Sturm $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
38 #include <OpenMS/config.h>
39 
40 
41 namespace OpenMS
42 {
43  class Param;
44  class TOPPBase;
45 
51  class OPENMS_DLLAPI File
52  {
53 public:
54 
55  friend class TOPPBase;
56 
61  static String getExecutablePath();
62 
64  static bool exists(const String& file);
65 
67  static bool empty(const String& file);
68 
83  static bool rename(const String& from, const String& to, bool overwrite_existing = true, bool verbose = true);
84 
90  static bool remove(const String& file);
91 
93  static bool removeDirRecursively(const String& dir_name);
94 
96  static bool removeDir(const QString& dir_name);
97 
99  static String absolutePath(const String& file);
100 
102  static String basename(const String& file);
103 
105  static String path(const String& file);
106 
114  static String removeExtension(const String& file);
115 
117  static bool readable(const String& file);
118 
120  static bool writable(const String& file);
121 
123  static bool isDirectory(const String& path);
124 
135  static String find(const String& filename, StringList directories = StringList());
136 
143  static bool fileList(const String& dir, const String& file_pattern, StringList& output, bool full_path = false);
144 
161  static String findDoc(const String& filename);
162 
169  static String getUniqueName(bool include_hostname = true);
170 
172  static String getOpenMSDataPath();
173 
175  static String getOpenMSHomePath();
176 
178  static String getTempDirectory();
179 
185  static String getUserDirectory();
186 
192  static Param getSystemParameters();
193 
197  static String findDatabase(const String& db_name);
198 
205  static String findExecutable(const String& toolName);
206 
223  static const String& getTemporaryFile(const String& alternative_file = "");
224 
225 private:
226 
228  static Param getSystemParameterDefaults_();
229 
231  static bool isOpenMSDataPath_(const String& path);
232 
233 
238  {
239  public:
240  TemporaryFiles_();
242  const String& newFile();
243 
244  ~TemporaryFiles_();
245  private:
246  TemporaryFiles_(const TemporaryFiles_&) = delete; // copy is forbidden
247  TemporaryFiles_& operator=(const TemporaryFiles_&) = delete;
249  };
250 
251 
254 
255  };
256 
257 }
258 
A more convenient string class.
Definition: String.h:57
StringList filenames_
Definition: File.h:248
static TemporaryFiles_ temporary_files_
private list of temporary filenames, which are deleted upon program exit
Definition: File.h:253
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
Base class for TOPP applications.
Definition: TOPPBase.h:150
bool find(TFinder &finder, const Pattern< TNeedle, FuzzyAC > &me, PatternAuxData< TNeedle > &dh)
Definition: AhoCorasickAmbiguous.h:884
Internal helper class, which holds temporary filenames and deletes these files at program exit...
Definition: File.h:237
Basic file handling operations.
Definition: File.h:51
std::vector< String > StringList
Vector of String.
Definition: ListUtils.h:73
Management and storage of parameters / INI files.
Definition: Param.h:74
int verbose
Verbosity level ( "-v" is 1 and "-V" is 2 )