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
|
/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
/*
Sonic Visualiser
An audio file viewer and annotation editor.
Centre for Digital Music, Queen Mary, University of London.
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. See the file
COPYING included with this distribution for more information.
*/
#ifndef PLUGIN_SCAN_H
#define PLUGIN_SCAN_H
#include <QStringList>
#include <QMutex>
#include <vector>
#include <map>
#ifdef HAVE_PLUGIN_CHECKER_HELPER
#include "checker/knownplugincandidates.h"
#else
class KnownPluginCandidates {};
#endif
namespace sv {
class PluginScan
{
public:
static PluginScan *getInstance();
/**
* Carry out startup scan of available plugins. Do not call
* getCandidateLibrariesFor() unless this has been called and
* scanSucceeded() is returning true.
*
* If this has been called before, do nothing.
*/
void scan();
/**
* Return true if scan() completed successfully. If the scan
* failed, consider using the normal plugin path to load any
* available plugins (as if they had all been found to be
* loadable) rather than rejecting all of them -- i.e. consider
* falling back on the behaviour of code from before the scan
* logic was added.
*/
bool scanSucceeded() const;
enum PluginType {
VampPlugin,
LADSPAPlugin,
DSSIPlugin
};
struct Candidate {
QString libraryPath; // full path, not just soname
QString helperTag; // identifies the helper that found it
// (see HelperExecPath)
};
/**
* Return the candidate plugin libraries of the given type that
* were found by helpers during the startup scan.
*
* This could return an empty list for two reasons: the scan
* succeeded but no libraries were found; or the scan failed. Call
* scanSucceeded() to distinguish between them.
*/
QList<Candidate> getCandidateLibrariesFor(PluginType) const;
QString getStartupFailureReport() const;
private:
PluginScan();
~PluginScan();
void clear();
#ifdef HAVE_PLUGIN_CHECKER_HELPER
QString formatFailureMessage(QString helperTag,
std::pair<KnownPlugins::PluginType,
PluginCandidates::FailureRec>)
const;
QString formatFailureReport(QString helperTag,
std::vector<std::pair<KnownPlugins::PluginType,
PluginCandidates::FailureRec>>)
const;
#endif
mutable QMutex m_mutex; // while scanning; definitely can't multi-thread this
std::map<QString, KnownPluginCandidates *> m_kp; // tag -> KnownPlugins client
bool m_scanned;
bool m_succeeded;
class Logger;
Logger *m_logger;
};
} // end namespace sv
#endif
|
