doc/events.txt

   1                                 Events
   2
   3 This file lists the events currently in use, when they are called, what they
   4 do and what arguments they expect.
   5
   6 Events are a mechanism for communication between ELinks parts --- any ELinks
   7 subsystem (module) can register an event, hook at an event or trigger an event.
   8 Events are designed to allow transition to a completely message-passing model
   9 internally, with modules talking to each other through the events.
  10
  11 Events are currently used primarily as a generic way to trigger event handlers
  12 in various scripting backends.
  13
  14 Therefore, so far this reference sheet is useful mainly to scripting backends
  15 developers and also scripting power users - it looks at the C side but usually
  16 you get most (if not all) of it passed to the hook functions in your scripts.
  17
  18
  19
  20 Below is a template showing how to read the event information
  21
  22 Name:           <event name>
  23 Managed By:     <what part of the code registers and unregister the event>
  24 Triggered When:
  25
  26  <short description of when the event is triggered>
  27
  28 Arguments:
  29
  30  <the order and type of the arguments>
  31
  32 Description:
  33
  34  <description of the arguments, what the event does etc.>
  35
  36 Please keep in alphabetical order!
  37
  38
  39
  40 The list of events itself:
  41
  42 -------------------------------------------------------------------------------
  43 Name:           bookmark-delete
  44 Managed By:     The bookmarks subsystem
  45 Triggered When:
  46
  47  A bookmark is being deleted.
  48
  49 Arguments:
  50
  51  struct bookmark *bookmark
  52
  53 Description:
  54
  55  Currently only used by the tab snapshotting code to avoid a dangling pointer
  56  should the deleted bookmark be the folder to which it made the last snapshot.
  57
  58 -------------------------------------------------------------------------------
  59 Name:           bookmark-move
  60 Managed By:     The bookmarks subsystem
  61 Triggered When:
  62
  63  A bookmark is being moved.
  64
  65 Arguments:
  66
  67  struct bookmark *bookmark
  68  struct bookmark *destination
  69
  70 Description:
  71
  72  The bookmark is moved immediately after the destination bookmark.
  73
  74  This is currently only used by the tab snapshotting code, which assumes
  75  that when a user moves a bookmark, the user does not want the snapshotting
  76  code to delete it when it makes the next snapshot.
  77
  78 -------------------------------------------------------------------------------
  79 Name:           bookmark-update
  80 Managed By:     The bookmarks subsystem
  81 Triggered When:
  82
  83  The user finishes editing a bookmark.
  84
  85 Arguments:
  86
  87  struct bookmark *bookmark
  88  unsigned char *new_title       /* UTF-8 */
  89  unsigned char *new_url         /* UTF-8 */
  90
  91 Description:
  92
  93  This is triggered before the new title and URL are assigned to the bookmark.
  94  Therefore, handlers can get the old title and URL from the bookmark structure
  95  and the new title and URL from the event arguments.
  96
  97  This is currently only used by the tab snapshotting code, which assumes
  98  that when a user edits a bookmark, the user does not want the snapshotting
  99  code to delete it when it makes the next snapshot.
 100
 101 -------------------------------------------------------------------------------
 102 Name:           dialog-lua-console
 103 Managed By:     The Lua scripting subsystem/backend
 104 Triggered When:
 105
 106  The user hits a key associated with 'lua-console' action.
 107
 108 Arguments:
 109
 110  struct session *ses
 111
 112 Description:
 113
 114  Open Lua console dialog.
 115
 116 -------------------------------------------------------------------------------
 117 Name:           follow-url
 118 Managed By:     The scripting subsystem/backends
 119 Triggered When:
 120
 121  The user decides to load some document by following a link, entering a URL
 122  in the goto URL dialog, loading frames from a frameset (?) etc.
 123
 124 Arguments:
 125
 126  unsigned char **url, struct session *ses
 127
 128 Description:
 129
 130  If another URL than @url should be followed it is passed by setting @url.
 131  If @url is changed the event propagation should be ended.
 132  Valid values for @url includes:
 133  - unchanged, if the original URL should be followed;
 134  - a new, dynamically allocated URL to be followed instead; or
 135  - NULL or an empty, dynamically allocated string if no URL should be followed.
 136
 137 -------------------------------------------------------------------------------
 138 Name:           free-history
 139 Managed By:     The scripting subsystem/backends
 140 Triggered When:
 141
 142  ELinks exits
 143
 144 Arguments:
 145
 146  None
 147
 148 Description:
 149
 150  Allow a subsystem to free its history lists.
 151
 152 -------------------------------------------------------------------------------
 153 Name:           get-proxy
 154 Managed By:     The scripting subsystem/backends
 155 Triggered When:
 156
 157  Determining what proxy, if any, should be used to load a requested URL.
 158
 159 Arguments:
 160
 161  unsigned char **new_proxy_url, unsigned char *url
 162
 163 Description:
 164
 165  Possible values for @new_proxy_url includes:
 166  - a dynamically allocated string with the format proxy:port;
 167  - an empty string (dynamically allocated!) to use no proxy; or
 168  - NULL to use the default proxies.
 169
 170 -------------------------------------------------------------------------------
 171 Name:           goto-url
 172 Managed By:     The scripting subsystem/backends
 173 Triggered When:
 174
 175  The user enters something into the goto URL dialog.
 176
 177 Arguments:
 178
 179  unsigned char **url, struct session *ses
 180
 181 Description:
 182
 183  If a URL other than @url should be followed, the old one should be freed
 184  and the new one should be assigned to @url. @url must not be assigned
 185  NULL and must remain freeable.
 186  Valid values for @url are:
 187  - unchanged, if the original URL should be followed;
 188  - a new, dynamically allocated URL to be followed instead; or
 189  - NULL or an empty, dynamically allocated string if no URL should be followed.
 190
 191  @ses is usually used for deciding based on the current URI or for reporting
 192  potential errors during the hook processing through the UI. With @ses being
 193  NULL the hook handler should assume no current URI and no suitable UI set up
 194  (i.e., starting up yet or -dump).
 195
 196 -------------------------------------------------------------------------------
 197 Name:           periodic-saving
 198 Managed By:     No maintainer but used by lowlevel/timer.*
 199 Triggered When:
 200
 201  The interval timer configured through option goes off.
 202
 203 Arguments:
 204
 205  none
 206
 207 Description:
 208
 209  Makes it possible to periodically save files in ~/.elinks to disk.
 210
 211 -------------------------------------------------------------------------------
 212 Name:           pre-format-html
 213 Managed By:     The scripting subsystem/backends
 214 Triggered When:
 215
 216  A HTML document has been loaded - before the document rendering begins.
 217
 218 Arguments:
 219
 220  struct session *ses
 221  struct cache_entry *cached
 222
 223 Description:
 224
 225  Makes it possible to fix up bad HTML code, remove tags etc. The parameter
 226  cached is guaranteed to have a single fragment. The HTML source is changed
 227  by replacing this fragment:
 228
 229         add_fragment(cached, 0, new_string, new_len);
 230         normalize_cache_entry(cached, new_len);
 231
 232  The caller must ensure that there is a reference to cached, so that
 233  calling garbage_collection() from the event handler cannot free it.
 234
 235 -------------------------------------------------------------------------------
 236 Name:           quit
 237 Managed By:     The scripting subsystem/backends
 238 Triggered When:
 239
 240  ELinks quits
 241
 242 Arguments:
 243
 244  None
 245
 246 Description:
 247
 248  Allows a subsystem to do whatever clean-up is required when ELinks quits.
 249
 250 -------------------------------------------------------------------------------