forked from KDE/ghostwriter
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathExporterFactory.cpp
More file actions
460 lines (409 loc) · 13.3 KB
/
Copy pathExporterFactory.cpp
File metadata and controls
460 lines (409 loc) · 13.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
/***********************************************************************
*
* Copyright (C) 2014-2019 wereturtle
*
* 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 3 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, see <http://www.gnu.org/licenses/>.
*
***********************************************************************/
#include <QProcess>
#include <QRegularExpression>
#include <QSettings>
#include "ExporterFactory.h"
#include "CmarkGfmExporter.h"
#include "CommandLineExporter.h"
ExporterFactory* ExporterFactory::instance = NULL;
ExporterFactory::~ExporterFactory()
{
// No need to delete Exporter instances, since this is a singleton class,
// and all will be destroyed upon quitting the application.
;
}
ExporterFactory* ExporterFactory::getInstance()
{
if (NULL == instance)
{
instance = new ExporterFactory();
}
return instance;
}
QList<Exporter*> ExporterFactory::getFileExporters()
{
return fileExporters;
}
QList<Exporter*> ExporterFactory::getHtmlExporters()
{
return htmlExporters;
}
Exporter* ExporterFactory::getExporterByName(const QString& name)
{
// Search in HTML exporter list first.
foreach (Exporter* exporter, htmlExporters)
{
if (exporter->getName() == name)
{
// Found a match!
return exporter;
}
}
// If HTML exporter list does not contain an exporter
// with the desired name, search in the file exporter
// list next.
//
foreach (Exporter* exporter, fileExporters)
{
if (exporter->getName() == name)
{
// Found a match!
return exporter;
}
}
// No match found.
return NULL;
}
ExporterFactory::ExporterFactory()
{
CommandLineExporter* exporter = NULL;
bool pandocIsAvailable = isCommandAvailable("pandoc --version");
bool mmdIsAvailable = isCommandAvailable("multimarkdown --version");
bool cmarkIsAvailable = isCommandAvailable("cmark --version");
CmarkGfmExporter* cmarkGfmExporter = new CmarkGfmExporter();
fileExporters.append(cmarkGfmExporter);
htmlExporters.append(cmarkGfmExporter);
if (pandocIsAvailable)
{
int majorVersion = 0;
int minorVersion = 0;
// Check whether version of Pandoc can read CommonMark.
QList<int> versionNumber = extractVersionNumber("pandoc --version");
if (versionNumber.length() > 0)
{
majorVersion = versionNumber[0];
if (versionNumber.length() > 1)
{
minorVersion = versionNumber[1];
}
}
addPandocExporter("Pandoc", "markdown", majorVersion, minorVersion);
if
(
(majorVersion > 1) ||
((1 == majorVersion) && (minorVersion >= 14))
)
{
addPandocExporter("Pandoc CommonMark", "commonmark", majorVersion, minorVersion);
}
addPandocExporter("Pandoc GitHub-flavored Markdown", "markdown_github-hard_line_breaks", majorVersion, minorVersion);
addPandocExporter("Pandoc PHP Markdown Extra", "markdown_phpextra", majorVersion, minorVersion);
addPandocExporter("Pandoc MultiMarkdown", "markdown_mmd", majorVersion, minorVersion);
addPandocExporter("Pandoc Strict", "markdown_strict", majorVersion, minorVersion);
}
if (mmdIsAvailable)
{
int majorVersion = 0;
QList<int> versionNumber = extractVersionNumber("multimarkdown --version");
if (versionNumber.length() > 0)
{
majorVersion = versionNumber[0];
}
exporter = new CommandLineExporter("MultiMarkdown");
// Smart typography option (--smart) is only availabe in version 5 and below.
// The option is was removed and enabled by default in version 6 and above.
//
if (majorVersion < 6)
{
exporter->setSmartTypographyOnArgument("--smart");
}
exporter->setSmartTypographyOffArgument("--nosmart");
exporter->setHtmlRenderCommand(QString("multimarkdown %1 -t html")
.arg(CommandLineExporter::SMART_TYPOGRAPHY_ARG));
exporter->addFileExportCommand
(
ExportFormat::HTML,
QString("multimarkdown %1 -t html -o %2")
.arg(CommandLineExporter::SMART_TYPOGRAPHY_ARG)
.arg(CommandLineExporter::OUTPUT_FILE_PATH_VAR)
);
// Version 6 removed ODF option and replaced it with ODT and FODT.
if (majorVersion >= 6)
{
exporter->addFileExportCommand
(
ExportFormat::ODT,
QString("multimarkdown %1 -t odt -o %2")
.arg(CommandLineExporter::SMART_TYPOGRAPHY_ARG)
.arg(CommandLineExporter::OUTPUT_FILE_PATH_VAR)
);
exporter->addFileExportCommand
(
ExportFormat::ODF,
QString("multimarkdown %1 -t fodt -o %2")
.arg(CommandLineExporter::SMART_TYPOGRAPHY_ARG)
.arg(CommandLineExporter::OUTPUT_FILE_PATH_VAR)
);
}
else
{
exporter->addFileExportCommand
(
ExportFormat::ODF,
QString("multimarkdown %1 -t odf -o %2")
.arg(CommandLineExporter::SMART_TYPOGRAPHY_ARG)
.arg(CommandLineExporter::OUTPUT_FILE_PATH_VAR)
);
}
// Version 6 added EPUB 3
if (majorVersion >= 6)
{
exporter->addFileExportCommand
(
ExportFormat::EPUBV3,
QString("multimarkdown %1 -b -t epub -o %2")
.arg(CommandLineExporter::SMART_TYPOGRAPHY_ARG)
.arg(CommandLineExporter::OUTPUT_FILE_PATH_VAR)
);
}
exporter->addFileExportCommand
(
ExportFormat::LATEX,
QString("multimarkdown %1 -t latex -o %2")
.arg(CommandLineExporter::SMART_TYPOGRAPHY_ARG)
.arg(CommandLineExporter::OUTPUT_FILE_PATH_VAR)
);
exporter->addFileExportCommand
(
ExportFormat::MEMOIR,
QString("multimarkdown %1 -t memoir -o %2")
.arg(CommandLineExporter::SMART_TYPOGRAPHY_ARG)
.arg(CommandLineExporter::OUTPUT_FILE_PATH_VAR)
);
exporter->addFileExportCommand
(
ExportFormat::LYX,
QString("multimarkdown %1 -t lyx -o %2")
.arg(CommandLineExporter::SMART_TYPOGRAPHY_ARG)
.arg(CommandLineExporter::OUTPUT_FILE_PATH_VAR)
);
fileExporters.append(exporter);
htmlExporters.append(exporter);
}
if (cmarkIsAvailable)
{
exporter = new CommandLineExporter("cmark");
exporter->setSmartTypographyOnArgument("--smart");
exporter->setHtmlRenderCommand(QString("cmark -t html --smart %1")
.arg(CommandLineExporter::SMART_TYPOGRAPHY_ARG));
exporter->addFileExportCommand
(
ExportFormat::HTML,
QString("cmark -t html %1")
.arg(CommandLineExporter::SMART_TYPOGRAPHY_ARG)
);
exporter->addFileExportCommand
(
ExportFormat::LATEX,
QString("cmark -t latex %1")
.arg(CommandLineExporter::SMART_TYPOGRAPHY_ARG)
);
exporter->addFileExportCommand
(
ExportFormat::MANPAGE,
QString("cmark -t man %1")
.arg(CommandLineExporter::SMART_TYPOGRAPHY_ARG)
);
fileExporters.append(exporter);
htmlExporters.append(exporter);
}
}
QList<int> ExporterFactory::extractVersionNumber(const QString& command) const
{
QList<int> versionNumber;
QProcess process;
process.start(command);
if (!process.waitForStarted(500))
{
return versionNumber;
}
else if (!process.waitForFinished(500))
{
process.kill();
return versionNumber;
}
QString versionStr = QString::fromUtf8(process.readAllStandardOutput().data());
QRegularExpression versionRegex1("v(\\d+(\\.\\d+)*)");
QRegularExpression versionRegex2("(\\d+(\\.\\d+)*)");
QRegularExpressionMatch match;
// Prefer searching for "v1.6.3" version format over "1.6.3" format
int pos = versionStr.indexOf(versionRegex1, 0, &match);
if ((pos >= 0) && match.hasMatch())
{
versionStr = match.captured(1);
}
// Else try the "1.6.3" format without the "v" in front
else
{
pos = versionStr.indexOf(versionRegex2, 0, &match);
if ((pos >= 0) && match.hasMatch())
{
versionStr = match.captured(1);
}
}
QStringList numbers = versionStr.split('.', QString::SkipEmptyParts);
foreach (QString num, numbers)
{
versionNumber.append(num.toInt());
}
return versionNumber;
}
bool ExporterFactory::isCommandAvailable(const QString& testCommand) const
{
QProcess process;
process.start(testCommand);
if (!process.waitForStarted(500))
{
return false;
}
else if (!process.waitForFinished(500))
{
process.kill();
}
return true;
}
void ExporterFactory::addPandocExporter
(
const QString& name,
const QString& inputFormat,
int majorVersion,
int minorVersion
)
{
Q_UNUSED(minorVersion)
CommandLineExporter* exporter = new CommandLineExporter(name);
if (majorVersion >= 2)
{
exporter->setSmartTypographyOnArgument("+smart");
exporter->setSmartTypographyOffArgument("-smart");
}
else
{
exporter->setSmartTypographyOnArgument(" --smart");
}
exporter->setHtmlRenderCommand
(
QString("pandoc --mathml -f ") +
inputFormat +
CommandLineExporter::SMART_TYPOGRAPHY_ARG +
" -t html"
);
QString standardExportStr;
if (majorVersion >= 2)
{
standardExportStr =
QString("pandoc -f ") +
inputFormat +
CommandLineExporter::SMART_TYPOGRAPHY_ARG +
" -t %1 --standalone --mathml --quiet -o " +
CommandLineExporter::OUTPUT_FILE_PATH_VAR;
}
else
{
// older Pandoc releases don't know the option '--quiet'
standardExportStr =
QString("pandoc -f ") +
inputFormat +
CommandLineExporter::SMART_TYPOGRAPHY_ARG +
" -t %1 --standalone --mathml -o " +
CommandLineExporter::OUTPUT_FILE_PATH_VAR;
}
exporter->addFileExportCommand
(
ExportFormat::HTML,
standardExportStr.arg("html")
);
exporter->addFileExportCommand
(
ExportFormat::HTML5,
standardExportStr.arg("html5")
);
exporter->addFileExportCommand
(
ExportFormat::ODT,
standardExportStr.arg("odt")
);
exporter->addFileExportCommand
(
ExportFormat::ODF,
standardExportStr.arg("opendocument")
);
exporter->addFileExportCommand
(
ExportFormat::RTF,
standardExportStr.arg("rtf")
);
exporter->addFileExportCommand
(
ExportFormat::DOCX,
standardExportStr.arg("docx")
);
exporter->addFileExportCommand
(
ExportFormat::PDF_LATEX,
standardExportStr.arg("latex") +
" -Vlinkcolor=blue -Vcitecolor=blue -Vurlcolor=blue -Vtoccolor=blue -Vmargin-left=1in -Vmargin-right=1in -Vmargin-top=1in -Vmargin-bottom=1in"
);
exporter->addFileExportCommand
(
ExportFormat::PDF_CONTEXT,
standardExportStr.arg("context") +
" --variable pagenumbering:location=footer --variable layout:header=0mm --variable layout:top=1in --variable layout:bottom=1in --variable layout:leftmargin=1in --variable layout:rightmargin=1in -Vlinkcolor=blue"
);
// Note: Do not use --mathjax option with WKHTMLTOPDF export, as this will
// cause pandoc to hang.
//
exporter->addFileExportCommand
(
ExportFormat::PDF_WKHTML,
standardExportStr.arg("html5") +
" -Vmargin-left=1in -Vmargin-right=1in -Vmargin-top=1in -Vmargin-bottom=1in"
);
exporter->addFileExportCommand
(
ExportFormat::EPUBV2,
standardExportStr.arg("epub") +
" --toc --toc-depth 6"
);
exporter->addFileExportCommand
(
ExportFormat::EPUBV3,
standardExportStr.arg("epub3") +
" --toc --toc-depth 6"
);
exporter->addFileExportCommand
(
ExportFormat::FICTIONBOOK2,
standardExportStr.arg("fb2") +
" --toc --toc-depth 6"
);
exporter->addFileExportCommand
(
ExportFormat::LATEX,
standardExportStr.arg("latex")
);
exporter->addFileExportCommand
(
ExportFormat::GROFFMAN,
standardExportStr.arg("man")
);
fileExporters.append(exporter);
htmlExporters.append(exporter);
}