--- LuaIRC is a low-level IRC library for Lua. -- All functions raise Lua exceptions on error. -- -- Use new to create a new Connection object.
-- Example:

-- --require "irc"
--local sleep = require "socket".sleep
--
--local s = irc.new{nick = "example"}
--
--s:hook("OnChat", function(user, channel, message)
-- print(("[%s] %s: %s"):format(channel, user.nick, message))
--end)
--
--s:connect("irc.example.net")
--s:join("#example")
--
--while true do
-- s:think()
-- sleep(0.5)
--end
-- module "irc" --- Create a new Connection object. Use irc:connect to connect to a server. -- @param user Table with fields nick, username and realname. -- The nick field is required. -- -- @return Returns a new Connection object. -- @see Connection function new(user) --- Hook a function to an event. -- @param name Name of event. -- @param id Unique tag. -- @param f Callback function. [defaults to id] -- @see Hooks function irc:hook(name, id, f) --- Remove previous hooked callback. -- @param name Name of event. -- @param id Unique tag. function irc:unhook(name, id) --- Connect irc to an IRC server. -- @param host Host address. -- @param port Server port. [default 6667] function irc:connect(host, port) -- @param table Table of connection details -- @see ConnectOptions function irc:connect(table) --- Disconnect irc from the server. -- @param message Quit message. function irc:disconnect(message) --- Handle incoming data for irc, and invoke previously hooked callbacks based on new server input. -- You should call this in some kind of main loop, or at least often enough to not time out. function irc:think() --- Look up user info. -- @param nick Nick of user to query. -- @return Table with fields userinfo, node, channels and account. function irc:whois(nick) --- Look up topic. -- Use this to invoke the hooks OnTopic and OnTopicInfo at any time. -- @param channel Channel to query. function irc:topic(channel) --- Send a IRC message to the server. -- @param msg Message or raw line to send, excluding newline characters. -- @param ... Format parameters for msg, with string.format semantics. [optional] function irc:send(msg, ...) --- Queue Message to be sent to the server. -- @param msg Message to be sent. function irc:queue(msg) --- Send a message to a channel or user. -- @param target Nick or channel to send to. -- @param message Message text. function irc:sendChat(target, message) --- Send a notice to a channel or user. -- @param target Nick or channel to send to. -- @param message Notice text. function irc:sendNotice(target, message) --- Join a channel. -- @param channel Channel to join. -- @param key Channel key. [optional] function irc:join(channel, key) --- Leave a channel. -- @param channel Channel to leave. function irc:part(channel) --- Turn user information tracking on or off. User tracking is enabled by default. -- @param b Boolean whether or not to track user information. function irc:trackUsers(b) --- Add/remove modes for a channel or nick. -- @param t Table with fields target, nick, add and/or rem. target or nick -- specifies the user or channel to add/remove modes. add is a list of modes to add to the user or channel. -- rem is a list of modes to remove from the user or channel. -- @usage Example which sets +m (moderated) for #channel:
-- irc:setMode{target = "#channel", add = "m"} function irc:setMode(t) --internal function irc:invoke(name, ...) function irc:handle(msg) function irc:shutdown() --- Table with connection information. -- @name ConnectOptions -- @class table -- @field host Server host name. -- @field port Server port. [defaults to 6667] -- @field timeout Connect timeout. [defaults to 30] -- @field password Server password. -- @field secure Boolean to enable TLS connection, pass a params table (described, [luasec]) to control -- [luasec]: http://www.inf.puc-rio.br/~brunoos/luasec/reference.html --- Class representing a connection. -- @name Connection -- @class table -- @field authed Boolean indicating whether the connection has completed registration. -- @field connected Whether the connection is currently connected. -- @field motd The server's message of the day. Can be nil. -- @field nick The current nickname. -- @field realname The real name sent to the server. -- @field username The username/ident sent to the server. -- @field socket Raw socket used by the library. -- @field supports What the server claims to support in it's ISUPPORT message. --- Class representing an IRC message. -- @name Message -- @class table -- @field args A list of the command arguments -- @field command The IRC command -- @field prefix The prefix of the message -- @field raw A raw IRC line for this message -- @field tags A table of IRCv3 tags -- @field user A User object describing the sender of the message -- Fields may be missing. -- Messages have the following methods: -- --- List of hooks you can use with irc:hook. -- The parameter list describes the parameters passed to the callback function. -- -- * Event also invoked for yourself. -- † Channel passed only when user tracking is enabled -- @name Hooks -- @class table --- Table with information about a user. -- -- Fields may be missing. To fill them in, enable user tracking and use irc:whois. -- @name User -- @class table