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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
#pragma once
#include <stdbool.h>
#include <stddef.h>
#include "nvim/api/private/defs.h"
#include "nvim/cmdexpand_defs.h"
#include "nvim/regexp_defs.h"
#include "nvim/types_defs.h"
/// Option value type
typedef enum {
kOptValTypeNil = 0,
kOptValTypeBoolean,
kOptValTypeNumber,
kOptValTypeString,
} OptValType;
typedef union {
// boolean options are actually tri-states because they have a third "None" value.
TriState boolean;
OptInt number;
String string;
} OptValData;
typedef struct {
OptValType type;
OptValData data;
} OptVal;
/// :set operator types
typedef enum {
OP_NONE = 0,
OP_ADDING, ///< "opt+=arg"
OP_PREPENDING, ///< "opt^=arg"
OP_REMOVING, ///< "opt-=arg"
} set_op_T;
/// Argument for the callback function (opt_did_set_cb_T) invoked after an
/// option value is modified.
typedef struct {
/// Pointer to the option variable. The variable can be an OptInt (numeric
/// option), an int (boolean option) or a char pointer (string option).
void *os_varp;
int os_idx;
int os_flags;
/// Old value of the option.
OptValData os_oldval;
/// New value of the option.
OptValData os_newval;
/// Option value was checked to be safe, no need to set P_INSECURE
/// Used for the 'keymap', 'filetype' and 'syntax' options.
bool os_value_checked;
/// Option value changed. Used for the 'filetype' and 'syntax' options.
bool os_value_changed;
/// Used by the 'isident', 'iskeyword', 'isprint' and 'isfname' options.
/// Set to true if the character table is modified when processing the
/// option and need to be restored because of a failure.
bool os_restore_chartab;
/// If the value specified for an option is not valid and the error message
/// is parameterized, then the "os_errbuf" buffer is used to store the error
/// message (when it is not NULL).
char *os_errbuf;
size_t os_errbuflen;
void *os_win;
void *os_buf;
} optset_T;
/// Type for the callback function that is invoked after an option value is
/// changed to validate and apply the new value.
///
/// Returns NULL if the option value is valid and successfully applied.
/// Otherwise returns an error message.
typedef const char *(*opt_did_set_cb_T)(optset_T *args);
/// Argument for the callback function (opt_expand_cb_T) invoked after a string
/// option value is expanded for cmdline completion.
typedef struct {
/// Pointer to the option variable. It's always a string.
char *oe_varp;
/// The original option value, escaped.
char *oe_opt_value;
/// true if using set+= instead of set=
bool oe_append;
/// true if we would like to add the original option value as the first choice.
bool oe_include_orig_val;
/// Regex from the cmdline, for matching potential options against.
regmatch_T *oe_regmatch;
/// The expansion context.
expand_T *oe_xp;
/// The full argument passed to :set. For example, if the user inputs
/// ":set dip=icase,algorithm:my<Tab>", oe_xp->xp_pattern will only have
/// "my", but oe_set_arg will contain the whole "icase,algorithm:my".
char *oe_set_arg;
} optexpand_T;
/// Type for the callback function that is invoked when expanding possible
/// string option values during cmdline completion.
///
/// Strings in returned matches will be managed and freed by caller.
///
/// Returns OK if the expansion succeeded (numMatches and matches have to be
/// set). Otherwise returns FAIL.
///
/// Note: If returned FAIL or *numMatches is 0, *matches will NOT be freed by
/// caller.
typedef int (*opt_expand_cb_T)(optexpand_T *args, int *numMatches, char ***matches);
/// Requested option scopes for various functions in option.c
typedef enum {
kOptReqGlobal = 0, ///< Request global option value
kOptReqWin = 1, ///< Request window-local option value
kOptReqBuf = 2, ///< Request buffer-local option value
} OptReqScope;
|
