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_array.idl modified Sun Jun 16 15:37:27 2013. */ 72a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 8eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#ifndef PPAPI_C_PPB_VAR_ARRAY_H_ 9eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#define PPAPI_C_PPB_VAR_ARRAY_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_ARRAY_INTERFACE_1_0 "PPB_VarArray;1.0" 17eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#define PPB_VAR_ARRAY_INTERFACE PPB_VAR_ARRAY_INTERFACE_1_0 182a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 192a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)/** 202a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @file 21eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * This file defines the <code>PPB_VarArray</code> struct providing 222a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * a way to interact with array vars. 232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) */ 242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 252a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)/** 272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @addtogroup Interfaces 282a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @{ 292a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) */ 30eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdochstruct PPB_VarArray_1_0 { 312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) /** 322a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * Creates an array var, i.e., a <code>PP_Var</code> with type set to 332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * <code>PP_VARTYPE_ARRAY</code>. The array length is set to 0. 342a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * 352a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @return An empty array var, whose reference count is set to 1 on behalf of 362a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * the caller. 372a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) */ 382a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) struct PP_Var (*Create)(void); 392a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) /** 402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * Gets an element from the array. 412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * 422a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @param[in] array An array var. 432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @param[in] index An index indicating which element to return. 442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * 45eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * @return The element at the specified position. The reference count of the 46eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * element returned is incremented on behalf of the caller. If 47eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * <code>index</code> is larger than or equal to the array length, an 48eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * undefined var is returned. 492a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) */ 502a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) struct PP_Var (*Get)(struct PP_Var array, uint32_t index); 512a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) /** 522a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * Sets the value of an element in the array. 532a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * 542a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @param[in] array An array var. 552a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @param[in] index An index indicating which element to modify. If 562a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * <code>index</code> is larger than or equal to the array length, the length 572a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * is updated to be <code>index</code> + 1. Any position in the array that 582a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * hasn't been set before is set to undefined, i.e., <code>PP_Var</code> of 592a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * type <code>PP_VARTYPE_UNDEFINED</code>. 602a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @param[in] value The value to set. The array holds a reference to it on 612a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * success. 622a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * 632a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @return A <code>PP_Bool</code> indicating whether the operation succeeds. 642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) */ 652a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) PP_Bool (*Set)(struct PP_Var array, uint32_t index, struct PP_Var value); 662a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) /** 672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * Gets the array length. 682a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * 692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @param[in] array An array var. 702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * 712a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @return The array length. 722a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) */ 732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) uint32_t (*GetLength)(struct PP_Var array); 742a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) /** 752a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * Sets the array length. 762a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * 772a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @param[in] array An array var. 782a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @param[in] length The new array length. If <code>length</code> is smaller 792a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * than its current value, the array is truncated to the new length; any 80eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * elements that no longer fit are removed and the references to them will be 81eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * released. If <code>length</code> is larger than its current value, 82eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * undefined vars are appended to increase the array to the specified length. 832a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * 842a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @return A <code>PP_Bool</code> indicating whether the operation succeeds. 852a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) */ 862a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) PP_Bool (*SetLength)(struct PP_Var array, uint32_t length); 872a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)}; 882a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 89eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdochtypedef struct PPB_VarArray_1_0 PPB_VarArray; 902a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)/** 912a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) * @} 922a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) */ 932a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 94eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#endif /* PPAPI_C_PPB_VAR_ARRAY_H_ */ 952a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 96