Merge lp:~inkscape.dev/inkscape/inkscape-librevenge into lp:~inkscape.dev/inkscape/trunk

[su_v]

Port inkscape to librevenge framework for WPG, CDR and VSD imports

See also:
http://www.documentliberation.org/
http://libregraphicsworld.org/blog/entry/librevenge-has-arrived

Thanks to Alex Valavanis the branch now supports conditional building with old or newer versions of libwpg, libcdr and libvisio, and does not introduce new requirements for dependencies which aren't available on current stable distros yet.

Branch compiled and tested successfully on OS X 10.7.5 with current stable releases (libwpg-2.0, libcdr 0.0, libvisio 0.0) and with git master of librevenge, libwpg, libcdr, libvisio.

[su_v (suv-lp)]

On 2014-05-28 06:24 +0100, ~suv wrote:
> Currently introduces an indirect dependency on one of the boost
> libraries: librevenge-stream-0.0 requires the Filesystem library from
> the Boost C++ libraries.

The dependency on the Filesystem library has been removed from upstream librevenge today:
<http://sourceforge.net/p/libwpd/librevenge/ci/fd8b4f3d933b631584e3338eae564f9336a20533/tree/>

[su_v (suv-lp)]

Branch updated in r13405 to latest patch from bug #1323592 for conditional build.

review: Needs Resubmitting

[lp:~inkscape.dev/inkscape/inkscape-librevenge]

13407. By su_v on 2014-09-02

update to trunk (r13540)

13408. By su_v on 2014-09-19

update to trunk (r13560)

[Bryce Harrington (bryce)]

I did a quick code review of the patch and it all looks fine, if the testing of the three components is working.

This is Freeze Approved for landing in the 0.91 stable tree.

review: Approve (code)

=== modified file 'configure.ac'
--- configure.ac	2014-09-02 04:05:35 +0000
+++ configure.ac	2014-09-19 00:35:56 +0000
@@ -532,27 +532,32 @@
 with_libwpg=no
 
 if test "x$enable_wpg" = "xyes"; then
-	PKG_CHECK_MODULES(LIBWPG01, libwpg-0.1 libwpg-stream-0.1, with_libwpg01=yes, with_libwpg01=no)
-	if test "x$with_libwpg01" = "xyes"; then
-		AC_DEFINE(WITH_LIBWPG01,1,[Build in libwpg 0.1.x])
-		with_libwpg=yes
-		AC_SUBST(LIBWPG_LIBS, $LIBWPG01_LIBS)
-		AC_SUBST(LIBWPG_CFLAGS, $LIBWPG01_CFLAGS)
-	fi
-
-	PKG_CHECK_MODULES(LIBWPG02, libwpg-0.2 libwpd-0.9 libwpd-stream-0.9, with_libwpg02=yes, with_libwpg02=no)
-	if test "x$with_libwpg02" = "xyes"; then
-		AC_DEFINE(WITH_LIBWPG02,1,[Build in libwpg 0.2.x])
-		with_libwpg=yes
-		AC_SUBST(LIBWPG_LIBS, $LIBWPG02_LIBS)
-		AC_SUBST(LIBWPG_CFLAGS, $LIBWPG02_CFLAGS)
+        dnl **************************************************************
+        dnl Try using librevenge framework first. Fall back to old libs
+        dnl if unavailable.
+        dnl TODO: Drop subsequent tests once this is widespread in distros
+        dnl **************************************************************
+	PKG_CHECK_MODULES(LIBWPG03, libwpg-0.3 librevenge-0.0 librevenge-stream-0.0, with_libwpg03=yes, with_libwpg03=no)
+	if test "x$with_libwpg03" = "xyes"; then
+		AC_DEFINE(WITH_LIBWPG03,1,[Build using libwpg 0.3.x])
+		with_libwpg=yes
+		AC_SUBST(LIBWPG_LIBS, $LIBWPG03_LIBS)
+		AC_SUBST(LIBWPG_CFLAGS, $LIBWPG03_CFLAGS)
+	else
+		PKG_CHECK_MODULES(LIBWPG02, libwpg-0.2 libwpd-0.9 libwpd-stream-0.9, with_libwpg02=yes, with_libwpg02=no)
+		if test "x$with_libwpg02" = "xyes"; then
+			AC_DEFINE(WITH_LIBWPG02,1,[Build using libwpg 0.2.x])
+			with_libwpg=yes
+			AC_SUBST(LIBWPG_LIBS, $LIBWPG02_LIBS)
+			AC_SUBST(LIBWPG_CFLAGS, $LIBWPG02_CFLAGS)
+		fi
 	fi
 
 	if test "x$with_libwpg" = "xyes"; then
 		AC_DEFINE(WITH_LIBWPG,1,[Build in libwpg])
 	fi
 fi
-AM_CONDITIONAL(WITH_LIBWPG01, test "x$with_libwpg01" = "xyes")
+AM_CONDITIONAL(WITH_LIBWPG03, test "x$with_libwpg03" = "xyes")
 AM_CONDITIONAL(WITH_LIBWPG02, test "x$with_libwpg02" = "xyes")
 AM_CONDITIONAL(WITH_LIBWPG, test "x$with_libwpg" = "xyes")
 
@@ -567,14 +572,33 @@
 with_libvisio=no
 
 if test "x$enable_visio" = "xyes"; then
-	PKG_CHECK_MODULES(LIBVISIO, libvisio-0.0 >= 0.0.20 libwpd-0.9 libwpd-stream-0.9 libwpg-0.2, with_libvisio=yes, with_libvisio=no)
+        dnl **************************************************************
+        dnl Try using librevenge framework first. Fall back to old libs
+        dnl if unavailable.
+        dnl TODO: Drop subsequent tests once this is widespread in distros
+        dnl **************************************************************
+	PKG_CHECK_MODULES(LIBVISIO01, libvisio-0.1 librevenge-0.0 librevenge-stream-0.0, with_libvisio01=yes, with_libvisio01=no)
+	if test "x$with_libvisio01" = "xyes"; then
+		AC_DEFINE(WITH_LIBVISIO01,1,[Build using libvisio 0.1.x])
+		with_libvisio=yes
+		AC_SUBST(LIBVISIO_LIBS, $LIBVISIO01_LIBS)
+		AC_SUBST(LIBVISIO_CFLAGS, $LIBVISIO01_CFLAGS)
+	else
+		PKG_CHECK_MODULES(LIBVISIO00, libvisio-0.0 >= 0.0.20 libwpd-0.9 libwpd-stream-0.9 libwpg-0.2, with_libvisio00=yes, with_libvisio00=no)
+		if test "x$with_libvisio00" = "xyes"; then
+			AC_DEFINE(WITH_LIBVISIO00,1,[Build using libvisio 0.0.x])
+			with_libvisio=yes
+			AC_SUBST(LIBVISIO_LIBS, $LIBVISIO00_LIBS)
+			AC_SUBST(LIBVISIO_CFLAGS, $LIBVISIO00_CFLAGS)
+		fi
+	fi
 
 	if test "x$with_libvisio" = "xyes"; then
 		AC_DEFINE(WITH_LIBVISIO,1,[Build in libvisio])
 	fi
 fi
-AC_SUBST(LIBVISIO_LIBS)
-AC_SUBST(LIBVISIO_CFLAGS)
+AM_CONDITIONAL(WITH_LIBVISIO01, test "x$with_libvisio01" = "xyes")
+AM_CONDITIONAL(WITH_LIBVISIO00, test "x$with_libvisio00" = "xyes")
 AM_CONDITIONAL(WITH_LIBVISIO, test "x$with_libvisio" = "xyes")
 
 dnl ********************************
@@ -588,14 +612,33 @@
 with_libcdr=no
 
 if test "x$enable_cdr" = "xyes"; then
-	PKG_CHECK_MODULES(LIBCDR, libcdr-0.0 >= 0.0.3 libwpd-0.9 libwpd-stream-0.9 libwpg-0.2, with_libcdr=yes, with_libcdr=no)
+        dnl **************************************************************
+        dnl Try using librevenge framework first. Fall back to old libs
+        dnl if unavailable.
+        dnl TODO: Drop subsequent tests once this is widespread in distros
+        dnl **************************************************************
+	PKG_CHECK_MODULES(LIBCDR01, libcdr-0.1 librevenge-0.0 librevenge-stream-0.0, with_libcdr01=yes, with_libcdr01=no)
+	if test "x$with_libcdr01" = "xyes"; then
+		AC_DEFINE(WITH_LIBCDR01,1,[Build using libcdr 0.1.x])
+		with_libcdr=yes
+		AC_SUBST(LIBCDR_LIBS, $LIBCDR01_LIBS)
+		AC_SUBST(LIBCDR_CFLAGS, $LIBCDR01_CFLAGS)
+	else
+		PKG_CHECK_MODULES(LIBCDR00, libcdr-0.0 >= 0.0.3 libwpd-0.9 libwpd-stream-0.9 libwpg-0.2, with_libcdr00=yes, with_libcdr00=no)
+		if test "x$with_libcdr00" = "xyes"; then
+			AC_DEFINE(WITH_LIBCDR00,1,[Build using libcdr 0.0.x])
+			with_libcdr=yes
+			AC_SUBST(LIBCDR_LIBS, $LIBCDR00_LIBS)
+			AC_SUBST(LIBCDR_CFLAGS, $LIBCDR00_CFLAGS)
+		fi
+	fi
 
 	if test "x$with_libcdr" = "xyes"; then
 		AC_DEFINE(WITH_LIBCDR,1,[Build in libcdr])
 	fi
 fi
-AC_SUBST(LIBCDR_LIBS)
-AC_SUBST(LIBCDR_CFLAGS)
+AM_CONDITIONAL(WITH_LIBCDR01, test "x$with_libcdr01" = "xyes")
+AM_CONDITIONAL(WITH_LIBCDR00, test "x$with_libcdr00" = "xyes")
 AM_CONDITIONAL(WITH_LIBCDR, test "x$with_libcdr" = "xyes")
 
 dnl ******************************

=== modified file 'src/extension/internal/cdr-input.cpp'
--- src/extension/internal/cdr-input.cpp	2013-10-27 16:33:32 +0000
+++ src/extension/internal/cdr-input.cpp	2014-09-19 00:35:56 +0000
@@ -24,7 +24,21 @@
 #include <cstring>
 
 #include <libcdr/libcdr.h>
-#include <libwpd-stream/libwpd-stream.h>
+
+// TODO: Drop this check when librevenge is widespread.
+#if WITH_LIBCDR01
+  #include <librevenge-stream/librevenge-stream.h>
+
+  using librevenge::RVNGString;
+  using librevenge::RVNGFileStream;
+  using librevenge::RVNGStringVector;
+#else
+  #include <libwpd-stream/libwpd-stream.h>
+
+  typedef WPXString               RVNGString;
+  typedef WPXFileStream           RVNGFileStream;
+  typedef libcdr::CDRStringVector RVNGStringVector;
+#endif
 
 #include <gtkmm/alignment.h>
 #include <gtkmm/comboboxtext.h>
@@ -60,7 +74,7 @@
 
 class CdrImportDialog : public Gtk::Dialog {
 public:
-     CdrImportDialog(const std::vector<WPXString> &vec);
+     CdrImportDialog(const std::vector<RVNGString> &vec);
      virtual ~CdrImportDialog();
 
      bool showDialog();
@@ -86,12 +100,12 @@
      class Gtk::VBox * vbox2;
      class Gtk::Widget * _previewArea;
 
-     const std::vector<WPXString> &_vec;   // Document to be imported
+     const std::vector<RVNGString> &_vec;   // Document to be imported
      unsigned _current_page;  // Current selected page
      int _preview_width, _preview_height;    // Size of the preview area
 };
 
-CdrImportDialog::CdrImportDialog(const std::vector<WPXString> &vec)
+CdrImportDialog::CdrImportDialog(const std::vector<RVNGString> &vec)
      : _vec(vec), _current_page(1)
 {
      int num_pages = _vec.size();
@@ -210,14 +224,20 @@
 
 SPDocument *CdrInput::open(Inkscape::Extension::Input * /*mod*/, const gchar * uri)
 {
-     WPXFileStream input(uri);
+     RVNGFileStream input(uri);
 
      if (!libcdr::CDRDocument::isSupported(&input)) {
           return NULL;
      }
 
-     libcdr::CDRStringVector output;
+     RVNGStringVector output;
+#if WITH_LIBCDR01
+     librevenge::RVNGSVGDrawingGenerator generator(output, "svg");
+
+     if (!libcdr::CDRDocument::parse(&input, &generator)) {
+#else
      if (!libcdr::CDRDocument::generateSVG(&input, output)) {
+#endif
           return NULL;
      }
 
@@ -225,9 +245,9 @@
           return NULL;
      }
 
-     std::vector<WPXString> tmpSVGOutput;
+     std::vector<RVNGString> tmpSVGOutput;
      for (unsigned i=0; i<output.size(); ++i) {
-          WPXString tmpString("<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n<!DOCTYPE svg PUBLIC \"-//W3C//DTD SVG 1.1//EN\" \"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd\">\n");
+          RVNGString tmpString("<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n<!DOCTYPE svg PUBLIC \"-//W3C//DTD SVG 1.1//EN\" \"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd\">\n");
           tmpString.append(output[i]);
           tmpSVGOutput.push_back(tmpString);
      }

=== modified file 'src/extension/internal/vsd-input.cpp'
--- src/extension/internal/vsd-input.cpp	2013-10-24 15:03:01 +0000
+++ src/extension/internal/vsd-input.cpp	2014-09-19 00:35:56 +0000
@@ -24,7 +24,22 @@
 #include <cstring>
 
 #include <libvisio/libvisio.h>
-#include <libwpd-stream/libwpd-stream.h>
+
+// TODO: Drop this check when librevenge is widespread.
+#if WITH_LIBVISIO01
+  #include <librevenge-stream/librevenge-stream.h>
+
+  using librevenge::RVNGString;
+  using librevenge::RVNGFileStream;
+  using librevenge::RVNGStringVector;
+#else
+  #include <libwpd-stream/libwpd-stream.h>
+
+  typedef WPXString                 RVNGString;
+  typedef WPXFileStream             RVNGFileStream;
+  typedef libvisio::VSDStringVector RVNGStringVector;
+#endif
+
 
 #include <gtkmm/alignment.h>
 #include <gtkmm/comboboxtext.h>
@@ -59,7 +74,7 @@
 
 class VsdImportDialog : public Gtk::Dialog {
 public:
-     VsdImportDialog(const std::vector<WPXString> &vec);
+     VsdImportDialog(const std::vector<RVNGString> &vec);
      virtual ~VsdImportDialog();
 
      bool showDialog();
@@ -85,12 +100,12 @@
      class Gtk::VBox * vbox2;
      class Gtk::Widget * _previewArea;
 
-     const std::vector<WPXString> &_vec;   // Document to be imported
+     const std::vector<RVNGString> &_vec;   // Document to be imported
      unsigned _current_page;  // Current selected page
      int _preview_width, _preview_height;    // Size of the preview area
 };
 
-VsdImportDialog::VsdImportDialog(const std::vector<WPXString> &vec)
+VsdImportDialog::VsdImportDialog(const std::vector<RVNGString> &vec)
      : _vec(vec), _current_page(1)
 {
      int num_pages = _vec.size();
@@ -209,14 +224,20 @@
 
 SPDocument *VsdInput::open(Inkscape::Extension::Input * /*mod*/, const gchar * uri)
 {
-     WPXFileStream input(uri);
+     RVNGFileStream input(uri);
 
      if (!libvisio::VisioDocument::isSupported(&input)) {
           return NULL;
      }
 
-     libvisio::VSDStringVector output;
+     RVNGStringVector output;
+#if WITH_LIBVISIO01
+     librevenge::RVNGSVGDrawingGenerator generator(output, "svg");
+
+     if (!libvisio::VisioDocument::parse(&input, &generator)) {
+#else
      if (!libvisio::VisioDocument::generateSVG(&input, output)) {
+#endif
           return NULL;
      }
 
@@ -224,9 +245,9 @@
           return NULL;
      }
 
-     std::vector<WPXString> tmpSVGOutput;
+     std::vector<RVNGString> tmpSVGOutput;
      for (unsigned i=0; i<output.size(); ++i) {
-          WPXString tmpString("<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n<!DOCTYPE svg PUBLIC \"-//W3C//DTD SVG 1.1//EN\" \"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd\">\n");
+          RVNGString tmpString("<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n<!DOCTYPE svg PUBLIC \"-//W3C//DTD SVG 1.1//EN\" \"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd\">\n");
           tmpString.append(output[i]);
           tmpSVGOutput.push_back(tmpString);
      }

=== modified file 'src/extension/internal/wpg-input.cpp'
--- src/extension/internal/wpg-input.cpp	2014-03-27 01:33:44 +0000
+++ src/extension/internal/wpg-input.cpp	2014-09-19 00:35:56 +0000
@@ -52,16 +52,24 @@
 #include "util/units.h"
 #include <cstring>
 
-// Take a guess and fallback to 0.1.x if no configure has run
-#if !defined(WITH_LIBWPG01) && !defined(WITH_LIBWPG02)
-#define WITH_LIBWPG01 1
+// Take a guess and fallback to 0.2.x if no configure has run
+#if !defined(WITH_LIBWPG03) && !defined(WITH_LIBWPG02)
+#define WITH_LIBWPG02 1
 #endif
 
 #include "libwpg/libwpg.h"
-#if WITH_LIBWPG01
-#include "libwpg/WPGStreamImplementation.h"
-#elif WITH_LIBWPG02
-#include "libwpd-stream/libwpd-stream.h"
+#if WITH_LIBWPG03
+  #include <librevenge-stream/librevenge-stream.h>
+
+  using librevenge::RVNGString;
+  using librevenge::RVNGFileStream;
+  using librevenge::RVNGInputStream;
+#else
+  #include "libwpd-stream/libwpd-stream.h"
+
+  typedef WPXString               RVNGString;
+  typedef WPXFileStream           RVNGFileStream;
+  typedef WPXInputStream          RVNGInputStream;
 #endif
 
 using namespace libwpg;
@@ -73,17 +81,15 @@
 
 SPDocument *WpgInput::open(Inkscape::Extension::Input * /*mod*/, const gchar * uri)
 {
-#if WITH_LIBWPG01
-    WPXInputStream* input = new libwpg::WPGFileStream(uri);
-#elif WITH_LIBWPG02
-    WPXInputStream* input = new WPXFileStream(uri);
-#endif
+    RVNGInputStream* input = new RVNGFileStream(uri);
+#if WITH_LIBWPG03
+    if (input->isStructured()) {
+        RVNGInputStream* olestream = input->getSubStreamByName("PerfectOffice_MAIN");
+#else
     if (input->isOLEStream()) {
-#if WITH_LIBWPG01
-        WPXInputStream* olestream = input->getDocumentOLEStream();
-#elif WITH_LIBWPG02
-        WPXInputStream* olestream = input->getDocumentOLEStream("PerfectOffice_MAIN");
+        RVNGInputStream* olestream = input->getDocumentOLEStream("PerfectOffice_MAIN");
 #endif
+
         if (olestream) {
             delete input;
             input = olestream;
@@ -98,15 +104,24 @@
         return NULL;
     }
 
-#if WITH_LIBWPG01
-    libwpg::WPGString output;
-#elif WITH_LIBWPG02
-    WPXString output;
-#endif
+#if WITH_LIBWPG03
+    librevenge::RVNGStringVector vec;
+    librevenge::RVNGSVGDrawingGenerator generator(vec, "");
+
+    if (!libwpg::WPGraphics::parse(input, &generator) || vec.empty() || vec[0].empty()) {
+        delete input;
+        return NULL;
+    }
+
+    RVNGString output("<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n<!DOCTYPE svg PUBLIC \"-//W3C//DTD SVG 1.1//EN\" \"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd\">\n");
+    output.append(vec[0]);
+#else
+    RVNGString output;
     if (!libwpg::WPGraphics::generateSVG(input, output)) {
         delete input;
         return NULL;
     }
+#endif
 
     //printf("I've got a doc: \n%s", painter.document.c_str());
 

=== modified file 'src/ui/dialog/symbols.cpp'
--- src/ui/dialog/symbols.cpp	2014-06-13 16:06:01 +0000
+++ src/ui/dialog/symbols.cpp	2014-09-19 00:35:56 +0000
@@ -62,8 +62,20 @@
 #include "widgets/icon.h"
 
 #ifdef WITH_LIBVISIO
-#include <libvisio/libvisio.h>
-#include <libwpd-stream/libwpd-stream.h>
+  #include <libvisio/libvisio.h>
+
+  // TODO: Drop this check when librevenge is widespread.
+  #if WITH_LIBVISIO01
+    #include <librevenge-stream/librevenge-stream.h>
+
+    using librevenge::RVNGFileStream;
+    using librevenge::RVNGStringVector;
+  #else
+    #include <libwpd-stream/libwpd-stream.h>
+
+    typedef WPXFileStream             RVNGFileStream;
+    typedef libvisio::VSDStringVector RVNGStringVector;
+  #endif
 #endif
 
 #include "verbs.h"
@@ -495,14 +507,20 @@
 // Read Visio stencil files
 SPDocument* read_vss( gchar* fullname, gchar* filename ) {
 
-  WPXFileStream input(fullname);
+  RVNGFileStream input(fullname);
 
   if (!libvisio::VisioDocument::isSupported(&input)) {
     return NULL;
   }
 
-  libvisio::VSDStringVector output;
+  RVNGStringVector output;
+#if WITH_LIBVISIO01
+  librevenge::RVNGSVGDrawingGenerator generator(output, "svg");
+
+  if (!libvisio::VisioDocument::parseStencils(&input, &generator)) {
+#else
   if (!libvisio::VisioDocument::generateSVGStencils(&input, output)) {
+#endif
     return NULL;
   }