Changeset 60

Timestamp:

04/14/06 12:08:30 (2 years ago)

Author:

jordi

Message:

The document's outlines are now loaded correctly, although I don't like the way is set up now...

Location:

trunk

Files:

• src/DocumentOutline.cxx (modified) (6 diffs)
• src/DocumentOutline.h (modified) (2 diffs)
• src/IDocument.cxx (modified) (1 diff)
• src/PDFDocument.cxx (modified) (1 diff)
• tests/DocumentOutlineTest.cxx (modified) (3 diffs)
• tests/DocumentOutlineTest.h (modified) (2 diffs)

trunk/src/DocumentOutline.cxx

@@ -17 +17 @@
 
 #include <config.h>
+
+// Poppler headers
+#include <goo/GooList.h>
+#include <Outline.h>
+#include <PDFDoc.h>
+#include <Link.h>
+
 #include "epdfview.h"
 
 using namespace ePDFView;
 
+/// Forward declarations.
+static void deleteChild (gpointer child, gpointer userData);
+
 ///
 /// @brief Constructs a new DocumentOutline.
 ///
-DocumentOutline::DocumentOutline ()
-{
+DocumentOutline::DocumentOutline (PDFDoc *document)
+{
+    m_Destination = 1;
+    m_Document = document;
+    m_Children = NULL;
+    m_LastReturnedChild = NULL;
+    m_Parent = NULL;
+    m_Title = NULL;
 }
 
@@ -33 +49 @@
 DocumentOutline::~DocumentOutline ()
 {
+    m_Document = NULL;
+    m_Parent = NULL;
+    g_free (m_Title);
+    /// Delete the children.
+    g_list_foreach (m_Children, deleteChild, NULL);
+    g_list_free (m_Children);
 }
 
@@ -50 +72 @@
 DocumentOutline::getDestinationPage ()
 {
-    return 1;
+    return m_Destination;
 }
 
@@ -62 +84 @@
 DocumentOutline::getFirstChild ()
 {
+    m_LastReturnedChild = g_list_first (m_Children);
+    if ( NULL != m_LastReturnedChild )
+    {
+        return (DocumentOutline *)m_LastReturnedChild->data;
+    }
+    return NULL;
+}
+
+///
+/// @brief Gets the next outline's child.
+///
+/// @returns The next child after the one returned by the last call to 
+///          getFirstChild() or getNextChild().
+///          If no child has been returned yet (i.e., getFirstChild() hasn't
+///          been called yet) or there's no next child returns NULL.
+///
+DocumentOutline *
+DocumentOutline::getNextChild ()
+{
+    m_LastReturnedChild = g_list_next (m_LastReturnedChild);
+    if ( NULL != m_LastReturnedChild )
+    {
+        return (DocumentOutline *)m_LastReturnedChild->data;
+    }
     return NULL;
 }
@@ -73 +119 @@
 DocumentOutline::getNumChildren ()
 {
-    return 0;
+    return g_list_length (m_Children);
 }
 
@@ -85 +131 @@
 DocumentOutline::getTitle ()
 {
-    return "";
-}
+    if ( NULL == m_Title )
+    {
+        return "";
+    }
+    return m_Title;
+}
+
+void
+DocumentOutline::setDestination (gint destination)
+{
+    m_Destination = destination;
+}
+
+void
+DocumentOutline::setChildren (GooList *childrenList)
+{
+    if ( NULL != childrenList )
+    {
+        int numChildren = childrenList->getLength ();
+        for ( int childIndex = 0; childIndex < numChildren; childIndex++)
+        {
+            OutlineItem *item = (OutlineItem *)childrenList->get (childIndex);
+            // Get the title.
+            gchar *title = g_ucs4_to_utf8 (item->getTitle (), 
+                                           item->getTitleLength (),
+                                           NULL, NULL, NULL);            
+            // The page destination.
+            gint destination = 1;
+            LinkAction *action = item->getAction ();
+            if ( NULL != action )
+            {
+                if ( action->isOk () && actionGoTo == action->getKind () )
+                {
+                    LinkDest *dest = ((LinkGoTo *)action)->getDest ();
+                    if ( dest->isOk () && dest->isPageRef () )
+                    {
+                        Ref ref = dest->getPageRef ();
+                        destination = m_Document->findPage (ref.num, ref.gen);
+                    }
+                    else if ( dest->isOk () )
+                    {
+                        destination = dest->getPageNum ();
+                    }
+                }
+            }
+            // Create the child.
+            DocumentOutline *child = new DocumentOutline (m_Document);
+            child->setParent (this);
+            child->setTitle (title);
+            g_free (title);
+            child->setDestination (destination);
+            // Add to the list of children.
+            m_Children = g_list_append (m_Children, child);
+            // And add its own children.
+            if ( item->hasKids () )
+            {
+                // I need to open the outline because if it's not 
+                // open then the getKids() function returns NULL.
+                item->open ();
+                child->setChildren (item->getKids ());
+            }
+        }
+    }
+}
+
+///
+/// @brief Sets the outline.
+///
+/// This is only called for the root outline element when loading a document.
+/// Fills in the list of outline items from the document.
+///
+/// @param outline The outline from the documents.
+///
+void
+DocumentOutline::setOutline (Outline *outline)
+{
+    g_assert (NULL != outline && "Tried to set a NULL outline.");
+    
+    setTitle ("");
+    setDestination (1);
+        
+    setChildren (outline->getItems ());
+}
+
+void
+DocumentOutline::setParent (DocumentOutline *parent)
+{
+    m_Parent = parent;
+}
+
+void
+DocumentOutline::setTitle (const char *title)
+{
+    g_assert (NULL != title && "Tried to set a NULL title.");
+
+    g_free (m_Title);
+    m_Title = g_strdup (title);
+}
+
+void
+deleteChild (gpointer child, gpointer userData)
+{
+    g_assert ( NULL != child && "An outline's child is NULL!");
+    
+    DocumentOutline *outline = (DocumentOutline *)child;
+    delete outline;
+}

trunk/src/DocumentOutline.h

@@ -19 +19 @@
 #define __DOCUMENT_OUTLINE_H__
 
+// Forward declarations.
+class PDFDoc;
+class Outline;
+class GooList;
+
 namespace ePDFView
 {
@@ -37 +42 @@
     {
         public:
-            DocumentOutline (void);
+            DocumentOutline (PDFDoc *document);
             ~DocumentOutline (void);
 
             gint getDestinationPage (void);
             DocumentOutline *getFirstChild (void);
+            DocumentOutline *getNextChild (void);
             gint getNumChildren (void);
             const gchar *getTitle (void);
+            void setOutline (Outline *outline);
+
+        private:
+            GList *m_Children;
+            gint m_Destination;
+            PDFDoc *m_Document;
+            GList *m_LastReturnedChild;
+            DocumentOutline *m_Parent;
+            gchar *m_Title;
+
+            void setChildren (GooList *childrenList);
+            void setParent (DocumentOutline *parent);
+            void setTitle (const gchar *title);
+            void setDestination (gint destination);
     };
 }

trunk/src/IDocument.cxx

@@ -127 +127 @@
     m_Creator = NULL;
     m_CurrentPage = 0;
-    m_Outline = new DocumentOutline ();
+    m_Outline = NULL;
     m_FileName = NULL;
     m_Format = NULL;

trunk/src/PDFDocument.cxx

@@ -124 +124 @@
     delete m_Document;
     m_Document = newDocument;
+    // Load the document's information and outline.
     loadMetadata ();
+    m_Outline = new DocumentOutline (m_Document);
+    m_Outline->setOutline (m_Document->getOutline ());
     // Set the output device.
     delete m_OutputDevice;

trunk/tests/DocumentOutlineTest.cxx

@@ -51 +51 @@
 {
     CPPUNIT_ASSERT ( !m_Document->isLoaded ());
-    DocumentOutline *outline = m_Document->getOutline ();
-    // The initial state of the outline is no outline at all.
-    CPPUNIT_ASSERT_EQUAL (0, outline->getNumChildren ());
-    CPPUNIT_ASSERT (0 == g_ascii_strcasecmp ("", outline->getTitle ()));
-    CPPUNIT_ASSERT_EQUAL (1, outline->getDestinationPage ());
-    CPPUNIT_ASSERT (NULL == outline->getFirstChild ());
+    CPPUNIT_ASSERT ( NULL == m_Document->getOutline ());
 }
 
@@ -63 +58 @@
 ///
 /// When a loaded document doesn't have an outline, the DocumentOutline's
-/// behaviour is exactly the same as the initial status.
+/// is empty.
 ///
 void
@@ -72 +67 @@
     CPPUNIT_ASSERT (m_Document->isLoaded ());
     DocumentOutline *outline = m_Document->getOutline ();
+    CPPUNIT_ASSERT ( NULL != outline );
     CPPUNIT_ASSERT_EQUAL (0, outline->getNumChildren ());
     CPPUNIT_ASSERT (0 == g_ascii_strcasecmp ("", outline->getTitle ()));
     CPPUNIT_ASSERT_EQUAL (1, outline->getDestinationPage ());
     CPPUNIT_ASSERT (NULL == outline->getFirstChild ());
+    CPPUNIT_ASSERT (NULL == outline->getNextChild ());
 }
+
+///
+/// @brief Test a file that has outline.
+///
+/// The document I've gone test has the following outline:
+///
+///  *
+///  |
+///  +- Test PDF 1 / page 3
+///  |
+///  +- Table of Contents / page 4
+///  |
+///  +- Chapter 1. First Chapter / page 5
+///     |
+///     + First Section / page 5
+///
+void
+DocumentOutlineTest::hasOutline ()
+{
+    CPPUNIT_ASSERT (m_Document->loadFile (TEST_DATA_DIR "test1.pdf",
+                                          NULL, NULL));
+    CPPUNIT_ASSERT (m_Document->isLoaded ());
+    DocumentOutline *outline = m_Document->getOutline ();
+    CPPUNIT_ASSERT ( NULL != outline );
+    // The root outline must be the same empy one, except it has children.
+    CPPUNIT_ASSERT_EQUAL (3, outline->getNumChildren ());
+    CPPUNIT_ASSERT (0 == g_ascii_strcasecmp ("", outline->getTitle ()));
+    CPPUNIT_ASSERT_EQUAL (1, outline->getDestinationPage ());
+
+    {
+        DocumentOutline *child = outline->getFirstChild();
+        CPPUNIT_ASSERT ( NULL != child );
+        CPPUNIT_ASSERT_EQUAL (0, child->getNumChildren ());
+        CPPUNIT_ASSERT_EQUAL (0, g_ascii_strcasecmp ("Test PDF 1", 
+                                                     child->getTitle ()));
+        CPPUNIT_ASSERT_EQUAL (3, child->getDestinationPage ());
+    }
+    
+    {
+        DocumentOutline *child = outline->getNextChild();
+        CPPUNIT_ASSERT ( NULL != child );
+        CPPUNIT_ASSERT_EQUAL (0, child->getNumChildren ());
+        CPPUNIT_ASSERT_EQUAL (0, g_ascii_strcasecmp ("Table of Contents", 
+                                                     child->getTitle ()));
+        CPPUNIT_ASSERT_EQUAL (4, child->getDestinationPage ());
+    }
+
+    {
+        DocumentOutline *child = outline->getNextChild();
+        CPPUNIT_ASSERT ( NULL != child );
+        CPPUNIT_ASSERT_EQUAL (1, child->getNumChildren ());
+        CPPUNIT_ASSERT_EQUAL (0,
+                              g_ascii_strcasecmp ("Chapter 1. First Chapter",
+                                                  child->getTitle ()));
+        CPPUNIT_ASSERT_EQUAL (5, child->getDestinationPage ());
+
+        DocumentOutline *greatChild = child->getFirstChild ();
+        CPPUNIT_ASSERT ( NULL != greatChild );
+        CPPUNIT_ASSERT_EQUAL (0, greatChild->getNumChildren ());
+        CPPUNIT_ASSERT_EQUAL (0, g_ascii_strcasecmp ("First Section",
+                                                     greatChild->getTitle ()));
+        CPPUNIT_ASSERT_EQUAL (5, greatChild->getDestinationPage ());
+    }
+
+    // After the last child, it should return NULL.
+    CPPUNIT_ASSERT (NULL == outline->getNextChild ());
+
+    // Try again the "no outlined" file.
+    noOutline ();
+}

trunk/tests/DocumentOutlineTest.h

@@ -28 +28 @@
         CPPUNIT_TEST (initialStatus);
         CPPUNIT_TEST (noOutline);
+        CPPUNIT_TEST (hasOutline);
         CPPUNIT_TEST_SUITE_END ();
 
@@ -36 +37 @@
             void initialStatus (void);
             void noOutline (void);
+            void hasOutline (void);
 
         protected: