| blob | 2ec5a2de2d0f85c9bc7c7656afb5defcb9fbf858 |
1 Subject: timer_add()/timer_remove() macros
3 This adds two new macro subroutines for handling timeouts.
5 **timer_add( func_name, timeout [, "global"] )**
6 Install a new timer that call the macro routine ~func_name~ after ~timeout~
7 milli seconds. The function is only called if the top window is the same as
8 the window from which ~timer_add()~ was called, this can be overriden with the
9 optional ~"global"~ parameter. The macro returns a timer ID which can be used
10 to remove a timer before expiration with ~timer_remove()~.
12 **timer_remove( timer_ID )**
13 Removes the timer with ID ~timer_ID~.
15 There can be a problem on LP64 architectures, the nedit macro language have
16 only int support but the XtIntervalId is defined as unsigned long, so there
17 can be domain error, I try to catch this error.
19 ---
21 doc/help.etx | 10 +++
22 source/built-ins.h | 2
23 source/highlightData.c | 2
24 source/macro.c | 161 +++++++++++++++++++++++++++++++++++++++++++++++++
25 4 files changed, 174 insertions(+), 1 deletion(-)
27 diff --quilt old/source/macro.c new/source/macro.c
28 --- old/source/macro.c
29 +++ new/source/macro.c
30 @@ -3516,6 +3516,167 @@ static int setWindowTitleMS(WindowInfo *
31 return True;
32 }
34 +typedef struct _TimerProcData {
35 + struct _TimerProcData *next;
36 + XtIntervalId id;
37 + WindowInfo *window;
38 + int global;
39 + char name[1];
40 +} TimerProcData;
41 +
42 +static TimerProcData *allTimerProcData;
43 +
44 +static void macroTimerProc(XtPointer clientData, XtIntervalId *id)
45 +{
46 + TimerProcData *data = clientData, **s;
47 + WindowInfo *win;
48 +
49 + s = &allTimerProcData;
50 + while (*s) {
51 + if ((*s)->id == data->id) {
52 + *s = data->next;
53 + break;
54 + }
55 + s = &(*s)->next;
56 + }
57 +
58 + /* check if window is still there, but don't trust the pointer */
59 + for (win = WindowList; win; win = win->next) {
60 + if (win == data->window) {
61 + break;
62 + }
63 + }
64 + if (win != data->window) {
65 + goto out;
66 + }
67 +
68 + if (*id != data->id) {
69 + goto out;
70 + }
71 +
72 + /* don't call macro if its not a global timer and current top-window is
73 + different from timer_add() window */
74 + if (!data->global && !IsTopDocument(data->window)) {
75 + goto out;
76 + }
77 +
78 + MacroApplyHook(data->window, data->name, 0, NULL, NULL);
79 +
80 +out:
81 + XtFree((char *)data);
82 +}
83 +
84 +/*
85 + * timer_ID = timer_add(macro_name, timeout[, "global"])
86 + */
87 +static int timerAddMS(WindowInfo *window, DataValue *argList, int nArgs,
88 + DataValue *result, char **errMsg)
89 +{
90 + int timeout;
91 + char stringStorage[2][TYPE_INT_STR_SIZE(int)];
92 + char *name = NULL;
93 + int is_global = 0;
94 + char *global;
95 + TimerProcData *data;
96 +
97 + if (nArgs < 2 || nArgs > 3) {
98 + return wrongNArgsErr(errMsg);
99 + }
100 + if (!readStringArg(argList[0], &name, stringStorage[0], errMsg)) {
101 + return False;
102 + }
103 + if (!readIntArg(argList[1], &timeout, errMsg)) {
104 + return False;
105 + }
106 + if (nArgs >= 3) {
107 + if(!readStringArg(argList[2], &global, stringStorage[1], errMsg)) {
108 + return False;
109 + }
110 + if (!strcmp(global, "global")) {
111 + is_global = 1;
112 + } else {
113 + *errMsg = "unknown argument for subroutine %s";
114 + return False;
115 + }
116 + }
117 +
118 + if (timeout < 100) {
119 + *errMsg = "timeout too small";
120 + return False;
121 + }
122 +
123 + /* terminating NIL is already in struct */
124 + data = (TimerProcData *)XtMalloc(sizeof(*data) +
125 + (strlen(name) * sizeof(char)));
126 + if (!data) {
127 + *errMsg = "internal error";
128 + return False;
129 + }
130 +
131 + data->window = window;
132 + data->global = is_global;
133 + strcpy(data->name, name);
134 +
135 + data->next = allTimerProcData;
136 + allTimerProcData = data;
137 +
138 + data->id = XtAppAddTimeOut(XtWidgetToApplicationContext(window->shell),
139 + timeout, macroTimerProc, data);
140 +
141 + result->tag = INT_TAG;
142 + if (data->id != (XtIntervalId)(int)data->id) {
143 + *errMsg = "warning: can't convert from XtIntervalId to int, timer not removable";
144 + result->val.n = 0;
145 + } else {
146 + result->val.n = data->id;
147 + }
148 +
149 + return True;
150 +}
151 +
152 +/*
153 + * timer_remove(timer_ID)
154 + */
155 +static int timerRemoveMS(WindowInfo *window, DataValue *argList, int nArgs,
156 + DataValue *result, char **errMsg)
157 +{
158 + int timerid;
159 + XtIntervalId id;
160 + TimerProcData *data, **s;
161 +
162 + if (nArgs != 1) {
163 + return wrongNArgsErr(errMsg);
164 + }
165 + if (!readIntArg(argList[0], &timerid, errMsg)) {
166 + return False;
167 + }
168 +
169 + if (0 == timerid) {
170 + /* we return 0 as timerid when we can't convert the id to int
171 + the timer can therefore not removed and the TimerProcData is freed
172 + when the timer is fired
173 + */
174 + return True;
175 + }
176 +
177 + id = timerid;
178 +
179 + XtRemoveTimeOut(id);
180 +
181 + s = &allTimerProcData;
182 + while (*s) {
183 + if ((*s)->id == id) {
184 + data = *s;
185 + *s = data->next;
186 + XtFree((char *)data);
187 + break;
188 + }
189 + s = &(*s)->next;
190 + }
191 +
192 + return True;
193 +}
194 +
195 /* T Balinski */
196 static int listDialogMS(WindowInfo *window, DataValue *argList, int nArgs,
197 DataValue *result, char **errMsg)
198 diff --quilt old/source/highlightData.c new/source/highlightData.c
199 --- old/source/highlightData.c
200 +++ new/source/highlightData.c
201 @@ -551,7 +551,7 @@ static char *DefaultPatternSets[] = {
202 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\
203 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\
204 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\
205 - 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|set_window_title|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\
206 + 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|set_window_title|shell_command|split|string_compare|string_dialog|string_to_clipboard|substring|t_print|timer_(?:add|remove)|to_(?:column|line|pos)|tolower|toupper|valid_number|write_file)(?=\\s*\\()\":::Subroutine::\n\
207 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\
208 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\
209 Macro Hooks:\"<(?:(?:pre|post)_(?:open|save)|cursor_moved|modified|(?:losing_)?focus)_hook(?=\\s*\\()\":::Subroutine1::\n\
210 diff --quilt old/doc/help.etx new/doc/help.etx
211 --- old/doc/help.etx
212 +++ new/doc/help.etx
213 @@ -2908,6 +2908,16 @@ Macro Subroutines
214 **t_print( string1, string2, ... )**
215 Writes strings to the terminal (stdout) from which NEdit was started.
217 +**timer_add( func_name, timeout [, "global"] )**
218 + Install a new timer that call the macro routine ~func_name~ after ~timeout~
219 + milli seconds. The function is only called if the top window is the same as
220 + the window from which ~timer_add()~ was called, this can be overriden with the
221 + optional ~"global"~ parameter. The macro returns a timer ID which can be used
222 + to remove a timer before expiration with ~timer_remove()~.
223 +
224 +**timer_remove( timer_ID )**
225 + Removes the timer with ID ~timer_ID~.
226 +
227 **to_column( position )**
228 Convert given position to column number in current window.
230 diff --quilt old/source/built-ins.h new/source/built-ins.h
231 --- old/source/built-ins.h
232 +++ new/source/built-ins.h
233 @@ -73,6 +73,8 @@ MS(to_pos, toPos)
234 MS(to_line, toLine)
235 MS(to_column, toColumn)
236 MS(set_window_title, setWindowTitle)
237 +MS(timer_add, timerAdd)
238 +MS(timer_remove, timerRemove)
240 MV(cursor, cursor)
241 MV(line, line)