You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
107 lines
3.4 KiB
107 lines
3.4 KiB
/* Copyright 2013 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.
|
|
*/
|
|
|
|
/* From ppb_var_dictionary.idl modified Sat Jun 8 23:03:54 2013. */
|
|
|
|
#ifndef PPAPI_C_PPB_VAR_DICTIONARY_H_
|
|
#define PPAPI_C_PPB_VAR_DICTIONARY_H_
|
|
|
|
#include "pp_bool.h"
|
|
#include "pp_macros.h"
|
|
#include "pp_stdint.h"
|
|
#include "pp_var.h"
|
|
|
|
#define PPB_VAR_DICTIONARY_INTERFACE_1_0 "PPB_VarDictionary;1.0"
|
|
#define PPB_VAR_DICTIONARY_INTERFACE PPB_VAR_DICTIONARY_INTERFACE_1_0
|
|
|
|
/**
|
|
* @file
|
|
* This file defines the <code>PPB_VarDictionary</code> struct providing
|
|
* a way to interact with dictionary vars.
|
|
*/
|
|
|
|
|
|
/**
|
|
* @addtogroup Interfaces
|
|
* @{
|
|
*/
|
|
/**
|
|
* A dictionary var contains key-value pairs with unique keys. The keys are
|
|
* strings while the values can be arbitrary vars. Key comparison is always
|
|
* done by value instead of by reference.
|
|
*/
|
|
struct PPB_VarDictionary_1_0 {
|
|
/**
|
|
* Creates a dictionary var, i.e., a <code>PP_Var</code> with type set to
|
|
* <code>PP_VARTYPE_DICTIONARY</code>.
|
|
*
|
|
* @return An empty dictionary var, whose reference count is set to 1 on
|
|
* behalf of the caller.
|
|
*/
|
|
struct PP_Var (*Create)(void);
|
|
/**
|
|
* Gets the value associated with the specified key.
|
|
*
|
|
* @param[in] dict A dictionary var.
|
|
* @param[in] key A string var.
|
|
*
|
|
* @return The value that is associated with <code>key</code>. The reference
|
|
* count of the element returned is incremented on behalf of the caller. If
|
|
* <code>key</code> is not a string var, or it doesn't exist in
|
|
* <code>dict</code>, an undefined var is returned.
|
|
*/
|
|
struct PP_Var (*Get)(struct PP_Var dict, struct PP_Var key);
|
|
/**
|
|
* Sets the value associated with the specified key.
|
|
*
|
|
* @param[in] dict A dictionary var.
|
|
* @param[in] key A string var. If this key hasn't existed in
|
|
* <code>dict</code>, it is added and associated with <code>value</code>;
|
|
* otherwise, the previous value is replaced with <code>value</code>.
|
|
* @param[in] value The value to set. The dictionary holds a reference to it
|
|
* on success.
|
|
*
|
|
* @return A <code>PP_Bool</code> indicating whether the operation succeeds.
|
|
*/
|
|
PP_Bool (*Set)(struct PP_Var dict, struct PP_Var key, struct PP_Var value);
|
|
/**
|
|
* Deletes the specified key and its associated value, if the key exists. The
|
|
* reference to the element will be released.
|
|
*
|
|
* @param[in] dict A dictionary var.
|
|
* @param[in] key A string var.
|
|
*/
|
|
void (*Delete)(struct PP_Var dict, struct PP_Var key);
|
|
/**
|
|
* Checks whether a key exists.
|
|
*
|
|
* @param[in] dict A dictionary var.
|
|
* @param[in] key A string var.
|
|
*
|
|
* @return A <code>PP_Bool</code> indicating whether the key exists.
|
|
*/
|
|
PP_Bool (*HasKey)(struct PP_Var dict, struct PP_Var key);
|
|
/**
|
|
* Gets all the keys in a dictionary. Please note that for each key that you
|
|
* set into the dictionary, a string var with the same contents is returned;
|
|
* but it may not be the same string var (i.e., <code>value.as_id</code> may
|
|
* be different).
|
|
*
|
|
* @param[in] dict A dictionary var.
|
|
*
|
|
* @return An array var which contains all the keys of <code>dict</code>. Its
|
|
* reference count is incremented on behalf of the caller. The elements are
|
|
* string vars. Returns a null var if failed.
|
|
*/
|
|
struct PP_Var (*GetKeys)(struct PP_Var dict);
|
|
};
|
|
|
|
typedef struct PPB_VarDictionary_1_0 PPB_VarDictionary;
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#endif /* PPAPI_C_PPB_VAR_DICTIONARY_H_ */
|
|
|
|
|