output view: make items selectable and use system colours
[pspp] / src / output / table.h
index 5075fa9e40fc85b122e75da580944d69ac858767..0cdeef1b4ea1a7661dcf717fd53b6c134a216161 100644 (file)
@@ -86,6 +86,15 @@ enum table_stroke
 
 const char *table_stroke_to_string (enum table_stroke);
 
+/* Given strokes A and B, returns a stroke that "combines" them, that is, that
+   gives a reasonable stroke choice for a rule for different reasons should
+   have both styles A and B. */
+static inline int
+table_stroke_combine (enum table_stroke a, enum table_stroke b)
+{
+  return a > b ? a : b;
+}
+
 struct table_border_style
   {
     enum table_stroke stroke;
@@ -143,7 +152,8 @@ struct font_style
         .fg = { [0] = CELL_COLOR_BLACK, [1] = CELL_COLOR_BLACK},        \
         .bg = { [0] = CELL_COLOR_WHITE, [1] = CELL_COLOR_WHITE},
 
-void font_style_copy (struct font_style *, const struct font_style *);
+void font_style_copy (struct pool *,
+                      struct font_style *, const struct font_style *);
 void font_style_uninit (struct font_style *);
 void font_style_dump (const struct font_style *);
 
@@ -159,7 +169,8 @@ struct area_style
        .font_style = FONT_STYLE_INITIALIZER
 
 struct area_style *area_style_clone (struct pool *, const struct area_style *);
-void area_style_copy (struct area_style *, const struct area_style *);
+void area_style_copy (struct pool *,
+                      struct area_style *, const struct area_style *);
 void area_style_uninit (struct area_style *);
 void area_style_free (struct area_style *);
 
@@ -175,45 +186,10 @@ enum
     TAB_STYLE_SHIFT = 5,
     TAB_STYLE_MASK = 7 << TAB_STYLE_SHIFT,
 
-    /* Horizontal alignment of cell contents. */
-    TAB_RIGHT      = 0 << 10,
-    TAB_LEFT       = 1 << 10,
-    TAB_CENTER     = 2 << 10,
-    TAB_HALIGN     = 3 << 10, /* Alignment mask. */
-
-    /* Vertical alignment of cell contents. */
-    TAB_TOP        = 0 << 12,
-    TAB_MIDDLE     = 1 << 12,
-    TAB_BOTTOM     = 2 << 12,
-    TAB_VALIGN     = 3 << 12, /* Alignment mask. */
-
     /* Internal use by tab.c only. */
     TAB_JOIN = 1 << 14,
   };
 
-/* Styles for the rules around table cells. */
-enum
-  {
-    TAL_NONE = TABLE_STROKE_NONE,
-#define TAL_0 TAL_NONE
-    TAL_SOLID = TABLE_STROKE_SOLID,
-#define TAL_1 TAL_SOLID
-    TAL_DASHED = TABLE_STROKE_DASHED,
-    TAL_THICK = TABLE_STROKE_THICK,
-    TAL_THIN = TABLE_STROKE_THIN,
-    TAL_DOUBLE = TABLE_STROKE_DOUBLE,
-#define TAL_2 TAL_DOUBLE
-  };
-
-/* Given line styles A and B (each one of the TAL_* enumeration constants
-   above), returns a line style that "combines" them, that is, that gives a
-   reasonable line style choice for a rule for different reasons should have
-   both styles A and B. */
-static inline int table_rule_combine (int a, int b)
-{
-  return a > b ? a : b;
-}
-
 /* A table. */
 struct table
   {
@@ -245,10 +221,10 @@ struct table
 
     /* Table contents.
 
-       Each array element in cc[] is ordinarily a "char *" pointer to a
-       string.  If TAB_JOIN (defined in tab.c) is set in ct[] for the element,
+       Each array element in cc[] is ordinarily a "char *" pointer to a string.
+       If TAB_JOIN (defined in table.c) is set in ct[] for the element,
        however, it is a joined cell and the corresponding element of cc[]
-       points to a struct tab_joined_cell. */
+       points to a struct table_cell. */
     void **cc;                  /* Cell contents; void *[nr][nc]. */
     unsigned short *ct;                /* Cell types; unsigned short[nr][nc]. */
     struct area_style *styles[8];
@@ -307,10 +283,19 @@ void table_text (struct table *, int c, int r, unsigned opt, const char *);
 void table_text_format (struct table *, int c, int r, unsigned opt,
                         const char *, ...)
   PRINTF_FORMAT (5, 6);
-
 void table_joint_text (struct table *, int x1, int y1, int x2, int y2,
                        unsigned opt, const char *);
 
+void table_add_subscripts (struct table *, int x, int y,
+                           char **subscripts, size_t n_subscripts);
+void table_add_superscript (struct table *, int x, int y,
+                            const char *superscript);
+
+/* Footnotes.
+
+   Use table_create_footnote() to create the footnotes themselves, then use
+   table_add_footnote() to create a reference from a table cell to a footnote.
+   There are two steps because a footnote may have multiple references. */
 struct footnote *table_create_footnote (struct table *, size_t idx,
                                         const char *content,
                                         const char *marker,