/* * * Conky, a system monitor, based on torsmo * * Any original torsmo code is licensed under the BSD license * * All code written since the fork of torsmo is licensed under the GPL * * Please see COPYING for details * * Copyright (c) 2004, Hannu Saransaari and Lauri Hakkarainen * Copyright (c) 2005-2024 Brenden Matthews, Philip Kovacs, et. al. * (see AUTHORS) * All rights reserved. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * You should have received a copy of the GNU General Public License * along with this program. If not, see . * */ #include "conky.h" #ifdef BUILD_GUI #include "fonts.h" #include "gui.h" #endif /* BUILD_GUI */ #include #include "logging.h" #include "nc.h" #include "specials.h" #ifdef HAVE_SYS_PARAM_H #include #endif /* HAVE_SYS_PARAM_H */ #include #include #include #include "colours.h" #include "common.h" #include "conky.h" #include "display-output.hh" struct special_node *specials = nullptr; int special_count; int graph_count = 0; std::map graphs; namespace { conky::range_config_setting default_bar_width( "default_bar_width", 0, std::numeric_limits::max(), 0, false); conky::range_config_setting default_bar_height( "default_bar_height", 0, std::numeric_limits::max(), 6, false); #ifdef BUILD_GUI conky::range_config_setting default_graph_width( "default_graph_width", 0, std::numeric_limits::max(), 0, false); conky::range_config_setting default_graph_height( "default_graph_height", 0, std::numeric_limits::max(), 25, false); conky::range_config_setting default_gauge_width( "default_gauge_width", 0, std::numeric_limits::max(), 40, false); conky::range_config_setting default_gauge_height( "default_gauge_height", 0, std::numeric_limits::max(), 25, false); conky::simple_config_setting store_graph_data_explicitly( "store_graph_data_explicitly", true, true); #endif /* BUILD_GUI */ conky::simple_config_setting console_graph_ticks( "console_graph_ticks", " ,_,=,#", false); } // namespace /* special data types flags */ #define SF_SCALED (1 << 0) #define SF_SHOWLOG (1 << 1) /* * Special data typedefs */ struct bar { char flags; int width, height; double scale; }; struct gauge { char flags; int width, height; double scale; }; struct graph { int id; char flags; int width, height; bool colours_set; Colour first_colour, last_colour; double scale; char tempgrad; }; struct stippled_hr { int height, arg; }; struct tab { int width, arg; }; /* * Scanning arguments to various special text objects */ #ifdef BUILD_GUI const char *scan_gauge(struct text_object *obj, const char *args, double scale) { struct gauge *g; g = static_cast(malloc(sizeof(struct gauge))); memset(g, 0, sizeof(struct gauge)); /*width and height*/ g->width = default_gauge_width.get(*state); g->height = default_gauge_height.get(*state); if (scale != 0.0) { g->scale = scale; } else { g->flags |= SF_SCALED; } /* gauge's argument is either height or height,width */ if (args != nullptr) { int n = 0; if (sscanf(args, "%d,%d %n", &g->height, &g->width, &n) <= 1) { if (sscanf(args, "%d %n", &g->height, &n) == 2) { g->width = g->height; /*square gauge*/ } } args += n; } obj->special_data = g; return args; } #endif const char *scan_bar(struct text_object *obj, const char *args, double scale) { struct bar *b; b = static_cast(malloc(sizeof(struct bar))); memset(b, 0, sizeof(struct bar)); /* zero width means all space that is available */ b->width = default_bar_width.get(*state); b->height = default_bar_height.get(*state); if (scale != 0.0) { b->scale = scale; } else { b->flags |= SF_SCALED; } /* bar's argument is either height or height,width */ if (args != nullptr) { int n = 0; if (sscanf(args, "%d,%d %n", &b->height, &b->width, &n) <= 1) { sscanf(args, "%d %n", &b->height, &n); } args += n; } obj->special_data = b; return args; } #ifdef BUILD_GUI void scan_font(struct text_object *obj, const char *args) { if ((args != nullptr) && (*args != 0)) { obj->data.s = strndup(args, DEFAULT_TEXT_BUFFER_SIZE); } } void apply_graph_colours(struct graph *g, const char *first_colour_name, const char *last_colour_name) { g->first_colour = parse_color(first_colour_name); g->last_colour = parse_color(last_colour_name); g->colours_set = true; } /** * parses a possibly-quoted command from the prefix of a string. * @param[in] s argument string to parse * @return pair of the command and the number of bytes parsed (counting quotes). * The command will be nullptr if the string to parse started with a * digit or an unpaired double-quote. **/ std::pair scan_command(const char *s) { if (s == nullptr) return {nullptr, 0}; /* unquoted commands are not permitted to begin with digits. This allows distinguishing a commands from a position in execgraph objects */ if (isdigit(*s)) { return {nullptr, 0}; } /* extract double-quoted command in case of execgraph */ if (*s == '"') { size_t _size; char *_ptr; if (((_ptr = const_cast(strrchr(s, '"'))) != nullptr) && _ptr != s) { _size = _ptr - s - 1; } else { NORM_ERR("mismatched double-quote in execgraph object"); return {nullptr, 0}; } char *quoted_cmd = static_cast(malloc(_size + 1)); quoted_cmd[0] = '\0'; strncpy(quoted_cmd, s + 1, _size); quoted_cmd[_size] = '\0'; return {quoted_cmd, _size + 2}; } else { size_t len; for (len = 0; s[len] != '\0' && !isspace(s[len]); len++) ; return {strndup(s, len), len}; } } /** * parses for [height,width] [color1 color2] [scale] [-t] [-l] * * -l will set the showlog flag, enabling logarithmic graph scales * -t will set the tempgrad member to true, enabling temperature gradient colors * * @param[out] obj struct in which to save width, height and other options * @param[in] args argument string to parse * @param[in] defscale default scale if no scale argument given * @return whether parsing was successful **/ bool scan_graph(struct text_object *obj, const char *argstr, double defscale) { char first_colour_name[1024] = {'\0'}; char last_colour_name[1024] = {'\0'}; auto *g = static_cast(malloc(sizeof(struct graph))); memset(g, 0, sizeof(struct graph)); obj->special_data = g; g->id = ++graph_count; /* zero width means all space that is available */ g->width = default_graph_width.get(*state); g->height = default_graph_height.get(*state); g->colours_set = false; g->first_colour = Colour(); g->last_colour = Colour(); g->scale = defscale; g->tempgrad = FALSE; if (argstr == nullptr) return false; /* set tempgrad to true if '-t' specified. * It doesn't matter where the argument is exactly. */ if ((strstr(argstr, " " TEMPGRAD) != nullptr) || strncmp(argstr, TEMPGRAD, strlen(TEMPGRAD)) == 0) { g->tempgrad = TRUE; } /* set showlog flag if '-l' specified. * It doesn't matter where the argument is exactly. */ if ((strstr(argstr, " " LOGGRAPH) != nullptr) || strncmp(argstr, LOGGRAPH, strlen(LOGGRAPH)) == 0) { g->flags |= SF_SHOWLOG; } /* all the following functions try to interpret the beginning of a * a string with different format strings. If successful, they return from * the function */ /* interpret the beginning(!) of the argument string as: * '[height],[width] [color1] [color2] [scale]' * This means parameters like -t and -l may not be in the beginning */ if (sscanf(argstr, "%d,%d %s %s %lf", &g->height, &g->width, first_colour_name, last_colour_name, &g->scale) == 5) { apply_graph_colours(g, first_colour_name, last_colour_name); return true; } g->height = default_graph_height.get(*state); g->width = default_graph_width.get(*state); first_colour_name[0] = '\0'; last_colour_name[0] = '\0'; g->scale = defscale; /* [height],[width] [color1] [color2] */ if (sscanf(argstr, "%d,%d %s %s", &g->height, &g->width, first_colour_name, last_colour_name) == 4) { apply_graph_colours(g, first_colour_name, last_colour_name); return true; } g->height = default_graph_height.get(*state); g->width = default_graph_width.get(*state); first_colour_name[0] = '\0'; /* [height],[width] [scale] */ if (sscanf(argstr, "%d,%d %lf", &g->height, &g->width, &g->scale) == 3) { return true; } g->height = default_graph_height.get(*state); g->width = default_graph_width.get(*state); /* [height],[width] */ if (sscanf(argstr, "%d,%d", &g->height, &g->width) == 2) { return true; } g->height = default_graph_height.get(*state); g->width = default_graph_width.get(*state); /* [height], */ char comma; if (sscanf(argstr, "%d%[,]", &g->height, &comma) == 2) { return true; } g->height = default_graph_height.get(*state); /* [color1] [color2] [scale] */ if (sscanf(argstr, "%s %s %lf", first_colour_name, last_colour_name, &g->scale) == 3) { apply_graph_colours(g, first_colour_name, last_colour_name); return true; } first_colour_name[0] = '\0'; last_colour_name[0] = '\0'; g->scale = defscale; /* [color1] [color2] */ if (sscanf(argstr, "%s %s", first_colour_name, last_colour_name) == 2) { apply_graph_colours(g, first_colour_name, last_colour_name); return true; } /* [scale] */ if (sscanf(argstr, "%lf", &g->scale) == 1) { return true; } return true; } #endif /* BUILD_GUI */ /* * Printing various special text objects */ struct special_node *new_special_t_node() { auto *newnode = new special_node; memset(newnode, 0, sizeof *newnode); return newnode; } /** * expands the current global linked list specials to special_count elements * * increases special_count * @param[out] buf is set to "\x01\x00" not sure why ??? * @param[in] t special type enum, e.g. alignc, alignr, fg, bg, ... * @return pointer to the newly inserted special of type t **/ struct special_node *new_special(char *buf, text_node_t t) { special_node *current; buf[0] = SPECIAL_CHAR; buf[1] = '\0'; if (specials == nullptr) { specials = new_special_t_node(); } current = specials; /* allocate special_count linked list elements */ for (int i = 0; i < special_count; i++) { if (current->next == nullptr) { current->next = new_special_t_node(); } current = current->next; } current->type = t; special_count++; return current; } void new_gauge_in_shell(struct text_object *obj, char *p, unsigned int p_max_size, double usage) { static const char *gaugevals[] = {"_. ", "\\. ", " | ", " ./", " ._"}; auto *g = static_cast(obj->special_data); snprintf(p, p_max_size, "%s", gaugevals[round_to_positive_int(usage * 4 / g->scale)]); } #ifdef BUILD_GUI void new_gauge_in_gui(struct text_object *obj, char *buf, double usage) { struct special_node *s = nullptr; auto *g = static_cast(obj->special_data); if (display_output() == nullptr || !display_output()->graphical()) { return; } if (g == nullptr) { return; } s = new_special(buf, text_node_t::GAUGE); s->arg = usage; s->width = dpi_scale(g->width); s->height = dpi_scale(g->height); s->scale = g->scale; } #endif /* BUILD_GUI */ void new_gauge(struct text_object *obj, char *p, unsigned int p_max_size, double usage) { auto *g = static_cast(obj->special_data); if ((p_max_size == 0) || (g == nullptr)) { return; } if ((g->flags & SF_SCALED) != 0) { g->scale = std::max(g->scale, usage); } else { usage = std::min(g->scale, usage); } #ifdef BUILD_GUI if (display_output() && display_output()->graphical()) { new_gauge_in_gui(obj, p, usage); } if (out_to_stdout.get(*state)) { new_gauge_in_shell(obj, p, p_max_size, usage); } #else /* BUILD_GUI */ new_gauge_in_shell(obj, p, p_max_size, usage); #endif /* BUILD_GUI */ } #ifdef BUILD_GUI void new_font(struct text_object *obj, char *p, unsigned int p_max_size) { struct special_node *s; unsigned int tmp = selected_font; if (display_output() == nullptr || !display_output()->graphical()) { return; } if (p_max_size == 0) { return; } s = new_special(p, text_node_t::FONT); if (obj->data.s != nullptr) { if (s->font_added >= static_cast(fonts.size()) || (s->font_added == 0) || obj->data.s != fonts[s->font_added].name) { selected_font = s->font_added = add_font(obj->data.s); selected_font = tmp; } } else { selected_font = s->font_added = 0; selected_font = tmp; } } /** * Adds value f to graph possibly truncating and scaling the graph **/ static void graph_append(struct special_node *graph, double f, char showaslog) { int i; /* do nothing if we don't even have a graph yet */ if (graph->graph == nullptr) { return; } if (showaslog != 0) { #ifdef BUILD_MATH f = log10(f + 1); #endif } if ((graph->scaled == 0) && f > graph->scale) { f = graph->scale; } /* shift all the data by 1 */ for (i = graph->graph_allocated - 1; i > 0; i--) { graph->graph[i] = graph->graph[i - 1]; } graph->graph[0] = f; /* add new data */ if (graph->scaled != 0) { graph->scale = *std::max_element(graph->graph + 0, graph->graph + graph->graph_width); if (graph->scale < 1e-47) { /* avoid NaN's when the graph is all-zero (e.g. before the first update) * there is nothing magical about 1e-47 here */ graph->scale = 1e-47; } } } void new_graph_in_shell(struct special_node *s, char *buf, int buf_max_size) { // Split config string on comma to avoid the hassle of dealing with the // idiosyncrasies of multi-byte unicode on different platforms. // TODO(brenden): Parse config string once and cache result. const std::string ticks = console_graph_ticks.get(*state); std::stringstream ss(ticks); std::string tickitem; std::vector tickitems; while (std::getline(ss, tickitem, ',')) { tickitems.push_back(tickitem); } char *p = buf; char *buf_max = buf + (sizeof(char) * buf_max_size); double scale = (tickitems.size() - 1) / s->scale; for (int i = s->graph_allocated - 1; i >= 0; i--) { const unsigned int v = round_to_positive_int(s->graph[i] * scale); const char *tick = tickitems[v].c_str(); size_t itemlen = tickitems[v].size(); for (unsigned int j = 0; j < itemlen; j++) { *p++ = tick[j]; if (p == buf_max) { goto graph_buf_end; } } } graph_buf_end: *p = '\0'; } double *copy_graph(double *original_graph, int graph_width) { double *new_graph = static_cast(malloc(graph_width * sizeof(double))); memcpy(new_graph, original_graph, graph_width * sizeof(double)); return new_graph; } double *retrieve_graph(int graph_id, int graph_width) { if (graphs.find(graph_id) == graphs.end()) { return static_cast(calloc(1, graph_width * sizeof(double))); } else { return copy_graph(graphs[graph_id], graph_width); } } void store_graph(int graph_id, struct special_node *s) { if (s->graph == nullptr) { graphs[graph_id] = nullptr; } else { if (graphs.find(graph_id) != graphs.end()) { free(graphs[graph_id]); } graphs[graph_id] = s->graph; } } /** * Creates a visual graph and/or appends val to the graph / plot * * @param[in] obj struct containing all relevant flags like width, height, ... * @param[in] buf buffer for ascii art graph in console * @param[in] buf_max_size maximum length of buf * @param[in] val value to plot i.e. to add to plot **/ void new_graph(struct text_object *obj, char *buf, int buf_max_size, double val) { struct special_node *s = nullptr; auto *g = static_cast(obj->special_data); if ((g == nullptr) || (buf_max_size == 0)) { return; } s = new_special(buf, text_node_t::GRAPH); /* set graph (special) width to width in obj */ s->width = dpi_scale(g->width); if (s->width != 0) { s->graph_width = s->width; } if (s->graph_width != s->graph_allocated) { auto *graph = static_cast( realloc(s->graph, s->graph_width * sizeof(double))); DBGP("reallocing graph from %d to %d", s->graph_allocated, s->graph_width); if (s->graph == nullptr) { /* initialize */ std::fill_n(graph, s->graph_width, 0.0); s->scale = 100; } else if (graph != nullptr) { if (s->graph_width > s->graph_allocated) { /* initialize the new region */ std::fill(graph + s->graph_allocated, graph + s->graph_width, 0.0); } } else { DBGP("reallocing FAILED"); graph = s->graph; s->graph_width = s->graph_allocated; } s->graph = graph; s->graph_allocated = s->graph_width; graphs[g->id] = graph; } s->height = dpi_scale(g->height); s->colours_set = g->colours_set; s->first_colour = g->first_colour; s->last_colour = g->last_colour; if (g->scale != 0) { s->scaled = 0; s->scale = g->scale; s->show_scale = 0; } else { s->scaled = 1; s->scale = 1; s->show_scale = 1; } s->tempgrad = g->tempgrad; #ifdef BUILD_MATH if ((g->flags & SF_SHOWLOG) != 0) { s->scale_log = 1; s->scale = log10(s->scale + 1); } #endif if (store_graph_data_explicitly.get(*state)) { if (s->graph) { s->graph = retrieve_graph(g->id, s->graph_width); } graph_append(s, val, g->flags); store_graph(g->id, s); } else { graph_append(s, val, g->flags); } if (out_to_stdout.get(*state)) { new_graph_in_shell(s, buf, buf_max_size); } } void new_hr(struct text_object *obj, char *p, unsigned int p_max_size) { if (display_output() == nullptr || !display_output()->graphical()) { return; } if (p_max_size == 0) { return; } new_special(p, text_node_t::HORIZONTAL_LINE)->height = dpi_scale(obj->data.l); } void scan_stippled_hr(struct text_object *obj, const char *arg) { struct stippled_hr *sh; sh = static_cast(malloc(sizeof(struct stippled_hr))); memset(sh, 0, sizeof(struct stippled_hr)); sh->arg = stippled_borders.get(*state); sh->height = 1; if (arg != nullptr) { if (sscanf(arg, "%d %d", &sh->arg, &sh->height) != 2) { sscanf(arg, "%d", &sh->height); } } if (sh->arg <= 0) { sh->arg = 1; } obj->special_data = sh; } void new_stippled_hr(struct text_object *obj, char *p, unsigned int p_max_size) { struct special_node *s = nullptr; auto *sh = static_cast(obj->special_data); if (display_output() == nullptr || !display_output()->graphical()) { return; } if ((sh == nullptr) || (p_max_size == 0)) { return; } s = new_special(p, text_node_t::STIPPLED_HR); s->height = dpi_scale(sh->height); s->arg = dpi_scale(sh->arg); } #endif /* BUILD_GUI */ void new_fg(struct text_object *obj, char *p, unsigned int p_max_size) { if (false #ifdef BUILD_GUI || (display_output() && display_output()->graphical()) #endif /* BUILD_GUI */ #ifdef BUILD_NCURSES || out_to_ncurses.get(*state) #endif /* BUILD_NCURSES */ ) { new_special(p, text_node_t::FG)->arg = obj->data.l; } UNUSED(obj); UNUSED(p); UNUSED(p_max_size); } #ifdef BUILD_GUI void new_bg(struct text_object *obj, char *p, unsigned int p_max_size) { if (display_output() == nullptr || !display_output()->graphical()) { return; } if (p_max_size == 0) { return; } new_special(p, text_node_t::BG)->arg = obj->data.l; } #endif /* BUILD_GUI */ static void new_bar_in_shell(struct text_object *obj, char *buffer, unsigned int buf_max_size, double usage) { auto *b = static_cast(obj->special_data); unsigned int width, i, scaledusage; if (b == nullptr) { return; } width = b->width; if (width == 0) { width = DEFAULT_BAR_WIDTH_NO_X; } if (width > buf_max_size) { width = buf_max_size; } scaledusage = round_to_positive_int(usage * width / b->scale); for (i = 0; i < scaledusage; i++) { buffer[i] = *(bar_fill.get(*state).c_str()); } for (; i < width; i++) { buffer[i] = *(bar_unfill.get(*state).c_str()); } buffer[i] = 0; } #ifdef BUILD_GUI static void new_bar_in_gui(struct text_object *obj, char *buf, double usage) { struct special_node *s = nullptr; auto *b = static_cast(obj->special_data); if (display_output() == nullptr || !display_output()->graphical()) { return; } if (b == nullptr) { return; } s = new_special(buf, text_node_t::BAR); s->arg = usage; s->width = dpi_scale(b->width); s->height = dpi_scale(b->height); s->scale = b->scale; } #endif /* BUILD_GUI */ /* usage is in range [0,255] */ void new_bar(struct text_object *obj, char *p, unsigned int p_max_size, double usage) { auto *b = static_cast(obj->special_data); if ((p_max_size == 0) || (b == nullptr)) { return; } if ((b->flags & SF_SCALED) != 0) { b->scale = std::max(b->scale, usage); } else { usage = std::min(b->scale, usage); } #ifdef BUILD_GUI if (display_output() && display_output()->graphical()) { new_bar_in_gui(obj, p, usage); } if (out_to_stdout.get(*state)) { new_bar_in_shell(obj, p, p_max_size, usage); } #else /* BUILD_GUI */ new_bar_in_shell(obj, p, p_max_size, usage); #endif /* BUILD_GUI */ } void new_outline(struct text_object *obj, char *p, unsigned int p_max_size) { if (p_max_size == 0) { return; } new_special(p, text_node_t::OUTLINE)->arg = obj->data.l; } void new_offset(struct text_object *obj, char *p, unsigned int p_max_size) { if (p_max_size == 0) { return; } new_special(p, text_node_t::OFFSET)->arg = dpi_scale(obj->data.l); } void new_voffset(struct text_object *obj, char *p, unsigned int p_max_size) { if (p_max_size == 0) { return; } new_special(p, text_node_t::VOFFSET)->arg = dpi_scale(obj->data.l); } void new_save_coordinates(struct text_object *obj, char *p, unsigned int p_max_size) { if (p_max_size == 0) { return; } new_special(p, text_node_t::SAVE_COORDINATES)->arg = obj->data.l; } void new_alignr(struct text_object *obj, char *p, unsigned int p_max_size) { if (p_max_size == 0) { return; } new_special(p, text_node_t::ALIGNR)->arg = dpi_scale(obj->data.l); } // A positive offset pushes the text further left void new_alignc(struct text_object *obj, char *p, unsigned int p_max_size) { if (p_max_size == 0) { return; } new_special(p, text_node_t::ALIGNC)->arg = dpi_scale(obj->data.l); } void new_goto(struct text_object *obj, char *p, unsigned int p_max_size) { if (p_max_size == 0) { return; } new_special(p, text_node_t::GOTO)->arg = dpi_scale(obj->data.l); } void scan_tab(struct text_object *obj, const char *arg) { struct tab *t; t = static_cast(malloc(sizeof(struct tab))); memset(t, 0, sizeof(struct tab)); t->width = 10; t->arg = 0; if (arg != nullptr) { if (sscanf(arg, "%d %d", &t->width, &t->arg) != 2) { sscanf(arg, "%d", &t->arg); } } if (t->width <= 0) { t->width = 1; } obj->special_data = t; } void new_tab(struct text_object *obj, char *p, unsigned int p_max_size) { struct special_node *s = nullptr; auto *t = static_cast(obj->special_data); if ((t == nullptr) || (p_max_size == 0)) { return; } s = new_special(p, text_node_t::TAB); s->width = dpi_scale(t->width); s->arg = dpi_scale(t->arg); } void clear_stored_graphs() { graph_count = 0; graphs.clear(); }