1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
// Copyright (c) 2010 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.
#ifndef PPAPI_C_PPB_CLASS_H_
#define PPAPI_C_PPB_CLASS_H_
#include "ppapi/c/pp_module.h"
#include "ppapi/c/pp_resource.h"
#include "ppapi/c/pp_stdint.h"
#include "ppapi/c/ppb_var.h"
#define PPB_CLASS_INTERFACE "PPB_Class;0.1"
/**
* @file
* Defines the PPB_Class struct.
*
* @addtogroup PPB
* @{
*/
/**
* Function callback.
*
* native_ptr will always be the native_ptr used to create this_object. If
* this object was not created in this module, native_ptr will be NULL. There
* is no other type protection - if your module contains two objects with
* different native_ptr information, make sure you can handle the case of
* JS calling one object's function with another object set as this.
*/
typedef PP_Var (*PP_ClassFunction)(void* native_ptr, PP_Var this_object,
PP_Var* args, uint32_t argc,
PP_Var* exception);
typedef void (*PP_ClassDestructor)(void* native_ptr);
/**
* One property of a class.
*
* It can be either a value property, in which case it need to have getter
* and/or setter fields set, and method NULL, or a function, in which case it
* needs to have method set, and getter/setter set to NULL. It is an error to
* have method and either getter or setter set, as it is an error to not provide
* any of them.
*
* Not providing a getter will be equivalent to having a getter which returns
* undefined. Not providing a setter will be equivalent to providing a setter
* which doesn't do anything.
*/
struct PP_ClassProperty {
const char* name;
PP_ClassFunction method;
PP_ClassFunction getter;
PP_ClassFunction setter;
uint32_t modifiers;
};
/** Interface for implementing JavaScript-accessible objects.
*
*
* Example usage:
*
* struct PP_ClassProperty properties[] = {
* { "method", methodFunc },
* { "hiddenMethod", hiddenMethodFunc, NULL, NULL,
* PP_OBJECTPROPERTY_MODIFIER_DONTENUM },
* { "property", NULL, propertyGetter, propertySetter },
* { "readonlyProperty", NULL, propertyGetter, NULL,
* PP_OBJECTPROPERTY_MODIFIER_READONLY },
* { NULL }
* };
*
* PP_Resource object_template =
* Create(module, &operator delete, NULL, properties);
*
* ...
*
* struct NativeData { int blah; ... }; // Can be anything.
* NativeData* native_data = new NativeData;
* native_data->blah = 123; // Initialize native data.
*
* PP_Var object = Instantiate(object_template, native_data);
*
* Please also see:
* http://code.google.com/p/ppapi/wiki/InterfacingWithJavaScript
* for general information on using and implementing vars.
*/
struct PPB_Class {
/**
* Creates a class containing given methods and properties.
*
* Properties list is terminated with a NULL-named property. New instances are
* created using Instantiate(). Each instance carries one void* of native
* state, which is passed to Instantiate(). When the instance is finalized,
* the destructor function is called to destruct the native state.
*
* If invoke handler is specified, then the instances can be used as
* functions.
*/
PP_Resource (*Create)(PP_Module module,
PP_ClassDestructor destruct,
PP_ClassFunction invoke,
PP_ClassProperty* properties);
/**
* Creates an instance of the given class, and attaches given native pointer
* to it.
*
* If the class_object is invalid, throws an exception.
*/
PP_Var (*Instantiate)(PP_Resource class_object,
void* native_ptr, PP_Var* exception);
};
/**
* @}
* End addtogroup PPP
*/
#endif // PPAPI_C_PPP_CLASS_H_
|
