vtkPVStandardPaths Class Reference

Utilities methods to get standard paths. More...

#include <vtkPVStandardPaths.h>

Static Public Member Functions
static std::vector< std::string >	GetSystemDirectories ()
	Return system data directories, depending on operating system: More...
static std::vector< std::string >	GetInstallDirectories ()
	Returns paths relative to install directory. More...
static std::string	GetUserSettingsDirectory ()
	Get directory for user settings file. More...
static std::string	GetUserSettingsFilePath ()
	Get file path for the user settings file. More...

Detailed Description

Utilities methods to get standard paths.

Methods to get useful paths depending on the current operating system and on the running application:

• system directories depends only on the system
• install directories are relative to the running application
• user directory is a conventional user space. It is expected to be writeable.

Different environment variables are taken into account, trying to respect diffent system convention:

• unix-like: https://specifications.freedesktop.org/basedir-spec/0.8

This class has only static methods to access standard paths used by ParaView and is not meant to be instantiated.

Definition at line 33 of file vtkPVStandardPaths.h.

Member Function Documentation

GetSystemDirectories()

static std::vector<std::string> vtkPVStandardPaths::GetSystemDirectories ( )

static

Return system data directories, depending on operating system:

• Windows: Uses COMMON_APPDATA:
• MacOS - linux: Honorates XDG_DATA_DIRS, falling back to /usr/share and /usr/local/share. https://specifications.freedesktop.org/basedir-spec/0.8/

GetInstallDirectories()

static std::vector<std::string> vtkPVStandardPaths::GetInstallDirectories ( )

static

Returns paths relative to install directory.

• the exectutable dir
• the <install> dir: the executable dir or its parent if executable is under a "bin" dir.
• <install>/lib <install>/share/paraview-<version>
• MacOs specific:
  • package <root>: <install>/../../..
  • lib, lib-paraview-<version>, Support as <root> subdirs.

GetUserSettingsDirectory()

static std::string vtkPVStandardPaths::GetUserSettingsDirectory ( )

static

Get directory for user settings file.

The last character is always the file path separator appropriate for the system.

• Windows: honors APPDATA environment variable
• linux/MacOs: honors xdg convention:
  • $XDG_DATA_HOME environment first
  • $HOME/.config/<organization-name> then see: https://specifications.freedesktop.org/basedir-spec/0.8/

GetUserSettingsFilePath()

static std::string vtkPVStandardPaths::GetUserSettingsFilePath ( )

static

Get file path for the user settings file.

Construct server settings file path: <GetUserSettingsDirectory()>/<GetApplicationName()>-UserSettings.json

See also

vtkInitializationHelper::GetApplicationName()

---

The documentation for this class was generated from the following file:

• /builds/gitlab-kitware-sciviz-ci/Remoting/Application/vtkPVStandardPaths.h