summaryrefslogtreecommitdiffhomepage
path: root/src/nxt_file.h
diff options
context:
space:
mode:
authorAlejandro Colomar <alx.manpages@gmail.com>2022-04-30 19:20:23 +0200
committerAlejandro Colomar <alx.manpages@gmail.com>2022-05-03 12:11:14 +0200
commit952bcc50bfc5bd651a56fd97aa6f1f3c3e214071 (patch)
tree3a144d855ddac17dfa0e033b16b408e19944f5c7 /src/nxt_file.h
parentd929fbe1a4e0365b294e36aed4b5f12ee2a2210e (diff)
downloadunit-952bcc50bfc5bd651a56fd97aa6f1f3c3e214071.tar.gz
unit-952bcc50bfc5bd651a56fd97aa6f1f3c3e214071.tar.bz2
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/ //}'
Diffstat (limited to 'src/nxt_file.h')
-rw-r--r--src/nxt_file.h39
1 files changed, 13 insertions, 26 deletions
diff --git a/src/nxt_file.h b/src/nxt_file.h
index 4846305b..07c7a22b 100644
--- a/src/nxt_file.h
+++ b/src/nxt_file.h
@@ -27,23 +27,19 @@ typedef struct {
} nxt_file_name_str_t;
-#define \
-nxt_file_name_str_set(file_name, mem_pool, name) \
+#define nxt_file_name_str_set(file_name, mem_pool, name) \
((file_name) = (nxt_file_name_t *) (name), NXT_OK)
-#define \
-nxt_file_name_alloc(mem_pool, len) \
+#define nxt_file_name_alloc(mem_pool, len) \
nxt_mp_nget(mem_pool, len)
-#define \
-nxt_file_name_copy(dst, src, len) \
+#define nxt_file_name_copy(dst, src, len) \
nxt_cpymem(dst, src, len)
-#define \
-nxt_file_name_add(dst, src, len) \
+#define nxt_file_name_add(dst, src, len) \
nxt_cpymem(dst, src, len)
@@ -51,21 +47,18 @@ nxt_file_name_add(dst, src, len) \
/* MacOSX, Cygwin. */
-#define \
-nxt_file_name_eq(fn1, fn2) \
+#define nxt_file_name_eq(fn1, fn2) \
(nxt_strcasecmp(fn1, fn2) == 0)
#else
-#define \
-nxt_file_name_eq(fn1, fn2) \
+#define nxt_file_name_eq(fn1, fn2) \
(nxt_strcmp(fn1, fn2) == 0)
#endif
-#define \
-nxt_file_name_is_absolute(name) \
+#define nxt_file_name_is_absolute(name) \
(name[0] == '/')
@@ -168,20 +161,16 @@ NXT_EXPORT void nxt_file_read_ahead(nxt_file_t *file, nxt_off_t offset,
NXT_EXPORT nxt_int_t nxt_file_info(nxt_file_t *file, nxt_file_info_t *fi);
-#define \
-nxt_is_dir(fi) \
+#define nxt_is_dir(fi) \
(S_ISDIR((fi)->st_mode))
-#define \
-nxt_is_file(fi) \
+#define nxt_is_file(fi) \
(S_ISREG((fi)->st_mode))
-#define \
-nxt_file_size(fi) \
+#define nxt_file_size(fi) \
(fi)->st_size
-#define \
-nxt_file_mtime(fi) \
+#define nxt_file_mtime(fi) \
(fi)->st_mtime
@@ -206,12 +195,10 @@ NXT_EXPORT nxt_int_t nxt_stderr_start(void);
#define nxt_stderr STDERR_FILENO
-#define \
-nxt_write_console(fd, buf, size) \
+#define nxt_write_console(fd, buf, size) \
write(fd, buf, size)
-#define \
-nxt_write_syslog(priority, message) \
+#define nxt_write_syslog(priority, message) \
syslog(priority, "%s", message)