libklatexformula3-dev 3.3.0~beta-1+b2 / usr / include / klfbackend / klflatexpreviewthread.h

/***************************************************************************
 *   file klflatexpreviewthread.h
 *   This file is part of the KLatexFormula Project.
 *   Copyright (C) 2011 by Philippe Faist
 *   philippe.faist at bluewin.ch
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
/* $Id: klflatexpreviewthread.h 903 2014-08-10 02:15:11Z phfaist $ */

#ifndef klflatexpreviewthread_H__
#define klflatexpreviewthread_H__

#include <QThread>
#include <QMutex>
#include <QWaitCondition>

#include <klfdefs.h>
#include <klfbackend.h>


class KLFLatexPreviewThreadPrivate;

class KLF_EXPORT KLFLatexPreviewHandler : public QObject
{
  Q_OBJECT
public:
  KLFLatexPreviewHandler(QObject * parent = NULL) ;
  virtual ~KLFLatexPreviewHandler();

public slots:
  /** Called whenever there is no preview to generate (input latex string empty) */
  virtual void latexPreviewReset();

  /** Called when a preview was successfully generated (i.e., <tt>output.status==0</tt>). The full
   * KLFBackend::klfOutput object is given here.
   *
   * Note that this method is called before the other latexPreview***Available() functions.
   */
  virtual void latexOutputAvailable(const KLFBackend::klfOutput& output) ;
  /** Called when a preview was successfully generated. All three images are given here (preview
   * size, large preview size, original image) */
  virtual void latexPreviewAvailable(const QImage& preview, const QImage& largePreview, const QImage& fullPreview);
  /** Called when a preview was successfully generated. Preview Size image. See also
   * \ref setPreviewSize(). */
  virtual void latexPreviewImageAvailable(const QImage& preview);
  /** Called when a preview was successfully generated. Large preview size image. See also
   * \ref setLargePreviewSize(). */
  virtual void latexPreviewLargeImageAvailable(const QImage& largePreview);
  /** Called when a preview was successfully generated. The original image is given. */
  virtual void latexPreviewFullImageAvailable(const QImage& fullPreview);

  /** Called when generation of the latex preview raised an error. See the error codes
   * defined in klfbackend.h */
  virtual void latexPreviewError(const QString& errorString, int errorCode);
};



class KLF_EXPORT KLFLatexPreviewThread : public QThread
{
  Q_OBJECT

  Q_PROPERTY(QSize previewSize READ previewSize WRITE setPreviewSize) ;
  Q_PROPERTY(QSize largePreviewSize READ largePreviewSize WRITE setLargePreviewSize) ;

public:
  KLFLatexPreviewThread(QObject *parent = NULL);
  virtual ~KLFLatexPreviewThread();

  typedef qint64 TaskId;

  QSize previewSize() const;
  QSize largePreviewSize() const;
  void getPreviewSizes(QSize *previewsize, QSize *largepreviewsize) const;

  void setPreviewSize(const QSize& previewSize);
  void setLargePreviewSize(const QSize& largePreviewSize);
  void setPreviewSizes(const QSize& previewsize, const QSize& largepreviewsize) const;

  void cancelTask(TaskId task);
  void clearPendingTasks();

  void start(Priority priority = InheritPriority);
  void stop();

public slots:

  TaskId submitPreviewTask(const KLFBackend::klfInput& input,
			   const KLFBackend::klfSettings& settings,
			   KLFLatexPreviewHandler * outputhandler,
			   const QSize& previewSize, const QSize& largePreviewSize);
  TaskId submitPreviewTask(const KLFBackend::klfInput& input,
			   const KLFBackend::klfSettings& settings,
			   KLFLatexPreviewHandler * outputhandler);
  TaskId clearAndSubmitPreviewTask(const KLFBackend::klfInput& input,
				   const KLFBackend::klfSettings& settings,
				   KLFLatexPreviewHandler * outputhandler,
				   const QSize& previewSize, const QSize& largePreviewSize);
  TaskId clearAndSubmitPreviewTask(const KLFBackend::klfInput& input,
				   const KLFBackend::klfSettings& settings,
				   KLFLatexPreviewHandler * outputhandler); 
  TaskId replaceSubmitPreviewTask(TaskId replaceId,
				  const KLFBackend::klfInput& input,
				  const KLFBackend::klfSettings& settings,
				  KLFLatexPreviewHandler * outputhandler,
				  const QSize& previewSize, const QSize& largePreviewSize);
  TaskId replaceSubmitPreviewTask(TaskId replaceId,
				  const KLFBackend::klfInput& input,
				  const KLFBackend::klfSettings& settings,
				  KLFLatexPreviewHandler * outputhandler); 

protected:
  virtual void run();

private:
  KLF_DECLARE_PRIVATE(KLFLatexPreviewThread) ;

  QMutex _startupmutex;
  QWaitCondition _startupWaitCondition;
};


/*
class KLF_EXPORT KLFLatexPreviewThread : public QThread
{
  Q_OBJECT

  Q_PROPERTY(QSize previewSize READ previewSize WRITE setPreviewSize) ;
  Q_PROPERTY(QSize largePreviewSize READ largePreviewSize WRITE setLargePreviewSize) ;

public:
  KLFLatexPreviewThread(QObject *parent = NULL);
  virtual ~KLFLatexPreviewThread();

  struct QueuedTask
  {
    QueuedTask() : isrunning(false), isfinished(false) { }

    inline int ref() { return refcount.ref(); }
    inline int deref() { return refcount.deref(); }
  private:
    QAtomicInt refcount;

    friend class KLFLatexPreviewThread;
    friend class KLFLatexPreviewThreadPrivate;
    bool isrunning;
    bool isfinished;
  };

  QSize previewSize() const;
  QSize largePreviewSize() const;

  KLFRefPtr<QueuedTask> submitPreviewTask(const KLFBackend::klfInput& input,
					  const KLFBackend::klfSettings& settings,
					  KLFLatexPreviewHandler * outputhandler,
 					  const QSize& previewSize, const QSize& largePreviewSize);
  KLFRefPtr<QueuedTask> submitPreviewTask(const KLFBackend::klfInput& input,
					  const KLFBackend::klfSettings& settings,
					  KLFLatexPreviewHandler * outputhandler);
  KLFRefPtr<QueuedTask> clearAndSubmitPreviewTask(const KLFBackend::klfInput& input,
						  const KLFBackend::klfSettings& settings,
						  KLFLatexPreviewHandler * outputhandler,
						  const QSize& previewSize, const QSize& largePreviewSize);
  KLFRefPtr<QueuedTask> clearAndSubmitPreviewTask(const KLFBackend::klfInput& input,
						  const KLFBackend::klfSettings& settings,
						  KLFLatexPreviewHandler * outputhandler);
  bool cancelTask(KLFRefPtr<QueuedTask> task);
  void clearPendingTasks();

  bool taskIsNew(KLFRefPtr<QueuedTask> task);
  bool taskIsRunning(KLFRefPtr<QueuedTask> task);
  bool taskIsFinished(KLFRefPtr<QueuedTask> task);

  void stop();

  void setPreviewSize(const QSize& previewSize);
  void setLargePreviewSize(const QSize& largePreviewSize);

protected:
  virtual void run();

private:
  KLF_DECLARE_PRIVATE(KLFLatexPreviewThread) ;

  QMutex _mutex;
};
*/


class KLFContLatexPreviewPrivate;

/**
 * A helper that runs in a different thread that generates previews in real-time as user types text,
 * without blocking the GUI.
 *
 * .......... UPDATE DOC FOR NEW THREAD OBJECT STRUCTURE ........
 *
 * \note returns (max.) three different image sizes set by setPreviewSize(), setLargePreviewSize() and
 *   the original image size. Setting an invalid size disables image generation of that particular preview
 *   size (might save resources by not resizing the image to that size).
 */
class KLF_EXPORT KLFContLatexPreview : public QObject
{
  Q_OBJECT

  Q_PROPERTY(QSize previewSize READ previewSize WRITE setPreviewSize) ;
  Q_PROPERTY(QSize largePreviewSize READ largePreviewSize WRITE setLargePreviewSize) ;

public:
  KLFContLatexPreview(KLFLatexPreviewThread * thread = NULL);
  virtual ~KLFContLatexPreview();

  KLFBackend::klfInput intput() const;
  KLFBackend::klfSettings settings() const;

  QSize previewSize() const;
  QSize largePreviewSize() const;

  void setThread(KLFLatexPreviewThread * thread);

signals:
  /** Emitted whenever there is no preview to generate (input latex string empty) */
  void previewReset();

  /** Emitted when a preview was successfully generated (i.e., <tt>output.status==0</tt>). The full
   * KLFBackend::klfOutput object is given here.
   *
   * Note that this signal is emitted before the other preview***Available() functions.
   */
  void outputAvailable(const KLFBackend::klfOutput& output) ;
  /** Emitted when a preview was successfully generated. All three images are given here (preview
   * size, large preview size, original image) */
  void previewAvailable(const QImage& preview, const QImage& largePreview, const QImage& fullPreview);
  /** Emitted when a preview was successfully generated. Preview Size image. See also
   * \ref setPreviewSize(). */
  void previewImageAvailable(const QImage& preview);
  /** Emitted when a preview was successfully generated. Large preview size image. See also
   * \ref setLargePreviewSize(). */
  void previewLargeImageAvailable(const QImage& largePreview);
  /** Emitted when a preview was successfully generated. The original image is given. */
  void previewFullImageAvailable(const QImage& fullPreview);

  /** Emitted when generation of the latex preview raised an error. See the error codes
   * defined in klfbackend.h */
  void previewError(const QString& errorString, int errorCode);

  /** Is emitted whenever there currently is a LaTeX formula compiling */
  void compiling(bool isCompiling);

public slots:
  /** \returns TRUE if the input was set, FALSE if current input is already equal to \c input.
   * The thread will then take care to generate the corresponding preview and emit the previewAvailable() etc.
   * signals. */
  bool setInput(const KLFBackend::klfInput& input);
  /** \returns TRUE if the settings were set, FALSE if current settings are already equal to \c settings */
  bool setSettings(const KLFBackend::klfSettings& settings, bool disableExtraFormats = true);
  /** \returns TRUE if the previewSize was set, FALSE if current preview size is already equal to
   * \c previewSize */
  bool setPreviewSize(const QSize& previewSize);
  /** \returns TRUE if the largePreviewSize was set, FALSE if current large preview size is already equal to
   * \c largePreviewSize */
  bool setLargePreviewSize(const QSize& largePreviewSize);

private:
  KLF_DECLARE_PRIVATE(KLFContLatexPreview) ;
};



#endif