[KLF Backend][KLF Tools][KLF Home]
KLatexFormula Project
klflatexpreviewthread.h
1 /***************************************************************************
2  * file klflatexpreviewthread.h
3  * This file is part of the KLatexFormula Project.
4  * Copyright (C) 2011 by Philippe Faist
5  * philippe.faist at bluewin.ch
6  * *
7  * This program is free software; you can redistribute it and/or modify *
8  * it under the terms of the GNU General Public License as published by *
9  * the Free Software Foundation; either version 2 of the License, or *
10  * (at your option) any later version. *
11  * *
12  * This program is distributed in the hope that it will be useful, *
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
15  * GNU General Public License for more details. *
16  * *
17  * You should have received a copy of the GNU General Public License *
18  * along with this program; if not, write to the *
19  * Free Software Foundation, Inc., *
20  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
21  ***************************************************************************/
22 /* $Id: klflatexpreviewthread.h 953 2016-12-27 00:13:10Z phfaist $ */
23 
24 #ifndef klflatexpreviewthread_H__
25 #define klflatexpreviewthread_H__
26 
27 #include <QThread>
28 #include <QMutex>
29 #include <QWaitCondition>
30 
31 #include <klfdefs.h>
32 #include <klfbackend.h>
33 
34 
35 struct KLFLatexPreviewThreadPrivate;
36 
38 {
39  Q_OBJECT
40 public:
41  KLFLatexPreviewHandler(QObject * parent = NULL) ;
42  virtual ~KLFLatexPreviewHandler();
43 
44 public slots:
46  virtual void latexPreviewReset();
47 
53  virtual void latexOutputAvailable(const KLFBackend::klfOutput& output) ;
56  virtual void latexPreviewAvailable(const QImage& preview, const QImage& largePreview, const QImage& fullPreview);
59  virtual void latexPreviewImageAvailable(const QImage& preview);
62  virtual void latexPreviewLargeImageAvailable(const QImage& largePreview);
64  virtual void latexPreviewFullImageAvailable(const QImage& fullPreview);
65 
68  virtual void latexPreviewError(const QString& errorString, int errorCode);
69 };
70 
71 
72 
74 {
75  Q_OBJECT
76 
77  Q_PROPERTY(QSize previewSize READ previewSize WRITE setPreviewSize) ;
78  Q_PROPERTY(QSize largePreviewSize READ largePreviewSize WRITE setLargePreviewSize) ;
79 
80 public:
81  KLFLatexPreviewThread(QObject *parent = NULL);
82  virtual ~KLFLatexPreviewThread();
83 
84  typedef qint64 TaskId;
85 
86  QSize previewSize() const;
87  QSize largePreviewSize() const;
88  void getPreviewSizes(QSize *previewsize, QSize *largepreviewsize) const;
89 
90  void setPreviewSize(const QSize& previewSize);
91  void setLargePreviewSize(const QSize& largePreviewSize);
92  void setPreviewSizes(const QSize& previewsize, const QSize& largepreviewsize) const;
93 
94  void cancelTask(TaskId task);
95  void clearPendingTasks();
96 
97  void start(Priority priority = InheritPriority);
98  void stop();
99 
100 public slots:
101 
102  TaskId submitPreviewTask(const KLFBackend::klfInput& input,
103  const KLFBackend::klfSettings& settings,
104  KLFLatexPreviewHandler * outputhandler,
105  const QSize& previewSize, const QSize& largePreviewSize);
106  TaskId submitPreviewTask(const KLFBackend::klfInput& input,
107  const KLFBackend::klfSettings& settings,
108  KLFLatexPreviewHandler * outputhandler);
109  TaskId clearAndSubmitPreviewTask(const KLFBackend::klfInput& input,
110  const KLFBackend::klfSettings& settings,
111  KLFLatexPreviewHandler * outputhandler,
112  const QSize& previewSize, const QSize& largePreviewSize);
113  TaskId clearAndSubmitPreviewTask(const KLFBackend::klfInput& input,
114  const KLFBackend::klfSettings& settings,
115  KLFLatexPreviewHandler * outputhandler);
116  TaskId replaceSubmitPreviewTask(TaskId replaceId,
117  const KLFBackend::klfInput& input,
118  const KLFBackend::klfSettings& settings,
119  KLFLatexPreviewHandler * outputhandler,
120  const QSize& previewSize, const QSize& largePreviewSize);
121  TaskId replaceSubmitPreviewTask(TaskId replaceId,
122  const KLFBackend::klfInput& input,
123  const KLFBackend::klfSettings& settings,
124  KLFLatexPreviewHandler * outputhandler);
125 
126 protected:
127  virtual void run();
128 
129 private:
131 
132  QMutex _startupmutex;
133  QWaitCondition _startupWaitCondition;
134 };
135 
136 
137 /*
138 class KLF_EXPORT KLFLatexPreviewThread : public QThread
139 {
140  Q_OBJECT
141 
142  Q_PROPERTY(QSize previewSize READ previewSize WRITE setPreviewSize) ;
143  Q_PROPERTY(QSize largePreviewSize READ largePreviewSize WRITE setLargePreviewSize) ;
144 
145 public:
146  KLFLatexPreviewThread(QObject *parent = NULL);
147  virtual ~KLFLatexPreviewThread();
148 
149  struct QueuedTask
150  {
151  QueuedTask() : isrunning(false), isfinished(false) { }
152 
153  inline int ref() { return refcount.ref(); }
154  inline int deref() { return refcount.deref(); }
155  private:
156  QAtomicInt refcount;
157 
158  friend class KLFLatexPreviewThread;
159  friend class KLFLatexPreviewThreadPrivate;
160  bool isrunning;
161  bool isfinished;
162  };
163 
164  QSize previewSize() const;
165  QSize largePreviewSize() const;
166 
167  KLFRefPtr<QueuedTask> submitPreviewTask(const KLFBackend::klfInput& input,
168  const KLFBackend::klfSettings& settings,
169  KLFLatexPreviewHandler * outputhandler,
170  const QSize& previewSize, const QSize& largePreviewSize);
171  KLFRefPtr<QueuedTask> submitPreviewTask(const KLFBackend::klfInput& input,
172  const KLFBackend::klfSettings& settings,
173  KLFLatexPreviewHandler * outputhandler);
174  KLFRefPtr<QueuedTask> clearAndSubmitPreviewTask(const KLFBackend::klfInput& input,
175  const KLFBackend::klfSettings& settings,
176  KLFLatexPreviewHandler * outputhandler,
177  const QSize& previewSize, const QSize& largePreviewSize);
178  KLFRefPtr<QueuedTask> clearAndSubmitPreviewTask(const KLFBackend::klfInput& input,
179  const KLFBackend::klfSettings& settings,
180  KLFLatexPreviewHandler * outputhandler);
181  bool cancelTask(KLFRefPtr<QueuedTask> task);
182  void clearPendingTasks();
183 
184  bool taskIsNew(KLFRefPtr<QueuedTask> task);
185  bool taskIsRunning(KLFRefPtr<QueuedTask> task);
186  bool taskIsFinished(KLFRefPtr<QueuedTask> task);
187 
188  void stop();
189 
190  void setPreviewSize(const QSize& previewSize);
191  void setLargePreviewSize(const QSize& largePreviewSize);
192 
193 protected:
194  virtual void run();
195 
196 private:
197  KLF_DECLARE_PRIVATE(KLFLatexPreviewThread) ;
198 
199  QMutex _mutex;
200 };
201 */
202 
203 
204 struct KLFContLatexPreviewPrivate;
205 
217 {
218  Q_OBJECT
219 
220  Q_PROPERTY(QSize previewSize READ previewSize WRITE setPreviewSize) ;
221  Q_PROPERTY(QSize largePreviewSize READ largePreviewSize WRITE setLargePreviewSize) ;
222 
223 public:
225  virtual ~KLFContLatexPreview();
226 
227  KLFBackend::klfInput intput() const;
228  KLFBackend::klfSettings settings() const;
229 
230  QSize previewSize() const;
231  QSize largePreviewSize() const;
232 
233  void setThread(KLFLatexPreviewThread * thread);
234 
235 signals:
237  void previewReset();
238 
244  void outputAvailable(const KLFBackend::klfOutput& output) ;
247  void previewAvailable(const QImage& preview, const QImage& largePreview, const QImage& fullPreview);
250  void previewImageAvailable(const QImage& preview);
253  void previewLargeImageAvailable(const QImage& largePreview);
255  void previewFullImageAvailable(const QImage& fullPreview);
256 
259  void previewError(const QString& errorString, int errorCode);
260 
262  void compiling(bool isCompiling);
263 
264 public slots:
268  bool setInput(const KLFBackend::klfInput& input);
270  bool setSettings(const KLFBackend::klfSettings& settings, bool disableExtraFormats = true);
273  bool setPreviewSize(const QSize& previewSize);
276  bool setLargePreviewSize(const QSize& largePreviewSize);
277 
278 private:
280 };
281 
282 
283 
284 #endif
Specific input to KLFBackend::getLatexFormula()
Definition: klfbackend.h:306
void start(Priority priority)
#define KLF_EXPORT
#define KLF_DECLARE_PRIVATE(ClassName)
virtual void run()
Definition of class KLFBackend.
KLFBackend::getLatexFormula() result.
Definition: klfbackend.h:370
General settings for KLFBackend::getLatexFormula()
Definition: klfbackend.h:218

Generated by doxygen 1.8.13