add-ed 0.9.0-alpha

Embeddable pure rust editor based on ED
Documentation 
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

//! Current error handling hack. Const strings for error messages.

// Relevant non-error consts
#[cfg(feature = "initial_input_data")]
pub const HELP_TEXT: &str = concat!(
"Application commands:\n",
"  q: Quit the editor. Warns on unsaved changes.\n",
"  Q: Force quit the editor.\n",
"  h: Print last occured error\n",
"  H: Toggle printing errors vs just noting there was an error\n",
"  help: Print this help text\n",
"  =: Print current selection\n",
"  #: Do nothing (start of comment)\n",
"File commands:\n",
"  f: Print current filepath; or set filepath if one is given\n",
"  e: Open given filepath for editing. If none given use current filepath. Warns\n",
"     on unsaved changes.\n",
"  E: Same as 'e' but unconditional (overwriting unsaved changes if any).",
"  r: Append contents from given filepath to current selection. If none given\n",
"     use current filepath.\n",
"  w: Write selection (default all) to given filepath. If none given use current\n",
"     filepath.\n",
"  W: Append selection to given filepath. If none given use current filepath.\n",
"Print commands:\n",
"  Most commands take flags p (print), n (numbered print), l (escaped print).\n",
"  (no command): Normal print by default. Also accepts print flags.\n",
"  z: Scroll (and print) given number of lines down from end of selection. \n",
"  Z: Scroll (and print) given number of lines up from start of selection. \n",
"Editing commands:\n",
"  a: Append lines entered after the command to selection. Stop line entry with\n",
"     lone '.' on a line.\n",
"  i: Same as 'a' but places lines before selection.\n",
"  c: Same as 'a' except it also cuts the selection into clipboard.\n",
"  A: Same as 'a', but joins the last input line with the line following the\n",
"     input (if any).\n",
"  I: Same as 'i', but joins the first input line with the line preceding the\n",
"     input (if any).\n",
"  C: Same as 'c', but the selection is copied into the input field, allowing\n",
"     direct modification.\n",
"  d: Cut the selection into clipboard.\n",
"  y: Copy the selection into clipboard.\n",
"  x/X: Append/prepend clipboard contents to selection.\n",
"  m: Move the selection to after index given after command.\n",
"  t: Copy the selection to after index given after command.\n",
"  j: Join the selection into one line. (only removes newlines)\n",
"Regex commands:\n",
"  s: Uses the first character as a separator between a regex matching pattern\n",
"     and a replacement string.\n",
"     If no arguments are given it re-uses the arguments given last execution.\n",
"  g: Uses the first character as a separator between a regex matching pattern\n",
"     and any number of commands. Flag 'I' gives case insensitive matching.\n",
"     If the line doesn't end with the separator it takes input until the\n",
"     separator is given alone on a line.\n",
"  G: Same as 'g' but only takes a pattern. The commands to run against each\n",
"     matching line are given upon each line. Flag 'I' gives case insensitive\n",
"     matching.",
"     Input is terminated by the separator alone on a line, just as 'g' if\n",
"     command line isn't separator terminated.\n",
"  v/V: Same as their 'g' counterparts except they invert the pattern.\n",
);
#[cfg(not(feature = "initial_input_data"))]
pub const HELP_TEXT: &str = concat!(
"Application commands:\n",
"  q: Quit the editor. Warns on unsaved changes.\n",
"  Q: Force quit the editor.\n",
"  h: Print last occured error\n",
"  H: Toggle printing errors vs just noting there was an error\n",
"  help: Print this help text\n",
"  =: Print current selection\n",
"  #: Do nothing (start of comment)\n",
"File commands:\n",
"  f: Print current filepath; or set filepath if one is given\n",
"  e: Open given filepath for editing. If none given use current filepath. Warns\n",
"     on unsaved changes.\n",
"  E: Same as 'e' but unconditional (overwriting unsaved changes if any).",
"  r: Append contents from given filepath to current selection. If none given\n",
"     use current filepath.\n",
"  w: Write selection (default all) to given filepath. If none given use current\n",
"     filepath.\n",
"  W: Append selection to given filepath. If none given use current filepath.\n",
"Print commands:\n",
"  Most commands take flags p (print), n (numbered print), l (escaped print).\n",
"  (no command): Normal print by default. Also accepts print flags.\n",
"  z: Scroll (and print) given number of lines down from end of selection. \n",
"  Z: Scroll (and print) given number of lines up from start of selection. \n",
"Editing commands:\n",
"  a: Append lines entered after the command to selection. Stop line entry with\n",
"     lone '.' on a line.\n",
"  i: Same as 'a' but places lines before selection.\n",
"  c: Same as 'a' except it also cuts the selection into clipboard.\n",
"  A: Same as 'a', but joins the last input line with the line following the\n",
"     input (if any).\n",
"  I: Same as 'i', but joins the first input line with the line preceding the\n",
"     input (if any).\n",
"  d: Cut the selection into clipboard.\n",
"  y: Copy the selection into clipboard.\n",
"  x/X: Append/prepend clipboard contents to selection.\n",
"  m: Move the selection to after index given after command.\n",
"  t: Copy the selection to after index given after command.\n",
"  j: Join the selection into one line. (only removes newlines)\n",
"Regex commands:\n",
"  s: Uses the first character as a separator between a regex matching pattern\n",
"     and a replacement string.\n",
"     If no arguments are given it re-uses the arguments given last execution.\n",
"  g: Uses the first character as a separator between a regex matching pattern\n",
"     and any number of commands. Flag 'I' gives case insensitive matching.\n",
"     If the line doesn't end with the separator it takes input until the\n",
"     separator is given alone on a line.\n",
"  G: Same as 'g' but only takes a pattern. The commands to run against each\n",
"     matching line are given upon each line. Flag 'I' gives case insensitive\n",
"     matching.",
"     Input is terminated by the separator alone on a line, just as 'g' if\n",
"     command line isn't separator terminated.\n",
"  v/V: Same as their 'g' counterparts except they invert the pattern.\n",
);

// Pre-command parsing errors
pub const INDEX_PARSE: &str = "Could not parse given index.";
pub const NO_COMMAND: &str = "No valid command given.";
pub const NO_SELECTION: &str = "No prior selection exists.";
pub const NEGATIVE_INDEX: &str = "Resulting index is negative.";

// Command handling errors
pub const UNDEFINED_COMMAND: &str = "Command not defined.";
pub const SELECTION_FORBIDDEN: &str = "That command doesn't take a selection.";
pub const UNSAVED_CHANGES: &str = "Unsaved changes. Force with the capitalised version of your command or save with 'w'.";
pub const NO_ERROR: &str = "No errors recorded.";
pub const NO_FILE: &str = "No file set.";

// Post-command parsing errors
pub const ESCAPED_LAST_EXPRESSION: &str = "Expression input ended with '\\'.";
pub const EXPRESSION_TOO_SHORT: &str = "Expression too short or not closed.";
pub const NO_PRIOR_S: &str = "'s' has not been run before, so no default exists.";
pub const UNDEFINED_FLAG: &str = "Unknown flag entered.";
pub const DUPLICATE_FLAG: &str = "A flag was entered twice.";
pub const INTEGER_PARSE: &str = "Could not parse argument as integer.";

// Buffer command errors
pub const BUFFER_NOT_IMPLEMENTED: &str = "Feature not implemented in buffer.";
pub const INVALID_LINENR0: &str = "Cannot operate on line 0.";
pub const INDEX_TOO_BIG: &str = "Cannot operate beyond buffer's end.";
pub const SELECTION_EMPTY: &str = "Selection empty or inverted.";
pub const MOVE_INTO_SELF: &str = "Cannot move selection into itself.";
pub const INVALID_TAG: &str = "Invalid line tag entered.";
pub const INVALID_REGEX: &str = "Invalid regex entered.";
pub const NO_MATCH: &str = "No line matched requirements.";

// File interaction errors
pub const PERMISSION_DENIED: &str = "Could not open file. Permission denied.";
pub const NOT_FOUND: &str = "Could not open file. Not found or invalid path.";
pub const UNKNOWN: &str = "Unknown error while reading file.";

// UI errors
pub const NO_INPUT: &str = "Failed to get input."; // Probably only used by DummyUI, which has limited input.
pub const ABORTED: &str = "Aborted. To close application use 'q'.";
#[cfg(feature = "initial_input_data")]
pub const UNSUPPORTED_INITIAL_DATA: &str = "Initial input data was given to UI input function that cannot handle it.";

// Terminal interaction errors
// No carriage returns, since only used through panic messages.
pub const TERMINAL_READ: &str = "Failed to read from terminal.";
pub const TERMINAL_WRITE: &str = "Failed to write to terminal.";
pub const DISABLE_RAWMODE: &str = "Failed to clear raw mode. Either restart terminal or run 'reset'. Good luck!";