HACKING

   1 # Code structure
   2
   3 The plugin consists of a common and editor-specific part(s).
   4 An editor-specific part is expected to provide the common part
   5 with the following wrapper functions:
   6
   7  - read()
   8  - insert()
   9  - delete()
  10  - seek()
  11  - bol_at()
  12  - eol_at()
  13
  14 and map the functions exported by the common part to appropriate keys.
  15 The handler for self-inserting keys defined in `input.lua` is an exception,
  16 it must be bound to an appropriate event.
  17
  18 `parser.lua` is the only module where the file buffer is read().
  19 It parses the text incrementally (one top-level sexp at a time),
  20 and maintains a parse tree, which the rest of the plugin relies on
  21 for implementing the "business logic."
  22 For the incremental parsing to function correctly, the higher-level code
  23 that changes text is required to call rewind() to let the parser know
  24 of the earliest file offset involved in a change.
  25
  26 `walker.lua` contains helper functions for finding various positions
  27 in the parse tree maintained by `parser.lua`.
  28
  29 `edit.lua` contains functions for structure-aware editing actions.
  30
  31 `input.lua` contains the handler for self-inserting keys.