Files
nginx-unit/src/nxt_thread_time.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

93 lines
2.4 KiB
C

/*
* Copyright (C) Igor Sysoev
* Copyright (C) NGINX, Inc.
*/
#ifndef _NXT_THREAD_TIME_H_INCLUDED_
#define _NXT_THREAD_TIME_H_INCLUDED_
#define NXT_THREAD_TIME_LOCAL 0
#define NXT_THREAD_TIME_GMT 1
#define NXT_THREAD_TIME_SEC 0
#define NXT_THREAD_TIME_MSEC 1
typedef struct {
nxt_atomic_t slot;
u_char *(*handler)(u_char *buf, nxt_realtime_t *now,
struct tm *tm, size_t size,
const char *format);
const char *format;
size_t size;
uint8_t timezone; /* 1 bit */
uint8_t msec; /* 1 bit */
} nxt_time_string_t;
typedef struct {
nxt_time_t last;
#if (NXT_DEBUG)
nxt_msec_t last_msec;
#endif
nxt_str_t string;
} nxt_time_string_cache_t;
typedef struct {
nxt_monotonic_time_t now;
nxt_time_t last_gmtime;
nxt_time_t last_localtime;
struct tm gmtime;
struct tm localtime;
uint32_t no_cache; /* 1 bit */
/*
* The flag indicating a signal state of a thread.
* It is used to handle local time of the thread:
* -1 means that the thread never runs in a signal context;
* 0 means that the thread may run in a signal context but not now;
* >0 means that the thread runs in a signal context right now.
*/
nxt_atomic_int_t signal;
nxt_atomic_uint_t nstrings;
nxt_time_string_cache_t *strings;
} nxt_thread_time_t;
NXT_EXPORT void nxt_thread_time_update(nxt_thread_t *thr);
void nxt_thread_time_free(nxt_thread_t *thr);
NXT_EXPORT nxt_time_t nxt_thread_time(nxt_thread_t *thr);
NXT_EXPORT nxt_realtime_t *nxt_thread_realtime(nxt_thread_t *thr);
NXT_EXPORT u_char *nxt_thread_time_string(nxt_thread_t *thr,
nxt_time_string_t *ts, u_char *buf);
void nxt_time_thread_start(nxt_msec_t interval);
#define nxt_thread_monotonic_time(thr) \
(thr)->time.now.monotonic
#if (NXT_DEBUG)
#define nxt_thread_time_debug_update(thr) \
nxt_thread_time_update(thr)
#else
#define nxt_thread_time_debug_update(thr)
#endif
NXT_EXPORT void nxt_gmtime(nxt_time_t s, struct tm *tm);
#endif /* _NXT_THREAD_TIME_H_INCLUDED_ */