pqEventTranslator.h

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

#ifndef _pqEventTranslator_h
#define _pqEventTranslator_h

#include "QtTestingExport.h"
#include <QObject>
#include <QRect>
#include <QRegularExpression>

class pqEventComment;
class pqTestUtility;
class pqWidgetEventTranslator;

/**
Manages serialization of user interaction for test-cases, demos, tutorials, etc.
pqEventTranslator installs itself as a global Qt event "filter" that receives notification of every
Qt event.  Each event is passed
through a collection of pqWidgetEventTranslator objects, until one of them "handles" the event.  The
pqWidgetEventTranslator objects
convert low-level Qt events (mouse move, button down, key released, etc) into high-level ParaView
events (button clicked, row selected, etc)
that can be serialized as text.  Once an event translator is found, the recordEvent() signal is
emitted with the name of the widget
that is receiving the event, plus the serialized event.  Observers such as pqEventObserverXML
connect to the recordEvent() signal and
handle storage of the events.

\sa pqWidgetEventTranslator, pqEventObserverStdout, pqEventObserverXML, pqEventPlayer.
*/
class QTTESTING_EXPORT pqEventTranslator : public QObject
{
  Q_OBJECT

public:
  pqEventTranslator(QObject* p = 0);
  ~pqEventTranslator() override;

  /** Adds the default set of widget translators to the working set.
  Translators are executed in order, so you may call addWidgetEventTranslator()
  with your own custom translators before calling this method,
  to "override" the default translators. */
  void addDefaultWidgetEventTranslators(pqTestUtility* util);
  /** Adds a new translator to the current working set of widget translators.
  pqEventTranslator assumes control of the lifetime of the supplied object.*/
  void addWidgetEventTranslator(pqWidgetEventTranslator*);
  /** Method to get a specific player */
  bool removeWidgetEventTranslator(const QString& className);
  /** Method to get a specific player */
  pqWidgetEventTranslator* getWidgetEventTranslator(const QString& className);

  /// Return a QList of all the Translators previously added.
  QList<pqWidgetEventTranslator*> translators() const;

  /// Add a new default eventComment in the scenario/recording to inform,
  /// intract with the user during the play back.
  void addDefaultEventManagers(pqTestUtility* util);
  /// Return the pqEventComment, to be able to add any comment events
  pqEventComment* eventComment() const;

  /// Adds @a object to a list of objects that will be ignored when
  /// translating events that have a command matching @a commandFilter
  /// (useful to prevent recording UI events from being
  /// captured as part of the recording)
  ///
  /// You may also choose to ignore commands by setting the
  /// "BlockRecordCommands" property of @a object to a QRegExp that will
  /// match the commands to block.  This is useful for temporarily blocking
  /// a command when a programatically change will fire a signal that generates
  /// a command.
  void ignoreObject(QObject* object,
    QRegularExpression commandFilter = QRegularExpression(
      ".*", QRegularExpression::CaseInsensitiveOption));

  /// start listening to the GUI and translating events
  void start();

  /// stop listening to the GUI and translating events
  void stop();

  /// Record check event instead of events
  void check(bool value);

  /// Activate/Deactivate recording
  void record(bool value);
  bool isRecording();

  /// Set the record interaction timings flag
  void recordInteractionTimings(bool value);

  /// Record a dashboard mode toggle event
  void recordDashboardModeToggle(QObject* object, bool toggle);

Q_SIGNALS:
  /// This signal will be emitted every time a translator generates a
  /// high-level ParaView event.  Observers should connect to this signal
  /// to serialize high-level events.
  void recordEvent(
    const QString& Object, const QString& Command, const QString& Arguments, int eventType);

  /// this signals when recording starts
  void started();

  /// this signals when recording stops
  void stopped();

private Q_SLOTS:
  // Slot called when recording an event
  void onRecordEvent(
    QObject* Object, const QString& Command, const QString& Arguments, int eventType);

  // Legacy convenient slot for pqEventTypes::ACTION_EVENT events
  void onRecordEvent(QObject* Object, const QString& Command, const QString& Arguments);

  // Slots called when widget request a specific size for the check overlay
  void setOverlayGeometry(const QRect& geometry, bool specific = true);

private:
  pqEventTranslator(const pqEventTranslator&);
  pqEventTranslator& operator=(const pqEventTranslator&);

  bool eventFilter(QObject* Object, QEvent* Event) override;
  int getWidgetEventTranslatorIndex(const QString& className);

  struct pqImplementation;
  pqImplementation* const Implementation;
};

#endif // !_pqEventTranslator_h