stdio.h File Reference

#include <stdint.h>
#include <stdarg.h>

Go to the source code of this file.

Macros
#define	sprintf(buf, fmt, ...)   snprintf ( (buf), ~( ( size_t ) 0 ), (fmt), ## __VA_ARGS__ )
	Write a formatted string to a buffer. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
int	putchar (int character)
	Write a single character to each console device. More...
int	getchar (void)
	Read a single character from any console. More...
int	__attribute__ ((format(printf, 1, 2))) printf(const char *fmt
int int	__attribute__ ((format(printf, 3, 4))) snprintf(char *buf
int int size_t const char int	__attribute__ ((format(printf, 2, 3))) asprintf(char **strp
int int size_t const char int const char int	vprintf (const char *fmt, va_list args)
	Write a formatted string to the console. More...
int	vsnprintf (char *buf, size_t size, const char *fmt, va_list args)
	Write a formatted string to a buffer. More...
int	vasprintf (char **strp, const char *fmt, va_list args)
	Write a formatted string to newly allocated memory. More...
static int	vsprintf (char *buf, const char *fmt, va_list args)
	Write a formatted string to a buffer. More...

Variables
int int size_t	size
int int size_t const char *	fmt

Macro Definition Documentation

sprintf

#define sprintf	(		buf,
			fmt,
			...
	)		snprintf ( (buf), ~( ( size_t ) 0 ), (fmt), ## __VA_ARGS__ )

Write a formatted string to a buffer.

Parameters

buf	Buffer into which to write the string
fmt	Format string
...	Arguments corresponding to the format string

Return values

len	Length of formatted string

Definition at line 37 of file stdio.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

putchar()

int putchar

(

int

character

)

Write a single character to each console device.

Parameters

character

Character to be written

Return values

character

Character written

The character is written out to all enabled console devices, using each device's console_driver::putchar() method.

Definition at line 29 of file console.c.

                              {
        struct console_driver *console;

        /* Automatic LF -> CR,LF translation */
        if ( character == '\n' )
                putchar ( '\r' );

        for_each_table_entry ( console, CONSOLES ) {
                if ( ( ! ( console->disabled & CONSOLE_DISABLED_OUTPUT ) ) &&
                     ( console_usage & console->usage ) &&
                     console->putchar )
                        console->putchar ( character );
        }

        return character;
}

References CONSOLE_DISABLED_OUTPUT, console_usage, CONSOLES, console_driver::disabled, for_each_table_entry, putchar(), console_driver::putchar, and console_driver::usage.

Referenced by ansiscr_putc(), clrline(), eepro_poll(), epic100_open(), falcon_init_xmac(), get_eeprom_data(), int21(), monojob_clear(), print_user_string(), printf_putchar(), putchar(), readline_history(), and sync_console().

getchar()

int getchar

(

void

)

Read a single character from any console.

Return values

character

Character read from a console.

A character will be read from the first enabled console device that has input available using that console's console_driver::getchar() method. If no console has input available to be read, this method will block. To perform a non-blocking read, use something like

int key = iskey() ? getchar() : -1;

The character read will not be echoed back to any console.

Definition at line 86 of file console.c.

                     {
        struct console_driver *console;
        int character;

        while ( 1 ) {
                console = has_input();
                if ( console && console->getchar ) {
                        character = console->getchar ();
                        break;
                }

                /* Doze for a while (until the next interrupt).  This works
                 * fine, because the keyboard is interrupt-driven, and the
                 * timer interrupt (approx. every 50msec) takes care of the
                 * serial port, which is read by polling.  This reduces the
                 * power dissipation of a modern CPU considerably, and also
                 * makes Etherboot waiting for user interaction waste a lot
                 * less CPU time in a VMware session.
                 */
                cpu_nap();

                /* Keep processing background tasks while we wait for
                 * input.
                 */
                step();
        }

        /* CR -> LF translation */
        if ( character == '\r' )
                character = '\n';

        return character;
}

References cpu_nap(), console_driver::getchar, has_input(), and step().

Referenced by ansiscr_getc(), dbg_more(), dbg_pause(), getchar_timeout(), int21(), keypress_interrupted(), loopback_wait(), and monojob_wait().

__attribute__() [1/3]

int __attribute__

(

(format(printf, 1, 2))

)

const

__attribute__() [2/3]

int int __attribute__

(

(format(printf, 3, 4))

)

__attribute__() [3/3]

int int size_t const char int __attribute__

(

(format(printf, 2, 3))

)

vprintf()

int int size_t const char int const char int vprintf	(	const char *	fmt,
		va_list	args
	)

Write a formatted string to the console.

Parameters

fmt	Format string
args	Arguments corresponding to the format string

Return values

len	Length of formatted string

Definition at line 450 of file vsprintf.c.

                                              {
        struct printf_context ctx;

        /* Hand off to vcprintf */
        ctx.handler = printf_putchar;   
        return vcprintf ( &ctx, fmt, args );    
}

References ctx, fmt, printf_putchar(), and vcprintf().

Referenced by dbg_printf(), log_vprintf(), and printf().

vsnprintf()

int vsnprintf	(	char *	buf,
		size_t	size,
		const char *	fmt,
		va_list	args
	)

Write a formatted string to a buffer.

Parameters

buf	Buffer into which to write the string
size	Size of buffer
fmt	Format string
args	Arguments corresponding to the format string

Return values

len	Length of formatted string

If the buffer is too small to contain the string, the returned length is the length that would have been written had enough space been available.

Definition at line 352 of file vsprintf.c.

                                                                        {
        struct sputc_context sctx;
        size_t len;
        size_t end;

        /* Hand off to vcprintf */
        sctx.ctx.handler = printf_sputc;
        sctx.buf = buf;
        sctx.max_len = size;
        len = vcprintf ( &sctx.ctx, fmt, args );

        /* Add trailing NUL */
        if ( size ) {
                end = size - 1;
                if ( len < end )
                        end = len;
                buf[end] = '\0';
        }

        return len;
}

References sputc_context::buf, sputc_context::ctx, end, fmt, printf_context::handler, len, sputc_context::max_len, printf_sputc(), size, and vcprintf().

Referenced by ipair_tx(), snprintf(), snprintf_okx(), vasprintf(), vmsg(), vsprintf(), and vssnprintf().

vasprintf()

int vasprintf	(	char **	strp,
		const char *	fmt,
		va_list	args
	)

Write a formatted string to newly allocated memory.

Parameters

strp	Pointer to hold allocated string
fmt	Format string
args	Arguments corresponding to the format string

Return values

len	Length of formatted string

Definition at line 18 of file asprintf.c.

                                                             {
        size_t len;
        va_list args_tmp;

        /* Calculate length needed for string */
        va_copy ( args_tmp, args );
        len = ( vsnprintf ( NULL, 0, fmt, args_tmp ) + 1 );
        va_end ( args_tmp );

        /* Allocate and fill string */
        *strp = malloc ( len );
        if ( ! *strp )
                return -ENOMEM;
        return vsnprintf ( *strp, len, fmt, args );
}

References ENOMEM, fmt, len, malloc(), NULL, va_copy, va_end, and vsnprintf().

Referenced by asprintf(), and xfer_vprintf().

vsprintf()

static int vsprintf ( char *  buf, const char *  fmt, va_list  args  )

inlinestatic

Write a formatted string to a buffer.

Parameters

buf	Buffer into which to write the string
fmt	Format string
args	Arguments corresponding to the format string

Return values

len	Length of formatted string

Definition at line 48 of file stdio.h.

                                                                        {
        return vsnprintf ( buf, ~( ( size_t ) 0 ), fmt, args );
}

References fmt, and vsnprintf().

Variable Documentation

size

int int size_t size

Definition at line 18 of file stdio.h.

fmt

int int size_t const char int const char* fmt

Definition at line 18 of file stdio.h.

Referenced by vsprintf().