message.h File Reference

Printing messages to stderr. More...

Go to the source code of this file.

Enumerations
enum	message_verbosity {   V_SILENT , V_ERROR , V_WARNING , V_VERBOSE ,   V_DEBUG }
	Verbosity levels. More...

Functions
void	message_init (void)
	Initializes the message functions.
void	message_verbosity_increase (void)
	Increase verbosity level by one step unless it was at maximum.
void	message_verbosity_decrease (void)
	Decrease verbosity level by one step unless it was at minimum.
enum message_verbosity	message_verbosity_get (void)
	Get the current verbosity level.
void	message (enum message_verbosity verbosity, const char *fmt,...) lzma_attribute((__format__(__printf__
	Print a message if verbosity level is at least "verbosity".
void void	message_warning (const char *fmt,...) lzma_attribute((__format__(__printf__
	Prints a warning and possibly sets exit status.
void void void	message_error (const char *fmt,...) lzma_attribute((__format__(__printf__
	Prints an error message and sets exit status.
void void void void	message_fatal (const char *fmt,...) lzma_attribute((__format__(__printf__
	Prints an error message and exits with EXIT_ERROR.
void void void void	lzma_attribute ((__noreturn__))
void	message_bug (void) lzma_attribute((__noreturn__))
void	message_signal_handler (void) lzma_attribute((__noreturn__))
const char *	message_strm (lzma_ret code)
	Convert lzma_ret to a string.
void	message_mem_needed (enum message_verbosity v, uint64_t memusage)
	Display how much memory was needed and how much the limit was.
void	message_filters_show (enum message_verbosity v, const lzma_filter *filters)
	Print the filter chain.
void	message_try_help (void)
	Print a message that user should try –help.
void	message_version (void) lzma_attribute((__noreturn__))
	Prints the version number to stdout and exits with exit status SUCCESS.
void	message_help (bool long_help) lzma_attribute((__noreturn__))
	Print the help message.
void	message_set_files (unsigned int files)
	Set the total number of files to be processed.
void	message_filename (const char *src_name)
	Set the name of the current file and possibly print it too.
void	message_progress_start (lzma_stream *strm, bool is_passthru, uint64_t in_size)
	Start progress info handling.
void	message_progress_update (void)
void	message_progress_end (bool finished)
	Finishes the progress message if we were in verbose mode.

Variables
const int	message_progress_sigs []
	Signals used for progress message handling.

Detailed Description

Printing messages to stderr.

Enumeration Type Documentation

message_verbosity

enum message_verbosity

Verbosity levels.

Enumerator
V_SILENT	No messages.
V_ERROR	Only error messages.
V_WARNING	Errors and warnings.
V_VERBOSE	Errors, warnings, and verbose statistics.
V_DEBUG	Very verbose.

Function Documentation

lzma_attribute()

static void lzma_attribute

(

(__noreturn__)

)

message()

void message ( enum message_verbosity verbosity, const char * fmt, ... )

extern

Print a message if verbosity level is at least "verbosity".

This doesn't touch the exit status.

message_bug()

void message_bug ( void )

extern

Print an error message that an internal error occurred and exit with EXIT_ERROR.

message_error()

void void void message_error ( const char * fmt, ... )

extern

Prints an error message and sets exit status.

The message is printed only if verbosity level is at least V_ERROR. The exit status is set to ERROR.

message_fatal()

void void void void message_fatal ( const char * fmt, ... )

extern

Prints an error message and exits with EXIT_ERROR.

The message is printed only if verbosity level is at least V_ERROR.

message_filename()

void message_filename ( const char * src_name )

extern

Set the name of the current file and possibly print it too.

The name is printed immediately if –list was used or if –verbose was used and stderr is a terminal. Even when the filename isn't printed, it is stored so that it can be printed later if needed for progress messages.

message_filters_show()

void message_filters_show ( enum message_verbosity v, const lzma_filter * filters )

extern

Print the filter chain.

message_help()

void message_help ( bool long_help )

extern

Print the help message.

message_init()

void message_init ( void )

extern

Initializes the message functions.

If an error occurs, this function doesn't return.

message_mem_needed()

void message_mem_needed ( enum message_verbosity v, uint64_t memusage )

extern

Display how much memory was needed and how much the limit was.

message_progress_end()

void message_progress_end ( bool finished )

extern

Finishes the progress message if we were in verbose mode.

Parameters

finished

True if the whole stream was successfully coded and output written to the output stream.

message_progress_start()

void message_progress_start ( lzma_stream * strm, bool is_passthru, uint64_t in_size )

extern

Start progress info handling.

message_filename() must be called before this function to set the filename.

This must be paired with a call to message_progress_end() before the given *strm becomes invalid.

Parameters

strm	Pointer to lzma_stream used for the coding.
in_size	Size of the input file, or zero if unknown.

message_progress_update()

void message_progress_update ( void )

extern

Update the progress info if in verbose mode and enough time has passed since the previous update. This can be called only when message_progress_start() has already been used.

message_set_files()

void message_set_files ( unsigned int files )

extern

Set the total number of files to be processed.

Standard input is counted as a file here. This is used when printing the filename via message_filename().

message_signal_handler()

void message_signal_handler ( void )

extern

Print a message that establishing signal handlers failed, and exit with exit status ERROR.

message_strm()

const char * message_strm ( lzma_ret code )

extern

Convert lzma_ret to a string.

message_try_help()

void message_try_help ( void )

extern

Print a message that user should try –help.

message_verbosity_decrease()

void message_verbosity_decrease ( void )

extern

Decrease verbosity level by one step unless it was at minimum.

message_verbosity_get()

enum message_verbosity message_verbosity_get ( void )

extern

Get the current verbosity level.

message_verbosity_increase()

void message_verbosity_increase ( void )

extern

Increase verbosity level by one step unless it was at maximum.

message_version()

void message_version ( void )

extern

Prints the version number to stdout and exits with exit status SUCCESS.

message_warning()

void void message_warning ( const char * fmt, ... )

extern

Prints a warning and possibly sets exit status.

The message is printed only if verbosity level is at least V_WARNING. The exit status is set to WARNING unless it was already at ERROR.

Variable Documentation

message_progress_sigs

const int message_progress_sigs[]

extern

Signals used for progress message handling.