forked from KOBA789/node.js_ja
-
Notifications
You must be signed in to change notification settings - Fork 5
/
addons.html
989 lines (789 loc) · 33.1 KB
/
addons.html
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
<!doctype html>
<html lang="ja">
<head>
<meta charset="utf-8">
<title>Addons Node.js v0.10.1 Manual & Documentation</title>
<link rel="stylesheet" href="assets/style.css">
<link rel="stylesheet" href="assets/sh.css">
<link rel="canonical" href="http://nodejs.org/api/addons.html">
</head>
<body class="alt apidoc" id="api-section-addons">
<div id="intro" class="interior">
<a href="/" title="Go back to the home page">
<img id="logo" src="http://nodejs.org/images/logo-light.png" alt="node.js">
</a>
</div>
<div id="content" class="clearfix">
<div id="column2" class="interior">
<ul>
<!--
<li><a href="/" class="home">Home</a></li>
<li><a href="/download/" class="download">Download</a></li>
<li><a href="/about/" class="about">About</a></li>
<li><a href="http://search.npmjs.org/" class="npm">npm Registry</a></li>
<li><a href="http://nodejs.org/api/" class="docs current">Docs</a></li>
<li><a href="http://blog.nodejs.org" class="blog">Blog</a></li>
<li><a href="/community/" class="community">Community</a></li>
<li><a href="/logos/" class="logos">Logos</a></li>
-->
<li><a href="../" class="home">ホーム</a></li>
<li><a href="../#download" class="download">ダウンロード</a></li>
<li><a href="../about/" class="about">概要</a></li>
<li><a href="http://search.npmjs.org/" class="npm">npm レジストリ</a></li>
<li><a href="../api/" class="docs current">ドキュメント</a></li>
<li><a href="http://blog.nodejs.org" class="blog">ブログ</a></li>
<li><a href="../community/" class="community">コミュニティ</a></li>
<li><a href="../logos/" class="logos">ロゴ</a></li>
<li><a href="http://jobs.nodejs.org/" class="jobs">Jobs</a></li>
</ul>
<p class="twitter"><a href="http://twitter.com/nodejs">@nodejs</a></p>
</div>
<div id="column1" class="interior">
<header>
<h1>Node.js v0.10.1 マニュアル & ドキュメンテーション</h1>
<div id="gtoc">
<p>
<a href="index.html" name="toc">Index</a> |
<a href="all.html">View on single page</a> |
<a href="addons.json">View as JSON</a>
</p>
</div>
<hr>
</header>
<div id="toc">
<h2>Table of Contents</h2>
<ul>
<li><a href="#addons_addons">Addons</a><ul>
<li><a href="#addons_hello_world">Hello world</a></li>
<li><a href="#addons_addon_patterns">Addon patterns</a><ul>
<li><a href="#addons_function_arguments">Function arguments</a></li>
<li><a href="#addons_callbacks">Callbacks</a></li>
<li><a href="#addons_object_factory">Object factory</a></li>
<li><a href="#addons_function_factory">Function factory</a></li>
<li><a href="#addons_wrapping_c_objects">Wrapping C++ objects</a></li>
<li><a href="#addons_factory_of_wrapped_objects">Factory of wrapped objects</a></li>
<li><a href="#addons_passing_wrapped_objects_around">Passing wrapped objects around</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div id="apicontent">
<h1>Addons<span><a class="mark" href="#addons_addons" id="addons_addons">#</a></span></h1>
<!--
Addons are dynamically linked shared objects. They can provide glue to C and
C++ libraries. The API (at the moment) is rather complex, involving
knowledge of several libraries:
-->
<p>アドオンは動的に共有オブジェクトをリンクします。
それらは、C や C++ のライブラリに接合点を提供します。
API はいくつかのライブラリの知識が必要で、(現時点では) かなり複雑です。
</p>
<!--
- V8 JavaScript, a C++ library. Used for interfacing with JavaScript:
creating objects, calling functions, etc. Documented mostly in the
`v8.h` header file (`deps/v8/include/v8.h` in the Node source
tree), which is also available
[online](http://izs.me/v8-docs/main.html).
-->
<ul>
<li>V8 JavaScript は C++ のライブラリです。
JavaScript のオブジェクト作成や関数呼び出し等のインタフェースに使用されます。
ドキュメントは主に、<code>v8.h</code> のヘッダファイル
(Node のソースツリーの中の <code>deps/v8/include/v8.h</code>) に記されていますが、
<a href="http://izs.me/v8-docs/main.html">オンライン</a> で参照することもできます。</li>
</ul>
<!--
- [libuv](https://github.com/joyent/libuv), C event loop library.
Anytime one needs to wait for a file descriptor to become readable,
wait for a timer, or wait for a signal to received one will need to
interface with libuv. That is, if you perform any I/O, libuv will
need to be used.
-->
<ul>
<li><a href="https://github.com/joyent/libuv">libuv</a> は
C のイベントループライブラリです。
ファイル記述子が読み取り可能になるのを待つとき、タイマーを待つとき、
シグナルを受信するのを待つときはいつでも、
libv のインタフェースが必要になります。
つまり、何らかの I/O 処理をすると必ず libuv を使う必要があるということです。</li>
</ul>
<!--
- Internal Node libraries. Most importantly is the `node::ObjectWrap`
class which you will likely want to derive from.
-->
<ul>
<li>Node の内部ライブラリ。
もっとも重要なのは <code>node::ObjectWrap</code> クラスで、
このクラスから派生させることが多くなるでしょう。</li>
</ul>
<!--
- Others. Look in `deps/` for what else is available.
-->
<ul>
<li>その他。どのような物が利用できるかは <code>deps/</code> 以下を参照してさい。</li>
</ul>
<!--
Node statically compiles all its dependencies into the executable.
When compiling your module, you don't need to worry about linking to
any of these libraries.
-->
<p>Node は全ての依存ライブラリを実行ファイルに静的にコンパイルします。
モジュールのコンパイル時には、それらのリンクについて一切気にする必要は有りません。
</p>
<!--
All of the following examples are available for
[download](https://github.com/rvagg/node-addon-examples) and may be
used as a starting-point for your own Addon.
-->
<p>以下のサンプルの全ては
<a href="https://github.com/rvagg/node-addon-examples">ダウンロード</a>
から利用することができ、独自のアドオンの出発点になるでしょう。
</p>
<h2>Hello world<span><a class="mark" href="#addons_hello_world" id="addons_hello_world">#</a></span></h2>
<!--
To get started let's make a small Addon which is the C++ equivalent of
the following JavaScript code:
-->
<p>では、 以下の JavaScript コードと同じ様に動作する小さなアドオンを
C++ で作成してみましょう。
</p>
<pre><code>module.exports.hello = function() { return 'world'; };</code></pre>
<!--
First we create a file `hello.cc`:
-->
<p>最初に <code>hello.cc</code> というファイルを作成します:
</p>
<pre><code>#include <node.h>
#include <v8.h>
using namespace v8;
Handle<Value> Method(const Arguments& args) {
HandleScope scope;
return scope.Close(String::New("world"));
}
void init(Handle<Object> exports) {
exports->Set(String::NewSymbol("hello"),
FunctionTemplate::New(Method)->GetFunction());
}
NODE_MODULE(hello, init)</code></pre>
<!--
Note that all Node addons must export an initialization function:
-->
<p>全ての Node アドオンは初期化関数をエクスポートしなければならないことに
注意してください。
</p>
<pre><code>void Initialize (Handle<Object> exports);
NODE_MODULE(module_name, Initialize)</code></pre>
<!--
There is no semi-colon after `NODE_MODULE` as it's not a function (see `node.h`).
The `module_name` needs to match the filename of the final binary (minus the
.node suffix).
The source code needs to be built into `hello.node`, the binary Addon. To
do this we create a file called `binding.gyp` which describes the configuration
to build your module in a JSON-like format. This file gets compiled by
[node-gyp](https://github.com/TooTallNate/node-gyp).
-->
<p><code>NODE_MODULE</code> は関数ではないので、その後にセミコロンを付けてはいけません
(<code>node.h</code> を参照してください)。
</p>
<p><code>module_name</code> は最終的なバイナリのファイル名 (拡張子 .node を除く)
とマッチする必要があります。
</p>
<p>このソースコードは、<code>hello.node</code> というバイナリアドオンとしてビルドされる必要が有ります。
そのために <code>binding.gyp</code> と呼ばれる、あなたのモジュールをビルドするための
構成を JSON 的なフォーマットで記述したファイルを作成します。
このファイルは <a href="https://github.com/TooTallNate/node-gyp">node-gyp</a>
によってコンパイルされます。
</p>
<pre><code>{
"targets": [
{
"target_name": "hello",
"sources": [ "hello.cc" ]
}
]
}</code></pre>
<!--
The next step is to generate the appropriate project build files for the
current platform. Use `node-gyp configure` for that.
-->
<p>次のステップは現在のプラットフォームに適したプロジェクトビルドファイルを
生成することです。
<code>node-gyp configure</code> を使います。
</p>
<!--
Now you will have either a `Makefile` (on Unix platforms) or a `vcxproj` file
(on Windows) in the `build/` directory. Next invoke the `node-gyp build`
command.
-->
<p>これで、<code>Makefile</code> (Unix プラットフォームの場合)、または <code>vcxproj</code> ファイル
(Windows の場合) が <code>build/</code> ディレクトリに作られます。
次に <code>node-gyp build</code> コマンドを起動します。
</p>
<!--
Now you have your compiled `.node` bindings file! The compiled bindings end up
in `build/Release/`.
-->
<p>これでコンパイルされた <code>.node</code> バインディングファイルが作成されます！
コンパイルされたバインディングファイルは <code>build/Release/</code> にあります。
</p>
<!--
You can now use the binary addon in a Node project `hello.js` by pointing `require` to
the recently built `hello.node` module:
-->
<p>ビルドされた <code>hello.node</code> モジュールを <code>require</code> で指定することにより、
このバイナリアドオンを Node プロジェクトの <code>hello.js</code> から利用することが
可能になります。
</p>
<pre><code>var addon = require('./build/Release/hello');
console.log(addon.hello()); // 'world'</code></pre>
<!--
Please see patterns below for further information or
<https://github.com/arturadib/node-qt> for an example in production.
-->
<p>さらに詳しい情報については下記のパターンか、
</p>
<p><a href="https://github.com/arturadib/node-qt">https://github.com/arturadib/node-qt</a> を実際のプロダクトにおける
例として参照してください。
</p>
<h2>Addon patterns<span><a class="mark" href="#addons_addon_patterns" id="addons_addon_patterns">#</a></span></h2>
<!--
Below are some addon patterns to help you get started. Consult the online
[v8 reference](http://izs.me/v8-docs/main.html) for help with the various v8
calls, and v8's [Embedder's Guide](http://code.google.com/apis/v8/embed.html)
for an explanation of several concepts used such as handles, scopes,
function templates, etc.
-->
<p>以下は初心者に役立つアドオンのパターンです。
v8 の様々な API についてはオンラインの
<a href="http://izs.me/v8-docs/main.html">v8 reference</a> が、
そして ハンドルやスコープ、関数テンプレートなどいくつかの概念については
v8 の <a href="http://code.google.com/apis/v8/embed.html">Embedder's Guide</a> が
役に立つでしょう。
</p>
<!--
In order to use these examples you need to compile them using `node-gyp`.
Create the following `binding.gyp` file:
-->
<p>このサンプルを利用できるようにするには、<code>node-gyp</code> を使用して
コンパイルする必要があります。
以下の <code>binding.gyp</code> ファイルを作成します。
</p>
<pre><code>{
"targets": [
{
"target_name": "addon",
"sources": [ "addon.cc" ]
}
]
}</code></pre>
<!--
In cases where there is more than one `.cc` file, simply add the file name to the
`sources` array, e.g.:
-->
<p>一つ以上の <code>.cc</code> ファイルがある場合は、単純に <code>sources</code> 配列にファイル名を
加えるだけです。例:
</p>
<pre><code>"sources": ["addon.cc", "myexample.cc"]</code></pre>
<!--
Now that you have your `binding.gyp` ready, you can configure and build the
addon:
-->
<p>これで <code>binding.gyp</code> の準備ができました。
アドオンをコンフィギュアおよびビルドするには:
</p>
<pre><code>$ node-gyp configure build</code></pre>
<h3>Function arguments<span><a class="mark" href="#addons_function_arguments" id="addons_function_arguments">#</a></span></h3>
<!--
The following pattern illustrates how to read arguments from JavaScript
function calls and return a result. This is the main and only needed source
`addon.cc`:
-->
<p>以下のパターンは JavaScript から呼び出された関数で引数を読み出したり、
結果を返す方法を示します。これは <code>addon.cc</code> でのみ必要となります。
</p>
<pre><code>#define BUILDING_NODE_EXTENSION
#include <node.h>
using namespace v8;
Handle<Value> Add(const Arguments& args) {
HandleScope scope;
if (args.Length() < 2) {
ThrowException(Exception::TypeError(String::New("Wrong number of arguments")));
return scope.Close(Undefined());
}
if (!args[0]->IsNumber() || !args[1]->IsNumber()) {
ThrowException(Exception::TypeError(String::New("Wrong arguments")));
return scope.Close(Undefined());
}
Local<Number> num = Number::New(args[0]->NumberValue() +
args[1]->NumberValue());
return scope.Close(num);
}
void Init(Handle<Object> exports) {
exports->Set(String::NewSymbol("add"),
FunctionTemplate::New(Add)->GetFunction());
}
NODE_MODULE(addon, Init)</code></pre>
<!--
You can test it with the following JavaScript snippet:
-->
<p>以下の JavaScript コード片でテストすることができます。
</p>
<pre><code>var addon = require('./build/Release/addon');
console.log( 'This should be eight:', addon.add(3,5) );</code></pre>
<h3>Callbacks<span><a class="mark" href="#addons_callbacks" id="addons_callbacks">#</a></span></h3>
<!--
You can pass JavaScript functions to a C++ function and execute them from
there. Here's `addon.cc`:
-->
<p>JavaScript の関数を C++ の関数に渡してそこから呼び出すことができます。
これは <code>addon.cc</code> です:
</p>
<pre><code>#define BUILDING_NODE_EXTENSION
#include <node.h>
using namespace v8;
Handle<Value> RunCallback(const Arguments& args) {
HandleScope scope;
Local<Function> cb = Local<Function>::Cast(args[0]);
const unsigned argc = 1;
Local<Value> argv[argc] = { Local<Value>::New(String::New("hello world")) };
cb->Call(Context::GetCurrent()->Global(), argc, argv);
return scope.Close(Undefined());
}
void Init(Handle<Object> exports, Handle<Object> module) {
module->Set(String::NewSymbol("exports"),
FunctionTemplate::New(RunCallback)->GetFunction());
}
NODE_MODULE(addon, Init)</code></pre>
<!--
Note that this example uses a two-argument form of `Init()` that receives
the full `module` object as the second argument. This allows the addon
to completely overwrite `exports` with a single function instead of
adding the function as a property of `exports`.
-->
<p>この例は二つの引数を取る形式の <code>Init()</code> を使用して、第2引数で完全な <code>module</code>
オブジェクトを受け取っていることに注意してください。
これは、<code>exports</code> のプロパティとして関数を加える代わりに、アドオンが
一つの関数で <code>exports</code> を完全に上書きすることを可能にします。
</p>
<!--
To test it run the following JavaScript snippet:
-->
<p>以下の JavaScript コード片でテストすることができます。
</p>
<pre><code>var addon = require('./build/Release/addon');
addon(function(msg){
console.log(msg); // 'hello world'
});</code></pre>
<h3>Object factory<span><a class="mark" href="#addons_object_factory" id="addons_object_factory">#</a></span></h3>
<!--
You can create and return new objects from within a C++ function with this
`addon.cc` pattern, which returns an object with property `msg` that echoes
the string passed to `createObject()`:
-->
<p>C++ 関数の中から新しいオブジェクトを作成して返すことができます。
以下の <code>addon.cc</code> のパターンでは、<code>createObject()</code> に渡された文字列を
反映する <code>msg</code> プロパティを持ったオブジェクトを返します。
</p>
<pre><code>#define BUILDING_NODE_EXTENSION
#include <node.h>
using namespace v8;
Handle<Value> CreateObject(const Arguments& args) {
HandleScope scope;
Local<Object> obj = Object::New();
obj->Set(String::NewSymbol("msg"), args[0]->ToString());
return scope.Close(obj);
}
void Init(Handle<Object> exports, Handle<Object> module) {
module->Set(String::NewSymbol("exports"),
FunctionTemplate::New(CreateObject)->GetFunction());
}
NODE_MODULE(addon, Init)</code></pre>
<!--
To test it in JavaScript:
-->
<p>テスト用の JavaScript:
</p>
<pre><code>var addon = require('./build/Release/addon');
var obj1 = addon('hello');
var obj2 = addon('world');
console.log(obj1.msg+' '+obj2.msg); // 'hello world'</code></pre>
<h3>Function factory<span><a class="mark" href="#addons_function_factory" id="addons_function_factory">#</a></span></h3>
<!--
This pattern illustrates how to create and return a JavaScript function that
wraps a C++ function:
-->
<p>このパターンは C++ 関数をラップした JavaScript 関数を作成して返す方法を
示します。
</p>
<pre><code>#define BUILDING_NODE_EXTENSION
#include <node.h>
using namespace v8;
Handle<Value> MyFunction(const Arguments& args) {
HandleScope scope;
return scope.Close(String::New("hello world"));
}
Handle<Value> CreateFunction(const Arguments& args) {
HandleScope scope;
Local<FunctionTemplate> tpl = FunctionTemplate::New(MyFunction);
Local<Function> fn = tpl->GetFunction();
fn->SetName(String::NewSymbol("theFunction")); // omit this to make it anonymous
return scope.Close(fn);
}
void Init(Handle<Object> exports, Handle<Object> module) {
module->Set(String::NewSymbol("exports"),
FunctionTemplate::New(CreateFunction)->GetFunction());
}
NODE_MODULE(addon, Init)</code></pre>
<!--
To test:
-->
<p>テスト:
</p>
<pre><code>var addon = require('./build/Release/addon');
var fn = addon();
console.log(fn()); // 'hello world'</code></pre>
<h3>Wrapping C++ objects<span><a class="mark" href="#addons_wrapping_c_objects" id="addons_wrapping_c_objects">#</a></span></h3>
<!--
Here we will create a wrapper for a C++ object/class `MyObject` that can be
instantiated in JavaScript through the `new` operator. First prepare the main
module `addon.cc`:
-->
<p>ここでは、
C++ オブジェクト／クラスをラップし、JavaScript から new 演算子を使って
インスタンス化できる <code>MyObject</code> を作成します。
最初にメインモジュール <code>addon.cc</code> を準備します:
</p>
<pre><code>#define BUILDING_NODE_EXTENSION
#include <node.h>
#include "myobject.h"
using namespace v8;
void InitAll(Handle<Object> exports) {
MyObject::Init(exports);
}
NODE_MODULE(addon, InitAll)</code></pre>
<!--
Then in `myobject.h` make your wrapper inherit from `node::ObjectWrap`:
-->
<p>次に、<code>node::ObjectWrap</code> を継承したラッパーを <code>myobject.h</code> に作成します。
</p>
<pre><code>#ifndef MYOBJECT_H
#define MYOBJECT_H
#include <node.h>
class MyObject : public node::ObjectWrap {
public:
static void Init(v8::Handle<v8::Object> exports);
private:
MyObject();
~MyObject();
static v8::Handle<v8::Value> New(const v8::Arguments& args);
static v8::Handle<v8::Value> PlusOne(const v8::Arguments& args);
double counter_;
};
#endif</code></pre>
<!--
And in `myobject.cc` implement the various methods that you want to expose.
Here we expose the method `plusOne` by adding it to the constructor's
prototype:
-->
<p>公開したい様々なメソッドを <code>myobject.cc</code> に実装します。
ここでは、コンストラクタに渡された値に加算する <code>plusOne</code> を公開しています:
</p>
<pre><code>#define BUILDING_NODE_EXTENSION
#include <node.h>
#include "myobject.h"
using namespace v8;
MyObject::MyObject() {};
MyObject::~MyObject() {};
void MyObject::Init(Handle<Object> exports) {
// Prepare constructor template
Local<FunctionTemplate> tpl = FunctionTemplate::New(New);
tpl->SetClassName(String::NewSymbol("MyObject"));
tpl->InstanceTemplate()->SetInternalFieldCount(1);
// Prototype
tpl->PrototypeTemplate()->Set(String::NewSymbol("plusOne"),
FunctionTemplate::New(PlusOne)->GetFunction());
Persistent<Function> constructor = Persistent<Function>::New(tpl->GetFunction());
exports->Set(String::NewSymbol("MyObject"), constructor);
}
Handle<Value> MyObject::New(const Arguments& args) {
HandleScope scope;
MyObject* obj = new MyObject();
obj->counter_ = args[0]->IsUndefined() ? 0 : args[0]->NumberValue();
obj->Wrap(args.This());
return args.This();
}
Handle<Value> MyObject::PlusOne(const Arguments& args) {
HandleScope scope;
MyObject* obj = ObjectWrap::Unwrap<MyObject>(args.This());
obj->counter_ += 1;
return scope.Close(Number::New(obj->counter_));
}</code></pre>
<!--
Test it with:
-->
<p>これでテストします:
</p>
<pre><code>var addon = require('./build/Release/addon');
var obj = new addon.MyObject(10);
console.log( obj.plusOne() ); // 11
console.log( obj.plusOne() ); // 12
console.log( obj.plusOne() ); // 13</code></pre>
<h3>Factory of wrapped objects<span><a class="mark" href="#addons_factory_of_wrapped_objects" id="addons_factory_of_wrapped_objects">#</a></span></h3>
<!--
This is useful when you want to be able to create native objects without
explicitly instantiating them with the `new` operator in JavaScript, e.g.
-->
<p>JavaScript の <code>new</code> 演算子で明示的にインスタンス化することなく、
ネイティブオブジェクトを作成できるようにしたい場合に便利です。例:
</p>
<pre><code>var obj = addon.createObject();
// instead of:
// var obj = new addon.Object();</code></pre>
<!--
Let's register our `createObject` method in `addon.cc`:
-->
<p>createObject<code> を </code>addon.cc` に登録しましょう:
</p>
<pre><code>#define BUILDING_NODE_EXTENSION
#include <node.h>
#include "myobject.h"
using namespace v8;
Handle<Value> CreateObject(const Arguments& args) {
HandleScope scope;
return scope.Close(MyObject::NewInstance(args));
}
void InitAll(Handle<Object> exports, Handle<Object> module) {
MyObject::Init();
module->Set(String::NewSymbol("exports"),
FunctionTemplate::New(CreateObject)->GetFunction());
}
NODE_MODULE(addon, InitAll)</code></pre>
<!--
In `myobject.h` we now introduce the static method `NewInstance` that takes
care of instantiating the object (i.e. it does the job of `new` in JavaScript):
-->
<p><code>myobject.h</code> にオブジェクトを生成する static メソッド <code>NewInstance</code> を
導入しましょう (すなわち，それが JavaScript 内の <code>new</code> の働きをします)。
</p>
<pre><code>#define BUILDING_NODE_EXTENSION
#ifndef MYOBJECT_H
#define MYOBJECT_H
#include <node.h>
class MyObject : public node::ObjectWrap {
public:
static void Init();
static v8::Handle<v8::Value> NewInstance(const v8::Arguments& args);
private:
MyObject();
~MyObject();
static v8::Persistent<v8::Function> constructor;
static v8::Handle<v8::Value> New(const v8::Arguments& args);
static v8::Handle<v8::Value> PlusOne(const v8::Arguments& args);
double counter_;
};
#endif</code></pre>
<!--
The implementation is similar to the above in `myobject.cc`:
-->
<p>実装は前述の <code>myobject.cc</code> と同様です:
</p>
<pre><code>#define BUILDING_NODE_EXTENSION
#include <node.h>
#include "myobject.h"
using namespace v8;
MyObject::MyObject() {};
MyObject::~MyObject() {};
Persistent<Function> MyObject::constructor;
void MyObject::Init() {
// Prepare constructor template
Local<FunctionTemplate> tpl = FunctionTemplate::New(New);
tpl->SetClassName(String::NewSymbol("MyObject"));
tpl->InstanceTemplate()->SetInternalFieldCount(1);
// Prototype
tpl->PrototypeTemplate()->Set(String::NewSymbol("plusOne"),
FunctionTemplate::New(PlusOne)->GetFunction());
constructor = Persistent<Function>::New(tpl->GetFunction());
}
Handle<Value> MyObject::New(const Arguments& args) {
HandleScope scope;
MyObject* obj = new MyObject();
obj->counter_ = args[0]->IsUndefined() ? 0 : args[0]->NumberValue();
obj->Wrap(args.This());
return args.This();
}
Handle<Value> MyObject::NewInstance(const Arguments& args) {
HandleScope scope;
const unsigned argc = 1;
Handle<Value> argv[argc] = { args[0] };
Local<Object> instance = constructor->NewInstance(argc, argv);
return scope.Close(instance);
}
Handle<Value> MyObject::PlusOne(const Arguments& args) {
HandleScope scope;
MyObject* obj = ObjectWrap::Unwrap<MyObject>(args.This());
obj->counter_ += 1;
return scope.Close(Number::New(obj->counter_));
}</code></pre>
<!--
Test it with:
-->
<p>これでテストします:
</p>
<pre><code>var createObject = require('./build/Release/addon');
var obj = createObject(10);
console.log( obj.plusOne() ); // 11
console.log( obj.plusOne() ); // 12
console.log( obj.plusOne() ); // 13
var obj2 = createObject(20);
console.log( obj2.plusOne() ); // 21
console.log( obj2.plusOne() ); // 22
console.log( obj2.plusOne() ); // 23</code></pre>
<h3>Passing wrapped objects around<span><a class="mark" href="#addons_passing_wrapped_objects_around" id="addons_passing_wrapped_objects_around">#</a></span></h3>
<!--
In addition to wrapping and returning C++ objects, you can pass them around
by unwrapping them with Node's `node::ObjectWrap::Unwrap` helper function.
In the following `addon.cc` we introduce a function `add()` that can take on two
`MyObject` objects:
-->
<p>C++ オブジェクトをラップして返すことに加えて、Node が提供するヘルパ関数
<code>node::ObjectWrap::Unwrap</code> を使用してアンラップすることもできます。
以下の <code>addon.cc</code> では、二つの <code>MyObject</code> オブジェクトを受け取る <code>add()</code>
関数を導入します:
</p>
<pre><code>#define BUILDING_NODE_EXTENSION
#include <node.h>
#include "myobject.h"
using namespace v8;
Handle<Value> CreateObject(const Arguments& args) {
HandleScope scope;
return scope.Close(MyObject::NewInstance(args));
}
Handle<Value> Add(const Arguments& args) {
HandleScope scope;
MyObject* obj1 = node::ObjectWrap::Unwrap<MyObject>(
args[0]->ToObject());
MyObject* obj2 = node::ObjectWrap::Unwrap<MyObject>(
args[1]->ToObject());
double sum = obj1->Val() + obj2->Val();
return scope.Close(Number::New(sum));
}
void InitAll(Handle<Object> exports) {
MyObject::Init();
exports->Set(String::NewSymbol("createObject"),
FunctionTemplate::New(CreateObject)->GetFunction());
exports->Set(String::NewSymbol("add"),
FunctionTemplate::New(Add)->GetFunction());
}
NODE_MODULE(addon, InitAll)</code></pre>
<!--
To make things interesting we introduce a public method in `myobject.h` so we
can probe private values after unwrapping the object:
-->
<p>よりおもしろくするために、<code>myobject.h</code> にパブリックメソッドを導入しましょう。
したがって、アンラップされたオブジェクトのプライベート変数を調べることが
できます。
</p>
<pre><code>#define BUILDING_NODE_EXTENSION
#ifndef MYOBJECT_H
#define MYOBJECT_H
#include <node.h>
class MyObject : public node::ObjectWrap {
public:
static void Init();
static v8::Handle<v8::Value> NewInstance(const v8::Arguments& args);
double Val() const { return val_; }
private:
MyObject();
~MyObject();
static v8::Persistent<v8::Function> constructor;
static v8::Handle<v8::Value> New(const v8::Arguments& args);
double val_;
};
#endif</code></pre>
<!--
The implementation of `myobject.cc` is similar as before:
-->
<p><code>myobject.cc</code> の実装はこれまでと同様です:
</p>
<pre><code>#define BUILDING_NODE_EXTENSION
#include <node.h>
#include "myobject.h"
using namespace v8;
MyObject::MyObject() {};
MyObject::~MyObject() {};
Persistent<Function> MyObject::constructor;
void MyObject::Init() {
// Prepare constructor template
Local<FunctionTemplate> tpl = FunctionTemplate::New(New);
tpl->SetClassName(String::NewSymbol("MyObject"));
tpl->InstanceTemplate()->SetInternalFieldCount(1);
constructor = Persistent<Function>::New(tpl->GetFunction());
}
Handle<Value> MyObject::New(const Arguments& args) {
HandleScope scope;
MyObject* obj = new MyObject();
obj->val_ = args[0]->IsUndefined() ? 0 : args[0]->NumberValue();
obj->Wrap(args.This());
return args.This();
}
Handle<Value> MyObject::NewInstance(const Arguments& args) {
HandleScope scope;
const unsigned argc = 1;
Handle<Value> argv[argc] = { args[0] };
Local<Object> instance = constructor->NewInstance(argc, argv);
return scope.Close(instance);
}</code></pre>
<!--
Test it with:
-->
<p>これでテストします:
</p>
<pre><code>var addon = require('./build/Release/addon');
var obj1 = addon.createObject(10);
var obj2 = addon.createObject(20);
var result = addon.add(obj1, obj2);
console.log(result); // 30</code></pre>
</div>
</div>
</div>
<div id="footer">
<ul class="clearfix">
<!--
<li><a href="/">Node.js</a></li>
<li><a href="/download/">Download</a></li>
<li><a href="/about/">About</a></li>
<li><a href="http://search.npmjs.org/">npm Registry</a></li>
<li><a href="http://nodejs.org/api/">Docs</a></li>
<li><a href="http://blog.nodejs.org">Blog</a></li>
<li><a href="/community/">Community</a></li>
<li><a href="/logos/">Logos</a></li>
-->
<li><a href="../">Node.js</a></li>
<li><a href="../#download">ダウンロード</a></li>
<li><a href="../about/">概要</a></li>
<li><a href="http://search.npmjs.org/">npm レジストリ</a></li>
<li><a href="../api/">ドキュメント</a></li>
<li><a href="http://blog.nodejs.org">ブログ</a></li>
<li><a href="../community/">コミュニティ</a></li>
<li><a href="../logos/">ロゴ</a></li>
<li><a href="http://jobs.nodejs.org/">Jobs</a></li>
<li><a href="http://twitter.com/nodejs" class="twitter">@nodejs</a></li>
</ul>
<p>Copyright <a href="http://joyent.com/">Joyent, Inc</a>, Node.js is a <a href="/trademark-policy.pdf">trademark</a> of Joyent, Inc. View <a href="https://raw.github.com/joyent/node/v0.10.1/LICENSE">license</a>.</p>
</div>
<script src="../sh_main.js"></script>
<script src="../sh_javascript.min.js"></script>
<script>highlight(undefined, undefined, 'pre');</script>
<script>
window._gaq = [['_setAccount', 'UA-10874194-2'], ['_trackPageview']];
(function(d, t) {
var g = d.createElement(t),
s = d.getElementsByTagName(t)[0];
g.src = '//www.google-analytics.com/ga.js';
s.parentNode.insertBefore(g, s);
}(document, 'script'));
</script>
</body>
</html>