mirror of
https://git.tukaani.org/xz.git
synced 2024-04-04 12:36:23 +02:00
132 lines
4.1 KiB
C
132 lines
4.1 KiB
C
///////////////////////////////////////////////////////////////////////////////
|
|
//
|
|
/// \file message.h
|
|
/// \brief Printing messages to stderr
|
|
//
|
|
// Author: Lasse Collin
|
|
//
|
|
// This file has been put into the public domain.
|
|
// You can do whatever you want with this file.
|
|
//
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
/// Verbosity levels
|
|
enum message_verbosity {
|
|
V_SILENT, ///< No messages
|
|
V_ERROR, ///< Only error messages
|
|
V_WARNING, ///< Errors and warnings
|
|
V_VERBOSE, ///< Errors, warnings, and verbose statistics
|
|
V_DEBUG, ///< Debugging, FIXME remove?
|
|
};
|
|
|
|
|
|
/// \brief Initializes the message functions
|
|
///
|
|
/// \param argv0 Name of the program i.e. argv[0] from main()
|
|
/// \param verbosity Verbosity level
|
|
///
|
|
/// If an error occurs, this function doesn't return.
|
|
///
|
|
extern void message_init(const char *argv0);
|
|
|
|
|
|
/// Increase verbosity level by one step unless it was at maximum.
|
|
extern void message_verbosity_increase(void);
|
|
|
|
/// Decrease verbosity level by one step unless it was at minimum.
|
|
extern void message_verbosity_decrease(void);
|
|
|
|
|
|
/// Set the total number of files to be processed (stdin is counted as a file
|
|
/// here). The default is one.
|
|
extern void message_set_files(unsigned int files);
|
|
|
|
|
|
/// \brief Print a message if verbosity level is at least "verbosity"
|
|
///
|
|
/// This doesn't touch the exit status.
|
|
extern void message(enum message_verbosity verbosity, const char *fmt, ...)
|
|
lzma_attribute((format(printf, 2, 3)));
|
|
|
|
|
|
/// \brief 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.
|
|
extern void message_warning(const char *fmt, ...)
|
|
lzma_attribute((format(printf, 1, 2)));
|
|
|
|
|
|
/// \brief 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.
|
|
extern void message_error(const char *fmt, ...)
|
|
lzma_attribute((format(printf, 1, 2)));
|
|
|
|
|
|
/// \brief Prints an error message and exits with EXIT_ERROR
|
|
///
|
|
/// The message is printed only if verbosity level is at least V_ERROR.
|
|
extern void message_fatal(const char *fmt, ...)
|
|
lzma_attribute((format(printf, 1, 2)))
|
|
lzma_attribute((noreturn));
|
|
|
|
|
|
/// Print an error message that an internal error occurred and exit with
|
|
/// EXIT_ERROR.
|
|
extern void message_bug(void) lzma_attribute((noreturn));
|
|
|
|
|
|
/// Print a message that establishing signal handlers failed, and exit with
|
|
/// exit status ERROR.
|
|
extern void message_signal_handler(void) lzma_attribute((noreturn));
|
|
|
|
|
|
/// Convert lzma_ret to a string.
|
|
extern const char *message_strm(lzma_ret code);
|
|
|
|
|
|
/// Print the filter chain.
|
|
extern void message_filters(
|
|
enum message_verbosity v, const lzma_filter *filters);
|
|
|
|
|
|
/// Print a message that user should try --help.
|
|
extern void message_try_help(void);
|
|
|
|
|
|
/// Prints the version number to stdout and exits with exit status SUCCESS.
|
|
extern void message_version(void) lzma_attribute((noreturn));
|
|
|
|
|
|
/// Print the help message.
|
|
extern void message_help(bool long_help) lzma_attribute((noreturn));
|
|
|
|
|
|
/// \brief Start progress info handling
|
|
///
|
|
/// This must be paired with a call to message_progress_end() before the
|
|
/// given *strm becomes invalid.
|
|
///
|
|
/// \param strm Pointer to lzma_stream used for the coding.
|
|
/// \param filename Name of the input file. stdin_filename is
|
|
/// handled specially.
|
|
/// \param in_size Size of the input file, or zero if unknown.
|
|
///
|
|
extern void message_progress_start(
|
|
lzma_stream *strm, const char *filename, uint64_t in_size);
|
|
|
|
|
|
/// 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.
|
|
extern void message_progress_update(void);
|
|
|
|
|
|
/// \brief Finishes the progress message if we were in verbose mode
|
|
///
|
|
/// \param finished True if the whole stream was successfully coded
|
|
/// and output written to the output stream.
|
|
///
|
|
extern void message_progress_end(bool finished);
|