vtkInitializationHelper.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkInitializationHelper_h
#define vtkInitializationHelper_h

#include "vtkObject.h"
#include "vtkParaViewDeprecation.h"       // for deprecation macros
#include "vtkRemotingApplicationModule.h" // needed for exports
#include <string>                         // needed for std::string

#if PARAVIEW_USE_PYTHON
#include "vtkPythonInterpreter.h"
#endif

class vtkCLIOptions;
class vtkRemotingCoreConfiguration;
class vtkStringList;

class VTKREMOTINGAPPLICATION_EXPORT vtkInitializationHelper : public vtkObject
{
public:
  vtkTypeMacro(vtkInitializationHelper, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static bool Initialize(int argc, char** argv, int processType, vtkCLIOptions* options = nullptr,
    bool enableStandardArgs = true);

  static bool Initialize(vtkStringList* argv, int processType);

  static bool Initialize(const char* executable, int type);

  static bool InitializeProcessModule(int argc, char** argv, int type);

  static bool InitializeGlobalOptions(int argc, char** argv, int processType,
    vtkCLIOptions* options = nullptr, bool enableStandardArgs = true);

  static bool InitializeOtherOptions(int argc, char** argv, int processType,
    vtkCLIOptions* options = nullptr, bool enableStandardArgs = true);

  static bool InitializeOptions(int argc, char** argv, int processType,
    vtkCLIOptions* options = nullptr, bool enableStandardArgs = true);

  static bool InitializeSettings(int type, bool defaultCoreConfig);

  static bool InitializeOthers();

  PARAVIEW_DEPRECATED_IN_5_13_0("Use InitializeSettings and InitializeOthers instead")
  static bool InitializeMiscellaneous(int type);

  static void InitializePythonVirtualEnvironment();

  static void Finalize();

  static int GetExitCode() { return vtkInitializationHelper::ExitCode; }


  static void StandaloneInitialize();
  static void StandaloneFinalize();


  static void SetLoadSettingsFilesDuringInitialization(bool);
  static bool GetLoadSettingsFilesDuringInitialization();


  static void SetOrganizationName(const std::string& organizationName);
  static const std::string& GetOrganizationName();


  static void SetApplicationName(const std::string& appName);
  static const std::string& GetApplicationName();

  PARAVIEW_DEPRECATED_IN_5_13_0("Use vtkPVStandardPaths::GetUserSettingsDirectory instead")
  static std::string GetUserSettingsDirectory();

  PARAVIEW_DEPRECATED_IN_5_13_0("Use vtkPVStandardPaths::GetUserSettingsFilePath instead")
  static std::string GetUserSettingsFilePath();

protected:
  vtkInitializationHelper() = default;
  ~vtkInitializationHelper() override = default;

  static void LoadSettings();

private:
  vtkInitializationHelper(const vtkInitializationHelper&) = delete;
  void operator=(const vtkInitializationHelper&) = delete;

  static bool ParseOptions(int argc, char** argv, vtkCLIOptions* options,
    vtkRemotingCoreConfiguration* coreConfig, bool checkForExit);

  static bool LoadSettingsFilesDuringInitialization;
  static bool SaveUserSettingsFileDuringFinalization;
  static std::string OrganizationName;
  static std::string ApplicationName;
  static int ExitCode;
};

#endif