pqPythonFileIO.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 pqPythonFileIO_h
#define pqPythonFileIO_h

#include "pqPythonModule.h"

#include "pqPythonUtils.h"

#include "vtkType.h" // For vtkTypeUInt32

#include <QAction>
#include <QDir>
#include <QObject>
#include <QString>

#include <iostream>

class QTextEdit;

class PQPYTHON_EXPORT pqPythonFileIO : public QObject
{
  Q_OBJECT
public:
  pqPythonFileIO() = delete;

  pqPythonFileIO(QWidget* parent, QTextEdit& text);

  ~pqPythonFileIO() override;

  bool saveOnClose();

  bool openFile(const QString& filename, vtkTypeUInt32 location = 0x10 /*vtkPVSession::CLIENT*/);

  void setDefaultSaveDirectory(const QString& dir) { this->DefaultSaveDirectory = dir; }

  const QString& getFilename() const { return this->File.Name; }

  vtkTypeUInt32 getLocation() const { return this->File.Location; }

  bool isDirty() const;

Q_SIGNALS:
  void bufferErased();

  void fileOpened(const QString&);

  void fileSaved(const QString&);

  void contentChanged();

public Q_SLOTS:
  void setModified(bool modified);

  bool save();

  bool saveAs();

  bool saveAsMacro();

  bool saveAsScript();

private:
  struct PythonFile
  {
    PythonFile() = default;

    PythonFile(const QString& str, const vtkTypeUInt32 location, QTextEdit* textEdit)
      : Name(str)
      , Location(location)
      , Text(textEdit)
    {
    }

    bool operator!=(const PythonFile& other) const { return this->Name != other.Name; }

    bool writeToFile() const;

    bool readFromFile(QString& str) const;

    void start();

    void removeSwap() const;

    QString Name = "";
    vtkTypeUInt32 Location = 0x10 /*vtkPVSession::CLIENT*/;
    QTextEdit* Text = nullptr;
  } File;

  bool saveBuffer(const QString& file, vtkTypeUInt32 location);

  QTextEdit& TextEdit;

  QString DefaultSaveDirectory = QDir::homePath();
};

#endif // pqPythonFileIO_h