summaryrefslogtreecommitdiffstats
path: root/src/qtattributionsscanner/scanner.h
blob: 01c9a8b61c987786d2e2ca5c6be1a774b1f06b07 (plain)
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
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0

#ifndef SCANNER_H
#define SCANNER_H

#include "logging.h"
#include "package.h"

#include <QtCore/qstring.h>
#include <QtCore/qlist.h>

#include <optional>

namespace Scanner {

enum class InputFormat {
    QtAttributions = 0x1, // qt_attributions.json
    ChromiumAttributions = 0x2, // README.chromium
};
Q_DECLARE_FLAGS(InputFormats, InputFormat)
Q_DECLARE_OPERATORS_FOR_FLAGS(InputFormats)

enum class Check { Paths = 0x1, All = Paths };
Q_DECLARE_FLAGS(Checks, Check)
Q_DECLARE_OPERATORS_FOR_FLAGS(Checks)

std::optional<QList<Package>> readFile(const QString &filePath, Checks checks, LogLevel logLevel);
std::optional<QList<Package>> scanDirectory(const QString &directory, InputFormats inputFormats,
                                            Checks checks, LogLevel logLevel);
}

#endif // SCANNER_H