ATTRIBUTES

METHODS

ATTRIBUTES

METHODS

• destroy

• bans

• ban_get_mask $nick, $ban_type

• banlist_add $ban, $nick, $time

• banlist_remove $ban

• nick_insert $nick, $op, $voice, $send_massjoin

• nick_remove $nick

• nick_find $nick

• nick_find_mask $mask

• nicks

ATTRIBUTES

METHODS

ATTRIBUTES

METHODS

ATTRIBUTES

ATTRIBUTES

ATTRIBUTES

• Dcc

• Dcc::Chat-

• Dcc::Get-

• Dcc::Send-

METHODS

• destroy

• chat_send $data

• ctcp_message $target, $notice, $msg

• close

• init_rec

• reject

COLOURS

• Local Colours

• Colourising Text in IRC Messages

VARIABLE SYNTAX

• Some Examples:

ALIAS AND FORMAT TEMPLATE ARGUMENTS

EXPANDOS (SPECIAL VARIABLES)

DESCRIPTION

LOADING AND UNLOADING SCRIPTS

• File Locations

  • Autorunning Scripts

• Testing

• Loading

• Unloading

ANATOMY OF A SCRIPT

• Preamble

  • Accessing Script Metadata From Outside Irssi

• COMMONLY SCRIPTED TASKS

  • Modifying an input line before sending

  • Responding to a public message

  • Responding to a private message

• USEFUL THINGS

  • Fun With Window(item) Contents

    • Inserting Lines

    • Removing Lines

  • Dealing with Blocking IO

  • Getting the Response Value of a Remote Command

  • Getting the Response Value of a Local Command

    • Making Parsing Easier

  • COMMUNICATING WITH OTHER SCRIPTS

    • Using Signals

    • Using Functions

      • Checking if a script is loaded

      • Calling Functions in Other Scripts

    • If In Doubt, Dump!

    • Making Scripts Look Native

      • Provide Help

      • Use Tab Completion

      • Use Settings for Customisation

        • Detecting Changes in Settings

      • Use Subcommands to Group Script Functionality

      • Use Existing Formats for Consistency

      • Creating a new Statusbar Item

      • Creating a new Expando

    • THANKS

ATTRIBUTES

METHODS

• Event Redirection

• Netsplits

• Misc

• Sending Raw Data

ATTRIBUTES

METHODS

• channels

• channels_join $channels, $automatic

• queries

• print $channel, $str, $level

• command $string

• Connect::connect

• disconnect

• isnickflag $flag

• ischannel $data

• get_nick_flags

• send_message $target, $msg, $target_type

• netsplit_find $nick, $address

• netsplit_find_channel $nick, $address, $channel

• dcc_ctcp_message $target, $notice, $msg

• channel_find $channel

• ignore_check $nick, $host, $channel, $text, $level

• nicks_get_same $nick

TODO

ATTRIBUTES

METHODS

add_rec

update_rec

Code Organisation

• Design Hierarchy

• Filesystem Layout

Mainloop

Signals, And Their Handling

• A Simplified Description

• The Gory Details

• Adding Signals

• notes

Curses and Terminals

Input Processing (keybindings, etc)

• Reading Keystrokes

INPUT HANDLING

• gui-readline.c

• keyboard.h

• keyboard.c

• Handling Key-Bindings.

History (inc. window level history)

Window Management

Formats, Abstracts, and Themes

• Colors:

• Formats.c

• gui-printtext.c

Perl Scripting Support

• Message Levels

fe-text

• term-curses.c

• term.h

• term-terminfo.c

• terminfo-core.c

• terminfo-core.h

Hacking on the Perl API

TODO

METHODS

Accessors

• dccs

DESCRIPTION

EXPORTS

METHODS

• Accessors

• File-associated Accessors

• Signals

  • Handling Signals

• Controlling Signal Propagation

• Registering New Signals

Commands

• Registering Commands

• Invoking Commands

• Parsing Command Arguments

Settings

• Creating New Settings

• Retrieving Settings

• Modifying Settings

• IO and Process Management

• Message Levels

• Themes

• Expandos

• Text GUI

  • Getting the Input Field Contents

• Channels

• Ignores

• Logging

• Raw Logging

• Chat-Nets

• Status Bars

ATTRIBUTES

METHODS

• get_text

• next

• prev

ATTRIBUTES

METHODS

ATTRIBUTES

METHODS

ATTRIBUTES

METHODS

• update

• close

• start_logging

• stop_logging

• item_add $type, $name, $server

• item_destroy $item

• item_find $type, $item, $server

• write_rec

ATTRIBUTES

METHODS

ATTRIBUTES

METHODS

Writing your own Module

ATTRIBUTES

METHODS

ATTRIBUTES

METHODS

• ircnets_match $ircnet

ATTRIBUTES

METHODS

ATTRIBUTES

METHODS

ATTRIBUTES

METHODS

• destroy

• get_lines

• open $filename

• close

• save $filename

• input $str

• output $str

• redirect $str

ATTRIBUTES

ATTRIBUTES

• Sample Object Contents

METHODS

DESCRIPTION

GOALS

USING SIGNALS

SIGNAL TYPES

SIGNAL DEFINITIONS

Core

• chat-protocols.c

• channels.c

• chatnets.c

• commands.c

• ignore.c

• log.c

• modules.c

• nicklist.c

• pidwait.c

• queries.c

• rawlog.c

• server.c

• settings.c

IRC Core

• bans.c

• channels, nicklist

• ctcp.c

• irc-log.c

• irc-nicklist.c

• irc-servers.c

• irc.c

• lag.c

• massjoin.c

• mode-lists.c

• modes.c

• netsplit.c

IRC Modules

• dcc*.c

• autoignore.c

• flood.c

• notifylist.c

• proxy/listen.c

Display (FE) Common

• completion.c

• fe-common-core.c

• fe-exec.c

• fe-messages.c

• keyboard.c

• printtext.c

• themes.c

• window-activity.c

• window-items.c

• windows.c

Display (FE) IRC

• fe-events.c

• fe-irc-messages.c

• fe-modes.c

• dcc/fe-dcc-chat-messages.c

Display (FE) Text

• gui-readline.c

• gui-printtext.c

Perl Scripting

ATTRIBUTES

METHODS

• default_handler $item, $get_size_only, $str, $data, $escape_vars

ATTRIBUTES

METHODS

ATTRIBUTES

METHODS

• Irssi::UI::TextDest::print

ATTRIBUTES

METHODS

format_expand $theme, $format, $flags

get_format $theme, $module, $tag

Loading and Testing

TEMPLATES

COLOURS

ATTRIBUTES

METHODS

ATTRIBUTES

METHODS

• Printing and Formatting

• Window Management

• Window Item Management

ATTRIBUTES

METHODS

• print $str, $level

• printformat $level, $str, @args

• command $string

• set_active

• change_server $server

• is_active

• get_dcc $item

• window

• window_create $automatic

• activity $data_level $hilight_colour

• parse_special $str, $data, $flags

Introduction

Misc

Replacements

Abstracts

Formats

• fe-common/irc/dcc

• fe-common/irc/notifylist

• fe-common/core

• fe-text

• fe-common/perl

• fe-common/irc