#include <cstdarg>
#include <cstdio>
#include <cstdlib>
#include <cstring>
#include <iterator>
#include <unistd.h>
#include "debug.h"
#include "host.h"
#include "utils/color_out.h"

Include dependency graph for color_out.cpp:

Macros
#define	MOD_NAME "[color_out] "

Functions
bool	color_output_init ()
	sets internal variable color_stdout and retunrs its contents

int	color_printf (const char *format,...)

static bool	is_output_color ()

template<class OutputIt >
static int	prune_ansi_sequences (const char *in, OutputIt out)

void	prune_ansi_sequences_inplace (std::string &str)

char *	prune_ansi_sequences_inplace_cstr (char *cstr)

string	prune_ansi_sequences_str (const char *in)

Variables
static bool	color_stdout

Detailed Description

Author: Martin Pulec pulec.nosp@m.@ces.nosp@m.net.c.nosp@m.z

Definition in file color_out.cpp.

Macro Definition Documentation

◆ MOD_NAME

#define MOD_NAME "[color_out] "

Definition at line 53 of file color_out.cpp.

Referenced by is_output_color().

Function Documentation

◆ color_output_init()

bool color_output_init ( void )

sets internal variable color_stdout and retunrs its contents

Definition at line 168 of file color_out.cpp.

{
        color_stdout = is_output_color();
        return color_stdout;
}

References color_stdout, and is_output_color().

Referenced by Log_output::Log_output(), and common_preinit().

Here is the call graph for this function:

◆ color_printf()

int color_printf	(	const char *	format,
			... )

Definition at line 220 of file color_out.cpp.

                                          {
        va_list ap;
        va_start(ap, format);
        int size = vsnprintf(NULL, 0, format, ap);
        va_end(ap);
 
        // format the string
        auto buf = get_log_output().get_buffer();
        buf.append(size + 1, '\0');
        va_start(ap, format);
        vsnprintf(buf.data(), size + 1, format, ap);
        va_end(ap);
 
        if (!color_stdout) {
                int len = prune_ansi_sequences(buf.data(), buf.data());
                buf.get().resize(len);
        }
 
        buf.submit_raw();
        return size;
}

References Log_output::Buffer::append(), color_stdout, Log_output::get_buffer(), get_log_output(), len, prune_ansi_sequences(), and vsnprintf().

Here is the call graph for this function:

◆ is_output_color()

static bool is_output_color ( )

static

Returns: whether stdout can process ANSI escape sequences

Definition at line 140 of file color_out.cpp.

{
#ifdef HAVE_CONFIG_H
        const char *const param_val = get_commandline_param("log-color");
        if (param_val != nullptr) {
                return strcmp(param_val, "no") != 0;
        }
        if (get_commandline_param("log-nocolor") != nullptr) {
                fprintf(stderr,
                        MOD_NAME "The param log-nocolor is deprecated, use "
                                 "'log-color=no' instead\n");
                return false;
        }
#endif
        const char *env_val = getenv("ULTRAGRID_COLOR_OUT");
        if (env_val != nullptr && strlen(env_val) > 0) {
                return strcmp(env_val, "0") != 0;
        }
#ifdef _WIN32
        return isMsysPty(fileno(stdout)) ||
               (_isatty(fileno(stdout)) &&
                setWinTermAnsiColors(STD_OUTPUT_HANDLE));
#else
        return isatty(fileno(stdout));
#endif
}

References get_commandline_param(), and MOD_NAME.

Referenced by color_output_init().

Here is the call graph for this function:

◆ prune_ansi_sequences()

template<class OutputIt >

static int prune_ansi_sequences	(	const char *	in,
		OutputIt	out )

static

Definition at line 175 of file color_out.cpp.

                                                              {
        char c = *in;
        bool in_control = false;
        int written = 0;
        while (c != '\0') {
                switch (c) {
                        case '\033':
                                in_control = true;
                                break;
                        case 'm':
                                   if (in_control) {
                                           in_control = false;
                                           break;
                                   }
                                   // fall through
                        default:
                                   if (!in_control) {
                                           *out++ = c;
                                           written++;
                                   }
                }
                c = *++in;
        }
        *out = '\0';
        return written;
}

Referenced by color_printf(), prune_ansi_sequences_inplace(), prune_ansi_sequences_inplace_cstr(), and prune_ansi_sequences_str().

◆ prune_ansi_sequences_inplace()

void prune_ansi_sequences_inplace ( std::string & str )

Definition at line 208 of file color_out.cpp.

                                                 {
        auto c_ptr = str.data();
        auto len = prune_ansi_sequences(c_ptr, c_ptr);
        str.resize(len);
}

References len, and prune_ansi_sequences().

Referenced by log_vprintf().

Here is the call graph for this function:

◆ prune_ansi_sequences_inplace_cstr()

char * prune_ansi_sequences_inplace_cstr ( char * cstr )

Returns: cstr

Definition at line 215 of file color_out.cpp.

                                                    {
        prune_ansi_sequences(cstr, cstr);
        return cstr;
}

References prune_ansi_sequences().

Referenced by wrap_paragraph().

Here is the call graph for this function:

◆ prune_ansi_sequences_str()

string prune_ansi_sequences_str ( const char * in )

Definition at line 202 of file color_out.cpp.

                                                {
        string out;
        prune_ansi_sequences(in, std::back_inserter(out));
        return out;
}