output: Add support for layer info in table output.
[pspp] / src / output / odt.c
index 1b637f20b7695d235ed872ee73ae833628efcad4..1d430eac5a355b234bef250e95cc7464ee6e1b44 100644 (file)
@@ -36,6 +36,7 @@
 #include "libpspp/temp-file.h"
 #include "libpspp/version.h"
 #include "libpspp/zip-writer.h"
+#include "data/file-handle-def.h"
 #include "output/driver-provider.h"
 #include "output/message-item.h"
 #include "output/options.h"
@@ -68,15 +69,10 @@ struct odt_driver
 
   /* Number of tables so far. */
   int table_num;
-
-  /* Name of current command. */
-  char *command_name;
 };
 
 static const struct output_driver_class odt_driver_class;
 
-static void write_table (struct odt_driver *, const struct table *);
-
 static struct odt_driver *
 odt_driver_cast (struct output_driver *driver)
 {
@@ -147,7 +143,7 @@ write_style_data (struct odt_driver *odt)
                               _xml ("urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0") );
 
   xmlTextWriterWriteAttribute (w, _xml ("office:version"),  _xml ("1.1"));
-                              
+
 
 
   xmlTextWriterStartElement (w, _xml ("office:styles"));
@@ -243,7 +239,7 @@ write_meta_data (struct odt_driver *odt)
   xmlTextWriterStartElement (w, _xml ("office:meta"));
   {
     xmlTextWriterStartElement (w, _xml ("meta:generator"));
-    xmlTextWriterWriteString (w, _xml (stat_version));
+    xmlTextWriterWriteString (w, _xml (version));
     xmlTextWriterEndElement (w);
   }
 
@@ -289,12 +285,13 @@ write_meta_data (struct odt_driver *odt)
 }
 
 static struct output_driver *
-odt_create (const char *file_name, enum settings_output_devices device_type,
+odt_create (struct file_handle *fh, enum settings_output_devices device_type,
             struct string_map *o UNUSED)
 {
   struct output_driver *d;
   struct odt_driver *odt;
   struct zip_writer *zip;
+  const char *file_name = fh_get_file_name (fh);
 
   zip = zip_writer_create (file_name);
   if (zip == NULL)
@@ -302,6 +299,7 @@ odt_create (const char *file_name, enum settings_output_devices device_type,
 
   odt = xzalloc (sizeof *odt);
   d = &odt->driver;
+
   output_driver_init (d, &odt_driver_class, file_name, device_type);
 
   odt->zip = zip;
@@ -381,64 +379,99 @@ odt_destroy (struct output_driver *driver)
 
       zip_writer_close (odt->zip);
     }
-  
+
   free (odt->file_name);
-  free (odt->command_name);
   free (odt);
 }
 
 static void
-write_xml_with_line_breaks (xmlTextWriterPtr writer, char *line)
+write_xml_with_line_breaks (struct odt_driver *odt, const char *line_)
 {
-  char *newline;
-  char *p;
+  xmlTextWriterPtr writer = odt->content_wtr;
 
-  for (p = line; *p; p = newline + 1)
+  if (!strchr (line_, '\n'))
+    xmlTextWriterWriteString (writer, _xml(line_));
+  else
     {
-      newline = strchr (p, '\n');
+      char *line = xstrdup (line_);
+      char *newline;
+      char *p;
 
-      if (!newline)
+      for (p = line; *p; p = newline + 1)
         {
+          newline = strchr (p, '\n');
+
+          if (!newline)
+            {
+              xmlTextWriterWriteString (writer, _xml(p));
+              free (line);
+              return;
+            }
+
+          if (newline > p && newline[-1] == '\r')
+            newline[-1] = '\0';
+          else
+            *newline = '\0';
           xmlTextWriterWriteString (writer, _xml(p));
-          return;
+          xmlTextWriterWriteElement (writer, _xml("text:line-break"), _xml(""));
         }
-
-      if (newline > p && newline[-1] == '\r')
-        newline[-1] = '\0';
-      else
-        *newline = '\0';
-      xmlTextWriterWriteString (writer, _xml(p));
-      xmlTextWriterWriteElement (writer, _xml("text:line-break"), _xml(""));
     }
 }
 
 static void
-odt_submit_table (struct odt_driver *odt, struct table_item *item)
+write_footnote (struct odt_driver *odt, const struct footnote *f)
 {
-  const char *caption = table_item_get_caption (item);
+  xmlTextWriterStartElement (odt->content_wtr, _xml("text:note"));
+  xmlTextWriterWriteAttribute (odt->content_wtr, _xml("text:note-class"),
+                               _xml("footnote"));
+
+  xmlTextWriterStartElement (odt->content_wtr, _xml("text:note-citation"));
+  if (strlen (f->marker) > 1)
+    xmlTextWriterWriteFormatAttribute (odt->content_wtr, _xml("text:label"),
+                                       "(%s)", f->marker);
+  else
+    xmlTextWriterWriteAttribute (odt->content_wtr, _xml("text:label"),
+                                 _xml(f->marker));
+  xmlTextWriterEndElement (odt->content_wtr);
 
-  /* Write a heading for the table */
-  if (caption != NULL)
-    {
-      xmlTextWriterStartElement (odt->content_wtr, _xml("text:h"));
-      xmlTextWriterWriteFormatAttribute (odt->content_wtr,
-                                         _xml("text:outline-level"), "%d", 2);
-      xmlTextWriterWriteString (odt->content_wtr,
-                                _xml (table_item_get_caption (item)) );
-      xmlTextWriterEndElement (odt->content_wtr);
-    }
+  xmlTextWriterStartElement (odt->content_wtr, _xml("text:note-body"));
+  xmlTextWriterStartElement (odt->content_wtr, _xml("text:p"));
+  write_xml_with_line_breaks (odt, f->content);
+  xmlTextWriterEndElement (odt->content_wtr);
+  xmlTextWriterEndElement (odt->content_wtr);
 
-  write_table (odt, table_item_get_table (item));
+  xmlTextWriterEndElement (odt->content_wtr);
 }
 
 static void
-write_table (struct odt_driver *odt, const struct table *tab)
+write_table_item_text (struct odt_driver *odt,
+                       const struct table_item_text *text)
 {
+  if (!text)
+    return;
+
+  xmlTextWriterStartElement (odt->content_wtr, _xml("text:h"));
+  xmlTextWriterWriteFormatAttribute (odt->content_wtr,
+                                     _xml("text:outline-level"), "%d", 2);
+  xmlTextWriterWriteString (odt->content_wtr, _xml (text->content) );
+  for (size_t i = 0; i < text->n_footnotes; i++)
+    write_footnote (odt, text->footnotes[i]);
+  xmlTextWriterEndElement (odt->content_wtr);
+}
+
+static void
+write_table (struct odt_driver *odt, const struct table_item *item)
+{
+  const struct table *tab = table_item_get_table (item);
   int r, c;
 
+  /* Write a heading for the table */
+  write_table_item_text (odt, table_item_get_title (item));
+  write_table_item_text (odt, table_item_get_layers (item));
+
   /* Start table */
   xmlTextWriterStartElement (odt->content_wtr, _xml("table:table"));
-  xmlTextWriterWriteFormatAttribute (odt->content_wtr, _xml("table:name"), 
+  xmlTextWriterWriteFormatAttribute (odt->content_wtr, _xml("table:name"),
                                     "TABLE-%d", odt->table_num++);
 
 
@@ -451,7 +484,7 @@ write_table (struct odt_driver *odt, const struct table *tab)
   /* Deal with row headers */
   if ( table_ht (tab) > 0)
     xmlTextWriterStartElement (odt->content_wtr, _xml("table:table-header-rows"));
-    
+
 
   /* Write all the rows */
   for (r = 0 ; r < table_nr (tab); ++r)
@@ -488,32 +521,21 @@ write_table (struct odt_driver *odt, const struct table *tab)
               for (i = 0; i < cell.n_contents; i++)
                 {
                   const struct cell_contents *contents = &cell.contents[i];
+                  int j;
 
-                  if (contents->text)
-                    {
-                      xmlTextWriterStartElement (odt->content_wtr, _xml("text:p"));
-
-                      if ( r < table_ht (tab) || c < table_hl (tab) )
-                        xmlTextWriterWriteAttribute (odt->content_wtr, _xml("text:style-name"), _xml("Table_20_Heading"));
-                      else
-                        xmlTextWriterWriteAttribute (odt->content_wtr, _xml("text:style-name"), _xml("Table_20_Contents"));
-
-                      if (strchr (contents->text, '\n'))
-                        {
-                          char *line = xstrdup (contents->text);
-                          write_xml_with_line_breaks (odt->content_wtr, line);
-                          free (line);
-                        }
-                      else
-                        xmlTextWriterWriteString (odt->content_wtr, _xml(contents->text));
-
-                      xmlTextWriterEndElement (odt->content_wtr); /* text:p */
-                    }
-                  else if (contents->table)
-                    {
-                      write_table (odt, contents->table);
-                      continue;
-                    }
+                  xmlTextWriterStartElement (odt->content_wtr, _xml("text:p"));
+
+                  if ( r < table_ht (tab) || c < table_hl (tab) )
+                    xmlTextWriterWriteAttribute (odt->content_wtr, _xml("text:style-name"), _xml("Table_20_Heading"));
+                  else
+                    xmlTextWriterWriteAttribute (odt->content_wtr, _xml("text:style-name"), _xml("Table_20_Contents"));
+
+                  write_xml_with_line_breaks (odt, contents->text);
+
+                  for (j = 0; j < contents->n_footnotes; j++)
+                    write_footnote (odt, contents->footnotes[j]);
+
+                  xmlTextWriterEndElement (odt->content_wtr); /* text:p */
                 }
               xmlTextWriterEndElement (odt->content_wtr); /* table:table-cell */
            }
@@ -525,7 +547,7 @@ write_table (struct odt_driver *odt, const struct table *tab)
 
           table_cell_free (&cell);
        }
-  
+
       xmlTextWriterEndElement (odt->content_wtr); /* row */
 
       if ( table_ht (tab) > 0 && r == table_ht (tab) - 1)
@@ -533,6 +555,9 @@ write_table (struct odt_driver *odt, const struct table *tab)
     }
 
   xmlTextWriterEndElement (odt->content_wtr); /* table */
+
+  /* Write a caption for the table */
+  write_table_item_text (odt, table_item_get_caption (item));
 }
 
 static void
@@ -550,10 +575,8 @@ odt_submit (struct output_driver *driver,
 {
   struct odt_driver *odt = odt_driver_cast (driver);
 
-  output_driver_track_current_command (output_item, &odt->command_name);
-
   if (is_table_item (output_item))
-    odt_submit_table (odt, to_table_item (output_item));
+    write_table (odt, to_table_item (output_item));
   else if (is_text_item (output_item))
     {
       struct text_item *text_item = to_text_item (output_item);
@@ -565,7 +588,7 @@ odt_submit (struct output_driver *driver,
     {
       const struct message_item *message_item = to_message_item (output_item);
       const struct msg *msg = message_item_get_msg (message_item);
-      char *s = msg_to_string (msg, odt->command_name);
+      char *s = msg_to_string (msg, message_item->command_name);
       odt_output_text (odt, s);
       free (s);
     }