src/drafts/scripting

   1 ===================
   2 The design
   3 ===================
   4
   5 I. Key Factors
   6 There are several aspects to deal with when adding scripting support to
   7 Screen:
   8 1. The set of information to expose.
   9 2. The command interface to provide.
  10 3. The hook on interesting events in Screen.
  11 4. The ability to do run asynchronously to Screen itself.
  12
  13 A. Query & control interface
  14
  15 Currently, screen provides a way to control a running session through the -X
  16 command switch, which sends the specified command through the sever socket.
  17 It's quite useful and can already do automation to some degree, (e.g. [1]).
  18 However, the problem is that, there is no way to get enough feedback to make
  19 decision in your script in such a scheme. The first job is to provide an
  20 interface for scripts to query internal status of Screen. The second job is to
  21 provide an interface to control Screen, with reasonable feedback.
  22
  23 B. Event hooking
  24
  25 When the internal status of Screen changed, we say that an event happened.
  26 Events are also interesting to scripts, but are not covered by the query
  27 interface. A hook / callback system is needed to notify scripts about
  28 interested events. With the callback that triggers before an event, the script
  29 should be able to stop the event from happening.
  30
  31 C. Asynchronous scripting
  32
  33 So far, with the described scripting support, we can write small functions
  34 that provide enhanced functionality to a screen command, or write event
  35 handler that handles interested events. But we are restricted to finish our
  36 work quickly. The problem is that, Screen itself is a single threaded
  37 application, utilizing asynchronous I/O to provide services to all windows
  38 running inside. So you simply can not do time-consuming work in any of the
  39 processing path, including the scripts.
  40
  41 Sometimes we may need to wait for something in a script, such as emulating
  42 Expect in a Screen script [2]. The core of this use case is to wait for an
  43 output pattern and react upon it. One possible way is to provide an event
  44 callback for it. But it's not a pleasant way to do a series of interaction.
  45 A natural solution is to make the script able to run asynchronously to Screen
  46 itself.
  47
  48 [1] http://github.com/rblackwe/yapc--na-2007--making-an-ajax-gui-for-gnu-screen
  49 [2] http://lists.gnu.org/archive/html/screen-users/2009-05/msg00006.html
  50
  51 II. The Screen interface
  52
  53 Screen needs to provide a user interface to source and run scripts.
  54
  55 script source [-async|-a] [-binding|-b <binding>] script.
  56
  57   This command sources the specified script. This command can be used several
  58   times to source multiple scripts. Use the -async switch if the
  59   script is supposed to run asynchronously , e.g. it needs to wait for
  60   external events. Asynchronous scripts running mode needs to acquire a
  61   lock before playing on Screen itself. As a result, it pays more overhead
  62   than synch ones. Moreover, asynchronous scripts may be isolated from other
  63   scripts and may not share any information with them. In other words, normal
  64   scripts may share the same context. (Note: the isolation between scripts may
  65   be implementation dependent. Which is more desirable?)
  66
  67 script call func arg1 arg2 ...
  68
  69   Call functions defined by scripts. If the same function are defined in
  70   multiple scripting context, the last one applies. Call to normal script
  71   returns synchronously. And call to asynchronous one will return immediately.
  72
  73 Special invoke interface, such as those embedded in caption/hstatus format
  74 string.
  75
  76 III. The scripting interface
  77
  78 There are several kinds of objects that may be interested to scripts.
  79
  80 A. Display
  81
  82 Stands for a user interface.
  83
  84 ----------
  85 Properties:
  86 ----------
  87
  88 tty:
  89  mode: read only.
  90  type: String.
  91  description: The tty that this attach runs on.
  92
  93 term:
  94  mode: read only.
  95  type: String.
  96  description: The TERM env of that tty.
  97
  98 fore:
  99  mode: read only.
 100  type: Window.
 101  description: The fore window.
 102
 103 other:
 104  mode: read only.
 105  type: Window.
 106  description: List of windows other than the fore.
 107
 108 width:
 109  mode: read only.
 110  type: Int.
 111  description: As the name suggests
 112
 113 height:
 114  mode: read only.
 115  type: Int.
 116  description:  As the name suggests
 117
 118 user:
 119  mode: read only.
 120  type: User.
 121  description: The owner of this display.
 122
 123 layout:
 124  mode: read only.
 125  type: Layout.
 126  description: Active layout on this display.
 127
 128
 129 ----------
 130 Methods:
 131 ----------
 132
 133 get_canvases: Get a list of canvases on this display.
 134
 135 ----------
 136 Events:
 137 ----------
 138
 139 on_resize: Triggered after the geometry of the display is changed.
 140
 141 B. Window
 142
 143 Stands for the sub-terminal(PTY, telnet etc) that processes runs on.
 144
 145 ----------
 146 Properties:
 147 ----------
 148
 149 title:
 150  mode: read write
 151  type: String.
 152  description: The title of the window.
 153
 154 number:
 155  mode: read write
 156  type: int.
 157  description: The index in the window slots. Assigning new value to the number
 158               changes the position of this window in the window list. If the
 159               new window is occupied by some other window, they are changed by
 160               position.
 161
 162 dir:
 163  mode: read only
 164  type: String.
 165  description: The initial directory of the first
 166               application (typically the shell) in that window.
 167
 168 tty:
 169  mode: read only
 170  type: String
 171  description: the associated terminal device for that window.
 172
 173 pid:
 174  mode: read only
 175  type: int
 176  description: the pid of of the slave end of the pty.
 177
 178 group:
 179  mode: read only
 180  type: Window
 181  description: The window group we belongs to. (*This seems in-active?*)
 182
 183 bell:
 184  mode: read only
 185  type: int
 186  description: The bell status of the window.
 187
 188 ----------
 189 Methods:
 190 ----------
 191
 192 int get_monitor_status(bool activity);
 193  Returns the status of the specified monitor type. Either activity or silence.
 194  When the silence monitor is active, the threshold is returned.
 195
 196 void set_monitor_status(bool activity, int status);
 197  Set the status of activity/silence monitor. The number of status for the
 198  silence monitor is the seconds of threshold.
 199
 200 void stuff(string buf);
 201  put the string into the input buffer.
 202
 203 void activate();
 204  Show the window in current focused canvas.
 205
 206 int waitfor(string pattern);
 207  Waiting for a specified output pattern. The pattern is limited to plain text.
 208  NOTICE: This is an asynchronous method call and can only be called in
 209  asynchronous mode.
 210
 211 hook([obj], event, handler, [priv])
 212  See the description in Screen object.
 213
 214 ----------
 215 Events
 216 ----------
 217
 218 on_activity
 219 on_silence (window)
 220   triggered when the silence monitor got fired.
 221
 222 on_focus (display, window)
 223  Triggered when the window gets input focus on a display.
 224  Differs from the global event forechange, it's associated with a specific
 225  window.
 226
 227 on_leave (display, window)
 228  Triggered after the window lost input focus on a display.
 229  Differs from the global event forechange, it's associated with a specific
 230  window.
 231
 232 on_show (display, window)
 233  Triggered after the first view of this window show up on a display.
 234  Differs from on_focus when there are many regions on a display.
 235
 236 on_hide (display, window)
 237  Triggered after the last view of this window disappeared from a display.
 238  Differs from on_leave when there are many regions on a display.
 239
 240 can_resize
 241 on_resize
 242
 243 C. User
 244
 245 --------
 246 Property:
 247 --------
 248
 249 name:
 250  mode: read only
 251  type: String.
 252  description: The login name.
 253
 254 uid:
 255  mode: read only
 256  type: int
 257  description: The index in the ACL bit fields.
 258
 259 esc:
 260 metaesc:
 261  mode: read only
 262  type: int
 263  description: The escape character
 264
 265 umask:
 266  mode: read only
 267  type: String.
 268  description: The access for the window created by this user to other users.
 269               The result will be in a form of 'rwx'.
 270
 271 D. Display
 272
 273
 274 ----------
 275 Methods:
 276 ----------
 277
 278 E. Canvas
 279
 280 ----------
 281 Methods:
 282 ----------
 283
 284 select()
 285   Get input focus for this canvas.
 286
 287 F. Screen
 288
 289  This is a pseudo object standing for the whole screen object. All other
 290  objects can be obtained starting from this one.
 291
 292 --------
 293 Methods:
 294 --------
 295 windows
 296 displays
 297 command
 298 windowbyname
 299
 300 hook([obj], event, handler, [priv])
 301 or obj:hook(event, handler,[priv])
 302
 303  listen to the event notification. The event is associated with the specified
 304  obj. If the obj is omitted, the event is a global event. An optional privilege
 305  can be specified through the priv parameter. The privilege determines the
 306  position of this handler in the chain. A smaller value has higher privilege.
 307
 308  This method returns a ticket (or handle) of the registration. This is used to
 309  unregister the notification, using the syntax: ticket:unhook().
 310
 311 input(prompt, callback, [prefill])
 312  get input from user asynchronously with a callback.
 313  This call returns immediately, with a input line poped up. The input prompt
 314  is set to the first parameter and the buffer can be pre-filled with the third
 315  parameter. Once the input is done with an enter, the callback function is
 316  called with the inputed string to enable further process.
 317
 318  The input happens at the active canvas of the current display. If there is no
 319  current display input line appears in all canvas that shows the current
 320  layer. FIXME!!!
 321
 322 --------
 323 Events:
 324 --------
 325 cmdexecuted
 326 detached (display, is_remote)
 327
 328 For detach-events, it's not enough to just listen to 'cmdexecuted'
 329 command, since this command is not used for remote detaches. So
 330 scripts looking to do something on a detach event need to hook to
 331 this event, instead of hooking to 'cmdexecuted' event and looking
 332 for 'detach' command.
 333
 334 ===================
 335 The Implementation
 336 ===================
 337
 338 Bindings are in fact script interpretors. We can have several different
 339 language bindings at the same time, with each registered at the compiling time
 340 and loaded (initialized) dynamically at runtime. It's an bridge between
 341 scripts and screen itself.
 342
 343 ---------------
 344 Binding related.
 345 ---------------
 346
 347 ---------------
 348 Binding independent
 349 ---------------