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
|
<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>X-Chat 2 Perl Interface</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:khisanth@miyu.hopto.org" />
<style type="text/css">
.branch {
list-style: none;
}
li code {
padding-right: 0.5em;
}
.example {
width: 98%;
padding: 0.5em;
float: left;
font-family: monospace;
}
.example .line_number {
float: left;
text-align: right;
margin-right: 10px;
padding-right: 5px;
border-right: 1px solid white;
}
.example .content {
float: left;
}
.example .content pre {
margin: 0;
}
td > table {
margin: 0.5em;
border-collapse: collapse;
}
td > table td {
border: 1px solid black;
}
.synComment {
color: rgb(135,206,235);
}
.synPreProc {
color: rgb(205,92,92);
}
.synError {
}
.synConstant {
color: #ffa0a0;
}
.synSpecial {
color: rgb(255,222,173);
}
.synIgnore {
color: rgb(102,102,102);
}
.synNormal {
color: rgb(255,255,255);
background-color: rgb(51,51,51);
}
.synType {
color: rgb(189,183,107);
}
.synIdentifier {
color: rgb(152,251,152);
}
.synTodo {
color: rgb(255,69,0);
background-color: rgb(238,238,0);
}
.synStatement {
color: rgb(240,230,140);
}
</style>
</head>
<body style="background-color: white">
<table border="0" width="100%" cellspacing="0" cellpadding="3">
<tr><td class="block" style="background-color: #cccccc" valign="middle">
<big><strong><span class="block"> X-Chat 2 Perl Interface</span></strong></big>
</td></tr>
</table>
<!-- INDEX BEGIN -->
<div>
<p><a name="__index__"></a></p>
<ul>
<li><a href="#x_chat_2_perl_interface">X-Chat 2 Perl Interface</a></li>
<li class="branch">
<ul>
<li><a href="#introduction">Introduction</a></li>
<li><a href="#constants">Constants</a></li>
<li class="branch">
<ul>
<li><a href="#priorities">Priorities</a></li>
<li><a href="#return_values">Return values</a></li>
<li class="branch">
<ul>
<li><a href="#timer_and_fd_hooks">Timer and fd hooks</a></li>
</ul>
</li>
<li><a href="#hook_fd_flags">hook_fd flags</a></li>
</ul>
</li>
<li><a href="#functions">Functions</a></li>
<li class="branch">
<ul>
<li><a href="#xchat_register"><code>Xchat::register( $name, $version, [$description,[$callback]] )</code></a></li>
<li><a href="#xchat_hook_server"><code>Xchat::hook_server( $message, $callback, [\%options] )</code></a></li>
<li><a href="#xchat_hook_command"><code>Xchat::hook_command( $command, $callback, [\%options] )</code></a></li>
<li><a href="#xchat_hook_print"><code>Xchat::hook_print( $event,$callback, [\%options] )</code></a></li>
<li><a href="#xchat_hook_timer"><code>Xchat::hook_timer( $timeout,$callback, [\%options | $data] )</code></a></li>
<li><a href="#xchat_hook_fd"><code>Xchat::hook_fd( $handle, $callback, [ \%options ] )</code></a></li>
<li class="branch">
<ul>
<li><a href="#when_callbacks_are_invoked">When callbacks are invoked</a></li>
<li><a href="#callback_arguments">Callback Arguments</a></li>
<li><a href="#callback_return_values">Callback return values</a></li>
<li><a href="#miscellaneous_hook_related_information">Miscellaneous Hook Related Information</a></li>
</ul>
</li>
<li><a href="#xchat_unhook"><code>Xchat::unhook( $hook )</code></a></li>
<li><a href="#xchat_print"><code>Xchat::print( $text | \@lines, [$channel,[$server]] )</code></a></li>
<li><a href="#xchat_printf"><code>Xchat::printf( $format, LIST )</code></a></li>
<li><a href="#xchat_command"><code>Xchat::command( $command | \@commands, [$channel,[$server]] )</code></a></li>
<li><a href="#xchat_commandf"><code>Xchat::commandf( $format, LIST )</code></a></li>
<li><a href="#xchat_find_context"><code>Xchat::find_context( [$channel, [$server]] )</code></a></li>
<li><a href="#xchat_get_context"><code>Xchat::get_context()</code></a></li>
<li><a href="#xchat_set_context"><code>Xchat::set_context( $context | $channel,[$server] )</code></a></li>
<li><a href="#xchat_get_info"><code>Xchat::get_info( $id )</code></a></li>
<li><a href="#xchat_get_prefs"><code>Xchat::get_prefs( $name )</code></a></li>
<li><a href="#xchat_emit_print"><code>Xchat::emit_print( $event, LIST )</code></a></li>
<li><a href="#xchat_send_modes"><code>Xchat::send_modes( $target | \@targets, $sign, $mode, [ $modes_per_line ] )</code></a></li>
<li><a href="#xchat_nickcmp"><code>Xchat::nickcmp( $nick1, $nick2 )</code></a></li>
<li><a href="#xchat_get_list"><code>Xchat::get_list( $name )</code></a></li>
<li><a href="#xchat_user_info"><code>Xchat::user_info( [$nick] )</code></a></li>
<li><a href="#xchat_context_info"><code>Xchat::context_info( [$context] )</code></a></li>
<li><a href="#xchat_strip_code"><code>Xchat::strip_code( $string )</code></a></li>
</ul>
</li>
<li><a href="#examples">Examples</a></li>
<li class="branch">
<ul>
<li><a href="#asynchronous_dns_resolution_with_hook_fd">Asynchronous DNS resolution with hook_fd</a></li>
</ul>
</li>
<li><a href="#contact_information">Contact Information</a></li>
</ul>
</li>
</ul>
<hr />
</div>
<!-- INDEX END -->
<p>
</p>
<h1><a name="x_chat_2_perl_interface" />X-Chat 2 Perl Interface</h1>
<p>
</p>
<h2><a name="introduction" />Introduction</h2>
<p>This is the new Perl interface for X-Chat 2. However, due to changes in
xchat's plugin code you will need xchat 2.0.8 or above to load this. Scripts
written using the old interface will continue to work. If there are any
problems, questions, comments or suggestions please email them to the address
on the bottom of this page.</p>
<p>
</p>
<h2><a name="constants" />Constants</h2>
<p>
</p>
<h3><a name="priorities" />Priorities</h3>
<ul>
<li><strong><code>Xchat::PRI_HIGHEST</code></strong>
</li>
<li><strong><code>Xchat::PRI_HIGH</code></strong>
</li>
<li><strong><code>Xchat::PRI_NORM</code></strong>
</li>
<li><strong><code>Xchat::PRI_LOW</code></strong>
</li>
<li><strong><code>Xchat::PRI_LOWEST</code></strong>
</li>
</ul>
<p>
</p>
<h3><a name="return_values" />Return values</h3>
<ul>
<li><strong><code>Xchat::EAT_NONE</code> - pass the event along</strong>
</li>
<li><strong><code>Xchat::EAT_XCHAT</code> - don't let xchat see this event</strong>
</li>
<li><strong><code>Xchat::EAT_PLUGIN</code> - don't let other scripts and plugins see this event but xchat will still see it</strong>
</li>
<li><strong><code>Xchat::EAT_ALL</code> - don't let anything else see this event</strong>
</li>
</ul>
<p>
</p>
<h4><a name="timer_and_fd_hooks" />Timer and fd hooks</h4>
<ul>
<li><strong><code>Xchat::KEEP</code> - keep the timer going or hook watching the handle</strong>
</li>
<li><strong><code>Xchat::REMOVE</code> - remove the timer or hook watching the handle</strong>
</li>
</ul>
<p>
</p>
<h3><a name="hook_fd_flags" />hook_fd flags</h3>
<ul>
<li><strong><code>Xchat::FD_READ</code> - invoke the callback when the handle is ready for reading</strong>
</li>
<li><strong><code>Xchat::FD_WRITE</code> - invoke the callback when the handle is ready for writing</strong>
</li>
<li><strong><code>Xchat::FD_EXCEPTION</code> - invoke the callback if an exception occurs</strong>
</li>
<li><strong><code>Xchat::FD_NOTSOCKET</code> - indicate that the handle being hooked is not a socket</strong>
</li>
</ul>
<p>
</p>
<h2><a name="functions" />Functions</h2>
<p>
</p>
<h3><a name="xchat_register" /><code>Xchat::register( $name, $version, [$description,[$callback]] )</code></h3>
<ul>
<li><strong><code>$name</code> - The name of this script</strong>
</li>
<li><strong><code>$version</code> - This script's version</strong>
</li>
<li><strong><code>$description</code> - A description for this script</strong>
</li>
<li><strong><code>$callback</code> - This is a function that will be called when the is script
unloaded. This can be either a reference to a
function or an anonymous sub reference.</strong>
</li>
</ul>
<p>This is the first thing to call in every script.</p>
<p>
</p>
<h3><a name="xchat_hook_server" /><code>Xchat::hook_server( $message, $callback, [\%options] )</code></h3>
<p>
</p>
<h3><a name="xchat_hook_command" /><code>Xchat::hook_command( $command, $callback, [\%options] )</code></h3>
<p>
</p>
<h3><a name="xchat_hook_print" /><code>Xchat::hook_print( $event,$callback, [\%options] )</code></h3>
<p>
</p>
<h3><a name="xchat_hook_timer" /><code>Xchat::hook_timer( $timeout,$callback, [\%options | $data] )</code></h3>
<p>
</p>
<h3><a name="xchat_hook_fd" /><code>Xchat::hook_fd( $handle, $callback, [ \%options ] )</code></h3>
<p>These functions can be to intercept various events.
hook_server can be used to intercept any incoming message from the IRC server.
hook_command can be used to intercept any command, if the command doesn't currently exist then a new one is created.
hook_print can be used to intercept any of the events listed in Setttings->Advanced->Text Events
hook_timer can be used to create a new timer</p>
<ul>
<li><strong><code>$message</code> - server message to hook such as PRIVMSG</strong>
</li>
<li><strong><code>$command</code> - command to intercept, without the leading /</strong>
</li>
<li><strong><code>$event</code> - one of the events listed in Settings->Advanced->Text Events</strong>
</li>
<li><strong><code>$timeout</code> - timeout in milliseconds</strong>
</li>
<li><strong><code>$handle</code> - the I/O handle you want to monitor with hook_fd. This must be something that has a fileno. See perldoc -f fileno or <a href="http://perldoc.perl.org/functions/fileno.html">fileno</a></strong>
</li>
<li><strong><code>$callback</code> - callback function, this is called whenever
the hooked event is trigged, the following are
the conditions that will trigger the different hooks.
This can be either a reference to a
function or an anonymous sub reference.</strong>
</li>
<li><strong>\%options - a hash reference containing addional options for the hooks</strong>
</li>
</ul>
<p>Valid keys for \%options:</p>
<table border="1"> <tr>
<td>data</td> <td>Additional data that is to be associated with the<br />
hook. For timer hooks this value can be provided either as<br />
<code>Xchat::hook_timer( $timeout, $cb,{data=>$data})</code><br />
or <code>Xchat::hook_timer( $timeout, $cb, $data )</code>.<br />
However, this means that hook_timer cannot be provided<br />
with a hash reference containing data as a key.<br /> example:<br />
my $options = { data => [@arrayOfStuff] };<br />
Xchat::hook_timer( $timeout, $cb, $options );<br />
<br />
In this example, the timer's data will be<br />
[@arrayOfStuff] and not { data => [@arrayOfStuff] }<br />
<br />
This key is valid for all of the hook functions.<br />
<br />
Default is undef.<br />
</td>
</tr> <tr>
<td>priority</td> <td>Sets the priority for the hook.<br />
It can be set to one of the
<code>Xchat::PRI_*</code> constants.<br />
<br />
This key only applies to server, command
and print hooks.<br />
<br />
Default is <code>Xchat::PRI_NORM</code>.
</td> </tr> <tr>
<td>help_text</td> <td>Text displayed for /help $command.<br />
<br />
This key only applies to command hooks.<br />
<br />
Default is "".
</td>
</tr> <tr>
<td>flags</td> <td>Specify the flags for a fd hook.<br />
<br />
See <a href="#hook_fd_flags">hook fd flags</a> section for valid values.<br />
<br />
On Windows if the handle is a pipe you specify<br />
Xchat::FD_NOTSOCKET in addition to any other flags you might be using.<br />
<br />
This key only applies to fd hooks.<br />
Default is Xchat::FD_READ
</td>
</tr></table><p>
</p>
<h4><a name="when_callbacks_are_invoked" />When callbacks are invoked</h4>
<p>Each of the hooks will be triggered at different times depending on the type
of hook.</p>
<table border="1"> <tr style="background-color: #dddddd">
<td>Hook Type</td> <td>When the callback will be invoked</td>
</tr> <tr>
<td>server hooks</td> <td>a <code>$message</code> message is
received from the server
</td>
</tr> <tr>
<td>command hooks</td> <td>the <code>$command</code> command is
executed, either by the user or from a script
</td>
</tr> <tr>
<td>print hooks</td> <td>X-Chat is about to print the message for the
<code>$event</code> event
</td>
</tr> <tr>
<td>timer hooks</td> <td>called every <code>$timeout</code> milliseconds
(1000 millisecond is 1 second)<br />
the callback will be executed in the same context where
the hook_timer was called, if the context no longer exists
then it will execute in a random context
</td>
</tr> <tr>
<td>fd hooks</td> <td>depends on the flags that were passed to hook_fd<br />
See <a href="#hook_fd_flags">hook_fd flags</a> section.
</td>
</tr>
</table><p>The value return from these hook functions can be passed to <code>Xchat::unhook</code>
to remove the hook.</p>
<p>
</p>
<h4><a name="callback_arguments" />Callback Arguments</h4>
<p>All callback functions will receive their arguments in <code>@_</code> like every
other Perl subroutine.</p>
<p>
Server and command callbacks<br />
<br />
<code>$_[0]</code> - array reference containing the IRC message or command and
arguments broken into words<br />
example:<br />
/command arg1 arg2 arg3<br />
<code>$_[0][0]</code> - command<br />
<code>$_[0][1]</code> - arg1<br />
<code>$_[0][2]</code> - arg2<br />
<code>$_[0][3]</code> - arg3<br />
<br />
<code>$_[1]</code> - array reference containing the Nth word to the last word<br />
example:<br />
/command arg1 arg2 arg3<br />
<code>$_[1][0]</code> - command arg1 arg2 arg3<br />
<code>$_[1][1]</code> - arg1 arg2 arg3<br />
<code>$_[1][2]</code> - arg2 arg3<br />
<code>$_[1][3]</code> - arg3<br />
<br />
<code>$_[2]</code> - the data that was passed to the hook function<br />
<br />
Print callbacks<br />
<br />
<code>$_[0]</code> - array reference containing the values for the
text event see Settings->Advanced->Text Events<br />
<code>$_[1]</code> - the data that was passed to the hook function<br />
<br />
Timer callbacks<br />
<br />
<code>$_[0]</code> - the data that was passed to the hook function<br />
<br />fd callbacks<br />
<br />
<code>$_[0]</code> - the handle that was passed to hook_fd<br />
<code>$_[1]</code> - flags indicating why the callback was called<br />
<code>$_[2]</code> - the data that was passed to the hook function<br />
</p><p>
</p>
<h4><a name="callback_return_values" />Callback return values</h4>
<p>All server, command and print callbacks should return one of
the <code>Xchat::EAT_*</code> constants.
Timer callbacks can return Xchat::REMOVE to remove
the timer or Xchat::KEEP to keep it going</p>
<p>
</p>
<h4><a name="miscellaneous_hook_related_information" />Miscellaneous Hook Related Information</h4>
<p>For server hooks, if <code>$message</code> is "RAW LINE" then <code>$cb</code> will be called for
every IRC message than X-Chat receives.</p>
<p>For command hooks if <code>$command</code> is "" then <code>$cb</code> will be called for
messages entered by the user that is not a command.</p>
<p>For print hooks besides those events listed in
Settings->Advanced->Text Events, these additional events can be used.</p>
<table border="1"> <tr style="background-color: #dddddd">
<td>Event</td> <td>Description</td>
</tr> <tr>
<td>"Open Context"</td> <td>a new context is created</td>
</tr> <tr>
<td>"Close Context"</td> <td>a context has been close</td>
</tr> <tr>
<td>"Focus Tab"</td> <td>when a tab is brought to the front</td>
</tr> <tr>
<td>"Focus Window"</td> <td>when a top level window is focused or the
main tab window is focused by the window manager
</td>
</tr> <tr>
<td>"DCC Chat Text"</td> <td>when text from a DCC Chat arrives.
<code>$_[0]</code> will have these values<br />
<br />
<code>$_[0][0]</code> - Address<br />
<code>$_[0][1]</code> - Port<br />
<code>$_[0][2]</code> - Nick<br />
<code>$_[0][3]</code> - Message<br />
</td>
</tr> <tr>
<td>"Key Press"</td> <td>used for intercepting key presses<br />
$_[0][0] - key value<br />
$_[0][1] - state bitfield, 1 - shift, 4 - control, 8 - alt<br />
$_[0][2] - string version of the key which might be empty for unprintable keys<br />
$_[0][3] - length of the string in $_[0][2]<br />
</td>
</tr>
</table><p>
</p>
<h3><a name="xchat_unhook" /><code>Xchat::unhook( $hook )</code></h3>
<ul>
<li><strong><code>$hook</code> - the hook that was previously returned by one of the <code>Xchat::hook_*</code> functions</strong>
</li>
</ul>
<p>This function is used to removed a hook previously added with one of
the <code>Xchat::hook_*</code> functions</p>
<p>It returns the data that was passed to the <code>Xchat::hook_*</code> function when
the hook was added</p>
<p>
</p>
<h3><a name="xchat_print" /><code>Xchat::print( $text | \@lines, [$channel,[$server]] )</code></h3>
<ul>
<li><strong><code>$text</code> - the text to print</strong>
</li>
<li><strong><code>\@lines</code> - array reference containing lines of text to be printed
all the elements will be joined together before printing</strong>
</li>
<li><strong><code>$channel</code> - channel or tab with the given name where <code>$text</code>
will be printed</strong>
</li>
<li><strong><code>$server</code> - specifies that the text will be printed in a channel or tab
that is associated with <code>$server</code></strong>
</li>
</ul>
<p>The first argument can either be a string or an array reference of strings.
Either or both of <code>$channel</code> and <code>$server</code> can be undef.</p>
<p>If called as <code>Xchat::print( $text )</code>, it will always return true.
If called with either the channel or the channel and the server
specified then it will return true if a context is found and
false otherwise. The text will not be printed if the context
is not found. The meaning of setting <code>$channel</code> or <code>$server</code> to
undef is the same as
<a href="#xchat_find_context">find_context</a>.</p>
<p>
</p>
<h3><a name="xchat_printf" /><code>Xchat::printf( $format, LIST )</code></h3>
<ul>
<li><strong><code>$format</code> - a format string, see "perldoc -f <a href="http://perldoc.perl.org/functions/sprintf.html">sprintf</a>" for further detail</strong>
</li>
<li><strong>LIST - list of values for the format fields</strong>
</li>
</ul>
<p>
</p>
<h3><a name="xchat_command" /><code>Xchat::command( $command | \@commands, [$channel,[$server]] )</code></h3>
<ul>
<li><strong><code>$command</code> - the command to execute, without the leading /</strong>
</li>
<li><strong><code>\@commands</code> - array reference containing a list of commands to execute</strong>
</li>
<li><strong><code>$channel</code> - channel or tab with the given name where <code>$command</code> will be executed</strong>
</li>
<li><strong><code>$server</code> - specifies that the command will be executed in a channel or tab that is associated with <code>$server</code></strong>
</li>
</ul>
<p>The first argument can either be a string or an array reference of strings.
Either or both of <code>$channel</code> and <code>$server</code> can be undef.</p>
<p>If called as <code>Xchat::command( $command )</code>, it will always return true.
If called with either the channel or the channel and the server
specified then it will return true if a context is found and false
otherwise. The command will not be executed if the context is not found.
The meaning of setting <code>$channel</code> or <code>$server</code> to undef is the same
as find_context.</p>
<p>
</p>
<h3><a name="xchat_commandf" /><code>Xchat::commandf( $format, LIST )</code></h3>
<ul>
<li><strong><code>$format</code> - a format string, see "perldoc -f <a href="http://perldoc.perl.org/functions/sprintf.html">sprintf</a>" for further detail</strong>
</li>
<li><strong>LIST - list of values for the format fields</strong>
</li>
</ul>
<p>
</p>
<h3><a name="xchat_find_context" /><code>Xchat::find_context( [$channel, [$server]] )</code></h3>
<ul>
<li><strong><code>$channel</code> - name of a channel</strong>
</li>
<li><strong><code>$server</code> - name of a server</strong>
</li>
</ul>
<p>Either or both of <code>$channel</code> and $server can be undef. Calling
<code>Xchat::find_context()</code> is the same as calling
<code>Xchat::find_context( undef, undef)</code> and
<code>Xchat::find_context( $channel )</code> is
the same as <code>Xchat::find_context( $channel, undef )</code>.</p>
<p>If <code>$server</code> is undef, find any channel named $channel.
If <code>$channel</code> is undef, find the front most window
or tab named <code>$server</code>.If both $channel and
<code>$server</code> are undef, find the currently focused tab or window.</p>
<p>Return the context found for one of the above situations or undef if such
a context cannot be found.</p>
<p>
</p>
<h3><a name="xchat_get_context" /><code>Xchat::get_context()</code></h3>
<p>Returns the current context.</p>
<p>
</p>
<h3><a name="xchat_set_context" /><code>Xchat::set_context( $context | $channel,[$server] )</code></h3>
<ul>
<li><strong><code>$context</code> - context value as returned from <a href="#xchat_get_context">get_context</a>,<a href="#xchat_find_context">find_context</a> or one
of the fields in the list of hashrefs returned by list_get</strong>
</li>
<li><strong><code>$channel</code> - name of a channel you want to switch context to</strong>
</li>
<li><strong><code>$server</code> - name of a server you want to switch context to</strong>
</li>
</ul>
<p>See <a href="#xchat_find_context">find_context</a> for more details on <code>$channel</code> and <code>$server</code>.</p>
<p>Returns true on success, false on failure</p>
<p>
</p>
<h3><a name="xchat_get_info" /><code>Xchat::get_info( $id )</code></h3>
<ul>
<li><strong><code>$id</code> - one of the following case sensitive values</strong>
</li>
</ul>
<table border="1"> <tr style="background-color: #dddddd">
<td>ID</td> <td>Return value</td>
</tr> <tr>
<td>away</td> <td>away reason or undef if you are not away</td>
</tr> <tr>
<td>channel</td> <td>current channel name</td>
</tr> <tr>
<td>charset</td> <td>character-set used in the current context</td>
</tr> <tr>
<td>event_text <Event Name></td> <td>text event format string for <Event name><br />
Example:
<div class="example synNormal"><div class='line_number'>
<div>1</div>
</div>
<div class='content'><pre><span class="synStatement">my</span> <span class="synIdentifier">$channel_msg_format</span> = Xchat::get_info( <span class="synStatement">"</span><span class="synConstant">event_text Channel Message</span><span class="synStatement">"</span> );
</pre></div>
</div>
</td>
</tr>
<tr>
<td>host</td> <td>real hostname of the current server</td>
</tr><tr>
<td>id</td> <td>connection id</td>
</tr><tr>
<td>inputbox</td> <td>contents of the inputbox</td>
</tr><tr>
<td>libdirfs</td>
<td>the system wide directory where xchat will look for plugins.
this string is in the same encoding as the local file system</td>
</tr><tr>
<td>modes</td> <td>the current channels modes or undef if not known</td>
</tr><tr>
<td>network</td> <td>current network name or undef</td>
</tr><tr>
<td>nick</td> <td>current nick</td>
</tr><tr>
<td>nickserv</td> <td>nickserv password for this network or undef</td>
</tr><tr>
<td>server</td> <td>current server name <br />
(what the server claims to be) undef if not connected
</td>
</tr><tr>
<td>state_cursor</td>
<td>current inputbox cursor position in characters</td>
</tr><tr>
<td>topic</td> <td>current channel topic</td>
</tr><tr>
<td>version</td> <td>xchat version number</td>
</tr><tr>
<td>win_status</td>
<td>status of the xchat window, possible values are "active", "hidden"
and "normal"</td>
</tr><tr>
<td>win_ptr</td> <td>native window pointer, GtkWindow * on Unix, HWND on Win32.<br />
On Unix if you have the Glib module installed you can use my $window = Glib::Object->new_from_pointer( Xchat::get_info( "win_ptr" ) ); to get a Gtk2::Window object.<br />
Additionally when you have detached tabs, each of the windows will return a different win_ptr for the different Gtk2::Window objects.<br />
See <a href="http://xchat.cvs.sourceforge.net/viewvc/xchat/xchat2/plugins/perl/char_count.pl?view=markup">char_count.pl</a> for a longer example of a script that uses this to show how many characters you currently have in your input box.
</td>
</tr>
<tr>
<td>xchatdir</td> <td>xchat config directory encoded in UTF-8<br />
examples:<br />
/home/user/.xchat2<br />
C:\Documents and Settings\user\Application Data\X-Chat 2
</td>
</tr><tr>
<td>xchatdirfs</td> <td>same as xchatdir except encoded in the locale file system encoding</td>
</tr>
</table><p>This function is used to retrieve certain information about the current
context.</p><p>
</p>
<h3><a name="xchat_get_prefs" /><code>Xchat::get_prefs( $name )</code></h3>
<ul>
<li><strong><code>$name</code> - name of a X-Chat setting (available through the /set command)</strong>
</li>
</ul>
<p>This function provides a way to retrieve X-Chat's setting information.</p>
<p>Returns <code>undef</code> if there is no setting called called <code>$name</code>.</p>
<p>
</p>
<h3><a name="xchat_emit_print" /><code>Xchat::emit_print( $event, LIST )</code></h3>
<ul>
<li><strong><code>$event</code> - name from the Event column in Settings->Advanced->Text Events</strong>
</li>
<li><strong>LIST - this depends on the Description column on the bottom of Settings->Advanced->Text Events</strong>
</li>
</ul>
<p>This functions is used to generate one of the events listed under
Settings->Advanced->Text Events</p>
<p>Note: when using this function you MUST return Xchat::EAT_ALL otherwise you will end up with duplicate events.
One is the original and the second is the one you emit.</p>
<p>Returns true on success, false on failure</p>
<p>
</p>
<h3><a name="xchat_send_modes" /><code>Xchat::send_modes( $target | \@targets, $sign, $mode, [ $modes_per_line ] )</code></h3>
<ul>
<li><strong><code>$target</code> - a single nick to set the mode on</strong>
</li>
<li><strong><code>\@targets</code> - an array reference of the nicks to set the mode on</strong>
</li>
<li><strong><code>$sign</code> - the mode sign, either '+' or '-'</strong>
</li>
<li><strong><code>$mode</code> - the mode character such as 'o' and 'v', this can only be one character long</strong>
</li>
<li><strong><code>$modes_per_line</code> - an optional argument maximum number of modes to send per at once, pass 0 use the current server's maximum (default)</strong>
</li>
</ul>
<p>Send multiple mode changes for the current channel. It may send multiple MODE lines if the request doesn't fit on one.</p>
<p>Example:</p>
<<div class="example synNormal"><div class='line_number'>
<div>1</div>
<div>2</div>
<div>3</div>
<div>4</div>
<div>5</div>
<div>6</div>
<div>7</div>
<div>8</div>
<div>9</div>
<div>10</div>
<div>11</div>
<div>12</div>
<div>13</div>
<div>14</div>
</div>
<div class='content'><pre><span class="synStatement">use strict</span>;
<span class="synStatement">use </span>warning;
<span class="synStatement">use </span>Xchat <span class="synStatement">qw(</span><span class="synConstant">:all</span><span class="synStatement">)</span>;
hook_command( <span class="synStatement">"</span><span class="synConstant">MODES</span><span class="synStatement">"</span>, <span class="synStatement">sub </span>{
<span class="synStatement">my</span> (<span class="synStatement">undef</span>, <span class="synIdentifier">$who</span>, <span class="synIdentifier">$sign</span>, <span class="synIdentifier">$mode</span>) = <span class="synIdentifier">@{$_[</span><span class="synConstant">0</span><span class="synIdentifier">]}</span>;
<span class="synStatement">my</span> <span class="synIdentifier">@targets</span> = <span class="synStatement">split</span> <span class="synStatement">/</span><span class="synConstant">,</span><span class="synStatement">/</span>, <span class="synIdentifier">$who</span>;
<span class="synStatement">if</span>( <span class="synIdentifier">@targets</span> > <span class="synConstant">1</span> ) {
send_modes( \<span class="synIdentifier">@targets</span>, <span class="synIdentifier">$sign</span>, <span class="synIdentifier">$mode</span>, <span class="synConstant">1</span> );
} <span class="synStatement">else</span> {
send_modes( <span class="synIdentifier">$who</span>, <span class="synIdentifier">$sign</span>, <span class="synIdentifier">$mode</span> );
}
<span class="synStatement">return</span> EAT_XCHAT;
});
</pre></div>
</div><p>
</p>
<h3><a name="xchat_nickcmp" /><code>Xchat::nickcmp( $nick1, $nick2 )</code></h3>
<ul>
<li><strong><code>$nick1, $nick2</code> - the two nicks or channel names that are to be compared</strong>
</li>
</ul>
<p>The comparsion is based on the current server. Either a <a href="http://www.ietf.org/rfc/rfc1459.txt" class="rfc">RFC1459</a> compliant
string compare or plain ascii will be using depending on the server. The
comparison is case insensitive.</p>
<p>Returns a number less than, equal to or greater than zero if
<code>$nick1</code> is
found respectively, to be less than, to match, or be greater than
<code>$nick2</code>.</p>
<p>
</p>
<h3><a name="xchat_get_list" /><code>Xchat::get_list( $name )</code></h3>
<ul>
<li><strong><code>$name</code> - name of the list, one of the following:
"channels", "dcc", "ignore", "notify", "users"</strong>
</li>
</ul>
<p>This function will return a list of hash references. The hash references
will have different keys depend on the list. An empty list is returned
if there is no such list.</p>
<p>"channels" - list of channels, querys and their server</p><table border="1"> <tr style="background-color: #dddddd">
<td>Key</td> <td>Description</td>
</tr> <tr>
<td>channel</td> <td>tab name</td>
</tr> <tr>
<td>chantypes</td>
<td>channel types supported by the server, typically "#&"</td>
</tr> <tr>
<td>context</td> <td>can be used with set_context</td>
</tr> <tr>
<td>flags</td> <td>Server Bits:<br />
0 - Connected<br />
1 - Connecting<br />
2 - Away<br />
3 - EndOfMotd(Login complete)<br />
4 - Has WHOX<br />
5 - Has IDMSG (FreeNode)<br />
<br />
<p>The following correspond to the /chanopt command</p>
6 - Hide Join/Part Message (text_hidejoinpart)<br />
7 - unused (was for color paste)<br />
8 - Beep on message (alert_beep)<br />
9 - Blink Tray (alert_tray)<br />
10 - Blink Task Bar (alert_taskbar)<br />
<p>Example of checking if the current context has Hide Join/Part messages set:</p>
<div class="example synNormal"><div class='line_number'>
<div>1</div>
<div>2</div>
<div>3</div>
</div>
<div class='content'><pre><span class="synStatement">if</span>( Xchat::context_info->{flags} & (<span class="synConstant">1</span> << <span class="synConstant">6</span>) ) {
Xchat::<span class="synStatement">print</span>( <span class="synStatement">"</span><span class="synConstant">Hide Join/Part messages is enabled</span><span class="synStatement">"</span> );
}
</pre></div>
</div> </td>
</tr> <tr>
<td>id</td> <td>Unique server ID </td>
</tr>
<tr>
<td>lag</td>
<td>lag in milliseconds</td>
</tr> <tr>
<td>maxmodes</td> <td>Maximum modes per line</td>
</tr> <tr>
<td>network</td> <td>network name to which this channel belongs</td>
</tr> <tr>
<td>nickprefixes</td> <td>Nickname prefixes e.g. "+@"</td>
</tr>
<tr>
<td>nickmodes</td> <td>Nickname mode chars e.g. "vo"</td>
</tr> <tr>
<td>queue</td>
<td>number of bytes in the send queue</td>
</tr>
<tr>
<td>server</td> <td>server name to which this channel belongs</td>
</tr> <tr>
<td>type</td> <td>the type of this context<br />
1 - server<br />
2 - channel<br />
3 - dialog<br />
</td>
</tr> <tr>
<td>users</td> <td>Number of users in this channel</td>
</tr>
</table><p>"dcc" - list of DCC file transfers</p>
<table border="1"> <tr style="background-color: #dddddd">
<td>Key</td> <td>Value</td>
</tr> <tr>
<td>address32</td> <td>address of the remote user(ipv4 address)</td>
</tr> <tr>
<td>cps</td> <td>bytes per second(speed)</td>
</tr> <tr>
<td>destfile</td> <td>destination full pathname</td>
</tr> <tr>
<td>file</td> <td>file name</td>
</tr> <tr>
<td>nick</td>
<td>nick of the person this DCC connection is connected to</td>
</tr> <tr>
<td>port</td> <td>TCP port number</td>
</tr> <tr>
<td>pos</td> <td>bytes sent/received</td>
</tr> <tr>
<td>poshigh</td> <td>bytes sent/received, high order 32 bits</td>
</tr> <tr>
<td>resume</td> <td>point at which this file was resumed<br />
(zero if it was not resumed)
</td>
</tr> <tr>
<td>resumehigh</td> <td>point at which this file was resumed, high order 32 bits<br />
</td>
</tr> <tr>
<td>size</td> <td>file size in bytes low order 32 bits</td>
</tr> <tr>
<td>sizehigh</td> <td>file size in bytes, high order 32 bits (when the files is > 4GB)</td>
</tr>
<tr>
<td>status</td> <td>DCC Status:<br />
0 - queued<br />
1 - active<br />
2 - failed<br />
3 - done<br />
4 - connecting<br />
5 - aborted
</td>
</tr> <tr>
<td>type</td> <td>DCC Type:<br />
0 - send<br />
1 - receive<br />
2 - chatrecv<br />
3 - chatsend
</td>
</tr></table><p>"ignore" - current ignore list</p>
<table border="1"> <tr style="background-color: #dddddd">
<td>Key</td> <td>Value</td>
</tr> <tr>
<td>mask</td> <td>ignore mask. e.g: *!*@*.aol.com</td>
</tr> <tr>
<td>flags</td> <td>Bit field of flags.<br />
0 - private<br />
1 - notice<br />
2 - channel<br />
3 - ctcp<br />
4 - invite<br />
5 - unignore<br />
6 - nosave<br />
7 - dcc<br />
</td>
</tr></table><p>"notify" - list of people on notify</p>
<table border="1">
<tr style="background-color: #dddddd">
<td>Key</td> <td>Value</td>
</tr> <tr>
<td>networks</td>
<td>comma separated list of networks where you will be notfified about this user's online/offline status or undef if you will be notificed on every network you are connected to</td>
</tr> <tr>
<td>nick</td> <td>nickname</td>
</tr> <tr>
<td>flags</td> <td>0 = is online</td>
</tr> <tr>
<td>on</td> <td>time when user came online</td>
</tr> <tr>
<td>off</td> <td>time when user went offline</td>
</tr> <tr>
<td>seen</td> <td>time when user was last verified still online</td>
</tr>
</table><p>the values indexed by on, off and seen can be passed to localtime
and gmtime, see perldoc -f <a href="http://perldoc.perl.org/functions/localtime.html">localtime</a> and perldoc -f <a href="http://perldoc.perl.org/functions/gmtime.html">gmtime</a> for more
detail</p><p>"users" - list of users in the current channel</p>
<table border="1"> <tr style="background-color: #dddddd">
<td>Key</td> <td>Value</td>
</tr> <tr>
<td>away</td> <td>away status(boolean)</td>
</tr> <tr>
<td>lasttalk</td>
<td>last time a user was seen talking, this is the an epoch time(number of seconds since a certain date, that date depends on the OS)</td>
</tr> <tr>
<td>nick</td> <td>nick name</td>
</tr> <tr>
<td>host</td>
<td>host name in the form: user@host or undef if not known</td>
</tr> <tr>
<td>prefix</td> <td>prefix character, .e.g: @ or +</td>
</tr> <tr>
<td>realname</td>
<td>Real name or undef</td>
</tr> <tr>
<td>selected</td>
<td>selected status in the user list, only works when retrieving the user list of the focused tab. You can use the /USELECT command to select the nicks</td>
</tr>
</table><p>"networks" - list of networks and the associated settings from network list</p>
<table border="1"> <tr style="background-color: #dddddd">
<td>Key</td> <td>Value</td>
</tr>
<tr>
<td>autojoins</td> <td>An object with the following methods:<br />
<table>
<tr>
<td>Method</td>
<td>Description</td>
</tr> <tr>
<td>channels()</td>
<td>returns a list of this networks' autojoin channels in list context, a count of the number autojoin channels in scalar context</td>
</tr> <tr>
<td>keys()</td>
<td>returns a list of the keys to go with the channels, the order is the same as the channels, if a channel doesn't have a key, '' will be returned in it's place</td>
</tr> <tr>
<td>pairs()</td>
<td>a combination of channels() and keys(), returns a list of (channels, keys) pairs. This can be assigned to a hash for a mapping from channel to key.</td>
</tr> <tr>
<td>as_hash()</td>
<td>return the pairs as a hash reference</td>
</tr> <tr>
<td>as_string()</td>
<td>the original string that was used to construct this autojoin object, this can be used with the JOIN command to join all the channels in the autojoin list</td>
</tr> <tr>
<td>as_array()</td>
<td>return an array reference of hash references consisting of the keys "channel" and "key"</td>
</tr> <tr>
<td>as_bool()</td>
<td>returns true if the network has autojoins and false otherwise</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>connect_commands</td> <td>An array reference containing the connect commands for a network. An empty array if there aren't any</td>
</tr> <tr>
<td>encoding</td> <td>the encoding for the network</td>
</tr> <tr>
<td>flags</td>
<td>
a hash reference corresponding to the checkboxes in the network edit window
<table>
<tr>
<td>allow_invalid</td>
<td>true if "Accept invalid SSL certificate" is checked</td>
</tr> <tr>
<td>autoconnect</td>
<td>true if "Auto connect to this network at startup" is checked</td>
</tr> <tr>
<td>cycle</td>
<td>true if "Connect to selected server only" is <strong>NOT</strong> checked</td>
</tr> <tr>
<td>use_global</td>
<td>true if "Use global user information" is checked</td>
</tr> <tr>
<td>use_proxy</td>
<td>true if "Bypass proxy server" is <strong>NOT</strong> checked</td>
</tr> <tr>
<td>use_ssl</td>
<td>true if "Use SSL for all the servers on this network" is checked</td>
</tr>
</table>
</td>
</tr> <tr>
<td>irc_nick1</td>
<td>Corresponds with the "Nick name" field in the network edit window</td>
</tr> <tr>
<td>irc_nick2</td>
<td>Corresponds with the "Second choice" field in the network edit window</td>
</tr> <tr>
<td>irc_real_name</td>
<td>Corresponds with the "Real name" field in the network edit window</td>
</tr> <tr>
<td>irc_user_name</td>
<td>Corresponds with the "User name" field in the network edit window</td>
</tr> <tr>
<td>network</td>
<td>Name of the network</td>
</tr> <tr>
<td>nickserv_password</td>
<td>Corresponds with the "Nickserv password" field in the network edit window</td>
</tr> <tr>
<td>selected</td>
<td>Index into the list of servers in the "servers" key, this is used if the "cycle" flag is false</td>
</tr> <tr>
<td>server_password</td>
<td>Corresponds with the "Server password" field in the network edit window</td>
</tr> <tr>
<td>servers</td>
<td>An array reference of hash references with a "host" and "port" key. If a port is not specified then 6667 will be used.</td>
</tr>
</table><p>
</p>
<h3><a name="xchat_user_info" /><code>Xchat::user_info( [$nick] )</code></h3>
<ul>
<li><strong><code>$nick</code> - the nick to look for, if this is not given your own nick will be
used as default</strong>
</li>
</ul>
<p>This function is mainly intended to be used as a shortcut for when you need
to retrieve some information about only one user in a channel. Otherwise it
is better to use <a href="#xchat_get_list">get_list</a>.
If <code>$nick</code> is found a hash reference containing the same keys as those in the
"users" list of <a href="#xchat_get_list">get_list</a> is returned otherwise undef is returned.
Since it relies on <a href="#xchat_get_list">get_list</a> this function can only be used in a
channel context.</p>
<p>
</p>
<h3><a name="xchat_context_info" /><code>Xchat::context_info( [$context] )</code></h3>
<ul>
<li><strong><code>$context</code> - context returned from <a href="#xchat_get_context">get_context</a>, <a href="#xchat_find_context">find_context</a> and <a href="#xchat_get_list">get_list</a>, this is the context that you want infomation about. If this is omitted, it will default to current context.</strong>
</li>
</ul>
<p>This function will return the information normally retrieved with <a href="#xchat_get_info">get_info</a>, except this is for the context that is passed in. The information will be returned in the form of a hash. The keys of the hash are the <code>$id</code> you would normally supply to <a href="#xchat_get_info">get_info</a> as well as all the keys that are valid for the items in the "channels" list from <a href="#xchat_get_list">get_list</a>. Use of this function is more efficient than calling get_list( "channels" ) and searching through the result.</p>
<p>Example:</p>
<div class="example synNormal"><div class='line_number'>
<div>1</div>
<div>2</div>
<div>3</div>
<div>4</div>
<div>5</div>
<div>6</div>
<div>7</div>
<div>8</div>
<div>9</div>
<div>10</div>
<div>11</div>
</div>
<div class='content'><pre><span class="synStatement">use strict</span>;
<span class="synStatement">use warnings</span>;
<span class="synStatement">use </span>Xchat <span class="synStatement">qw(</span><span class="synConstant">:all</span><span class="synStatement">)</span>; <span class="synComment"># imports all the functions documented on this page</span>
register( <span class="synStatement">"</span><span class="synConstant">User Count</span><span class="synStatement">"</span>, <span class="synStatement">"</span><span class="synConstant">0.1</span><span class="synStatement">"</span>,
<span class="synStatement">"</span><span class="synConstant">Print out the number of users on the current channel</span><span class="synStatement">"</span> );
hook_command( <span class="synStatement">"</span><span class="synConstant">UCOUNT</span><span class="synStatement">"</span>, \<span class="synIdentifier">&display_count</span> );
<span class="synStatement">sub </span><span class="synIdentifier">display_count </span>{
prnt <span class="synStatement">"</span><span class="synConstant">There are </span><span class="synStatement">"</span> . context_info()->{users} . <span class="synStatement">"</span><span class="synConstant"> users in this channel.</span><span class="synStatement">"</span>;
<span class="synStatement">return</span> EAT_XCHAT;
}
</pre></div>
</div><p>
</p>
<h3><a name="xchat_strip_code" /><code>Xchat::strip_code( $string )</code></h3>
<ul>
<li><strong><code>$string</code> - string to remove codes from</strong>
</li>
</ul>
<p>This function will remove bold, color, beep, reset, reverse and underline codes from <code>$string</code>. It will also remove ANSI escape codes which might get used by certain terminal based clients. If it is called in void context <code>$string</code> will be modified otherwise a modified copy of <code>$string</code> is returned.</p>
<p>
</p>
<h2><a name="examples" />Examples</h2>
<p>
</p>
<h3><a name="asynchronous_dns_resolution_with_hook_fd" />Asynchronous DNS resolution with hook_fd</h3>
<div class="example synNormal"><div class='line_number'>
<div>1</div>
<div>2</div>
<div>3</div>
<div>4</div>
<div>5</div>
<div>6</div>
<div>7</div>
<div>8</div>
<div>9</div>
<div>10</div>
<div>11</div>
<div>12</div>
<div>13</div>
<div>14</div>
<div>15</div>
<div>16</div>
<div>17</div>
<div>18</div>
<div>19</div>
<div>20</div>
<div>21</div>
<div>22</div>
<div>23</div>
<div>24</div>
<div>25</div>
<div>26</div>
<div>27</div>
<div>28</div>
<div>29</div>
<div>30</div>
<div>31</div>
<div>32</div>
<div>33</div>
<div>34</div>
<div>35</div>
</div>
<div class='content'><pre><span class="synStatement">use strict</span>;
<span class="synStatement">use warnings</span>;
<span class="synStatement">use </span>Xchat <span class="synStatement">qw(</span><span class="synConstant">:all</span><span class="synStatement">)</span>;
<span class="synStatement">use </span>Net::DNS;
hook_command( <span class="synStatement">"</span><span class="synConstant">BGDNS</span><span class="synStatement">"</span>, <span class="synStatement">sub </span>{
<span class="synStatement">my</span> <span class="synIdentifier">$host</span> = <span class="synIdentifier">$_[</span><span class="synConstant">0</span><span class="synIdentifier">][</span><span class="synConstant">1</span><span class="synIdentifier">]</span>;
<span class="synStatement">my</span> <span class="synIdentifier">$resolver</span> = Net::DNS::Resolver->new;
<span class="synStatement">my</span> <span class="synIdentifier">$sock</span> = <span class="synIdentifier">$resolver->bgsend</span>( <span class="synIdentifier">$host</span> );
hook_fd( <span class="synIdentifier">$sock</span>, <span class="synStatement">sub </span>{
<span class="synStatement">my</span> <span class="synIdentifier">$ready_sock</span> = <span class="synIdentifier">$_[</span><span class="synConstant">0</span><span class="synIdentifier">]</span>;
<span class="synStatement">my</span> <span class="synIdentifier">$packet</span> = <span class="synIdentifier">$resolver->bgread</span>( <span class="synIdentifier">$ready_sock</span> );
<span class="synStatement">if</span>( <span class="synIdentifier">$packet->authority</span> && (<span class="synStatement">my</span> <span class="synIdentifier">@answers</span> = <span class="synIdentifier">$packet->answer</span> ) ) {
<span class="synStatement">if</span>( <span class="synIdentifier">@answers</span> ) {
prnt <span class="synStatement">"</span><span class="synIdentifier">$host</span><span class="synConstant">:</span><span class="synStatement">"</span>;
<span class="synStatement">my</span> <span class="synIdentifier">$padding</span> = <span class="synStatement">"</span><span class="synConstant"> </span><span class="synStatement">"</span> x (<span class="synStatement">length</span>( <span class="synIdentifier">$host</span> ) + <span class="synConstant">2</span>);
<span class="synStatement">for</span> <span class="synStatement">my</span> <span class="synIdentifier">$answer</span> ( <span class="synIdentifier">@answers</span> ) {
prnt <span class="synIdentifier">$padding</span> . <span class="synIdentifier">$answer->rdatastr</span> . <span class="synStatement">'</span><span class="synConstant"> </span><span class="synStatement">'</span> . <span class="synIdentifier">$answer->type</span>;
}
}
} <span class="synStatement">else</span> {
prnt <span class="synStatement">"</span><span class="synConstant">Unable to resolve </span><span class="synIdentifier">$host</span><span class="synStatement">"</span>;
}
<span class="synStatement">return</span> REMOVE;
},
{
<span class="synConstant">flags</span> => FD_READ,
});
<span class="synStatement">return</span> EAT_XCHAT;
});
</pre></div>
</div>
<p>
</p>
<h2><a name="contact_information" />Contact Information</h2>
<p>Contact Lian Wan Situ at <atmcmnky [at] yahoo.com> for questions, comments and
corrections about this page or the Perl plugin itself. You can also find me
in #xchat on FreeNode under the nick Khisanth.</p>
<table border="0" width="100%" cellspacing="0" cellpadding="3">
<tr><td class="block" style="background-color: #cccccc" valign="middle">
<big><strong><span class="block"> X-Chat 2 Perl Interface</span></strong></big>
</td></tr>
</table>
</body>
</html>
|
