VTK  9.2.6
vtkPSystemTools.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkPSystemTools.h
5
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13
14 =========================================================================*/
29#ifndef vtkPSystemTools_h
30#define vtkPSystemTools_h
31
32#include "vtkObject.h"
33#include "vtkParallelCoreModule.h" // For export macro
34#include <string> // for string functions in SystemTools
35
36class VTKPARALLELCORE_EXPORT vtkPSystemTools : public vtkObject
37{
38public:
40 vtkTypeMacro(vtkPSystemTools, vtkObject);
41 void PrintSelf(ostream& os, vtkIndent indent) override;
42
49 static void BroadcastString(std::string&, int proc);
50
58 static VTK_FILEPATH std::string CollapseFullPath(VTK_FILEPATH const std::string& in_relative);
59 static VTK_FILEPATH std::string CollapseFullPath(
60 VTK_FILEPATH const std::string& in_relative, VTK_FILEPATH const char* in_base);
61
63
71 static bool FileExists(VTK_FILEPATH const char* filename, bool isFile);
72 static bool FileExists(VTK_FILEPATH const std::string& filename, bool isFile);
73 static bool FileExists(VTK_FILEPATH const char* filename);
74 static bool FileExists(VTK_FILEPATH const std::string& filename);
76
80 static bool FileIsDirectory(VTK_FILEPATH const std::string& name);
81
94 static bool FindProgramPath(const char* argv0, std::string& pathOut, std::string& errorMsg,
95 const char* exeName = nullptr, const char* buildDir = nullptr,
96 const char* installPrefix = nullptr);
97
101 static VTK_FILEPATH std::string GetCurrentWorkingDirectory(bool collapse = true);
102
108 static VTK_FILEPATH std::string GetProgramPath(VTK_FILEPATH const std::string&);
109
110protected:
111 vtkPSystemTools() = default;
112 ~vtkPSystemTools() override = default;
113
114private:
115 vtkPSystemTools(const vtkPSystemTools&) = delete;
116 void operator=(const vtkPSystemTools&) = delete;
117};
118
119#endif
a simple class to control print indentation
Definition: vtkIndent.h:40
abstract base class for most VTK objects
Definition: vtkObject.h:63
System tools for file system introspection.
static void BroadcastString(std::string &, int proc)
Given a string on process proc, broadcast that string to all of the other processes.
vtkPSystemTools()=default
static bool FileIsDirectory(VTK_FILEPATH const std::string &name)
Return true if the file is a directory.
static bool FileExists(VTK_FILEPATH const std::string &filename)
Return true if a file exists in the current directory.
static VTK_FILEPATH std::string GetProgramPath(VTK_FILEPATH const std::string &)
Given the path to a program executable, get the directory part of the path with the file stripped off...
static vtkPSystemTools * New()
~vtkPSystemTools() override=default
static VTK_FILEPATH std::string CollapseFullPath(VTK_FILEPATH const std::string &in_relative, VTK_FILEPATH const char *in_base)
static bool FileExists(VTK_FILEPATH const char *filename)
Return true if a file exists in the current directory.
static VTK_FILEPATH std::string CollapseFullPath(VTK_FILEPATH const std::string &in_relative)
Given a path to a file or directory, convert it to a full path.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static VTK_FILEPATH std::string GetCurrentWorkingDirectory(bool collapse=true)
Get current working directory CWD.
static bool FileExists(VTK_FILEPATH const std::string &filename, bool isFile)
Return true if a file exists in the current directory.
static bool FindProgramPath(const char *argv0, std::string &pathOut, std::string &errorMsg, const char *exeName=nullptr, const char *buildDir=nullptr, const char *installPrefix=nullptr)
Given argv[0] for a unix program find the full path to a running executable.
static bool FileExists(VTK_FILEPATH const char *filename, bool isFile)
Return true if a file exists in the current directory.
#define VTK_FILEPATH