1 /**
2 * collection4 - graph.h
3 * Copyright (C) 2010 Florian octo Forster
4 *
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
14 *
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 * Boston, MA 02110-1301 USA
19 *
20 * Authors:
21 * Florian octo Forster <ff at octo.it>
22 **/
24 #ifndef GRAPH_H
25 #define GRAPH_H 1
27 #include "graph_types.h"
28 #include "graph_ident.h"
29 #include "oconfig.h"
30 #include "rrd_args.h"
31 #include "utils_array.h"
32 #include "utils_search.h"
34 /*
35 * Functions
36 */
37 graph_config_t *graph_create (const graph_ident_t *selector);
39 void graph_destroy (graph_config_t *graph);
41 int graph_config_add (const oconfig_item_t *ci);
43 int graph_add_file (graph_config_t *cfg, const graph_ident_t *file);
45 int graph_get_title (graph_config_t *cfg,
46 char *buffer, size_t buffer_size);
48 int graph_get_params (graph_config_t *cfg, char *buffer, size_t buffer_size);
50 graph_ident_t *graph_get_selector (graph_config_t *cfg);
52 graph_def_t *graph_get_defs (graph_config_t *cfg);
54 int graph_add_def (graph_config_t *cfg, graph_def_t *def);
56 /* Returns true if the given "ident" matches the (more general) selector of
57 * the graph "cfg". */
58 _Bool graph_ident_matches (graph_config_t *cfg, const graph_ident_t *ident);
60 /* Returns true if the selector of the graph "cfg" matches the more general
61 * ident "selector". */
62 _Bool graph_matches_ident (graph_config_t *cfg,
63 const graph_ident_t *selector);
65 /* Compares the given string with the appropriate field of the selector. If
66 * the selector field is "/all/" or "/any/", returns true without checking the
67 * instances. See "graph_inst_search_field" for finding all matching
68 * instances. */
69 _Bool graph_matches_field (graph_config_t *cfg,
70 graph_ident_field_t field, const char *field_value);
72 int graph_inst_foreach (graph_config_t *cfg,
73 inst_callback_t cb, void *user_data);
75 graph_instance_t *graph_inst_find_exact (graph_config_t *cfg,
76 graph_ident_t *ident);
78 graph_instance_t *graph_inst_find_matching (graph_config_t *cfg,
79 const graph_ident_t *ident);
81 int graph_inst_find_all_matching (graph_config_t *cfg,
82 const graph_ident_t *ident,
83 graph_inst_callback_t callback, void *user_data);
85 /* Search for instances using a search_info_t. The code assumes that the
86 * graph's selector has already been checked against the search_info_t, using
87 * "search_to_ident" and "graph_matches_ident". */
88 int graph_search_inst (graph_config_t *cfg, search_info_t *si,
89 graph_inst_callback_t callback, void *user_data);
91 int graph_search_inst_string (graph_config_t *cfg, const char *term,
92 graph_inst_callback_t callback, void *user_data);
94 /* Iterates over all instances and calls "inst_matches_field". If that method
95 * returns true, calls the callback with the graph and instance pointers. */
96 int graph_inst_search_field (graph_config_t *cfg,
97 graph_ident_field_t field, const char *field_value,
98 graph_inst_callback_t callback, void *user_data);
100 int graph_compare (graph_config_t *cfg, const graph_ident_t *ident);
102 size_t graph_num_instances (graph_config_t *cfg);
104 int graph_sort_instances (graph_config_t *cfg);
106 int graph_clear_instances (graph_config_t *cfg);
108 int graph_get_rrdargs (graph_config_t *cfg, graph_instance_t *inst,
109 rrd_args_t *args);
111 #endif /* GRAPH_H */
112 /* vim: set sw=2 sts=2 et fdm=marker : */