#include "output/group-item.h"
#include "output/message-item.h"
#include "output/options.h"
+#include "output/page-setup-item.h"
#include "output/render.h"
#include "output/tab.h"
#include "output/table-item.h"
int line_width; /* Width of lines. */
int min_break[TABLE_N_AXES]; /* Min cell size to break across pages. */
+ int object_spacing; /* Space between output objects. */
struct xr_color bg; /* Background color */
struct xr_color fg; /* Foreground color */
+ int initial_page_number;
+
+ struct page_heading headings[2]; /* Top and bottom headings. */
+ int headings_height[2];
+
/* Internal state. */
struct render_params *params;
int char_width, char_height;
char *title;
char *subtitle;
cairo_t *cairo;
+ cairo_surface_t *surface;
int page_number; /* Current page number. */
int x, y;
struct xr_render_fsm *fsm;
int nest;
+ struct string_map heading_vars;
};
static const struct output_driver_class cairo_driver_class;
xr->fonts[XR_FONT_EMPHASIS].desc = parse_font_option (
d, o, "emph-font", "sans serif", font_size, false, true);
- xr->page_number = 0;
-
parse_color (d, o, "background-color", "#FFFFFFFFFFFF", &xr->bg);
parse_color (d, o, "foreground-color", "#000000000000", &xr->fg);
min_break[H] = parse_dimension (opt (d, o, "min-hbreak", NULL)) * scale;
min_break[V] = parse_dimension (opt (d, o, "min-vbreak", NULL)) * scale;
+ int object_spacing = (parse_dimension (opt (d, o, "object-spacing", NULL))
+ * scale);
+
/* Convert to inch/(XR_POINT * 72). */
xr->left_margin = left_margin * scale;
xr->right_margin = right_margin * scale;
xr->length = (paper_length - top_margin - bottom_margin) * scale;
xr->min_break[H] = min_break[H] >= 0 ? min_break[H] : xr->width / 2;
xr->min_break[V] = min_break[V] >= 0 ? min_break[V] : xr->length / 2;
+ xr->object_spacing = object_spacing >= 0 ? object_spacing : XR_POINT * 12;
+
+ /* There are no headings so headings_height can stay 0. */
}
static struct xr_driver *
output_driver_init (d, &cairo_driver_class, name, device_type);
+ string_map_init (&xr->heading_vars);
+
apply_options (xr, o);
return xr;
: xr);
}
+static void
+xr_measure_fonts (cairo_t *cairo, const struct xr_font fonts[XR_N_FONTS],
+ int *char_width, int *char_height)
+{
+ *char_width = 0;
+ *char_height = 0;
+ for (int i = 0; i < XR_N_FONTS; i++)
+ {
+ PangoLayout *layout = pango_cairo_create_layout (cairo);
+ pango_layout_set_font_description (layout, fonts[i].desc);
+
+ pango_layout_set_text (layout, "0", 1);
+
+ int cw, ch;
+ pango_layout_get_size (layout, &cw, &ch);
+ *char_width = MAX (*char_width, pango_to_xr (cw));
+ *char_height = MAX (*char_height, pango_to_xr (ch));
+
+ g_object_unref (G_OBJECT (layout));
+ }
+}
+
+static int
+xr_render_page_heading (cairo_t *cairo, const PangoFontDescription *font,
+ const struct page_heading *ph, int page_number,
+ int width, bool draw, int base_y)
+{
+ PangoLayout *layout = pango_cairo_create_layout (cairo);
+ pango_layout_set_font_description (layout, font);
+
+ int y = 0;
+ for (size_t i = 0; i < ph->n; i++)
+ {
+ const struct page_paragraph *pp = &ph->paragraphs[i];
+
+ char *markup = output_driver_substitute_heading_vars (pp->markup,
+ page_number);
+ pango_layout_set_markup (layout, markup, -1);
+ free (markup);
+
+ pango_layout_set_alignment (layout,
+ (pp->halign == TAB_RIGHT ? PANGO_ALIGN_RIGHT
+ : pp->halign == TAB_LEFT ? PANGO_ALIGN_LEFT
+ : PANGO_ALIGN_CENTER));
+ pango_layout_set_width (layout, xr_to_pango (width));
+ if (draw)
+ {
+ cairo_save (cairo);
+ cairo_translate (cairo, 0, xr_to_pt (y + base_y));
+ pango_cairo_show_layout (cairo, layout);
+ cairo_restore (cairo);
+ }
+
+ int w, h;
+ pango_layout_get_size (layout, &w, &h);
+ y += pango_to_xr (h);
+ }
+
+ g_object_unref (G_OBJECT (layout));
+
+ return y;
+}
+
+static int
+xr_measure_headings (cairo_surface_t *surface,
+ const PangoFontDescription *font,
+ const struct page_heading headings[2],
+ int width, int object_spacing, int height[2])
+{
+ cairo_t *cairo = cairo_create (surface);
+ int total = 0;
+ for (int i = 0; i < 2; i++)
+ {
+ int h = xr_render_page_heading (cairo, font, &headings[i], -1,
+ width, false, 0);
+
+ /* If the top heading is nonempty, add some space below it. */
+ if (h && i == 0)
+ h += object_spacing;
+
+ if (height)
+ height[i] = h;
+ total += h;
+ }
+ cairo_destroy (cairo);
+ return total;
+}
+
static bool
-xr_set_cairo (struct xr_driver *xr, cairo_t *cairo)
+xr_check_fonts (cairo_surface_t *surface,
+ const struct xr_font fonts[XR_N_FONTS],
+ int usable_width, int usable_length)
{
- int i;
+ cairo_t *cairo = cairo_create (surface);
+ int char_width, char_height;
+ xr_measure_fonts (cairo, fonts, &char_width, &char_height);
+ cairo_destroy (cairo);
+ bool ok = true;
+ enum { MIN_WIDTH = 3, MIN_LENGTH = 3 };
+ if (usable_width / char_width < MIN_WIDTH)
+ {
+ msg (ME, _("The defined page is not wide enough to hold at least %d "
+ "characters in the default font. In fact, there's only "
+ "room for %d characters."),
+ MIN_WIDTH, usable_width / char_width);
+ ok = false;
+ }
+ if (usable_length / char_height < MIN_LENGTH)
+ {
+ msg (ME, _("The defined page is not long enough to hold at least %d "
+ "lines in the default font. In fact, there's only "
+ "room for %d lines."),
+ MIN_LENGTH, usable_length / char_height);
+ ok = false;
+ }
+ return ok;
+}
+
+static void
+xr_set_cairo (struct xr_driver *xr, cairo_t *cairo)
+{
xr->cairo = cairo;
cairo_set_line_width (xr->cairo, xr_to_pt (XR_LINE_WIDTH));
- xr->char_width = 0;
- xr->char_height = 0;
- for (i = 0; i < XR_N_FONTS; i++)
+ xr_measure_fonts (xr->cairo, xr->fonts, &xr->char_width, &xr->char_height);
+
+ for (int i = 0; i < XR_N_FONTS; i++)
{
struct xr_font *font = &xr->fonts[i];
- int char_width, char_height;
-
font->layout = pango_cairo_create_layout (cairo);
pango_layout_set_font_description (font->layout, font->desc);
-
- pango_layout_set_text (font->layout, "0", 1);
- pango_layout_get_size (font->layout, &char_width, &char_height);
- xr->char_width = MAX (xr->char_width, pango_to_xr (char_width));
- xr->char_height = MAX (xr->char_height, pango_to_xr (char_height));
}
if (xr->params == NULL)
int lw = XR_LINE_WIDTH;
int ls = XR_LINE_SPACE;
- for (i = 0; i < TABLE_N_AXES; i++)
+ for (int i = 0; i < TABLE_N_AXES; i++)
{
xr->params->line_widths[i][RENDER_LINE_NONE] = 0;
xr->params->line_widths[i][RENDER_LINE_SINGLE] = lw;
xr->params->line_widths[i][RENDER_LINE_DOUBLE] = 2 * lw + ls;
}
- for (i = 0; i < TABLE_N_AXES; i++)
+ for (int i = 0; i < TABLE_N_AXES; i++)
xr->params->min_break[i] = xr->min_break[i];
xr->params->supports_margins = true;
xr->params->rtl = render_direction_rtl ();
}
cairo_set_source_rgb (xr->cairo, xr->fg.red, xr->fg.green, xr->fg.blue);
-
- return true;
}
static struct output_driver *
xr_create (const char *file_name, enum settings_output_devices device_type,
struct string_map *o, enum xr_output_type file_type)
{
- enum { MIN_WIDTH = 3, MIN_LENGTH = 3 };
struct xr_driver *xr;
- cairo_surface_t *surface;
cairo_status_t status;
double width_pt, length_pt;
width_pt = xr_to_pt (xr->width + xr->left_margin + xr->right_margin);
length_pt = xr_to_pt (xr->length + xr->top_margin + xr->bottom_margin);
if (file_type == XR_PDF)
- surface = cairo_pdf_surface_create (file_name, width_pt, length_pt);
+ xr->surface = cairo_pdf_surface_create (file_name, width_pt, length_pt);
else if (file_type == XR_PS)
- surface = cairo_ps_surface_create (file_name, width_pt, length_pt);
+ xr->surface = cairo_ps_surface_create (file_name, width_pt, length_pt);
else if (file_type == XR_SVG)
- surface = cairo_svg_surface_create (file_name, width_pt, length_pt);
+ xr->surface = cairo_svg_surface_create (file_name, width_pt, length_pt);
else
NOT_REACHED ();
- status = cairo_surface_status (surface);
+ status = cairo_surface_status (xr->surface);
if (status != CAIRO_STATUS_SUCCESS)
{
msg (ME, _("error opening output file `%s': %s"),
file_name, cairo_status_to_string (status));
- cairo_surface_destroy (surface);
goto error;
}
- xr->cairo = cairo_create (surface);
- cairo_surface_destroy (surface);
-
- if (!xr_set_cairo (xr, xr->cairo))
+ if (!xr_check_fonts (xr->surface, xr->fonts, xr->width, xr->length))
goto error;
- cairo_save (xr->cairo);
- xr_driver_next_page (xr, xr->cairo);
-
- if (xr->width / xr->char_width < MIN_WIDTH)
- {
- msg (ME, _("The defined page is not wide enough to hold at least %d "
- "characters in the default font. In fact, there's only "
- "room for %d characters."),
- MIN_WIDTH,
- xr->width / xr->char_width);
- goto error;
- }
-
- if (xr->length / xr->char_height < MIN_LENGTH)
- {
- msg (ME, _("The defined page is not long enough to hold at least %d "
- "lines in the default font. In fact, there's only "
- "room for %d lines."),
- MIN_LENGTH,
- xr->length / xr->char_height);
- goto error;
- }
-
return &xr->driver;
error:
if (xr->cairo != NULL)
{
- cairo_status_t status;
-
- cairo_surface_finish (cairo_get_target (xr->cairo));
- status = cairo_status (xr->cairo);
+ cairo_surface_finish (xr->surface);
+ cairo_status_t status = cairo_status (xr->cairo);
if (status != CAIRO_STATUS_SUCCESS)
msg (ME, _("error drawing output for %s driver: %s"),
output_driver_get_name (driver),
cairo_status_to_string (status));
+ cairo_surface_destroy (xr->surface);
+
cairo_destroy (xr->cairo);
}
cairo_surface_flush (cairo_get_target (xr->cairo));
}
+static void
+xr_update_page_setup (struct output_driver *driver,
+ const struct page_setup *ps)
+{
+ struct xr_driver *xr = xr_driver_cast (driver);
+
+ xr->initial_page_number = ps->initial_page_number;
+ xr->object_spacing = ps->object_spacing * 72 * XR_POINT;
+
+ if (xr->cairo)
+ return;
+
+ int usable[TABLE_N_AXES];
+ for (int i = 0; i < 2; i++)
+ usable[i] = (ps->paper[i]
+ - (ps->margins[i][0] + ps->margins[i][1])) * 72 * XR_POINT;
+
+ int headings_height[2];
+ usable[V] -= xr_measure_headings (
+ xr->surface, xr->fonts[XR_FONT_PROPORTIONAL].desc, ps->headings,
+ usable[H], xr->object_spacing, headings_height);
+
+ enum table_axis h = ps->orientation == PAGE_LANDSCAPE;
+ enum table_axis v = !h;
+ if (!xr_check_fonts (xr->surface, xr->fonts, usable[h], usable[v]))
+ return;
+
+ for (int i = 0; i < 2; i++)
+ {
+ page_heading_uninit (&xr->headings[i]);
+ page_heading_copy (&xr->headings[i], &ps->headings[i]);
+ xr->headings_height[i] = headings_height[i];
+ }
+ xr->width = usable[h];
+ xr->length = usable[v];
+ xr->left_margin = ps->margins[h][0] * 72 * XR_POINT;
+ xr->right_margin = ps->margins[h][1] * 72 * XR_POINT;
+ xr->top_margin = ps->margins[v][0] * 72 * XR_POINT;
+ xr->bottom_margin = ps->margins[v][1] * 72 * XR_POINT;
+ cairo_pdf_surface_set_size (xr->surface,
+ ps->paper[h] * 72.0, ps->paper[v] * 72.0);
+}
+
static void
xr_submit (struct output_driver *driver, const struct output_item *output_item)
{
struct xr_driver *xr = xr_driver_cast (driver);
+ if (is_page_setup_item (output_item))
+ {
+ xr_update_page_setup (driver,
+ to_page_setup_item (output_item)->page_setup);
+ return;
+ }
+
+ if (!xr->cairo)
+ {
+ xr->page_number = xr->initial_page_number - 1;
+ xr_set_cairo (xr, cairo_create (xr->surface));
+ cairo_save (xr->cairo);
+ xr_driver_next_page (xr, xr->cairo);
+ }
+
xr_driver_output_item (xr, output_item);
while (xr_driver_need_new_page (xr))
{
cairo_translate (cairo,
xr_to_pt (xr->left_margin),
- xr_to_pt (xr->top_margin));
+ xr_to_pt (xr->top_margin + xr->headings_height[0]));
xr->page_number++;
xr->cairo = cairo;
xr->x = xr->y = 0;
+
+ xr_render_page_heading (xr->cairo, xr->fonts[XR_FONT_PROPORTIONAL].desc,
+ &xr->headings[0], xr->page_number, xr->width, true,
+ -xr->headings_height[0]);
+ xr_render_page_heading (xr->cairo, xr->fonts[XR_FONT_PROPORTIONAL].desc,
+ &xr->headings[1], xr->page_number, xr->width, true,
+ xr->length);
+
xr_driver_run_fsm (xr);
}
if (best && !xr->nest)
dump_line (xr, -xr->left_margin, best,
xr->width + xr->right_margin, best,
- RENDER_LINE_SINGLE, &CELL_COLOR (0, 255, 0));
+ RENDER_LINE_SINGLE,
+ &(struct cell_color) CELL_COLOR (0, 255, 0));
}
}
xr_driver_create (cairo_t *cairo, struct string_map *options)
{
struct xr_driver *xr = xr_allocate ("cairo", 0, options);
- if (!xr_set_cairo (xr, cairo))
- {
- output_driver_destroy (&xr->driver);
- return NULL;
- }
+ xr_set_cairo (xr, cairo);
return xr;
}
xr_render_text (struct xr_driver *xr, const struct text_item *text_item)
{
enum text_item_type type = text_item_get_type (text_item);
+ const char *text = text_item_get_text (text_item);
switch (type)
{
case TEXT_ITEM_PAGE_TITLE:
+ string_map_replace (&xr->heading_vars, "PageTitle", text);
break;
case TEXT_ITEM_BLANK_LINE:
#include <limits.h>
#include <stdlib.h>
#include <string.h>
+#include <time.h>
#include "data/file-handle-def.h"
#include "data/settings.h"
char **groups; /* Command names of nested sections. */
size_t n_groups;
size_t allocated_groups;
+
+ struct string_map heading_vars;
};
static const struct output_driver_factory *factories[];
return &engine_stack[n_stack - 1];
}
+static void
+put_strftime (const char *key, const char *format,
+ const struct tm *tm, struct string_map *vars)
+{
+ if (!string_map_find (vars, key))
+ {
+ char value[128];
+ strftime (value, sizeof value, format, tm);
+ string_map_insert (vars, key, value);
+ }
+}
+
void
output_engine_push (void)
{
memset (e, 0, sizeof *e);
llx_init (&e->drivers);
ds_init_empty (&e->deferred_syntax);
- e->title = NULL;
- e->subtitle = NULL;
+
+ string_map_init (&e->heading_vars);
+
+ time_t t = time (NULL);
+ const struct tm *tm = localtime (&t);
+ put_strftime ("Date", "%x", tm, &e->heading_vars);
+ put_strftime ("Time", "%X", tm, &e->heading_vars);
}
void
for (size_t i = 0; i < e->n_groups; i++)
free (e->groups[i]);
free (e->groups);
+ string_map_destroy (&e->heading_vars);
}
void
size_t idx = --e->n_groups;
free (e->groups[idx]);
+ if (idx >= 1 && idx <= 4)
+ {
+ char key[6];
+ snprintf (key, sizeof key, "Head%d", idx);
+ string_map_find_and_delete (&e->heading_vars, key);
+ }
+ }
+ else if (is_text_item (item))
+ {
+ const struct text_item *text_item = to_text_item (item);
+ enum text_item_type type = text_item_get_type (text_item);
+ const char *text = text_item_get_text (text_item);
+ if (type == TEXT_ITEM_TITLE
+ && e->n_groups >= 1 && e->n_groups <= 4)
+ {
+ char key[6];
+ snprintf (key, sizeof key, "Head%d", e->n_groups);
+ string_map_replace (&e->heading_vars, key, text);
+ }
+ else if (type == TEXT_ITEM_PAGE_TITLE)
+ string_map_replace (&e->heading_vars, "PageTitle", text);
}
+
output_submit__ (e, item);
}
output_set_title__ (e, &e->subtitle, subtitle);
}
+void
+output_set_filename (const char *filename)
+{
+ struct output_engine *e = engine_stack_top ();
+
+ string_map_replace (&e->heading_vars, "Filename", filename);
+}
+
size_t
output_get_group_level (void)
{
return content;
}
+
+char *
+output_driver_substitute_heading_vars (const char *src, int page_number)
+{
+ struct output_engine *e = engine_stack_top ();
+ struct string dst = DS_EMPTY_INITIALIZER;
+ ds_extend (&dst, strlen (src));
+ for (const char *p = src; *p; )
+ {
+ if (!strncmp (p, "&[", 6))
+ {
+ if (page_number != INT_MIN)
+ {
+ const char *start = p + 6;
+ const char *end = strchr (start, ']');
+ if (end)
+ {
+ const char *value = string_map_find__ (&e->heading_vars,
+ start, end - start);
+ if (value)
+ ds_put_cstr (&dst, value);
+ else if (ss_equals (ss_buffer (start, end - start),
+ ss_cstr ("Page")))
+ ds_put_format (&dst, "%d", page_number);
+ p = end + 1;
+ continue;
+ }
+ }
+ ds_put_cstr (&dst, "&");
+ p += 5;
+ }
+ else
+ ds_put_byte (&dst, *p++);
+ }
+ return ds_steal_cstr (&dst);
+}
--- /dev/null
+/* PSPP - a program for statistical analysis.
+ Copyright (C) 2009, 2010, 2011, 2018 Free Sonftware 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
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>. */
+
+#ifndef OUTPUT_PAGE_SETUP_ITEM_H
+#define OUTPUT_PAGE_SETUP_ITEM_H 1
+
+/* Page setup items.
+
+ A page setup item configures the paper size, margins, header and footer,
+ and other attributes used for printing. */
+
+#include <stdbool.h>
+#include "output/output-item.h"
+#include "table.h"
+
+enum page_orientation
+ {
+ PAGE_PORTRAIT,
+ PAGE_LANDSCAPE
+ };
+
+enum page_chart_size
+ {
+ PAGE_CHART_AS_IS,
+ PAGE_CHART_FULL_HEIGHT,
+ PAGE_CHART_HALF_HEIGHT,
+ PAGE_CHART_QUARTER_HEIGHT,
+ };
+
+struct page_paragraph
+ {
+ char *markup;
+ int halign; /* TAB_LEFT, TAB_CENTER, TAB_RIGHT. */
+ };
+
+struct page_heading
+ {
+ struct page_paragraph *paragraphs;
+ size_t n;
+ };
+
+void page_heading_copy (struct page_heading *, const struct page_heading *);
+void page_heading_uninit (struct page_heading *);
+
+struct page_setup
+ {
+ int initial_page_number;
+ double paper[TABLE_N_AXES]; /* Paper size in inches. */
+ double margins[TABLE_N_AXES][2]; /* In inches. */
+ enum page_orientation orientation;
+ double object_spacing; /* Space between objects, in inches. */
+ enum page_chart_size chart_size;
+ struct page_heading headings[2]; /* Header and footer. */
+ char *file_name;
+ };
+
+#define PAGE_SETUP_INITIALIZER \
+ { \
+ .initial_page_number = 1, \
+ .paper = { [TABLE_HORZ] = 8.5, [TABLE_VERT] = 11.0 }, \
+ .margins = { { 0.5, 0.5 }, { 0.5, 0.5 } }, \
+ .orientation = PAGE_PORTRAIT, \
+ .object_spacing = 12.0 / 72.0, \
+ .chart_size = PAGE_CHART_AS_IS, \
+ }
+
+struct page_setup *page_setup_clone (const struct page_setup *);
+void page_setup_destroy (struct page_setup *);
+
+/* A page setup item. */
+struct page_setup_item
+ {
+ struct output_item output_item;
+ struct page_setup *page_setup;
+ };
+
+struct page_setup_item *page_setup_item_create (const struct page_setup *);
+\f
+/* This boilerplate for page_setup_item, a subclass of output_item, was
+ autogenerated by mk-class-boilerplate. */
+
+#include <assert.h>
+#include "libpspp/cast.h"
+
+extern const struct output_item_class page_setup_item_class;
+
+/* Returns true if SUPER is a page_setup_item, otherwise false. */
+static inline bool
+is_page_setup_item (const struct output_item *super)
+{
+ return super->class == &page_setup_item_class;
+}
+
+/* Returns SUPER converted to page_setup_item. SUPER must be a page_setup_item, as
+ reported by is_page_setup_item. */
+static inline struct page_setup_item *
+to_page_setup_item (const struct output_item *super)
+{
+ assert (is_page_setup_item (super));
+ return UP_CAST (super, struct page_setup_item, output_item);
+}
+
+/* Returns INSTANCE converted to output_item. */
+static inline struct output_item *
+page_setup_item_super (const struct page_setup_item *instance)
+{
+ return CONST_CAST (struct output_item *, &instance->output_item);
+}
+
+/* Increments INSTANCE's reference count and returns INSTANCE. */
+static inline struct page_setup_item *
+page_setup_item_ref (const struct page_setup_item *instance)
+{
+ return to_page_setup_item (output_item_ref (&instance->output_item));
+}
+
+/* Decrements INSTANCE's reference count, then destroys INSTANCE if
+ the reference count is now zero. */
+static inline void
+page_setup_item_unref (struct page_setup_item *instance)
+{
+ output_item_unref (&instance->output_item);
+}
+
+/* Returns true if INSTANCE's reference count is greater than 1,
+ false otherwise. */
+static inline bool
+page_setup_item_is_shared (const struct page_setup_item *instance)
+{
+ return output_item_is_shared (&instance->output_item);
+}
+
+void page_setup_item_submit (struct page_setup_item *);
+\f
+#endif /* output/page-setup-item.h */
projects / pspp / commitdiff