ovsdb-client: Break table formatting into new library.

[sliver-openvswitch.git] / lib / table.h

diff --git a/lib/table.h b/lib/table.h
new file mode 100644 (file)
index 0000000..c24bca2
--- /dev/null
+++ b/lib/table.h
@@ -0,0 +1,113 @@
+/*
+ * Copyright (c) 2009, 2010, 2011 Nicira Networks.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef TABLE_H
+#define TABLE_H 1
+
+#include <stdbool.h>
+#include <stddef.h>
+#include "compiler.h"
+
+struct table_style;
+\f
+/* Manipulating tables and their rows and columns. */
+
+struct table {
+    struct cell *cells;
+    struct column *columns;
+    size_t n_columns, allocated_columns;
+    size_t n_rows, allocated_rows;
+    size_t current_column;
+    char *caption;
+};
+
+void table_init(struct table *);
+void table_destroy(struct table *);
+void table_set_caption(struct table *, char *caption);
+
+void table_add_column(struct table *, const char *heading, ...)
+    PRINTF_FORMAT(2, 3);
+void table_add_row(struct table *);
+\f
+/* Table cells. */
+
+struct cell {
+    /* Literal text. */
+    char *text;
+
+    /* JSON. */
+    struct json *json;
+    const struct ovsdb_type *type;
+};
+
+struct cell *table_add_cell(struct table *);
+\f
+/* Table formatting. */
+
+enum table_format {
+    TF_TABLE,                   /* 2-d table. */
+    TF_HTML,                    /* HTML table. */
+    TF_CSV,                     /* Comma-separated lines. */
+    TF_JSON                     /* JSON. */
+};
+
+enum cell_format {
+    CF_STRING,                  /* String format. */
+    CF_JSON                     /* JSON. */
+};
+
+struct table_style {
+    enum table_format format;   /* TF_*. */
+    enum cell_format cell_format; /* CF_*. */
+    bool headings;              /* Include headings? */
+    int json_flags;             /* CF_JSON: Flags for json_to_string(). */
+};
+
+#define TABLE_STYLE_DEFAULT { TF_TABLE, CF_STRING, true, JSSF_SORT }
+
+#define TABLE_OPTION_ENUMS                      \
+    OPT_NO_HEADINGS,                            \
+    OPT_PRETTY
+
+#define TABLE_LONG_OPTIONS                                  \
+        {"format", required_argument, 0, 'f'},              \
+        {"data", required_argument, 0, 'd'},                \
+        {"no-headings", no_argument, 0, OPT_NO_HEADINGS},   \
+        {"pretty", no_argument, 0, OPT_PRETTY},
+
+#define TABLE_OPTION_HANDLERS(STYLE)                \
+        case 'f':                                   \
+            table_parse_format(STYLE, optarg);      \
+            break;                                  \
+                                                    \
+        case 'd':                                   \
+            table_parse_cell_format(STYLE, optarg); \
+            break;                                  \
+                                                    \
+        case OPT_NO_HEADINGS:                       \
+            (STYLE)->headings = false;              \
+            break;                                  \
+                                                    \
+        case OPT_PRETTY:                            \
+            (STYLE)->json_flags |= JSSF_PRETTY;     \
+            break;
+
+void table_parse_format(struct table_style *, const char *format);
+void table_parse_cell_format(struct table_style *, const char *format);
+
+void table_print(const struct table *, const struct table_style *);
+
+#endif /* table.h */