From 952bcc50bfc5bd651a56fd97aa6f1f3c3e214071 Mon Sep 17 00:00:00 2001
From: Alejandro Colomar <alx.manpages@gmail.com>
Date: Sat, 30 Apr 2022 19:20:23 +0200
Subject: Fixed #define style.

We had a mix of styles for declaring function-like macros:

Style A:
 #define                    \
 foo()                      \
     do {                   \
         ...                \
     } while (0)

Style B:
 #define foo()              \
     do {                   \
         ...                \
     } while (0)

We had a similar number of occurences of each style:

 $ grep -rnI '^\w*(.*\\' | wc -l
 244
 $ grep -rn 'define.*(.*)' | wc -l
 239

(Those regexes aren't perfect, but a very decent approximation.)

Real examples:

 $ find src -type f | xargs sed -n '/^nxt_double_is_zero/,/^$/p'
 nxt_double_is_zero(f)                                                         \
     (fabs(f) <= FLT_EPSILON)

 $ find src -type f | xargs sed -n '/define nxt_http_field_set/,/^$/p'
 #define nxt_http_field_set(_field, _name, _value)                             \
     do {                                                                      \
         (_field)->name_length = nxt_length(_name);                            \
         (_field)->value_length = nxt_length(_value);                          \
         (_field)->name = (u_char *) _name;                                    \
         (_field)->value = (u_char *) _value;                                  \
     } while (0)

I'd like to standardize on a single style for them, and IMO,
having the identifier in the same line as #define is a better
option for the following reasons:

- Programmers are used to `#define foo() ...` (readability).
- One less line of code.
- The program for finding them is really simple (see below).

 function grep_ngx_func()
 {
     if (($# != 1)); then
         >&2 echo "Usage: ${FUNCNAME[0]} <func>";
         return 1;
     fi;

     find src -type f \
     | grep '\.[ch]$' \
     | xargs grep -l "$1" \
     | sort \
     | xargs pcregrep -Mn "(?s)^\$[\w\s*]+?^$1\(.*?^}";

     find src -type f \
     | grep '\.[ch]$' \
     | xargs grep -l "$1" \
     | sort \
     | xargs pcregrep -Mn "(?s)define $1\(.*?^$" \
     | sed -E '1s/^[^:]+:[0-9]+:/&\n\n/';
 }

 $ grep_ngx_func
 Usage: grep_ngx_func <func>

 $ grep_ngx_func nxt_http_field_set
 src/nxt_http.h:98:

 #define nxt_http_field_set(_field, _name, _value)                             \
     do {                                                                      \
         (_field)->name_length = nxt_length(_name);                            \
         (_field)->value_length = nxt_length(_value);                          \
         (_field)->name = (u_char *) _name;                                    \
         (_field)->value = (u_char *) _value;                                  \
     } while (0)

 $ grep_ngx_func nxt_sprintf
 src/nxt_sprintf.c:56:

 u_char * nxt_cdecl
 nxt_sprintf(u_char *buf, u_char *end, const char *fmt, ...)
 {
     u_char   *p;
     va_list  args;

     va_start(args, fmt);
     p = nxt_vsprintf(buf, end, fmt, args);
     va_end(args);

     return p;
 }

................
Scripted change:
................

$ find src -type f \
  | grep '\.[ch]$' \
  | xargs sed -i '/define *\\$/{N;s/ *\\\n/ /;s/        //}'
---
 src/nxt_mem_zone.c | 27 +++++++++------------------
 1 file changed, 9 insertions(+), 18 deletions(-)

(limited to 'src/nxt_mem_zone.c')

diff --git a/src/nxt_mem_zone.c b/src/nxt_mem_zone.c
index 67c6d746..f8ab09d9 100644
--- a/src/nxt_mem_zone.c
+++ b/src/nxt_mem_zone.c
@@ -87,48 +87,39 @@ struct nxt_mem_zone_s {
 };
 
 
-#define                                                                       \
-nxt_mem_zone_page_addr(zone, page)                                            \
+#define nxt_mem_zone_page_addr(zone, page)                                    \
     (void *) (zone->start + ((page - zone->pages) << zone->page_size_shift))
 
 
-#define                                                                       \
-nxt_mem_zone_addr_page(zone, addr)                                            \
+#define nxt_mem_zone_addr_page(zone, addr)                                    \
     &zone->pages[((u_char *) addr - zone->start) >> zone->page_size_shift]
 
 
-#define                                                                       \
-nxt_mem_zone_page_is_free(page)                                               \
+#define nxt_mem_zone_page_is_free(page)                                       \
     (page->size < NXT_MEM_ZONE_PAGE_USED)
 
 
-#define                                                                       \
-nxt_mem_zone_page_is_chunked(page)                                            \
+#define nxt_mem_zone_page_is_chunked(page)                                    \
     (page->size >= 16)
 
 
-#define                                                                       \
-nxt_mem_zone_page_bitmap(zone, slot)                                          \
+#define nxt_mem_zone_page_bitmap(zone, slot)                                  \
     (slot->size < zone->small_bitmap_min_size)
 
 
-#define                                                                       \
-nxt_mem_zone_set_chunk_free(map, chunk)                                       \
+#define nxt_mem_zone_set_chunk_free(map, chunk)                               \
     map[chunk / 8] &= ~(0x80 >> (chunk & 7))
 
 
-#define                                                                       \
-nxt_mem_zone_chunk_is_free(map, chunk)                                        \
+#define nxt_mem_zone_chunk_is_free(map, chunk)                                \
     ((map[chunk / 8] & (0x80 >> (chunk & 7))) == 0)
 
 
-#define                                                                       \
-nxt_mem_zone_fresh_junk(p, size)                                              \
+#define nxt_mem_zone_fresh_junk(p, size)                                      \
     nxt_memset((p), 0xA5, size)
 
 
-#define                                                                       \
-nxt_mem_zone_free_junk(p, size)                                               \
+#define nxt_mem_zone_free_junk(p, size)                                       \
     nxt_memset((p), 0x5A, size)
 
 
-- 
cgit