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/ //}'
66 lines
1.8 KiB
C
66 lines
1.8 KiB
C
|
|
/*
|
|
* Copyright (C) Igor Sysoev
|
|
* Copyright (C) NGINX, Inc.
|
|
*/
|
|
|
|
#ifndef _NXT_VECTOR_H_INCLUDED_
|
|
#define _NXT_VECTOR_H_INCLUDED_
|
|
|
|
|
|
typedef enum {
|
|
NXT_VECTOR_INITED = 0,
|
|
NXT_VECTOR_DESCRETE,
|
|
NXT_VECTOR_EMBEDDED,
|
|
} nxt_vector_type_t;
|
|
|
|
|
|
typedef struct {
|
|
void *start;
|
|
/*
|
|
* A vector can hold no more than 65536 items.
|
|
* The item size is no more than 64K.
|
|
*/
|
|
uint16_t items;
|
|
uint16_t avalaible;
|
|
uint16_t item_size;
|
|
nxt_vector_type_t type:8;
|
|
} nxt_vector_t;
|
|
|
|
|
|
NXT_EXPORT nxt_vector_t *nxt_vector_create(nxt_uint_t items, size_t item_size,
|
|
const nxt_mem_proto_t *proto, void *pool);
|
|
NXT_EXPORT void *nxt_vector_init(nxt_vector_t *vector, nxt_uint_t items,
|
|
size_t item_size, const nxt_mem_proto_t *proto, void *pool);
|
|
NXT_EXPORT void nxt_vector_destroy(nxt_vector_t *vector,
|
|
const nxt_mem_proto_t *proto, void *pool);
|
|
NXT_EXPORT void *nxt_vector_add(nxt_vector_t *vector,
|
|
const nxt_mem_proto_t *proto, void *pool);
|
|
NXT_EXPORT void *nxt_vector_zero_add(nxt_vector_t *vector,
|
|
const nxt_mem_proto_t *proto, void *pool);
|
|
NXT_EXPORT void nxt_vector_remove(nxt_vector_t *vector, void *item);
|
|
|
|
|
|
#define nxt_vector_last(vector) \
|
|
nxt_pointer_to((vector)->start, \
|
|
(vector)->item_size * ((vector)->items - 1))
|
|
|
|
|
|
#define nxt_vector_reset(vector) \
|
|
(vector)->items = 0;
|
|
|
|
|
|
#define nxt_vector_is_empty(vector) \
|
|
((vector)->items == 0)
|
|
|
|
|
|
nxt_inline void *
|
|
nxt_vector_remove_last(nxt_vector_t *vector)
|
|
{
|
|
vector->items--;
|
|
return nxt_pointer_to(vector->start, vector->item_size * vector->items);
|
|
}
|
|
|
|
|
|
#endif /* _NXT_VECTOR_H_INCLUDED_ */
|