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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
/*
protocol.h
This file is part of GammaRay, the Qt application inspection and manipulation tool.
SPDX-FileCopyrightText: 2013 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_PROTOCOL_H
#define GAMMARAY_PROTOCOL_H
#include "gammaray_common_export.h"
#include <QAbstractItemModel>
#include <QDataStream>
#include <QDebug>
#include <QVector>
#include <QModelIndex>
#include <limits>
namespace GammaRay {
/*! Helper functions and constants defining the communication protocol between client and server. */
namespace Protocol {
/*! Message payload size type. */
using PayloadSize = qint32;
/*! Remote object address type. */
using ObjectAddress = quint16;
/*! Message type type. */
using MessageType = quint8;
/*! Invalid object address. */
static const ObjectAddress InvalidObjectAddress = 0;
/*! Address of the launcher remote object for probe <-> launcher communication. */
static const ObjectAddress LauncherAddress = std::numeric_limits<ObjectAddress>::max();
/*! Invalid message type. */
static const MessageType InvalidMessageType = 0;
/*! Protocol message types. */
enum BuildInMessageType
{
// object management
// client -> server
ObjectMonitored = InvalidMessageType + 1,
ObjectUnmonitored,
// server -> client
ServerVersion,
ServerDataVersionNegotiated,
ObjectMapReply,
ObjectAdded,
ObjectRemoved,
// remote model messages
// client -> server
ClientDataVersionNegotiated,
ModelRowColumnCountRequest,
ModelContentRequest,
ModelHeaderRequest,
ModelSetDataRequest,
ModelSortRequest,
ModelSyncBarrier,
SelectionModelStateRequest,
ModelCreationDeclartionLocationRequest,
// server -> client
ModelRowColumnCountReply,
ModelContentReply,
ModelContentChanged,
ModelHeaderReply,
ModelHeaderChanged,
ModelRowsAdded,
ModelRowsMoved,
ModelRowsRemoved,
ModelColumnsAdded,
ModelColumnsMoved,
ModelColumnsRemoved,
ModelReset,
ModelLayoutChanged,
ModelCreationDeclartionLocationReply,
// server <-> client
SelectionModelSelect,
SelectionModelCurrent,
MethodCall,
PropertySyncRequest,
PropertyValuesChanged,
ServerInfo,
// probe settings provided by the launcher
ProbeSettings,
ServerAddress,
ServerLaunchError,
MESSAGE_TYPE_COUNT // NOTE when changing this enum, also update MessageStatisticsModel!
};
///@cond internal
/*! Transport protocol representation of a model index element. */
class ModelIndexData
{
public:
explicit ModelIndexData(qint32 row_ = 0, qint32 column_ = 0)
: row(row_)
, column(column_)
{
}
qint32 row;
qint32 column;
};
/*! Transport protocol representation of a QModelIndex. */
using ModelIndex = QVector<ModelIndexData>;
/*! Protocol representation of an QItemSelectionRange. */
struct ItemSelectionRange
{
ModelIndex topLeft;
ModelIndex bottomRight;
};
/*! Protocol representation of an QItemSelection. */
using ItemSelection = QVector<ItemSelectionRange>;
/*! Serializes a QModelIndex. */
GAMMARAY_COMMON_EXPORT ModelIndex fromQModelIndex(const QModelIndex &index);
/*! Deserializes a QModelIndex. */
GAMMARAY_COMMON_EXPORT QModelIndex toQModelIndex(const QAbstractItemModel *model,
const ModelIndex &index);
///@endcond
/*! Protocol version, must match exactly between client and server. */
GAMMARAY_COMMON_EXPORT qint32 version();
/*! Broadcast format version. */
GAMMARAY_COMMON_EXPORT qint32 broadcastFormatVersion();
}
}
///@cond internal
QT_BEGIN_NAMESPACE
inline QDataStream &operator>>(QDataStream &s, GammaRay::Protocol::ModelIndexData &data)
{
s >> data.row >> data.column;
return s;
}
inline QDataStream &operator<<(QDataStream &s, const GammaRay::Protocol::ModelIndexData &data)
{
s << data.row << data.column;
return s;
}
inline QDebug &operator<<(QDebug &s, const GammaRay::Protocol::ModelIndexData &data)
{
s << '(' << data.row << ',' << data.column << ')';
return s;
}
///@endcond
Q_DECLARE_TYPEINFO(GammaRay::Protocol::ModelIndexData, Q_MOVABLE_TYPE);
Q_DECLARE_TYPEINFO(GammaRay::Protocol::ItemSelectionRange, Q_MOVABLE_TYPE);
QT_END_NAMESPACE
#endif
|
