Files
nginx-unit/src/nxt_list.h
Alejandro Colomar 952bcc50bf 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/        //}'
2022-05-03 12:11:14 +02:00

128 lines
3.7 KiB
C

/*
* Copyright (C) Igor Sysoev
* Copyright (C) NGINX, Inc.
*/
#ifndef _NXT_LIST_H_INCLUDED_
#define _NXT_LIST_H_INCLUDED_
typedef struct nxt_list_part_s nxt_list_part_t;
struct nxt_list_part_s {
nxt_list_part_t *next;
uintptr_t nelts;
char data[];
};
typedef struct {
nxt_list_part_t *last;
#if (NXT_64BIT)
uint32_t size;
uint32_t nalloc;
#else
uint16_t size;
uint16_t nalloc;
#endif
nxt_mp_t *mem_pool;
nxt_list_part_t part;
} nxt_list_t;
typedef struct {
nxt_list_part_t *part;
uintptr_t elt;
} nxt_list_next_t;
#define nxt_list_part(list) \
(&(list)->part)
#define nxt_list_data(part) \
((void *) part->data)
#define nxt_list_first(list) \
nxt_list_data(nxt_list_part(list))
nxt_inline void *
nxt_list_elt(nxt_list_t *list, nxt_uint_t n)
{
nxt_list_part_t *part;
if (nxt_fast_path((list) != NULL)) {
part = nxt_list_part(list);
while (part != NULL) {
if (n < (nxt_uint_t) part->nelts) {
return nxt_pointer_to(nxt_list_data(part), n * (list)->size);
}
n -= (nxt_uint_t) part->nelts;
part = part->next;
}
}
return NULL;
}
#define nxt_list_each(elt, list) \
do { \
if (nxt_fast_path((list) != NULL)) { \
void *_end; \
nxt_list_part_t *_part = nxt_list_part(list); \
\
do { \
elt = nxt_list_data(_part); \
\
for (_end = (elt + _part->nelts); elt != _end; elt++) { \
#define nxt_list_loop \
} \
\
_part = _part->next; \
\
} while (_part != NULL); \
} \
} while (0)
NXT_EXPORT nxt_list_t *nxt_list_create(nxt_mp_t *mp, nxt_uint_t n, size_t size);
NXT_EXPORT void *nxt_list_add(nxt_list_t *list);
NXT_EXPORT void *nxt_list_zero_add(nxt_list_t *list);
NXT_EXPORT void *nxt_list_next(nxt_list_t *list, nxt_list_next_t *next);
#define nxt_list_next_value(list, next) \
(nxt_pointer_to(nxt_list_data((next)->part), (next)->elt * (list)->size))
nxt_inline nxt_uint_t
nxt_list_nelts(nxt_list_t *list)
{
nxt_uint_t n;
nxt_list_part_t *part;
n = 0;
if (nxt_fast_path((list) != NULL)) {
part = nxt_list_part(list);
do {
n += (nxt_uint_t) part->nelts;
part = part->next;
} while (part != NULL);
}
return n;
}
#endif /* _NXT_LIST_H_INCLUDED_ */