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

89 lines
2.7 KiB
C

/*
* Copyright (C) Igor Sysoev
* Copyright (C) NGINX, Inc.
*/
#ifndef _NXT_UNIX_ERRNO_H_INCLUDED_
#define _NXT_UNIX_ERRNO_H_INCLUDED_
typedef int nxt_err_t;
#define NXT_EPERM EPERM
#define NXT_ENOENT ENOENT
#define NXT_ENOPATH ENOENT
#define NXT_ESRCH ESRCH
#define NXT_EINTR EINTR
#define NXT_ENXIO ENXIO
#define NXT_ECHILD ECHILD
#define NXT_ENOMEM ENOMEM
#define NXT_EACCES EACCES
#define NXT_EBUSY EBUSY
#define NXT_EEXIST EEXIST
#define NXT_ELOOP ELOOP
#define NXT_EXDEV EXDEV
#define NXT_ENOTDIR ENOTDIR
#define NXT_EISDIR EISDIR
#define NXT_EINVAL EINVAL
#define NXT_ENOSPC ENOSPC
#define NXT_EPIPE EPIPE
#define NXT_EINPROGRESS EINPROGRESS
#define NXT_EOPNOTSUPP EOPNOTSUPP
#define NXT_EADDRINUSE EADDRINUSE
#define NXT_ECONNABORTED ECONNABORTED
#define NXT_ECONNRESET ECONNRESET
#define NXT_ENOTCONN ENOTCONN
#define NXT_ETIMEDOUT ETIMEDOUT
#define NXT_ECONNREFUSED ECONNREFUSED
#define NXT_ENAMETOOLONG ENAMETOOLONG
#define NXT_ENETDOWN ENETDOWN
#define NXT_ENETUNREACH ENETUNREACH
#define NXT_EHOSTDOWN EHOSTDOWN
#define NXT_EHOSTUNREACH EHOSTUNREACH
#define NXT_ENOSYS ENOSYS
#define NXT_ECANCELED ECANCELED
#define NXT_EILSEQ EILSEQ
#define NXT_ETIME ETIME
#define NXT_ENOMOREFILES 0
#define NXT_ENOBUFS ENOBUFS
#define NXT_ERANGE ERANGE
#if (NXT_HPUX)
/* HP-UX uses EWOULDBLOCK instead of EAGAIN. */
#define NXT_EAGAIN EWOULDBLOCK
#else
#define NXT_EAGAIN EAGAIN
#endif
#define NXT_OK 0
#define NXT_ERROR (-1)
#define NXT_AGAIN (-2)
#define NXT_DECLINED (-3)
#define NXT_DONE (-4)
#define nxt_errno \
errno
#define nxt_socket_errno \
errno
#define nxt_set_errno(err) \
errno = err
#define nxt_set_socket_errno(err) \
errno = err
nxt_int_t nxt_strerror_start(void);
typedef u_char *(*nxt_strerror_t)(nxt_err_t err, u_char *errstr, size_t size);
extern nxt_strerror_t nxt_strerror;
#endif /* _NXT_UNIX_ERRNO_H_INCLUDED_ */