This repository was archived by the owner on Jul 19, 2026. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathrenderer_helpers.h
More file actions
61 lines (55 loc) · 2.09 KB
/
Copy pathrenderer_helpers.h
File metadata and controls
61 lines (55 loc) · 2.09 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
/*
* Functions for rendering using external "helper" programs.
* Copyright (c) 2021-2026 Benjamin Johnson
*
* 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.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef RENDERER_HELPERS_H
#define RENDERER_HELPERS_H
#include <QByteArray>
#include <QPair>
#include <QString>
#include <QStringList>
/*
* Find an external program to use with runHelper().
*
* This first checks the settings for a path specified by the user.
* If none was set, it defaults to the specified fallback, which
* becomes the new setting if it is found.
*
* If no valid executable is found, any existing setting is cleared.
*
* Returns the full path of the executable if the program is found,
* or an empty string otherwise.
*/
const QString findHelper(const QString &settingName,
const QString &fallback = QString());
/*
* Locate a program in the system's $PATH.
*
* Returns the full path to the program executable if found, or an empty
* string otherwise.
*/
const QString findInSystemPath(const QString &fileName);
/*
* Run an external program to convert a file into something we can display.
*
* Returns a QPair<bool, QByteArray> where:
* .first indicates whether the program ran successfully, and
* .second contains its output (including standard error in case of failure).
*/
using HelperResult = QPair<bool, QByteArray>;
HelperResult runHelper(const QString &program, const QStringList &arguments);
#endif /* RENDERER_HELPERS_H */