Changeset 58

Timestamp:

04/14/06 10:13:02 (2 years ago)

Author:

jordi

Message:

I've changed the old DocumentIndex? class name to DocumentOutline?, following a little closer the PDF specifications.

Created a new test fixture for the DocumentOutline?, removing this part from the PDFDocument test fixture.

I also removed the Poppler headers from the epdfview.h header, so I don't need to specify the POPPLER_CFLAGS on the test directory.

Location:

trunk

Files:

• src/DocumentOutline.cxx (moved) (moved from trunk/src/DocumentIndex.cxx) (1 diff)
• src/DocumentOutline.h (moved) (moved from trunk/src/DocumentIndex.h) (2 diffs)
• src/DocumentPage.cxx (modified) (1 diff)
• src/IDocument.cxx (modified) (3 diffs)
• src/IDocument.h (modified) (2 diffs)
• src/MainPter.cxx (modified) (1 diff)
• src/Makefile.am (modified) (1 diff)
• src/PDFDocument.cxx (modified) (1 diff)
• src/PDFDocument.h (modified) (1 diff)
• src/epdfview.h (modified) (1 diff)
• tests/DocumentOutlineTest.cxx (added)
• tests/DocumentOutlineTest.h (added)
• tests/MainPterTest.cxx (modified) (1 diff)
• tests/Makefile.am (modified) (2 diffs)
• tests/PDFDocumentTest.cxx (modified) (1 diff)

trunk/src/DocumentOutline.cxx

@@ -22 +22 @@
 
 ///
-/// @brief Constructs a new DocumentIndex.
+/// @brief Constructs a new DocumentOutline.
 ///
-DocumentIndex::DocumentIndex ()
+DocumentOutline::DocumentOutline ()
 {
 }
 
 ///
-/// @brief Destroys any dynamically created object of DocumentIndex;
+/// @brief Destroys any dynamically allocated memory for DocumentOutline.
 ///
-DocumentIndex::~DocumentIndex ()
+DocumentOutline::~DocumentOutline ()
 {
 }
 
 ///
-/// @brief Get the number of children for this index.
+/// @brief Get the outline's destination page.
 ///
-/// @return The number of children this index has.
+/// I'm only using the outlines as a way to go to an specific page, although
+/// the PDF Specification says that an outline could open a page from another
+/// file, execute an application, etc... I won't use all those features and
+/// concentrate only on the pages.
+///
+/// @return The destination page number for the outline number or 1 if the
+///         outline item has no page number (like the root outline item or
+///         other kinds of destinations).
 ///
 gint
-DocumentIndex::getNumChildren ()
+DocumentOutline::getDestinationPage ()
+{
+    return 1;
+}
+
+///
+/// @brief The first children of the outline item.
+///
+/// @return The pointer to the first children of the outline item, or
+///         NULL if the outline has no children.
+///
+DocumentOutline *
+DocumentOutline::getFirstChild ()
+{
+    return NULL;
+}
+
+///
+/// @brief Gets the number of children for this outline.
+///
+/// @return The number of children this utline has.
+///
+gint
+DocumentOutline::getNumChildren ()
 {
     return 0;
 }
+
+///
+/// @brief Gets the outline's title.
+///
+/// @return The title of the outline item or an empty string if the
+///         outline item has no title (like the root outline item).
+///
+const gchar *
+DocumentOutline::getTitle ()
+{
+    return "";
+}

trunk/src/DocumentOutline.h

@@ -16 +16 @@
 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
-#if !defined (__DOCUMENT_INDEX_H__)
-#define __DOCUMENT_INDEX_H__
+#if !defined (__DOCUMENT_OUTLINE_H__)
+#define __DOCUMENT_OUTLINE_H__
 
 namespace ePDFView
 {
     ///
-    /// @class DocumentIndex
-    /// @brief Stores the document's index name, action and its children.
+    /// @class DocumentOutline
+    /// @brief Stores the document's outline title, page num. and its children.
     ///
     /// Some documents have an index with them. This index can be used to
@@ -29 +29 @@
     /// contents.
     ///
-    /// Each node contains a name, an action an possibly children nodes. The
-    /// only node that have an empty name and no action is the top level 
-    /// DocumentIndex, that is only used as a container for all other
-    /// DocumentIndex objects.
+    /// Each node contains a title, a destination page an possibly children
+    /// nodes. The only node that have an empty name and a 0 page number is the
+    /// top level DocumentOutline, that is only used as a container for all 
+    /// other DocumentOutline objects.
     ///
-    class DocumentIndex
+    class DocumentOutline
     {
         public:
-            DocumentIndex (void);
-            ~DocumentIndex (void);
+            DocumentOutline (void);
+            ~DocumentOutline (void);
 
+            gint getDestinationPage (void);
+            DocumentOutline *getFirstChild (void);
             gint getNumChildren (void);
+            const gchar *getTitle (void);
     };
 }
 
-#endif // !__DOCUMENT_INDEX_H__
+#endif // !__DOCUMENT_OUTLINE_H__

trunk/src/DocumentPage.cxx

@@ -17 +17 @@
 
 #include <config.h>
+#include <string.h>
 #include "epdfview.h"
 

trunk/src/IDocument.cxx

@@ -127 +127 @@
     m_Creator = NULL;
     m_CurrentPage = 0;
-    m_DocumentIndex = new DocumentIndex ();
+    m_Outline = new DocumentOutline ();
     m_FileName = NULL;
     m_Format = NULL;
@@ -148 +148 @@
 IDocument::~IDocument ()
 {
-    delete m_DocumentIndex;
+    delete m_Outline;
     g_free (m_Author);
     g_free (m_CreationDate);
@@ -557 +557 @@
 
 ///
-/// @brief Get the document's index.
-///
-/// @return The top level DocumentIndex for this document.
-///
-DocumentIndex &
-IDocument::getDocumentIndex ()
-{
-    g_assert (NULL != m_DocumentIndex && "The document index is NULL.");
-    
-    return *(m_DocumentIndex);
+/// @brief Get the document's outline.
+///
+/// @return The top level DocumentOutline for this document.
+///         The returned object must not be freed, the 
+///         IDocument class will do it.
+///
+DocumentOutline *
+IDocument::getOutline ()
+{
+    return m_Outline;
 }
 

trunk/src/IDocument.h

@@ -199 +199 @@
             void setNumPages (gint numPages);
             gint getCurrentPageNum (void);
-            DocumentIndex &getDocumentIndex (void);
+            DocumentOutline *getOutline (void);
 
             void goToFirstPage (void);
@@ -231 +231 @@
             gchar *m_Creator;
             gint m_CurrentPage;
-            DocumentIndex *m_DocumentIndex;
+            DocumentOutline *m_Outline;
             gchar *m_Format;
             gchar *m_FileName;

trunk/src/MainPter.cxx

@@ -17 +17 @@
 
 #include <config.h>
+#include <stdlib.h>
 #include "epdfview.h"
 

trunk/src/Makefile.am

@@ -5 +5 @@
 
 libepdfview_a_SOURCES = \
-    DocumentIndex.cxx   \
-    DocumentIndex.h     \
+    DocumentOutline.cxx \
+    DocumentOutline.h   \
     DocumentPage.h      \
     DocumentPage.cxx    \

trunk/src/PDFDocument.cxx

@@ -19 +19 @@
 
 // Poppler headers.
+#include <PDFDoc.h>
+#include <CairoOutputDev.h>
 #include <ErrorCodes.h>
 #include <GlobalParams.h>

trunk/src/PDFDocument.h

@@ -18 +18 @@
 #if !defined (__PDF_DOCUMENT_H__)
 #define __PDF_DOCUMENT_H__
+
+
+/// Forward declarations.
+class PDFDoc;
+class CairoOutputDev;
 
 namespace ePDFView 

trunk/src/epdfview.h

@@ -22 +22 @@
 #include <glib.h>
 
-// Poppler headers.
-#include <PDFDoc.h>
-#include <CairoOutputDev.h>
-
-#include <DocumentIndex.h>
+#include <DocumentOutline.h>
 #include <DocumentPage.h>
 #include <IDocument.h>

trunk/tests/MainPterTest.cxx

@@ -16 +16 @@
 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
-#include <glib.h>
-#include <IDocument.h>
-#include <IMainView.h>
-#include <MainPter.h>
+#include <epdfview.h>
 #include "DumbDocument.h"
 #include "DumbMainView.h"

trunk/tests/Makefile.am

@@ -8 +8 @@
 
 test_epdfview_SOURCES =     \
+    DocumentOutlineTest.cxx \
+    DocumentOutlineTest.h   \
     DumbDocument.cxx        \
     DumbDocument.h          \
@@ -22 +24 @@
     -I$(top_srcdir)/src                         \
     $(GLIB_CFLAGS)                              \
-    $(POPPLER_CFLAGS)                           \
     $(CPPUNIT_CFLAGS)
 

trunk/tests/PDFDocumentTest.cxx

@@ -79 +79 @@
     CPPUNIT_ASSERT_EQUAL (0, m_Document->getNumPages ());
     CPPUNIT_ASSERT_EQUAL (0, m_Document->getCurrentPageNum ());
-
-    DocumentIndex &index = m_Document->getDocumentIndex ();
-    CPPUNIT_ASSERT_EQUAL (0, index.getNumChildren ());
 }