bind/lib/isc/errno2result.h

/*
 * Copyright (C) Internet Systems Consortium, Inc. ("ISC")
 *
 * SPDX-License-Identifier: MPL-2.0
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, you can obtain one at https://mozilla.org/MPL/2.0/.
 *
 * See the COPYRIGHT file distributed with this work for additional
 * information regarding copyright ownership.
 */

#pragma once

/*! \file */

/* XXXDCL this should be moved to lib/isc/include/isc/errno2result.h. */

#include <errno.h> /* Provides errno. */
#include <stdbool.h>

#include <isc/lang.h>
#include <isc/types.h>

ISC_LANG_BEGINDECLS

#define isc__errno2result(x) isc___errno2result(x, true, __FILE__, __LINE__)

isc_result_t
isc___errno2result(int posixerrno, bool dolog, const char *file,
		   unsigned int line);

ISC_LANG_ENDDECLS
Moved posix_result from file.c to errno2result.[ch], for use by multiple source files. We may want to generalize this as part of the libisc API, but with a better name. 2000-05-11 15:09:30 +00:00			`/*`
Update license headers to not include years in copyright in all applicable files 2018-02-23 09:53:12 +01:00			`* Copyright (C) Internet Systems Consortium, Inc. ("ISC")`
Trailing whitespace trimmed. Perhaps running "perl util/spacewhack.pl in your own CVS tree will help minimize CVS conflicts. Maybe not. Blame Graff for getting me to trim all trailing whitespace. 2000-08-01 01:33:37 +00:00			`*`
Update the copyright information in all files in the repository This commit converts the license handling to adhere to the REUSE specification. It specifically: 1. Adds used licnses to LICENSES/ directory 2. Add "isc" template for adding the copyright boilerplate 3. Changes all source files to include copyright and SPDX license header, this includes all the C sources, documentation, zone files, configuration files. There are notes in the doc/dev/copyrights file on how to add correct headers to the new files. 4. Handle the rest that can't be modified via .reuse/dep5 file. The binary (or otherwise unmodifiable) files could have license places next to them in <foo>.license file, but this would lead to cluttered repository and most of the files handled in the .reuse/dep5 file are system test files. 2021-06-03 08:37:05 +02:00			`* SPDX-License-Identifier: MPL-2.0`
			`*`
4401. [misc] Change LICENSE to MPL 2.0. 2016-06-27 14:56:38 +10:00			`* This Source Code Form is subject to the terms of the Mozilla Public`
			`* License, v. 2.0. If a copy of the MPL was not distributed with this`
update all copyright headers to eliminate the typo 2020-09-14 16:20:40 -07:00			`* file, you can obtain one at https://mozilla.org/MPL/2.0/.`
Update license headers to not include years in copyright in all applicable files 2018-02-23 09:53:12 +01:00			`*`
			`* See the COPYRIGHT file distributed with this work for additional`
			`* information regarding copyright ownership.`
Moved posix_result from file.c to errno2result.[ch], for use by multiple source files. We may want to generalize this as part of the libisc API, but with a better name. 2000-05-11 15:09:30 +00:00			`*/`

Use #pragma once as header guards Unify the header guard style and replace the inconsistent include guards with #pragma once. The #pragma once is widely and very well supported in all compilers that BIND 9 supports, and #pragma once was already in use in several new or refactored headers. Using simpler method will also allow us to automate header guard checks as this is simpler to programatically check. For reference, here are the reasons for the change taken from Wikipedia[1]: > In the C and C++ programming languages, #pragma once is a non-standard > but widely supported preprocessor directive designed to cause the > current source file to be included only once in a single compilation. > > Thus, #pragma once serves the same purpose as include guards, but with > several advantages, including: less code, avoidance of name clashes, > and sometimes improvement in compilation speed. On the other hand, > #pragma once is not necessarily available in all compilers and its > implementation is tricky and might not always be reliable. 1. https://en.wikipedia.org/wiki/Pragma_once 2021-10-05 16:49:47 +02:00			`#pragma once`
use isc/lang.h and add protective UNIX_ERRNO2RESULT_H wrapper 2000-06-23 03:03:57 +00:00
1851. [doc] Doxygen comment markup. [RT #11398] 2005-04-27 04:57:32 +00:00			`/! \file /`

use isc/lang.h and add protective UNIX_ERRNO2RESULT_H wrapper 2000-06-23 03:03:57 +00:00			`/* XXXDCL this should be moved to lib/isc/include/isc/errno2result.h. */`

Use clang-format to reformat the source files 2020-02-12 13:59:18 +01:00			`#include <errno.h> /* Provides errno. */`
Replace custom isc_boolean_t with C standard bool type 2018-04-17 08:29:14 -07:00			`#include <stdbool.h>`
provide errno by way of errno.h 2000-11-14 23:37:10 +00:00
use isc/lang.h and add protective UNIX_ERRNO2RESULT_H wrapper 2000-06-23 03:03:57 +00:00			`#include <isc/lang.h>`
Moved posix_result from file.c to errno2result.[ch], for use by multiple source files. We may want to generalize this as part of the libisc API, but with a better name. 2000-05-11 15:09:30 +00:00			`#include <isc/types.h>`

use isc/lang.h and add protective UNIX_ERRNO2RESULT_H wrapper 2000-06-23 03:03:57 +00:00			`ISC_LANG_BEGINDECLS`

Replace custom isc_boolean_t with C standard bool type 2018-04-17 08:29:14 -07:00			`#define isc__errno2result(x) isc___errno2result(x, true, __FILE__, __LINE__)`
errno2result now reports caller when unable to convert errno 2011-12-02 07:15:17 +00:00
Moved posix_result from file.c to errno2result.[ch], for use by multiple source files. We may want to generalize this as part of the libisc API, but with a better name. 2000-05-11 15:09:30 +00:00			`isc_result_t`
Use clang-format to reformat the source files 2020-02-12 13:59:18 +01:00			`isc___errno2result(int posixerrno, bool dolog, const char *file,`
			`unsigned int line);`
use isc/lang.h and add protective UNIX_ERRNO2RESULT_H wrapper 2000-06-23 03:03:57 +00:00
			`ISC_LANG_ENDDECLS`