vis.h

   1 #ifndef VIS_H
   2 #define VIS_H
   3
   4 #include <signal.h>
   5 #include <stddef.h>
   6 #include <stdbool.h>
   7
   8 typedef struct Vis Vis;
   9 typedef struct File File;
  10 typedef struct Win Win;
  11
  12 #include "ui.h"
  13 #include "view.h"
  14 #include "text-regex.h"
  15 #include "libutf.h"
  16 #include "array.h"
  17
  18 #ifndef CONFIG_HELP
  19 #define CONFIG_HELP 1
  20 #endif
  21
  22 #if CONFIG_HELP
  23 #define VIS_HELP_DECL(x) x
  24 #define VIS_HELP_USE(x) x
  25 #define VIS_HELP(x) (x),
  26 #else
  27 #define VIS_HELP_DECL(x)
  28 #define VIS_HELP_USE(x) NULL
  29 #define VIS_HELP(x)
  30 #endif
  31
  32 /* simplify utility renames by distribution packagers */
  33 #ifndef VIS_OPEN
  34 #define VIS_OPEN "vis-open"
  35 #endif
  36 #ifndef VIS_CLIPBOARD
  37 #define VIS_CLIPBOARD "vis-clipboard"
  38 #endif
  39
  40 /* maximum bytes needed for string representation of a (pseudo) key */
  41 #define VIS_KEY_LENGTH_MAX 64
  42
  43 /**
  44  * Editor event handlers.
  45  */
  46 typedef struct {
  47         void (*init)(Vis*);
  48         void (*start)(Vis*);
  49         void (*quit)(Vis*);
  50         void (*mode_insert_input)(Vis*, const char *key, size_t len);
  51         void (*mode_replace_input)(Vis*, const char *key, size_t len);
  52         void (*file_open)(Vis*, File*);
  53         bool (*file_save_pre)(Vis*, File*, const char *path);
  54         void (*file_save_post)(Vis*, File*, const char *path);
  55         void (*file_close)(Vis*, File*);
  56         void (*win_open)(Vis*, Win*);
  57         void (*win_close)(Vis*, Win*);
  58         void (*win_highlight)(Vis*, Win*);
  59         void (*win_status)(Vis*, Win*);
  60 } VisEvent;
  61
  62 /** Union used to pass arguments to key action functions. */
  63 typedef union {
  64         bool b;
  65         int i;
  66         const char *s;
  67         const void *v;
  68         void (*w)(View*);
  69         void (*f)(Vis*);
  70         Filerange (*combine)(const Filerange*, const Filerange*);
  71 } Arg;
  72
  73 /**
  74  * Key action handling function.
  75  * @param keys Input queue content *after* the binding which invoked this function.
  76  * @rst
  77  * .. note:: An empty string ``""`` indicates that no further input is available.
  78  * @endrst
  79  * @return Pointer to first non-cosumed key.
  80  * @rst
  81  * .. warning:: Must be in range ``[keys, keys+strlen(keys)]`` or ``NULL`` to
  82  *              indicate that not enough input was available. In the latter case
  83  *              the function will be called again once more input has been received.
  84  * @endrst
  85  * @ingroup vis_action
  86  */
  87 typedef const char *KeyActionFunction(Vis*, const char *keys, const Arg*);
  88
  89 /** Key action definition. */
  90 typedef struct {
  91         const char *name;                /**< Name of a pseudo key ``<name>`` which can be used in mappings. */
  92         VIS_HELP_DECL(const char *help;) /**< One line human readable description, displayed by ``:help``. */
  93         KeyActionFunction *func;         /**< Key action implementation function. */
  94         Arg arg;                         /**< Options passes as last argument to ``func``. */
  95 } KeyAction;
  96
  97 /**
  98  * A key binding, refers to an action or an alias
  99  * @rst
 100  * .. note:: Either ``action`` or ``alias`` must be ``NULL``.
 101  * @endrst
 102  */
 103 typedef struct {
 104         const char *key;         /**< Symbolic key to trigger this binding. */
 105         const KeyAction *action; /**< Action to invoke when triggering this binding. */
 106         const char *alias;       /**< Replaces ``key`` with ``alias`` at the front of the input queue. */
 107 } KeyBinding;
 108
 109 /**
 110  * @defgroup vis_lifecycle
 111  * @{
 112  */
 113 /** Create a new editor instance using the given user interface and event handlers. */
 114 Vis *vis_new(Ui*, VisEvent*);
 115 /** Free all resources associated with this editor instance, terminates UI. */
 116 void vis_free(Vis*);
 117 /**
 118  * Enter main loop, start processing user input.
 119  * @return The editor exit status code.
 120  */
 121 int vis_run(Vis*);
 122 /** Terminate editing session, the given ``status`` will be the return value of `vis_run`. */
 123 void vis_exit(Vis*, int status);
 124 /**
 125  * Emergency exit, print given message, perform minimal UI cleanup and exit process.
 126  * @rst
 127  * .. note:: This function does not return.
 128  * @endrst
 129  */
 130 void vis_die(Vis*, const char *msg, ...) __attribute__((noreturn,format(printf, 2, 3)));
 131
 132 /**
 133  * Temporarily supsend the editor process.
 134  * @rst
 135  * .. note:: This function will generate a ``SIGTSTP`` signal.
 136  * @endrst
 137  **/
 138 void vis_suspend(Vis*);
 139 /**
 140  * Resume editor process.
 141  * @rst
 142  * .. note:: This function is usually called in response to a ``SIGCONT`` signal.
 143  * @endrst
 144  */
 145 void vis_resume(Vis*);
 146 /**
 147  * Inform the editor core that a signal occured.
 148  * @return Whether the signal was handled.
 149  * @rst
 150  * .. note:: Being designed as a library the editor core does *not* register any
 151  *           signal handlers on its own.
 152  * .. note:: The remaining arguments match the prototype of ``sa_sigaction`` as
 153  *           specified in `sigaction(2)`.
 154  * @endrst
 155  */
 156 bool vis_signal_handler(Vis*, int signum, const siginfo_t *siginfo, const void *context);
 157 /**
 158  * Interrupt long running operation.
 159  * @rst
 160  * .. warning:: There is no guarantee that a long running operation is actually
 161  *              interrupted. It is analogous to cooperative multitasking where
 162  *              the operation has to voluntarily yield control.
 163  * .. note:: It is invoked from `vis_signal_handler` when receiving ``SIGINT``.
 164  * @endrst
 165  */
 166 void vis_interrupt(Vis*);
 167 /** Check whether interruption was requested. */
 168 bool vis_interrupt_requested(Vis*);
 169 /**
 170  * @}
 171  * @defgroup vis_draw
 172  * @{
 173  */
 174 /** Draw user interface. */
 175 void vis_draw(Vis*);
 176 /** Completely redraw user interface. */
 177 void vis_redraw(Vis*);
 178 /** Blit user interface state to output device. */
 179 void vis_update(Vis*);
 180 /**
 181  * @}
 182  * @defgroup vis_windows
 183  * @{
 184  */
 185 /**
 186  * Create a new window and load the given file.
 187  * @param filename If ``NULL`` a unamed, empty buffer is created.
 188  * @rst
 189  * .. note:: If the given file name is already opened in another window,
 190  *           the underlying File object is shared.
 191  * .. warning:: This duplication detection is currently based on normalized,
 192  *              absolute file names. TODO: compare inodes instead.
 193  * @endrst
 194  */
 195 bool vis_window_new(Vis*, const char *filename);
 196 /**
 197  * Create a new window associated with a file descriptor.
 198  * @rst
 199  * .. note:: No data is read from `fd`, but write commands without an
 200  *           explicit filename will instead write to the file descriptor.
 201  * @endrst
 202  */
 203 bool vis_window_new_fd(Vis*, int fd);
 204 /** Reload the file currently displayed in the window from disk. */
 205 bool vis_window_reload(Win*);
 206 /** Check whether closing the window would loose unsaved changes. */
 207 bool vis_window_closable(Win*);
 208 /** Close window, redraw user interface. */
 209 void vis_window_close(Win*);
 210 /** Split the window, shares the underlying file object. */
 211 bool vis_window_split(Win*);
 212 /** Change status message of this window. */
 213 void vis_window_status(Win*, const char *status);
 214 void vis_window_draw(Win*);
 215 void vis_window_invalidate(Win*);
 216 /** Focus next window. */
 217 void vis_window_next(Vis*);
 218 /** Focus previous window. */
 219 void vis_window_prev(Vis*);
 220 /** Change currently focused window, receiving user input. */
 221 void vis_window_focus(Win*);
 222 /** Swap location of two windows. */
 223 void vis_window_swap(Win*, Win*);
 224 /** Query window dimension. */
 225 int vis_window_width_get(const Win*);
 226 /** Query window dimension. */
 227 int vis_window_height_get(const Win*);
 228 /**
 229  * @}
 230  * @defgroup vis_info
 231  * @{
 232  */
 233 /**
 234  * Display a user prompt with a certain title.
 235  * @rst
 236  * .. note:: The prompt is currently implemented as a single line height window.
 237  * @endrst
 238  */
 239 void vis_prompt_show(Vis*, const char *title);
 240
 241 /**
 242  * Display a single line message.
 243  * @rst
 244  * .. note:: The message will automatically be hidden upon next input.
 245  * @endrst
 246  */
 247 void vis_info_show(Vis*, const char *msg, ...) __attribute__((format(printf, 2, 3)));
 248 /** Hide informational message. */
 249 void vis_info_hide(Vis*);
 250
 251 /** Display arbitrary long message in a dedicated window. */
 252 void vis_message_show(Vis*, const char *msg);
 253 /** Close message window. */
 254 void vis_message_hide(Vis*);
 255 /**
 256  * @}
 257  * @defgroup vis_changes
 258  * @{
 259  */
 260 void vis_insert(Vis*, size_t pos, const char *data, size_t len);
 261 void vis_delete(Vis*, size_t pos, size_t len);
 262 void vis_replace(Vis*, size_t pos, const char *data, size_t len);
 263 /** Perform insertion at all cursor positions. */
 264 void vis_insert_key(Vis*, const char *data, size_t len);
 265 /**
 266  * Perform character subsitution at all cursor positions.
 267  * @rst
 268  * .. note:: Does not replace new line characters.
 269  * @endrst
 270  */
 271 void vis_replace_key(Vis*, const char *data, size_t len);
 272 /**
 273  * Insert a tab at all cursor positions.
 274  * @rst
 275  * .. note:: Performs tab expansion according to current settings.
 276  * @endrst
 277  */
 278 void vis_insert_tab(Vis*);
 279 /**
 280  * Inserts a new line character at every cursor position.
 281  * @rst
 282  * .. note:: Performs auto indentation according to current settings.
 283  * @endrst
 284  */
 285 void vis_insert_nl(Vis*);
 286
 287 /** @} */
 288 /** Mode specifiers. */
 289 enum VisMode {
 290         VIS_MODE_NORMAL,
 291         VIS_MODE_OPERATOR_PENDING,
 292         VIS_MODE_VISUAL,
 293         VIS_MODE_VISUAL_LINE, /**< Sub mode of `VIS_MODE_VISUAL`. */
 294         VIS_MODE_INSERT,
 295         VIS_MODE_REPLACE, /**< Sub mode of `VIS_MODE_INSERT`. */
 296         VIS_MODE_INVALID,
 297 };
 298
 299 /**
 300  * @defgroup vis_modes
 301  * @{
 302  */
 303 /**
 304  * Switch mode.
 305  * @rst
 306  * .. note:: Will first trigger the leave event of the currently active
 307  *           mode, followed by an enter event of the new mode.
 308  *           No events are emitted, if the specified mode is already active.
 309  * @endrst
 310  */
 311 void vis_mode_switch(Vis*, enum VisMode);
 312 /** Get currently active mode. */
 313 enum VisMode vis_mode_get(Vis*);
 314 /** Translate human readable mode name to constant. */
 315 enum VisMode vis_mode_from(Vis*, const char *name);
 316
 317 /**
 318  * @}
 319  * @defgroup vis_keybind
 320  * @{
 321  */
 322 KeyBinding *vis_binding_new(Vis*);
 323 void vis_binding_free(Vis*, KeyBinding*);
 324
 325 /**
 326  * Set up a key binding.
 327  * @param force Whether an existing mapping should be discarded.
 328  * @param key The symbolic key to map.
 329  * @param binding The binding to map.
 330  * @rst
 331  * .. note:: ``binding->key`` is always ignored in favor of ``key``.
 332  * @endrst
 333  */
 334 bool vis_mode_map(Vis*, enum VisMode, bool force, const char *key, const KeyBinding*);
 335 /** Analogous to `vis_mode_map`, but window specific. */
 336 bool vis_window_mode_map(Win*, enum VisMode, bool force, const char *key, const KeyBinding*);
 337 /** Unmap a symbolic key in a given mode. */
 338 bool vis_mode_unmap(Vis*, enum VisMode, const char *key);
 339 /** Analogous to `vis_mode_unmap`, but window specific. */
 340 bool vis_window_mode_unmap(Win*, enum VisMode, const char *key);
 341 /**
 342  * @}
 343  * @defgroup vis_action
 344  * @{
 345  */
 346 /**
 347  * Create new key action.
 348  * @param name The name to be used as symbolic key when registering.
 349  * @param help Optional single line help text.
 350  * @param func The function implementing the key action logic.
 351  * @param arg Argument passed to function.
 352  */
 353 KeyAction *vis_action_new(Vis*, const char *name, const char *help, KeyActionFunction*, Arg);
 354 void vis_action_free(Vis*, KeyAction*);
 355 /**
 356  * Register key action.
 357  * @rst
 358  * .. note:: Makes the key action available under the pseudo key name specified
 359  *           in ``keyaction->name``.
 360  * @endrst
 361  */
 362 bool vis_action_register(Vis*, const KeyAction*);
 363
 364 /**
 365  * @}
 366  * @defgroup vis_keymap
 367  * @{
 368  */
 369
 370 /** Add a key translation. */
 371 bool vis_keymap_add(Vis*, const char *key, const char *mapping);
 372 /** Temporarily disable the keymap for the next key press. */
 373 void vis_keymap_disable(Vis*);
 374
 375 /** @} */
 376 /** Operator specifiers. */
 377 enum VisOperator {
 378         VIS_OP_DELETE,
 379         VIS_OP_CHANGE,
 380         VIS_OP_YANK,
 381         VIS_OP_PUT_AFTER,
 382         VIS_OP_SHIFT_RIGHT,
 383         VIS_OP_SHIFT_LEFT,
 384         VIS_OP_JOIN,
 385         VIS_OP_MODESWITCH,
 386         VIS_OP_REPLACE,
 387         VIS_OP_CURSOR_SOL,
 388         VIS_OP_INVALID, /* denotes the end of the "real" operators */
 389         /* pseudo operators: keep them at the end to save space in array definition */
 390         VIS_OP_CURSOR_EOL,
 391         VIS_OP_PUT_AFTER_END,
 392         VIS_OP_PUT_BEFORE,
 393         VIS_OP_PUT_BEFORE_END,
 394         VIS_OP_LAST, /* has to be last enum member */
 395 };
 396
 397 /**
 398  * @defgroup vis_operators
 399  * @{
 400  */
 401 typedef struct OperatorContext OperatorContext;
 402
 403 /**
 404  * An operator performs a certain function on a given text range.
 405  * @rst
 406  * .. note:: The operator must return the new cursor position or ``EPOS`` if
 407  *           the cursor should be disposed.
 408  * .. note:: The last used operator can be repeated using `vis_repeat`.
 409  * @endrst
 410  */
 411 typedef size_t (VisOperatorFunction)(Vis*, Text*, OperatorContext*);
 412
 413 /**
 414  * Register an operator.
 415  * @return Operator ID. Negative values indicate an error, positive ones can be
 416  *         used with `vis_operator`.
 417  */
 418 int vis_operator_register(Vis*, VisOperatorFunction*, void *context);
 419
 420 /**
 421  * Set operator to execute.
 422  *
 423  * Has immediate effect if:
 424  *  - A visual mode is active.
 425  *  - The same operator was already set (range will be the current line).
 426  *
 427  * Otherwise the operator will be executed on the range determinded by:
 428  *  - A motion (see `vis_motion`).
 429  *  - A text object (`vis_textobject`).
 430  *
 431  * The expected varying arguments are:
 432  *
 433  *  - `VIS_OP_JOIN`       a char pointer referring to the text to insert between lines.
 434  *  - `VIS_OP_MODESWITCH` an ``enum VisMode`` indicating the mode to switch to.
 435  *  - `VIS_OP_REPLACE`    a char pointer reffering to the replacement character.
 436  */
 437 bool vis_operator(Vis*, enum VisOperator, ...);
 438
 439 /** Repeat last operator, possibly with a new count if one was provided in the meantime. */
 440 void vis_repeat(Vis*);
 441
 442 /** Cancel pending operator, reset count, motion, text object, register etc. */
 443 void vis_cancel(Vis*);
 444
 445 /** @} */
 446 /** Motion specifiers. */
 447 enum VisMotion {
 448         VIS_MOVE_LINE_DOWN,
 449         VIS_MOVE_LINE_UP,
 450         VIS_MOVE_SCREEN_LINE_UP,
 451         VIS_MOVE_SCREEN_LINE_DOWN,
 452         VIS_MOVE_SCREEN_LINE_BEGIN,
 453         VIS_MOVE_SCREEN_LINE_MIDDLE,
 454         VIS_MOVE_SCREEN_LINE_END,
 455         VIS_MOVE_LINE_PREV,
 456         VIS_MOVE_LINE_BEGIN,
 457         VIS_MOVE_LINE_START,
 458         VIS_MOVE_LINE_FINISH,
 459         VIS_MOVE_LINE_LASTCHAR,
 460         VIS_MOVE_LINE_END,
 461         VIS_MOVE_LINE_NEXT,
 462         VIS_MOVE_LINE,
 463         VIS_MOVE_COLUMN,
 464         VIS_MOVE_CHAR_PREV,
 465         VIS_MOVE_CHAR_NEXT,
 466         VIS_MOVE_LINE_CHAR_PREV,
 467         VIS_MOVE_LINE_CHAR_NEXT,
 468         VIS_MOVE_CODEPOINT_PREV,
 469         VIS_MOVE_CODEPOINT_NEXT,
 470         VIS_MOVE_WORD_NEXT,
 471         VIS_MOVE_WORD_START_NEXT,
 472         VIS_MOVE_WORD_END_PREV,
 473         VIS_MOVE_WORD_END_NEXT,
 474         VIS_MOVE_WORD_START_PREV,
 475         VIS_MOVE_LONGWORD_NEXT,
 476         VIS_MOVE_LONGWORD_START_PREV,
 477         VIS_MOVE_LONGWORD_START_NEXT,
 478         VIS_MOVE_LONGWORD_END_PREV,
 479         VIS_MOVE_LONGWORD_END_NEXT,
 480         VIS_MOVE_SENTENCE_PREV,
 481         VIS_MOVE_SENTENCE_NEXT,
 482         VIS_MOVE_PARAGRAPH_PREV,
 483         VIS_MOVE_PARAGRAPH_NEXT,
 484         VIS_MOVE_FUNCTION_START_PREV,
 485         VIS_MOVE_FUNCTION_START_NEXT,
 486         VIS_MOVE_FUNCTION_END_PREV,
 487         VIS_MOVE_FUNCTION_END_NEXT,
 488         VIS_MOVE_BLOCK_START,
 489         VIS_MOVE_BLOCK_END,
 490         VIS_MOVE_PARENTHESIS_START,
 491         VIS_MOVE_PARENTHESIS_END,
 492         VIS_MOVE_BRACKET_MATCH,
 493         VIS_MOVE_LEFT_TO,
 494         VIS_MOVE_RIGHT_TO,
 495         VIS_MOVE_LEFT_TILL,
 496         VIS_MOVE_RIGHT_TILL,
 497         VIS_MOVE_FILE_BEGIN,
 498         VIS_MOVE_FILE_END,
 499         VIS_MOVE_SEARCH_WORD_FORWARD,
 500         VIS_MOVE_SEARCH_WORD_BACKWARD,
 501         VIS_MOVE_SEARCH_REPEAT_FORWARD,
 502         VIS_MOVE_SEARCH_REPEAT_BACKWARD,
 503         VIS_MOVE_WINDOW_LINE_TOP,
 504         VIS_MOVE_WINDOW_LINE_MIDDLE,
 505         VIS_MOVE_WINDOW_LINE_BOTTOM,
 506         VIS_MOVE_CHANGELIST_NEXT,
 507         VIS_MOVE_CHANGELIST_PREV,
 508         VIS_MOVE_NOP,
 509         VIS_MOVE_PERCENT,
 510         VIS_MOVE_BYTE,
 511         VIS_MOVE_BYTE_LEFT,
 512         VIS_MOVE_BYTE_RIGHT,
 513         VIS_MOVE_INVALID, /* denotes the end of the "real" motions */
 514         /* pseudo motions: keep them at the end to save space in array definition */
 515         VIS_MOVE_TOTILL_REPEAT,
 516         VIS_MOVE_TOTILL_REVERSE,
 517         VIS_MOVE_SEARCH_FORWARD,
 518         VIS_MOVE_SEARCH_BACKWARD,
 519         VIS_MOVE_SEARCH_REPEAT,
 520         VIS_MOVE_SEARCH_REPEAT_REVERSE,
 521         VIS_MOVE_LAST, /* denotes the end of all motions */
 522 };
 523
 524 /**
 525  * @defgroup vis_motions
 526  * @{
 527  */
 528 /**
 529  * Set motion to perform.
 530  *
 531  * The following motions take an additional argument:
 532  *
 533  *  - `VIS_MOVE_SEARCH_FORWARD` and `VIS_MOVE_SEARCH_BACKWARD`
 534  *
 535  *     The search pattern as ``const char *``.
 536  *
 537  *  - ``VIS_MOVE_{LEFT,RIGHT}_{TO,TILL}``
 538  *
 539  *     The character to search for as ``const char *``.
 540  */
 541 bool vis_motion(Vis*, enum VisMotion, ...);
 542
 543 enum VisMotionType {
 544         VIS_MOTIONTYPE_LINEWISE  = 1 << 0,
 545         VIS_MOTIONTYPE_CHARWISE  = 1 << 1,
 546 };
 547
 548 /** Force currently specified motion to behave in line or character wise mode. */
 549 void vis_motion_type(Vis *vis, enum VisMotionType);
 550
 551 /**
 552  * Motions take a starting position and transform it to an end position.
 553  * @rst
 554  * .. note:: Should a motion not be possible, the original position must be returned.
 555  *           TODO: we might want to change that to ``EPOS``?
 556  * @endrst
 557  */
 558 typedef size_t (VisMotionFunction)(Vis*, Win*, void *context, size_t pos);
 559
 560 /**
 561  * Register a motion function.
 562  * @return Motion ID. Negative values indicate an error, positive ones can be
 563  *         used with `vis_motion`.
 564  */
 565 int vis_motion_register(Vis*, void *context, VisMotionFunction*);
 566
 567 /**
 568  * @}
 569  * @defgroup vis_count
 570  * @{
 571  */
 572 /** No count was specified. */
 573 #define VIS_COUNT_UNKNOWN (-1)
 574 /** Get count, might return `VIS_COUNT_UNKNOWN`. */
 575 int vis_count_get(Vis*);
 576 /** Get count, if none was specified, return ``def``. */
 577 int vis_count_get_default(Vis*, int def);
 578 /** Set a count. */
 579 void vis_count_set(Vis*, int count);
 580
 581 typedef struct {
 582         Vis *vis;
 583         int iteration;
 584         int count;
 585 } VisCountIterator;
 586
 587 /** Get iterator initialized with current count or ``def`` if not specified. */
 588 VisCountIterator vis_count_iterator_get(Vis*, int def);
 589 /** Get iterator initialized with a count value. */
 590 VisCountIterator vis_count_iterator_init(Vis*, int count);
 591 /**
 592  * Increment iterator counter.
 593  * @return Whether iteration should continue.
 594  * @rst
 595  * .. note:: Terminates iteration if the edtior was
 596  *           `interrupted <vis_interrupt>`_ in the meantime.
 597  * @endrst
 598  */
 599 bool vis_count_iterator_next(VisCountIterator*);
 600
 601 /** @} */
 602 /** Text object specifier. */
 603 enum VisTextObject {
 604         VIS_TEXTOBJECT_INNER_WORD,
 605         VIS_TEXTOBJECT_OUTER_WORD,
 606         VIS_TEXTOBJECT_INNER_LONGWORD,
 607         VIS_TEXTOBJECT_OUTER_LONGWORD,
 608         VIS_TEXTOBJECT_SENTENCE,
 609         VIS_TEXTOBJECT_PARAGRAPH,
 610         VIS_TEXTOBJECT_PARAGRAPH_OUTER,
 611         VIS_TEXTOBJECT_OUTER_SQUARE_BRACKET,
 612         VIS_TEXTOBJECT_INNER_SQUARE_BRACKET,
 613         VIS_TEXTOBJECT_OUTER_CURLY_BRACKET,
 614         VIS_TEXTOBJECT_INNER_CURLY_BRACKET,
 615         VIS_TEXTOBJECT_OUTER_ANGLE_BRACKET,
 616         VIS_TEXTOBJECT_INNER_ANGLE_BRACKET,
 617         VIS_TEXTOBJECT_OUTER_PARENTHESIS,
 618         VIS_TEXTOBJECT_INNER_PARENTHESIS,
 619         VIS_TEXTOBJECT_OUTER_QUOTE,
 620         VIS_TEXTOBJECT_INNER_QUOTE,
 621         VIS_TEXTOBJECT_OUTER_SINGLE_QUOTE,
 622         VIS_TEXTOBJECT_INNER_SINGLE_QUOTE,
 623         VIS_TEXTOBJECT_OUTER_BACKTICK,
 624         VIS_TEXTOBJECT_INNER_BACKTICK,
 625         VIS_TEXTOBJECT_OUTER_LINE,
 626         VIS_TEXTOBJECT_INNER_LINE,
 627         VIS_TEXTOBJECT_INDENTATION,
 628         VIS_TEXTOBJECT_SEARCH_FORWARD,
 629         VIS_TEXTOBJECT_SEARCH_BACKWARD,
 630         VIS_TEXTOBJECT_INVALID,
 631 };
 632
 633 /**
 634  * @defgroup vis_textobjs
 635  * @{
 636  */
 637
 638 /**
 639  * Text objects take a starting position and return a text range.
 640  * @rst
 641  * .. note:: The originating position does not necessarily have to be contained in
 642  *           the resulting range.
 643  * @endrst
 644  */
 645 typedef Filerange (VisTextObjectFunction)(Vis*, Win*, void *context, size_t pos);
 646
 647 /**
 648  * Register a new text object.
 649  * @return Text object ID. Negative values indicate an error, positive ones can be
 650  *         used with `vis_textobject`.
 651  */
 652 int vis_textobject_register(Vis*, int type, void *data, VisTextObjectFunction*);
 653
 654 /** Set text object to use. */
 655 bool vis_textobject(Vis*, enum VisTextObject);
 656
 657 /** @} */
 658 /** Mark specifiers. */
 659 enum VisMark {
 660         VIS_MARK_DEFAULT,
 661         VIS_MARK_SELECTION,
 662         VIS_MARK_a, VIS_MARK_b, VIS_MARK_c, VIS_MARK_d, VIS_MARK_e,
 663         VIS_MARK_f, VIS_MARK_g, VIS_MARK_h, VIS_MARK_i, VIS_MARK_j,
 664         VIS_MARK_k, VIS_MARK_l, VIS_MARK_m, VIS_MARK_n, VIS_MARK_o,
 665         VIS_MARK_p, VIS_MARK_q, VIS_MARK_r, VIS_MARK_s, VIS_MARK_t,
 666         VIS_MARK_u, VIS_MARK_v, VIS_MARK_w, VIS_MARK_x, VIS_MARK_y,
 667         VIS_MARK_z,
 668         VIS_MARK_INVALID,     /* has to be the last enum member */
 669 };
 670
 671 /**
 672  * @}
 673  * @defgroup vis_marks
 674  * @{
 675  */
 676 /** Translate between single character mark name and corresponding constant. */
 677 enum VisMark vis_mark_from(Vis*, char mark);
 678 char vis_mark_to(Vis*, enum VisMark);
 679 /**
 680  * Specify mark to use.
 681  * @rst
 682  * .. note:: If none is specified `VIS_MARK_DEFAULT` will be used.
 683  * @endrst
 684  */
 685 void vis_mark(Vis*, enum VisMark);
 686 enum VisMark vis_mark_used(Vis*);
 687 /**
 688  * Store a set of ``Filerange``s in a mark.
 689  *
 690  * @param id The register to use.
 691  * @param sel The array containing the file ranges.
 692  */
 693 void vis_mark_set(Win*, enum VisMark id, Array *sel);
 694 /**
 695  * Get an array of file ranges stored in the mark.
 696  *
 697  * @rst
 698  * .. warning:: The caller must eventually free the Array by calling
 699  *              ``array_release``.
 700  * @endrst
 701  */
 702 Array vis_mark_get(Win*, enum VisMark id);
 703 /**
 704  * Normalize an Array of Fileranges.
 705  *
 706  * Removes invalid ranges, merges overlapping ones and sorts
 707  * according to the start position.
 708  */
 709 void vis_mark_normalize(Array*);
 710 /** Add selections of focused window to jump list. */
 711 bool vis_jumplist_save(Vis*);
 712 /** Navigate jump list backwards. */
 713 bool vis_jumplist_prev(Vis*);
 714 /** Navigate jump list forwards. */
 715 bool vis_jumplist_next(Vis*);
 716 /** @} */
 717 /** Register specifiers. */
 718 enum VisRegister {
 719         VIS_REG_DEFAULT,    /* used when no other register is specified */
 720         VIS_REG_ZERO,       /* yank register */
 721         VIS_REG_AMPERSAND,  /* last regex match */
 722         VIS_REG_1,          /* 1-9 last sub-expression matches */
 723         VIS_REG_2,
 724         VIS_REG_3,
 725         VIS_REG_4,
 726         VIS_REG_5,
 727         VIS_REG_6,
 728         VIS_REG_7,
 729         VIS_REG_8,
 730         VIS_REG_9,
 731         VIS_REG_BLACKHOLE,  /* /dev/null register */
 732         VIS_REG_CLIPBOARD,  /* system clipboard register */
 733         VIS_REG_PRIMARY,    /* system primary clipboard register */
 734         VIS_REG_DOT,        /* last inserted text, copy of VIS_MACRO_OPERATOR */
 735         VIS_REG_SEARCH,     /* last used search pattern "/ */
 736         VIS_REG_COMMAND,    /* last used :-command ": */
 737         VIS_REG_SHELL,      /* last used shell command given to either <, >, |, or ! */
 738         VIS_REG_NUMBER,     /* cursor number */
 739         VIS_REG_a, VIS_REG_b, VIS_REG_c, VIS_REG_d, VIS_REG_e,
 740         VIS_REG_f, VIS_REG_g, VIS_REG_h, VIS_REG_i, VIS_REG_j,
 741         VIS_REG_k, VIS_REG_l, VIS_REG_m, VIS_REG_n, VIS_REG_o,
 742         VIS_REG_p, VIS_REG_q, VIS_REG_r, VIS_REG_s, VIS_REG_t,
 743         VIS_REG_u, VIS_REG_v, VIS_REG_w, VIS_REG_x, VIS_REG_y,
 744         VIS_REG_z,
 745         VIS_MACRO_OPERATOR, /* records entered keys after an operator */
 746         VIS_REG_PROMPT, /* internal register which shadows DEFAULT in PROMPT mode */
 747         VIS_REG_INVALID, /* has to be the last 'real' register */
 748         VIS_REG_A, VIS_REG_B, VIS_REG_C, VIS_REG_D, VIS_REG_E,
 749         VIS_REG_F, VIS_REG_G, VIS_REG_H, VIS_REG_I, VIS_REG_J,
 750         VIS_REG_K, VIS_REG_L, VIS_REG_M, VIS_REG_N, VIS_REG_O,
 751         VIS_REG_P, VIS_REG_Q, VIS_REG_R, VIS_REG_S, VIS_REG_T,
 752         VIS_REG_U, VIS_REG_V, VIS_REG_W, VIS_REG_X, VIS_REG_Y,
 753         VIS_REG_Z,
 754         VIS_MACRO_LAST_RECORDED, /* pseudo macro referring to last recorded one */
 755 };
 756
 757 /**
 758  * @defgroup vis_registers
 759  * @{
 760  */
 761 /** Translate between single character register name and corresponding constant. */
 762 enum VisRegister vis_register_from(Vis*, char reg);
 763 char vis_register_to(Vis*, enum VisRegister);
 764 /**
 765  * Specify register to use.
 766  * @rst
 767  * .. note:: If none is specified `VIS_REG_DEFAULT` will be used.
 768  * @endrst
 769  */
 770 void vis_register(Vis*, enum VisRegister);
 771 enum VisRegister vis_register_used(Vis*);
 772 /**
 773  * Get register content.
 774  * @return An array of ``TextString`` structs.
 775  * @rst
 776  * .. warning:: The caller must eventually free the array ressources using
 777  *              ``array_release``.
 778  * @endrst
 779  */
 780 Array vis_register_get(Vis*, enum VisRegister);
 781 /**
 782  * Set register content.
 783  * @param data The array comprised of ``TextString`` structs.
 784  */
 785 bool vis_register_set(Vis*, enum VisRegister, Array *data);
 786 /**
 787  * @}
 788  * @defgroup vis_macros
 789  * @{
 790  */
 791 /**
 792  * Start recording a macro.
 793  * @rst
 794  * .. note:: Fails if a recording is already ongoing.
 795  * @endrst
 796  */
 797 bool vis_macro_record(Vis*, enum VisRegister);
 798 /** Stop recording, fails if there is nothing to stop. */
 799 bool vis_macro_record_stop(Vis*);
 800 /** Check whether a recording is currently ongoing. */
 801 bool vis_macro_recording(Vis*);
 802 /**
 803  * Replay a macro.
 804  * @rst
 805  * .. note:: A macro currently being recorded can not be replayed.
 806  * @endrst
 807  */
 808 bool vis_macro_replay(Vis*, enum VisRegister);
 809
 810 /**
 811  * @}
 812  * @defgroup vis_cmds
 813  * @{
 814  */
 815
 816 /** Execute a ``:``-command. */
 817 bool vis_cmd(Vis*, const char *cmd);
 818
 819 /** Command handler function. */
 820 typedef bool (VisCommandFunction)(Vis*, Win*, void *data, bool force,
 821         const char *argv[], Selection*, Filerange*);
 822 /**
 823  * Register new ``:``-command.
 824  * @param name The command name.
 825  * @param help Optional single line help text.
 826  * @param context User supplied context pointer passed to the handler function.
 827  * @param func The function implementing the command logic.
 828  * @rst
 829  * .. note:: Any unique prefix of the command name will invoke the command.
 830  * @endrst
 831  */
 832 bool vis_cmd_register(Vis*, const char *name, const char *help, void *context, VisCommandFunction*);
 833
 834 /** Unregister ``:``-command. */
 835 bool vis_cmd_unregister(Vis*, const char *name);
 836
 837 /**
 838  * @}
 839  * @defgroup vis_options
 840  * @{
 841  */
 842 /** Option properties. */
 843 enum VisOption {
 844         VIS_OPTION_TYPE_BOOL = 1 << 0,
 845         VIS_OPTION_TYPE_STRING = 1 << 1,
 846         VIS_OPTION_TYPE_NUMBER = 1 << 2,
 847         VIS_OPTION_VALUE_OPTIONAL = 1 << 3,
 848         VIS_OPTION_NEED_WINDOW = 1 << 4,
 849 };
 850
 851 /**
 852  * Option handler function.
 853  * @param win The window to which option should apply, might be ``NULL``.
 854  * @param context User provided context pointer as given to `vis_option_register`.
 855  * @param force Whether the option was specfied with a bang ``!``.
 856  * @param name Name of option which was set.
 857  * @param arg The new option value.
 858  */
 859 typedef bool (VisOptionFunction)(Vis*, Win*, void *context, bool toggle,
 860                                  enum VisOption, const char *name, Arg *value);
 861
 862 /**
 863  * Register a new ``:set`` option.
 864  * @param names A ``NULL`` terminated array of option names.
 865  * @param option Option properties.
 866  * @param func The function handling the option.
 867  * @param context User supplied context pointer passed to the handler function.
 868  * @param help Optional single line help text.
 869  * @rst
 870  * .. note:: Fails if any of the given option names is already registered.
 871  * @endrst
 872  */
 873 bool vis_option_register(Vis*, const char *names[], enum VisOption,
 874                          VisOptionFunction*, void *context, const char *help);
 875 /**
 876  * Unregister an existing ``:set`` option.
 877  * @rst
 878  * .. note:: Also unregisters all aliases as given to `vis_option_register`.
 879  * @endrst
 880  */
 881 bool vis_option_unregister(Vis*, const char *name);
 882
 883 /** Execute any kind (``:``, ``?``, ``/``) of prompt command */
 884 bool vis_prompt_cmd(Vis*, const char *cmd);
 885
 886 /**
 887  * Pipe a given file range to an external process.
 888  *
 889  * If the range is invalid 'interactive' mode is enabled, meaning that
 890  * stdin and stderr are passed through the underlying command, stdout
 891  * points to vis' stderr.
 892  *
 893  * If ``argv`` contains only one non-NULL element the command is executed
 894  * through an intermediate shell (using ``/bin/sh -c argv[0]``) that is
 895  * argument expansion is performed by the shell. Otherwise the argument
 896  * list will be passed unmodified to ``execvp(argv[0], argv)``.
 897  *
 898  * If the ``read_stdout`` and ``read_stderr`` callbacks are non-NULL they
 899  * will be invoked when output from the forked process is available.
 900  *
 901  * @rst
 902  * .. warning:: The editor core is blocked until this function returns.
 903  * @endrst
 904  *
 905  * @return The exit status of the forked process.
 906  */
 907 int vis_pipe(Vis*, File*, Filerange*, const char *argv[],
 908         void *stdout_context, ssize_t (*read_stdout)(void *stdout_context, char *data, size_t len),
 909         void *stderr_context, ssize_t (*read_stderr)(void *stderr_context, char *data, size_t len));
 910
 911 /**
 912  * Pipe a Filerange to an external process, return its exit status and capture
 913  * everything that is written to stdout/stderr.
 914  * @param argv Argument list, must be ``NULL`` terminated.
 915  * @param out Data written to ``stdout``, will be ``NUL`` terminated.
 916  * @param err Data written to ``stderr``, will be ``NUL`` terminated.
 917  * @rst
 918  * .. warning:: The pointers stored in ``out`` and ``err`` need to be `free(3)`-ed
 919  *              by the caller.
 920  * @endrst
 921  */
 922 int vis_pipe_collect(Vis*, File*, Filerange*, const char *argv[], char **out, char **err);
 923
 924 /**
 925  * @}
 926  * @defgroup vis_keys
 927  * @{
 928  */
 929 /**
 930  * Advance to the start of the next symbolic key.
 931  *
 932  * Given the start of a symbolic key, returns a pointer to the start of the one
 933  * immediately following it.
 934  */
 935 const char *vis_keys_next(Vis*, const char *keys);
 936 /** Convert next symbolic key to an Unicode code point, returns ``-1`` for unknown keys. */
 937 long vis_keys_codepoint(Vis*, const char *keys);
 938 /**
 939  * Convert next symbolic key to a UTF-8 sequence.
 940  * @return Whether conversion was successful, if not ``utf8`` is left unmodified.
 941  * @rst
 942  * .. note:: Guarantees that ``utf8`` is NUL terminated on success.
 943  * @endrst
 944  */
 945 bool vis_keys_utf8(Vis*, const char *keys, char utf8[static UTFmax+1]);
 946 /** Process symbolic keys as if they were user originated input. */
 947 void vis_keys_feed(Vis*, const char *keys);
 948 /**
 949  * @}
 950  * @defgroup vis_misc
 951  * @{
 952  */
 953
 954 /**
 955  * Get a regex object matching pattern.
 956  * @param regex The regex pattern to compile, if ``NULL`` the most recently used
 957  *        one is substituted.
 958  * @return A Regex object or ``NULL`` in case of an error.
 959  * @rst
 960  * .. warning:: The caller must free the regex object using `text_regex_free`.
 961  * @endrst
 962  */
 963 Regex *vis_regex(Vis*, const char *pattern);
 964
 965 /**
 966  * Take an undo snaphost to which we can later revert to.
 967  * @rst
 968  * .. note:: Does nothing when invoked while replaying a macro.
 969  * @endrst
 970  */
 971 void vis_file_snapshot(Vis*, File*);
 972 /** @} */
 973
 974 /* TODO: expose proper API to iterate through files etc */
 975 Text *vis_text(Vis*);
 976 View *vis_view(Vis*);
 977 Win *vis_window(Vis*);
 978
 979 /* Get value of autoindent */
 980 bool vis_get_autoindent(const Vis*);
 981
 982 #endif