SYS_Stdio.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        SYS_Stdio.h (SYS Library, C++)
 *
 * COMMENTS:    Platform-independent wrappers for functions in <stdio.h>
 */

#pragma once

#ifndef __SYS_STDIO_H_INCLUDED__
#define __SYS_STDIO_H_INCLUDED__

/// @file SYS_Stdio.h
/// Portable stdio.h replacements, primarily breaking broken Windows
/// implementations.

#include "SYS_API.h"
#include "SYS_Inline.h"
#include "SYS_Types.h"

#include <stdio.h>

#ifndef _WIN32
#include <unistd.h> // for rmdir()
#endif

/// @internal
#if SYS_HEADER_ONLY
    #include "SYS_Stdio.C"
#elif defined(_WIN32)
    SYS_API extern FILE *SYSfopenNT(const char *filename, const char *mode);
    SYS_API extern int SYSremoveNT(const char *path);
    SYS_API extern int SYSrmdirNT(const char *path);
#endif

/// Portable replacement for fopen() to allow UTF-8 paths on Windows
static inline FILE*
SYSfopen(const char *filename, const char *mode)
{
#ifdef _WIN32
    return SYSfopenNT(filename, mode);
#else
    return fopen(filename, mode);
#endif
}

/// Portable replacement for remove() to allow UTF-8 paths on Windows.
/// Unlike the CRT remove(), we satisfy the POSIX requirement that if path
/// is a directory, then it's equivalent to calling rmdir(path),
static inline int
SYSremove(const char *path)
{
#ifdef _WIN32
    return SYSremoveNT(path);
#else
    return remove(path);
#endif
}

/// Portable replacement for rmdir() to allow UTF-8 paths on Windows
static inline int
SYSrmdir(const char *path)
{
#ifdef _WIN32
    return SYSrmdirNT(path);
#else
    return rmdir(path);
#endif
}

/// Portable replacement for fseek() to use 64-bit file offsets
static inline int
SYSfseek(FILE *stream, int64 offset, int whence)
{
#ifdef _WIN32
    return _fseeki64(stream, offset, whence);
#else
    // fseeko uses 64-bit offsets even on 32-bit platforms when
    // _FILE_OFFSET_BITS is defined as 64.
    return fseeko(stream, offset, whence);
#endif
}

/// Portable replacement for ftell() to return 64-bit file offsets
static inline int64
SYSftell(FILE *stream)
{
#ifdef _WIN32
    return _ftelli64(stream);
#else
    // ftello uses 64-bit offsets even on 32-bit platforms when
    // _FILE_OFFSET_BITS is defined as 64.
    return ftello(stream);
#endif
}

#endif // __SYS_STDIO_H_INCLUDED__