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
|
/*
enumdefinition.h
This file is part of GammaRay, the Qt application inspection and manipulation tool.
SPDX-FileCopyrightText: 2016 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
Author: Volker Krause <volker.krause@kdab.com>
SPDX-License-Identifier: GPL-2.0-or-later
Contact KDAB at <info@kdab.com> for commercial licensing options.
*/
#ifndef GAMMARAY_ENUMDEFINITION_H
#define GAMMARAY_ENUMDEFINITION_H
#include "gammaray_common_export.h"
#include "enumvalue.h"
#include <QVector>
namespace GammaRay {
/*! A single element of an EnumDefinition. */
class GAMMARAY_COMMON_EXPORT EnumDefinitionElement
{
public:
EnumDefinitionElement() = default;
/*! Create a new enum definition element with name @p name and value @p value. */
EnumDefinitionElement(int value, const char *name);
/*! The numeric value represented of this enum definition element. */
int value() const;
/*! The name of this enum definition element. */
QByteArray name() const;
private:
friend QDataStream &operator<<(QDataStream &out, const EnumDefinitionElement &elem);
friend QDataStream &operator>>(QDataStream &in, EnumDefinitionElement &elem);
int m_value = 0;
QByteArray m_name;
};
/*! Target-independent representation of an enum or flag definition. */
class GAMMARAY_COMMON_EXPORT EnumDefinition
{
public:
EnumDefinition() = default;
/*! Create a new definition for an enum named @p name and internal id @p id. */
explicit EnumDefinition(EnumId id, const QByteArray &name);
/*! Returns whether this is a valid enum definition.
* This means it's a enum definition registered with the EnumRepository
* and there is at least one enum definition element present.
*/
bool isValid() const;
/*! A unique identifier for this enum definition.
* This is used to identify enums between the GammaRay client and server.
*/
EnumId id() const;
/*! The name of the enum. */
QByteArray name() const;
/*! Returns @c true if this enum is used as a flag. */
bool isFlag() const;
/*! Returns the individual elements of this enum.
* That is, the key/value pairs of its definition.
*/
const QVector<EnumDefinitionElement> &elements() const;
//! @cond internal
void setElements(const QVector<EnumDefinitionElement> &elements);
void setIsFlag(bool isFlag);
//! @endcond
/*! Converts the given enum value into a string representation. */
QByteArray valueToString(const EnumValue &value) const;
private:
friend GAMMARAY_COMMON_EXPORT QDataStream &operator<<(QDataStream &out, const EnumDefinition &def);
friend GAMMARAY_COMMON_EXPORT QDataStream &operator>>(QDataStream &in, EnumDefinition &def);
EnumId m_id = InvalidEnumId;
bool m_isFlag = false;
QByteArray m_name;
QVector<EnumDefinitionElement> m_elements;
};
///@cond internal
GAMMARAY_COMMON_EXPORT QDataStream &operator<<(QDataStream &out, const EnumDefinition &def);
GAMMARAY_COMMON_EXPORT QDataStream &operator>>(QDataStream &in, EnumDefinition &def);
///@endcond
}
Q_DECLARE_METATYPE(GammaRay::EnumDefinition)
QT_BEGIN_NAMESPACE
Q_DECLARE_TYPEINFO(GammaRay::EnumDefinitionElement, Q_MOVABLE_TYPE);
Q_DECLARE_TYPEINFO(GammaRay::EnumDefinition, Q_MOVABLE_TYPE);
QT_END_NAMESPACE
#endif // GAMMARAY_ENUMDEFINITION_H
|
