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
|
/*
* This file is part of Poedit (https://poedit.net)
*
* Copyright (C) 2017-2026 Vaclav Slavik
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*
*/
#ifndef Poedit_qa_checks_h
#define Poedit_qa_checks_h
#include "catalog.h"
#include <memory>
#include <vector>
/// Interface for implementing quality checks
class QACheck
{
public:
virtual ~QACheck() {}
// Informal protocol for metadata:
// static const char *GetId();
// static wxString GetDescription();
virtual const char *GetCheckId() const = 0; // same as GetId()
// Implementation has to implement one of the CheckXXX() methods,
// it doesn't have to implement all of them.
/**
Checks given item for issues, possibly calling CatalogItem::SetIssue()
to flag it as broken. Returns true if an issue was found, false otherwise.
*/
virtual bool CheckItem(CatalogItemPtr item);
/// A more convenient API, checking only strings
virtual bool CheckString(CatalogItemPtr item, const wxString& source, const wxString& translation);
};
/// This class performs actual checking
class QAChecker
{
public:
/// Returns checker suitable for given file
static std::shared_ptr<QAChecker> GetFor(Catalog& catalog);
/// Returns metadata for the available checkers, as (id,description) pairs
static std::vector<std::pair<std::string, wxString>> GetMetadata();
/// Checks all items. Returns # of issues found.
int Check(Catalog& catalog);
/// Check a single item. Returns # of issues found.
int Check(CatalogItemPtr item);
// Low-level creation and setup:
QAChecker();
~QAChecker();
template<typename TCheck, typename... Args>
void AddCheck(Args&&... args)
{
if (IsCheckEnabled<TCheck>())
AddCheck(std::make_shared<TCheck>(args...));
}
void AddCheck(std::shared_ptr<QACheck> c) { m_checks.push_back(c); }
private:
template<typename TCheck>
bool IsCheckEnabled() const { return true; }
protected:
std::vector<std::shared_ptr<QACheck>> m_checks;
};
#endif // Poedit_qa_checks_h
|
