aboutsummaryrefslogtreecommitdiff
path: root/src/nvim/normal.h
blob: 8e15e909d4f47f007b1194834a40e5f314444b80 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
#ifndef NVIM_NORMAL_H
#define NVIM_NORMAL_H

#include <stdbool.h>
#include "nvim/pos.h"
#include "nvim/buffer_defs.h"  // for win_T

/* Values for find_ident_under_cursor() */
#define FIND_IDENT      1       /* find identifier (word) */
#define FIND_STRING     2       /* find any string (WORD) */
#define FIND_EVAL       4       /* include "->", "[]" and "." */

/// Motion types, used for operators and for yank/delete registers.
///
/// The three valid numerical values must not be changed, as they
/// are used in external communication and serialization.
typedef enum {
  kMTCharWise = 0,     ///< character-wise movement/register
  kMTLineWise = 1,     ///< line-wise movement/register
  kMTBlockWise = 2,    ///< block-wise movement/register
  kMTUnknown = -1      ///< Unknown or invalid motion type
} MotionType;

/*
 * Arguments for operators.
 */
typedef struct oparg_S {
  int op_type;                  // current pending operator type
  int regname;                  // register to use for the operator
  MotionType motion_type;       // type of the current cursor motion
  int motion_force;             // force motion type: 'v', 'V' or CTRL-V
  bool use_reg_one;             // true if delete uses reg 1 even when not
                                // linewise
  bool inclusive;               // true if char motion is inclusive (only
                                // valid when motion_type is kMTCharWise)
  bool end_adjusted;            // backuped b_op_end one char (only used by
                                // do_format())
  pos_T start;                  // start of the operator
  pos_T end;                    // end of the operator
  pos_T cursor_start;           // cursor position before motion for "gw"

  long line_count;              // number of lines from op_start to op_end
                                // (inclusive)
  bool empty;                   // op_start and op_end the same (only used by
                                // op_change())
  bool is_VIsual;               // operator on Visual area
  colnr_T start_vcol;           // start col for block mode operator
  colnr_T end_vcol;             // end col for block mode operator
  long prev_opcount;            // ca.opcount saved for K_EVENT
  long prev_count0;             // ca.count0 saved for K_EVENT
  bool excl_tr_ws;              // exclude trailing whitespace for yank of a
                                // block
} oparg_T;

/*
 * Arguments for Normal mode commands.
 */
typedef struct cmdarg_S {
  oparg_T     *oap;             /* Operator arguments */
  int prechar;                  /* prefix character (optional, always 'g') */
  int cmdchar;                  /* command character */
  int nchar;                    /* next command character (optional) */
  int ncharC1;                  /* first composing character (optional) */
  int ncharC2;                  /* second composing character (optional) */
  int extra_char;               /* yet another character (optional) */
  long opcount;                 /* count before an operator */
  long count0;                  /* count before command, default 0 */
  long count1;                  /* count before command, default 1 */
  int arg;                      /* extra argument from nv_cmds[] */
  int retval;                   /* return: CA_* values */
  char_u      *searchbuf;       /* return: pointer to search pattern or NULL */
} cmdarg_T;

/* values for retval: */
#define CA_COMMAND_BUSY     1   /* skip restarting edit() once */
#define CA_NO_ADJ_OP_END    2   /* don't adjust operator end */


#ifdef INCLUDE_GENERATED_DECLARATIONS
# include "normal.h.generated.h"
#endif
#endif  // NVIM_NORMAL_H