apps/irssi/docs/design.txt

   1
   2  Irssi's hierarchy is something like this:
   3
   4
   5          sub1 sub2
   6             \ /
   7        xxx  IRC       COMMON ICQ  yyy
   8         |____|___________|____|____|
   9                    |
  10                   GUI (gtk/gnome, qt/kde, text, none)
  11                    |
  12          sub1 sub2 |
  13             \ /    |
  14        xxx  IRC    |  COMMON ICQ  yyy
  15         |____|_____|_____|____|____|
  16                    |
  17                COMMON UI
  18                    |
  19          sub1 sub2 |
  20             \ /    |
  21        xxx  IRC    |    ICQ  yyy
  22         |____|_____|_____|____|
  23                    |
  24                  CORE
  25                  /
  26         lib-config
  27
  28
  29  (IRC, ICQ, xxx and yyy are chat protocols ..)
  30  (sub1 and sub2 are submodules of IRC module, like DCC and flood protect)
  31
  32
  33  Chat protocols and frontends are kept in separate modules. Common UI
  34  and GUI modules also have the common parts which don't know anything
  35  about the chat protocols. This should allow implementing modules to
  36  whatever chat protocols and with whatever frontends easily.
  37
  38  ** Signals
  39
  40  Communication between different modules are done with "signals". They are
  41  not related to UNIX signals in any way, you could more like think of them
  42  as "events" - which might be a better name for them, but I don't really
  43  want to change it anymore :)
  44
  45  So, you send signal with signal_emit() and it's sent to all modules that
  46  have grabbed it by calling signal_add() in their init function. For
  47  example:
  48
  49    signal_emit("mysignal", 1, "hello");
  50
  51  Sends a "mysignal" function with one argument "hello" - before that, you
  52  should have grabbed the signal somewhere else with:
  53
  54    static void sig_mysignal(const char *arg1)
  55    {
  56      /* arg1 contains "hello" */
  57    }
  58
  59    signal_add("mysignal", (SIGNAL_FUNC) sig_mysignal);
  60
  61  There are three different signal_add() functions which you can use to
  62  specify if you want to grab the signal first, "normally" or last. You can
  63  also stop the signal from going any further.
  64
  65  Emitting signal with it's name creates a small overhead since it has to
  66  look up the signal's numeric ID first, after which it looks up the signal
  67  structure. This is done because if you call a signal _really_ often,
  68  it's faster to find it with it's numeric ID instead of the string. You
  69  can use signal_get_uniq_id() macro to convert the signal name into ID -
  70  you'll have to do this only once! - and use signal_emit_id() to emit the
  71  signal. Don't bother to do this unless your signal is sent (or could be
  72  sent) several times in a second.
  73
  74  See src/core/signals.h for definition of the signal function, and
  75  signals.txt for a list of signals.
  76
  77
  78  ** lib-config
  79
  80    Irssi depends on this for reading and saving configuration.
  81    (created by me for irssi)
  82
  83
  84  ** CORE module
  85
  86  Provides some functionality that all other modules can use:
  87    - signal handling
  88    - keeping list of settings
  89    - keeping list of /commands
  90    - keeping track of loaded modules
  91    - networking functions (with nonblocking connects, IPv6 support)
  92    - handles connecting to servers
  93    - raw logging of server's input/output data
  94    - /EVAL support
  95    - fgets() like function line_split() without any maximum line limits
  96    - command line parameter handling
  97    - miscellaneous useful little functions
  98    - handles logging
  99
 100
 101  ** COMMON UI module
 102
 103    - knows basics about windows and window items (=channels, queries, ..)
 104    - printtext() - parsing texts and feeding it for GUI to print.
 105    - themes
 106    - translation tables
 107    - text hilighting
 108    - command history
 109    - user interface (/commands) for CORE's functionality
 110
 111
 112  ** GUI modules
 113
 114    - all the rest of the functionality needed for a working client.
 115
 116
 117  ** IRC module
 118
 119    * CORE
 120
 121      - IRC specific /commands
 122      - flood protecting commands sent to server
 123      - creating IRC masks based on nick/address for bans, ignores, etc.
 124      - keeps list of channels, nicks, channel modes, bans, etc.
 125      - keeps list of servers, server settings, irc networks,
 126        server reconnections and irc network splits
 127      - redirection of commands' replies
 128      - lag detection
 129      - ctcp support and flood protection
 130      - Handles ignoring people
 131
 132    * DCC
 133
 134      - DCC chat, send and get
 135
 136    * FLOOD
 137
 138      - detects private or channel flooding and sends "flood" signal
 139      - automatic ignoring when flooding
 140
 141    * NOTIFYLIST
 142
 143      - handles notifylist
 144
 145
 146  ** IRC UI module
 147
 148    - placing channels and queries in windows
 149    - nick completion
 150    - printing infomation of some events