Add "config query" command to remotecontrol plugin to query a configuration value...
[oonf.git] / include / oonf / base / oonf_viewer.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon version 2 (olsrd2)
4  * Copyright (c) 2004-2015, the olsr.org team - see HISTORY file
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  *   notice, this list of conditions and the following disclaimer in
15  *   the documentation and/or other materials provided with the
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its
18  *   contributors may be used to endorse or promote products derived
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42 /**
43  * @file
44  */
45
46 #ifndef OONF_VIEWER_H_
47 #define OONF_VIEWER_H_
48
49 #include <oonf/libcommon/autobuf.h>
50 #include <oonf/oonf.h>
51 #include <oonf/libcommon/json.h>
52 #include <oonf/libcommon/template.h>
53
54 #include <oonf/libcore/oonf_subsystem.h>
55 #include <oonf/base/oonf_telnet.h> /* compile-time dependency */
56
57 /*! subsystem identifier */
58 #define OONF_VIEWER_SUBSYSTEM "viewer"
59
60 /*! viewer should return raw numbers, not iso-prefixes */
61 #define OONF_VIEWER_RAW_FORMAT "raw"
62
63 /*! viewer should only return the names of the fields */
64 #define OONF_VIEWER_HEAD_FORMAT "head"
65
66 /*! viewer should output json format */
67 #define OONF_VIEWER_JSON_FORMAT "json"
68
69 /*! viewer should output json format with raw numbers */
70 #define OONF_VIEWER_JSON_RAW_FORMAT "jsonraw"
71
72 /*! viewer should output json format without surrounding object brackets */
73 #define OONF_VIEWER_DATA_FORMAT "data"
74
75 /**
76  * viewer should output json format with raw numbers
77  * and without surrounding object brackets
78  */
79 #define OONF_VIEWER_DATA_RAW_FORMAT "dataraw"
80
81 /**
82  * This struct defines a template engine command that can output both
83  * table and JSON.
84  */
85 struct oonf_viewer_template {
86   /*! output buffer */
87   struct autobuf *out;
88
89   /*! true if output should be in JSON format */
90   bool create_json;
91
92   /*! true if isonumbers should be raw */
93   bool create_raw;
94
95   /*! true if skips the enclosing JSON brackets */
96   bool create_only_data;
97
98   /*! pointer to template data array to get key/value pairs */
99   struct abuf_template_data *data;
100
101   /*! size of template data array */
102   size_t data_size;
103
104   /*! name of the JSON object which contains the key*/
105   const char *json_name;
106
107   /*! single line help text for overview about command */
108   const char *help_line;
109
110   /*! full help text about this template output */
111   const char *help;
112
113   /**
114    * Callback triggered to generate the content of the template
115    * @param this viewer template
116    * @return -1 if an error happened, 0 otherwise
117    */
118   int (*cb_function)(struct oonf_viewer_template *);
119
120   /*! internal variable for template engine storage array */
121   struct abuf_template_storage *_storage;
122
123   /*! internal variable for JSON generation */
124   struct json_session _json;
125 };
126
127 EXPORT void oonf_viewer_output_prepare(struct oonf_viewer_template *template, struct abuf_template_storage *storage,
128   struct autobuf *out, const char *format);
129 EXPORT void oonf_viewer_output_print_line(struct oonf_viewer_template *template);
130 EXPORT void oonf_viewer_output_finish(struct oonf_viewer_template *template);
131
132 EXPORT void oonf_viewer_print_help(
133   struct autobuf *out, const char *parameter, struct oonf_viewer_template *template, size_t count);
134 EXPORT int oonf_viewer_call_subcommands(struct autobuf *out, struct abuf_template_storage *storage, const char *param,
135   struct oonf_viewer_template *templates, size_t count);
136 EXPORT enum oonf_telnet_result oonf_viewer_telnet_handler(struct autobuf *out, struct abuf_template_storage *storage,
137   const char *cmd, const char *param, struct oonf_viewer_template *templates, size_t count);
138 EXPORT enum oonf_telnet_result oonf_viewer_telnet_help(
139   struct autobuf *out, const char *cmd, const char *parameter, struct oonf_viewer_template *template, size_t count);
140
141 #endif /* OONF_VIEWER_H_ */