15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef UI_AURA_WINDOW_PROPERTY_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UI_AURA_WINDOW_PROPERTY_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/aura/aura_export.h" 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/aura/window.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This header should be included by code that defines WindowProperties. It 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// should not be included by code that only gets and sets WindowProperties. 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// To define a new WindowProperty: 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// #include "foo/foo_export.h" 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// #include "ui/aura/window_property.h" 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// DECLARE_EXPORTED_WINDOW_PROPERTY_TYPE(FOO_EXPORT, MyType); 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// namespace foo { 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// // Use this to define an exported property that is premitive, 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// // or a pointer you don't want automatically deleted. 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// DEFINE_WINDOW_PROPERTY_KEY(MyType, kMyKey, MyDefault); 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// // Use this to define an exported property whose value is a heap 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// // allocated object, and has to be owned and freed by the window. 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// DEFINE_OWNED_WINDOW_PROPERTY_KEY(gfx::Rect, kRestoreBoundsKey, NULL); 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// // Use this to define a non exported property that is primitive, 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// // or a pointer you don't want to automatically deleted, and is used 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// // only in a specific file. This will define the property in an unnamed 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// // namespace which cannot be accessed from another file. 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// DEFINE_LOCAL_WINDOW_PROPERTY_KEY(MyType, kMyKey, MyDefault); 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// } // foo namespace 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// To define a new type used for WindowProperty. 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// // outside all namespaces: 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// DECLARE_EXPORTED_WINDOW_PROPERTY_TYPE(FOO_EXPORT, MyType) 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// If a property type is not exported, use DECLARE_WINDOW_PROPERTY_TYPE(MyType) 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// which is a shorthand for DECLARE_EXPORTED_WINDOW_PROPERTY_TYPE(, MyType). 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace aura { 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace { 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// No single new-style cast works for every conversion to/from int64, so we 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// need this helper class. A third specialization is needed for bool because 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// MSVC warning C4800 (forcing value to bool) is not suppressed by an explicit 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// cast (!). 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)template<typename T> 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class WindowPropertyCaster { 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static int64 ToInt64(T x) { return static_cast<int64>(x); } 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static T FromInt64(int64 x) { return static_cast<T>(x); } 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)template<typename T> 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class WindowPropertyCaster<T*> { 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static int64 ToInt64(T* x) { return reinterpret_cast<int64>(x); } 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static T* FromInt64(int64 x) { return reinterpret_cast<T*>(x); } 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)template<> 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class WindowPropertyCaster<bool> { 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static int64 ToInt64(bool x) { return static_cast<int64>(x); } 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool FromInt64(int64 x) { return x != 0; } 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)template<typename T> 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct WindowProperty { 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) T default_value; 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char* name; 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Window::PropertyDeallocator deallocator; 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)template<typename T> 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void Window::SetProperty(const WindowProperty<T>* property, T value) { 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int64 old = SetPropertyInternal( 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) property, 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) property->name, 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) value == property->default_value ? NULL : property->deallocator, 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) WindowPropertyCaster<T>::ToInt64(value), 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) WindowPropertyCaster<T>::ToInt64(property->default_value)); 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (property->deallocator && 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) old != WindowPropertyCaster<T>::ToInt64(property->default_value)) { 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (*property->deallocator)(old); 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)template<typename T> 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)T Window::GetProperty(const WindowProperty<T>* property) const { 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return WindowPropertyCaster<T>::FromInt64(GetPropertyInternal( 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) property, WindowPropertyCaster<T>::ToInt64(property->default_value))); 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)template<typename T> 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void Window::ClearProperty(const WindowProperty<T>* property) { 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SetProperty(property, property->default_value); 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace aura 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Macros to instantiate the property getter/setter template functions. 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DECLARE_EXPORTED_WINDOW_PROPERTY_TYPE(EXPORT, T) \ 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) template EXPORT void aura::Window::SetProperty( \ 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const aura::WindowProperty<T >*, T); \ 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) template EXPORT T aura::Window::GetProperty( \ 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const aura::WindowProperty<T >*) const; \ 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) template EXPORT void aura::Window::ClearProperty( \ 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const aura::WindowProperty<T >*); 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DECLARE_WINDOW_PROPERTY_TYPE(T) \ 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DECLARE_EXPORTED_WINDOW_PROPERTY_TYPE(, T) 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DEFINE_WINDOW_PROPERTY_KEY(TYPE, NAME, DEFAULT) \ 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) COMPILE_ASSERT(sizeof(TYPE) <= sizeof(int64), property_type_too_large); \ 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) namespace { \ 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const aura::WindowProperty<TYPE> NAME ## _Value = {DEFAULT, #NAME, NULL}; \ 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } \ 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const aura::WindowProperty<TYPE>* const NAME = & NAME ## _Value; 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DEFINE_LOCAL_WINDOW_PROPERTY_KEY(TYPE, NAME, DEFAULT) \ 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) COMPILE_ASSERT(sizeof(TYPE) <= sizeof(int64), property_type_too_large); \ 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) namespace { \ 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const aura::WindowProperty<TYPE> NAME ## _Value = {DEFAULT, #NAME, NULL}; \ 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const aura::WindowProperty<TYPE>* const NAME = & NAME ## _Value; \ 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DEFINE_OWNED_WINDOW_PROPERTY_KEY(TYPE, NAME, DEFAULT) \ 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) namespace { \ 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Deallocator ## NAME (int64 p) { \ 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum { type_must_be_complete = sizeof(TYPE) }; \ 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) delete aura::WindowPropertyCaster<TYPE*>::FromInt64(p); \ 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } \ 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const aura::WindowProperty<TYPE*> NAME ## _Value = \ 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) {DEFAULT,#NAME,&Deallocator ## NAME}; \ 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } \ 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const aura::WindowProperty<TYPE*>* const NAME = & NAME ## _Value; 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // UI_AURA_WINDOW_PROPERTY_H_ 145