pqServerLauncher.h

Go to the documentation of this file.

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

#include "pqComponentsModule.h"
#include <QObject>
#include <QProcess> // needed for QProcess::ProcessError.

class pqServer;
class pqServerConfiguration;
class QDialog;
class QProcessEnvironment;
class vtkObject;

class PQCOMPONENTS_EXPORT pqServerLauncher : public QObject
{
  Q_OBJECT
  typedef QObject Superclass;

public:
  pqServerLauncher(const pqServerConfiguration& configuration, QObject* parent = nullptr);
  ~pqServerLauncher() override;

  static const QMetaObject* setServerDefaultLauncherType(const QMetaObject*);
  static const QMetaObject* defaultServerLauncherType();

  static pqServerLauncher* newInstance(
    const pqServerConfiguration& configuration, QObject* parent = nullptr);

  bool connectToServer(bool showConnectionDialog = true);

  pqServer* connectedServer() const;

protected Q_SLOTS:
  void processFailed(QProcess::ProcessError);
  void readStandardOutput();
  void readStandardError();
  void launchServerForReverseConnection();

protected: // NOLINT(readability-redundant-access-specifiers)
  bool promptOptions();

  virtual bool launchServer(bool show_status_dialog);

  bool processCommand(QString command, double processWait, double delay,
    const QProcessEnvironment* options = nullptr);

  virtual bool connectToPrelaunchedServer(bool showConnectionDialog = true);

  bool isReverseConnection() const;

  virtual void prepareDialogForPromptOptions(QDialog&) {}

  pqServerConfiguration& configuration() const;

  QProcessEnvironment& options() const;

  virtual void updateOptionsUsingUserSelections();

  virtual void handleProcessStandardOutput(const QByteArray& data);
  virtual void handleProcessErrorOutput(const QByteArray& data);

private:
  Q_DISABLE_COPY(pqServerLauncher)

  class pqInternals;
  pqInternals* Internals;
  static const QMetaObject* DefaultServerLauncherType;
  bool WrongConnectId;
};

#endif