Updated architecture drawing.

Author: jonathanslenders

docs/pages/architecture.rst

@@ -12,30 +12,37 @@ Architecture
  | and control characters. Calls the corresponding |
  | handlers of the `InputStreamHandel` instance. |
  | |
- | e.g. Translate '\x1b[6~' into "page_down", call the |
- | `page_down` function of `InputStreamHandler` |
+ | e.g. Translate '\x1b[6~' into "Keys.PageDown", call |
+ | the `feed_key` method of `InputProcessor`.  |
  +---------------------------------------------------------------+
  |
  v
  +---------------------------------------------------------------+
  | InputStreamHandler |
  | ================== |
- | - Implements keybindings for control keys, arrow |
- | movement, escape, etc... There are two classes |
- | inheriting from this, which implement more |
- | specific key bindings. |
- | * `EmacsInputStreamHandler` |
- | * `ViInputStreamHandler` |
- | Keybindings are implemented as operations of the |
- | `Line` object. |
+ | - Has a `Registry` of key bindings, it calls the |
+ | bindings according to the received keys and the |
+ | input mode. |
  | |
- | e.g. 'ctrl_t' calls the |
- | `swap_characters_before_cursor` method of |
- | the `Line` object. |
+ | We have Vi and Emacs bindings.
  +---------------------------------------------------------------+
  |
  v
  +---------------------------------------------------------------+
+ | Key bindings |
+ | ============ |
+ | - Every key binding consists of a function that |
+ | receives an `Event` and usually it operates on |
+ | the `Line` object. (It could insert data or move |
+ | the cursor for example.) |
+ +---------------------------------------------------------------+
+ |
+ | Most of the key bindings operate on a `Line` object, but
+ | they don't have to. They could also change the visibility
+ | of a menu for instance, or change the color scheme.
+ |
+ v
+ +---------------------------------------------------------------+
  | Line |
  | ==== |
  | - Contains a data structure to hold the current |
@@ -55,46 +62,33 @@ Architecture
  | +-----------------------------------------------+ |
  +---------------------------------------------------------------+
  |
- | `Line` creates a `RenderContext` instance which holds the
- | information to visualise the command line. This is passed
- | to the `Renderer` object. (Passing this object happens at
- | various places.)
- |
- | +---------------+ +-------------------------------+
- | | RenderContext | | Prompt |
- | | ============= | --> | ====== |
- | | | | - Responsible for the |
- | | | | "prompt" (The leading text |
- | | | | before the actual input.) |
- | | | | |
- | | | | Further it actually also |
- | | | | implements the trailing |
- | | | | text, which could be a |
- | | | | context sentsitive help |
- | | | | text. |
- | | | +-------------------------------+
- | | |
- | | | +-------------------------------+
- | | | -> | Code |
- | | | | ==== |
- | | | | - Implements the semantics |
- | | | | of the command line. This |
- | | | | are two major things: |
- | | | | |
- | | | | * tokenizing the input |
- | | | | for highlighting. |
- | | | | * Autocompletion |
- | +---------------+ +-------------------------------+
+ | Normally after every key press, the output will be
+ | rendered again. This happens in the event loop of
+ | the `CommandLineInterface` where `Renderer.render` is
+ | called.
+ v
+ +---------------------------------------------------------------+
+ | Layout |
+ | ====== |
+ | - When the renderer should redraw, the renderer |
+ | asks the layout what the output should look like. |
+ | - The layout operates on a `Screen` object that he |
+ | received from the `Renderer` and will put the |
+ | toolbars, menus, highlighted content and prompt |
+ | in place. |
+ | |
+ | +-----------------------------------------------+ |
+ | | Menus, toolbars, prompt | |
+ | | ======================= | |
+ | | | |
+ | +-----------------------------------------------+ |
+ +---------------------------------------------------------------+
  |
- | The methods from `Prompt` and `Code` which are meant for
- | the renderer return a list of (Token, text) tuples, where
- | `Token` is a Pygments token.
  v
  +---------------------------------------------------------------+
  | Renderer |
  | ======== |
- | - Responsible for painting the (Token, text) tuples |
- | to the terminal output. |
+ | - Calculates the difference between the last output |
+ | and the new one and writes it to the terminal |
+ | output. |
  +---------------------------------------------------------------+
-
-