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
173
174
175
176
177
178
179
180
181
182
183
|
// Copyright 2016 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef UI_AURA_MUS_PROPERTY_CONVERTER_H_
#define UI_AURA_MUS_PROPERTY_CONVERTER_H_
#include <stdint.h>
#include <map>
#include <memory>
#include <string>
#include <vector>
#include "base/callback_forward.h"
#include "base/macros.h"
#include "ui/aura/aura_export.h"
#include "ui/aura/window.h"
namespace base {
class TimeDelta;
class UnguessableToken;
}
namespace gfx {
class Rect;
class Size;
}
namespace aura {
// PropertyConverter is used to convert Window properties for transport to the
// mus window server and back. Any time a property changes from one side it is
// mapped to the other using this class. Not all Window properties need to map
// to server properties, and similarly not all transport properties need map to
// Window properties.
class AURA_EXPORT PropertyConverter {
public:
// All primitive values are stored using this type.
using PrimitiveType = int64_t;
PropertyConverter();
~PropertyConverter();
// Creates a validation callback for use in RegisterProperty() which will
// accept any value.
static base::RepeatingCallback<bool(int64_t)> CreateAcceptAnyValueCallback();
// Returns the key for the window property registered against the specified
// transport name.
const void* GetPropertyKeyFromTransportName(const std::string& name);
// Returns true if RegisterProperty() has been called with the specified
// transport name.
bool IsTransportNameRegistered(const std::string& name) const;
// Maps a property on the Window to a property pushed to the server. Return
// true if the property should be sent to the server, false if the property
// is only used locally.
bool ConvertPropertyForTransport(
Window* window,
const void* key,
std::string* transport_name,
std::unique_ptr<std::vector<uint8_t>>* transport_value);
// Returns the transport name for a Window property.
std::string GetTransportNameForPropertyKey(const void* key);
// Applies a value from the server to |window|. |transport_name| is the
// name of the property and |transport_data| the value. |transport_data| may
// be null.
void SetPropertyFromTransportValue(
Window* window,
const std::string& transport_name,
const std::vector<uint8_t>* transport_data);
// Returns the value for a particular transport value. All primitives are
// serialized as a PrimitiveType, so this function may be used for any
// primitive. Returns true on success and sets |value| accordingly. A return
// value of false indicates the value isn't known or the property type isn't
// primitive.
bool GetPropertyValueFromTransportValue(
const std::string& transport_name,
const std::vector<uint8_t>& transport_data,
PrimitiveType* value);
// Register a property to support conversion between mus and aura.
// |validator| is a callback used to validate incoming values from
// transport_data; if it returns false, the value is rejected.
template <typename T>
void RegisterPrimitiveProperty(
const WindowProperty<T>* property,
const char* transport_name,
const base::RepeatingCallback<bool(int64_t)>& validator) {
DCHECK(!IsTransportNameRegistered(transport_name))
<< "Property already registered: " << transport_name;
PrimitiveProperty primitive_property;
primitive_property.property_name = property->name;
primitive_property.transport_name = transport_name;
primitive_property.default_value =
ui::ClassPropertyCaster<T>::ToInt64(property->default_value);
primitive_property.validator = validator;
primitive_properties_[property] = primitive_property;
transport_names_.insert(transport_name);
}
// Register owned properties to support conversion between mus and aura.
void RegisterImageSkiaProperty(
const WindowProperty<gfx::ImageSkia*>* property,
const char* transport_name);
void RegisterRectProperty(const WindowProperty<gfx::Rect*>* property,
const char* transport_name);
void RegisterSizeProperty(const WindowProperty<gfx::Size*>* property,
const char* transport_name);
void RegisterStringProperty(const WindowProperty<std::string*>* property,
const char* transport_name);
void RegisterString16Property(const WindowProperty<base::string16*>* property,
const char* transport_name);
void RegisterTimeDeltaProperty(
const WindowProperty<base::TimeDelta>* property,
const char* transport_name);
void RegisterUnguessableTokenProperty(
const WindowProperty<base::UnguessableToken*>* property,
const char* transport_name);
void RegisterWindowPtrProperty(const WindowProperty<Window*>* property,
const char* transport_name);
// Returns the window property key of Window* value which is registered with
// the transport_name. If the name is not registered or registered with a
// different type, returns nullptr.
const WindowProperty<Window*>* GetWindowPtrProperty(
const std::string& transport_name) const;
bool IsWindowPtrPropertyRegistered(
const WindowProperty<Window*>* property) const;
// Get a flat map of the window's registered properties, to use for transport.
base::flat_map<std::string, std::vector<uint8_t>> GetTransportProperties(
Window* window);
private:
// Contains data needed to store and convert primitive-type properties.
struct AURA_EXPORT PrimitiveProperty {
PrimitiveProperty();
PrimitiveProperty(const PrimitiveProperty& property);
~PrimitiveProperty();
// The aura::WindowProperty::name used for storage.
const char* property_name = nullptr;
// The mus property name used for transport.
const char* transport_name = nullptr;
// The aura::WindowProperty::default_value stored using PrimitiveType.
PrimitiveType default_value = 0;
// A callback used to validate incoming values.
base::RepeatingCallback<bool(int64_t)> validator;
};
// A map of aura::WindowProperty<T> to PrimitiveProperty structs.
// This supports the internal codepaths for primitive types, eg. T=bool.
std::map<const void*, PrimitiveProperty> primitive_properties_;
// Maps of aura::WindowProperty<T> to their mus property names.
// This supports types that can be serialized for Mojo, eg. T=std::string*.
std::map<const WindowProperty<gfx::ImageSkia*>*, const char*>
image_properties_;
std::map<const WindowProperty<gfx::Rect*>*, const char*> rect_properties_;
std::map<const WindowProperty<gfx::Size*>*, const char*> size_properties_;
std::map<const WindowProperty<std::string*>*, const char*> string_properties_;
std::map<const WindowProperty<base::string16*>*, const char*>
string16_properties_;
std::map<const WindowProperty<base::UnguessableToken*>*, const char*>
unguessable_token_properties_;
std::map<const WindowProperty<Window*>*, const char*> window_ptr_properties_;
// Set of transport names supplied to RegisterProperty().
std::set<std::string> transport_names_;
DISALLOW_COPY_AND_ASSIGN(PropertyConverter);
};
} // namespace aura
#endif // UI_AURA_MUS_PROPERTY_CONVERTER_H_
|
