Ticket #4206: StableWindowList.patch

lib/widget.h

@@ -21 +21 @@
 #include "lib/widget/background.h"
 #include "lib/widget/frame.h"
 #include "lib/widget/dialog.h"
+#include "lib/widget/order_kept_dialog.h"
 #include "lib/widget/history.h"
 #include "lib/widget/button.h"
 #include "lib/widget/buttonbar.h"

lib/widget/Makefile.am

@@ -7 +7 @@
         buttonbar.c buttonbar.h \
         check.c check.h \
         dialog.c dialog.h \
+        order_kept_dialog.c order_kept_dialog.h \
         dialog-switch.c dialog-switch.h \
         frame.c frame.h \
         gauge.c gauge.h \

lib/widget/dialog.c

@@ -373 +373 @@
             gboolean compact, const int *colors, widget_cb_fn callback,
             widget_mouse_cb_fn mouse_callback, const char *help_ctx, const char *title)
 {
-    WDialog *new_d;
+    WDialog *new_h;
+    new_h = g_new0 (WDialog, 1);
+    if (new_h != NULL)
+    {
+        gboolean ret;
+        ret = dlg_init_object (new_h, modal, y1, x1, lines, cols, pos_flags, compact, colors,
+                               callback, mouse_callback, help_ctx, title);
+        if (!ret)
+        {
+            g_free (new_h);
+            return NULL;
+        }
+    }
+    return new_h;
+}
+
+/* --------------------------------------------------------------------------------------------- */
+
+gboolean
+dlg_init_object (WDialog * new_h, gboolean modal, int y1, int x1, int lines, int cols,
+                 widget_pos_flags_t pos_flags, gboolean compact, const int *colors,
+                 widget_cb_fn callback, widget_mouse_cb_fn mouse_callback, const char *help_ctx,
+                 const char *title)
+{
     Widget *w;
     WGroup *g;
 
-    new_d = g_new0 (WDialog, 1);
-    w = WIDGET (new_d);
-    g = GROUP (new_d);
+    w = WIDGET (new_h);
+    g = GROUP (new_h);
+
     widget_adjust_position (pos_flags, &y1, &x1, &lines, &cols);
     group_init (g, y1, x1, lines, cols, callback != NULL ? callback : dlg_default_callback,
                 mouse_callback != NULL ? mouse_callback : dlg_default_mouse_callback);
@@ -397 +420 @@
 
     w->get_colors = dlg_default_get_colors;
 
-    new_d->colors = colors;
-    new_d->help_ctx = help_ctx;
-    new_d->compact = compact;
-    new_d->data = NULL;
+    new_h->colors = colors;
+    new_h->help_ctx = help_ctx;
+    new_h->compact = compact;
+    new_h->data = NULL;
 
     if (modal)
     {
         w->state |= WST_MODAL;
 
-        new_d->bg = WIDGET (frame_new (0, 0, w->lines, w->cols, title, FALSE, new_d->compact));
-        group_add_widget (g, new_d->bg);
-        frame_set_title (FRAME (new_d->bg), title);
+        new_h->bg = WIDGET (frame_new (0, 0, w->lines, w->cols, title, FALSE, new_h->compact));
+        group_add_widget (g, new_h->bg);
+        frame_set_title (FRAME (new_h->bg), title);
     }
 
     /* unique name of event group for this dialog */
-    new_d->event_group = g_strdup_printf ("%s_%p", MCEVENT_GROUP_DIALOG, (void *) new_d);
+    new_h->event_group = g_strdup_printf ("%s_%p", MCEVENT_GROUP_DIALOG, (void *) new_h);
 
-    return new_d;
+    return TRUE;
 }
 
 /* --------------------------------------------------------------------------------------------- */

lib/widget/dialog.h

@@ -102 +102 @@
                      const int *colors, widget_cb_fn callback, widget_mouse_cb_fn mouse_callback,
                      const char *help_ctx, const char *title);
 
+gboolean dlg_init_object (WDialog * new_h, gboolean modal, int y1, int x1, int lines, int cols,
+                          widget_pos_flags_t pos_flags, gboolean compact,
+                          const int *colors, widget_cb_fn callback,
+                          widget_mouse_cb_fn mouse_callback, const char *help_ctx,
+                          const char *title);
+
 void dlg_set_default_colors (void);
 
 void dlg_init (WDialog * h);

new file lib/widget/order_kept_dialog.c

@@ +1 @@
+/*
+   This dialog keeps a fixed order list of the widgets in its group (no Z-depth reordering).
+
+   Copyright (C) 2021
+   Free Software Foundation, Inc.
+
+   Written by:
+   Sebastian Gniazdowski <sgniazdowski@gmail.com>, 2021
+
+   This file is part of the Midnight Commander.
+
+   The Midnight Commander is free software: you can redistribute it
+   and/or modify it under the terms of the GNU General Public License as
+   published by the Free Software Foundation, either version 3 of the License,
+   or (at your option) any later version.
+
+   The Midnight Commander is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/** \file order_kept_dlg
+ *  \brief This extension of Dialog is to have a stable, fixed list of files in MCEdit.
+ *  \author Sebastian Gniazdowski
+ *  \date 2021
+ *
+ *  Before this class the files were fluctuating when they have been selected, as they
+ *  were brought to the front of the Z axis, which has been moving them in the `widgets`
+ *  list of the Group widget.
+ */
+
+#include <config.h>
+
+#include "lib/global.h"
+#include "lib/widget.h"
+
+#include "src/editor/editwidget.h"
+
+/*** global variables ****************************************************************************/
+
+/*** file scope macro definitions ****************************************************************/
+
+/*** file scope type declarations ****************************************************************/
+
+/*** file scope variables ************************************************************************/
+
+/*** file scope functions ************************************************************************/
+/* --------------------------------------------------------------------------------------------- */
+
+/* To search WEdit by file name */
+static gboolean
+filename_equal_edit_widgets (gconstpointer a, gconstpointer b)
+{
+    WEdit *wa = (WEdit *) a;
+    const char *fname_a = NULL, *fname_b = (const char *) b;
+
+    if (wa->filename_vpath != NULL)
+        fname_a = vfs_path_as_str (wa->filename_vpath);
+
+    return (g_strcmp0 (fname_a, fname_b) == 0);
+}
+
+/* --------------------------------------------------------------------------------------------- */
+/* Return a new string with old extension replaced by new extension */
+
+static char *
+replace_suffix_with (const char *src_str, const char *old_suffix, const char *new_suffix)
+{
+    char *new_str, *sufx_ptr;
+    new_str = g_strndup (src_str, strlen (src_str) + strlen (new_suffix));
+    sufx_ptr = g_strrstr (new_str, old_suffix);
+    if (sufx_ptr != NULL)
+    {
+        g_stpcpy (sufx_ptr, new_suffix);
+        return new_str;
+    }
+    else
+    {
+        g_free (new_str);
+        return NULL;
+    }
+}
+
+/* --------------------------------------------------------------------------------------------- */
+/* Sorts widgets by clustering headers and sources adjacent */
+
+static gboolean
+sort_edit_widgets (GPtrArray * array, order_kept_dialog_sort_flags_t sort_flags)
+{
+    WEdit *we;
+    const char *fname;
+    char *fname_con_c = NULL, *fname_con_cpp = NULL;
+    guint con_idx = 0, idx;
+    gboolean ret = FALSE, ret_con;
+
+    const char *src_sufx, *con_sufx_1, *con_sufx_2;
+
+    /* No need to sort? */
+    if ((sort_flags & (ORDER_DLG_GLUE_HEADERS_AND_SOURCE |
+                       ORDER_DLG_GLUE_HEADERS_AND_SOURCE_REVERSE)) == 0)
+        return ret;
+
+    /* Iterate over array inserting headers before/after its sources */
+    for (idx = 0; idx < array->len; idx++)
+    {
+        we = (WEdit *) g_ptr_array_index (array, idx);
+
+        if (we->filename_vpath == NULL)
+            continue;
+        fname = vfs_path_as_str (we->filename_vpath);
+
+        if (fname == NULL)
+            continue;
+
+        /* Is it a source? */
+        if (g_str_has_suffix (fname, ".c") || g_str_has_suffix (fname, ".cpp"))
+        {
+            src_sufx = ".c";
+            con_sufx_1 = ".h";
+            con_sufx_2 = ".hpp";
+
+            /* Is it a header? */
+        }
+        else if (g_str_has_suffix (fname, ".h") || g_str_has_suffix (fname, ".hpp"))
+        {
+            src_sufx = ".h";
+            con_sufx_1 = ".c";
+            con_sufx_2 = ".cpp";
+        }
+
+        /* Other kind -> ignore */
+        else
+            continue;
+
+        /* Construct a C and C++ contrary file */
+        fname_con_c = replace_suffix_with (fname, src_sufx, con_sufx_1);
+        fname_con_cpp = replace_suffix_with (fname, src_sufx, con_sufx_2);
+
+        /* Search for C extension contary file */
+        ret_con = g_ptr_array_find_with_equal_func (array, fname_con_c,
+                                                    filename_equal_edit_widgets, &con_idx);
+
+        /* If needed, retry with C++ extension file */
+        if (!ret_con)
+            ret_con = g_ptr_array_find_with_equal_func (array, fname_con_cpp,
+                                                        filename_equal_edit_widgets, &con_idx);
+
+        g_free (fname_con_c);
+        g_free (fname_con_cpp);
+
+        /* There's no contary file? */
+        if (!ret_con || con_idx == idx || array->pdata[idx] == array->pdata[con_idx])
+            continue;
+
+        ret = TRUE;
+
+        /* Move headers and their sources at adjacent positions */
+        if (con_idx < idx && (sort_flags & ORDER_DLG_GLUE_HEADERS_AND_SOURCE) != 0)
+        {
+            gpointer file = g_ptr_array_steal_index (array, idx);
+            g_ptr_array_insert (array, (src_sufx[1] == 'h') ? con_idx : con_idx + 1, file);
+        }
+        else if (idx < con_idx && (sort_flags & ORDER_DLG_GLUE_HEADERS_AND_SOURCE) != 0)
+        {
+            gpointer con_file = g_ptr_array_steal_index (array, con_idx);
+            g_ptr_array_insert (array, (src_sufx[1] == 'h') ? idx + 1 : idx, con_file);
+            idx++;
+        }
+        else if (con_idx < idx && (sort_flags & ORDER_DLG_GLUE_HEADERS_AND_SOURCE_REVERSE) != 0)
+        {
+            gpointer file = g_ptr_array_steal_index (array, idx);
+            g_ptr_array_insert (array, (src_sufx[1] == 'h') ? con_idx + 1 : con_idx, file);
+        }
+        else if (idx < con_idx && (sort_flags & ORDER_DLG_GLUE_HEADERS_AND_SOURCE_REVERSE) != 0)
+        {
+            gpointer con_file = g_ptr_array_steal_index (array, con_idx);
+            g_ptr_array_insert (array, (src_sufx[1] == 'h') ? idx : idx + 1, con_file);
+            idx++;
+        }
+    };
+    return ret;
+}
+
+/* --------------------------------------------------------------------------------------------- */
+/* Called after any action properly handled by front WDialog */
+
+static gboolean
+order_dlg_update_widgets_array (WOrderKeptDialog * h)
+{
+    GList *w;
+    gboolean ret = FALSE;
+    guint idx;
+
+    /* Initialize pointer array */
+    if (h->ordered_widgets == NULL)
+        h->ordered_widgets = g_ptr_array_new ();
+
+    /* Copy newly opened files */
+    for (w = GROUP (h)->widgets; w != NULL; w = g_list_next (w))
+    {
+        if (edit_widget_is_editor (CONST_WIDGET (w->data)) &&
+            !g_ptr_array_find (h->ordered_widgets, w->data, NULL))
+        {
+            g_ptr_array_add (h->ordered_widgets, w->data);
+            ret = TRUE;
+        }
+    }
+
+    /* Pop closed files */
+    for (idx = 0; idx < h->ordered_widgets->len; idx++)
+        if (g_list_find (GROUP (h)->widgets, g_ptr_array_index (h->ordered_widgets, idx)) == NULL)
+            g_ptr_array_remove_index (h->ordered_widgets, idx);
+
+    /* Sort if needed */
+    if (ret)
+        order_dlg_sort_widgets (h);
+
+    return ret;
+}
+
+/* --------------------------------------------------------------------------------------------- */
+/*** public functions ****************************************************************************/
+/* --------------------------------------------------------------------------------------------- */
+
+WOrderKeptDialog *
+order_dlg_create (gboolean modal, int y1, int x1, int lines, int cols,
+                  widget_pos_flags_t pos_flags, gboolean compact,
+                  const int *colors, widget_cb_fn callback,
+                  widget_cb_fn base_callback,
+                  widget_mouse_cb_fn mouse_callback,
+                  const char *help_ctx, const char *title, order_kept_dialog_sort_flags_t sort)
+{
+    WOrderKeptDialog *new_oh;
+    gboolean ret;
+
+    new_oh = g_new0 (WOrderKeptDialog, 1);
+    new_oh->sort_flags = sort;
+    ret = dlg_init_object (DIALOG (new_oh), modal, y1, x1, lines, cols, pos_flags, compact, colors,
+                           callback, mouse_callback, help_ctx, title);
+    if (!ret)
+    {
+        g_free (new_oh);
+        return NULL;
+    }
+
+    new_oh->base_callback = base_callback;
+    return new_oh;
+}
+
+/* --------------------------------------------------------------------------------------------- */
+
+cb_ret_t
+order_dlg_callback (Widget * w, Widget * sender, widget_msg_t msg, int parm, void *data)
+{
+    WOrderKeptDialog *h = ORDER_DIALOG (w);
+    cb_ret_t ret = MSG_NOT_HANDLED;
+
+    switch (msg)
+    {
+    case MSG_INIT:
+        /* Initial copy of WEdit pointers kept in WGroup::widgets */
+        order_dlg_update_widgets_array (h);
+        break;
+    case MSG_DESTROY:
+        /* Only a shallow release, as WEdit objects are owned by WGroup base object */
+        g_ptr_array_free (h->ordered_widgets, TRUE);
+        h->ordered_widgets = NULL;
+        break;
+    default:
+        break;
+    }
+
+    if (ret != MSG_HANDLED)
+    {
+        ret = h->base_callback (w, sender, msg, parm, data);
+        if (ret == MSG_HANDLED)
+            /* Add and pop new or closed files */
+            order_dlg_update_widgets_array (h);
+    }
+
+    return ret;
+}
+
+/* --------------------------------------------------------------------------------------------- */
+/* Sorts main widget list (adjacent headers/sources) */
+
+void
+order_dlg_sort_widgets (WOrderKeptDialog * h)
+{
+    sort_edit_widgets (h->ordered_widgets, h->sort_flags);
+}
+
+/* --------------------------------------------------------------------------------------------- */

new file lib/widget/order_kept_dialog.h

@@ +1 @@
+#ifndef MC__TEMPLATE_H
+#define MC__TEMPLATE_H
+
+/*** typedefs(not structures) and defined constants **********************************************/
+
+#define ORDER_DIALOG(x) ((WOrderKeptDialog *)(x))
+#define CONST_ORDER_DIALOG(x) ((const WOrderKeptDialog *)(x))
+
+/*** enums ***************************************************************************************/
+
+/* Default is: (1<<0) | (1<<7) */
+typedef enum
+{
+    ORDER_DLG_GLUE_HEADERS_AND_SOURCE = (1 << 0),
+    ORDER_DLG_GLUE_HEADERS_AND_SOURCE_REVERSE = (1 << 1),
+    ORDER_DLG_ALLOW_STANDARD_REORDERING = (1 << 2),
+    ORDER_DLG_SORT_REVERSE = (1 << 3),
+    ORDER_DLG_SORT_BACKUP_FILES_LAST = (1 << 5),
+    ORDER_DLG_DEFAULT_SORT = (1 << 7)
+} order_kept_dialog_sort_flags_t;
+
+/*** structures declarations (and typedefs of structures)*****************************************/
+
+typedef struct WOrderKeptDialog
+{
+    WDialog base;
+    GPtrArray *ordered_widgets;
+    widget_cb_fn base_callback;
+    order_kept_dialog_sort_flags_t sort_flags;
+} WOrderKeptDialog;
+
+/*** global variables defined in .c file *********************************************************/
+
+/*** declarations of public functions ************************************************************/
+
+WOrderKeptDialog *order_dlg_create (gboolean modal, int y1, int x1, int lines, int cols,
+                                    widget_pos_flags_t pos_flags, gboolean compact,
+                                    const int *colors, widget_cb_fn callback,
+                                    widget_cb_fn base_callback,
+                                    widget_mouse_cb_fn mouse_callback,
+                                    const char *help_ctx, const char *title,
+                                    order_kept_dialog_sort_flags_t sort);
+
+cb_ret_t order_dlg_callback (Widget * w, Widget * sender, widget_msg_t msg, int parm, void *data);
+
+void order_dlg_sort_widgets (WOrderKeptDialog * h);
+
+/*** inline functions ****************************************************************************/
+
+#endif /* MC__ORDER_DIALOG_H */

src/editor/editwidget.c

@@ -295 +295 @@
 static void
 edit_window_list (const WDialog * h)
 {
-    const WGroup *g = CONST_GROUP (h);
-    const size_t offset = 2;    /* skip menu and buttonbar */
-    const size_t dlg_num = g_list_length (g->widgets) - offset;
+    const WOrderKeptDialog *od = ORDER_DIALOG (h);
+    const size_t dlg_num = od->ordered_widgets->len;
     int lines, cols;
     Listbox *listbox;
-    GList *w;
     WEdit *selected;
-    int i = 0;
+    WListbox *lw;
+    uint idx;
 
     lines = MIN ((size_t) (LINES * 2 / 3), dlg_num);
     cols = COLS * 2 / 3;
 
     listbox = create_listbox_window (lines, cols, _("Open files"), "[Open files]");
 
-    for (w = g->widgets; w != NULL; w = g_list_next (w))
-        if (edit_widget_is_editor (CONST_WIDGET (w->data)))
-        {
-            WEdit *e = (WEdit *) w->data;
-            char *fname;
+    /* Convenience variable. */
+    lw = LISTBOX (listbox->list);
 
-            if (e->filename_vpath == NULL)
-                fname = g_strdup_printf ("%c [%s]", e->modified ? '*' : ' ', _("NoName"));
-            else
-                fname =
-                    g_strdup_printf ("%c%s", e->modified ? '*' : ' ',
-                                     vfs_path_as_str (e->filename_vpath));
+    /* Iterate over designated ptr array */
+    for (idx = 0; idx < od->ordered_widgets->len; idx++)
+    {
+        WEdit *e = (WEdit *) g_ptr_array_index (od->ordered_widgets, idx);
+        char *fname;
 
-            listbox_add_item (listbox->list, LISTBOX_APPEND_AT_END, get_hotkey (i++),
-                              str_term_trim (fname, WIDGET (listbox->list)->cols - 2), e, FALSE);
-            g_free (fname);
-        }
+        if (e->filename_vpath == NULL)
+            fname = g_strdup_printf ("%c [%s]", e->modified ? '*' : ' ', _("NoName"));
+        else
+            fname =
+                g_strdup_printf ("%c%s", e->modified ? '*' : ' ',
+                                 vfs_path_as_str (e->filename_vpath));
 
-    selected = run_listbox_with_data (listbox, g->current->data);
+        listbox_add_item (lw, LISTBOX_APPEND_AT_END, get_hotkey (idx),
+                          str_term_trim (fname, WIDGET (lw)->cols - 2), e, FALSE);
+        g_free (fname);
+    }
+
+    selected = run_listbox_with_data (listbox, GROUP (od)->current->data);
     if (selected != NULL)
         widget_select (WIDGET (selected));
 }
@@ -1206 +1208 @@
 edit_files (const GList * files)
 {
     static gboolean made_directory = FALSE;
+    WOrderKeptDialog *order_edit_dlg;
     WDialog *edit_dlg;
     WGroup *g;
     WMenuBar *menubar;
@@ -1231 +1234 @@
     }
 
     /* Create a new dialog and add it widgets to it */
-    edit_dlg =
-        dlg_create (FALSE, 0, 0, 1, 1, WPOS_FULLSCREEN, FALSE, NULL, edit_dialog_callback,
-                    edit_dialog_mouse_callback, "[Internal File Editor]", NULL);
+    order_edit_dlg =
+        order_dlg_create (FALSE, 0, 0, 1, 1, WPOS_FULLSCREEN, FALSE, NULL,
+                          order_dlg_callback, edit_dialog_callback,
+                          edit_dialog_mouse_callback, "[Internal File Editor]", NULL,
+                          ORDER_DLG_GLUE_HEADERS_AND_SOURCE);
+
+    edit_dlg = DIALOG (order_edit_dlg);
     wd = WIDGET (edit_dlg);
+
     widget_want_tab (wd, TRUE);
     wd->keymap = editor_map;
     wd->ext_keymap = editor_x_map;