Using cpIRC

Compiling with cpIRC

	#include "IRC.h"

Synopsis

	#include "IRC.h"

	IRC conn;

	conn.start("some.irc.server.com", 6667, "some nick", "some user", "some irc name", "some password");
	conn.message_loop();

Getting started

	#include "IRC.h"

	IRC conn;

	conn.hook_irc_command("irc response", &function_name);

	int function_name(char* params, irc_reply_data* hostd, void* conn)
	{
		IRC* irc_conn=(IRC*)conn; /* notice that you are passed a pointer to the connection object */
	
		return 0;
	}

	struct irc_reply_data
	{
		char* nick;
		char* ident;
		char* host;
		char* target; /* This variable contains things such as the target of a PRIVMSG/NOTICE message, 
				 ie. the channel or person it was sent to */
	};

	conn.start("some.irc.server.com", 6667, "some nick", "some user", "some irc name", "some password");
	conn.message_loop();

When you are sick of talking to the IRC server, just get one of your forked processes or spawned threads to issue this command:

	conn.quit("Leaving");

	conn.irc_command(<params>);

Command	Function	Description
JOIN	int IRC::join(char* channel);	Join a channel.
PART	int IRC::part(char* channel);	Leave a channel.
QUIT	int IRC::quit(char* message);	Disconnect from the IRC server.
NOTICE	int IRC::notice(char* target, char* message); int IRC::notice(char* target, ...);	Send a notice. The second function allows usage like printf.
PRIVMSG	int IRC::privmsg(char* target, char* message); int IRC::privmsg(char* target, ...);	Send a message. The second function allows usage like printf.
KICK	int IRC::kick(char* channel, char* nick); int IRC::kick(char* channel, char* nick, char* message);	Kick somebody from a channel.
MODE	int IRC::mode(char* modes); int IRC::mode(char* channel, char* modes, char* targets);	Change channel or user modes.
NICK	int IRC::nick(char* newnick);	Change your nickname.
RAW	int IRC::raw(char* data);	Issue a raw IRC command to the server.

and the following other functions are implemented:

Function	Description
int IRC::start(char* server, int port, char* nick, char* user, char* name, char* pass);	Connects to an IRC server.
int IRC::message_loop();	Start the IRC message loop, this is called to start the parsing of commands.
void IRC::hook_irc_command(char* cmd_name, int (*function_ptr)(char*, irc_reply_data*, void*));	This function is used to 'hook' an IRC command. It allows you to specify a function to be called when the appropriate response is received from the server.
void IRC::disconnect();	Disconnect from the IRC server. This function does not take a reason for quitting as a parameter.
int IRC::is_op(char* channel, char* nick);	Checks whether or not a user has ops in the specified channel.
int IRC::is_voice(char* channel, char* user);	Checks whether or not a user has voice in the specified channel.
char* IRC::current_nick();	Returns a pointer to a string holding the current nickname of the client.

Examples

	#include <stdio.h>
	#include <windows.h>
	#include <process.h>

	#include "IRC.h"

	int end_of_motd(char* params, irc_reply_data* hostd, void* conn) /* our callback function */
	{
		IRC* irc_conn=(IRC*)conn;
	
		irc_conn->join("#magpie"); /* join the channel #magpie */
		return 0;
	}

	void cmd_thread(void* irc_conn) /* another thread just to wait until a key is pressed, and then quit */
	{
		IRC* conn=(IRC*)irc_conn;

		getc(stdin); /* read in a character from standard in */
		conn->quit("Leaving"); /* send the Quit command to the IRC server */
		_endthread(); /* end the thread */
	}

	void main()
	{
		IRC conn; /* declare an IRC connection */
		WSADATA wsaData; /* winsock stuff, linux/unix/*bsd users need not worry about this */
	
		if (WSAStartup(MAKEWORD(1, 1), &wsaData)) /* more winsock rubbish */
		{
			printf("Failed to initialise winsock!\n");
		}
	
		conn.hook_irc_command("376", &end_of_motd); /* hook the end of MOTD message */
		_beginthread(cmd_thread, 0, (void*)&conn); /* spawn our key input thread */
		conn.start("irc.uk.quakenet.org", 6668, "cpirctest", "cpirctest", "cpIRC test", "password"); /* connect to a server */
		conn.message_loop(); /* start the message loop */
		WSACleanup(); /* more winsock stuff */
	}