Changeset 147

Timestamp:

05/05/06 11:42:43 (2 years ago)

Author:

jordi

Message:

Added the new DocumentLink? class that holds a link's rectangle (position) and the destination page. The page rendered now also gets all the links from the PDF document and adds it to the DocumentPage? class, which can be queried about the link at a given position.

The page view changes the cursor when the pointer is over a link and also when it's dragging the page.

Location:

trunk

Files:

• src/DocumentLink.cxx (added)
• src/DocumentLink.h (added)
• src/DocumentPage.cxx (modified) (3 diffs)
• src/DocumentPage.h (modified) (2 diffs)
• src/IDocument.cxx (modified) (1 diff)
• src/IDocument.h (modified) (1 diff)
• src/IPageView.h (modified) (3 diffs)
• src/MainPter.cxx (modified) (1 diff)
• src/MainPter.h (modified) (1 diff)
• src/Makefile.am (modified) (1 diff)
• src/PDFDocument.cxx (modified) (3 diffs)
• src/PDFDocument.h (modified) (2 diffs)
• src/PagePter.cxx (modified) (3 diffs)
• src/epdfview.h (modified) (1 diff)
• src/gtk/PageView.cxx (modified) (2 diffs)
• src/gtk/PageView.h (modified) (1 diff)
• tests/DumbPageView.cxx (modified) (1 diff)
• tests/DumbPageView.h (modified) (1 diff)
• tests/PDFDocumentTest.cxx (modified) (1 diff)
• tests/PDFDocumentTest.h (modified) (2 diffs)

trunk/src/DocumentPage.cxx

@@ -31 +31 @@
     m_Data = NULL;
     m_Height = 0;
+    m_LinkList = NULL;
     m_Width = 0;
 }
@@ -40 +41 @@
 {
     delete[] m_Data;
+    for ( GList *linkItem = g_list_first (m_LinkList) ;
+          NULL != linkItem ;
+          linkItem = g_list_next (linkItem) )
+    {
+        DocumentLink *link = (DocumentLink *)linkItem->data;
+        delete link;
+    }
+    g_list_free (m_LinkList);
+}
+
+void
+DocumentPage::addLink (DocumentLink *link)
+{
+    m_LinkList = g_list_prepend (m_LinkList, link);
 }
 
@@ -58 +73 @@
 
     return m_Data;
+}
+
+DocumentLink *
+DocumentPage::getLinkAtPosition (gint x, gint y)
+{
+    DocumentLink *link = NULL;
+
+    for ( GList *linkItem = g_list_first (m_LinkList) ;
+          NULL != linkItem && NULL == link;
+          linkItem = g_list_next (linkItem) )
+    {
+        DocumentLink *tmpLink = (DocumentLink *)linkItem->data;
+        if ( tmpLink->positionIsOver (x, y) )
+        {
+            link = tmpLink;
+        }
+    }
+    
+    return link;
 }
 

trunk/src/DocumentPage.h

@@ -32 +32 @@
             DocumentPage (void);
             ~DocumentPage (void);
-            
+           
+            void addLink (DocumentLink *link);
             guchar *getData (void);
             gint getHeight (void);
+            DocumentLink *getLinkAtPosition (gint x, gint y);
             gint getRowStride (void);
             gint getWidth (void);
@@ -43 +45 @@
             gint m_Height;
             gint m_Width;
+            GList *m_LinkList;
     };
 }

trunk/src/IDocument.cxx

@@ -1227 +1227 @@
 }
 
+gboolean
+IDocument::hasLinkAtPosition (gint x, gint y)
+{
+    // XXX For now only non rotated pages.
+    if ( 0 == getRotation () )
+    {
+        DocumentPage *page = getCurrentPage ();
+        if ( NULL != page )
+        {
+            return (NULL != page->getLinkAtPosition (x, y));
+        }
+    }
+    return FALSE;
+}
+
+void
+IDocument::activateLinkAtPosition (gint x, gint y)
+{
+    DocumentPage *page = getCurrentPage ();
+    // XXX For now only non rotated pages.
+    if ( NULL != page && 0 == getRotation () )
+    {
+        DocumentLink *link = page->getLinkAtPosition (x, y);
+        if ( NULL != link )
+        {
+            goToPage (link->getDestinationPage ());
+        }
+    }    
+}

trunk/src/IDocument.h

@@ -256 +256 @@
             void zoomToWidth (gint width);
 
+            gboolean hasLinkAtPosition (gint x, gint y);
+            void activateLinkAtPosition (gint x, gint y);
+
             static GQuark getErrorQuark (void);
             static gchar *getErrorMessage (DocumentError errorCode);

trunk/src/IPageView.h

@@ -23 +23 @@
     // Forward declarations.
     class PagePter;
+
+    enum PageCursor
+    {
+        /// Normal cursor.
+        PAGE_VIEW_CURSOR_NORMAL,
+        /// Drag cursor.
+        PAGE_VIEW_CURSOR_DRAG,
+        /// Link cursor.
+        PAGE_VIEW_CURSOR_LINK
+    };
     
     ///
@@ -84 +94 @@
             virtual void scrollPage (gdouble scrollX, gdouble scrollY,
                                      gint dx, gint dy) = 0;
-
+            
+            ///
+            /// @brief Sets the cursor for the page view.
+            ///
+            /// The view must change the cursor for the page image.
+            /// If the cursor to be set is the same as the current cursor,
+            /// the view can ignore the petition.
+            ///
+            /// @param cursorType The cursor to set.
+            ///
+            virtual void setCursor (PageCursor cursorType) = 0;
+            
             ///
             /// @brief Shows a document's page.
@@ -100 +121 @@
             ///
             virtual void showPage (DocumentPage *page, PageScroll scroll) = 0;
-
             
         protected:

trunk/src/MainPter.cxx

@@ -589 +589 @@
 /// @param error Where to save the error if there's one.
 ///
-bool
+gboolean
 MainPter::openDocument (const gchar *fileName, const gchar *oldPassword,
                         GError **error)

trunk/src/MainPter.h

@@ -51 +51 @@
             void goToPageActivated (void);
             void goToPreviousPageActivated (void);
-            bool openDocument (const gchar *fileName, const gchar *oldPassword,
-                                GError **error);
+            gboolean openDocument (const gchar *fileName, 
+                                   const gchar *oldPassword, GError **error);
             void openFileActivated (void);
             void outlineActivated (DocumentOutline *outline);

trunk/src/Makefile.am

@@ -7 +7 @@
     Config.cxx          \
     Config.h            \
+    DocumentLink.cxx    \
+    DocumentLink.h  \
     DocumentOutline.cxx \
     DocumentOutline.h   \

trunk/src/PDFDocument.cxx

@@ -233 +233 @@
 }
 
+void
+PDFDocument::setLinks (DocumentPage *renderedPage, PopplerPage *popplerPage)
+{
+    gdouble pageHeight = 1.0;
+    // Get the height, to calculate the Y position as the document's origin
+    // is at the bottom-left corner, not the top-left as the screen does.
+    poppler_page_get_size (popplerPage, NULL, &pageHeight);
+    // We'll already calculate the positions scaled.
+    gdouble scale = getZoom ();
+    GList *pageLinks = poppler_page_get_link_mapping (popplerPage); 
+    for (GList *pageLink = g_list_first (pageLinks) ;
+         NULL != pageLink ;
+         pageLink = g_list_next (pageLink) )
+    {
+        PopplerLinkMapping *link = (PopplerLinkMapping *)pageLink->data;
+        PopplerAction *action = link->action;
+        // Only internal links.
+        if ( POPPLER_ACTION_GOTO_DEST == action->type )
+        {
+            PopplerActionGotoDest *actionGoTo = (PopplerActionGotoDest *)action;
+            DocumentLink *documentLink = 
+                new DocumentLink (link->area.x1 * scale, 
+                                  (pageHeight - link->area.y2) * scale,
+                                  link->area.x2 * scale,
+                                  (pageHeight - link->area.y1) * scale,
+                                  actionGoTo->dest->page_num);
+            renderedPage->addLink (documentLink);
+        }
+    }
+}
+
 ///
 /// @brief Sets the document's outline.
@@ -311 +342 @@
     *width = pageWidth;
     *height = pageHeight;
+
+    g_object_unref (G_OBJECT (page));
 }
 
@@ -353 +386 @@
                                    getRotation (), pixbuf);
     gdk_pixbuf_unref (pixbuf);
+    setLinks (renderedPage, page);
+    g_object_unref (G_OBJECT (page));
     
     return (renderedPage);

trunk/src/PDFDocument.h

@@ -23 +23 @@
 typedef struct _PopplerIndexIter PopplerIndexIter;
 typedef struct _PopplerDocument PopplerDocument;
+typedef struct _PopplerPage PopplerPage;
 
 namespace ePDFView 
@@ -51 +52 @@
             void setOutline (DocumentOutline *outline, 
                              PopplerIndexIter *childrenList);
+            void setLinks (DocumentPage *renderedPage,
+                           PopplerPage *popplerPage);
     };
 }

trunk/src/PagePter.cxx

@@ -83 +83 @@
     if ( 1 == button )
     {
-        m_DragInfo = new DragInfo;
-        m_DragInfo->x = x;
-        m_DragInfo->y = y;
-        m_DragInfo->scrollX = getView ().getHorizontalScroll ();
-        m_DragInfo->scrollY = getView ().getVerticalScroll ();
+        if ( m_Document->hasLinkAtPosition (x, y) )
+        {
+            m_Document->activateLinkAtPosition (x, y);
+        }
+        else
+        {
+            m_DragInfo = new DragInfo;
+            m_DragInfo->x = x;
+            m_DragInfo->y = y;
+
+            IPageView &view = getView ();
+            m_DragInfo->scrollX = view.getHorizontalScroll ();
+            m_DragInfo->scrollY = view.getVerticalScroll ();
+            view.setCursor (PAGE_VIEW_CURSOR_DRAG);
+        }
     }
 }
@@ -98 +108 @@
         delete m_DragInfo;
         m_DragInfo = NULL;
+        getView ().setCursor (PAGE_VIEW_CURSOR_NORMAL);
     }
 }
@@ -104 +115 @@
 PagePter::mouseMoved (gint x, gint y)
 {
-    if ( NULL != m_DragInfo )
-    {
-        getView ().scrollPage (m_DragInfo->scrollX, m_DragInfo->scrollY,
-                               x - m_DragInfo->x, y - m_DragInfo->y);
+    IPageView &view = getView ();
+    if ( NULL == m_DragInfo )
+    {
+        if ( m_Document->hasLinkAtPosition (x, y) )
+        {
+            view.setCursor (PAGE_VIEW_CURSOR_LINK);
+        }
+        else
+        {
+            view.setCursor (PAGE_VIEW_CURSOR_NORMAL);
+        }
+    }
+    else
+    {
+        view.scrollPage (m_DragInfo->scrollX, m_DragInfo->scrollY,
+                         x - m_DragInfo->x, y - m_DragInfo->y);
     }
 }

trunk/src/epdfview.h

@@ -24 +24 @@
 #include <Config.h>
 
+#include <DocumentLink.h>
 #include <DocumentOutline.h>
 #include <DocumentPage.h>

trunk/src/gtk/PageView.cxx

@@ -44 +44 @@
     IPageView ()
 {
+    // The initial cursor is normal.
+    m_CurrentCursor = PAGE_VIEW_CURSOR_NORMAL;
+
     // Create the scrolled window where the page image will be.
     m_PageScroll = gtk_scrolled_window_new (NULL, NULL);
@@ -100 +103 @@
             GTK_SCROLLED_WINDOW (m_PageScroll));
     return gtk_adjustment_get_value (vAdjustment);
+}
+
+void
+PageView::setCursor (PageCursor cursorType)
+{
+    if ( cursorType != m_CurrentCursor )
+    {
+        GdkCursor *cursor = NULL;
+        switch (cursorType)
+        {
+            case PAGE_VIEW_CURSOR_LINK:
+                cursor = gdk_cursor_new (GDK_HAND2);
+                break;
+            case PAGE_VIEW_CURSOR_DRAG:
+                cursor = gdk_cursor_new (GDK_FLEUR);
+                break;
+            default:
+                cursor = NULL;
+        }
+        if ( NULL != m_EventBox && GDK_IS_WINDOW (m_EventBox->window) )
+        {
+            gdk_window_set_cursor (m_EventBox->window, cursor);
+        }
+        if ( NULL != cursor )
+        {
+            gdk_cursor_unref (cursor);
+        }
+        gdk_flush ();
+        m_CurrentCursor = cursorType;
+    }
 }
 

trunk/src/gtk/PageView.h

@@ -35 +35 @@
             void scrollPage (gdouble scrollX, gdouble scrollY,
                              gint dx, gint dy);
+            void setCursor (PageCursor cursorType);
             void setPresenter (PagePter *pter);
             void showPage (DocumentPage *page, PageScroll scroll);
 
         protected:
+            PageCursor m_CurrentCursor;
             GtkWidget *m_EventBox;
             GtkWidget *m_PageImage;

trunk/tests/DumbPageView.cxx

@@ -59 +59 @@
 
 void
+DumbPageView::setCursor (PageCursor cursorType)
+{
+}
+
+void
 DumbPageView::showPage (DocumentPage *page, PageScroll scroll)
 {

trunk/tests/DumbPageView.h

@@ -32 +32 @@
             void scrollPage (gdouble scrollX, gdouble scrollY,
                              gint dx, gint dy);
+            void setCursor (PageCursor cursorType);
             void showPage (DocumentPage *page, PageScroll scroll);
 

trunk/tests/PDFDocumentTest.cxx

@@ -604 +604 @@
     g_free (testFile);
 }
+
+///
+/// @brief Tests the document's link.
+///
+/// If a page has a links, we should be able to ask the document if the
+/// mouse pointer is over any link (to be able to change the cursor) and to
+/// tell the document to change the current page for the page a links points
+/// to.
+///
+/// All this should happen even if the page is resized but will keep things
+/// simple for now and only for unrotated documents.
+///
+void
+PDFDocumentTest::pageLinks ()
+{
+    gchar *testFile = getTestFile ("test1.pdf");
+    m_Document->load (testFile, NULL);
+    while ( !m_Observer->loadFinished () ) { }
+    CPPUNIT_ASSERT (m_Observer->notifiedLoaded ());
+    CPPUNIT_ASSERT (m_Document->isLoaded ());
+
+    // In this test PDF document there are two links on page 4.
+    // Both links points to page 5 and are situated at:
+    // ((72.00, 147.11), (134.50, 137.11))
+    // ((96.00, 158.11), (145.17, 148.11))
+    //
+    // First try with an unscaled document.
+    m_Document->goToPage (4);
+    DocumentPage *page = NULL;
+    while ( NULL == page || (DocumentPage *)0xdeadbeef == page )
+    {
+        page = m_Document->getCurrentPage ();
+    }
+    CPPUNIT_ASSERT (!m_Document->hasLinkAtPosition (70, 140));
+    CPPUNIT_ASSERT (!m_Document->hasLinkAtPosition (76, 40));
+    CPPUNIT_ASSERT (!m_Document->hasLinkAtPosition (136, 139));
+    CPPUNIT_ASSERT (!m_Document->hasLinkAtPosition (130, 160));
+    CPPUNIT_ASSERT (m_Document->hasLinkAtPosition (76, 139));
+    CPPUNIT_ASSERT (m_Document->hasLinkAtPosition (100, 150));
+    CPPUNIT_ASSERT (!m_Document->hasLinkAtPosition (90, 151));
+    CPPUNIT_ASSERT (!m_Document->hasLinkAtPosition (100, 130));
+    CPPUNIT_ASSERT (!m_Document->hasLinkAtPosition (110, 160));
+    CPPUNIT_ASSERT (!m_Document->hasLinkAtPosition (150, 152));
+
+    // Active a link and let see how the page is changed.
+    m_Document->activateLinkAtPosition (76, 139);
+    CPPUNIT_ASSERT_EQUAL (5, m_Document->getCurrentPageNum ());
+
+    // Now try the same but with an scaled page. (x1.2)
+    // With this scale the links are now at:
+    // ((86.40, 176.53), (160.80, 164.53))
+    // ((115.2, 189.73), (174.20, 177.73))
+    //
+    m_Document->zoomIn ();
+    m_Document->goToPage (4);
+    page = NULL;
+    while ( NULL == page || (DocumentPage *)0xdeadbeef == page )
+    {
+        page = m_Document->getCurrentPage ();
+    }
+    // Just check the first link and activate the second.
+    CPPUNIT_ASSERT (m_Document->hasLinkAtPosition (87, 175));
+    m_Document->activateLinkAtPosition (174, 177);
+    CPPUNIT_ASSERT_EQUAL (5, m_Document->getCurrentPageNum ());
+}

trunk/tests/PDFDocumentTest.h

@@ -36 +36 @@
         CPPUNIT_TEST (pageZoom);
         CPPUNIT_TEST (pageRender);
+        CPPUNIT_TEST (pageLinks);
         CPPUNIT_TEST_SUITE_END ();
 
@@ -52 +53 @@
             void pageZoom (void);
             void pageRender (void);
+            void pageLinks (void);
             
         private: