bio.h

Go to the documentation of this file.

/*                           B I O . H
 * BRL-CAD
 *
 * Copyright (c) 2008-2026 United States Government as represented by
 * the U.S. Army Research Laboratory.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * version 2.1 as published by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this file; see the file named COPYING for more
 * information.
 */
/** @addtogroup bu_bio
 *
 * @brief
 * BRL-CAD system compatibility wrapper header that provides declarations for
 * native and standard system INPUT/OUTPUT routines.
 *
 * This header is commonly used in lieu of including the following: stdio.h,
 * io.h, fcntl, unistd.h, and windows.h
 *
 * The logic in this header should not rely on common.h's HAVE_* defines and
 * should not be including the common.h header.  This is intended to be a
 * stand-alone portability header intended to be independent of build system,
 * reusable by external projects.
 */
 
/** @{ */
/** @file bio.h */
 
#ifndef BIO_H
#define BIO_H
 
#include <stdio.h>
 
#if defined(_WIN32) && !defined(__CYGWIN__) && !defined(__MSYS__)
 
#  ifdef WIN32_LEAN_AND_MEAN
#    undef WIN32_LEAN_AND_MEAN
#  endif
#  define WIN32_LEAN_AND_MEAN 434144 /* don't want winsock.h */
 
#  ifdef NOMINMAX
#    undef NOMINMAX
#  endif
#  define NOMINMAX 434144 /* don't break std::min and std::max */
 
#  include <windows.h>
 
#  undef WIN32_LEAN_AND_MEAN /* unset to not interfere with calling apps */
#  undef NOMINMAX
#  include <io.h>
 
#  undef rad1 /* Win32 radio button 1 */
#  undef rad2 /* Win32 radio button 2 */
#  undef small /* defined as part of the Microsoft Interface Definition Language (MIDL) */
 
#else
 
/* strict mode may not declare fileno().  Ensure a consistent C linkage
 * declaration for both C and C++ consumers, but do not attempt to add
 * any project-specific dll-export/import attributes here so this header
 * remains a standalone portability shim.  On Windows fileno() is always
 * declared by <stdio.h> (with CRT dll-import linkage), so redeclaring it
 * here would conflict - skip the declaration on that platform. */
# if !defined(fileno)
#  ifdef __cplusplus
extern "C" {
#  endif
int fileno(FILE *stream);
#  ifdef __cplusplus
}
#  endif
# endif
 
#  include <unistd.h>
 
/* provide a stub so we don't need to wrap all setmode() calls */
static inline int setmode(int UNUSED(a), int UNUSED(b)) {return 42;}
static int (* volatile setmode_func)(int, int) = setmode; /* quell use */
#endif
 
/* needed for testing O_TEMPORARY and O_BINARY */
#include <fcntl.h>
 
/* _O_TEMPORARY on Windows removes file when last descriptor is closed */
#ifndef O_TEMPORARY
#  define O_TEMPORARY 0
#endif
 
/* _O_BINARY on Windows indicates whether to use binary or text (default) I/O.
 * Map the POSIX O_BINARY name to the Windows-specific _O_BINARY constant so
 * that code can use O_BINARY portably.  On POSIX systems all I/O is binary by
 * default, so define O_BINARY as 0 there (no flag needed). */
#ifndef O_BINARY
#  ifdef _O_BINARY
#    define O_BINARY _O_BINARY
#  else
#    define O_BINARY 0
#  endif
#endif
 
#endif /* BIO_H */
 
/** @} */
 
/*
 * Local Variables:
 * tab-width: 8
 * mode: C
 * indent-tabs-mode: t
 * c-file-style: "stroustrup"
 * End:
 * ex: shiftwidth=4 tabstop=8
 */