Merge branch '4592_clang_format'

Signed-off-by: Yury V. Zaytsev <[email protected]>

Author: zyv

.clang-format

@@ -0,0 +1,36 @@
+---
+BasedOnStyle: GNU
+AlignConsecutiveMacros:
+  Enabled: true
+  AcrossEmptyLines: true
+  PadOperators: true
+AlignOperands: DontAlign
+AttributeMacros:
+  - G_GNUC_PRINTF
+BraceWrapping:
+  AfterCaseLabel: true
+  AfterClass: true
+  AfterControlStatement: Always
+  AfterEnum: true
+  AfterExternBlock: true
+  AfterFunction: true
+  AfterNamespace: true
+  AfterObjCDeclaration: true
+  AfterStruct: true
+  AfterUnion: true
+  BeforeCatch: true
+  BeforeElse: true
+  BeforeLambdaBody: false
+  BeforeWhile: true
+  IndentBraces: false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+BreakBeforeBinaryOperators: NonAssignment
+BreakBeforeBraces: Custom
+ColumnLimit: 100
+IndentPPDirectives: AfterHash
+IndentWidth: 4
+SortIncludes: Never
+SpaceAfterCStyleCast: true
+SpacesBeforeTrailingComments: 2

.github/workflows/ci-fedora.yml

@@ -11,11 +11,14 @@ jobs:
     timeout-minutes: 5
 
     steps:
+      - name: Install git inside container
+        run: dnf install -y git
+
       - uses: actions/checkout@v4
 
       - name: Install dependencies
         run: |
-          dnf install -y autoconf automake gcc gettext-devel groff libtool make pkgconfig
+          dnf install -y autoconf automake clang-tools-extra gcc gettext-devel groff libtool make pkgconfig
           dnf install -y aspell-devel check-devel gpm-devel libX11-devel "pkgconfig(ext2fs)" "pkgconfig(glib-2.0)" "pkgconfig(gmodule-2.0)" "pkgconfig(libssh2)" "pkgconfig(slang)"
 
           # For tests
@@ -41,6 +44,11 @@ jobs:
               --enable-werror \
               && \
             \
+            echo "Checking formatting..." && \
+            clang-format --version && \
+            make indent && \
+            git diff --exit-code && \
+            \
             make -j$(nproc) && \
             make check && \
             make install \

.github/workflows/ci-macos.yml

@@ -19,7 +19,7 @@ jobs:
 
       - name: Install dependencies
         run: |
-          brew install autoconf automake gettext check gnu-indent libtool pkg-config
+          brew install autoconf automake gettext check libtool pkg-config
           brew install aspell e2fsprogs glib libssh2 openssl s-lang
 
           # unzip is part of the base system

.github/workflows/ci-ubuntu.yml

@@ -13,7 +13,7 @@ jobs:
 
       - name: Install dependencies
         run: |
-          sudo apt-get install -y autoconf autopoint check gettext indent libtool pkg-config
+          sudo apt-get install -y autoconf autopoint check gettext libtool pkg-config
           sudo apt-get install -y e2fslibs-dev libaspell-dev libglib2.0-dev libgpm-dev libncurses5-dev libpcre2-dev libslang2-dev libssh2-1-dev libx11-dev unzip
 
       - name: Bootstrap build system
@@ -39,10 +39,6 @@ jobs:
               --enable-vfs-undelfs \
               --enable-werror
 
-          make indent
-          # TODO: exit 1
-          git ls-files --modified
-
           make -j$(nproc)
           make check
           make install

Makefile.am

@@ -115,14 +115,7 @@ cppcheck-split-all: \
     cppcheck-unusedFunction \
     cppcheck-missingInclude
 
-INDENT_CMD = $(INDENT) \
-    --gnu-style \
-    --format-first-column-comments \
-    --indent-level4 \
-    --brace-indent0 \
-    --line-length100 \
-    --no-tabs \
-    --blank-lines-after-procedures
+INDENT_CMD = clang-format -i
 
 INDENT_DIRS = \
     "$(top_srcdir)/lib" \

configure.ac

@@ -218,7 +218,6 @@ dnl ############################################################################
 dnl Check for other tools
 dnl ############################################################################
 
-AC_CHECK_TOOLS([INDENT], [gindent indent])
 mc_UNIT_TESTS
 
 

doc/HACKING

@@ -66,29 +66,11 @@ cd mc-slang
 cd ../mc-ncurses
 /usr/local/src/mc/configure --with-screen=ncurses && make all
 
-Please use the same indentation as other developers.  To indent a block,
-select in the internal editor and use Shift-F9 to call the external
-indent.  For historic reasons, GNU Midnight Commander used formatting
-that is not default for GNU Indent.  Please put following text to your
-~/.indent.pro file to make GNU Indent follow the style used in GNU
-Midnight Commander:
-
---gnu-style
---format-first-column-comments
---indent-level4
---brace-indent0
---line-length100
---no-tabs
---blank-lines-after-procedures
-
-or in short notation:
-
-indent -gnu -fc1 -i4 -bli0 -nut -bap -l100
-
-It's OK to indent the whole function if you edit it.  However, please
-refrain from it if you are posting your patch for review.  In this case
-you would save time of other developers if you only include significant
-changes.  The developer applying your patch can format the code for you.
+Please use the same indentation as other developers.  We enforce our
+indentation style with clang-format.  If your IDE doesn't have a
+suitable itegration, make sure to run the formatter yourself:
+
+make indent
 
 Please keep in mind that the VFS subsystem is licensed under LGPL, while
 the rest of the code uses GPL.

lib/charsets.c

@@ -34,9 +34,9 @@
 #include <string.h>
 
 #include "lib/global.h"
-#include "lib/strutil.h"        /* utf-8 functions */
+#include "lib/strutil.h"  // utf-8 functions
 #include "lib/fileloc.h"
-#include "lib/util.h"           /* whitespace() */
+#include "lib/util.h"  // whitespace()
 
 #include "lib/charsets.h"
 
@@ -52,7 +52,7 @@ const char *cp_source = NULL;
 
 /*** file scope macro definitions ****************************************************************/
 
-#define UNKNCHAR '\001'
+#define UNKNCHAR   '\001'
 
 #define OTHER_8BIT "Other_8_bit"
 
@@ -106,7 +106,7 @@ load_codepages_list_from_file (GPtrArray **list, const char *fname)
 
     while (fgets (buf, sizeof buf, f) != NULL)
     {
-        /* split string into id and cpname */
+        // split string into id and cpname
         char *p = buf;
         size_t buflen;
 
@@ -142,8 +142,8 @@ load_codepages_list_from_file (GPtrArray **list, const char *fname)
             {
                 unsigned int i;
 
-                /* whether id is already present in list */
-                /* if yes, overwrite description */
+                // whether id is already present in list
+                // if yes, overwrite description
                 for (i = 0; i < (*list)->len; i++)
                 {
                     codepage_desc *desc;
@@ -152,14 +152,14 @@ load_codepages_list_from_file (GPtrArray **list, const char *fname)
 
                     if (strcmp (id, desc->id) == 0)
                     {
-                        /* found */
+                        // found
                         g_free (desc->name);
                         desc->name = g_strdup (p);
                         break;
                     }
                 }
 
-                /* not found */
+                // not found
                 if (i == (*list)->len)
                     g_ptr_array_add (*list, new_codepage_desc (id, p));
             }
@@ -172,7 +172,7 @@ load_codepages_list_from_file (GPtrArray **list, const char *fname)
         g_free (default_codepage);
     }
 
-  fail:
+fail:
     fclose (f);
 }
 
@@ -203,23 +203,23 @@ load_codepages_list (void)
 {
     char *fname;
 
-    /* 1: try load /usr/share/mc/mc.charsets */
+    // 1: try load /usr/share/mc/mc.charsets
     fname = g_build_filename (mc_global.share_data_dir, CHARSETS_LIST, (char *) NULL);
     load_codepages_list_from_file (&codepages, fname);
     g_free (fname);
 
-    /* 2: try load /etc/mc/mc.charsets */
+    // 2: try load /etc/mc/mc.charsets
     fname = g_build_filename (mc_global.sysconfig_dir, CHARSETS_LIST, (char *) NULL);
     load_codepages_list_from_file (&codepages, fname);
     g_free (fname);
 
     if (codepages == NULL)
     {
-        /* files are not found, add default codepage */
-        fprintf (stderr, "%s\n", _("Warning: cannot load codepages list"));
+        // files are not found, add default codepage
+        fprintf (stderr, "%s\n", _ ("Warning: cannot load codepages list"));
 
         codepages = g_ptr_array_new_with_free_func (free_codepage_desc);
-        g_ptr_array_add (codepages, new_codepage_desc (DEFAULT_CHARSET, _("7-bit ASCII")));
+        g_ptr_array_add (codepages, new_codepage_desc (DEFAULT_CHARSET, _ ("7-bit ASCII")));
     }
 }
 
@@ -229,7 +229,7 @@ void
 free_codepages_list (void)
 {
     g_ptr_array_free (codepages, TRUE);
-    /* NULL-ize pointer to make unit tests happy */
+    // NULL-ize pointer to make unit tests happy
     codepages = NULL;
 }
 
@@ -288,7 +288,7 @@ init_translation_table (int cpsource, int cpdisplay)
     int i;
     GIConv cd;
 
-    /* Fill input <-> display tables */
+    // Fill input <-> display tables
 
     if (cpsource < 0 || cpdisplay < 0 || cpsource == cpdisplay)
     {
@@ -309,22 +309,22 @@ init_translation_table (int cpsource, int cpdisplay)
     cp_source = ((codepage_desc *) g_ptr_array_index (codepages, cpsource))->id;
     cp_display = ((codepage_desc *) g_ptr_array_index (codepages, cpdisplay))->id;
 
-    /* display <- inpit table */
+    // display <- inpit table
 
     cd = g_iconv_open (cp_display, cp_source);
     if (cd == INVALID_CONV)
-        return g_strdup_printf (_("Cannot translate from %s to %s"), cp_source, cp_display);
+        return g_strdup_printf (_ ("Cannot translate from %s to %s"), cp_source, cp_display);
 
     for (i = 128; i <= 255; ++i)
         conv_displ[i] = translate_character (cd, i);
 
     g_iconv_close (cd);
 
-    /* inpit <- display table */
+    // inpit <- display table
 
     cd = g_iconv_open (cp_source, cp_display);
     if (cd == INVALID_CONV)
-        return g_strdup_printf (_("Cannot translate from %s to %s"), cp_display, cp_source);
+        return g_strdup_printf (_ ("Cannot translate from %s to %s"), cp_display, cp_source);
 
     for (i = 128; i <= 255; ++i)
     {
@@ -489,13 +489,13 @@ convert_from_8bit_to_utf_c (char input_char, GIConv conv)
     switch (str_translate_char (conv, (char *) str, -1, (char *) buf_ch, sizeof (buf_ch)))
     {
     case ESTR_SUCCESS:
-        {
-            int res;
+    {
+        int res;
 
-            res = g_utf8_get_char_validated ((char *) buf_ch, -1);
-            ch = res >= 0 ? res : buf_ch[0];
-            break;
-        }
+        res = g_utf8_get_char_validated ((char *) buf_ch, -1);
+        ch = res >= 0 ? res : buf_ch[0];
+        break;
+    }
     case ESTR_PROBLEM:
     case ESTR_FAILURE:
     default:

lib/charsets.h

@@ -110,4 +110,4 @@ str_convert_to_display (const char *str)
 
 /* --------------------------------------------------------------------------------------------- */
 
-#endif /* MC__CHARSETS_H */
+#endif

lib/event-types.h

@@ -6,12 +6,12 @@
 /*** typedefs(not structures) and defined constants **********************************************/
 
 /* Event groups for main modules */
-#define MCEVENT_GROUP_CORE "Core"
-#define MCEVENT_GROUP_DIALOG "Dialog"
-#define MCEVENT_GROUP_DIFFVIEWER "DiffViewer"
-#define MCEVENT_GROUP_EDITOR "Editor"
+#define MCEVENT_GROUP_CORE        "Core"
+#define MCEVENT_GROUP_DIALOG      "Dialog"
+#define MCEVENT_GROUP_DIFFVIEWER  "DiffViewer"
+#define MCEVENT_GROUP_EDITOR      "Editor"
 #define MCEVENT_GROUP_FILEMANAGER "FileManager"
-#define MCEVENT_GROUP_VIEWER "Viewer"
+#define MCEVENT_GROUP_VIEWER      "Viewer"
 
 /* Events */
 #define MCEVENT_HISTORY_LOAD "history_load"
@@ -72,7 +72,7 @@ struct Widget;
 typedef struct
 {
     struct mc_config_t *cfg;
-    struct Widget *receiver;    /* NULL means broadcast message */
+    struct Widget *receiver;  // NULL means broadcast message
 } ev_history_load_save_t;
 
 /*** global variables defined in .c file *********************************************************/
@@ -81,4 +81,4 @@ typedef struct
 
 /*** inline functions ****************************************************************************/
 
-#endif /* MC__EVENT_TYPES_H */
+#endif

lib/event.h

@@ -24,25 +24,23 @@ typedef struct
 /*** declarations of public functions ************************************************************/
 
 /* event.c: */
-gboolean mc_event_init (GError ** mcerror);
-gboolean mc_event_deinit (GError ** mcerror);
-
+gboolean mc_event_init (GError **mcerror);
+gboolean mc_event_deinit (GError **mcerror);
 
 /* manage.c: */
-gboolean mc_event_add (const gchar * event_group_name, const gchar * event_name,
+gboolean mc_event_add (const gchar *event_group_name, const gchar *event_name,
                        mc_event_callback_func_t event_callback, gpointer event_init_data,
-                       GError ** mcerror);
-void mc_event_del (const gchar * event_group_name, const gchar * event_name,
+                       GError **mcerror);
+void mc_event_del (const gchar *event_group_name, const gchar *event_name,
                    mc_event_callback_func_t event_callback, gpointer event_init_data);
-void mc_event_destroy (const gchar * event_group_name, const gchar * event_name);
-void mc_event_group_del (const gchar * event_group_name);
-gboolean mc_event_present (const gchar * event_group_name, const gchar * event_name);
-gboolean mc_event_mass_add (const event_init_t * events, GError ** mcerror);
+void mc_event_destroy (const gchar *event_group_name, const gchar *event_name);
+void mc_event_group_del (const gchar *event_group_name);
+gboolean mc_event_present (const gchar *event_group_name, const gchar *event_name);
+gboolean mc_event_mass_add (const event_init_t *events, GError **mcerror);
 
 /* raise.c: */
 gboolean mc_event_raise (const gchar *, const gchar *, gpointer);
 
-
 /*** inline functions ****************************************************************************/
 
-#endif /* MC__EVENT_H */
+#endif