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
|
// Copyright (c) 2012 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_WINDOW_PROPERTY_H_
#define UI_AURA_WINDOW_PROPERTY_H_
#include "base/basictypes.h"
#include "ui/aura/aura_export.h"
#include "ui/aura/window.h"
// This header should be included by code that defines WindowProperties.
//
// To define a new WindowProperty:
//
// #include "foo/foo_export.h"
// #include "ui/aura/window_property.h"
//
// DECLARE_EXPORTED_WINDOW_PROPERTY_TYPE(FOO_EXPORT, MyType);
// namespace foo {
// // Use this to define an exported property that is premitive,
// // or a pointer you don't want automatically deleted.
// DEFINE_WINDOW_PROPERTY_KEY(MyType, kMyKey, MyDefault);
//
// // Use this to define an exported property whose value is a heap
// // allocated object, and has to be owned and freed by the window.
// DEFINE_OWNED_WINDOW_PROPERTY_KEY(gfx::Rect, kRestoreBoundsKey, NULL);
//
// // Use this to define a non exported property that is primitive,
// // or a pointer you don't want to automatically deleted, and is used
// // only in a specific file. This will define the property in an unnamed
// // namespace which cannot be accessed from another file.
// DEFINE_LOCAL_WINDOW_PROPERTY_KEY(MyType, kMyKey, MyDefault);
//
// } // foo namespace
//
// To define a new type used for WindowProperty.
//
// // outside all namespaces:
// DECLARE_EXPORTED_WINDOW_PROPERTY_TYPE(FOO_EXPORT, MyType)
//
// If a property type is not exported, use DECLARE_WINDOW_PROPERTY_TYPE(MyType)
// which is a shorthand for DECLARE_EXPORTED_WINDOW_PROPERTY_TYPE(, MyType).
namespace aura {
namespace {
// No single new-style cast works for every conversion to/from int64, so we
// need this helper class. A third specialization is needed for bool because
// MSVC warning C4800 (forcing value to bool) is not suppressed by an explicit
// cast (!).
template<typename T>
class WindowPropertyCaster {
public:
static int64 ToInt64(T x) { return static_cast<int64>(x); }
static T FromInt64(int64 x) { return static_cast<T>(x); }
};
template<typename T>
class WindowPropertyCaster<T*> {
public:
static int64 ToInt64(T* x) { return reinterpret_cast<int64>(x); }
static T* FromInt64(int64 x) { return reinterpret_cast<T*>(x); }
};
template<>
class WindowPropertyCaster<bool> {
public:
static int64 ToInt64(bool x) { return static_cast<int64>(x); }
static bool FromInt64(int64 x) { return x != 0; }
};
} // namespace
template<typename T>
struct WindowProperty {
T default_value;
const char* name;
Window::PropertyDeallocator deallocator;
};
namespace subtle {
class AURA_EXPORT PropertyHelper {
public:
template<typename T>
static void Set(Window* window, const WindowProperty<T>* property, T value) {
int64 old = window->SetPropertyInternal(
property,
property->name,
value == property->default_value ? nullptr : property->deallocator,
WindowPropertyCaster<T>::ToInt64(value),
WindowPropertyCaster<T>::ToInt64(property->default_value));
if (property->deallocator &&
old != WindowPropertyCaster<T>::ToInt64(property->default_value)) {
(*property->deallocator)(old);
}
}
template<typename T>
static T Get(const Window* window, const WindowProperty<T>* property) {
return WindowPropertyCaster<T>::FromInt64(window->GetPropertyInternal(
property, WindowPropertyCaster<T>::ToInt64(property->default_value)));
}
template<typename T>
static void Clear(Window* window, const WindowProperty<T>* property) {
window->SetProperty(property, property->default_value); \
}
};
} // namespace subtle
} // namespace aura
// Macros to instantiate the property getter/setter template functions.
#define DECLARE_EXPORTED_WINDOW_PROPERTY_TYPE(EXPORT, T) \
namespace aura { \
template<> EXPORT void aura::Window::SetProperty( \
const WindowProperty<T >* property, T value) { \
subtle::PropertyHelper::Set<T>(this, property, value); \
} \
template<> EXPORT T Window::GetProperty( \
const WindowProperty<T >* property) const { \
return subtle::PropertyHelper::Get<T>(this, property); \
} \
template<> EXPORT void Window::ClearProperty( \
const WindowProperty<T >* property) { \
subtle::PropertyHelper::Clear<T>(this, property); \
} \
}
#define DECLARE_WINDOW_PROPERTY_TYPE(T) \
DECLARE_EXPORTED_WINDOW_PROPERTY_TYPE(, T)
#define DEFINE_WINDOW_PROPERTY_KEY(TYPE, NAME, DEFAULT) \
COMPILE_ASSERT(sizeof(TYPE) <= sizeof(int64), property_type_too_large); \
namespace { \
const aura::WindowProperty<TYPE> NAME ## _Value = \
{DEFAULT, #NAME, nullptr}; \
} \
const aura::WindowProperty<TYPE>* const NAME = & NAME ## _Value;
#define DEFINE_LOCAL_WINDOW_PROPERTY_KEY(TYPE, NAME, DEFAULT) \
COMPILE_ASSERT(sizeof(TYPE) <= sizeof(int64), property_type_too_large); \
namespace { \
const aura::WindowProperty<TYPE> NAME ## _Value = \
{DEFAULT, #NAME, nullptr}; \
const aura::WindowProperty<TYPE>* const NAME = & NAME ## _Value; \
}
#define DEFINE_OWNED_WINDOW_PROPERTY_KEY(TYPE, NAME, DEFAULT) \
namespace { \
void Deallocator ## NAME (int64 p) { \
enum { type_must_be_complete = sizeof(TYPE) }; \
delete aura::WindowPropertyCaster<TYPE*>::FromInt64(p); \
} \
const aura::WindowProperty<TYPE*> NAME ## _Value = \
{DEFAULT,#NAME,&Deallocator ## NAME}; \
} \
const aura::WindowProperty<TYPE*>* const NAME = & NAME ## _Value;
#endif // UI_AURA_WINDOW_PROPERTY_H_
|
