scan_graph: allow giving a "hint" about a good scale value
[monky] / src / specials.c
1 /* -*- mode: c; c-basic-offset: 4; tab-width: 4; indent-tabs-mode: t -*-
2  * vim: ts=4 sw=4 noet ai cindent syntax=c
3  *
4  * Conky, a system monitor, based on torsmo
5  *
6  * Any original torsmo code is licensed under the BSD license
7  *
8  * All code written since the fork of torsmo is licensed under the GPL
9  *
10  * Please see COPYING for details
11  *
12  * Copyright (c) 2004, Hannu Saransaari and Lauri Hakkarainen
13  * Copyright (c) 2005-2009 Brenden Matthews, Philip Kovacs, et. al.
14  *      (see AUTHORS)
15  * All rights reserved.
16  *
17  * This program is free software: you can redistribute it and/or modify
18  * it under the terms of the GNU General Public License as published by
19  * the Free Software Foundation, either version 3 of the License, or
20  * (at your option) any later version.
21  *
22  * This program is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25  * GNU General Public License for more details.
26  * You should have received a copy of the GNU General Public License
27  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
28  *
29  */
30 #include "conky.h"
31 #include "colours.h"
32 #ifdef X11
33 #include "fonts.h"
34 #endif /* X11 */
35 #include "logging.h"
36 #include "specials.h"
37 #include <math.h>
38
39 /* maximum number of special things, e.g. fonts, offsets, aligns, etc. */
40 int max_specials = MAX_SPECIALS_DEFAULT;
41
42 /* create specials array on heap instead of stack with introduction of
43  * max_specials */
44 struct special_t *specials = NULL;
45
46 int special_count;
47
48 int default_bar_width = 0, default_bar_height = 6;
49 #ifdef X11
50 int default_graph_width = 0, default_graph_height = 25;
51 int default_gauge_width = 40, default_gauge_height = 25;
52 #endif /* X11 */
53
54 /*
55  * Special data typedefs
56  */
57
58 struct bar {
59         int width, height;
60 };
61
62 struct gauge {
63         int width, height;
64 };
65
66 struct graph {
67         int width, height;
68         unsigned int first_colour, last_colour;
69         unsigned int scale, showaslog;
70         char tempgrad;
71 };
72
73 struct stippled_hr {
74         int height, arg;
75 };
76
77 struct tab {
78         int width, arg;
79 };
80
81 /*
82  * Scanning arguments to various special text objects
83  */
84
85 #ifdef X11
86 const char *scan_gauge(struct text_object *obj, const char *args)
87 {
88         struct gauge *g;
89
90         g = malloc(sizeof(struct gauge));
91         memset(g, 0, sizeof(struct gauge));
92
93         /*width and height*/
94         g->width = default_gauge_width;
95         g->height = default_gauge_height;
96
97         /* gauge's argument is either height or height,width */
98         if (args) {
99                 int n = 0;
100
101                 if (sscanf(args, "%d,%d %n", &g->height, &g->width, &n) <= 1) {
102                         if (sscanf(args, "%d %n", &g->height, &n) == 2) {
103                                 g->width = g->height; /*square gauge*/
104                         }
105                 }
106                 args += n;
107         }
108
109         obj->special_data = g;
110         return args;
111 }
112 #endif /* X11 */
113
114 const char *scan_bar(struct text_object *obj, const char *args)
115 {
116         struct bar *b;
117
118         b = malloc(sizeof(struct bar));
119         memset(b, 0, sizeof(struct bar));
120
121         /* zero width means all space that is available */
122         b->width = default_bar_width;
123         b->height = default_bar_height;
124         /* bar's argument is either height or height,width */
125         if (args) {
126                 int n = 0;
127
128                 if (sscanf(args, "%d,%d %n", &b->height, &b->width, &n) <= 1) {
129                         sscanf(args, "%d %n", &b->height, &n);
130                 }
131                 args += n;
132         }
133
134         obj->special_data = b;
135         return args;
136 }
137
138 #ifdef X11
139 char *scan_font(const char *args)
140 {
141         if (args && *args) {
142                 return strndup(args, DEFAULT_TEXT_BUFFER_SIZE);
143         }
144
145         return NULL;
146 }
147
148 char *scan_graph(struct text_object *obj, const char *args, int defscale)
149 {
150         struct graph *g;
151         char buf[1024];
152         memset(buf, 0, 1024);
153
154         g = malloc(sizeof(struct graph));
155         memset(g, 0, sizeof(struct graph));
156         obj->special_data = g;
157
158         /* zero width means all space that is available */
159         g->width = default_graph_width;
160         g->height = default_graph_height;
161         g->first_colour = 0;
162         g->last_colour = 0;
163         g->scale = defscale;
164         g->tempgrad = FALSE;
165         g->showaslog = FALSE;
166         if (args) {
167                 if (strstr(args, " "TEMPGRAD) || strncmp(args, TEMPGRAD, strlen(TEMPGRAD)) == 0) {
168                         g->tempgrad = TRUE;
169                 }
170                 if (strstr(args, " "LOGGRAPH) || strncmp(args, LOGGRAPH, strlen(LOGGRAPH)) == 0) {
171                         g->showaslog = TRUE;
172                 }
173                 if (sscanf(args, "%d,%d %x %x %u", &g->height, &g->width, &g->first_colour, &g->last_colour, &g->scale) == 5) {
174                         return NULL;
175                 }
176                 g->scale = defscale;
177                 if (sscanf(args, "%d,%d %x %x", &g->height, &g->width, &g->first_colour, &g->last_colour) == 4) {
178                         return NULL;
179                 }
180                 if (sscanf(args, "%1023s %d,%d %x %x %u", buf, &g->height, &g->width, &g->first_colour, &g->last_colour, &g->scale) == 6) {
181                         return strndup(buf, text_buffer_size);
182                 }
183                 g->scale = defscale;
184                 if (sscanf(args, "%1023s %d,%d %x %x", buf, &g->height, &g->width, &g->first_colour, &g->last_colour) == 5) {
185                         return strndup(buf, text_buffer_size);
186                 }
187                 buf[0] = '\0';
188                 g->height = 25;
189                 g->width = 0;
190                 if (sscanf(args, "%x %x %u", &g->first_colour, &g->last_colour, &g->scale) == 3) {
191                         return NULL;
192                 }
193                 g->scale = defscale;
194                 if (sscanf(args, "%x %x", &g->first_colour, &g->last_colour) == 2) {
195                         return NULL;
196                 }
197                 if (sscanf(args, "%1023s %x %x %u", buf, &g->first_colour, &g->last_colour, &g->scale) == 4) {
198                         return strndup(buf, text_buffer_size);
199                 }
200                 g->scale = defscale;
201                 if (sscanf(args, "%1023s %x %x", buf, &g->first_colour, &g->last_colour) == 3) {
202                         return strndup(buf, text_buffer_size);
203                 }
204                 buf[0] = '\0';
205                 g->first_colour = 0;
206                 g->last_colour = 0;
207                 if (sscanf(args, "%d,%d %u", &g->height, &g->width, &g->scale) == 3) {
208                         return NULL;
209                 }
210                 g->scale = defscale;
211                 if (sscanf(args, "%d,%d", &g->height, &g->width) == 2) {
212                         return NULL;
213                 }
214                 if (sscanf(args, "%1023s %d,%d %u", buf, &g->height, &g->width, &g->scale) < 4) {
215                         g->scale = defscale;
216                         //TODO: check the return value and throw an error?
217                         sscanf(args, "%1023s %d,%d", buf, &g->height, &g->width);
218                 }
219 #undef g
220
221                 return strndup(buf, text_buffer_size);
222         }
223
224         if (buf[0] == '\0') {
225                 return NULL;
226         } else {
227                 return strndup(buf, text_buffer_size);
228         }
229 }
230 #endif /* X11 */
231
232 /*
233  * Printing various special text objects
234  */
235
236 static struct special_t *new_special(char *buf, enum special_types t)
237 {
238         if (special_count >= max_specials) {
239                 CRIT_ERR(NULL, NULL, "too many special things in text");
240         }
241
242         buf[0] = SPECIAL_CHAR;
243         buf[1] = '\0';
244         specials[special_count].type = t;
245         return &specials[special_count++];
246 }
247
248 #ifdef X11
249 void new_gauge(struct text_object *obj, char *buf, int usage)
250 {
251         struct special_t *s = 0;
252         struct gauge *g = obj->special_data;
253
254         if ((output_methods & TO_X) == 0)
255                 return;
256
257         if (!g)
258                 return;
259
260         s = new_special(buf, GAUGE);
261
262         s->arg = (usage > 255) ? 255 : ((usage < 0) ? 0 : usage);
263         s->width = g->width;
264         s->height = g->height;
265 }
266
267 void new_bar(struct text_object *obj, char *buf, int usage)
268 {
269         struct special_t *s = 0;
270         struct bar *b = obj->special_data;
271
272         if ((output_methods & TO_X) == 0)
273                 return;
274
275         if (!b)
276                 return;
277
278         s = new_special(buf, BAR);
279
280         s->arg = (usage > 255) ? 255 : ((usage < 0) ? 0 : usage);
281         s->width = b->width;
282         s->height = b->height;
283 }
284
285 void new_font(char *buf, char *args)
286 {
287         if ((output_methods & TO_X) == 0)
288                 return;
289
290         if (args) {
291                 struct special_t *s = new_special(buf, FONT);
292
293                 if (s->font_added > font_count || !s->font_added || (strncmp(args, fonts[s->font_added].name, DEFAULT_TEXT_BUFFER_SIZE) != EQUAL) ) {
294                         int tmp = selected_font;
295
296                         selected_font = s->font_added = add_font(args);
297                         selected_font = tmp;
298                 }
299         } else {
300                 struct special_t *s = new_special(buf, FONT);
301                 int tmp = selected_font;
302
303                 selected_font = s->font_added = 0;
304                 selected_font = tmp;
305         }
306 }
307
308 static void graph_append(struct special_t *graph, double f, char showaslog)
309 {
310         int i;
311
312         if (showaslog) {
313 #ifdef MATH
314                 f = log10(f + 1);
315 #endif
316         }
317
318         if (!graph->scaled && f > graph->graph_scale) {
319                 f = graph->graph_scale;
320         }
321
322         graph->graph[0] = f;    /* add new data */
323         /* shift all the data by 1 */
324         for (i = graph->graph_width - 1; i > 0; i--) {
325                 graph->graph[i] = graph->graph[i - 1];
326                 if (graph->scaled && graph->graph[i - 1] > graph->graph_scale) {
327                         /* check if we need to update the scale */
328                         graph->graph_scale = graph->graph[i - 1];
329                 }
330         }
331         if (graph->scaled && graph->graph[graph->graph_width] > graph->graph_scale) {
332                 /* check if we need to update the scale */
333                 graph->graph_scale = graph->graph[graph->graph_width];
334         }
335 }
336
337 void new_graph(struct text_object *obj, char *buf, double val)
338 {
339         struct special_t *s = 0;
340         struct graph *g = obj->special_data;
341
342         if ((output_methods & TO_X) == 0)
343                 return;
344
345         if (!g)
346                 return;
347
348         s = new_special(buf, GRAPH);
349
350         s->width = g->width;
351         if (s->graph == NULL) {
352                 if (s->width > 0 && s->width < MAX_GRAPH_DEPTH) {
353                         // subtract 2 for the box
354                         s->graph_width = s->width /* - 2 */;
355                 } else {
356                         s->graph_width = MAX_GRAPH_DEPTH - 2;
357                 }
358                 s->graph = malloc(s->graph_width * sizeof(double));
359                 memset(s->graph, 0, s->graph_width * sizeof(double));
360                 s->graph_scale = 100;
361         }
362         s->height = g->height;
363         s->first_colour = adjust_colours(g->first_colour);
364         s->last_colour = adjust_colours(g->last_colour);
365         if (g->scale != 0) {
366                 s->scaled = 0;
367                 s->graph_scale = g->scale;
368                 s->show_scale = 0;
369         } else {
370                 s->scaled = 1;
371                 s->graph_scale = 1;
372                 s->show_scale = 1;
373         }
374         s->tempgrad = g->tempgrad;
375         /* if (s->width) {
376                 s->graph_width = s->width - 2;  // subtract 2 for rectangle around
377         } */
378 #ifdef MATH
379         if (g->showaslog) {
380                 s->graph_scale = log10(s->graph_scale + 1);
381         }
382 #endif
383         graph_append(s, val, g->showaslog);
384 }
385
386 void new_hr(char *buf, int a)
387 {
388         if ((output_methods & TO_X) == 0)
389                 return;
390
391         new_special(buf, HORIZONTAL_LINE)->height = a;
392 }
393
394 void scan_stippled_hr(struct text_object *obj, const char *arg)
395 {
396         struct stippled_hr *sh;
397
398         sh = malloc(sizeof(struct stippled_hr));
399         memset(sh, 0, sizeof(struct stippled_hr));
400
401         sh->arg = get_stippled_borders();
402         sh->height = 1;
403
404         if (arg) {
405                 if (sscanf(arg, "%d %d", &sh->arg, &sh->height) != 2) {
406                         sscanf(arg, "%d", &sh->height);
407                 }
408         }
409         if (sh->arg <= 0) {
410                 sh->arg = 1;
411         }
412         obj->special_data = sh;
413 }
414
415 void new_stippled_hr(struct text_object *obj, char *buf)
416 {
417         struct special_t *s = 0;
418         struct stippled_hr *sh = obj->special_data;
419
420         if ((output_methods & TO_X) == 0)
421                 return;
422
423         if (!sh)
424                 return;
425
426         s = new_special(buf, STIPPLED_HR);
427
428         s->height = sh->height;
429         s->arg = sh->arg;
430 }
431 #endif /* X11 */
432
433 void new_fg(char *buf, long c)
434 {
435 #ifdef X11
436         if (output_methods & TO_X)
437                 new_special(buf, FG)->arg = c;
438 #endif /* X11 */
439 #ifdef NCURSES
440         if (output_methods & TO_NCURSES)
441                 new_special(buf, FG)->arg = c;
442 #endif /* NCURSES */
443         UNUSED(buf);
444         UNUSED(c);
445 }
446
447 #ifdef X11
448 void new_bg(char *buf, long c)
449 {
450         if ((output_methods & TO_X) == 0)
451                 return;
452
453         new_special(buf, BG)->arg = c;
454 }
455 #endif /* X11 */
456
457 void new_bar_in_shell(struct text_object *obj, char* buffer, int buf_max_size, double usage)
458 {
459         struct bar *b = obj->special_data;
460         int width;
461
462         if (!b)
463                 return;
464
465         width = b->width;
466         if (!width)
467                 width = DEFAULT_BAR_WIDTH_NO_X;
468
469         if(width<=buf_max_size){
470                 int i = 0, j = 0, scaledusage = round_to_int( usage * width / 100);
471
472                 #ifdef HAVE_OPENMP
473                 #pragma omp parallel for schedule(dynamic,10)
474                 #endif /* HAVE_OPENMP */
475                 for(i=0; i<(int)scaledusage; i++) {
476                         *(buffer+i)='#';
477                 }
478                 /* gcc seems to think i is not initialized properly :/ */
479                 j = i;
480                 #ifdef HAVE_OPENMP
481                 #pragma omp parallel for schedule(dynamic,10)
482                 #endif /* HAVE_OPENMP */
483                 for(i = j/* cheats */; i < width; i++) {
484                         *(buffer+i)='_';
485                 }
486                 *(buffer+i)=0;
487         }
488 }
489
490 void new_outline(char *buf, long c)
491 {
492         new_special(buf, OUTLINE)->arg = c;
493 }
494
495 void new_offset(char *buf, long c)
496 {
497         new_special(buf, OFFSET)->arg = c;
498 }
499
500 void new_voffset(char *buf, long c)
501 {
502         new_special(buf, VOFFSET)->arg = c;
503 }
504
505 void new_alignr(char *buf, long c)
506 {
507         new_special(buf, ALIGNR)->arg = c;
508 }
509
510 // A postive offset pushes the text further left
511 void new_alignc(char *buf, long c)
512 {
513         new_special(buf, ALIGNC)->arg = c;
514 }
515
516 void new_goto(char *buf, long c)
517 {
518         new_special(buf, GOTO)->arg = c;
519 }
520
521 void scan_tab(struct text_object *obj, const char *arg)
522 {
523         struct tab *t;
524
525         t = malloc(sizeof(struct tab));
526         memset(t, 0, sizeof(struct tab));
527
528         t->width = 10;
529         t->arg = 0;
530
531         if (arg) {
532                 if (sscanf(arg, "%d %d", &t->width, &t->arg) != 2) {
533                         sscanf(arg, "%d", &t->arg);
534                 }
535         }
536         if (t->width <= 0) {
537                 t->width = 1;
538         }
539         obj->special_data = t;
540 }
541
542 void new_tab(struct text_object *obj, char *buf)
543 {
544         struct special_t *s = 0;
545         struct tab *t = obj->special_data;
546
547         if (!t)
548                 return;
549
550         s = new_special(buf, TAB);
551         s->width = t->width;
552         s->arg = t->arg;
553 }