src/graph.h

   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  **/
  23
  24 #ifndef GRAPH_H
  25 #define GRAPH_H 1
  26
  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"
  33
  34 /*
  35  * Functions
  36  */
  37 graph_config_t *graph_create (const graph_ident_t *selector);
  38
  39 void graph_destroy (graph_config_t *graph);
  40
  41 int graph_config_add (const oconfig_item_t *ci);
  42
  43 int graph_add_file (graph_config_t *cfg, const graph_ident_t *file);
  44
  45 int graph_get_title (graph_config_t *cfg,
  46     char *buffer, size_t buffer_size);
  47
  48 int graph_get_params (graph_config_t *cfg, char *buffer, size_t buffer_size);
  49
  50 graph_ident_t *graph_get_selector (graph_config_t *cfg);
  51
  52 graph_def_t *graph_get_defs (graph_config_t *cfg);
  53
  54 int graph_add_def (graph_config_t *cfg, graph_def_t *def);
  55
  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);
  59
  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);
  64
  65 /* Returns true if a file may apply to both, the graphs selector and the
  66  * selector given as argument. If the selectors contradict one another,
  67  * returns false. */
  68 _Bool graph_ident_intersect (graph_config_t *cfg,
  69     const graph_ident_t *selector);
  70
  71 /* Compares the given string with the appropriate field of the selector. If
  72  * the selector field is "/all/" or "/any/", returns true without checking the
  73  * instances. See "graph_inst_search_field" for finding all matching
  74  * instances. */
  75 _Bool graph_matches_field (graph_config_t *cfg,
  76     graph_ident_field_t field, const char *field_value);
  77
  78 int graph_inst_foreach (graph_config_t *cfg,
  79     inst_callback_t cb, void *user_data);
  80
  81 graph_instance_t *graph_inst_find_exact (graph_config_t *cfg,
  82     graph_ident_t *ident);
  83
  84 graph_instance_t *graph_inst_find_matching (graph_config_t *cfg,
  85     const graph_ident_t *ident);
  86
  87 int graph_inst_find_all_matching (graph_config_t *cfg,
  88     const graph_ident_t *ident,
  89     graph_inst_callback_t callback, void *user_data);
  90
  91 /* Search for instances using a search_info_t. The code assumes that the
  92  * graph's selector has already been checked against the search_info_t, using
  93  * "search_to_ident" and "graph_matches_ident". */
  94 int graph_search_inst (graph_config_t *cfg, search_info_t *si,
  95     graph_inst_callback_t callback, void *user_data);
  96
  97 int graph_search_inst_string (graph_config_t *cfg, const char *term,
  98     graph_inst_callback_t callback, void *user_data);
  99
 100 /* Iterates over all instances and calls "inst_matches_field". If that method
 101  * returns true, calls the callback with the graph and instance pointers. */
 102 int graph_inst_search_field (graph_config_t *cfg,
 103     graph_ident_field_t field, const char *field_value,
 104     graph_inst_callback_t callback, void *user_data);
 105
 106 int graph_compare (graph_config_t *cfg, const graph_ident_t *ident);
 107
 108 size_t graph_num_instances (graph_config_t *cfg);
 109
 110 int graph_sort_instances (graph_config_t *cfg);
 111
 112 int graph_clear_instances (graph_config_t *cfg);
 113
 114 int graph_get_rrdargs (graph_config_t *cfg, graph_instance_t *inst,
 115     rrd_args_t *args);
 116
 117 #endif /* GRAPH_H */
 118 /* vim: set sw=2 sts=2 et fdm=marker : */