Improved parsing of graph arguments.
[monky] / src / specials.h
1 /* Conky, a system monitor, based on torsmo
2  *
3  * Any original torsmo code is licensed under the BSD license
4  *
5  * All code written since the fork of torsmo is licensed under the GPL
6  *
7  * Please see COPYING for details
8  *
9  * Copyright (c) 2004, Hannu Saransaari and Lauri Hakkarainen
10  * Copyright (c) 2005-2009 Brenden Matthews, Philip Kovacs, et. al.
11  *      (see AUTHORS)
12  * All rights reserved.
13  *
14  * This program is free software: you can redistribute it and/or modify
15  * it under the terms of the GNU General Public License as published by
16  * the Free Software Foundation, either version 3 of the License, or
17  * (at your option) any later version.
18  *
19  * This program is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU General Public License for more details.
23  * You should have received a copy of the GNU General Public License
24  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
25  *
26  */
27 #ifndef _SPECIALS_H
28 #define _SPECIALS_H
29
30 /* special stuff in text_buffer */
31
32 #define SPECIAL_CHAR '\x01'
33
34 #define MAX_GRAPH_DEPTH 512
35
36 // don't use spaces in LOGGRAPH or NORMGRAPH if you change them
37 #define LOGGRAPH "-l"
38 #define TEMPGRAD "-t"
39
40 enum special_types {
41         HORIZONTAL_LINE,
42         STIPPLED_HR,
43         BAR,
44         FG,
45         BG,
46         OUTLINE,
47         ALIGNR,
48         ALIGNC,
49         GAUGE,
50         GRAPH,
51         OFFSET,
52         VOFFSET,
53         FONT,
54         GOTO,
55         TAB,
56 };
57
58 struct special_t {
59         int type;
60         short height;
61         short width;
62         long arg;
63         double *graph;
64         double graph_scale;
65         short show_scale;
66         int graph_width;
67         int scaled;
68         unsigned long first_colour;     // for graph gradient
69         unsigned long last_colour;
70         short font_added;
71         char tempgrad;
72 };
73
74 /* direct access to the registered specials (FIXME: bad encapsulation) */
75 extern struct special_t *specials;
76 extern int special_count;
77
78 extern int default_bar_width;
79 extern int default_bar_height;
80 #ifdef X11
81 extern int default_graph_width;
82 extern int default_graph_height;
83 extern int default_gauge_width;
84 extern int default_gauge_height;
85 #endif
86
87 /* max number of specials allowed (TODO: use linked list instead) */
88 extern int max_specials;
89
90 /* scanning special arguments */
91 const char *scan_bar(const char *, int *, int *);
92 #ifdef X11
93 const char *scan_gauge(const char *, int *, int *);
94 char *scan_font(const char *);
95 char *scan_graph(const char *, int *, int *, unsigned int *,
96                  unsigned int *, unsigned int *, char *, char *);
97
98 /* printing specials */
99 void new_gauge(char *, int, int, int);
100 void new_bar(char *, int, int, int);
101 void new_font(char *, char *);
102 void new_graph(char *, int, int, unsigned int,
103                unsigned int, double, int, int, char, char);
104 void new_hr(char *, int);
105 void new_stippled_hr(char *, int, int);
106 #endif
107 void new_bar_in_shell(char *, int, double, int);
108 void new_fg(char *, long);
109 void new_bg(char *, long);
110 void new_outline(char *, long);
111 void new_offset(char *, long);
112 void new_voffset(char *, long);
113 void new_alignr(char *, long);
114 void new_alignc(char *, long);
115 void new_goto(char *, long);
116 void new_tab(char *, int, int);
117
118 #endif /* _SPECIALS_H */