output: Introduce pivot tables.
[pspp] / src / output / tab.h
index dd6840c63cad291ea4354dba84030a593fc53dff..f81a010c65c718a6988d1438f2a7b2c99c3f65ef 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 1997, 1998, 1999, 2000, 2009, 2011 Free Software Foundation, Inc.
+   Copyright (C) 1997, 1998, 1999, 2000, 2009, 2011, 2014 Free Software Foundation, Inc.
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
 
    This is a type of table (see output/table.h) whose content is composed
    manually by the code that generates it, by filling in cells one by one.
-
-   Some of the features of this type of table are obsolete but have not yet
-   been removed, because some code still uses them.  These features are:
-
-       - The title.  The title (or caption, actually) is a property of the
-         table_item (see output/table-item.h) in which a table is embedded,
-         not a property of the table itself.
-
-       - Row and columns offsets (via tab_offset(), tab_next_row()).  This
-         feature simply isn't used enough to justify keeping it.
-
-       - Table resizing.  The code that does use this feature is just as well
-         served by creating multiple tables and pasting them together with
-         table_paste().  Eliminating this feature would also slightly simplify
-         the table code here.
 */
 
 #include "libpspp/compiler.h"
 #include "output/table.h"
+#include "data/format.h"
+
+#define TAB_STYLE_MASK (7u << (TAB_FIRST_AVAILABLE + 1))
+#define TAB_STYLE_SHIFT (TAB_FIRST_AVAILABLE + 1)
+
+enum
+  {
+    /* Horizontal alignment of cell contents. */
+    TAB_RIGHT      = 0 << (TAB_FIRST_AVAILABLE + 2),
+    TAB_LEFT       = 1 << (TAB_FIRST_AVAILABLE + 2),
+    TAB_CENTER     = 2 << (TAB_FIRST_AVAILABLE + 2),
+    TAB_HALIGN     = 3 << (TAB_FIRST_AVAILABLE + 2), /* Alignment mask. */
+
+    /* Vertical alignment of cell contents. */
+    TAB_TOP        = 0 << (TAB_FIRST_AVAILABLE + 4),
+    TAB_MIDDLE     = 1 << (TAB_FIRST_AVAILABLE + 4),
+    TAB_BOTTOM     = 2 << (TAB_FIRST_AVAILABLE + 4),
+    TAB_VALIGN     = 3 << (TAB_FIRST_AVAILABLE + 4), /* Alignment mask. */
+  };
+
+/* Rule masks. */
+#define TAB_RULE_TYPE_MASK   7
+#define TAB_RULE_TYPE_SHIFT  0
+#define TAB_RULE_STYLE_MASK  (31 << TAB_RULE_STYLE_SHIFT)
+#define TAB_RULE_STYLE_SHIFT 3
 
 /* A table. */
 struct tab_table
@@ -47,10 +57,7 @@ struct tab_table
     struct table table;
     struct pool *container;
 
-    /* Table title, or a null pointer if no title has been set.
-
-       The table title is properly part of struct table_item, not struc*/
-    char *title;
+    /* Table title and caption, or null. */
     int cf;                    /* Column factor for indexing purposes. */
 
     /* Table contents.
@@ -60,14 +67,13 @@ struct tab_table
        however, it is a joined cell and the corresponding element of cc[]
        points to a struct tab_joined_cell. */
     void **cc;                  /* Cell contents; void *[nr][nc]. */
-    unsigned char *ct;         /* Cell types; unsigned char[nr][nc]. */
+    unsigned short *ct;                /* Cell types; unsigned short[nr][nc]. */
+    struct area_style *styles[8];
 
     /* Rules. */
     unsigned char *rh;         /* Horiz rules; unsigned char[nr+1][nc]. */
     unsigned char *rv;         /* Vert rules; unsigned char[nr][nc+1]. */
-
-    /* X and Y offsets. */
-    int col_ofs, row_ofs;
+    struct cell_color *rule_colors[32];
   };
 
 struct tab_table *tab_cast (const struct table *);
@@ -90,12 +96,7 @@ static inline int tab_b (const struct tab_table *table)
 
 /* Tables. */
 struct tab_table *tab_create (int nc, int nr);
-void tab_resize (struct tab_table *, int nc, int nr);
-void tab_realloc (struct tab_table *, int nc, int nr);
 void tab_headers (struct tab_table *, int l, int r, int t, int b);
-void tab_title (struct tab_table *, const char *, ...)
-     PRINTF_FORMAT (2, 3);
-void tab_submit (struct tab_table *);
 
 /* Rules. */
 void tab_hline (struct tab_table *, int style, int x1, int x2, int y);
@@ -103,23 +104,7 @@ void tab_vline (struct tab_table *, int style, int x, int y1, int y2);
 void tab_box (struct tab_table *, int f_h, int f_v, int i_h, int i_v,
              int x1, int y1, int x2, int y2);
 
-/* Obsolete cell options. */
-#define TAT_TITLE TAB_EMPH      /* Title attributes. */
-
 /* Cells. */
-struct fmt_spec;
-struct dictionary;
-union value;
-void tab_value (struct tab_table *, int c, int r, unsigned char opt,
-               const union value *, const struct variable *,
-               const struct fmt_spec *);
-
-void tab_fixed (struct tab_table *, int c, int r, unsigned char opt,
-               double v, int w, int d);
-
-void tab_double (struct tab_table *, int c, int r, unsigned char opt,
-               double v, const struct fmt_spec *);
-
 void tab_text (struct tab_table *, int c, int r, unsigned opt, const char *);
 void tab_text_format (struct tab_table *, int c, int r, unsigned opt,
                       const char *, ...)
@@ -127,19 +112,17 @@ void tab_text_format (struct tab_table *, int c, int r, unsigned opt,
 
 void tab_joint_text (struct tab_table *, int x1, int y1, int x2, int y2,
                     unsigned opt, const char *);
-void tab_joint_text_format (struct tab_table *, int x1, int y1, int x2, int y2,
-                            unsigned opt, const char *, ...)
-     PRINTF_FORMAT (7, 8);
 
-bool tab_cell_is_empty (const struct tab_table *, int c, int r);
+struct footnote *tab_create_footnote (struct tab_table *, size_t idx,
+                                      const char *content, const char *marker,
+                                      struct area_style *);
+void tab_add_footnote (struct tab_table *, int x, int y,
+                       const struct footnote *);
 
-/* Editing. */
-void tab_offset (struct tab_table *, int col, int row);
-void tab_next_row (struct tab_table *);
+void tab_add_style (struct tab_table *, int x, int y,
+                    const struct area_style *);
 
-/* Current row/column offset. */
-#define tab_row(TABLE) ((TABLE)->row_ofs)
-#define tab_col(TABLE) ((TABLE)->col_ofs)
+bool tab_cell_is_empty (const struct tab_table *, int c, int r);
 
 /* Simple output. */
 void tab_output_text (int options, const char *string);