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 DBUS_VALUES_UTIL_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DBUS_VALUES_UTIL_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "dbus/dbus_export.h" 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace base { 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Value; 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace dbus { 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class MessageReader; 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class MessageWriter; 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Pops a value from |reader| as a base::Value. 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Returns NULL if an error occurs. 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Note: Integer values larger than int32 (including uint32) are converted to 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// double. Non-string diciontary keys are converted to strings. 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)CHROME_DBUS_EXPORT base::Value* PopDataAsValue(MessageReader* reader); 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 25cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// Appends a basic type value to |writer|. Basic types are BOOLEAN, INTEGER, 26cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// DOUBLE, and STRING. Use this function for values that are known to be basic 27cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// types and to handle basic type members of collections that should not 28cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// have type "a{sv}" or "av". Otherwise, use AppendValueData. 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)CHROME_DBUS_EXPORT void AppendBasicTypeValueData(MessageWriter* writer, 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::Value& value); 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 32cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// Appends a basic type value to |writer| as a variant. Basic types are BOOLEAN, 33cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// INTEGER, DOUBLE, and STRING. Use this function for values that are known to 34cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// be basic types and to handle basic type members of collections that should 35cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// not have type "a{sv}" or "av". Otherwise, use AppendValueDataAsVariant. 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)CHROME_DBUS_EXPORT void AppendBasicTypeValueDataAsVariant( 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MessageWriter* writer, 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::Value& value); 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 40cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// Appends a value to |writer|. Value can be a basic type, as well as a 41cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// collection type, such as dictionary or list. Collections will be recursively 42cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// written as variant containers, i.e. dictionaries will be written with type 43cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// a{sv} and lists with type av. Any sub-dictionaries or sub-lists will also 44cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// have these types. 45cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)CHROME_DBUS_EXPORT void AppendValueData(MessageWriter* writer, 46cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) const base::Value& value); 47cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 48cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// Appends a value to |writer| as a variant. Value can be a basic type, as well 49cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// as a collection type, such as dictionary or list. Collections will be 50cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// recursively written as variant containers, i.e. dictionaries will be written 51cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// with type a{sv} and lists with type av. Any sub-dictionaries or sub-lists 52cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// will also have these types. 53cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)CHROME_DBUS_EXPORT void AppendValueDataAsVariant(MessageWriter* writer, 54cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) const base::Value& value); 55cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace dbus 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // DBUS_VALUES_UTIL_H_ 59