Changeset 61

Timestamp:

04/14/06 12:36:20 (3 years ago)

Author:

jordi

Message:

I've removed all Poppler stuff from the DocumentOutline? and put it into the PDFDocument, where it should be. Also the previously protected setters DocumentOutline? methods are set to public.

Added the missing documentation comments.

Location:

trunk/src

Files:

• DocumentOutline.cxx (modified) (8 diffs)
• DocumentOutline.h (modified) (3 diffs)
• PDFDocument.cxx (modified) (4 diffs)
• PDFDocument.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"
 
@@ -34 +27 @@
 /// @brief Constructs a new DocumentOutline.
 ///
-DocumentOutline::DocumentOutline (PDFDoc *document)
+DocumentOutline::DocumentOutline ()
 {
     m_Destination = 1;
-    m_Document = document;
     m_Children = NULL;
     m_LastReturnedChild = NULL;
@@ -49 +41 @@
 DocumentOutline::~DocumentOutline ()
 {
-    m_Document = NULL;
     m_Parent = NULL;
     g_free (m_Title);
@@ -58 +49 @@
 
 ///
-/// @brief Get the outline's destination page.
+/// @brief Adds a new outline's child.
+///
+/// @param child The new child to add.
+///
+void
+DocumentOutline::addChild (DocumentOutline *child)
+{
+    m_Children = g_list_append (m_Children, child);
+}
+
+///
+/// @brief Gets the outline's destination page.
 ///
 /// I'm only using the outlines as a way to go to an specific page, although
@@ -138 +140 @@
 }
 
+///
+/// @brief Sets the outline item's destination.
+///
+/// @see getDestination().
+///
+/// @param destination The page number, starting from 1, that
+///                    this outline links to.
+///
 void
 DocumentOutline::setDestination (gint destination)
@@ -144 +154 @@
 }
 
-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 ());
-}
-
+///
+/// @brief Sets the item's parent.
+///
+/// This is currently not used.
+///
+/// @param parent The outline item's parent.
+///
 void
 DocumentOutline::setParent (DocumentOutline *parent)
@@ -221 +167 @@
 }
 
+///
+/// @brief Sets the outline item's title.
+///
+/// @param title The title to set to the outline.
+///
 void
 DocumentOutline::setTitle (const char *title)
@@ -230 +181 @@
 }
 
+///
+/// @brief Deletes an outline item's child.
+///
+/// This function is called by the destructor to delete all childs in
+/// the m_Children list.
+///
+/// @param child The data element in the list's item.
+/// @param userData The data passed to the g_list_foreach() function.
+///                 Currently unused.
+///
 void
 deleteChild (gpointer child, gpointer userData)

trunk/src/DocumentOutline.h

@@ -19 +19 @@
 #define __DOCUMENT_OUTLINE_H__
 
-// Forward declarations.
-class PDFDoc;
-class Outline;
-class GooList;
-
 namespace ePDFView
 {
@@ -42 +37 @@
     {
         public:
-            DocumentOutline (PDFDoc *document);
+            DocumentOutline (void);
             ~DocumentOutline (void);
 
+            void addChild (DocumentOutline *child);
             gint getDestinationPage (void);
             DocumentOutline *getFirstChild (void);
@@ -50 +46 @@
             gint getNumChildren (void);
             const gchar *getTitle (void);
-            void setOutline (Outline *outline);
+            void setParent (DocumentOutline *parent);
+            void setTitle (const gchar *title);
+            void setDestination (gint destination);
 
         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/PDFDocument.cxx

@@ -19 +19 @@
 
 // Poppler headers.
+#include <goo/GooList.h>
 #include <PDFDoc.h>
 #include <CairoOutputDev.h>
@@ -24 +25 @@
 #include <GlobalParams.h>
 #include <PDFDocEncoding.h>
+#include <Outline.h>
+#include <Link.h>
 
 #include "epdfview.h"
@@ -126 +129 @@
     // Load the document's information and outline.
     loadMetadata ();
-    m_Outline = new DocumentOutline (m_Document);
-    m_Outline->setOutline (m_Document->getOutline ());
+    Outline *outline = m_Document->getOutline ();
+    m_Outline = new DocumentOutline ();
+    setOutline (m_Outline, outline->getItems ());
+    // Set the current rotation angle and zoom level.
+    m_Rotation = 0;
+    m_Scale = 1.0f;
     // Set the output device.
     delete m_OutputDevice;
@@ -203 +210 @@
     setNumPages (m_Document->getNumPages ());
     goToFirstPage ();
-
-    // Set the current rotation angle and zoom level.
-    m_Rotation = 0;
-    m_Scale = 1.0f;
+}
+
+///
+/// @brief Sets the document's outline.
+///
+/// This is a recursive function that adds child outlines
+/// from the PDF's outline to the passed @a outline.
+///
+/// @param outline The outline to set the nodes to. The first
+///                call must be set to the root DocumentOutline.
+/// @param childrenList The list of children for to set to @outline.
+///                     The first line must be a call to the getItems()
+///                     function from the PDF's outline.
+///
+void
+PDFDocument::setOutline (DocumentOutline *outline, 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, create the new child outline and set the
+            // title to it.
+            gchar *title = g_ucs4_to_utf8 (item->getTitle (),
+                                           item->getTitleLength (), 
+                                           NULL, NULL, NULL);
+            DocumentOutline *child = new DocumentOutline ();
+            child->setParent (outline);
+            child->setTitle (title);
+            g_free (title);
+            /// Get the page destination.
+            gint destination = 1;
+            LinkAction *action = item->getAction ();
+            if ( NULL != action && action->isOk () && 
+                 actionGoTo == action->getKind () ) 
+            {
+                LinkDest *linkDestination = ((LinkGoTo *)action)->getDest ();
+                if ( linkDestination->isOk () )
+                {
+                    if ( linkDestination->isPageRef () )
+                    {
+                        Ref pageReference = linkDestination->getPageRef ();
+                        destination = m_Document->findPage (pageReference.num,
+                                                            pageReference.gen);
+                    }
+                    else
+                    {
+                        destination = linkDestination->getPageNum ();
+                    }
+                } // if ( linkDestination->isOk () )
+            } // if ( NULL != action ... )
+            child->setDestination (destination);
+            outline->addChild (child);
+            // Add the child's children, if any.
+            if ( item->hasKids () )
+            {
+                // I need to open the outline because if it's not
+                // open then the getKids() function would return NULL.
+                item->open ();
+                setOutline (child, item->getKids ());
+            }
+        } // for ( int childIndex = 0 ; ... )       
+    } // if ( NULL != childrenList )
 }
 

trunk/src/PDFDocument.h

@@ -21 +21 @@
 
 /// Forward declarations.
+class GooList;
 class PDFDoc;
 class CairoOutputDev;
@@ -49 +50 @@
 
             void loadMetadata (void);
+            void setOutline (DocumentOutline *outline, GooList *childrenList);
     };
 }