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
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
|
= WeeChat 開発者ガイド
:author: Sébastien Helleu
:email: flashcode@flashtux.org
:lang: ja
:toc: left
:toclevels: 3
:toc-title: 目次
:sectnums:
:docinfo1:
翻訳者:
* Ryuunosuke Ayanokouzi <i38w7i3@yahoo.co.jp>, 2014-2019
このマニュアルは WeeChat チャットクライアントについての文書で、これは WeeChat の一部です。
この文書の最新版は以下のページにあります:
https://weechat.org/doc
[[introduction]]
== はじめに
WeeChat (Wee Enhanced Environment for Chat)
は無料のチャットクライアントで、高速、軽量、多くのオペレーティングシステムで動くように設計されています。
このマニュアルは WeeChat の内部構造について書かれています:
* リポジトリ
* コーディングルール
* 中核部の内部構造
* プラグインの内部構造
* WeeChat に貢献する方法
[[repositories]]
== リポジトリ
WeeChat リポジトリは GitHub organization の "weechat" にあります:
https://github.com/weechat
リポジトリのリスト:
weechat::
ソースコードと文書を含むコアリポジトリ
scripts::
weechat.org に投稿された _公式_ スクリプト
weechat.org::
WeeChat ウェブサイトのソースコード: https://weechat.org/
weercd::
IRC テストサーバ
qweechat::
WeeChat の Qt リモート GUI。
このマニュアルは _weechat_ リポジトリだけを説明しています。
[[overview]]
=== 概要
主な WeeChat ディレクトリは:
[width="100%",cols="1m,3",options="header"]
|===
| ディレクトリ | 説明
| src/ | ソースコードのルートディレクトリ
| core/ | コア関数: エントリポイント、内部構造体
| hook/ | フック関数
| gui/ | バッファ、ウィンドウ、... を操作する関数 (全てのインターフェースで使う)
| curses/ | curses インターフェース
| headless/ | ヘッドレスモード (インターフェースなし)
| normal/ | curses インターフェース
| plugins/ | プラグインとスクリプト向け API
| alias/ | alias プラグイン
| buflist/ | buflist プラグイン
| charset/ | charset プラグイン
| exec/ | exec プラグイン
| fifo/ | fifo プラグイン (WeeChat にコマンドを送信する FIFO パイプ)
| fset/ | fset (高速設定) プラグイン
| guile/ | guile (scheme) スクリプト用 API
| irc/ | IRC (Internet Relay Chat) プラグイン
| javascript/ | javascript スクリプト用 API
| logger/ | logger プラグイン (表示されたメッセージをファイルに書き込む)
| lua/ | lua スクリプト用 API
| perl/ | perl スクリプト用 API
| php/ | php スクリプト用 API
| python/ | python スクリプト用 API
| relay/ | relay プラグイン (irc プロキシ + リモートインターフェース用の中継)
| ruby/ | ruby スクリプト用 API
| script/ | スクリプトマネージャ
| spell/ | spell プラグイン
| tcl/ | tcl スクリプト用 API
| trigger/ | trigger プラグイン
| xfer/ | xfer (IRC DCC ファイル/チャット)
| tests/ | テスト
| scripts/ | スクリプト API テスト
| python/ | スクリプト API テストを生成、実行する Python スクリプト
| unit/ | 単体テスト
| core/ | コア関数の単体テスト
| gui/ | インターフェース関数の単体テスト
| plugins/ | プラグインの単体テスト
| irc/ | IRC プラグインの単体テスト
| doc/ | 文書
| po/ | 翻訳ファイル (gettext)
| debian/ | Debian パッケージ用
|===
[[sources]]
=== ソースコード
[[sources_core]]
==== コア
WeeChat "core" は以下のディレクトリに配置されています:
* _src/core/_: コア関数 (データ操作用)
* _src/gui/_: インターフェースの関数 (バッファ、ウィンドウ、...)
[width="100%",cols="1m,3",options="header"]
|===
| パス/ファイル名 | 説明
| core/ | コア関数: エントリポイント、内部構造体
| wee-arraylist.c | 配列リスト
| wee-backtrace.c | クラッシュした際にバックトレースを表示
| wee-command.c | WeeChat コアコマンド
| wee-completion.c | デフォルト補完
| wee-config-file.c | 設定ファイル管理
| wee-config.c | WeeChat コアの設定オプション (weechat.conf ファイル)
| wee-debug.c | デバッグ用関数
| wee-eval.c | 内部変数へのリファレンスを含む式を評価
| wee-hashtable.c | ハッシュテーブル
| wee-hdata.c | hdata (ハッシュテーブルを用いて直接データを読む)
| wee-hook.c | フック
| wee-infolist.c | インフォリスト (オブジェクトに関するデータを含むリスト)
| wee-input.c | コマンドおよびテキストの入力
| wee-list.c | ソート済みリスト
| wee-log.c | WeeChat ログファイル (weechat.log) に書き込む
| wee-network.c | ネットワーク関数 (サーバやプロキシへの接続)
| wee-proxy.c | プロキシ管理
| wee-secure.c | データ保護用の関数
| wee-secure-buffer.c | データ保護用のバッファ
| wee-secure-config.c | 安全なデータオプション (sec.conf ファイル)
| wee-string.c | 文字列関数
| wee-upgrade-file.c | 内部アップグレードシステム
| wee-upgrade.c | WeeChat コアのアップグレード (バッファ、行、履歴、...)
| wee-url.c | URL 転送 (libcurl を使う)
| wee-utf8.c | UTF-8 関数
| wee-util.c | その他の関数
| wee-version.c | WeeChat バージョンについての関数
| weechat.c | 主要関数: コマンドラインオプション、起動
| hook/ | フック関数
| wee-hook-command-run.c | "command_run" フック
| wee-hook-command.c | "command" フック
| wee-hook-completion.c | "completion" フック
| wee-hook-config.c | "config" フック
| wee-hook-connect.c | "connect" フック
| wee-hook-fd.c | "fd" フック
| wee-hook-focus.c | "focus" フック
| wee-hook-hdata.c | "hdata" フック
| wee-hook-hsignal.c | "hsignal" フック
| wee-hook-info-hashtable.c | "info_hashtable" フック
| wee-hook-info.c | "info" フック
| wee-hook-infolist.c | "infolist" フック
| wee-hook-line.c | "line" フック
| wee-hook-modifier.c | "modifier" フック
| wee-hook-print.c | "print" フック
| wee-hook-process.c | "process" フック
| wee-hook-signal.c | "signal" フック
| wee-hook-timer.c | "timer" フック
| gui/ | バッファ、ウィンドウなどの関数 (全てのインターフェースで利用)
| gui-bar-item.c | バー要素
| gui-bar-window.c | バーウィンドウ
| gui-bar.c | バー
| gui-buffer.c | バッファ
| gui-chat.c | チャット関数 (メッセージの表示、...)
| gui-color.c | 色関数
| gui-completion.c | コマンドラインの補完
| gui-cursor.c | カーソルモード (カーソルを自由に移動)
| gui-filter.c | フィルタ
| gui-focus.c | フォーカスについての関数 (カーソルモードとマウス用)
| gui-history.c | コマンドおよびバッファに保存されたテキスト
| gui-hotlist.c | ホットリスト管理 (活発なバッファのリスト)
| gui-input.c | 入力関数 (入力バー)
| gui-key.c | キーボード関数
| gui-layout.c | レイアウト
| gui-line.c | バッファ中の行
| gui-mouse.c | マウス
| gui-nick.c | ニックネーム関数
| gui-nicklist.c | バッファのニックネームリスト
| gui-window.c | ウィンドウ
| curses/ | curses インターフェース
| gui-curses-bar-window.c | バーウィンドウへの表示
| gui-curses-chat.c | チャットエリアへの表示 (メッセージ)
| gui-curses-color.c | 色関数
| gui-curses-key.c | キーボード関数 (デフォルトキー、入力の読み取り)
| gui-curses-main.c | WeeChat メインループ (キーボードやネットワークイベントの待ち受け)
| gui-curses-mouse.c | マウス
| gui-curses-term.c | 端末についての関数
| gui-curses-window.c | ウィンドウ
| headless/ | ヘッドレスモード (インターフェースなし)
| main.c | ヘッドレスモード用のエントリポイント
| ncurses-fake.c | ダミーの ncurses ライブラリ
| normal/ | curses インターフェース
| main.c | curses インターフェース用のエントリポイント
|===
[[sources_plugins]]
==== プラグイン
[width="100%",cols="1m,3",options="header"]
|===
| パス/ファイル名 | 説明
| plugins/ | プラグインのルートディレクトリ
| plugin.c | プラグイン管理 (動的 C 言語ライブラリのロード/アンロード)
| plugin-api.c | プラグイン API の追加関数 (WeeChat コア関数のラッパー)
| plugin-api-info.c | プラグイン API 用のインフォ/インフォリストに関する追加関数
| plugin-config.c | プラグイン設定オプション (plugins.conf ファイル)
| plugin-script.c | スクリプトプラグインの共用関数
| plugin-script-api.c | スクリプト API 関数: 一部のプラグイン API 関数のラッパー
| plugin-script-config.c | スクリプトプラグインの設定オプション (python.conf、perl.conf 等のファイル)
| weechat-plugin.h | WeeChat プラグインと一緒に配布されるヘッダファイル、プラグインのコンパイルに必要
| alias/ | alias プラグイン
| alias.c | alias の主要関数
| alias-command.c | alias コマンド
| alias-completion.c | alias 補完
| alias-config.c | alias 設定オプション (alias.conf ファイル)
| alias-info.c | alias の情報/インフォリスト/hdata
| spell/ | spell プラグイン
| spell.c | spell の主関数
| spell-bar-item.c | spell バー要素
| spell-command.c | spell コマンド
| spell-completion.c | spell 補完
| spell-config.c | spell 設定オプション (spell.conf ファイル)
| spell-info.c | spell の情報/インフォリスト/hdata
| spell-speller.c | spell のスペラー管理
| buflist/ | buflist プラグイン
| buflist.c | buflist の主要関数
| buflist-bar-item.c | buflist バー要素
| buflist-command.c | buflist コマンド
| buflist-config.c | buflist 設定オプション (buflist.conf ファイル)
| buflist-info.c | buflist の情報/インフォリスト/hdata
| buflist-mouse.c | buflist マウス動作
| charset/ | charset プラグイン
| charset.c | charset 関数
| exec/ | exec プラグイン
| exec.c | exec の主要関数
| exec-buffer.c | exec バッファ
| exec-command.c | exec コマンド
| exec-completion.c | exec 補完
| exec-config.c | exec 設定オプション (exec.conf ファイル)
| fifo/ | fifo プラグイン
| fifo.c | fifo の主要関数
| fifo-command.c | fifo コマンド
| fifo-config.c | fifo 設定オプション (fifo.conf ファイル)
| fifo-info.c | fifo の情報/インフォリスト/hdata
| fset/ | fset プラグイン
| fset.c | fset の主要関数
| fset-bar-item.c | fset バー要素
| fset-buffer.c | fset バッファ
| fset-command.c | fset コマンド
| fset-completion.c | fset 補完
| fset-config.c | fset 設定オプション (fset.conf ファイル)
| fset-info.c | fset の情報/インフォリスト/hdata
| fset-mouse.c | fset マウス動作
| fset-option.c | fset オプション管理
| guile/ | guile (scheme) プラグイン
| weechat-guile.c | guile の主要関数 (スクリプトのロード/アンロード、guile コードの実行)
| weechat-guile-api.c | guile スクリプト作成 API 関数
| irc/ | IRC (Internet Relay Chat) プラグイン
| irc.c | IRC の主要関数
| irc-bar-item.c | IRC バー要素
| irc-buffer.c | IRC バッファ
| irc-channel.c | IRC チャンネル
| irc-color.c | IRC 色
| irc-command.c | IRC コマンド
| irc-completion.c | IRC 補完
| irc-config.c | IRC 設定オプション (irc.conf ファイル)
| irc-ctcp.c | IRC CTCP
| irc-debug.c | IRC デバッグ関数
| irc-ignore.c | IRC 無視
| irc-info.c | IRC の情報/インフォリスト/hdata
| irc-input.c | コマンドおよびテキストの入力
| irc-message.c | IRC メッセージを操作する関数
| irc-mode.c | チャンネルおよびニックネームのモードを操作する関数
| irc-modelist.c | IRC チャンネルモードリスト (+b、+e、+I、...).
| irc-msgbuffer.c | IRC メッセージを送るバッファ
| irc-nick.c | IRC ニックネーム
| irc-notify.c | IRC 通知リスト
| irc-protocol.c | IRC プロトコル (RFC 1459/2810/2811/2812/2813)
| irc-raw.c | IRC 生バッファ
| irc-redirect.c | IRC コマンド出力のリダイレクト
| irc-sasl.c | IRC サーバに対する SASL 認証
| irc-server.c | IRC サーバとの入出力通信
| irc-upgrade.c | WeeChat をアップグレードする際の IRC データの保存およびロード
| javascript/ | JavaScript プラグイン
| weechat-js.cpp | JavaScript の主要関数 (スクリプトのロード/アンロード、JavaScript コードの実行)
| weechat-js-api.cpp | JavaScript スクリプト作成 API 関数
| weechat-js-v8.cpp | JavaScript v8 関数
| logger/ | logger プラグイン
| logger.c | logger の主要関数
| logger-buffer.c | logger バッファリスト管理
| logger-command.c | logger コマンド
| logger-config.c | logger 設定オプション (logger.conf ファイル)
| logger-info.c | logger の情報/インフォリスト/hdata
| logger-tail.c | ファイル末尾の行を返す
| lua/ | lua プラグイン
| weechat-lua.c | lua の主要関数 (スクリプトのロード/アンロード、lua コードの実行)
| weechat-lua-api.c | lua スクリプト作成 API 関数
| perl/ | perl プラグイン
| weechat-perl.c | perl の主要関数 (スクリプトのロード/アンロード、perl コードの実行)
| weechat-perl-api.c | perl スクリプト作成 API 関数
| php/ | php プラグイン
| weechat-php.c | php の主要関数 (スクリプトのロード/アンロード、php コードの実行)
| weechat-php-api.c | php スクリプト作成 API 関数
| python/ | python プラグイン
| weechat-python.c | python の主要関数 (スクリプトのロード/アンロード、python コードの実行)
| weechat-python-api.c | python スクリプト作成 API 関数
| relay/ | relay プラグイン (IRC プロキシとリモートインターフェースへの中継)
| relay.c | relay の主要関数
| relay-buffer.c | relay バッファ
| relay-client.c | relay クライアント
| relay-command.c | relay コマンド
| relay-completion.c | relay 補完
| relay-config.c | relay 設定オプション (relay.conf ファイル)
| relay-info.c | relay の情報/インフォリスト/hdata
| relay-network.c | relay 用のネットワーク関数
| relay-raw.c | relay 生バッファ
| relay-server.c | relay サーバ
| relay-upgrade.c | WeeChat をアップグレードする際にデータを保存/回復
| relay-websocket.c | リレー用の websocket サーバ関数 (RFC 6455)
| irc/ | IRC プロキシ
| relay-irc.c | IRC プロキシの主要関数
| weechat/ | リモートインターフェースへの中継
| relay-weechat.c | リモートインターフェースへの中継 (主要関数)
| relay-weechat-msg.c | クライアントにバイナリメッセージを送信
| relay-weechat-nicklist.c | ニックネームリスト関数
| relay-weechat-protocol.c | クライアントからのコマンドを読み取る
| ruby/ | ruby プラグイン
| weechat-ruby.c | ruby の主要関数 (スクリプトのロード/アンロード、ruby コードの実行)
| weechat-ruby-api.c | ruby スクリプト作成 API 関数
| script/ | スクリプトマネージャ
| script.c | スクリプトマネージャの主要関数
| script-action.c | スクリプトに対する操作 (ロード/アンロード、インストール/削除、...)
| script-buffer.c | スクリプトマネージャ用のバッファ
| script-command.c | スクリプトマネージャ用のコマンド
| script-completion.c | スクリプトマネージャ用の補完
| script-config.c | スクリプトマネージャ用の設定オプション (script.conf ファイル)
| script-info.c | スクリプトマネージャの情報/インフォリスト/hdata
| script-mouse.c | スクリプトマネージャのマウス動作
| script-repo.c | リポジトリファイルのダウンロードとロード
| tcl/ | tcl プラグイン
| weechat-tcl.c | tcl の主要関数 (スクリプトのロード/アンロード、tcl コードの実行)
| weechat-tcl-api.c | tcl スクリプト作成 API 関数
| trigger/ | trigger プラグイン
| trigger.c | trigger の主要関数
| trigger-buffer.c | trigger バッファ
| trigger-callback.c | trigger コールバック
| trigger-command.c | trigger コマンド
| trigger-completion.c | trigger 補完
| trigger-config.c | trigger 設定オプション (trigger.conf ファイル)
| xfer/ | xfer プラグイン (IRC DCC ファイル/チャット)
| xfer.c | xfer の主要関数
| xfer-buffer.c | xfer バッファ
| xfer-chat.c | xfer DCC チャット
| xfer-command.c | xfer コマンド
| xfer-completion.c | xfer 補完
| xfer-config.c | xfer 設定オプション (xfer.conf ファイル)
| xfer-dcc.c | DCC ファイル転送
| xfer-file.c | xfer のファイル関数
| xfer-info.c | xfer の情報/インフォリスト/hdata
| xfer-network.c | xfer のネットワーク関数
| xfer-upgrade.c | WeeChat をアップグレードする際の xfer データの保存および回復
|===
[[sources_tests]]
==== テスト
[width="100%",cols="1m,3",options="header"]
|===
| パス/ファイル名 | 説明
| tests/ | テスト用のルートディレクトリ
| tests.cpp | 全テストの実行時に使われるプログラム
| scripts/ | スクリプト API テスト用のルートディレクトリ
| test-scripts.cpp | スクリプト API テストの実行時に使われるプログラム
| python/ | スクリプト API テストを生成、実行する Python スクリプト
| testapigen.py | スクリプト API のテスト時にすべての言語に関するスクリプトを生成する Python スクリプト
| testapi.py | スクリプト API テスト時に使われる Python スクリプト (スクリプト testapigen.py から使われます)
| unparse.py | Python コードを別の言語に変換 (スクリプト testapigen.py から使われます)
| unit/ | 単体テスト用のルートディレクトリ
| test-plugins.cpp | テスト: プラグイン
| core/ | core 向け単体テスト用のルートディレクトリ
| test-core-arraylist.cpp | テスト: 配列リスト
| test-core-eval.cpp | テスト: 式の評価
| test-core-hashtble.cpp | テスト: ハッシュテーブル
| test-core-hdata.cpp | テスト: hdata
| test-core-hook.cpp | テスト: フック
| test-core-infolist.cpp | テスト: インフォリスト
| test-core-list.cpp | テスト: リスト
| test-core-secure.cpp | テスト: データ保護
| test-core-string.cpp | テスト: 文字列
| test-core-url.cpp | テスト: URL
| test-core-utf8.cpp | テスト: UTF-8
| test-core-util.cpp | テスト: ユーティリティ関数
| gui/ | インターフェースの単体テストを収める最上位ディレクトリ
| test-gui-line.cpp | テスト: 行
// TRANSLATION MISSING
| test-gui-nick.cpp | テスト: nicks
| plugins/ | プラグインの単体テストを収める最上位ディレクトリ
| irc/ | IRC プラグインの単体テストを収める最上位ディレクトリ
// TRANSLATION MISSING
| test-irc-color.cpp | Tests: IRC colors.
| test-irc-config.cpp | テスト: IRC 設定
// TRANSLATION MISSING
| test-irc-ignore.cpp | Tests: IRC ignores.
// TRANSLATION MISSING
| test-irc-message.cpp | Tests: IRC messages.
// TRANSLATION MISSING
| test-irc-mode.cpp | Tests: IRC modes.
// TRANSLATION MISSING
| test-irc-nick.cpp | Tests: IRC nicks.
| test-irc-protocol.cpp | テスト: IRC プロトコル
|===
[[documentation_translations]]
=== 文書 / 翻訳
文書ファイル:
[width="100%",cols="1m,3",options="header"]
|===
| パス/ファイル名 | 説明
| doc/ | 文書
| docinfo.html | asciidoctor スタイル
| docgen.py | _autogen/_ ディレクトリ内のファイルを作成する Python スクリプト (以下を参照)
| XX/ | 言語コード XX (言語コード: en、fr、de、it、...) 用のディレクトリ
| cmdline_options.XX.adoc | 一般利用向けコマンドラインオプション (このファイルの内容は man ページとユーザーズガイドにも含まれます)
| cmdline_options_debug.XX.adoc | デバッグ用コマンドラインオプション (このファイルの内容は man ページとユーザーズガイドにも含まれます)
| weechat.1.XX.adoc | man ページ (`man weechat`)
| weechat_dev.XX.adoc | link:weechat_dev.ja.html[開発者リファレンス] (この文書)
| weechat_faq.XX.adoc | link:weechat_faq.ja.html[FAQ]
| weechat_plugin_api.XX.adoc | link:weechat_plugin_api.ja.html[プラグイン API リファレンス]
| weechat_quickstart.XX.adoc | link:weechat_quickstart.ja.html[クイックスタートガイド]
| weechat_relay_protocol.XX.adoc | link:weechat_relay_protocol.ja.html[リレープロトコル] (リモートインターフェース用)
| weechat_scripting.XX.adoc | link:weechat_scripting.ja.html[スクリプト作成ガイド]
| weechat_tester.XX.adoc | link:weechat_tester.ja.html[テスターガイド]
| weechat_user.XX.adoc | link:weechat_user.ja.html[ユーザーズガイド]
| autogen/ | docgen.py スクリプトが自動生成するファイル
| user/ | ユーザーズガイド用の自動生成ファイル (手作業による編集は *禁止*!)
| plugin_api/ | プラグイン API 用の自動生成ファイル (手作業による編集は *禁止*!)
|===
WeeChat とプラグインの翻訳は gettext で行います、ファイルは _po/_ ディレクトリに含まれています:
[width="100%",cols="1m,3",options="header"]
|===
| パス/ファイル名 | 説明
| po/ | 翻訳ファイル (gettext)
| XX.po | 言語コード XX (言語コード: en、fr、de、it、...) への翻訳、翻訳元言語は英語
| weechat.pot | 翻訳用テンプレート (自動作成)
|===
[[coding_rules]]
== コーディングルール
[[coding_general_rules]]
=== 一般的なルール
* ソースコード内で使用する、コメント、変数名、...
は必ず *英語* で記述してください (他の言語を使わないでください)
* 新しいファイルにはコピーライトヘッダを入れ、以下の情報を含めてください:
** ファイルの短い説明 (1 行)、
** 日付、
** 名前、
** 電子メールアドレス、
** ライセンス。
[source,C]
----
/*
* weechat.c - core functions for WeeChat
*
* Copyright (C) 2019 Your Name <your@email.com>
*
* This file is part of WeeChat, the extensible chat client.
*
* WeeChat is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* WeeChat is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with WeeChat. If not, see <https://www.gnu.org/licenses/>.
*/
----
[[coding_c_style]]
=== C 言語スタイル
C 言語のコードを書く際には以下の基本的なルールを *必ず* 守ってください。:
* インデントは空白文字を 4 個使ってください。タブ文字を使わないでください、タブ文字は良くありません。
* 読みやすくする必要がある場合を除いて、1
行は 80 文字以内に収めてください。
* コメントは `+/* comment */+` のようにしてください (`+// comment+` のような C99 スタイルのコメントは使わないでください)。
* 関数の前に、その関数の機能を説明するコメントを付けてください
(説明が短くても、必ず複数行コメントを使ってください)。
例:
[source,C]
----
/*
* Checks if a string with boolean value is valid.
*
* Returns:
* 1: boolean value is valid
* 0: boolean value is NOT valid
*/
int
foo ()
{
int i;
/* one line comment */
i = 1;
/*
* multi-line comment: this is a very long description about next block
* of code
*/
i = 2;
printf ("%d\n", i);
}
----
* 具体的な変数名を使ってください、例えば "n" や "nc" の代わりに "nicks_count" を使ってください。
例外: `for` ループのカウンタ変数に "i" や "n" を使うのは問題ありません。
* 関数内で行うローカル変数の初期化は宣言の後に行ってください、例:
[source,C]
----
void
foo ()
{
int nick_count, buffer_count;
nick_count = 0;
buffer_count = 1;
/* ... */
}
----
* たとえ必要無くとも、丸括弧を使って式を評価する順番を明示してください、例:
`+x + y * z+` の代わりに `+x + (y * z)+` と書いてください
* 中括弧 `+{ }+` は制御文の次の行に単独で置き、制御文 (以下の `if` です)
と同じ空白文字の数だけインデントしてください:
[source,C]
----
if (nicks_count == 1)
{
/* something */
}
----
* 関数内部でブロックを分けるには空行を使ってください、可能であればそれぞれのブロックにコメントを付けてください:
[source,C]
----
/*
* Sends a message from out queue.
*/
void
irc_server_outqueue_send (struct t_irc_server *server)
{
/* ... */
/* send signal with command that will be sent to server */
irc_server_send_signal (server, "irc_out",
server->outqueue[priority]->command,
server->outqueue[priority]->message_after_mod,
NULL);
tags_to_send = irc_server_get_tags_to_send (server->outqueue[priority]->tags);
irc_server_send_signal (server, "irc_outtags",
server->outqueue[priority]->command,
server->outqueue[priority]->message_after_mod,
(tags_to_send) ? tags_to_send : "");
if (tags_to_send)
free (tags_to_send);
/* send command */
irc_server_send (server, server->outqueue[priority]->message_after_mod,
strlen (server->outqueue[priority]->message_after_mod));
server->last_user_message = time_now;
/* start redirection if redirect is set */
if (server->outqueue[priority]->redirect)
{
irc_redirect_init_command (server->outqueue[priority]->redirect,
server->outqueue[priority]->message_after_mod);
}
/* ... */
}
----
* `if` 条件はインデントし、演算子を含む条件は丸括弧で括ってください
(単独のブール値を評価する場合は不要)、例:
[source,C]
----
if (something)
{
/* something */
}
else
{
/* something else */
}
if (my_boolean1 && my_boolean2 && (i == 10)
&& ((buffer1 != buffer2) || (window1 != window2)))
{
/* something */
}
else
{
/* something else */
}
----
* `switch` 文は以下の様にインデントしてください:
[source,C]
----
switch (string[0])
{
case 'A': /* first case */
foo ("abc", "def");
break;
case 'B': /* second case */
bar (1, 2, 3);
break;
default: /* other cases */
baz ();
break;
}
----
* 関数プロトタイプには `typedef` を使い、構造体を使わないでください:
[source,C]
----
typedef int (t_hook_callback_fd)(void *data, int fd);
struct t_hook_fd
{
t_hook_callback_fd *callback; /* fd callback */
int fd; /* socket or file descriptor */
int flags; /* fd flags (read,write,..) */
int error; /* contains errno if error occurred */
/* with fd */
};
/* ... */
struct t_hook_fd *new_hook_fd;
new_hook_fd = malloc (sizeof (*new_hook_fd));
----
* Emacs テキストエディタのユーザは以下の Lisp コードを
_~/.emacs.el_ に追記することで、適切なインデントを行うことができます。
[source,lisp]
----
(add-hook 'c-mode-common-hook
'(lambda ()
(c-toggle-hungry-state t)
(c-set-style "k&r")
(setq c-basic-offset 4)
(c-tab-always-indent t)
(c-set-offset 'case-label '+)))
----
[[coding_python_style]]
=== Python スタイル
https://www.python.org/dev/peps/pep-0008/ を参照
[[core_internals]]
== コアの構造
[[naming_convention]]
=== 命名規則
[[naming_convention_files]]
==== ファイル
ファイル名に使えるのは文字とハイフンだけで、書式: _xxx-yyyyy.[ch]_
に従ってください。_xxx_ はディレクトリおよび構成要素 (略称も可) で、_yyyyy_
はファイルの名前です。
主要ファイルにはディレクトリと同じ名前を付ける事ができます。例えば
irc プラグインの _irc.c_ など。
例:
[width="100%",cols="1m,3",options="header"]
|===
| ディレクトリ | ファイル
| src/core/ | weechat.c、wee-backtrace.c、wee-command.c、...
| src/gui/ | gui-bar.c、gui-bar-item.c、gui-bar-window.c、...
| src/gui/curses/ | gui-curses-bar.c、gui-curses-bar-window.c、gui-curses-chat.c、...
| src/plugins/ | plugin.c、plugin-api.c、plugin-api-info.c、plugin-config.c、plugin-script.c、...
| src/plugins/irc/ | irc.c、irc-bar-item.c、irc-buffer.c、...
| src/plugins/python/ | weechat-python.c、weechat-python-api.c、...
|===
C 言語ファイルのヘッダはファイルと同じ名前です、例えばファイル
_wee-command.c_ のヘッダファイルは _wee-command.h_ です
[[naming_convention_structures]]
==== 構造体
構造体の名前は _t_X_Y_ または _t_X_Y_Z_ という書式に従います:
* _X_: ディレクトリ/構成要素 (略称も可)
* _Y_: ファイル名の最後
* _Z_: 構造体の名前 (任意)
例: IRC のニックネーム (_src/plugins/irc/irc-nick.h_ より):
[source,C]
----
struct t_irc_nick
{
char *name; /* nickname */
char *host; /* full hostname */
char *prefixes; /* string with prefixes enabled for nick */
char prefix[2]; /* current prefix (higher prefix set in */
/* prefixes) */
int away; /* 1 if nick is away */
char *color; /* color for nickname in chat window */
struct t_irc_nick *prev_nick; /* link to previous nick on channel */
struct t_irc_nick *next_nick; /* link to next nick on channel */
};
----
[[naming_convention_variables]]
==== 変数
グローバル変数 (関数の外側) の名前は _X_Y_Z_ という書式に従います:
* _X_: ディレクトリ/構成要素 (略称も可)
* _Y_: ファイル名の最後
* _Z_: 変数の名前
例外として、リストの「最後の」ノードを表す変数の名前は _last_X_
という書式に従います (ここで _X_ は変数の名前で、単数形を使います)。
例: ウィンドウ (_src/gui/gui-window.c_ より):
[source,C]
----
struct t_gui_window *gui_windows = NULL; /* first window */
struct t_gui_window *last_gui_window = NULL; /* last window */
struct t_gui_window *gui_current_window = NULL; /* current window */
----
ローカル変数 (関数内) に対する命名規則はありません。ただし具体的な (短すぎない)
名前をつけることを推奨します。とは言うものの、構造体へのポインタは通常 _ptr_xxxx_
のように名付けます。例えば、_struct t_gui_buffer *_ へのポインタは: _*ptr_buffer_
のように名付けます。
[[naming_convention_functions]]
==== 関数
関数に対する命名規則は<<naming_convention_variables,変数>>と同じです。
例: 新しいウィンドウの作成 (_src/gui/gui-window.c_ より):
[source,C]
----
/*
* Creates a new window.
*
* Returns pointer to new window, NULL if error.
*/
struct t_gui_window *
gui_window_new (struct t_gui_window *parent_window, struct t_gui_buffer *buffer,
int x, int y, int width, int height,
int width_pct, int height_pct)
{
/* ... */
return new_window;
}
----
[[single_thread]]
=== シングルスレッド
WeeChat はシングルスレッドです。これはつまり、コードの全ての部分を非常に高速に実行する必要があり、`sleep`
などの関数を呼び出すことは *厳格に禁止* されているということです (この点は
WeeChat コアだけでなく、C 言語プラグインとスクリプトでも同じことが言えます)。
何らかの理由でしばらく sleep したい場合は、`hook_timer` をコールバックと併せて使ってください。
[[doubly_linked_lists]]
=== 双方向連結リスト
WeeChat のほとんどの連結リストは双方向連結リストです: 各ノードは
1 つ前と 1 つ後のノードへのポインタを持っています。
例: バッファのリスト (_src/gui/gui-buffer.h_ より):
[source,C]
----
struct t_gui_buffer
{
/* data */
/* ... */
struct t_gui_buffer *prev_buffer; /* link to previous buffer */
struct t_gui_buffer *next_buffer; /* link to next buffer */
};
----
さらにリストの最初と最後を示す 2 つのポインタがあります:
[source,C]
----
struct t_gui_buffer *gui_buffers = NULL; /* first buffer */
struct t_gui_buffer *last_gui_buffer = NULL; /* last buffer */
----
[[color_codes_in_strings]]
=== 文字列中の色コード
WeeChat は文字列中に独自の色コードを使うことで、属性
(太字、下線、...) と画面上の色を表現します。
文字列にある文字を含め、その後に属性および色を指定します、これは:
* _0x19_: 色コード (これの後に色コード指定)
* _0x1A_: 属性の設定 (これの後に属性を指定)
* _0x1B_: 削除属性 (これの後に属性を指定)
* _0x1C_: リセット (これの後には何も付けない)
指定できる属性は (1 文字以上):
* `+*+`: 太字
* `+!+`: 反転
* `+/+`: イタリック
* `+_+`: 下線
* `+|+`: 属性を保存
指定できる色は:
* 標準色: 任意属性 + 2 桁の番号
* 拡張色: `+@+` + 任意属性 + 5 桁の番号
以下の表に使われる組み合わせを示す:
* `STD`: 標準色 (2 桁の番号)
* `(A)STD`: 任意属性を含めた標準色 (属性 + 2 桁の番号)
* `EXT`: 拡張色 (`+@+` + 5 桁の番号)
* `(A)EXT`:任意属性を含めた拡張色 (`+@+` + 属性 + 5 桁の番号)
* `ATTR`: 属性指定の 1 文字 (`+*+`、`+!+`、`+/+`、`+_+`、`+|+`)
以下の表にすべての組み合わせをまとめています:
[width="100%",cols="4,2,2,8",options="header"]
|===
| コード | 例 | エリア | 説明
| [hex]#19# + STD | [hex]#19# `+01+` | chat + bars | オプションを使って属性と色を指定、色コードは以下の表を参照
| [hex]#19# + EXT | [hex]#19# `+@00001+` | chat | ncurses ペアを使って色を指定 (`/color` バッファのみ有効)
| [hex]#19# + "F" + (A)STD | [hex]#19# `+F*05+` | chat + bars | 文字色 (WeeChat 色) を設定
| [hex]#19# + "F" + (A)EXT | [hex]#19# `+F@00214+` | chat + bars | 文字色 (拡張色) を設定
| [hex]#19# + "B" + STD | [hex]#19# `+B05+` | chat + bars | 背景色 (WeeChat 色) を設定
| [hex]#19# + "B" + EXT | [hex]#19# `+B@00124+` | chat + bars | 背景色 (拡張色) を設定
| [hex]#19# + "*" + (A)STD | [hex]#19# `+*05+` | chat + bars | 文字色(WeeChat 色) を設定
| [hex]#19# + "*" + (A)EXT | [hex]#19# `+*@00214+` | chat + bars | 文字色 (拡張色) を設定
| [hex]#19# + "*" + (A)STD + "," + STD ^(1)^ | [hex]#19# `+*08,05+` | chat + bars | 文字色および背景色 (WeeChat 色) を設定
| [hex]#19# + "*" + (A)STD + "," + EXT ^(1)^ | [hex]#19# `+*01,@00214+` | chat + bars | 文字色 (WeeChat 色) と背景色 (拡張色) を設定
| [hex]#19# + "*" + (A)EXT + "," + STD ^(1)^ | [hex]#19# `+*@00214,05+` | chat + bars | 文字色 (拡張色) と背景色 (WeeChat 色) を設定
| [hex]#19# + "*" + (A)EXT + "," + EXT ^(1)^ | [hex]#19# `+*@00214,@00017+` | chat + bars | 文字色および背景色 (拡張色) を設定
| [hex]#19# + "*" + (A)STD + "~" + STD | [hex]#19# `+*08~05+` | chat + bars | 文字色および背景色 (WeeChat 色) を設定
| [hex]#19# + "*" + (A)STD + "~" + EXT | [hex]#19# `+*01~@00214+` | chat + bars | 文字色 (WeeChat 色) と背景色 (拡張色) を設定
| [hex]#19# + "*" + (A)EXT + "~" + STD | [hex]#19# `+*@00214~05+` | chat + bars | 文字色 (拡張色) と背景色 (WeeChat 色) を設定
| [hex]#19# + "*" + (A)EXT + "~" + EXT | [hex]#19# `+*@00214~@00017+` | chat + bars | 文字色および背景色 (拡張色) を設定
| [hex]#19# + "b" + "F" | [hex]#19# `+bF+` | bars | バーの文字色を設定
| [hex]#19# + "b" + "D" | [hex]#19# `+bD+` | bars | バーの区切り文字色を設定
| [hex]#19# + "b" + "B" | [hex]#19# `+bB+` | bars | バーの背景色を設定
| [hex]#19# + "b" + "_" | [hex]#19# `+b_+` | input bar | 文字入力を開始 ("input_text" 要素のみで利用可)
| [hex]#19# + "b" + "-" | [hex]#19# `+b-+` | input bar | 隠し文字入力を開始 ("input_text" 要素のみで利用可)
| [hex]#19# + "b" + "#" | [hex]#19# `+b#+` | input bar | カーソル文字を移動 ("input_text" 要素のみで利用可)
| [hex]#19# + "b" + "i" | [hex]#19# `+bi+` | bars | 要素を開始
| [hex]#19# + "b" + "l" (小文字の L) | [hex]#19# `+bl+` | bars | 行要素を開始
| [hex]#19# + "E" | [hex]#19# `+E+` | chat + bars | テキストを強調 _(WeeChat バージョン 0.4.2 以上で利用可)_
| [hex]#19# + [hex]#1C# | [hex]#19# [hex]#1C# | chat + bars | 色をリセット (属性は保存)
| [hex]#1A# + ATTR | [hex]#1A# `+*+` | chat + bars | 属性を設定
| [hex]#1B# + ATTR | [hex]#1B# `+*+` | chat + bars | 属性を削除
| [hex]#1C# | [hex]#1C# | chat + bars | 属性と色をリセット
|===
// TRANSLATION MISSING
[NOTE]
^(1)^ The use of comma as separator was used until WeeChat 2.5. +
With WeeChat ≥ 2.6, a tilde is used to separate foreground from background
color. If you are developing a WeeChat relay client and want to be compatible
with all WeeChat versions, you should support both separators (for example if a
user with WeeChat ≤ 2.5 runs `/upgrade` to a version ≥ 2.6, both separators
could be used at same time in buffers).
オプションを使う色コード
(_src/gui/gui-color.h_ ファイルの _t_gui_color_enum_ を参照):
[width="70%",cols="^1m,10",options="header"]
|===
| コード | オプション
| 00 | weechat.color.separator
| 01 | weechat.color.chat
| 02 | weechat.color.chat_time
| 03 | weechat.color.chat_time_delimiters
| 04 | weechat.color.chat_prefix_error
| 05 | weechat.color.chat_prefix_network
| 06 | weechat.color.chat_prefix_action
| 07 | weechat.color.chat_prefix_join
| 08 | weechat.color.chat_prefix_quit
| 09 | weechat.color.chat_prefix_more
| 10 | weechat.color.chat_prefix_suffix
| 11 | weechat.color.chat_buffer
| 12 | weechat.color.chat_server
| 13 | weechat.color.chat_channel
| 14 | weechat.color.chat_nick
| 15 | weechat.color.chat_nick_self
| 16 | weechat.color.chat_nick_other
| 17 | _(WeeChat バージョン 0.3.4 以上で利用不可)_
| 18 | _(WeeChat バージョン 0.3.4 以上で利用不可)_
| 19 | _(WeeChat バージョン 0.3.4 以上で利用不可)_
| 20 | _(WeeChat バージョン 0.3.4 以上で利用不可)_
| 21 | _(WeeChat バージョン 0.3.4 以上で利用不可)_
| 22 | _(WeeChat バージョン 0.3.4 以上で利用不可)_
| 23 | _(WeeChat バージョン 0.3.4 以上で利用不可)_
| 24 | _(WeeChat バージョン 0.3.4 以上で利用不可)_
| 25 | _(WeeChat バージョン 0.3.4 以上で利用不可)_
| 26 | _(WeeChat バージョン 0.3.4 以上で利用不可)_
| 27 | weechat.color.chat_host
| 28 | weechat.color.chat_delimiters
| 29 | weechat.color.chat_highlight
| 30 | weechat.color.chat_read_marker
| 31 | weechat.color.chat_text_found
| 32 | weechat.color.chat_value
| 33 | weechat.color.chat_prefix_buffer
| 34 | weechat.color.chat_tags _(WeeChat バージョン 0.3.6 以上で利用可)_
| 35 | weechat.color.chat_inactive_window _(WeeChat バージョン 0.3.6 以上で利用可)_
| 36 | weechat.color.chat_inactive_buffer _(WeeChat バージョン 0.3.6 以上で利用可)_
| 37 | weechat.color.chat_prefix_buffer_inactive_buffer _(WeeChat バージョン 0.3.6 以上で利用可)_
| 38 | weechat.color.chat_nick_offline _(WeeChat バージョン 0.3.9 以上で利用可)_
| 39 | weechat.color.chat_nick_offline_highlight _(WeeChat バージョン 0.3.9 以上で利用可)_
| 40 | weechat.color.chat_nick_prefix _(WeeChat バージョン 0.4.1 以上で利用可)_
| 41 | weechat.color.chat_nick_suffix _(WeeChat バージョン 0.4.1 以上で利用可)_
| 42 | weechat.color.emphasized _(WeeChat バージョン 0.4.2 以上で利用可)_
| 43 | weechat.color.chat_day_change _(WeeChat バージョン 0.4.2 以上で利用可)_
| 44 | weechat.color.chat_value_null _(WeeChat バージョン 1.4 以上で利用可)_
|===
WeeChat 色は:
[width="70%",cols="^1m,10",options="header"]
|===
| コード | 色
| 00 | デフォルト (端末の文字色/背景色)
| 01 | 黒
| 02 | 暗い灰色
| 03 | 暗い赤
| 04 | 明るい赤
| 05 | 暗い緑
| 06 | 明るい緑
| 07 | 茶色
| 08 | 黄色
| 09 | 暗い青
| 10 | 明るい青
| 11 | 暗いマゼンダ
| 12 | 明るいマゼンダ
| 13 | 暗いシアン
| 14 | 明るいシアン
| 15 | 灰色
| 16 | 白
|===
色コードの例:
[width="70%",cols="1,2",options="header"]
|===
| コード | 説明
| [hex]#19# `+01+` | オプション "01" の色 (チャットテキスト)
| [hex]#19# `+*08,03+` | 文字色が黄色、背景色が赤色
| [hex]#19# `+*@00214+` | オレンジ (拡張色 214)
| [hex]#19# `+*@*_00214,@00017+` | 文字は太字で下線付きのオレンジ色 (214)、背景色は青 (17)
| [hex]#1A# `+_+` | 下線
| [hex]#1B# `+_+` | 下線を削除
| [hex]#1C# | 属性と色をリセット
|===
[[plugin_internals]]
== プラグインの内部構造
ファイル _src/plugins/weechat-plugin.h_ は API
で使うことのできる全ての関数を定義し、エクスポートします。
_t_weechat_plugin_ 構造体はプラグインに関する情報
(ファイル名、プラグイン名、作者、説明、...)
と全ての API 関数をポインタにしてを保存するために使われます
API 関数を簡単に呼び出すためのマクロが定義されています。
例えば、関数 _hook_timer_ は以下のように構造体
_t_weechat_plugin_ で定義されています:
[source,C]
----
struct t_hook *(*hook_timer) (struct t_weechat_plugin *plugin,
long interval,
int align_second,
int max_calls,
int (*callback)(void *data,
int remaining_calls),
void *callback_data);
----
この関数を呼び出すマクロは:
[source,C]
----
#define weechat_hook_timer(__interval, __align_second, __max_calls, \
__callback, __data) \
weechat_plugin->hook_timer(weechat_plugin, __interval, \
__align_second, __max_calls, \
__callback, __data)
----
このため、プラグイン内での関数の呼び出しは以下の例の様に行います:
[source,C]
----
server->hook_timer_sasl = weechat_hook_timer (timeout * 1000,
0, 1,
&irc_server_timer_sasl_cb,
server);
----
[[contribute]]
== WeeChat への貢献
[[git_repository]]
=== Git リポジトリ
Git リポジトリはこの URL にあります: https://github.com/weechat/weechat
バグや新機能のパッチは必ず master ブランチに対して適用できるものを作成し、GitHub の pull
リクエストを使って提出することを推奨します。パッチは電子メールで送信することも可能です
(`git diff` または `git format-patch` で作成してください)。
コミットメッセージは以下の書式に従ってください (GitHub の issue を閉じる場合):
----
component: fix a problem (closes #123)
----
Savannah のバグを閉じる場合:
----
component: fix a problem (bug #12345)
----
_component_ には以下から 1 つ選んで記入してください:
* WeeChat コア: _core_ (ルートディレクトリ、_po/_ ディレクトリ、_src/_
ディレクトリに含まれるファイル、ただし _src/plugins/_ 内のファイルを除く)
* 文書ファイル: _doc_ (_doc/_ ディレクトリに含まれるファイル)
* プラグインの名前: _irc_、_python_、_relay_、... (_src/plugins/_ ディレクトリに含まれるファイル)
以下のルールに従ってください:
* 英語を使ってください
* 動詞の原形を使ってください
* コミットの内容がトラッカーに関するものである場合には、コミットメッセージの後にカッコで括ってその旨記載してください、書式は以下のようにしてください:
** GitHub: closes #123
** Savannah: bug #12345, task #12345, patch #12345
コミットメッセージの例:
----
irc: add command /unquiet (closes #36)
core: add callback "nickcmp" for nick comparison in buffers
irc: fix freeze when reading on socket with SSL enabled (bug #35097)
ruby: add detection of ruby version 1.9.3 in CMake
python: fix crash when unloading a script without pointer to interpreter
core: update Japanese translations (patch #7783)
----
[[translations]]
=== 翻訳
[[gettext]]
==== Gettext
Gettext ファイルは _po/_
ディレクトリに入っています。新しい言語の翻訳を始める際は、コマンド
`msginit` を使ってください。例えばオランダ語の空ファイルを作成するには:
----
$ cd po
$ msginit -i weechat.pot -l nl_NL -o nl.po
----
WeeChat
の翻訳元言語は英語です、翻訳する場合は必ず英語から翻訳してください
ソースに変更があった際は、以下のコマンドを Cmake の "build"
ディレクトリで実行することで、すべての翻訳を再生成する事が可能です。
----
$ make translations && make update-po
----
その後翻訳できるならば .po ファイルを編集します。
翻訳が完了したら、*必ず* _msgcheck.py_ (https://github.com/flashcode/msgcheck)
スクリプトを使ってファイルの内容を確認してください:
----
$ msgcheck.py xx.po
----
新しい翻訳を使うには WeeChat を再コンパイルしてください。
[[build_autogen_files]]
===== 自動生成ファイルを作成する
_doc/XX/autogen/_ ディレクトリに含まれるファイルは _doc/docgen.py_ スクリプトが自動生成するファイルです。
この python スクリプトを自分の python ディレクトリ (例えば _~/.weechat/python_)
にコピーしてください。WeeChat からこのスクリプトをロードして、_/doc_ ディレクトリへのパスを設定してください:
----
/python load docgen.py
/set plugins.var.python.docgen.path "~/src/weechat/doc"
----
ファイルを生成するエイリアスを作ってください:
----
/alias add doc /perl unload; /python unload; /ruby unload; /lua unload; /tcl unload; /guile unload; /javascript unload; /python load docgen.py; /wait 1ms /docgen
----
コマンド `/doc` を使って全ての (全てのプログラミング言語について) 自動生成するファイルを作成してください。
[IMPORTANT]
コマンド `/doc` を使う際に、すべての C 言語プラグイン (irc、charset、...)
がロードされていることを確認して下さい、これはメモリ上にあるデータを使ってファイルを作成するためです。
[[asciidoc]]
==== Asciidoc
Asciidoc ファイルは _doc/XX/_ ディレクトリにあり、_XX_
は言語コード (en、fr、de、it、...) です。
最初に英語の asciidoc ファイル (_doc/en/_ ディレクトリ中にある)
をコピーして、それを編集してください。
ファイル中の未翻訳部分には以下の文字列で目印が付けられています:
----
// TRANSLATION MISSING
----
メモや警告などを示すリンクおよび特殊キーワードを除く全ての部分を必ず翻訳してください、以下の単語を書き換えるのはやめてください:
----
[[link_name]]
<<link_name>>
[NOTE]
[TIP]
[IMPORTANT]
[WARNING]
[CAUTION]
----
`<<link_name>>` の後に名前がある場合、これも必ず翻訳してください:
----
<<link_name,このテキストは必ず翻訳してください>>
----
|
