X-Chat 2 Perl Interface

This function will return the information normally retrieved with get_info, 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 $id you would normally supply to get_info as well as all the keys that are valid for the items in the "channels" list from get_list. Use of this function is more efficient than calling get_list( "channels" ) and searching through the result.


use strict;
use warnings;
use Xchat qw(:all); # imports all the functions documented on this page
register( "User Count", "0.1",
	 "Print out the number of users on the current channel" );
hook_command( "UCOUNT", \&display_count );
sub display_count {
  prnt "There are " . context_info()->{users} . " users in this channel.";
  return EAT_XCHAT;
}

data	Additional data that is to be associated with the hook. For timer hooks this value can be provided either as `Xchat::hook_timer( $timeout, $cb,{data=>$data})` or `Xchat::hook_timer( $timeout, $cb, $data )`. However, this means that hook_timer cannot be provided with a hash reference containing data as a key. example: my $options = { data => [@arrayOfStuff] }; Xchat::hook_timer( $timeout, $cb, $options ); In this example, the timer's data will be [@arrayOfStuff] and not { data => [@arrayOfStuff] } This key is valid for all of the hook functions. Default is undef.
priority	Sets the priority for the hook. It can be set to one of the `Xchat::PRI_*` constants. This key only applies to server, command and print hooks. Default is `Xchat::PRI_NORM`.
help_text	Text displayed for /help $command. This key only applies to command hooks. Default is "".

Hook Type	When the callback will be invoked
server hooks	a `$message` message is received from the server
command hooks	the `$command` command is executed, either by the user or from a script
print hooks	X-Chat is about to print the message for the `$event` event
timer hooks	called every `$timeout` milliseconds (1000 millisecond is 1 second)

Event	Description
"Open Context"	a new context is created
"Close Context"	a context has been close
"Focus Tab"	when a tab is brought to the front
"Focus Window"	when a top level window is focused or the main tab window is focused by the window manager
"DCC Chat Text"	when text from a DCC Chat arrives. `$_[0]` will have these values `$_[0][0]` - Address `$_[0][1]` - Port `$_[0][2]` - Nick `$_[0][3]` - Message
"Key Press"	used for intercepting key presses $_[0][0] - key value $_[0][1] - state bitfield, 1 - shift, 4 - control, 8 - alt $_[0][2] - string version of the key which might be empty for unprintable keys $_[0][3] - length of the string in $_[0][2]

ID	Return value
away	away reason or undef if you are not away
channel	current channel name
charset	character-set used in the current context
event_text <Event Name>	text event format string for <Event name> Example: my $channel_msg_format = Xchat::get_info( "event_text Channel Message" );
host	real hostname of the current server
id	connection id
inputbox	contents of the inputbox
libdirfs	the system wide directory where xchat will look for plugins. this string is in the same encoding as the local file system
modes	the current channels modes or undef if not known
network	current network name or undef
nick	current nick
nickserv	nickserv password for this network or undef
server	current server name (what the server claims to be) undef if not connected
state_cursor	current inputbox cursor position in characters
topic	current channel topic
version	xchat version number
win_status	status of the xchat window, possible values are "active", "hidden" and "normal"
win_ptr	native window pointer, GtkWindow * on Unix, HWND on Win32. 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. Additionally when you have detached tabs, each of the windows will return a different win_ptr for the different Gtk2::Window objects. See char_count.pl for a longer example of a script that uses this to show how many characters you currently have in your input box.
xchatdir	xchat config directory encoded in UTF-8 examples: /home/user/.xchat2 C:\Documents and Settings\user\Application Data\X-Chat 2
xchatdirfs	same as xchatdir except encoded in the locale file system encoding

Key	Description
channel	tab name
chantypes	channel types supported by the server, typically "#&"
context	can be used with set_context
flags	Server Bits: 0 - Connected 1 - Connecting 2 - Away 3 - EndOfMotd(Login complete) 4 - Has WHOX 5 - Has IDMSG (FreeNode) The following correspond to the /chanopt command 6 - Hide Join/Part Message (text_hidejoinpart) 7 - unused (was for color paste) 8 - Beep on message (alert_beep) 9 - Blink Tray (alert_tray) 10 - Blink Task Bar (alert_taskbar) Example of checking if the current context has Hide Join/Part messages set: `if( Xchat::context_info->{flags} & (1 >> 6) ) { Xchat::print( "Hide Join/Part messages is enabled" ); }`
id	Unique server ID
lag	lag in milliseconds
maxmodes	Maximum modes per line
network	network name to which this channel belongs
nickprefixes	Nickname prefixes e.g. "+@"
nickmodes	Nickname mode chars e.g. "vo"
queue	number of bytes in the send queue
server	server name to which this channel belongs
type	the type of this context 1 - server 2 - channel 3 - dialog
users	Number of users in this channel

X-Chat 2 Perl Interface

Introduction

Constants

Priorities

Return values

Timer specific

Functions

`Xchat::register( $name, $version, [$description,[$callback]] )`

`Xchat::hook_server( $message, $callback, [\%options] )`

`Xchat::hook_command( $command, $callback, [\%options] )`

`Xchat::hook_print( $event,$callback, [\%options] )`

`Xchat::hook_timer( $timeout,$callback, [\%options | $data] )`

When callbacks are invoked

Callback Arguments

Callback return values

Miscellaneous Hook Related Information

`Xchat::unhook( $hook )`

`Xchat::print( $text | \@lines, [$channel,[$server]] )`

`Xchat::printf( $format, LIST )`

`Xchat::command( $command | \@commands, [$channel,[$server]] )`

`Xchat::commandf( $format, LIST )`

`Xchat::find_context( [$channel, [$server]] )`

`Xchat::get_context()`

`Xchat::set_context( $context | $channel,[$server] )`

`Xchat::get_info( $id )`

`Xchat::get_prefs( $name )`

`Xchat::emit_print( $event, LIST )`

`Xchat::send_modes( $target | \@targets, $sign, $mode, [ $modes_per_line ] )`

`Xchat::nickcmp( $nick1, $nick2 )`

`Xchat::get_list( $name )`

`Xchat::user_info( [$nick] )`

`Xchat::context_info( [$context] )`

`Xchat::strip_code( $string )`

Contact Information

Key	Value
address32	address of the remote user(ipv4 address)
cps	bytes per second(speed)
destfile	destination full pathname
file	file name
nick	nick of the person this DCC connection is connected to
port	TCP port number
pos	bytes sent/received
resume	point at which this file was resumed (zero if it was not resumed)
size	file size in bytes low order 32 bits
sizehigh	file size in bytes high order 32 bits (when the files is > 4GB)
status	DCC Status: 0 - queued 1 - active 2 - failed 3 - done 4 - connecting 5 - aborted
type	DCC Type: 0 - send 1 - receive 2 - chatrecv 3 - chatsend

Key	Value
mask	ignore mask. e.g: !@*.aol.com
flags	Bit field of flags. 0 - private 1 - notice 2 - channel 3 - ctcp 4 - invite 5 - unignore 6 - nosave 7 - dcc

Key	Value
networks	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
nick	nickname
flags	0 = is online
on	time when user came online
off	time when user went offline
seen	time when user was last verified still online

Key	Value
away	away status(boolean)
lasttalk	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)
nick	nick name
host	host name in the form: user@host or undef if not known
prefix	prefix character, .e.g: @ or +
realname	Real name or undef
selected	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