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/        //}'
This commit is contained in:
Alejandro Colomar
2022-04-30 19:20:23 +02:00
parent d929fbe1a4
commit 952bcc50bf
41 changed files with 259 additions and 518 deletions

View File

@@ -43,121 +43,98 @@
* several levels.
*/
#define \
nxt_lvlhsh_is_bucket(p) \
#define nxt_lvlhsh_is_bucket(p) \
((uintptr_t) (p) & 1)
#define \
nxt_lvlhsh_count_inc(n) \
#define nxt_lvlhsh_count_inc(n) \
n = (void *) ((uintptr_t) (n) + 2)
#define \
nxt_lvlhsh_count_dec(n) \
#define nxt_lvlhsh_count_dec(n) \
n = (void *) ((uintptr_t) (n) - 2)
#define \
nxt_lvlhsh_level_size(proto, nlvl) \
#define nxt_lvlhsh_level_size(proto, nlvl) \
((uintptr_t) 1 << proto->shift[nlvl])
#define \
nxt_lvlhsh_level(lvl, mask) \
#define nxt_lvlhsh_level(lvl, mask) \
(void **) ((uintptr_t) lvl & (~mask << 2))
#define \
nxt_lvlhsh_level_entries(lvl, mask) \
#define nxt_lvlhsh_level_entries(lvl, mask) \
((uintptr_t) lvl & (mask << 1))
#define \
nxt_lvlhsh_store_bucket(slot, bkt) \
#define nxt_lvlhsh_store_bucket(slot, bkt) \
slot = (void **) ((uintptr_t) bkt | 2 | 1)
#define \
nxt_lvlhsh_bucket_size(proto) \
#define nxt_lvlhsh_bucket_size(proto) \
proto->bucket_size
#define \
nxt_lvlhsh_bucket(proto, bkt) \
#define nxt_lvlhsh_bucket(proto, bkt) \
(uint32_t *) ((uintptr_t) bkt & ~(uintptr_t) proto->bucket_mask)
#define \
nxt_lvlhsh_bucket_entries(proto, bkt) \
#define nxt_lvlhsh_bucket_entries(proto, bkt) \
(((uintptr_t) bkt & (uintptr_t) proto->bucket_mask) >> 1)
#define \
nxt_lvlhsh_bucket_end(proto, bkt) \
#define nxt_lvlhsh_bucket_end(proto, bkt) \
&bkt[proto->bucket_end]
#define \
nxt_lvlhsh_free_entry(e) \
#define nxt_lvlhsh_free_entry(e) \
(!(nxt_lvlhsh_valid_entry(e)))
#define \
nxt_lvlhsh_next_bucket(proto, bkt) \
#define nxt_lvlhsh_next_bucket(proto, bkt) \
((void **) &bkt[proto->bucket_end])
#if (NXT_64BIT)
#define \
nxt_lvlhsh_valid_entry(e) \
#define nxt_lvlhsh_valid_entry(e) \
(((e)[0] | (e)[1]) != 0)
#define \
nxt_lvlhsh_entry_value(e) \
#define nxt_lvlhsh_entry_value(e) \
(void *) (((uintptr_t) (e)[1] << 32) + (e)[0])
#define \
nxt_lvlhsh_set_entry_value(e, n) \
#define nxt_lvlhsh_set_entry_value(e, n) \
(e)[0] = (uint32_t) (uintptr_t) n; \
(e)[1] = (uint32_t) ((uintptr_t) n >> 32)
#define \
nxt_lvlhsh_entry_key(e) \
#define nxt_lvlhsh_entry_key(e) \
(e)[2]
#define \
nxt_lvlhsh_set_entry_key(e, n) \
#define nxt_lvlhsh_set_entry_key(e, n) \
(e)[2] = n
#else
#define \
nxt_lvlhsh_valid_entry(e) \
#define nxt_lvlhsh_valid_entry(e) \
((e)[0] != 0)
#define \
nxt_lvlhsh_entry_value(e) \
#define nxt_lvlhsh_entry_value(e) \
(void *) (e)[0]
#define \
nxt_lvlhsh_set_entry_value(e, n) \
#define nxt_lvlhsh_set_entry_value(e, n) \
(e)[0] = (uint32_t) n
#define \
nxt_lvlhsh_entry_key(e) \
#define nxt_lvlhsh_entry_key(e) \
(e)[1]
#define \
nxt_lvlhsh_set_entry_key(e, n) \
#define nxt_lvlhsh_set_entry_key(e, n) \
(e)[1] = n
#endif