bind9/lib/isc/include/isc/stdio.h
Ondřej Surý f3635bcc14 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-13 00:49:15 -07:00

69 lines
1.6 KiB
C

/*
* Copyright (C) Internet Systems Consortium, Inc. ("ISC")
*
* 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 isc/stdio.h */
/*%
* These functions are wrappers around the corresponding stdio functions.
*
* They return a detailed error code in the form of an an isc_result_t. ANSI C
* does not guarantee that stdio functions set errno, hence these functions
* must use platform dependent methods (e.g., the POSIX errno) to construct the
* error code.
*/
#include <stdio.h>
#include <isc/lang.h>
#include <isc/result.h>
ISC_LANG_BEGINDECLS
/*% Open */
isc_result_t
isc_stdio_open(const char *filename, const char *mode, FILE **fp);
/*% Close */
isc_result_t
isc_stdio_close(FILE *f);
/*% Seek */
isc_result_t
isc_stdio_seek(FILE *f, off_t offset, int whence);
/*% Tell */
isc_result_t
isc_stdio_tell(FILE *f, off_t *offsetp);
/*% Read */
isc_result_t
isc_stdio_read(void *ptr, size_t size, size_t nmemb, FILE *f, size_t *nret);
/*% Write */
isc_result_t
isc_stdio_write(const void *ptr, size_t size, size_t nmemb, FILE *f,
size_t *nret);
/*% Flush */
isc_result_t
isc_stdio_flush(FILE *f);
isc_result_t
isc_stdio_sync(FILE *f);
/*%<
* Invoke fsync() on the file descriptor underlying an stdio stream, or an
* equivalent system-dependent operation. Note that this function has no
* direct counterpart in the stdio library.
*/
ISC_LANG_ENDDECLS