bio.h

Go to the documentation of this file.

/*                           B I O . H
 * BRL-CAD
 *
 * Copyright (c) 2008-2023 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>
 
/* strict mode may not declare fileno() */
# if !defined(fileno) && !defined(__cplusplus)
extern int fileno(FILE *stream);
# endif
 
#if defined(_WIN32) && !defined(__CYGWIN__)
 
#  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
 
#  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 */
#ifndef O_BINARY
#  define O_BINARY 0
#endif
 
/* the S_IS* macros should replace the S_IF*'s
   already defined in C99 compliant compilers
   this is the work-around for older compilers */
#ifndef S_ISBLK
#  ifdef S_IFBLK
#    define S_ISBLK(mode) (((mode) & S_IFMT) == S_IFBLK)
#  else
#    define S_ISBLK(mode) (0)
#  endif
#endif
#ifndef S_ISCHR
#  ifdef S_IFCHR
#    define S_ISCHR(mode) (((mode) & S_IFMT) == S_IFCHR)
#  else
#    define S_ISCHR(mode) (0)
#  endif
#endif
#ifndef S_ISDIR
#  ifdef S_IFDIR
#    define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)
#  else
#    define S_ISDIR(mode) (0)
#  endif
#endif
#ifndef S_ISFIFO
#  ifdef S_IFIFO
#    define S_ISFIFO(mode) (((mode) & S_IFMT) == S_IFIFO)
#  else
#    define S_ISFIFO(mode) (0)
#  endif
#endif
#ifndef S_ISLNK
#  ifdef S_IFLNK
#    define S_ISLNK(mode) (((mode) & S_IFMT) == S_IFLNK)
#  else
#    define S_ISLNK(mode) (0)
#  endif
#endif
#ifndef S_ISREG
#  ifdef S_IFREG
#    define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG)
#  else
#    define S_ISREG(mode) (0)
#  endif
#endif
#ifndef S_ISSOCK
#  ifdef S_IFSOCK
#    define S_ISSOCK(mode) (((mode) & S_IFMT) == S_IFSOCK)
#  else
#    define S_ISSOCK(mode) (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
 */