aboutsummaryrefslogtreecommitdiff
path: root/includes/info.h
blob: 5ccec9d58334716fb0b12b8c642e8cc46e8db989 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
/*
 *    HardInfo - Displays System Information
 *    Copyright (C) 2017 Leandro A. F. Pereira <leandro@hardinfo.org>
 *
 *    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, version 2.
 *
 *    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, write to the Free Software
 *    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#pragma once

#include <stdarg.h>
#include <glib.h>

enum InfoGroupSort {
    INFO_GROUP_SORT_NONE,
    INFO_GROUP_SORT_NAME_ASCENDING,
    INFO_GROUP_SORT_NAME_DESCENDING,
    INFO_GROUP_SORT_VALUE_ASCENDING,
    INFO_GROUP_SORT_VALUE_DESCENDING,
    INFO_GROUP_SORT_TAG_ASCENDING,
    INFO_GROUP_SORT_TAG_DESCENDING,
    INFO_GROUP_SORT_MAX,
};

struct Info {
    GArray *groups;

    const gchar *column_titles[5];

    ShellViewType view_type;

    int reload_interval;

    gboolean column_headers_visible;
    gboolean zebra_visible;
    gboolean normalize_percentage;
};

struct InfoGroup {
    const gchar *name;
    enum InfoGroupSort sort;

    GArray *fields;

     /* scaffolding fields */
    const gchar *computed;
};

struct InfoField {
    const gchar *name;
    const gchar *value;
    const gchar *icon;
          gchar *tag; /* moreinfo() lookup tag */

    int update_interval;
    gboolean highlight;      /* select in GUI, highlight in report (flag:*) */
    gboolean report_details; /* show moreinfo() in report (flag:!) */

    gboolean free_name_on_flatten;
    gboolean free_value_on_flatten;
};

struct Info *info_new(void);

struct InfoGroup *info_add_group(struct Info *info, const gchar *group_name, ...);
void info_add_computed_group(struct Info *info, const gchar *name, const gchar *value);

void info_group_add_field(struct InfoGroup *group, struct InfoField field);
void info_group_add_fields(struct InfoGroup *group, ...);
void info_group_add_fieldsv(struct InfoGroup *group, va_list ap);

struct InfoField info_field_printf(const gchar *name, const gchar *format, ...)
    __attribute__((format(printf, 2, 3)));

#define info_field_full(...)                                                   \
    (struct InfoField) { __VA_ARGS__ }

#define info_field(n, v, ...)                                                  \
    info_field_full(.name = (n), .value = (v), __VA_ARGS__)

#define info_field_update(n, ui, ...)                                          \
    info_field_full(.name = (n), .value = "...", .update_interval = (ui),      \
                    __VA_ARGS__)

#define info_field_last()                                                      \
    (struct InfoField) {}

void info_set_column_title(struct Info *info, const gchar *column, const gchar *title);
void info_set_column_headers_visible(struct Info *info, gboolean setting);
void info_set_zebra_visible(struct Info *info, gboolean setting);
void info_set_normalize_percentage(struct Info *info, gboolean setting);
void info_set_view_type(struct Info *info, ShellViewType setting);
void info_set_reload_interval(struct Info *info, int setting);

gchar *info_flatten(struct Info *info);