| blob | a6defe01bc602d6817b06ec443451a7cb6dd4950 |
1 From: Uwe Lehnert <ulehnert@users.sourceforge.net>
2 Subject: pos <-> line, column macro subroutines
4 Within NEdit mailing list a built-in macro subroutine was requested, which
5 allows the conversion of line / column number to a related text buffer position.
7 Sometimes it may also of interest to convert a given position to a related line
8 / column number.
10 Attached patch implements 3 built-in macro subroutines which allow
11 position <-> line / column conversion:
13 1.) to_pos( [line-number] [, column-number] )
14 Convert given line number and column number to a text buffer position in current
15 window. Parameters of 'to_pos' follow the same syntax than parameters of
16 subroutine 'goto_line_number'.
18 2.) to_column( position )
19 Convert given position to column number in current window.
21 3.) to_line( position )
22 Convert given position to line number in current window.
24 ---
26 doc/help.etx | 14 +++
27 source/highlightData.c | 2
28 source/macro.c | 210 +++++++++++++++++++++++++++++++++++++++++++++++++
29 source/selection.c | 9 +-
30 4 files changed, 232 insertions(+), 3 deletions(-)
32 diff --quilt old/doc/help.etx new/doc/help.etx
33 --- old/doc/help.etx
34 +++ new/doc/help.etx
35 @@ -2908,6 +2908,20 @@ Macro Subroutines
36 **t_print( string1, string2, ... )**
37 Writes strings to the terminal (stdout) from which NEdit was started.
39 +**to_column( position )**
40 + Convert given position to column number in current window.
41 +
42 +**to_line( position )**
43 + Convert given position to line number in current window.
44 +
45 +**to_pos( [line-number] [, column-number] )**
46 + Convert given line number and column number to position in current
47 + window. Parameters of "to_pos" follow the same syntax than parameters
48 + of subroutine "goto_line_number".
49 + Examples: 'to_pos(10)' returns position of first character of line
50 + number 10; 'to_pos(",2")' or 'to_pos(-1, 2)' returns position of
51 + column number 2 of the line, where the cursor currently resides.
52 +
53 **tolower( string )**
54 Return an all lower-case version of string.
56 diff --quilt old/source/highlightData.c new/source/highlightData.c
57 --- old/source/highlightData.c
58 +++ new/source/highlightData.c
59 @@ -551,7 +551,7 @@ static char *DefaultPatternSets[] = {
60 Built-in Misc Vars:\"(?<!\\Y)\\$(?:active_pane|args|calltip_ID|column|cursor|display_width|empty_array|file_name|file_path|language_mode|line|locked|max_font_width|min_font_width|modified|n_display_lines|n_panes|rangeset_list|read_only|selection_(?:start|end|left|right)|server_name|text_length|top_line|transient|VERSION|NEDIT_HOME)>\":::Identifier::\n\
61 Built-in Pref Vars:\"(?<!\\Y)\\$(?:auto_indent|em_tab_dist|file_format|font_name|font_name_bold|font_name_bold_italic|font_name_italic|highlight_syntax|incremental_backup|incremental_search_line|make_backup_copy|match_syntax_based|overtype_mode|show_line_numbers|show_matching|statistics_line|tab_dist|use_tabs|wrap_margin|wrap_text)>\":::Identifier2::\n\
62 Built-in Special Vars:\"(?<!\\Y)\\$(?:[1-9]|list_dialog_button|n_args|read_status|search_end|shell_cmd_status|string_dialog_button|sub_sep)>\":::String1::\n\
63 - Built-in Subrs:\"<(?:args|append_file|beep|call|calltip|clipboard_to_string|define|dialog|filename_dialog|dict_(?:insert|complete|save|append|is_element)|focus_window|get_character|get_matching|get_pattern_(by_name|at_pos)|get_range|get_selection|get_style_(by_name|at_pos)|getenv|highlight_calltip_line|kill_calltip|length|list_dialog|max|min|n_args|rangeset_(?:add|create|destroy|get_by_name|includes|info|invert|range|set_color|set_mode|set_name|subtract)|read_file|replace_in_string|replace_range|replace_selection|replace_substring|search|search_string|select|select_rectangle|set_cursor_pos|set_transient|shell_command|split|string_compare|string_dialog|string_to_clipboard|substring|t_print|tolower|toupper|valid_number|write_file)(?=\\s*\\()\":::Subroutine::\n\
64 + Built-in Subrs:\"<(?:args|append_file|beep|call|calltip|clipboard_to_string|define|dialog|filename_dialog|dict_(?:insert|complete|save|append|is_element)|focus_window|get_character|get_matching|get_pattern_(by_name|at_pos)|get_range|get_selection|get_style_(by_name|at_pos)|getenv|highlight_calltip_line|kill_calltip|length|list_dialog|max|min|n_args|rangeset_(?:add|create|destroy|get_by_name|includes|info|invert|range|set_color|set_mode|set_name|subtract)|read_file|replace_in_string|replace_range|replace_selection|replace_substring|search|search_string|select|select_rectangle|set_cursor_pos|set_transient|shell_command|split|string_compare|string_dialog|string_to_clipboard|substring|t_print|to_(?:column|line|pos)|tolower|toupper|valid_number|write_file)(?=\\s*\\()\":::Subroutine::\n\
65 Menu Actions:\"<(?:new(?:_tab|_opposite)?|open|open-dialog|open_dialog|open-selected|open_selected|close|save|save-as|save_as|save-as-dialog|save_as_dialog|revert-to-saved|revert_to_saved|revert_to_saved_dialog|include-file|include_file|include-file-dialog|include_file_dialog|load-macro-file|load_macro_file|load-macro-file-dialog|load_macro_file_dialog|load-tags-file|load_tags_file|load-tags-file-dialog|load_tags_file_dialog|unload_tags_file|load_tips_file|load_tips_file_dialog|unload_tips_file|print|print-selection|print_selection|exit|undo|redo|delete|select-all|select_all|shift-left|shift_left|shift-left-by-tab|shift_left_by_tab|shift-right|shift_right|shift-right-by-tab|shift_right_by_tab|find|find-dialog|find_dialog|find-again|find_again|find-selection|find_selection|find_incremental|start_incremental_find|replace|replace-dialog|replace_dialog|replace-all|replace_all|replace-in-selection|replace_in_selection|replace-again|replace_again|replace_find|replace_find_same|replace_find_again|goto-line-number|goto_line_number|goto-line-number-dialog|goto_line_number_dialog|goto-selected|goto_selected|mark|mark-dialog|mark_dialog|goto-mark|goto_mark|goto-mark-dialog|goto_mark_dialog|match|select_to_matching|goto_matching|find-definition|find_definition|show_tip|split-pane|split_pane|close-pane|close_pane|detach_document(?:_dialog)?|move_document_dialog|(?:next|previous|last)_document|uppercase|lowercase|fill-paragraph|fill_paragraph|control-code-dialog|control_code_dialog|filter-selection-dialog|filter_selection_dialog|filter-selection|filter_selection|execute-command|execute_command|execute-command-dialog|execute_command_dialog|execute-command-line|execute_command_line|shell-menu-command|shell_menu_command|macro-menu-command|macro_menu_command|bg_menu_command|post_window_bg_menu|post_tab_context_menu|beginning-of-selection|beginning_of_selection|end-of-selection|end_of_selection|repeat_macro|repeat_dialog|raise_window|focus_pane|set_statistics_line|set_incremental_search_line|set_show_line_numbers|set_auto_indent|set_wrap_text|set_wrap_margin|set_highlight_syntax|set_make_backup_copy|set_incremental_backup|set_show_matching|set_match_syntax_based|set_overtype_mode|set_locked|set_tab_dist|set_em_tab_dist|set_use_tabs|set_fonts|set_language_mode)(?=\\s*\\()\":::Subroutine::\n\
66 Text Actions:\"<(?:self-insert|self_insert|grab-focus|grab_focus|extend-adjust|extend_adjust|extend-start|extend_start|extend-end|extend_end|secondary-adjust|secondary_adjust|secondary-or-drag-adjust|secondary_or_drag_adjust|secondary-start|secondary_start|secondary-or-drag-start|secondary_or_drag_start|process-bdrag|process_bdrag|move-destination|move_destination|move-to|move_to|move-to-or-end-drag|move_to_or_end_drag|end_drag|copy-to|copy_to|copy-to-or-end-drag|copy_to_or_end_drag|exchange|process-cancel|process_cancel|paste-clipboard|paste_clipboard|copy-clipboard|copy_clipboard|cut-clipboard|cut_clipboard|copy-primary|copy_primary|cut-primary|cut_primary|newline|newline-and-indent|newline_and_indent|newline-no-indent|newline_no_indent|delete-selection|delete_selection|delete-previous-character|delete_previous_character|delete-next-character|delete_next_character|delete-previous-word|delete_previous_word|delete-next-word|delete_next_word|delete-to-start-of-line|delete_to_start_of_line|delete-to-end-of-line|delete_to_end_of_line|forward-character|forward_character|backward-character|backward_character|key-select|key_select|process-up|process_up|process-down|process_down|process-shift-up|process_shift_up|process-shift-down|process_shift_down|process-home|process_home|forward-word|forward_word|backward-word|backward_word|forward-paragraph|forward_paragraph|backward-paragraph|backward_paragraph|beginning-of-line|beginning_of_line|end-of-line|end_of_line|beginning-of-file|beginning_of_file|end-of-file|end_of_file|next-page|next_page|previous-page|previous_page|page-left|page_left|page-right|page_right|toggle-overstrike|toggle_overstrike|scroll-up|scroll_up|scroll-down|scroll_down|scroll_left|scroll_right|scroll-to-line|scroll_to_line|select-all|select_all|deselect-all|deselect_all|focusIn|focusOut|process-return|process_return|process-tab|process_tab|insert-string|insert_string|mouse_pan)(?=\\s*\\()\":::Subroutine::\n\
67 Macro Hooks:\"<(?:(?:pre|post)_(?:open|save)|cursor_moved|modified|(?:losing_)?focus)_hook(?=\\s*\\()\":::Subroutine1::\n\
68 diff --quilt old/source/macro.c new/source/macro.c
69 --- old/source/macro.c
70 +++ new/source/macro.c
71 @@ -449,6 +449,17 @@ static int dictiselementMS(WindowInfo *w
72 static int defineMS(WindowInfo *window, DataValue *argList, int nArgs,
73 DataValue *result, char **errMsg);
75 +/*
76 + * UL convertPos patch:
77 + * add "to_pos", "to_line", "to_column" macro subroutines
78 + */
79 +static int toPosMS(WindowInfo *window, DataValue *argList, int nArgs,
80 + DataValue *result, char **errMsg);
81 +static int toLineMS(WindowInfo *window, DataValue *argList, int nArgs,
82 + DataValue *result, char **errMsg);
83 +static int toColumnMS(WindowInfo *window, DataValue *argList, int nArgs,
84 + DataValue *result, char **errMsg);
85 +
86 /* Built-in subroutines and variables for the macro language */
87 static const BuiltInSubrName MacroSubrs[] = {
88 { "args", argsMS },
89 @@ -518,6 +529,9 @@ static const BuiltInSubrName MacroSubrs[
90 { "dict_append", dictappendMS },
91 { "dict_is_element", dictiselementMS },
92 { "define", defineMS },
93 + { "to_pos", toPosMS },
94 + { "to_line", toLineMS },
95 + { "to_column", toColumnMS },
96 { NULL, NULL } /* sentinel */
97 };
99 @@ -6392,6 +6406,202 @@ static int dictcompleteMS(WindowInfo *wi
100 }
101 /* end of new macros for dictionary Christian Merkwirth 2000 */
103 +/*
104 +** UL convertPos patch:
105 +** translate given line / column parameter to text buffer position.
106 +*/
107 +static int toPosMS(WindowInfo *window, DataValue *argList, int nArgs,
108 + DataValue *result, char **errMsg)
109 +{
110 + char *lineStr, stringStorage1[TYPE_INT_STR_SIZE(int)];
111 + char *colStr , stringStorage2[TYPE_INT_STR_SIZE(int)];
112 + char *lineColString;
113 + char *allocStringBuf = NULL;
114 + int line, column, curCol;
115 + int pos;
116 + Widget w = window->lastFocus;
117 +
118 + /*
119 + * Get arguments and convert it to related cursor position
120 + */
121 + if (nArgs == 0)
122 + {
123 + *errMsg = "%s subroutine called with no arguments";
124 + return False;
125 + }
126 + else if (nArgs > 2)
127 + {
128 + return wrongNArgsErr(errMsg);
129 + }
130 + else if (nArgs == 1)
131 + {
132 + /*
133 + * 1 Argument: treat it as string to allow e.g. argument like
134 + * "line : column" (similar to goto_line_number).
135 + */
136 + if (!readStringArg(argList[0], &lineColString, stringStorage1, errMsg))
137 + return False;
138 + }
139 + else
140 + {
141 + /*
142 + * 2 Arguments: 1st holds line, 2nd holds column;
143 + * build arg. string of form "line, column" to cover negative
144 + * values, too (readIntArg doesn't allow negative values).
145 + */
146 + if (!readStringArg(argList[0], &lineStr, stringStorage1, errMsg))
147 + return False;
148 +
149 + if (!readStringArg(argList[1], &colStr, stringStorage2, errMsg))
150 + return False;
151 +
152 + allocStringBuf = XtMalloc(strlen(lineStr)+strlen(colStr)+3);
153 + lineColString = allocStringBuf;
154 +
155 + sprintf(lineColString, "%s, %s", lineStr, colStr);
156 + }
157 +
158 + if (StringToLineAndCol(lineColString, &line, &column) == -1)
159 + {
160 + *errMsg = "%s subroutine must hold valid line and/or column string";
161 + return False;
162 + }
163 +
164 + /*
165 + * Free eventually allocated buffer
166 + */
167 + if (allocStringBuf != NULL)
168 + XtFree(allocStringBuf);
169 +
170 + if (line == -1)
171 + {
172 + /*
173 + * User specified column, but not line number
174 + */
175 + pos = TextGetCursorPos(w);
176 + if (!TextPosToLineAndCol(w, pos, &line, &curCol))
177 + {
178 + /*
179 + * Should never occur
180 + */
181 + *errMsg = "current cursor position is not visible";
182 + return False;
183 + }
184 + }
185 + else if (column == -1)
186 + {
187 + /*
188 + * User didn't specify a column
189 + */
190 + column = 0;
191 + }
192 +
193 + pos = TextLineAndColToPos(w, line, column );
194 +
195 + /*
196 + * Return determined position
197 + */
198 + result->tag = INT_TAG;
199 + result->val.n = pos;
200 +
201 + return True;
202 +}
203 +
204 +/*
205 +** UL convertPos patch:
206 +** translate given text buffer position to line number.
207 +*/
208 +static int toLineMS(WindowInfo *window, DataValue *argList, int nArgs,
209 + DataValue *result, char **errMsg)
210 +{
211 + int line, column;
212 + int pos;
213 +
214 + /*
215 + * Get text buffer position argument
216 + */
217 + if (nArgs == 0)
218 + {
219 + *errMsg = "%s subroutine called with no arguments";
220 + return False;
221 + }
222 + else if (nArgs > 1)
223 + {
224 + return wrongNArgsErr(errMsg);
225 + }
226 +
227 + if (!readIntArg(argList[0], &pos, errMsg))
228 + {
229 + return False;
230 + }
231 +
232 + /*
233 + * Convert text buffer position to related line number
234 + */
235 + if (!TextPosToLineAndCol(window->lastFocus, pos, &line, &column))
236 + {
237 + line = BufCountLines(window->buffer, 0, pos) + 1;
238 + }
239 +
240 + /*
241 + * Return determined line number
242 + */
243 + result->tag = INT_TAG;
244 + result->val.n = line;
245 +
246 + return True;
247 +}
248 +
249 +/*
250 +** UL convertPos patch:
251 +** translate given text buffer position to column number.
252 +*/
253 +static int toColumnMS(WindowInfo *window, DataValue *argList, int nArgs,
254 + DataValue *result, char **errMsg)
255 +{
256 + int line, column;
257 + int pos;
258 + textBuffer *buf = window->buffer;
259 +
260 + /*
261 + * Get text buffer position argument
262 + */
263 + if (nArgs == 0)
264 + {
265 + *errMsg = "%s subroutine called with no arguments";
266 + return False;
267 + }
268 + else if (nArgs > 1)
269 + {
270 + return wrongNArgsErr(errMsg);
271 + }
272 +
273 + if (!readIntArg(argList[0], &pos, errMsg))
274 + {
275 + return False;
276 + }
277 +
278 + /*
279 + * Convert text buffer position to related column number
280 + */
281 + if (!TextPosToLineAndCol(window->lastFocus, pos, &line, &column))
282 + {
283 + column =
284 + BufCountDispChars(
285 + buf,
286 + BufStartOfLine(buf, pos),
287 + pos);
288 + }
289 +
290 + /*
291 + * Return determined line number
292 + */
293 + result->tag = INT_TAG;
294 + result->val.n = column;
295 +
296 + return True;
297 +}
298 +
299 static int wrongNArgsErr(char **errMsg)
300 {
301 *errMsg = "Wrong number of arguments to function %s";
302 diff --quilt old/source/selection.c new/source/selection.c
303 --- old/source/selection.c
304 +++ new/source/selection.c
305 @@ -101,9 +101,12 @@ int StringToLineAndCol(const char *text,
306 tempNum = strtol( text, &endptr, 10 );
308 /* If user didn't specify a line number, set lineNum to -1 */
309 +
310 + /* UL convertPos patch: negative values are interpreted as */
311 + /* not specified (i.s.o. line nbr. "0") */
312 if ( endptr == text ) { *lineNum = -1; }
313 else if ( tempNum >= INT_MAX ) { *lineNum = INT_MAX; }
314 - else if ( tempNum < 0 ) { *lineNum = 0; }
315 + else if ( tempNum < 0 ) { *lineNum = -1; }
316 else { *lineNum = tempNum; }
318 /* Find the next digit */
319 @@ -114,11 +117,13 @@ int StringToLineAndCol(const char *text,
320 }
321 }
323 + /* UL convertPos patch: negative values are interpreted as */
324 + /* not specified (i.s.o. column nbr. "0") */
325 /* Get column */
326 if ( *endptr != '\0' ) {
327 tempNum = strtol( endptr, NULL, 10 );
328 if ( tempNum >= INT_MAX ) { *column = INT_MAX; }
329 - else if ( tempNum < 0 ) { *column = 0; }
330 + else if ( tempNum < 0 ) { *column = -1; }
331 else { *column = tempNum; }
332 }
333 else { *column = -1; }