conky/src/specials.cc

/*
 *
 * 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-2021 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 <http://www.gnu.org/licenses/>.
 *
 */
#include "conky.h"
#ifdef BUILD_X11
#include "fonts.h"
#endif /* BUILD_X11 */
#include <cmath>
#include "logging.h"
#include "nc.h"
#include "specials.h"
#ifdef HAVE_SYS_PARAM_H
#include <sys/param.h>
#endif /* HAVE_SYS_PARAM_H */
#include <algorithm>
#include <map>
#include <sstream>
#include "colours.h"
#include "common.h"
#include "conky.h"

struct special_t *specials = nullptr;

int special_count;
int graph_count = 0;

std::map<int, double *> graphs;

namespace {
conky::range_config_setting<int> default_bar_width(
    "default_bar_width", 0, std::numeric_limits<int>::max(), 0, false);
conky::range_config_setting<int> default_bar_height(
    "default_bar_height", 0, std::numeric_limits<int>::max(), 6, false);

#ifdef BUILD_X11
conky::range_config_setting<int> default_graph_width(
    "default_graph_width", 0, std::numeric_limits<int>::max(), 0, false);
conky::range_config_setting<int> default_graph_height(
    "default_graph_height", 0, std::numeric_limits<int>::max(), 25, false);

conky::range_config_setting<int> default_gauge_width(
    "default_gauge_width", 0, std::numeric_limits<int>::max(), 40, false);
conky::range_config_setting<int> default_gauge_height(
    "default_gauge_height", 0, std::numeric_limits<int>::max(), 25, false);
#endif /* BUILD_X11 */

conky::simple_config_setting<std::string> 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;
  unsigned int 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_X11
const char *scan_gauge(struct text_object *obj, const char *args,
                       double scale) {
  struct gauge *g;

  g = static_cast<struct gauge *>(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<struct bar *>(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_X11
void scan_font(struct text_object *obj, const char *args) {
  if ((args != nullptr) && (*args != 0)) {
    obj->data.s = strndup(args, DEFAULT_TEXT_BUFFER_SIZE);
  }
}

/**
 * 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 string to the command argument, nullptr if argument didn't start with
 *         a string, but a number or if invalid argument string
 **/
char *scan_graph(struct text_object *obj, const char *args, double defscale) {
  char quoted_cmd[1024] = {'\0'}; /* double-quoted execgraph command */
  char argstr[1024] = {'\0'};     /* args minus quoted_cmd */
  char buf[1024] = {'\0'};        /* first unquoted string argument in argstr */

  auto *g = static_cast<struct graph *>(malloc(sizeof(struct graph)));
  memset(g, 0, sizeof(struct graph));
  obj->special_data = g;

  /* zero width means all space that is available */
  g->id = ++graph_count;
  g->width = default_graph_width.get(*state);
  g->height = default_graph_height.get(*state);
  g->first_colour = 0;
  g->last_colour = 0;
  g->scale = defscale;
  g->tempgrad = FALSE;
  if (args != nullptr) {
    /* extract double-quoted command in case of execgraph */
    if (*args == '"') {
      char *_ptr;
      size_t _size;
      if (((_ptr = const_cast<char *>(strrchr(args, '"'))) != nullptr) &&
          _ptr != args) {
        _size = _ptr - args - 1;
      } else {
        NORM_ERR("mismatched double-quote in execgraph object");
        return nullptr;
      }

      _size = _size < 1024 ? _size : 1023;
      strncpy(quoted_cmd, args + 1, _size);
      quoted_cmd[_size] = '\0';

      /* copy everything after the last quote into argstr */
      if (_size + 2 < strlen(args)) { strncpy(argstr, args + _size + 2, 1023); }
    } else {
      /* redundant, but simplifies the code below */
      strncpy(argstr, args, 1023);
    }

    /* 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 formaters. If successfully the return from
     * this whole 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 %x %x %lf", &g->height, &g->width,
               &g->first_colour, &g->last_colour, &g->scale) == 5) {
      return *quoted_cmd != 0
                 ? strndup(quoted_cmd, text_buffer_size.get(*state))
                 : nullptr;
    }
    /* [height],[width] [color1] [color2] */
    g->scale = defscale;
    if (sscanf(argstr, "%d,%d %x %x", &g->height, &g->width, &g->first_colour,
               &g->last_colour) == 4) {
      return *quoted_cmd != 0
                 ? strndup(quoted_cmd, text_buffer_size.get(*state))
                 : nullptr;
    }
    /* [command] [height],[width] [color1] [color2] [scale] */
    if (sscanf(argstr, "%1023s %d,%d %x %x %lf", buf, &g->height, &g->width,
               &g->first_colour, &g->last_colour, &g->scale) == 6) {
      return strndup(buf, text_buffer_size.get(*state));
    }
    g->scale = defscale;
    if (sscanf(argstr, "%1023s %d,%d %x %x", buf, &g->height, &g->width,
               &g->first_colour, &g->last_colour) == 5) {
      return strndup(buf, text_buffer_size.get(*state));
    }

    buf[0] = '\0';
    g->height = default_graph_height.get(*state);
    g->width = default_graph_width.get(*state);
    if (sscanf(argstr, "%x %x %lf", &g->first_colour, &g->last_colour,
               &g->scale) == 3) {
      return *quoted_cmd != 0
                 ? strndup(quoted_cmd, text_buffer_size.get(*state))
                 : nullptr;
    }
    g->scale = defscale;
    if (sscanf(argstr, "%x %x", &g->first_colour, &g->last_colour) == 2) {
      return *quoted_cmd != 0
                 ? strndup(quoted_cmd, text_buffer_size.get(*state))
                 : nullptr;
    }
    if (sscanf(argstr, "%1023s %x %x %lf", buf, &g->first_colour,
               &g->last_colour, &g->scale) == 4) {
      return strndup(buf, text_buffer_size.get(*state));
    }
    g->scale = defscale;
    if (sscanf(argstr, "%1023s %x %x", buf, &g->first_colour,
               &g->last_colour) == 3) {
      return strndup(buf, text_buffer_size.get(*state));
    }

    buf[0] = '\0';
    g->first_colour = 0;
    g->last_colour = 0;
    if (sscanf(argstr, "%d,%d %lf", &g->height, &g->width, &g->scale) == 3) {
      return *quoted_cmd != 0
                 ? strndup(quoted_cmd, text_buffer_size.get(*state))
                 : nullptr;
    }
    g->scale = defscale;
    if (sscanf(argstr, "%d,%d", &g->height, &g->width) == 2) {
      return *quoted_cmd != 0
                 ? strndup(quoted_cmd, text_buffer_size.get(*state))
                 : nullptr;
    }
    if (sscanf(argstr, "%1023s %d,%d %lf", buf, &g->height, &g->width,
               &g->scale) < 4) {
      g->scale = defscale;
      // TODO(brenden): check the return value and throw an error?
      sscanf(argstr, "%1023s %d,%d", buf, &g->height, &g->width);
    }

    if ((*quoted_cmd == 0) && (*buf == 0)) { return nullptr; }
    return strndup(*quoted_cmd != 0 ? quoted_cmd : buf,
                   text_buffer_size.get(*state));
  }

  return nullptr;
}
#endif /* BUILD_X11 */

/*
 * Printing various special text objects
 */

struct special_t *new_special_t_node() {
  auto *newnode = new special_t;

  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_t *new_special(char *buf, enum special_types t) {
  special_t *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<struct gauge *>(obj->special_data);

  snprintf(p, p_max_size, "%s",
           gaugevals[round_to_positive_int(usage * 4 / g->scale)]);
}

#ifdef BUILD_X11
void new_gauge_in_x11(struct text_object *obj, char *buf, double usage) {
  struct special_t *s = nullptr;
  auto *g = static_cast<struct gauge *>(obj->special_data);

  if (!out_to_x.get(*state)) { return; }

  if (g == nullptr) { return; }

  s = new_special(buf, GAUGE);

  s->arg = usage;
  s->width = xft_dpi_scale(g->width);
  s->height = xft_dpi_scale(g->height);
  s->scale = g->scale;
}
#endif /* BUILD_X11 */

void new_gauge(struct text_object *obj, char *p, unsigned int p_max_size,
               double usage) {
  auto *g = static_cast<struct gauge *>(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_X11
  if (out_to_x.get(*state)) { new_gauge_in_x11(obj, p, usage); }
  if (out_to_stdout.get(*state)) {
    new_gauge_in_shell(obj, p, p_max_size, usage);
  }
#else  /* BUILD_X11 */
  new_gauge_in_shell(obj, p, p_max_size, usage);
#endif /* BUILD_X11 */
}

#ifdef BUILD_X11
void new_font(struct text_object *obj, char *p, unsigned int p_max_size) {
  struct special_t *s;
  unsigned int tmp = selected_font;

  if (!out_to_x.get(*state)) { return; }

  if (p_max_size == 0) { return; }

  s = new_special(p, FONT);

  if (obj->data.s != nullptr) {
    if (s->font_added >= static_cast<int>(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_t *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_t *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<std::string> 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<double *>(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<double *>(calloc(1, graph_width * sizeof(double)));
  } else {
    return copy_graph(graphs[graph_id], graph_width);
  }
}

void store_graph(int graph_id, struct special_t *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_t *s = nullptr;
  auto *g = static_cast<struct graph *>(obj->special_data);

  if ((g == nullptr) || (buf_max_size == 0)) { return; }

  s = new_special(buf, GRAPH);

  /* set graph (special) width to width in obj */
  s->width = xft_dpi_scale(g->width);
  if (s->width != 0) { s->graph_width = s->width; }

  if (s->graph_width != s->graph_allocated) {
    auto *graph = static_cast<double *>(
        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 = xft_dpi_scale(g->height);
  s->first_colour = adjust_colours(g->first_colour);
  s->last_colour = adjust_colours(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

  int graph_id = ((struct graph *)obj->special_data)->id;
  s->graph = retrieve_graph(graph_id, s->graph_width);

  graph_append(s, val, g->flags);

  store_graph(graph_id, s);

  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 (!out_to_x.get(*state)) { return; }

  if (p_max_size == 0) { return; }

  new_special(p, HORIZONTAL_LINE)->height = xft_dpi_scale(obj->data.l);
}

void scan_stippled_hr(struct text_object *obj, const char *arg) {
  struct stippled_hr *sh;

  sh = static_cast<struct stippled_hr *>(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_t *s = nullptr;
  auto *sh = static_cast<struct stippled_hr *>(obj->special_data);

  if (!out_to_x.get(*state)) { return; }

  if ((sh == nullptr) || (p_max_size == 0)) { return; }

  s = new_special(p, STIPPLED_HR);

  s->height = xft_dpi_scale(sh->height);
  s->arg = xft_dpi_scale(sh->arg);
}
#endif /* BUILD_X11 */

void new_fg(struct text_object *obj, char *p, unsigned int p_max_size) {
#ifdef BUILD_X11
  if (out_to_x.get(*state)) { new_special(p, FG)->arg = obj->data.l; }
#endif /* BUILD_X11 */
#ifdef BUILD_NCURSES
  if (out_to_ncurses.get(*state)) { new_special(p, FG)->arg = obj->data.l; }
#endif /* BUILD_NCURSES */
  UNUSED(obj);
  UNUSED(p);
  UNUSED(p_max_size);
}

#ifdef BUILD_X11
void new_bg(struct text_object *obj, char *p, unsigned int p_max_size) {
  if (!out_to_x.get(*state)) { return; }

  if (p_max_size == 0) { return; }

  new_special(p, BG)->arg = obj->data.l;
}
#endif /* BUILD_X11 */

static void new_bar_in_shell(struct text_object *obj, char *buffer,
                             unsigned int buf_max_size, double usage) {
  auto *b = static_cast<struct bar *>(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_X11
static void new_bar_in_x11(struct text_object *obj, char *buf, double usage) {
  struct special_t *s = nullptr;
  auto *b = static_cast<struct bar *>(obj->special_data);

  if (!out_to_x.get(*state)) { return; }

  if (b == nullptr) { return; }

  s = new_special(buf, BAR);

  s->arg = usage;
  s->width = xft_dpi_scale(b->width);
  s->height = xft_dpi_scale(b->height);
  s->scale = b->scale;
}
#endif /* BUILD_X11 */

/* 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<struct bar *>(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_X11
  if (out_to_x.get(*state)) { new_bar_in_x11(obj, p, usage); }
  if (out_to_stdout.get(*state)) {
    new_bar_in_shell(obj, p, p_max_size, usage);
  }
#else  /* BUILD_X11 */
  new_bar_in_shell(obj, p, p_max_size, usage);
#endif /* BUILD_X11 */
}

void new_outline(struct text_object *obj, char *p, unsigned int p_max_size) {
  if (p_max_size == 0) { return; }
  new_special(p, 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, OFFSET)->arg = xft_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, VOFFSET)->arg = xft_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, 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, ALIGNR)->arg = xft_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, ALIGNC)->arg = xft_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, GOTO)->arg = xft_dpi_scale(obj->data.l);
}

void scan_tab(struct text_object *obj, const char *arg) {
  struct tab *t;

  t = static_cast<struct tab *>(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_t *s = nullptr;
  auto *t = static_cast<struct tab *>(obj->special_data);

  if ((t == nullptr) || (p_max_size == 0)) { return; }

  s = new_special(p, TAB);
  s->width = xft_dpi_scale(t->width);
  s->arg = xft_dpi_scale(t->arg);
}

void clear_stored_graphs() {
  graph_count = 0;
  graphs.clear();
}