final step to context based macro interpreter

[nedit-bw.git] / highlight_calltip_line.patch

From: Thorsten Haude <yoo@vranx.de>
Subject: highlight_calltip_line() macro

Highlight a line in the currently shown calltip.

This uses a XmText as the widget for the calltip.

---

 doc/help.etx           |    4 +
 source/calltips.c      |  109 ++++++++++++++++++++++++++++++++++++++++++++-----
 source/calltips.h      |    4 +
 source/highlightData.c |    2 
 source/macro.c         |   54 ++++++++++++++++++++++++
 5 files changed, 163 insertions(+), 10 deletions(-)

diff --quilt old/doc/help.etx new/doc/help.etx
--- old/doc/help.etx
+++ new/doc/help.etx
@@ -2709,6 +2709,10 @@ Macro Subroutines
 **getenv( name )**
   Gets the value of an environment variable.
 
+**highlight_calltip_line(calltip_ID, line)**
+  Highlights a single line in the given calltip. Set ~line~ to 0 to remove
+  any existing highlighting.
+
 **kill_calltip( [calltip_ID] )**
   Kills any calltip that is being displayed in the window in which the macro is
   running.  If there is no displayed calltip this does nothing.  If a calltip
diff --quilt old/source/calltips.c new/source/calltips.c
--- old/source/calltips.c
+++ new/source/calltips.c
@@ -42,6 +42,7 @@
 
 #include <Xm/Xm.h>
 #include <Xm/Label.h>
+#include <Xm/Text.h>
 #include <X11/Shell.h>
 
 #ifdef HAVE_DEBUG_H
@@ -63,6 +64,9 @@ static void getTipMetrics(Widget tip,
         Position *borderWidthPtr);
 static void moveTip(Widget tip, Position x, Position y);
 
+static Boolean getRangeOfLine(const char *textString, unsigned line,
+        unsigned *begin, unsigned *end);
+
 /*
 ** Pop-down a calltip if one exists, else do nothing
 */
@@ -373,7 +377,60 @@ void TextDKillScrolltip(textDisp *textD)
 }
 
 /*
-** This creates a calltip of class XmLabel and its parent, a shell of class
+** Highlight a single line in a given calltip, erasing all other highlights.
+**
+** Return values for this one need to be a bit more expressive. Some errors
+** might just be the result of sloppy parameters, and the caller should
+** decide whether to fail hard or not. The following results are possible:
+**
+** - The calltip ID given is invalid (CT_INVALID_ID).
+** - The user requested to remove all highlightings (CT_OK).
+** - The requested line is highlighted (CT_OK).
+** - The requested line is not in the provided text (CT_NOLINE).
+*/
+int HighlightCalltipLine(const WindowInfo *window, int calltipID, unsigned line)
+{
+    textDisp *textD = ((TextWidget)window->lastFocus)->text.textD;
+    Boolean result = False;
+
+    if (calltipID == textD->calltip.ID) {
+        Widget textWidget = textD->calltip.tip;
+        char *textString = XmTextGetString(textWidget);
+        XmTextPosition textLength = XmTextGetLastPosition(textWidget);
+        unsigned begin = 0, end = 0;
+        Boolean lineIsValid = False;
+
+        /* First remove all existing highlights. */
+        XmTextSetHighlight(textWidget, 0, textLength + 1, XmHIGHLIGHT_NORMAL);
+
+        if (0 == line) {
+            /* Just return without highlighting anything. */
+            result = CT_OK;
+        } else {
+            lineIsValid = getRangeOfLine(textString, line, &begin, &end);
+            if (lineIsValid) {
+                XmTextSetHighlight(textWidget,
+                        (XmTextPosition)begin,
+                        (XmTextPosition)end,
+                        XmHIGHLIGHT_SELECTED);
+
+                result = CT_OK;
+            } else {
+                /* The requested line is not in the provided text. */
+                result = CT_NOLINE;
+            }
+        }
+
+        XtFree(textString);
+    } else {
+        result = CT_INVALID_ID;
+    }
+
+    return result;
+}
+
+/*
+** This creates a calltip of class XmText and its parent, a shell of class
 ** OverrideShell (which in turn will be the child of the grandfather
 ** parameter). The tip will have minimum size but will resize to match
 ** the text entered (see XmNallowShellResize).
@@ -393,7 +450,7 @@ static Widget createTip(const char *name
 {
     Widget tip = NULL;
     Widget shell = NULL;
-    Arg args[10];
+    Arg args[2];
     int argcnt = 0;
     char *shellNameBuf;
 
@@ -417,12 +474,18 @@ static Widget createTip(const char *name
     /* Might want to make this a read-only XmText eventually so that
        users can copy from it */
     tip = XtVaCreateManagedWidget(name,
-            xmLabelWidgetClass, shell,
-            XmNborderWidth, 1, /* Thin borders */
+            xmTextWidgetClass, shell,
             XmNhighlightThickness, 0,
-            XmNalignment, XmALIGNMENT_BEGINNING,
+            XmNalignment, alignment,
+            XmNeditable, False,
+            XmNeditMode, XmMULTI_LINE_EDIT,
+            XmNcursorPositionVisible, False,
+            XmNresizeHeight, True,
+            XmNresizeWidth, True,
             XmNforeground, foreground,
             XmNbackground, background,
+            XmNheight, 1,
+            XmNwidth, 1,
             NULL);
 
     return tip;
@@ -435,11 +498,14 @@ static Widget shellOfTip(Widget tip)
 
 static void setTipText(Widget tip, const char *text)
 {
-    XmString str;
+    /* shrink the text widget to a minimum size, so that the new text
+       grow it to its size. */
+    XtVaSetValues(tip,
+            XmNheight, 1,
+            XmNwidth, 1,
+            NULL);
 
-    str = XmStringCreateLtoR((char *)text, XmFONTLIST_DEFAULT_TAG);
-    XtVaSetValues(tip, XmNlabelString, str, NULL);
-    XmStringFree(str);
+    XmTextSetString(tip, text);
 }
 
 static void showTip(Widget tip)
@@ -487,3 +553,28 @@ static void moveTip(Widget tip, Position
         XmNy, y,
         NULL);
 }
+
+/*
+** Sets the parameters to beginning and end of the line. Returns False if
+** the line is not in the text, True otherwise.
+*/
+static Boolean getRangeOfLine(const char *textString, unsigned line,
+        unsigned *begin, unsigned *end)
+{
+    int i;
+    size_t position = 0;
+
+    for (i = 0; i < line; i++) {
+        *end = strcspn(textString + position, "\n") + position;
+        *begin = position;
+        position = *end + 1;
+
+        if (*begin == *end) {
+            /* Break if last line is found. */
+            break;
+        }
+    }
+
+    return (*begin != *end);
+}
+
diff --quilt old/source/calltips.h new/source/calltips.h
--- old/source/calltips.h
+++ new/source/calltips.h
@@ -39,6 +39,7 @@ enum TipHAlignMode {TIP_LEFT, TIP_CENTER
 enum TipVAlignMode {TIP_ABOVE, TIP_BELOW};
 enum TipAlignStrict {TIP_SLOPPY, TIP_STRICT};
 enum ScrolltipAlignMode {SCROLLTIP_LEFT, SCROLLTIP_RIGHT};
+enum TipHighlightError {CT_OK, CT_INVALID_ID, CT_NOLINE};
 
 int  ShowCalltip(WindowInfo *window, char *text, Boolean anchored, 
         int pos, int hAlign, int vAlign, int alignMode);
@@ -51,4 +52,7 @@ Boolean TextDShowScrolltip(textDisp *tex
         int align);
 void TextDKillScrolltip(textDisp *textD);
 
+int HighlightCalltipLine(const WindowInfo *window, int calltipID,
+        unsigned line);
+
 #endif /* ifndef NEDIT_CALLTIPS_H_INCLUDED */
diff --quilt old/source/highlightData.c new/source/highlightData.c
--- old/source/highlightData.c
+++ new/source/highlightData.c
@@ -551,7 +551,7 @@ static char *DefaultPatternSets[] = {
         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|VERSION|NEDIT_HOME)>\":::Identifier::\n\
         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\
         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\
-        Built-in Subrs:\"<(?:args|append_file|beep|call|calltip|clipboard_to_string|dialog|filename_dialog|focus_window|get_character|get_pattern_(by_name|at_pos)|get_range|get_selection|get_style_(by_name|at_pos)|getenv|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|shell_command|split|string_compare|string_dialog|string_to_clipboard|substring|t_print|tolower|toupper|valid_number|write_file)(?=\\s*\\()\":::Subroutine::\n\
+        Built-in Subrs:\"<(?:args|append_file|beep|call|calltip|clipboard_to_string|dialog|filename_dialog|focus_window|get_character|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|shell_command|split|string_compare|string_dialog|string_to_clipboard|substring|t_print|tolower|toupper|valid_number|write_file)(?=\\s*\\()\":::Subroutine::\n\
         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\
         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\
         Keyword:\"<(?:break|continue|define|delete|do|else|for|if|in|return|while)>\":::Keyword::\n\
diff --quilt old/source/macro.c new/source/macro.c
--- old/source/macro.c
+++ new/source/macro.c
@@ -252,6 +252,8 @@ static int calltipMS(WindowInfo *window,
        DataValue *result, char **errMsg);
 static int killCalltipMS(WindowInfo *window, DataValue *argList, int nArgs,
        DataValue *result, char **errMsg);
+static int highlightCTLineMS(WindowInfo *window, DataValue *argList, int nArgs,
+        DataValue *result, char **errMsg);
 /* T Balinski */
 static int listDialogMS(WindowInfo *window, DataValue *argList, int nArgs,
        DataValue *result, char **errMsg);
@@ -465,6 +467,7 @@ static const BuiltInSubrName MacroSubrs[
     { "split", splitMS },
     { "calltip", calltipMS },
     { "kill_calltip", killCalltipMS },
+    { "highlight_calltip_line", highlightCTLineMS },
 /* DISABLED for 5.4
     { "set_backlight_string", setBacklightStringMS },
 */
@@ -3443,6 +3446,57 @@ static int killCalltipMS(WindowInfo *win
 }
 
 /*
+** highlight_calltip_line(ctID, line)
+*/
+static int highlightCTLineMS(WindowInfo *window, DataValue *argList, int nArgs,
+        DataValue *result, char **errMsg)
+{
+    int calltipID = 0;
+    int line;
+    int highlightResult;
+
+    if (2 != nArgs) {
+        *errMsg = "%s() called with wrong number of arguments";
+        return False;
+    }
+
+    if (!readIntArg(argList[0], &calltipID, errMsg)) {
+        *errMsg = "%s(): Could not read calltip ID from argument 1";
+        return False;
+    }
+
+    /* The macro function calltip() uses 0 to report an error. Catch sloppy
+       programmers who just feed this value into this function. */
+    if (0 == calltipID) {
+        *errMsg = "%s(): Invalid calltip ID 0";
+        return False;
+    }
+
+    if (!readIntArg(argList[1], &line, errMsg) || line < 0) {
+        *errMsg = "%s(): Could not read line number from argument 2";
+        return False;
+    }
+
+    result->tag = NO_TAG;
+
+    highlightResult = HighlightCalltipLine(window, calltipID, (unsigned)line);
+
+    if (CT_INVALID_ID == highlightResult) {
+        /* Fail only if the calltip ID given is invalid. */
+        *errMsg = "%s(): Invalid calltip ID";
+        return False;
+    }
+
+    /* In case NEdit ever gets a warning (!= error) mechanism. *//*
+    if (CT_NOLINE == highlightResult) {
+        *warnMsg = "%s(): Calltip line out of range";
+    }
+    */
+
+    return True;
+}
+
+/*
  * A subroutine to get the ID of the current calltip, or 0 if there is none.
  */
 static int calltipIDMV(WindowInfo *window, DataValue *argList,