| blob | e94f5271a3512d582dcaba8b296d0caf78938624 |
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/built-ins.h | 3
28 source/highlightData.c | 2
29 source/macro.c | 196 +++++++++++++++++++++++++++++++++++++++++++++++++
30 source/selection.c | 9 +-
31 5 files changed, 221 insertions(+), 3 deletions(-)
33 diff --quilt old/doc/help.etx new/doc/help.etx
34 --- old/doc/help.etx
35 +++ new/doc/help.etx
36 @@ -2908,6 +2908,20 @@ Macro Subroutines
37 **t_print( string1, string2, ... )**
38 Writes strings to the terminal (stdout) from which NEdit was started.
40 +**to_column( position )**
41 + Convert given position to column number in current window.
42 +
43 +**to_line( position )**
44 + Convert given position to line number in current window.
45 +
46 +**to_pos( [line-number] [, column-number] )**
47 + Convert given line number and column number to position in current
48 + window. Parameters of "to_pos" follow the same syntax than parameters
49 + of subroutine "goto_line_number".
50 + Examples: 'to_pos(10)' returns position of first character of line
51 + number 10; 'to_pos(",2")' or 'to_pos(-1, 2)' returns position of
52 + column number 2 of the line, where the cursor currently resides.
53 +
54 **tolower( string )**
55 Return an all lower-case version of string.
57 diff --quilt old/source/highlightData.c new/source/highlightData.c
58 --- old/source/highlightData.c
59 +++ new/source/highlightData.c
60 @@ -551,7 +551,7 @@ static char *DefaultPatternSets[] = {
61 Built-in Misc Vars:\"(?<!\\Y)\\$(?:active_pane|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\
62 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\
63 Built-in Special Vars:\"(?<!\\Y)\\$(?:args|[1-9]|list_dialog_button|n_args|read_status|search_end|shell_cmd_status|string_dialog_button|sub_sep)>\":::String1::\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|tolower|toupper|valid_number|write_file)(?=\\s*\\()\":::Subroutine::\n\
65 + 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\
66 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\
67 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\
68 Macro Hooks:\"<(?:(?:pre|post)_(?:open|save)|cursor_moved|modified|(?:losing_)?focus)_hook(?=\\s*\\()\":::Subroutine1::\n\
69 diff --quilt old/source/macro.c new/source/macro.c
70 --- old/source/macro.c
71 +++ new/source/macro.c
72 @@ -6056,6 +6056,202 @@ static int dictcompleteMS(WindowInfo *wi
73 }
74 /* end of new macros for dictionary Christian Merkwirth 2000 */
76 +/*
77 +** UL convertPos patch:
78 +** translate given line / column parameter to text buffer position.
79 +*/
80 +static int toPosMS(WindowInfo *window, DataValue *argList, int nArgs,
81 + DataValue *result, char **errMsg)
82 +{
83 + char *lineStr, stringStorage1[TYPE_INT_STR_SIZE(int)];
84 + char *colStr , stringStorage2[TYPE_INT_STR_SIZE(int)];
85 + char *lineColString;
86 + char *allocStringBuf = NULL;
87 + int line, column, curCol;
88 + int pos;
89 + Widget w = window->lastFocus;
90 +
91 + /*
92 + * Get arguments and convert it to related cursor position
93 + */
94 + if (nArgs == 0)
95 + {
96 + *errMsg = "%s subroutine called with no arguments";
97 + return False;
98 + }
99 + else if (nArgs > 2)
100 + {
101 + return wrongNArgsErr(errMsg);
102 + }
103 + else if (nArgs == 1)
104 + {
105 + /*
106 + * 1 Argument: treat it as string to allow e.g. argument like
107 + * "line : column" (similar to goto_line_number).
108 + */
109 + if (!readStringArg(argList[0], &lineColString, stringStorage1, errMsg))
110 + return False;
111 + }
112 + else
113 + {
114 + /*
115 + * 2 Arguments: 1st holds line, 2nd holds column;
116 + * build arg. string of form "line, column" to cover negative
117 + * values, too (readIntArg doesn't allow negative values).
118 + */
119 + if (!readStringArg(argList[0], &lineStr, stringStorage1, errMsg))
120 + return False;
121 +
122 + if (!readStringArg(argList[1], &colStr, stringStorage2, errMsg))
123 + return False;
124 +
125 + allocStringBuf = XtMalloc(strlen(lineStr)+strlen(colStr)+3);
126 + lineColString = allocStringBuf;
127 +
128 + sprintf(lineColString, "%s, %s", lineStr, colStr);
129 + }
130 +
131 + if (StringToLineAndCol(lineColString, &line, &column) == -1)
132 + {
133 + *errMsg = "%s subroutine must hold valid line and/or column string";
134 + return False;
135 + }
136 +
137 + /*
138 + * Free eventually allocated buffer
139 + */
140 + if (allocStringBuf != NULL)
141 + XtFree(allocStringBuf);
142 +
143 + if (line == -1)
144 + {
145 + /*
146 + * User specified column, but not line number
147 + */
148 + pos = TextGetCursorPos(w);
149 + if (!TextPosToLineAndCol(w, pos, &line, &curCol))
150 + {
151 + /*
152 + * Should never occur
153 + */
154 + *errMsg = "current cursor position is not visible";
155 + return False;
156 + }
157 + }
158 + else if (column == -1)
159 + {
160 + /*
161 + * User didn't specify a column
162 + */
163 + column = 0;
164 + }
165 +
166 + pos = TextLineAndColToPos(w, line, column );
167 +
168 + /*
169 + * Return determined position
170 + */
171 + result->tag = INT_TAG;
172 + result->val.n = pos;
173 +
174 + return True;
175 +}
176 +
177 +/*
178 +** UL convertPos patch:
179 +** translate given text buffer position to line number.
180 +*/
181 +static int toLineMS(WindowInfo *window, DataValue *argList, int nArgs,
182 + DataValue *result, char **errMsg)
183 +{
184 + int line, column;
185 + int pos;
186 +
187 + /*
188 + * Get text buffer position argument
189 + */
190 + if (nArgs == 0)
191 + {
192 + *errMsg = "%s subroutine called with no arguments";
193 + return False;
194 + }
195 + else if (nArgs > 1)
196 + {
197 + return wrongNArgsErr(errMsg);
198 + }
199 +
200 + if (!readIntArg(argList[0], &pos, errMsg))
201 + {
202 + return False;
203 + }
204 +
205 + /*
206 + * Convert text buffer position to related line number
207 + */
208 + if (!TextPosToLineAndCol(window->lastFocus, pos, &line, &column))
209 + {
210 + line = BufCountLines(window->buffer, 0, pos) + 1;
211 + }
212 +
213 + /*
214 + * Return determined line number
215 + */
216 + result->tag = INT_TAG;
217 + result->val.n = line;
218 +
219 + return True;
220 +}
221 +
222 +/*
223 +** UL convertPos patch:
224 +** translate given text buffer position to column number.
225 +*/
226 +static int toColumnMS(WindowInfo *window, DataValue *argList, int nArgs,
227 + DataValue *result, char **errMsg)
228 +{
229 + int line, column;
230 + int pos;
231 + textBuffer *buf = window->buffer;
232 +
233 + /*
234 + * Get text buffer position argument
235 + */
236 + if (nArgs == 0)
237 + {
238 + *errMsg = "%s subroutine called with no arguments";
239 + return False;
240 + }
241 + else if (nArgs > 1)
242 + {
243 + return wrongNArgsErr(errMsg);
244 + }
245 +
246 + if (!readIntArg(argList[0], &pos, errMsg))
247 + {
248 + return False;
249 + }
250 +
251 + /*
252 + * Convert text buffer position to related column number
253 + */
254 + if (!TextPosToLineAndCol(window->lastFocus, pos, &line, &column))
255 + {
256 + column =
257 + BufCountDispChars(
258 + buf,
259 + BufStartOfLine(buf, pos),
260 + pos);
261 + }
262 +
263 + /*
264 + * Return determined line number
265 + */
266 + result->tag = INT_TAG;
267 + result->val.n = column;
268 +
269 + return True;
270 +}
271 +
272 static int wrongNArgsErr(char **errMsg)
273 {
274 *errMsg = "Wrong number of arguments to function %s";
275 diff --quilt old/source/selection.c new/source/selection.c
276 --- old/source/selection.c
277 +++ new/source/selection.c
278 @@ -101,9 +101,12 @@ int StringToLineAndCol(const char *text,
279 tempNum = strtol( text, &endptr, 10 );
281 /* If user didn't specify a line number, set lineNum to -1 */
282 +
283 + /* UL convertPos patch: negative values are interpreted as */
284 + /* not specified (i.s.o. line nbr. "0") */
285 if ( endptr == text ) { *lineNum = -1; }
286 else if ( tempNum >= INT_MAX ) { *lineNum = INT_MAX; }
287 - else if ( tempNum < 0 ) { *lineNum = 0; }
288 + else if ( tempNum < 0 ) { *lineNum = -1; }
289 else { *lineNum = tempNum; }
291 /* Find the next digit */
292 @@ -114,11 +117,13 @@ int StringToLineAndCol(const char *text,
293 }
294 }
296 + /* UL convertPos patch: negative values are interpreted as */
297 + /* not specified (i.s.o. column nbr. "0") */
298 /* Get column */
299 if ( *endptr != '\0' ) {
300 tempNum = strtol( endptr, NULL, 10 );
301 if ( tempNum >= INT_MAX ) { *column = INT_MAX; }
302 - else if ( tempNum < 0 ) { *column = 0; }
303 + else if ( tempNum < 0 ) { *column = -1; }
304 else { *column = tempNum; }
305 }
306 else { *column = -1; }
307 diff --quilt old/source/built-ins.h new/source/built-ins.h
308 --- old/source/built-ins.h
309 +++ new/source/built-ins.h
310 @@ -69,6 +69,9 @@ MS(dict_save, dictsave)
311 MS(dict_append, dictappend)
312 MS(dict_is_element, dictiselement)
313 MS(define, define)
314 +MS(to_pos, toPos)
315 +MS(to_line, toLine)
316 +MS(to_column, toColumn)
318 MV(cursor, cursor)
319 MV(line, line)