2 * collection4 - graph.h
3 * Copyright (C) 2010 Florian octo Forster
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.
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.
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
21 * Florian octo Forster <ff at octo.it>
27 #include <yajl/yajl_gen.h>
29 #include "graph_types.h"
30 #include "graph_ident.h"
33 #include "utils_array.h"
34 #include "utils_search.h"
39 graph_config_t *graph_create (const graph_ident_t *selector);
41 void graph_destroy (graph_config_t *graph);
43 int graph_config_add (const oconfig_item_t *ci);
45 /* Add "inst" to the internal list. The instance is *not* copied and may not be
46 * freed from the outside. */
47 int graph_add_inst (graph_config_t *graph, graph_instance_t *inst);
49 int graph_add_file (graph_config_t *cfg, const graph_ident_t *file);
51 int graph_get_title (graph_config_t *cfg,
52 char *buffer, size_t buffer_size);
54 int graph_get_params (graph_config_t *cfg, char *buffer, size_t buffer_size);
56 graph_ident_t *graph_get_selector (graph_config_t *cfg);
58 graph_def_t *graph_get_defs (graph_config_t *cfg);
60 int graph_add_def (graph_config_t *cfg, graph_def_t *def);
62 /* Returns true if the given "ident" matches the (more general) selector of
64 _Bool graph_ident_matches (graph_config_t *cfg, const graph_ident_t *ident);
66 /* Returns true if the selector of the graph "cfg" matches the more general
67 * ident "selector". */
68 _Bool graph_matches_ident (graph_config_t *cfg,
69 const graph_ident_t *selector);
71 /* Returns true if a file may apply to both, the graphs selector and the
72 * selector given as argument. If the selectors contradict one another,
74 _Bool graph_ident_intersect (graph_config_t *cfg,
75 const graph_ident_t *selector);
77 /* Compares the given string with the appropriate field of the selector. If
78 * the selector field is "/all/" or "/any/", returns true without checking the
79 * instances. See "graph_inst_search_field" for finding all matching
81 _Bool graph_matches_field (graph_config_t *cfg,
82 graph_ident_field_t field, const char *field_value);
84 int graph_inst_foreach (graph_config_t *cfg,
85 inst_callback_t cb, void *user_data);
87 graph_instance_t *graph_inst_find_exact (graph_config_t *cfg,
88 graph_ident_t *ident);
90 graph_instance_t *graph_inst_find_matching (graph_config_t *cfg,
91 const graph_ident_t *ident);
93 int graph_inst_find_all_matching (graph_config_t *cfg,
94 const graph_ident_t *ident,
95 graph_inst_callback_t callback, void *user_data);
97 /* Search for instances using a search_info_t. The code assumes that the
98 * graph's selector has already been checked against the search_info_t, using
99 * "search_to_ident" and "graph_matches_ident". */
100 int graph_search_inst (graph_config_t *cfg, search_info_t *si,
101 graph_inst_callback_t callback, void *user_data);
103 int graph_search_inst_string (graph_config_t *cfg, const char *term,
104 graph_inst_callback_t callback, void *user_data);
106 /* Iterates over all instances and calls "inst_matches_field". If that method
107 * returns true, calls the callback with the graph and instance pointers. */
108 int graph_inst_search_field (graph_config_t *cfg,
109 graph_ident_field_t field, const char *field_value,
110 graph_inst_callback_t callback, void *user_data);
112 int graph_compare (graph_config_t *cfg, const graph_ident_t *ident);
114 int graph_to_json (const graph_config_t *cfg, yajl_gen handler);
116 size_t graph_num_instances (graph_config_t *cfg);
118 int graph_sort_instances (graph_config_t *cfg);
120 int graph_clear_instances (graph_config_t *cfg);
122 int graph_get_rrdargs (graph_config_t *cfg, graph_instance_t *inst,
126 /* vim: set sw=2 sts=2 et fdm=marker : */