richio.cpp File Reference

#include <cstdarg>
#include <config.h>
#include <ignore.h>
#include <richio.h>
#include <errno.h>
#include <wx/file.h>
#include <wx/translation.h>

Go to the source code of this file.

Macros
#define	getc_unlocked   getc
#define	NESTWIDTH   2

Functions
static int	vprint (std::string *result, const char *format, va_list ap)
int	StrPrintf (std::string *result, const char *format,...)
	This is like sprintf() but the output is appended to a std::string instead of to a character array. More...
std::string	StrPrintf (const char *format,...)
	This is like sprintf() but the output is returned in a std::string instead of to a character array. More...

Macro Definition Documentation

getc_unlocked

#define getc_unlocked   getc

Definition at line 39 of file richio.cpp.

NESTWIDTH

#define NESTWIDTH   2

Function Documentation

StrPrintf() [1/2]

int StrPrintf	(	std::string *	aResult,
		const char *	aFormat,
			...
	)

This is like sprintf() but the output is appended to a std::string instead of to a character array.

Parameters

aResult	is the string to append to, previous text is not clear()ed.
aFormat	is a printf() style format string.

Returns

the count of bytes appended to the result string, no terminating nul is included.

Definition at line 79 of file richio.cpp.

{
    va_list     args;

    va_start( args, format );
    int ret = vprint( result, format, args );
    va_end( args );

    return ret;
}

References vprint().

Referenced by fmt_mask(), PCB_IO::format(), FormatProbeItem(), GenCADLayerName(), GenCADLayerNameFlipped(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), PCB_PARSER::init(), GENDRILL_WRITER_BASE::layerName(), PCB_EDIT_FRAME::OpenProjectFiles(), ReplaceIllegalFileNameChars(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), and SCH_EDIT_FRAME::SetCrossProbeConnection().

StrPrintf() [2/2]

std::string StrPrintf	(	const char *	format,
			...
	)

This is like sprintf() but the output is returned in a std::string instead of to a character array.

Parameters

format

is a printf() style format string.

Returns

std::string - the result of the sprintf().

Definition at line 91 of file richio.cpp.

{
    std::string ret;
    va_list     args;

    va_start( args, format );
    ignore_unused( vprint( &ret, format, args ) );
    va_end( args );

    return ret;
}

References ignore_unused(), and vprint().

vprint()

static int vprint ( std::string *  result, const char *  format, va_list  ap  )

static

Definition at line 43 of file richio.cpp.

{
    char    msg[512];
    // This function can call vsnprintf twice.
    // But internally, vsnprintf retrieves arguments from the va_list identified by arg as if
    // va_arg was used on it, and thus the state of the va_list is likely to be altered by the call.
    // see: www.cplusplus.com/reference/cstdio/vsnprintf
    // we make a copy of va_list ap for the second call, if happens
    va_list tmp;
    va_copy( tmp, ap );

    size_t  len = vsnprintf( msg, sizeof(msg), format, ap );

    if( len < sizeof(msg) )     // the output fit into msg
    {
        result->append( msg, msg + len );
    }
    else
    {
        // output was too big, so now incur the expense of allocating
        // a buf for holding suffient characters.

        std::vector<char>   buf;
        buf.reserve( len+1 );   // reserve(), not resize() which writes. +1 for trailing nul.

        len = vsnprintf( &buf[0], len+1, format, tmp );

        result->append( &buf[0], &buf[0] + len );
    }

    va_end( tmp );      // Release the temporary va_list, initialised from ap

    return len;
}

Referenced by StrPrintf().