table-provider: Remove "const" from struct table_cell members.

[pspp] / src / output / pivot-table.h

diff --git a/src/output/pivot-table.h b/src/output/pivot-table.h
index c4c9bb778f70626c37b1c03a7ed7db1fa474f346..56ca865a2d3e4eac589b36b56e5ab1bdb2117d57 100644 (file)
--- a/src/output/pivot-table.h
+++ b/src/output/pivot-table.h
@@ -60,15 +60,11 @@ union value;
    Creating a pivot table usually consists of the following steps:
 
    1. Create the table with pivot_table_create(), passing in the title.
    Creating a pivot table usually consists of the following steps:
 
    1. Create the table with pivot_table_create(), passing in the title.

-      It's commonly useful to set up a few options at this point:

 
 

-      - If empty rows or columns should not be displayed, set ->omit_empty to
-        true.
+   2. Optionally, set the format to use for "count" values with
+      pivot_table_set_weight_var() or pivot_table_set_weight_format().

 
 

-      - Set the format to use for "count" values with
-        pivot_table_set_weight_var() or pivot_table_set_weight_format().
-
-   2. Create each dimension with pivot_dimension_create() and populate it with
+   3. Create each dimension with pivot_dimension_create() and populate it with

       categories and, possibly, with groups that contain the categories.  This
       call also assigns the dimension to an axis.
 
       categories and, possibly, with groups that contain the categories.  This
       call also assigns the dimension to an axis.
 


@@ -81,14 +77,14 @@ union value;
       first cell for that variable.  In that case, creating categories and
       inserting data can be interleaved.
 
       first cell for that variable.  In that case, creating categories and
       inserting data can be interleaved.
 

-   3. Insert data.  For each cell, supply the category indexes, which are
+   4. Insert data.  For each cell, supply the category indexes, which are

       assigned starting from 0 in the order in which the categories were
       created in step 2, and the value to go in the cell.  If the table has a
       small, fixed number of dimensions, functions like, e.g.
       pivot_table_put3() for 3 dimensions, can be used.  The general function
       pivot_table_put() works for other cases.
 
       assigned starting from 0 in the order in which the categories were
       created in step 2, and the value to go in the cell.  If the table has a
       small, fixed number of dimensions, functions like, e.g.
       pivot_table_put3() for 3 dimensions, can be used.  The general function
       pivot_table_put() works for other cases.
 

-   4. Output the table for user consumption.  Use pivot_table_submit(). */
+   5. Output the table for user consumption.  Use pivot_table_submit(). */

 \f
 /* Pivot table display styling. */
 
 \f
 /* Pivot table display styling. */
 


@@ -107,7 +103,6 @@ enum pivot_area
   };
 
 const char *pivot_area_to_string (enum pivot_area);
   };
 
 const char *pivot_area_to_string (enum pivot_area);

-const struct area_style *pivot_area_get_default_style (enum pivot_area);

 
 /* Table borders for styling purposes. */
 enum pivot_border
 
 /* Table borders for styling purposes. */
 enum pivot_border


@@ -146,17 +141,12 @@ enum pivot_border
   };
 
 const char *pivot_border_to_string (enum pivot_border);
   };
 
 const char *pivot_border_to_string (enum pivot_border);

-void pivot_border_get_default_style (enum pivot_border,
-                                     struct table_border_style *);

 
 /* Sizing for rows or columns of a rendered table.  The comments below talk
    about columns and their widths but they apply equally to rows and their
    heights. */
 struct pivot_table_sizing
   {
 
 /* Sizing for rows or columns of a rendered table.  The comments below talk
    about columns and their widths but they apply equally to rows and their
    heights. */
 struct pivot_table_sizing
   {

-    /* Minimum and maximum column width, in 1/96" units. */
-    int range[2];
-

     /* Specific column widths, in 1/96" units. */
     int *widths;
     size_t n_widths;
     /* Specific column widths, in 1/96" units. */
     int *widths;
     size_t n_widths;


@@ -372,6 +362,55 @@ void pivot_category_destroy (struct pivot_category *);
 
 bool pivot_result_class_change (const char *, const struct fmt_spec *);
 \f
 
 bool pivot_result_class_change (const char *, const struct fmt_spec *);
 \f

+/* Styling for a pivot table.
+
+   The division between this and the style information in struct pivot_table
+   seems fairly arbitrary.  The ultimate reason for the division is simply
+   because that's how SPSS documentation and file formats do it. */
+struct pivot_table_look
+  {
+    /* Reference count.  A pivot_table_look may be shared between multiple
+       owners, indicated by a reference count greater than 1.  When this is the
+       case, the pivot_table must not be modified. */
+    int ref_cnt;
+
+    char *name;                 /* May be null. */
+
+    /* General properties. */
+    bool omit_empty;
+    bool row_labels_in_corner;
+    int width_ranges[TABLE_N_AXES][2];      /* In 1/96" units. */
+
+    /* Footnote display settings. */
+    bool show_numeric_markers;
+    bool footnote_marker_superscripts;
+
+    /* Styles. */
+    struct table_area_style areas[PIVOT_N_AREAS];
+    struct table_border_style borders[PIVOT_N_BORDERS];
+
+    /* Print settings. */
+    bool print_all_layers;
+    bool paginate_layers;
+    bool shrink_to_fit[TABLE_N_AXES];
+    bool top_continuation, bottom_continuation;
+    char *continuation;
+    size_t n_orphan_lines;
+  };
+
+const struct pivot_table_look *pivot_table_look_get_default (void);
+void pivot_table_look_set_default (const struct pivot_table_look *);
+
+char *pivot_table_look_read (const char *, struct pivot_table_look **)
+  WARN_UNUSED_RESULT;
+
+const struct pivot_table_look *pivot_table_look_builtin_default (void);
+struct pivot_table_look *pivot_table_look_new_builtin_default (void);
+struct pivot_table_look *pivot_table_look_ref (
+  const struct pivot_table_look *);
+void pivot_table_look_unref (struct pivot_table_look *);
+struct pivot_table_look *pivot_table_look_unshare (struct pivot_table_look *);
+\f

 /* A pivot table.  See the top of this file for more information. */
 struct pivot_table
   {
 /* A pivot table.  See the top of this file for more information. */
 struct pivot_table
   {


@@ -380,35 +419,24 @@ struct pivot_table
        the pivot_table must not be modified. */
     int ref_cnt;
 
        the pivot_table must not be modified. */
     int ref_cnt;
 

+    /* Styling. */
+    struct pivot_table_look *look;
+

     /* Display settings. */
     bool rotate_inner_column_labels;
     bool rotate_outer_row_labels;
     /* Display settings. */
     bool rotate_inner_column_labels;
     bool rotate_outer_row_labels;

-    bool row_labels_in_corner;

     bool show_grid_lines;
     bool show_grid_lines;

+    bool show_title;

     bool show_caption;
     bool show_caption;

-    bool omit_empty;       /* Omit empty rows and columns? */
-    size_t *current_layer; /* axis[PIVOT_AXIS_LAYER].n_dimensions elements. */
-    char *table_look;
+    size_t *current_layer; /* axes[PIVOT_AXIS_LAYER].n_dimensions elements. */

     enum settings_value_show show_values;
     enum settings_value_show show_variables;
     struct fmt_spec weight_format;
 
     enum settings_value_show show_values;
     enum settings_value_show show_variables;
     struct fmt_spec weight_format;
 

-    /* Footnote display settings. */
-    bool show_numeric_markers;
-    bool footnote_marker_superscripts;
-

     /* Column and row sizing and page breaks.
        sizing[TABLE_HORZ] is for columns, sizing[TABLE_VERT] is for rows. */
     struct pivot_table_sizing sizing[TABLE_N_AXES];
 
     /* Column and row sizing and page breaks.
        sizing[TABLE_HORZ] is for columns, sizing[TABLE_VERT] is for rows. */
     struct pivot_table_sizing sizing[TABLE_N_AXES];
 

-    /* Print settings. */
-    bool print_all_layers;
-    bool paginate_layers;
-    bool shrink_to_fit[TABLE_N_AXES];
-    bool top_continuation, bottom_continuation;
-    char *continuation;
-    size_t n_orphan_lines;
-

     /* Format settings. */
     int epoch;
     char decimal;               /* Usually ',' or '.'. */
     /* Format settings. */
     int epoch;
     char decimal;               /* Usually ',' or '.'. */


@@ -436,11 +464,7 @@ struct pivot_table
     struct pivot_value *subtype;  /* Same as spv_item's subtype. */
     struct pivot_value *corner_text;
     struct pivot_value *caption;
     struct pivot_value *subtype;  /* Same as spv_item's subtype. */
     struct pivot_value *corner_text;
     struct pivot_value *caption;

-    char *notes;
-
-    /* Styles. */
-    struct area_style areas[PIVOT_N_AREAS];
-    struct table_border_style borders[PIVOT_N_BORDERS];
+    char *notes;                /* Shown as tooltip. */

 
     /* Dimensions. */
     struct pivot_dimension **dimensions;
 
     /* Dimensions. */
     struct pivot_dimension **dimensions;


@@ -463,6 +487,12 @@ struct pivot_table *pivot_table_ref (const struct pivot_table *);
 void pivot_table_unref (struct pivot_table *);
 bool pivot_table_is_shared (const struct pivot_table *);
 
 void pivot_table_unref (struct pivot_table *);
 bool pivot_table_is_shared (const struct pivot_table *);
 

+/* Styling. */
+const struct pivot_table_look *pivot_table_get_look (
+  const struct pivot_table *);
+void pivot_table_set_look (struct pivot_table *,
+                           const struct pivot_table_look *);
+

 /* Format of PIVOT_RC_COUNT cells. */
 void pivot_table_set_weight_var (struct pivot_table *,
                                  const struct variable *);
 /* Format of PIVOT_RC_COUNT cells. */
 void pivot_table_set_weight_var (struct pivot_table *,
                                  const struct variable *);


@@ -605,8 +635,6 @@ struct pivot_value
     char **subscripts;
     size_t n_subscripts;
 
     char **subscripts;
     size_t n_subscripts;
 

-    char *superscript;
-

     const struct pivot_footnote **footnotes;
     size_t n_footnotes;
 
     const struct pivot_footnote **footnotes;
     size_t n_footnotes;
 


@@ -683,7 +711,11 @@ struct pivot_value *pivot_value_new_variable (const struct variable *);
 /* Values from text strings. */
 struct pivot_value *pivot_value_new_text (const char *);
 struct pivot_value *pivot_value_new_text_format (const char *, ...)
 /* Values from text strings. */
 struct pivot_value *pivot_value_new_text (const char *);
 struct pivot_value *pivot_value_new_text_format (const char *, ...)

+#if defined(__GNUC__) && ((__GNUC__ == 4 && __GNUC_MINOR__>= 4) || __GNUC__ > 4)

   __attribute__((format(gnu_printf, 1, 2)));
   __attribute__((format(gnu_printf, 1, 2)));

+#else
+  __attribute__((format(__printf__, 1, 2)));
+#endif

 
 struct pivot_value *pivot_value_new_user_text (const char *, size_t length);
 struct pivot_value *pivot_value_new_user_text_nocopy (char *);
 
 struct pivot_value *pivot_value_new_user_text (const char *, size_t length);
 struct pivot_value *pivot_value_new_user_text_nocopy (char *);


@@ -714,8 +746,9 @@ void pivot_value_destroy (struct pivot_value *);
 void pivot_value_get_style (struct pivot_value *,
                             const struct font_style *base_font_style,
                             const struct cell_style *base_cell_style,
 void pivot_value_get_style (struct pivot_value *,
                             const struct font_style *base_font_style,
                             const struct cell_style *base_cell_style,

-                            struct area_style *);
-void pivot_value_set_style (struct pivot_value *, const struct area_style *);
+                            struct table_area_style *);
+void pivot_value_set_style (struct pivot_value *,
+                            const struct table_area_style *);

 
 /* Template arguments. */
 struct pivot_argument
 
 /* Template arguments. */
 struct pivot_argument