1eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch/* Copyright 2013 The Chromium Authors. All rights reserved. 22a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * Use of this source code is governed by a BSD-style license that can be 32a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * found in the LICENSE file. 42a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) */ 52a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 6eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch/* From ppb_var_dictionary.idl modified Sat Jun 8 23:03:54 2013. */ 72a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 8eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#ifndef PPAPI_C_PPB_VAR_DICTIONARY_H_ 9eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#define PPAPI_C_PPB_VAR_DICTIONARY_H_ 102a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 112a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "ppapi/c/pp_bool.h" 122a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "ppapi/c/pp_macros.h" 132a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "ppapi/c/pp_stdint.h" 142a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "ppapi/c/pp_var.h" 152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 16eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#define PPB_VAR_DICTIONARY_INTERFACE_1_0 "PPB_VarDictionary;1.0" 17eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#define PPB_VAR_DICTIONARY_INTERFACE PPB_VAR_DICTIONARY_INTERFACE_1_0 182a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 192a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)/** 202a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @file 21eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * This file defines the <code>PPB_VarDictionary</code> struct providing 222a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * a way to interact with dictionary vars. 232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) */ 242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 252a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)/** 272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @addtogroup Interfaces 282a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @{ 292a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) */ 302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)/** 312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * A dictionary var contains key-value pairs with unique keys. The keys are 322a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * strings while the values can be arbitrary vars. Key comparison is always 332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * done by value instead of by reference. 342a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) */ 35eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdochstruct PPB_VarDictionary_1_0 { 362a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) /** 372a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * Creates a dictionary var, i.e., a <code>PP_Var</code> with type set to 382a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * <code>PP_VARTYPE_DICTIONARY</code>. 392a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * 402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @return An empty dictionary var, whose reference count is set to 1 on 412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * behalf of the caller. 422a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) */ 432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) struct PP_Var (*Create)(void); 442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) /** 452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * Gets the value associated with the specified key. 462a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * 472a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @param[in] dict A dictionary var. 482a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @param[in] key A string var. 492a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * 502a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @return The value that is associated with <code>key</code>. The reference 51eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * count of the element returned is incremented on behalf of the caller. If 52eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * <code>key</code> is not a string var, or it doesn't exist in 53eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * <code>dict</code>, an undefined var is returned. 542a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) */ 552a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) struct PP_Var (*Get)(struct PP_Var dict, struct PP_Var key); 562a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) /** 57eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * Sets the value associated with the specified key. 582a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * 592a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @param[in] dict A dictionary var. 602a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @param[in] key A string var. If this key hasn't existed in 612a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * <code>dict</code>, it is added and associated with <code>value</code>; 622a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * otherwise, the previous value is replaced with <code>value</code>. 63eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * @param[in] value The value to set. The dictionary holds a reference to it 64eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * on success. 652a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * 662a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @return A <code>PP_Bool</code> indicating whether the operation succeeds. 672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) */ 682a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) PP_Bool (*Set)(struct PP_Var dict, struct PP_Var key, struct PP_Var value); 692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) /** 70eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * Deletes the specified key and its associated value, if the key exists. The 71eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * reference to the element will be released. 722a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * 732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @param[in] dict A dictionary var. 742a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @param[in] key A string var. 752a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) */ 762a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void (*Delete)(struct PP_Var dict, struct PP_Var key); 772a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) /** 782a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * Checks whether a key exists. 792a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * 802a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @param[in] dict A dictionary var. 812a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @param[in] key A string var. 822a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * 832a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @return A <code>PP_Bool</code> indicating whether the key exists. 842a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) */ 852a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) PP_Bool (*HasKey)(struct PP_Var dict, struct PP_Var key); 862a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) /** 872a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * Gets all the keys in a dictionary. Please note that for each key that you 882a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * set into the dictionary, a string var with the same contents is returned; 892a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * but it may not be the same string var (i.e., <code>value.as_id</code> may 902a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * be different). 912a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * 922a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @param[in] dict A dictionary var. 932a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * 942a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @return An array var which contains all the keys of <code>dict</code>. Its 952a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * reference count is incremented on behalf of the caller. The elements are 962a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * string vars. Returns a null var if failed. 972a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) */ 982a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) struct PP_Var (*GetKeys)(struct PP_Var dict); 992a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)}; 1002a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 101eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdochtypedef struct PPB_VarDictionary_1_0 PPB_VarDictionary; 1022a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)/** 1032a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @} 1042a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) */ 1052a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 106eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#endif /* PPAPI_C_PPB_VAR_DICTIONARY_H_ */ 1072a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 108