epicsStdio.h File Reference

#include <stdio.h>
#include <stdarg.h>
#include "libComAPI.h"
#include "compilerDependencies.h"
#include "epicsTempFile.h"

Include dependency graph for epicsStdio.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	stdin   epicsGetStdin()
#define	stdout   epicsGetStdout()
#define	stderr   epicsGetStderr()
#define	printf   epicsStdoutPrintf
#define	puts   epicsStdoutPuts
#define	putchar   epicsStdoutPutchar

Enumerations
enum	TF_RETURN { TF_OK =0, TF_ERROR =1 }

Functions
LIBCOM_API int epicsStdCall	epicsSnprintf (char *str, size_t size, const char *format,...) EPICS_PRINTF_STYLE(3
LIBCOM_API int epicsStdCall LIBCOM_API int epicsStdCall	epicsVsnprintf (char *str, size_t size, const char *format, va_list ap)
LIBCOM_API enum TF_RETURN	truncateFile (const char *pFileName, unsigned long size)
LIBCOM_API FILE *epicsStdCall	epicsGetStdin (void)
LIBCOM_API FILE *epicsStdCall	epicsGetStdout (void)
LIBCOM_API FILE *epicsStdCall	epicsGetStderr (void)
LIBCOM_API FILE *epicsStdCall	epicsGetThreadStdin (void)
LIBCOM_API FILE *epicsStdCall	epicsGetThreadStdout (void)
LIBCOM_API FILE *epicsStdCall	epicsGetThreadStderr (void)
LIBCOM_API void epicsStdCall	epicsSetThreadStdin (FILE *)
LIBCOM_API void epicsStdCall	epicsSetThreadStdout (FILE *)
LIBCOM_API void epicsStdCall	epicsSetThreadStderr (FILE *)
LIBCOM_API int epicsStdCall	epicsStdoutPrintf (const char *pformat,...) EPICS_PRINTF_STYLE(1
LIBCOM_API int epicsStdCall LIBCOM_API int epicsStdCall	epicsStdoutPuts (const char *str)
LIBCOM_API int epicsStdCall	epicsStdoutPutchar (int c)

Macro Definition Documentation

#define printf   epicsStdoutPrintf

Definition at line 41 of file epicsStdio.h.

#define putchar   epicsStdoutPutchar

Definition at line 51 of file epicsStdio.h.

#define puts   epicsStdoutPuts

Definition at line 46 of file epicsStdio.h.

#define stderr   epicsGetStderr()

Definition at line 32 of file epicsStdio.h.

#define stdin   epicsGetStdin()

Definition at line 28 of file epicsStdio.h.

#define stdout   epicsGetStdout()

Definition at line 30 of file epicsStdio.h.

Enumeration Type Documentation

enum TF_RETURN

Enumerator
TF_OK
TF_ERROR

Definition at line 70 of file epicsStdio.h.

{TF_OK=0, TF_ERROR=1};

Function Documentation

LIBCOM_API FILE* epicsStdCall epicsGetStderr

(

void

)

Definition at line 56 of file epicsStdio.c.

{
    FILE *fp = epicsGetThreadStderr();

    if (!fp)
        fp = stderr;
    return fp;
}

LIBCOM_API FILE* epicsStdCall epicsGetStdin

(

void

)

Definition at line 38 of file epicsStdio.c.

{
    FILE *fp = epicsGetThreadStdin();

    if (!fp)
        fp = stdin;
    return fp;
}

LIBCOM_API FILE* epicsStdCall epicsGetStdout

(

void

)

Definition at line 47 of file epicsStdio.c.

{
    FILE *fp = epicsGetThreadStdout();

    if (!fp)
        fp = stdout;
    return fp;
}

LIBCOM_API FILE* epicsStdCall epicsGetThreadStderr

(

void

)

Definition at line 77 of file epicsStdio.c.

{
    /* Deliberately don't do the epicsThreadOnce() here; epicsThreadInit()
     * is allowed to use stderr inside its once() routine, in which case we
     * must return the OS's stderr instead. There may be a tiny chance of a
     * race happening here during initialization for some architectures, so
     * we only use it for stderr to reduce the chance of that happening.
     */
    if (!stderrThreadPrivateId)
        return NULL;
    return epicsThreadPrivateGet(stderrThreadPrivateId);
}

LIBCOM_API FILE* epicsStdCall epicsGetThreadStdin

(

void

)

Definition at line 65 of file epicsStdio.c.

{
    epicsThreadOnce(&onceId,once,0);
    return epicsThreadPrivateGet(stdinThreadPrivateId);
}

LIBCOM_API FILE* epicsStdCall epicsGetThreadStdout

(

void

)

Definition at line 71 of file epicsStdio.c.

{
    epicsThreadOnce(&onceId,once,0);
    return epicsThreadPrivateGet(stdoutThreadPrivateId);
}

LIBCOM_API void epicsStdCall epicsSetThreadStderr

(

FILE *

)

Definition at line 102 of file epicsStdio.c.

{
    epicsThreadOnce(&onceId,once,0);
    epicsThreadPrivateSet(stderrThreadPrivateId,fp);
}

LIBCOM_API void epicsStdCall epicsSetThreadStdin

(

FILE *

)

Definition at line 90 of file epicsStdio.c.

{
    epicsThreadOnce(&onceId,once,0);
    epicsThreadPrivateSet(stdinThreadPrivateId,fp);
}

LIBCOM_API void epicsStdCall epicsSetThreadStdout

(

FILE *

)

Definition at line 96 of file epicsStdio.c.

{
    epicsThreadOnce(&onceId,once,0);
    epicsThreadPrivateSet(stdoutThreadPrivateId,fp);
}

LIBCOM_API int epicsStdCall epicsSnprintf	(	char *	str,
		size_t	size,
		const char *	format,
			...
	)

LIBCOM_API int epicsStdCall epicsStdoutPrintf	(	const char *	pformat,
			...
	)

LIBCOM_API int epicsStdCall epicsStdoutPutchar

(

int

c

)

Definition at line 125 of file epicsStdio.c.

{
    return putc(c, epicsGetStdout());
}

LIBCOM_API int epicsStdCall LIBCOM_API int epicsStdCall epicsStdoutPuts

(

const char *

str

)

Definition at line 120 of file epicsStdio.c.

{
    return fprintf(epicsGetStdout(), "%s\n", str);
}

LIBCOM_API int epicsStdCall LIBCOM_API int epicsStdCall epicsVsnprintf	(	char *	str,
		size_t	size,
		const char *	format,
		va_list	ap
	)

Definition at line 26 of file osdStdio.c.

{
    return vsnprintf ( str, size, format, ap );
}

LIBCOM_API enum TF_RETURN truncateFile	(	const char *	pFileName,
		unsigned long	size
	)

Definition at line 27 of file truncateFile.c.

{
    long filePos;
    FILE *pFile;
    FILE *ptmp;
    int status;
    int c;
    unsigned charNo;

    /*
     * see cast of size to long below
     */
    if (size>LONG_MAX) {
        return TF_ERROR;
    }

    pFile = fopen(pFileName, "r");
    if (!pFile) {
        fprintf (stderr,
            "File access problems to `%s' because `%s'\n",
            pFileName,
            strerror(errno));
        return TF_ERROR;
    }

    /*
     * This is not required under UNIX but does appear
     * to be required under WIN32.
     */
    status = fseek (pFile, 0L, SEEK_END);
    if (status!=TF_OK) {
        fclose (pFile);
        return TF_ERROR;
    }

    filePos = ftell(pFile);
    if (filePos <= (long) size) {
        fclose (pFile);
        return TF_OK;
    }

    ptmp = epicsTempFile();
    if (!ptmp) {
        fprintf (stderr,
            "File access problems to temp file because `%s'\n",
            strerror(errno));
        fclose (pFile);
        return TF_ERROR;
    }
    rewind (pFile);
    charNo = 0u;
    while (charNo<size) {
        c = getc (pFile);
        if (c==EOF) {
            fprintf (stderr,
                "File access problems to temp file because `%s'\n",
                strerror(errno));
            fclose (pFile);
            fclose (ptmp);
            return TF_ERROR;
        }
        status = putc (c, ptmp);
        if (status==EOF) {
            fprintf(stderr,
                "File access problems to temp file because `%s'\n",
                strerror(errno));
            fclose (pFile);
            fclose (ptmp);
            return TF_ERROR;
        }
        charNo++;
    }
    fclose (pFile);
    pFile = fopen(pFileName, "w");
    if (!pFile) {
        fprintf (stderr,
            "File access problems to `%s' because `%s'\n",
            pFileName,
            strerror(errno));
        fclose (ptmp);
        return TF_ERROR;
    }
    rewind (ptmp);
    charNo = 0u;
    while (charNo<size) {
        c = getc (ptmp);
        if (c==EOF) {
            fprintf (stderr,
                "File access problems to temp file because `%s'\n",
                strerror(errno));
            fclose (pFile);
            fclose (ptmp);
            return TF_ERROR;
        }
        status = putc (c, pFile);
        if (status==EOF) {
            fprintf(stderr,
                "File access problems to `%s' because `%s'\n",
                pFileName,
                strerror(errno));
            fclose (pFile);
            fclose (ptmp);
            return TF_ERROR;
        }
        charNo++;
    }
    fclose(ptmp);
    fclose(pFile);
    return TF_OK;
}