commandlineutils.h File Reference

#include "../global.h"
#include <optional>
#include <ostream>

Include dependency graph for commandlineutils.h:

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

Go to the source code of this file.

Classes
struct	CppUtilities::TerminalSize
	The TerminalSize struct describes a terminal size. More...
class	CppUtilities::Indentation
	The Indentation class allows printing indentation conveniently, eg. More...

Namespaces
namespace	CppUtilities
	Contains all utilities provided by the c++utilities library.

Macros
#define	CMD_UTILS_START_CONSOLE
#define	CMD_UTILS_CONVERT_ARGS_TO_UTF8
#define	CMD_UTILS_HANDLE_VIRTUAL_TERMINAL_PROCESSING

Enumerations
enum class	CppUtilities::Response { CppUtilities::None , CppUtilities::Yes , CppUtilities::No }
	The Response enum is used to specify the default response for the confirmPrompt() method. More...

Functions
CPP_UTILITIES_EXPORT bool	CppUtilities::confirmPrompt (const char *message, Response defaultResponse)
	Prompts for confirmation displaying the specified message.
CPP_UTILITIES_EXPORT std::optional< bool >	CppUtilities::isEnvVariableSet (const char *variableName)
	Returns whether the specified env variable is set to a non-zero and non-white-space-only value.
CPP_UTILITIES_EXPORT TerminalSize	CppUtilities::determineTerminalSize ()
	Returns the current size of the terminal.
CPP_UTILITIES_EXPORT std::ostream &	CppUtilities::operator<< (std::ostream &out, Indentation indentation)

Macro Definition Documentation

CMD_UTILS_CONVERT_ARGS_TO_UTF8

#define CMD_UTILS_CONVERT_ARGS_TO_UTF8

Definition at line 36 of file commandlineutils.h.

CMD_UTILS_HANDLE_VIRTUAL_TERMINAL_PROCESSING

#define CMD_UTILS_HANDLE_VIRTUAL_TERMINAL_PROCESSING

Definition at line 37 of file commandlineutils.h.

CMD_UTILS_START_CONSOLE

#define CMD_UTILS_START_CONSOLE

Definition at line 35 of file commandlineutils.h.