src/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$ */

#ifndef klflatexpreviewthread_H__
#define klflatexpreviewthread_H__

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

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


struct KLFLatexPreviewThreadPrivate;

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

public slots:
  virtual void latexPreviewReset();

  virtual void latexOutputAvailable(const KLFBackend::klfOutput& output) ;
  virtual void latexPreviewAvailable(const QImage& preview, const QImage& largePreview, const QImage& fullPreview);
  virtual void latexPreviewImageAvailable(const QImage& preview);
  virtual void latexPreviewLargeImageAvailable(const QImage& largePreview);
  virtual void latexPreviewFullImageAvailable(const QImage& fullPreview);

  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;
};





struct KLFContLatexPreviewPrivate;

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();

  bool enabled() const;

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

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

  void setThread(KLFLatexPreviewThread * thread);

signals:
  void previewReset();

  void outputAvailable(const KLFBackend::klfOutput& output) ;
  void previewAvailable(const QImage& preview, const QImage& largePreview, const QImage& fullPreview);
  void previewImageAvailable(const QImage& preview);
  void previewLargeImageAvailable(const QImage& largePreview);
  void previewFullImageAvailable(const QImage& fullPreview);

  void previewError(const QString& errorString, int errorCode);

  void compiling(bool isCompiling);

public slots:

  void setEnabled(bool enabled);

  bool setInput(const KLFBackend::klfInput& input);
  bool setSettings(const KLFBackend::klfSettings& settings, bool disableExtraFormats = true);
  bool setPreviewSize(const QSize& previewSize);
  bool setLargePreviewSize(const QSize& largePreviewSize);

private:
  KLF_DECLARE_PRIVATE(KLFContLatexPreview) ;
};



#endif