render: Introduce render_pager to factor out code from drivers.

[pspp] / src / output / render.h

diff --git a/src/output/render.h b/src/output/render.h
index cfba52e967b08616fbb22a39589d13911c9126c9..eed29e8512a74c7d9a87160054d58f1dff16dbdf 100644 (file)
--- a/src/output/render.h
+++ b/src/output/render.h
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 2009 Free Software Foundation, Inc.
+   Copyright (C) 2009, 2010, 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
@@ -19,7 +19,7 @@
 
 #include <stdbool.h>
 #include <stddef.h>
-#include <output/table-provider.h>
+#include "output/table-provider.h"
 
 struct table;
 
@@ -44,6 +44,19 @@ struct render_params
     int (*measure_cell_height) (void *aux, const struct table_cell *cell,
                                 int width);
 
+    /* Given that there is space measuring WIDTH by HEIGHT to render CELL,
+       where HEIGHT is insufficient to render the entire height of the cell,
+       returns the largest height less than HEIGHT at which it is appropriate
+       to break the cell.  For example, if breaking at the specified HEIGHT
+       would break in the middle of a line of text, the return value would be
+       just sufficiently less that the breakpoint would be between lines of
+       text.
+
+       Optional.  If NULL, the rendering engine assumes that all breakpoints
+       are acceptable. */
+    int (*adjust_break) (void *aux, const struct table_cell *cell,
+                         int width, int height);
+
     /* Draws a generalized intersection of lines in the rectangle whose
        top-left corner is (BB[TABLE_HORZ][0], BB[TABLE_VERT][0]) and whose
        bottom-right corner is (BB[TABLE_HORZ][1], BB[TABLE_VERT][1]).
@@ -78,12 +91,17 @@ struct render_params
 
     /* Width of different kinds of lines. */
     int line_widths[TABLE_N_AXES][RENDER_N_LINES];
+
+    /* Minimum cell width or height before allowing the cell to be broken
+       across two pages.  (Joined cells may always be broken at join
+       points.) */
+    int min_break[TABLE_N_AXES];
   };
 \f
 /* A "page" of content that is ready to be rendered.
 
    A page's size is not limited to the size passed in as part of render_params.
-   Use render_break (see below) to break a too-big render_page into smaller
+   Use render_pager (see below) to break a render_page into smaller
    render_pages that will fit in the available space. */
 struct render_page *render_page_create (const struct render_params *,
                                         const struct table *);
@@ -93,23 +111,17 @@ void render_page_unref (struct render_page *);
 
 int render_page_get_size (const struct render_page *, enum table_axis);
 void render_page_draw (const struct render_page *);
+void render_page_draw_region (const struct render_page *,
+                              int x, int y, int w, int h);
+
+int render_page_get_best_breakpoint (const struct render_page *, int height);
 \f
 /* An iterator for breaking render_pages into smaller chunks. */
-struct render_break
-  {
-    struct render_page *page;   /* Page being broken up. */
-    enum table_axis axis;       /* Axis along which 'page' is being broken. */
-    int cell;                   /* Next cell. */
-    int pixel;                  /* Pixel offset within 'cell' (usually 0). */
-    int hw;                     /* Width of headers of 'page' along 'axis'. */
-  };
 
-void render_break_init (struct render_break *, struct render_page *,
-                        enum table_axis);
-void render_break_destroy (struct render_break *);
+struct render_pager *render_pager_create (struct render_page *);
+void render_pager_destroy (struct render_pager *);
 
-bool render_break_has_next (const struct render_break *);
-int render_break_next_size (const struct render_break *);
-struct render_page *render_break_next (struct render_break *, int size);
+bool render_pager_has_next (const struct render_pager *);
+struct render_page *render_pager_next (struct render_pager *, int height);
 
 #endif /* output/render.h */