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
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
|
// SPDX-FileCopyrightText: 2003-2025 Sébastien Helleu <flashcode@flashtux.org>
//
// SPDX-License-Identifier: GPL-3.0-or-later
= Guide du développeur WeeChat
:author: Sébastien Helleu
:email: flashcode@flashtux.org
:lang: fr
include::includes/attributes-fr.adoc[]
Ce manuel documente le client de messagerie instantanée WeeChat, il fait
partie de WeeChat.
La dernière version de ce document peut être téléchargée sur
https://weechat.org/doc/[cette page ^↗^^].
[[introduction]]
== Introduction
WeeChat (Wee Enhanced Environment for Chat) est un client de discussion libre,
rapide et léger, conçu pour différents systèmes d'exploitation.
Ce manuel documente l'intérieur de WeeChat :
* dépôts
* règles de développement
* le cœur
* les extensions
* comment contribuer à WeeChat.
[[repositories]]
== Dépôts
Les dépôts de WeeChat sont dans l'organisation
https://github.com/weechat[weechat ^↗^^] de GitHub.
Liste des dépôts :
weechat::
dépôt principal avec le code source et la documentation
scripts::
les scripts _officiels_ soumis sur weechat.org
weechat.org::
le code source du https://weechat.org/[site de WeeChat ^↗^^]
weercd::
serveur de test IRC
qweechat::
interface Qt distante pour WeeChat.
Ce manuel documente seulement le dépôt _weechat_.
[[overview]]
=== Vue d'ensemble
Les répertoires principaux de WeeChat sont :
[width="100%",cols="2m,3",options="header"]
|===
| Répertoire | Description
| src/ | Racine des sources.
| core/ | Fonctions du cœur : point d'entrée, structures internes.
| hook/ | Fonctions sur les "hooks".
| gui/ | Fonctions pour les tampons, fenêtres, ... (utilisées par toutes les interfaces).
| curses/ | Interface Curses.
| headless/ | Mode sans interface (« headless »).
| normal/ | Interface Curses.
| plugins/ | API extension/script.
| alias/ | Extension Alias.
| buflist/ | Extension Buflist.
| charset/ | Extension Charset.
| exec/ | Extension Exec.
| fifo/ | Extension Fifo (tube FIFO utilisé pour envoyer des commandes à WeeChat).
| fset/ | Extension Fset (Fast Set).
| guile/ | API script Guile (scheme).
| irc/ | Extension IRC (Internet Relay Chat).
| javascript/ | API script JavaScript.
| logger/ | Extension Logger (enregistrer les messages affichés dans des fichiers).
| lua/ | API script Lua.
| perl/ | API script Perl.
| php/ | API script PHP.
| python/ | API script Python.
| relay/ | Extension Relay (proxy IRC + relai pour interfaces distantes).
| ruby/ | API script Ruby.
| script/ | Gestionnaire de scripts.
| spell/ | Extension Spell.
| tcl/ | API script Tcl.
| trigger/ | Extension Trigger.
| typing/ | Extension Typing.
| xfer/ | Extension Xfer (IRC DCC fichier/discussion).
| tests/ | Tests.
| fuzz/ | Fuzzing (tests à données aléatoires).
| core/ | Fuzzing pour les fonctions du cœur.
| unit/ | Tests unitaires.
| core/ | Tests unitaires pour les fonctions du cœur.
| hook/ | Tests unitaires pour les fonctions hook.
| gui/ | Tests unitaires pour les fonctions de l'interface.
| curses/ | Tests unitaires pour les fonctions de l'interface Curses.
| scripts/ | Tests de l'API script.
| python/ | Scripts Python pour générer et lancer les tests de l'API script.
| plugins/ | Tests unitaires pour les extensions.
| alias/ | Tests unitaires pour l'extension alias.
| irc/ | Tests unitaires pour l'extension IRC.
| logger/ | Tests unitaires pour l'extension logger.
| relay/ | Tests unitaires pour l'extension relay.
| trigger/ | Tests unitaires pour l'extension trigger.
| typing/ | Tests unitaires pour l'extension typing.
| xfer/ | Tests unitaires pour l'extension xfer.
| doc/ | Documentation.
| po/ | Fichiers de traductions (gettext).
| debian/ | Empaquetage Debian.
|===
[[sources]]
=== Sources
[[sources_core]]
==== Cœur
Le cœur de WeeChat est situé dans les répertoires suivants :
* _src/core/_ : fonctions du cœur (pour manipuler des données)
* _src/gui/_ : fonctions pour l'interface (tampons, fenêtres, ...)
[width="100%",cols="2m,3",options="header"]
|===
| Chemin/fichier | Description
| core/ | Fonctions du cœur : point d'entrée, structures internes.
| core-arraylist.c | Listes avec tableau (« arraylists »).
| core-backtrace.c | Afficher une trace après un plantage.
| core-calc.c | Calcul du résultat d'expressions.
| core-command.c | Commandes du cœur de WeeChat.
| core-completion.c | Complétions par défaut.
| core-config-file.c | Gestion des fichiers de configuration.
| core-config.c | Options de configuration du cœur de WeeChat (fichier weechat.conf).
| core-crypto.c | Fonctions de cryptographie.
| core-debug.c | Quelques fonctions de debug.
| core-dir.c | Fonctions sur les répertoires/fichiers.
| core-doc.c | Génération de fichiers pour la documentation.
| core-eval.c | Évaluation d'expressions avec des références à des variables internes.
| core-hashtable.c | Tables de hachage.
| core-hdata.c | Hdata (accès direct aux données en utilisant des tables de hachage).
| core-hook.c | Crochets ("hooks").
| core-infolist.c | Infolists (listes avec les données des objets).
| core-input.c | Entrée de commandes/texte.
| core-list.c | Listes triées.
| core-log.c | Écriture dans le fichier de log WeeChat (weechat.log).
| core-network.c | Fonctions réseau (connexion aux serveurs/proxies).
| core-proxy.c | Gestion des proxies.
| core-secure.c | Fonctions pour les données sécurisées.
| core-secure-buffer.c | Tampon pour les données sécurisées.
| core-secure-config.c | Options des données sécurisées (fichier sec.conf).
| core-signal.c | Fonctions sur les signaux.
| core-string.c | Fonctions sur les chaînes de caractères.
| core-sys.c | Fonctions système.
| core-upgrade-file.c | Système de mise à jour interne.
| core-upgrade.c | Mise à jour du cœur de WeeChat (tampons, lignes, historique, ...).
| core-url.c | Transfert d'URL (en utilisant libcurl).
| core-utf8.c | Fonctions UTF-8.
| core-util.c | Quelques autres fonctions utilitaires.
| core-version.c | Fonctions pour la version de WeeChat.
| weechat.c | Fonctions principales : options de ligne de commande, démarrage.
| hook/ | Fonctions "hook".
| hook-command-run.c | Hook "command_run".
| hook-command.c | Hook "command".
| hook-completion.c | Hook "completion".
| hook-config.c | Hook "config".
| hook-connect.c | Hook "connect".
| hook-fd.c | Hook "fd".
| hook-focus.c | Hook "focus".
| hook-hdata.c | Hook "hdata".
| hook-hsignal.c | Hook "hsignal".
| hook-info-hashtable.c | Hook "info".
| hook-info.c | Hook "info".
| hook-infolist.c | Hook "infolist".
| hook-line.c | Hook "line".
| hook-modifier.c | Hook "modifier".
| hook-print.c | Hook "print".
| hook-process.c | Hook "process".
| hook-signal.c | Hook "signal".
| hook-timer.c | Hook "timer".
| hook-url.c | Hook "url".
| gui/ | Fonctions pour les tampons, fenêtres, ... (utilisées par toutes les interfaces).
| gui-bar-item.c | Objets de barre.
| gui-bar-window.c | Fenêtres de barre.
| gui-bar.c | Barres.
| gui-buffer.c | Tampons.
| gui-chat.c | Fonctions pour la discussion (afficher un message, ...).
| gui-color.c | Fonctions de couleur.
| gui-completion.c | Complétion sur la ligne de commande.
| gui-cursor.c | Mode curseur (mouvement libre du curseur).
| gui-filter.c | Filtres.
| gui-focus.c | Fonctions concernant le focus (pour les modes curseur et souris).
| gui-history.c | Commandes/texte sauvés dans les tampons.
| gui-hotlist.c | Gestion de la "hotlist" (liste des tampons avec activité).
| gui-input.c | Fonctions d'entrée (barre "input").
| gui-key.c | Fonctions pour le clavier.
| gui-layout.c | Dispositions ("layouts").
| gui-line.c | Lignes dans les tampons.
| gui-mouse.c | Souris.
| gui-nick.c | Fonctions pour les pseudos.
| gui-nicklist.c | Liste de pseudos dans les tampons.
| gui-window.c | Fenêtres.
| curses/ | Interface Curses.
| gui-curses-bar-window.c | Affichage dans les fenêtres de barre.
| gui-curses-chat.c | Affichage dans la zone de discussion (messages).
| gui-curses-color.c | Fonctions pour les couleurs.
| gui-curses-key.c | Fonctions pour le clavier (touches par défaut, lecture du clavier).
| gui-curses-main.c | Boucle principale de WeeChat (attente des évènements clavier/réseau).
| gui-curses-mouse.c | Souris.
| gui-curses-term.c | Fonctions pour le terminal.
| gui-curses-window.c | Fenêtres.
| headless/ | Mode sans interface (« headless »).
| main.c | Point d'entrée pour le mode sans interface.
| ncurses-fake.c | Fausse bibliothèque ncurses.
| normal/ | Interface Curses.
| main.c | Point d'entrée pour l'interface Curses.
|===
[[sources_plugins]]
==== Extensions
[width="100%",cols="2m,3",options="header"]
|===
| Chemin/fichier | Description
| plugins/ | Racine des extensions.
| plugin.c | Gestion des extensions (chargement/déchargement des bibliothèques C dynamiques).
| plugin-api.c | Fonctions supplémentaires pour l'API extension (enveloppes autour des fonctions du cœur de WeeChat).
| plugin-api-info.c | Fonctions supplémentaires info/infolist pour l'API extension.
| plugin-config.c | Options de configuration des extensions (fichier plugins.conf).
| plugin-script.c | Fonctions communes utilisés par les extensions pour les scripts.
| plugin-script-api.c | Fonctions pour l'API script : enveloppes autour de quelques fonctions de l'API extension.
| plugin-script-config.c | Options de configuration des extensions pour les scripts (fichiers python.conf, perl.conf, ...).
| weechat-plugin.h | En-tête destiné à être distribué avec les extensions WeeChat, pour les compiler.
| alias/ | Extension Alias.
| alias.c | Fonctions principales pour les alias.
| alias-command.c | Commandes Alias.
| alias-completion.c | Complétions pour Alias.
| alias-config.c | Options de configuration des alias (fichier alias.conf).
| alias-info.c | Info/infolists/hdata pour les alias.
| spell/ | Extension Spell.
| spell.c | Fonctions principales pour Spell.
| spell-bar-item.c | Objets de barre Spell.
| spell-command.c | Commandes Spell.
| spell-completion.c | Complétions pour Spell.
| spell-config.c | Options de configuration pour Spell (fichier spell.conf).
| spell-info.c | Info/infolists/hdata pour Spell.
| spell-speller.c | Gestion des correcteurs orthographiques.
| buflist/ | Extension Buflist.
| buflist.c | Fonctions principales de Buflist.
| buflist-bar-item.c | Objets de barre Buflist.
| buflist-command.c | Commandes pour Buflist.
| buflist-completion.c | Complétions pour Buflist.
| buflist-config.c | Options de configuration pour Buflist (fichier buflist.conf).
| buflist-info.c | Info/infolists/hdata pour Buflist.
| buflist-mouse.c | Actions souris pour Buflist.
| charset/ | Extension Charset.
| charset.c | Fonctions pour Charset.
| exec/ | Extension Exec.
| exec.c | Fonctions principales de Exec.
| exec-buffer.c | Tampon Exec.
| exec-command.c | Commandes pour Exec.
| exec-completion.c | Complétions pour Exec.
| exec-config.c | Options de configuration pour Exec (fichier exec.conf).
| fifo/ | Extension Fifo.
| fifo.c | Fonctions principales de Fifo.
| fifo-command.c | Commandes pour Fifo.
| fifo-config.c | Options de configuration pour Fifo (fichier fifo.conf).
| fifo-info.c | Info/infolists/hdata pour Fifo.
| fset/ | Extension Fset.
| fset.c | Fonctions principales de Fset.
| fset-bar-item.c | Objets de barre Fset.
| fset-buffer.c | Tampon Fset.
| fset-command.c | Commandes pour Fset.
| fset-completion.c | Complétions pour Fset.
| fset-config.c | Options de configuration pour Fset (fichier fset.conf).
| fset-info.c | Info/infolists/hdata pour Fset.
| fset-mouse.c | Actions souris pour Fset.
| fset-option.c | Gestion des options Fset.
| guile/ | Extension Guile (scheme).
| weechat-guile.c | Fonctions principales pour Guile (chargement/déchargement des scripts, exécution de code Guile).
| weechat-guile-api.c | Fonctions de l'API script Guile.
| irc/ | Extension IRC (Internet Relay Chat).
| irc.c | Fonctions principales IRC.
| irc-bar-item.c | Objets de barre IRC.
| irc-batch.c | Évènements batch IRC.
| irc-buffer.c | Tampons IRC.
| irc-channel.c | Canaux IRC.
| irc-color.c | Couleurs IRC.
| irc-command.c | Commandes IRC.
| irc-completion.c | Complétions IRC.
| irc-config.c | Options de configuration IRC (fichier irc.conf).
| irc-ctcp.c | CTCP IRC.
| irc-debug.c | Fonctions de debug IRC.
| irc-ignore.c | Ignore IRC.
| irc-info.c | Info/infolists/hdata pour IRC.
| irc-input.c | Entrée de commandes/texte.
| irc-join.c | Fonctions pour les listes de canaux à rejoindre.
| irc-list.c | Tampon pour la réponse à la commande /list.
| irc-message.c | Fonctions pour manipuler les messages IRC.
| irc-mode.c | Fonctions pour les modes de canal/pseudo.
| irc-modelist.c | Listes de modes de canaux IRC (+b, +e, +I, ...).
| irc-msgbuffer.c | Tampon cible pour les messages IRC.
| irc-nick.c | Pseudos IRC.
| irc-notify.c | Listes de notification IRC.
| irc-protocol.c | Protocole IRC (RFCs 1459/2810/2811/2812/2813/7194).
| irc-raw.c | Tampon des données brutes IRC.
| irc-redirect.c | Redirection de la sortie des commandes IRC.
| irc-sasl.c | Authentification SASL avec le serveur IRC.
| irc-server.c | Communication avec le serveur IRC.
| irc-tag.c | Fonctions pour manipuler les étiquettes de message IRC.
| irc-typing.c | Statut d'écriture.
| irc-upgrade.c | Sauvegarde/restauration des données IRC lors de la mise à jour de WeeChat.
| javascript/ | Extension JavaScript.
| weechat-js.cpp | Fonctions principales pour JavaScript (chargement/déchargement des scripts, exécution de code JavaScript).
| weechat-js-api.cpp | Fonctions de l'API script JavaScript.
| weechat-js-v8.cpp | Fonctions JavaScript v8.
| logger/ | Extension Logger.
| logger.c | Fonctions principales pour Logger.
| logger-backlog.c | Fonctions de backlog pour Logger.
| logger-buffer.c | Gestion des listes de tampons pour Logger.
| logger-command.c | Commandes de Logger.
| logger-config.c | Options de configuration pour Logger (fichier logger.conf).
| logger-info.c | Info/infolists/hdata pour Logger.
| logger-tail.c | Fonctions pour obtenir les dernières lignes d'un fichier.
| lua/ | Extension Lua.
| weechat-lua.c | Fonctions principales pour Lua (chargement/déchargement des scripts, exécution de code Lua).
| weechat-lua-api.c | Fonctions de l'API script Lua.
| perl/ | Extension Perl.
| weechat-perl.c | Fonctions principales pour Perl (chargement/déchargement des scripts, exécution de code Perl).
| weechat-perl-api.c | Fonctions de l'API script Perl.
| php/ | Extension PHP.
| weechat-php.c | Fonctions principales pour PHP (chargement/déchargement des scripts, exécution de code PHP).
| weechat-php-api.c | Fonctions de l'API script PHP.
| python/ | Extension Python.
| weechat-python.c | Fonctions principales pour Python (chargement/déchargement des scripts, exécution de code Python).
| weechat-python-api.c | Fonctions de l'API script Python.
| relay/ | Extension Relay (proxy IRC et relai pour des interfaces distantes).
| relay.c | Fonctions principales de Relay.
| relay-auth.c | Authentification des clients.
| relay-bar-item.c | Objets de barre Relay.
| relay-buffer.c | Tampon Relay.
| relay-client.c | Clients du relai.
| relay-command.c | Commandes de Relay.
| relay-completion.c | Complétions de Relay.
| relay-config.c | Options de configuration pour Relay (fichier relay.conf).
| relay-http.c | Fonctions HTTP.
| relay-info.c | Info/infolists/hdata pour Relay.
| relay-network.c | Fonctions de réseau pour Relay.
| relay-raw.c | Tampon des données brutes de Relay.
| relay-remote.c | Relai distant.
| relay-server.c | Serveur Relay.
| relay-upgrade.c | Sauvegarde/restauration des données Relay lors de la mise à jour de WeeChat.
| relay-websocket.c | Fonctions pour le serveur WebSocket (RFC 6455).
| api/ | Relai pour les interfaces distantes (en utilisant une API REST HTTP).
| relay-api.c | Fonctions principales pour l'API REST HTTP.
| relay-api-msg.c | Envoi de messages JSON aux clients.
| relay-api-protocol.c | Protocole HTTP REST API.
| remote/ | Relai distant.
| relay-remote-event.c | Traitement des évènements reçus du relai distant.
| relay-remote-network.c | Fonctions réseau pour le relai distant.
| irc/ | Proxy IRC.
| relay-irc.c | Fonctions principales pour le proxy IRC.
| weechat/ | Relai pour les interfaces distantes (en utilisant le protocole binaire "weechat").
| relay-weechat.c | Relai pour les interfaces distantes (fonctions principales).
| relay-weechat-msg.c | Envoi de messages binaires aux clients.
| relay-weechat-nicklist.c | Fonctions pour la liste de pseudos.
| relay-weechat-protocol.c | Lecture des commandes des clients.
| ruby/ | Extension Ruby.
| weechat-ruby.c | Fonctions principales pour Ruby (chargement/déchargement des scripts, exécution de code Ruby).
| weechat-ruby-api.c | Fonctions de l'API script Ruby.
| script/ | Gestionnaire de scripts.
| script.c | Fonctions principales du gestionnaire de scripts.
| script-action.c | Actions sur les scripts (chargement/déchargement, installation/suppression, ...).
| script-buffer.c | Tampon pour le gestionnaire de scripts.
| script-command.c | Commandes pour le gestionnaire de scripts.
| script-completion.c | Complétions pour le gestionnaire de scripts.
| script-config.c | Options de configuration pour le gestionnaire de scripts (fichier script.conf).
| script-info.c | Info/infolists/hdata pour le gestionnaire de scripts.
| script-mouse.c | Actions souris pour le gestionnaire de scripts.
| script-repo.c | Téléchargement et lecture du dépôt de scripts.
| tcl/ | Extension Tcl.
| weechat-tcl.c | Fonctions principales pour Tcl (chargement/déchargement des scripts, exécution de code Tcl).
| weechat-tcl-api.c | Fonctions de l'API script Tcl.
| trigger/ | Extension Trigger.
| trigger.c | Fonctions principales de Trigger.
| trigger-buffer.c | Tampon Trigger.
| trigger-callback.c | Fonctions de rappel de Trigger.
| trigger-command.c | Commandes pour Trigger.
| trigger-completion.c | Complétions pour Trigger.
| trigger-config.c | Options de configuration pour Trigger (fichier trigger.conf).
| typing/ | Extension Typing.
| typing.c | Fonctions principales de Typing.
| typing-bar-item.c | Objets de barre Typing.
| typing-config.c | Options de configuration pour Typing (fichier typing.conf).
| typing-status.c | Statut d'écriture de messages sur les tampons.
| xfer/ | Extension Xfer (IRC DCC fichier/discussion).
| xfer.c | Fonctions principales de Xfer.
| xfer-buffer.c | Tampon Xfer.
| xfer-chat.c | Discussion DCC.
| xfer-command.c | Commandes pour Xfer.
| xfer-completion.c | Complétions pour Xfer.
| xfer-config.c | Options de configuration pour Xfer (fichier xfer.conf).
| xfer-dcc.c | Transfert de fichier par DCC.
| xfer-file.c | Fonctions pour les fichiers dans Xfer.
| xfer-info.c | Info/infolists/hdata pour Xfer.
| xfer-network.c | Fonctions réseau pour Xfer.
| xfer-upgrade.c | Sauvegarde/restauration des données Xfer lors de la mise à jour de WeeChat.
|===
[[sources_tests]]
==== Tests
[width="100%",cols="2m,3",options="header"]
|===
| Chemin/fichier | Description
| tests/ | Racine des tests.
| fuzz/ | Racine du fuzzing (tests à données aléatoires).
| ossfuzz.sh | Script de construction pour https://github.com/google/oss-fuzz[OSS-Fuzz ^↗^^].
| core/ | Racine du fuzzing pour le cœur.
| calc-fuzzer.c | Fuzzing : calcul d'expressions.
| crypto-fuzzer.c | Fuzzing : fonctions cryptographiques.
| secure-fuzzer.c | Fuzzing : données sécurisées.
| string-fuzzer.c | Fuzzing : chaînes.
| utf8-fuzzer.c | Fuzzing : UTF-8.
| util-fuzzer.c | Fuzzing : fonctions utiles.
| unit/ | Racine des tests unitaires.
| tests.cpp | Programme utilisé pour lancer tous les tests.
| tests-record.cpp | Enregistrement et recherche dans les messages affichés.
| core/ | Racine des tests unitaires pour le cœur.
| test-core-arraylist.cpp | Tests : listes avec tableau (« arraylists »).
| test-core-calc.cpp | Tests : calcul d'expressions.
| test-core-command.cpp | Tests : commandes.
| test-core-config-file.cpp | Tests : fichiers de configuration.
| test-core-crypto.cpp | Tests : fonctions cryptographiques.
| test-core-dir.cpp | Tests : répertoires/fichiers.
| test-core-eval.cpp | Tests : évaluation d'expressions.
| test-core-hashtable.cpp | Tests : tables de hachage.
| test-core-hdata.cpp | Tests : hdata.
| test-core-hook.cpp | Tests : hooks.
| test-core-infolist.cpp | Tests : infolists.
| test-core-input.cpp | Tests : fonctions d'entrée.
| test-core-list.cpp | Tests : listes.
| test-core-network.cpp | Tests : fonctions réseau.
| test-core-secure.cpp | Tests : données sécurisées.
| test-core-signal.cpp | Tests : signaux.
| test-core-string.cpp | Tests : chaînes.
| test-core-sys.cpp | Tests : fonctions système.
| test-core-url.cpp | Tests : URLs.
| test-core-utf8.cpp | Tests : UTF-8.
| test-core-util.cpp | Tests : fonctions utiles.
| hook/ | Racine des tests pour les hooks.
| test-hook-command.cpp | Tests : hooks "command".
| test-hook-command-run.cpp | Tests : hooks "command_run".
| test-hook-completion.cpp | Tests : hooks "completion".
| test-hook-config.cpp | Tests : hooks "config".
| test-hook-connect.cpp | Tests : hooks "connect".
| test-hook-fd.cpp | Tests : hooks "fd".
| test-hook-focus.cpp | Tests : hooks "focus".
| test-hook-hdata.cpp | Tests : hooks "hdata".
| test-hook-hsignal.cpp | Tests : hooks "hsignal".
| test-hook-info-hashtable.cpp | Tests : hooks "info_hashtable".
| test-hook-info.cpp | Tests : hooks "info".
| test-hook-infolist.cpp | Tests : hooks "infolist".
| test-hook-line.cpp | Tests : hooks "line".
| test-hook-modifier.cpp | Tests : hooks "modifier".
| test-hook-print.cpp | Tests : hooks "print".
| test-hook-process.cpp | Tests : hooks "process".
| test-hook-signal.cpp | Tests : hooks "signal".
| test-hook-timer.cpp | Tests : hooks "timer".
| test-hook-url.cpp | Tests : hooks "url".
| gui/ | Racine des tests unitaires pour les interfaces.
| test-gui-bar-item-custom.cpp | Tests : fonctions d'objets de barre personnalisés.
| test-gui-bar-item.cpp | Tests : fonctions d'objets de barre.
| test-gui-bar-window.cpp | Tests : fonctions de fenêtres de barre.
| test-gui-bar.cpp | Tests : fonctions de barres.
| test-gui-buffer.cpp | Tests : fonctions de tampons.
| test-gui-chat.cpp | Tests : fonctions de discussion.
| test-gui-color.cpp | Tests : couleurs.
| test-gui-filter.cpp | Tests : filtres.
| test-gui-hotlist.cpp | Tests : fonctions hotlist.
| test-gui-input.cpp | Tests : fonctions d'entrée.
| test-gui-key.cpp | Tests : touches.
| test-gui-line.cpp | Tests : lignes.
| test-gui-nick.cpp | Tests : pseudos.
| test-gui-nicklist.cpp | Tests : fonctions de liste de pseudos.
| curses/ | Racine des tests unitaires pour l'interface Curses.
| test-gui-curses-mouse.cpp | Tests : souris (interface Curses).
| scripts/ | Racine des tests de l'API script.
| test-scripts.cpp | Programme utilisé pour lancer les tests de l'API script.
| python/ | Scripts Python pour générer et lancer les tests de l'API script.
| testapigen.py | Script Python générant des scripts dans tous les languages pour tester l'API script.
| testapi.py | Script Python avec les tests API, utilisé par le script testapigen.py.
| unparse.py | Conversion de code Python vers d'autres langages, utilisé par le script testapigen.py.
| plugins/ | Racine des tests unitaires pour les extensions.
| test-plugin-api-info.cpp | Tests : fonctions info de l'API extension.
| test-plugin-config.cpp | Tests : fonctions config de l'extension.
| test-plugins.cpp | Tests : extensions.
| alias/ | Racine des tests unitaires pour l'extension alias.
| test-alias.cpp | Tests : alias.
| irc/ | Racine des tests unitaires pour l'extension IRC.
| test-irc-batch.cpp | Tests : évènements batch IRC.
| test-irc-buffer.cpp | Tests : tampons IRC.
| test-irc-channel.cpp | Tests : canaux IRC.
| test-irc-color.cpp | Tests : couleurs IRC.
| test-irc-command.cpp | Tests : commandes IRC.
| test-irc-config.cpp | Tests : configuration IRC.
| test-irc-ctcp.cpp | Tests : CTCP IRC.
| test-irc-ignore.cpp | Tests : ignores IRC.
| test-irc-info.cpp | Tests : infos IRC.
| test-irc-join.cpp | Tests : fonctions de join IRC.
| test-irc-list.cpp | Tests : tampon IRC pour la réponse à la commande /list.
| test-irc-message.cpp | Tests : messages IRC.
| test-irc-mode.cpp | Tests : modes IRC.
| test-irc-nick.cpp | Tests : pseudos IRC.
| test-irc-protocol.cpp | Tests : protocole IRC.
| test-irc-sasl.cpp | Tests : authentification SASL avec le protocole IRC.
| test-irc-server.cpp | Tests : serveur IRC.
| test-irc-tag.cpp | Tests : étiquettes des messages IRC.
| logger/ | Racine des tests unitaires pour l'extension logger.
| test-logger.cpp | Tests : logger.
| test-logger-backlog.cpp | Tests : backlog logger.
| test-logger-tail.cpp | Tests : fonctions "tail".
| relay/ | Racine des tests unitaires pour l'extension Relay.
| test-relay-auth.cpp | Tests : authentification des clients.
| test-relay-bar-item.cpp | Tests : objets de barre pour l'extension Relay.
| test-relay-http.cpp | Tests : fonctions HTTP pour l'extension Relay.
| test-relay-raw.cpp | Tests : fonctions sur les messages bruts pour l'extension Relay.
| test-relay-remote.cpp | Tests : fonctions remote pour l'extension Relay.
| test-relay-websocket.cpp | Tests : fonctions websocket pour l'extension Relay.
| api/ | Racine des tests unitaires pour le protocole relay "api".
| test-relay-api.cpp | Tests : protocole relay "api" : fonctions générales.
| test-relay-api-msg.cpp | Tests : protocole relay "api" : messages.
| test-relay-api-protocol.cpp | Tests : protocole relay "api" : protocole.
| remote/ | Tests : protocole relay "api" : fonctions "remote" : évènement.
| test-relay-remote-event.cpp | Tests : protocole relay "api" : fonctions "remote" : réseau.
| test-relay-remote-network.cpp | Tests: Relay "api" protocol: remote network.
| irc/ | Racine des tests unitaires pour le protocole relay "irc".
| test-relay-irc.cpp | Tests : protocole relay "irc".
| trigger/ | Racine des tests unitaires pour l'extension trigger.
| test-trigger.cpp | Tests : triggers.
| test-trigger-config.cpp | Tests : configuration trigger.
| typing/ | Racine des tests unitaires pour l'extension typing.
| test-typing.cpp | Tests : typing.
| test-typing-status.cpp | Tests : statut d'écriture.
| xfer/ | Racine des tests unitaires pour l'extension Xfer.
| test-xfer-file.cpp | Tests : fonctions sur les fichiers.
| test-xfer-network.cpp | Tests : fonctions réseau.
|===
[[documentation_translations]]
=== Documentation / traductions
Fichiers de documentation :
[width="100%",cols="2m,3",options="header"]
|===
| Chemin/fichier | Description
| doc/ | Documentation.
| docinfo.html | Style Asciidoctor.
| XX/ | Documentation pour la langue XX (langues : en, fr, de, it, ...).
| weechat.1.XX.adoc | Page de manuel (`man weechat`).
| weechat_dev.XX.adoc | link:weechat_dev.fr.html[Guide du développeur ^↗^^] (ce document).
| weechat_faq.XX.adoc | link:weechat_faq.fr.html[FAQ ^↗^^] (questions fréquemment posées).
| weechat_plugin_api.XX.adoc | link:weechat_plugin_api.fr.html[Référence API extension ^↗^^].
| weechat_quickstart.XX.adoc | link:weechat_quickstart.fr.html[Guide de démarrage ^↗^^].
| weechat_relay_api.XX.adoc | link:weechat_relay_api.fr.html[Protocole relay "api" ^↗^^] (pour les interfaces distantes).
| weechat_relay_weechat.XX.adoc | link:weechat_relay_weechat.fr.html[Protocole relay "weechat" ^↗^^] (pour les interfaces distantes).
| weechat_scripting.XX.adoc | link:weechat_scripting.fr.html[Guide pour scripts ^↗^^].
| weechat_user.XX.adoc | link:weechat_user.fr.html[Guide utilisateur ^↗^^].
| includes/ | Fichiers inclus dans la documentation.
| cmdline_options.XX.adoc | Options de ligne de commande (fichier inclus dans les pages de manuel et le guide utilisateur).
| man.XX.adoc | Parties des pages de manuel : options d'extension, fichiers et copyright.
|===
Les traductions pour WeeChat et les extensions sont effectuées avec gettext, les
fichiers sont dans le répertoire _po/_ :
[width="100%",cols="2m,3",options="header"]
|===
| Chemin/fichier | Description
| po/ | Fichiers de traduction (gettext).
| XX.po | Traductions pour la langue XX (fr, de, it, ...), la langue par défaut est l'anglais.
| weechat.pot | Modèle pour les traductions (automatiquement généré).
|===
[[coding_rules]]
== Règles de développement
[[coding_general_rules]]
=== Règles générales
* Dans le code source, vos commentaires, noms de variables, ... doivent être
écrits en anglais *uniquement* (aucune autre langue n'est autorisée).
* Utilisez un en-tête de copyright dans chaque nouveau fichier source avec :
** la date
** le nom
** l'e-mail
** la licence
** une brève description du fichier (une seule ligne).
Le copyright et la licence doivent être définis en utilisant SPDX (System Package Data Exchange),
en suivant les recommandations de REUSE Software
(voir la https://reuse.software/spec/[spécification REUSE ^↗^^]).
Tous les fichiers du dépôt doivent avoir un copyright et une licence valide. +
Lorsque l'information ne peut pas être mise dans le fichier lui-même, vous pouvez
utiliser le fichier REUSE.toml à la racine du projet.
Exemple en C :
// REUSE-IgnoreStart
[source,c]
----
/*
* SPDX-FileCopyrightText: 2025 Your Name <your@email.com>
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
* 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/>.
*/
/* Core functions for WeeChat */
----
// REUSE-IgnoreEnd
[[coding_c_style]]
=== Style C
Quelques règles basiques que vous *devez* suivre quand vous écrivez du code C :
* Utilisez 4 espaces pour l'indentation (pas de tabulations).
* Essayez de ne pas dépasser 80 caractères par ligne, sauf si cela est
nécessaire pour améliorer la lisibilité.
* Utilisez les commentaires `+/* comment */+` (pas de style C99 comme
`+// comment+`).
* Ajoutez un commentaire avant chaque fonction, pour expliquer ce qu'elle fait
(utilisez toujours un commentaire multi-lignes, même si la description est
très courte).
Exemple :
[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);
}
----
* Utilisez des noms de variable explicites, par exemple "nicks_count" au lieu de
"n" ou "nc". Exception : dans les boucles `for`, où les variables comme "i" ou
"n" sont OK.
* Initialisez les variables locales après la déclaration, dans le corps de la
fonction, exemple :
[source,c]
----
void
foo ()
{
int nick_count, buffer_count;
nick_count = 0;
buffer_count = 1;
/* ... */
}
----
* Utilisez des parenthèses pour montrer explicitement comment l'expression est
évaluée, même si cela n'est pas obligatoire, par exemple écrivez `+x + (y * z)+`
au lieu de `+x + y * z+`.
* Disposez les accolades `+{ }+` seules sur la ligne, et indentez les avec le
nombre d'espaces utilisés sur la ligne au dessus de l'accolade ouvrante (le
`if` dans l'exemple) :
[source,c]
----
if (nicks_count == 1)
{
/* something */
}
----
* Utilisez des lignes vides pour séparer différents blocs dans les fonctions, et
si possible ajoutez un commentaire pour chacun, comme ceci :
[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);
}
/* ... */
}
----
* Indentez les conditions `if`, et utilisez des parenthèses autour des
conditions avec un opérateur (pas nécessaire pour un booléen simple), comme
ceci :
[source,c]
----
if (something)
{
/* something */
}
else
{
/* something else */
}
if (my_boolean1 && my_boolean2 && (i == 10)
&& ((buffer1 != buffer2) || (window1 != window2)))
{
/* something */
}
else
{
/* something else */
}
----
* Indentez les `switch` comme ceci :
[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;
}
----
* Utilisez `typedef` pur les prototypes de fonctions mais pas pour les
structures :
[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));
----
* Ce code Lisp peut être utilisé dans votre _~/.emacs.el_ pour indenter
correctement si vous utilisez l'éditeur de texte Emacs :
[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]]
=== Style Python
Voir https://www.python.org/dev/peps/pep-0008/[PEP 8 ^↗^^].
[[core_internals]]
== Intérieur du cœur
[[naming_convention]]
=== Conventions pour les noms
[[naming_convention_files]]
==== Fichiers
Les noms de fichiers sont composés de lettres et tirets, avec le format :
_xxx-yyyyy.[ch]_, où _xxx_ est le répertoire/composant (peut être une
abréviation) et _yyyyy_ un nom pour le fichier.
Le fichier principal d'un répertoire peut avoir le même nom que le répertoire,
par exemple _irc.c_ pour l'extension irc.
Exemples :
[width="100%",cols="2m,3",options="header"]
|===
| Répertoire | Fichiers
| src/core/ | weechat.c, core-backtrace.c, core-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, ...
|===
Les en-têtes des fichiers C doivent avoir le même nom que le fichier, par
exemple _core-command.h_ pour le fichier _core-command.c_.
[[naming_convention_structures]]
==== Structures
Les structures ont le nom _t_X_Y_ ou _t_X_Y_Z_ :
* _X_ : répertoire/composant (peut être une abréviation)
* _Y_ : fin du nom de fichier
* _Z_ : nom de la structure (facultatif)
Exemple : un pseudo IRC (de _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]]
==== Variables
Les variables globales (en dehors des fonctions) ont le nom _X_Y_Z_ :
* _X_ : répertoire/composant (peut être une abréviation)
* _Y_ : fin du nom de fichier
* _Z_ : nom de la variable
Exception : pour les variables des derniers éléments d'une liste, le nom est
_last_X_ (où _X_ est le nom de la variable, en utilisant le singulier).
Exemple : fenêtres (de _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 */
----
Il n'y a pas de convention pour les variables locales (dans les fonctions).
La seule recommandation est que le nom soit explicite (et pas trop court). +
Cependant, les pointeurs vers les structures sont souvent nommés _ptr_xxxx_, par
exemple un pointeur sur _struct t_gui_buffer *_ sera : _*ptr_buffer_.
[[naming_convention_functions]]
==== Fonctions
La convention pour les noms des fonctions est le même que celui des
<<naming_convention_variables,variables>>.
Exemple : création d'une nouvelle fenêtre (de _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]]
=== Thread unique
WeeChat a un seul thread. Cela signifie que chaque partie du code doit
s'exécuter très rapidement, et que les appels aux fonctions comme `sleep` sont
*strictement interdits* (cela est vrai pour le cœur de WeeChat mais aussi les
extensions et les scripts).
Si pour une raison quelconque vous devez attendre un peu, utilisez `hook_timer`
avec une fonction de rappel.
[[doubly_linked_lists]]
=== Listes doublement chaînées
La plupart des listes WeeChat sont doublement chaînées : chaque nœud a un
pointeur vers le nœud précédent/suivant.
Exemple : liste des tampons (de _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 */
};
----
Et les deux pointeurs vers la tête et la fin de liste :
[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]]
=== Codes couleur dans les chaînes
WeeChat utilise ses propres codes couleur dans les chaînes pour afficher les
attributs (gras, souligné, ...) et les couleurs à l'écran.
Tous les attributs/couleurs sont préfixés par un caractère dans la chaîne, qui
peuvent être :
* _0x19_ : code couleur (suivi par un/des code(s) couleur)
* _0x1A_ : activer un attribut (suivi par un attribut brut sur un caractère)
* _0x1B_ : supprimer un attribut (suivi par un attribut brut sur un caractère)
* _0x1C_ : réinitialiser (rien après)
Les couleurs possibles sont :
* couleur standard : attributs facultatifs + nombre sur 2 digits
* couleur étendue : `+@+` + attributs facultatifs + nombre sur 5 digits
Dans le tableau qui suit, les conventions suivantes sont utilisées :
* `STD` : couleur standard (2 digits)
* `(ATTR)STD` : couleur standard avec des attributs facultatifs
(attributs + 2 digits)
* `EXT` : couleur étendue (`+@+` + 5 digits)
* `(ATTR)EXT` : couleur étendue avec des attributs facultatifs
(`+@+` + attributs + 5 digits)
* `(ATTR)` : un ou plusieurs caractères d'attribut :
** `+%+` : clignotement
** `+.+` : "dim" (demi-intensité)
** `+*+` : gras
** `+!+` : vidéo inverse
** `+/+` : italique
** `+_+` : souligné
** `+|+` : garder les attributs
* `(a)` : un caractère d'attribut brut :
** _0x01_ : gras
** _0x02_ : vidéo inverse
** _0x03_ : italique
** _0x04_ : souligné
** _0x05_ : clignotement
** _0x06_ : "dim" (demi-intensité)
Toutes les combinaisons sont résumées dans ce tableau :
[width="100%",cols="4,3,2,8",options="header"]
|===
| Code | Exemple | Aires | Description
| [hex]#19# + `STD` | [hex]#19# `+01+` | chat + barres | Définir les attributs et la couleur en utilisant une option, voir le tableau ci-dessous.
| [hex]#19# + `EXT` | [hex]#19# `+@00001+` | chat | Définir une couleur avec la paire ncurses (utilisé seulement sur le tampon `/color`).
| [hex]#19# + `F` + `(ATTR)STD` | [hex]#19# `+F*05+` | chat + barres | Définir la couleur de texte (couleur WeeChat).
| [hex]#19# + `F` + `(ATTR)EXT` | [hex]#19# `+F@00214+` | chat + barres | Définir la couleur de texte (couleur étendue).
| [hex]#19# + `B` + `STD` | [hex]#19# `+B05+` | chat + barres | Définir la couleur de fond (couleur WeeChat).
| [hex]#19# + `B` + `EXT` | [hex]#19# `+B@00124+` | chat + barres | Définir le couleur de fond (couleur étendue).
| [hex]#19# + `*` + `(ATTR)STD` | [hex]#19# `+*05+` | chat + barres | Définir la couleur de texte (couleur WeeChat).
| [hex]#19# + `*` + `(ATTR)EXT` | [hex]#19# `+*@00214+` | chat + barres | Définir la couleur de texte (couleur étendue).
| [hex]#19# + `*` + `(ATTR)STD` + `,` + `STD` ^(1)^ | [hex]#19# `+*08,05+` | chat + barres | Définir la couleur de texte/fond (couleurs WeeChat).
| [hex]#19# + `*` + `(ATTR)STD` + `,` + `EXT` ^(1)^ | [hex]#19# `+*01,@00214+` | chat + barres | Définir la couleur de texte (couleur WeeChat) et de fond (couleur étendue).
| [hex]#19# + `*` + `(ATTR)EXT` + `,` + `STD` ^(1)^ | [hex]#19# `+*@00214,05+` | chat + barres | Définir la couleur de texte (couleur étendue) et de fond (couleur WeeChat).
| [hex]#19# + `*` + `(ATTR)EXT` + `,` + `EXT` ^(1)^ | [hex]#19# `+*@00214,@00017+` | chat + barres | Définir la couleur de texte/fond (couleurs étendues).
| [hex]#19# + `*` + `(ATTR)STD` + `~` + `STD` | [hex]#19# `+*08~05+` | chat + barres | Définir la couleur de texte/fond (couleurs WeeChat).
| [hex]#19# + `*` + `(ATTR)STD` + `~` + `EXT` | [hex]#19# `+*01~@00214+` | chat + barres | Définir la couleur de texte (couleur WeeChat) et de fond (couleur étendue).
| [hex]#19# + `*` + `(ATTR)EXT` + `~` + `STD` | [hex]#19# `+*@00214~05+` | chat + barres | Définir la couleur de texte (couleur étendue) et de fond (couleur WeeChat).
| [hex]#19# + `*` + `(ATTR)EXT` + `~` + `EXT` | [hex]#19# `+*@00214~@00017+` | chat + barres | Définir la couleur de texte/fond (couleurs étendues).
| [hex]#19# + `b` + `F` | [hex]#19# `+bF+` | barres | Définir la couleur de texte de la barre.
| [hex]#19# + `b` + `D` | [hex]#19# `+bD+` | barres | Définir la couleur du délimiteur de la barre.
| [hex]#19# + `b` + `B` | [hex]#19# `+bB+` | barres | Définir la couleur de fond de la barre.
| [hex]#19# + `b` + `_` | [hex]#19# `+b_+` | barre input | Caractère de démarrage dans l'entrée (utilisé seulement dans l'objet "input_text").
| [hex]#19# + `b` + `-` | [hex]#19# `+b-+` | barre input | Caractère de démarrage caché dans l'entrée (utilisé seulement dans l'objet "input_text").
| [hex]#19# + `b` + `#` | [hex]#19# `+b#+` | barre input | Caractère de déplacement du curseur (utilisé seulement dans l'objet "input_text").
| [hex]#19# + `b` + `i` | [hex]#19# `+bi+` | barres | Début d'objet.
| [hex]#19# + `b` + `l` (lower L) | [hex]#19# `+bl+` | barres | Ligne de démarrage d'objet.
| [hex]#19# + `E` | [hex]#19# `+E+` | chat + barres | Texte mis en valeur _(WeeChat ≥ 0.4.2)_.
| [hex]#19# + [hex]#1C# | [hex]#19# [hex]#1C# | chat + barres | Réinitialiser la couleur (garder les attributs).
| [hex]#1A# + `(a)` | [hex]#1A# [hex]#01# | chat + barres | Activer un attribut.
| [hex]#1B# + `(a)` | [hex]#1B# [hex]#01# | chat + barres | Supprimer un attribut.
| [hex]#1C# | [hex]#1C# | chat + barres | Réinitialiser les attributs et la couleur.
|===
[NOTE]
^(1)^ L'utilisation de virgule comme séparateur était utilisé jusqu'à
WeeChat 2.5. +
Avec WeeChat WeeChat ≥ 2.6, un tilde est utilisé pour séparer la
couleur du texte et du fond. Si vous développez un client WeeChat relay et
voulez être compatible avec toutes les versions de WeeChat, vous devriez
supporter les deux séparateurs (par exemple si un utilisateur avec WeeChat ≤ 2.5
lance `/upgrade` vers une version ≥ 2.6, les deux séparateurs pourront être
utilisés au même moment dans les tampons).
Les codes couleur utilisant des options (voir _t_gui_color_enum_, dans le
fichier _src/gui/gui-color.h_) :
[width="80%",cols="^1m,10",options="header"]
|===
| Code | Option
| 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 | _(n'est plus utilisé depuis WeeChat 0.3.4)_
| 18 | _(n'est plus utilisé depuis WeeChat 0.3.4)_
| 19 | _(n'est plus utilisé depuis WeeChat 0.3.4)_
| 20 | _(n'est plus utilisé depuis WeeChat 0.3.4)_
| 21 | _(n'est plus utilisé depuis WeeChat 0.3.4)_
| 22 | _(n'est plus utilisé depuis WeeChat 0.3.4)_
| 23 | _(n'est plus utilisé depuis WeeChat 0.3.4)_
| 24 | _(n'est plus utilisé depuis WeeChat 0.3.4)_
| 25 | _(n'est plus utilisé depuis WeeChat 0.3.4)_
| 26 | _(n'est plus utilisé depuis 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)_
| 45 | weechat.color.chat_status_disabled _(WeeChat ≥ 4.0.0)_
| 46 | weechat.color.chat_status_enabled _(WeeChat ≥ 4.0.0)_
|===
Les couleurs WeeChat sont :
[width="80%",cols="^1m,10",options="header"]
|===
| Code | Couleur
| 00 | Défaut (couleur de texte/fond du terminal)
| 01 | Noir
| 02 | Gris foncé
| 03 | Rouge foncé
| 04 | Rouge clair
| 05 | Vert foncé
| 06 | Vert clair
| 07 | Marron
| 08 | Jaune
| 09 | Bleu foncé
| 10 | Bleu clair
| 11 | Magenta foncé
| 12 | Magenta clair
| 13 | Cyan foncé
| 14 | Cyan clair
| 15 | Gris
| 16 | Blanc
|===
Exemples de codes couleur :
[width="100%",cols="1,2",options="header"]
|===
| Code | Description
| [hex]#19# `+01+` | Couleur de l'option "01" (texte de discussion).
| [hex]#19# `+*08,03+` | Jaune sur rouge.
| [hex]#19# `+*@00214+` | Orange (couleur étendue 214).
| [hex]#19# `+*@*_00214,@00017+` | Orange (214) gras souligné sur bleu foncé (17).
| [hex]#1A# `+_+` | Activer le souligné.
| [hex]#1B# `+_+` | Supprimer le souligné.
| [hex]#1C# | Réinitialiser les attributs et la couleur.
|===
[[plugin_internals]]
== Intérieur des extensions
Le fichier _src/plugins/weechat-plugin.h_ définit et exporte toutes les
fonctions disponibles dans l'API.
Une structure appelée _t_weechat_plugin_ est utilisée pour stocker les
informations sur l'extension (nom de fichier, nom, auteur, description, ...) et
toutes les fonctions de l'API, sous forme de pointeurs vers les fonctions
WeeChat.
Et puis des macros sont utilisées pour appeler ces fonctions.
Par exemple, la fonction _hook_timer_ est définie dans la structure
_t_weechat_plugin_ comme ceci :
[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);
----
Et la macro utilisée pour appeler cette fonction est :
[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)
----
Donc dans une extension, l'appel à cette fonction sera par exemple :
[source,c]
----
server->hook_timer_sasl = weechat_hook_timer (timeout * 1000,
0, 1,
&irc_server_timer_sasl_cb,
server);
----
[[contribute]]
== Contribuer à WeeChat
[[git_repository]]
=== Dépôt Git
Le dépôt Git est sur https://github.com/weechat/weechat[GitHub ^↗^^].
Tout patch pour un bug ou une nouvelle fonctionnalité doit être effectué sur la
branche `main`, le format préféré étant une "pull request" sur GitHub. Un patch
peut aussi être envoyé par e-mail (fait avec `git diff` ou `git format-patch`).
Le format du message de commit est le suivant (avec fermeture automatique
du bug GitHub) :
----
composant: fix a problem (closes #123)
----
Où _composant_ est :
[width="100%",cols="1m,4m,5",options="header"]
|===
| Composant | Fichiers | Description
| core
| AUTHORS.md +
CHANGELOG.md +
CONTRIBUTING.md +
.github/FUNDING.yml +
.github/ISSUE_TEMPLATE/* +
icons/* +
po/* +
README.md +
UPGRADING.md +
src/core/* +
src/gui/* +
version.sh +
weechat.desktop
| cœur de WeeChat
| build
| CMakeLists.txt +
cmake/* +
tools/* +
weechat.cygport.in
| Construction
| ci
| .github/workflows/*
| Intégration continue
| debian
| debian-devel/* +
debian-stable/*
| Empaquetage Debian
| tests/fuzz
| tests/fuzz/*
| Fuzzing (tests à données aléatoires)
| tests/unit
| tests/unit/*
| Tests unitaires
| doc
| doc/*
| Mises à jour générales sur la documentation, par exemple la construction
| doc/man
| doc/xx/weechat.1.xx.adoc +
doc/xx/weechat-headless.1.xx.adoc
| Pages de manuel
| doc/faq
| doc/xx/weechat_faq.xx.adoc
| Questions fréquemment posées (FAQ)
| doc/quickstart
| doc/xx/weechat_quickstart.xx.adoc
| Guide de démarrage rapide
| doc/user
| doc/xx/weechat_user.xx.adoc
| Guide utilisateur
| doc/scripting
| doc/xx/weechat_scripting.xx.adoc
| Guide pour scripts
| doc/api
| doc/xx/weechat_plugin_api.xx.adoc
| Référence extension API
| doc/relay
| doc/xx/weechat_relay_api.xx.adoc +
doc/xx/weechat_relay_weechat.xx.adoc
| Protocoles relay
| doc/dev
| doc/xx/weechat_dev.en.adoc
| Guide du développeur
| irc +
python +
relay +
…
| src/plugins/<name>/*
| Extension
|===
Quelques règles à suivre :
* Utilisez seulement l'anglais.
* Utilisez des verbes à l'infinitif.
* Si le commit est relatif à un bug GitHub, écrivez-le entre parenthèses après
le message, avec ce format : `(issue #123)` ou `(closes #123)` pour le fermer.
Exemples de messages de commit :
----
core: add callback "nickcmp" for nick comparison in buffers
core: update Japanese translations
irc: add command /unquiet (closes #36)
python: fix crash when unloading a script without pointer to interpreter
ruby: add detection of ruby version 1.9.3 in CMake
----
[[translations]]
=== Traductions
[[gettext]]
==== Gettext
Les fichiers gettext sont dans le répertoire _po/_.
Si vous souhaitez initialiser une nouvelle langue, utilisez la commande
`msginit`. Par exemple pour créer un fichier qui est prêt à traduire en
néerlandais :
[source,shell]
----
cd po
msginit -i weechat.pot -l nl_NL -o nl.po
----
La langue de base pour WeeChat est l'anglais, donc vous devez évidemment
comprendre parfaitement l'anglais pour traduire vers votre langue.
Après des changements dans les sources, vous pouvez regénérer toutes les
traductions : lancez cette commande dans le répertoire "build" de CMake :
[source,shell]
----
make translations && make update-po
----
Vous pouvez alors éditer les fichiers .po (si vous pouvez traduire dans une
langue).
Une fois terminé, vous *devez* vérifier votre fichier avec
https://github.com/flashcode/msgcheck[msgcheck ^↗^^] :
[source,shell]
----
msgcheck.py xx.po
----
Et vous pouvez alors recompiler WeeChat pour utiliser les nouvelles traductions.
[[asciidoc]]
==== Asciidoc
Les fichiers Asciidoc donc dans le répertoire _doc/XX/_ où _XX_ est la langue
(en, fr, de, it, ...).
Faites d'abord une copie du fichier asciidoc en anglais (dans le répertoire
_doc/en/_), puis travaillez dessus.
Les traductions manquantes dans les fichiers sont indiquées par cette chaîne :
----
// TRANSLATION MISSING
----
Vous devez traduire tout le fichier sauf les liens et les mots-clés spéciaux
pour les notes, avertissements, ... Ces mots doivent être gardés tels quels :
----
[[link_name]]
<<link_name>>
[NOTE]
[TIP]
[IMPORTANT]
[WARNING]
[CAUTION]
----
Lorsqu'il y a un nom après `+<<link_name>>+`, alors vous devez le traduire :
----
<<link_name,ce texte doit être traduit>>
----
|
