]> git.saurik.com Git - wxWidgets.git/blobdiff - src/html/htmlwin.cpp
Final scrolling updates
[wxWidgets.git] / src / html / htmlwin.cpp
index 393b47565da1473c6e90e5407c9c82d9586f5c53..d6b79d5cbda3a071a30d3360a45783f29d7a7622 100644 (file)
@@ -9,7 +9,8 @@
 
 
 #ifdef __GNUG__
-#pragma implementation
+#pragma implementation "htmlwin.h"
+#pragma implementation "htmlproc.h"
 #endif
 
 #include "wx/wxprec.h"
 
 #include "wx/html/htmlwin.h"
 #include "wx/html/forcelnk.h"
+#include "wx/html/htmlproc.h"
 #include "wx/log.h"
+#include "wx/arrimpl.cpp"
+#include "wx/list.h"
+#include "wx/listimpl.cpp"
+
+//-----------------------------------------------------------------------------
+// wxHtmlHistoryItem
+//-----------------------------------------------------------------------------
+
+// item of history list
+class WXDLLEXPORT wxHtmlHistoryItem : public wxObject
+{
+public:
+    wxHtmlHistoryItem(const wxString& p, const wxString& a) {m_Page = p, m_Anchor = a, m_Pos = 0;}
+    int GetPos() const {return m_Pos;}
+    void SetPos(int p) {m_Pos = p;}
+    const wxString& GetPage() const {return m_Page;}
+    const wxString& GetAnchor() const {return m_Anchor;}
+
+private:
+    wxString m_Page;
+    wxString m_Anchor;
+    int m_Pos;
+};
 
 
 //-----------------------------------------------------------------------------
-// wxHtmlWindow
+// our private arrays:
 //-----------------------------------------------------------------------------
 
+WX_DECLARE_OBJARRAY(wxHtmlHistoryItem, wxHtmlHistoryArray);
+WX_DEFINE_OBJARRAY(wxHtmlHistoryArray);
 
+WX_DECLARE_LIST(wxHtmlProcessor, wxHtmlProcessorList);
+WX_DEFINE_LIST(wxHtmlProcessorList);
 
-#include "wx/arrimpl.cpp"
-WX_DEFINE_OBJARRAY(HtmlHistoryArray)
+//-----------------------------------------------------------------------------
+// wxHtmlWindow
+//-----------------------------------------------------------------------------
 
 
 wxHtmlWindow::wxHtmlWindow(wxWindow *parent, wxWindowID id, const wxPoint& pos, const wxSize& size,
@@ -49,7 +79,7 @@ wxHtmlWindow::wxHtmlWindow(wxWindow *parent, wxWindowID id, const wxPoint& pos,
     m_FS = new wxFileSystem();
     m_RelatedStatusBar = -1;
     m_RelatedFrame = NULL;
-    m_TitleFormat = "%s";
+    m_TitleFormat = wxT("%s");
     m_OpenedPage = m_OpenedAnchor = m_OpenedPageTitle = wxEmptyString;
     m_Cell = NULL;
     m_Parser = new wxHtmlWinParser(this);
@@ -57,6 +87,8 @@ wxHtmlWindow::wxHtmlWindow(wxWindow *parent, wxWindowID id, const wxPoint& pos,
     SetBorders(10);
     m_HistoryPos = -1;
     m_HistoryOn = TRUE;
+    m_History = new wxHtmlHistoryArray;
+    m_Processors = NULL;
     m_Style = style;
     SetPage(wxT("<html><body></body></html>"));
 }
@@ -71,6 +103,8 @@ wxHtmlWindow::~wxHtmlWindow()
 
     delete m_Parser;
     delete m_FS;
+    delete m_History;
+    delete m_Processors;
 }
 
 
@@ -95,7 +129,8 @@ void wxHtmlWindow::SetFonts(wxString normal_face, wxString fixed_face, const int
     wxString op = m_OpenedPage;
 
     m_Parser->SetFonts(normal_face, fixed_face, sizes);
-    SetPage(wxT("<html><body></body></html>")); // fonts changed => contents invalid
+    // fonts changed => contents invalid, so reload the page:
+    SetPage(wxT("<html><body></body></html>"));
     if (!op.IsEmpty()) LoadPage(op);
 }
 
@@ -103,23 +138,59 @@ void wxHtmlWindow::SetFonts(wxString normal_face, wxString fixed_face, const int
 
 bool wxHtmlWindow::SetPage(const wxString& source)
 {
-    wxClientDC *dc = new wxClientDC(this);
+    wxString newsrc(source);
 
+    // pass HTML through registered processors:
+    if (m_Processors || m_GlobalProcessors)
+    {
+        wxHtmlProcessorList::Node *nodeL, *nodeG;
+        int prL, prG;
+
+        nodeL = (m_Processors) ? m_Processors->GetFirst() : NULL;
+        nodeG = (m_GlobalProcessors) ? m_GlobalProcessors->GetFirst() : NULL;
+
+        // VS: there are two lists, global and local, both of them sorted by
+        //     priority. Since we have to go through _both_ lists with 
+        //     decreasing priority, we "merge-sort" the lists on-line by
+        //     processing that one of the two heads that has higher priority
+        //     in every iteration
+        while (nodeL || nodeG)
+        {
+            prL = (nodeL) ? nodeL->GetData()->GetPriority() : -1;
+            prG = (nodeG) ? nodeG->GetData()->GetPriority() : -1;
+            if (prL > prG)
+            {
+                if (nodeL->GetData()->IsEnabled())
+                    newsrc = nodeL->GetData()->Process(newsrc);
+                nodeL = nodeL->GetNext();
+            }
+            else // prL <= prG
+            {
+                if (nodeG->GetData()->IsEnabled())
+                    newsrc = nodeG->GetData()->Process(newsrc);
+                nodeG = nodeG->GetNext();
+            }
+        }
+    }
+
+    // ...and run the parser on it:
+    wxClientDC *dc = new wxClientDC(this);
     dc->SetMapMode(wxMM_TEXT);
     SetBackgroundColour(wxColour(0xFF, 0xFF, 0xFF));
     m_OpenedPage = m_OpenedAnchor = m_OpenedPageTitle = wxEmptyString;
     m_Parser->SetDC(dc);
-    if (m_Cell) 
+    if (m_Cell)
     {
         delete m_Cell;
         m_Cell = NULL;
     }
-    m_Cell = (wxHtmlContainerCell*) m_Parser->Parse(source);
+    m_Cell = (wxHtmlContainerCell*) m_Parser->Parse(newsrc);
     delete dc;
     m_Cell->SetIndent(m_Borders, wxHTML_INDENT_ALL, wxHTML_UNITS_PIXELS);
     m_Cell->SetAlignHor(wxHTML_ALIGN_CENTER);
     CreateLayout();
-    if (m_tmpCanDrawLocks == 0) Refresh();
+    if (m_tmpCanDrawLocks == 0)
+        Refresh();
     return TRUE;
 }
 
@@ -129,34 +200,36 @@ bool wxHtmlWindow::LoadPage(const wxString& location)
     wxFSFile *f;
     bool rt_val;
     bool needs_refresh = FALSE;
-    
+
     SetCursor(*wxHOURGLASS_CURSOR);
     wxYield(); Refresh(FALSE);
 
     m_tmpCanDrawLocks++;
-    if (m_HistoryOn && (m_HistoryPos != -1)) // store scroll position into history item
+    if (m_HistoryOn && (m_HistoryPos != -1)) 
     {
+        // store scroll position into history item:
         int x, y;
         ViewStart(&x, &y);
-        m_History[m_HistoryPos].SetPos(y);
+        (*m_History)[m_HistoryPos].SetPos(y);
     }
 
-    if (location[0] == wxT('#')) // local anchor
+    if (location[0] == wxT('#')) 
     {
+        // local anchor:
         wxString anch = location.Mid(1) /*1 to end*/;
         m_tmpCanDrawLocks--;
         rt_val = ScrollToAnchor(anch);
         m_tmpCanDrawLocks++;
     }
-    else if (location.Find(wxT('#')) != wxNOT_FOUND && location.BeforeFirst(wxT('#')) == m_OpenedPage) 
+    else if (location.Find(wxT('#')) != wxNOT_FOUND && location.BeforeFirst(wxT('#')) == m_OpenedPage)
     {
         wxString anch = location.AfterFirst(wxT('#'));
         m_tmpCanDrawLocks--;
         rt_val = ScrollToAnchor(anch);
         m_tmpCanDrawLocks++;
     }
-    else if (location.Find(wxT('#')) != wxNOT_FOUND && 
-             (m_FS->GetPath() + location.BeforeFirst(wxT('#'))) == m_OpenedPage) 
+    else if (location.Find(wxT('#')) != wxNOT_FOUND &&
+             (m_FS->GetPath() + location.BeforeFirst(wxT('#'))) == m_OpenedPage)
        {
         wxString anch = location.AfterFirst(wxT('#'));
         m_tmpCanDrawLocks--;
@@ -164,19 +237,19 @@ bool wxHtmlWindow::LoadPage(const wxString& location)
         m_tmpCanDrawLocks++;
     }
 
-    else 
+    else
     {
         needs_refresh = TRUE;
         // load&display it:
-        if (m_RelatedStatusBar != -1) 
+        if (m_RelatedStatusBar != -1)
            {
             m_RelatedFrame->SetStatusText(_("Connecting..."), m_RelatedStatusBar);
             Refresh(FALSE);
         }
 
         f = m_FS->OpenFile(location);
-        
-        if (f == NULL) 
+
+        if (f == NULL)
            {
             wxString err;
 
@@ -187,12 +260,12 @@ bool wxHtmlWindow::LoadPage(const wxString& location)
             return FALSE;
         }
 
-        else 
+        else
        {
             wxNode *node;
             wxString src = wxEmptyString;
 
-            if (m_RelatedStatusBar != -1) 
+            if (m_RelatedStatusBar != -1)
                {
                 wxString msg = _("Loading : ") + location;
                 m_RelatedFrame->SetStatusText(msg, m_RelatedStatusBar);
@@ -210,7 +283,7 @@ bool wxHtmlWindow::LoadPage(const wxString& location)
                 }
                 node = node->GetNext();
             }
-            if (src == wxEmptyString) 
+            if (src == wxEmptyString)
                {
                 if (m_DefaultFilter == NULL) m_DefaultFilter = GetDefaultFilter();
                 src = m_DefaultFilter->ReadFile(*f);
@@ -219,7 +292,7 @@ bool wxHtmlWindow::LoadPage(const wxString& location)
             m_FS->ChangePathTo(f->GetLocation());
             rt_val = SetPage(src);
             m_OpenedPage = f->GetLocation();
-            if (f->GetAnchor() != wxEmptyString) 
+            if (f->GetAnchor() != wxEmptyString)
                {
                 wxYield();
                 ScrollToAnchor(f->GetAnchor());
@@ -233,19 +306,19 @@ bool wxHtmlWindow::LoadPage(const wxString& location)
 
     if (m_HistoryOn) // add this page to history there:
     {
-        int c = m_History.GetCount() - (m_HistoryPos + 1);
+        int c = m_History->GetCount() - (m_HistoryPos + 1);
 
         m_HistoryPos++;
         for (int i = 0; i < c; i++)
-            m_History.Remove(m_HistoryPos);
-        m_History.Add(new HtmlHistoryItem(m_OpenedPage, m_OpenedAnchor));
+            m_History->Remove(m_HistoryPos);
+        m_History->Add(new wxHtmlHistoryItem(m_OpenedPage, m_OpenedAnchor));
     }
 
     if (m_OpenedPageTitle == wxEmptyString)
         OnSetTitle(wxFileNameFromPath(m_OpenedPage));
     SetCursor(*wxSTANDARD_CURSOR);
 
-    if (needs_refresh) 
+    if (needs_refresh)
     {
         wxYield();
         m_tmpCanDrawLocks--;
@@ -267,7 +340,7 @@ bool wxHtmlWindow::ScrollToAnchor(const wxString& anchor)
         wxLogWarning(_("HTML anchor %s does not exist."), anchor.c_str());
         return FALSE;
     }
-    else 
+    else
     {
         int y;
 
@@ -281,7 +354,7 @@ bool wxHtmlWindow::ScrollToAnchor(const wxString& anchor)
 
 void wxHtmlWindow::OnSetTitle(const wxString& title)
 {
-    if (m_RelatedFrame) 
+    if (m_RelatedFrame)
     {
         wxString tit;
         tit.Printf(m_TitleFormat, title.c_str());
@@ -300,7 +373,7 @@ void wxHtmlWindow::CreateLayout()
 
     if (!m_Cell) return;
 
-    if (m_Style & wxHW_SCROLLBAR_NEVER) 
+    if (m_Style & wxHW_SCROLLBAR_NEVER)
     {
         SetScrollbars(wxHTML_SCROLL_STEP, 1, m_Cell->GetWidth() / wxHTML_SCROLL_STEP, 0); // always off
         GetClientSize(&ClientWidth, &ClientHeight);
@@ -310,7 +383,7 @@ void wxHtmlWindow::CreateLayout()
     else {
         GetClientSize(&ClientWidth, &ClientHeight);
         m_Cell->Layout(ClientWidth);
-        if (ClientHeight < m_Cell->GetHeight() + GetCharHeight()) 
+        if (ClientHeight < m_Cell->GetHeight() + GetCharHeight())
            {
             SetScrollbars(
                   wxHTML_SCROLL_STEP, wxHTML_SCROLL_STEP,
@@ -336,16 +409,16 @@ void wxHtmlWindow::ReadCustomization(wxConfigBase *cfg, wxString path)
     int p_fontsizes[7];
     wxString p_fff, p_ffn;
 
-    if (path != wxEmptyString) 
+    if (path != wxEmptyString)
     {
         oldpath = cfg->GetPath();
         cfg->SetPath(path);
     }
 
-    m_Borders = cfg->Read("wxHtmlWindow/Borders", m_Borders);
-    p_fff = cfg->Read("wxHtmlWindow/FontFaceFixed", m_Parser->m_FontFaceFixed);
-    p_ffn = cfg->Read("wxHtmlWindow/FontFaceNormal", m_Parser->m_FontFaceNormal);
-    for (int i = 0; i < 7; i++) 
+    m_Borders = cfg->Read(wxT("wxHtmlWindow/Borders"), m_Borders);
+    p_fff = cfg->Read(wxT("wxHtmlWindow/FontFaceFixed"), m_Parser->m_FontFaceFixed);
+    p_ffn = cfg->Read(wxT("wxHtmlWindow/FontFaceNormal"), m_Parser->m_FontFaceNormal);
+    for (int i = 0; i < 7; i++)
     {
         tmp.Printf(wxT("wxHtmlWindow/FontsSize%i"), i);
         p_fontsizes[i] = cfg->Read(tmp, m_Parser->m_FontsSizes[i]);
@@ -363,16 +436,16 @@ void wxHtmlWindow::WriteCustomization(wxConfigBase *cfg, wxString path)
     wxString oldpath;
     wxString tmp;
 
-    if (path != wxEmptyString) 
+    if (path != wxEmptyString)
     {
         oldpath = cfg->GetPath();
         cfg->SetPath(path);
     }
 
-    cfg->Write("wxHtmlWindow/Borders", (long) m_Borders);
-    cfg->Write("wxHtmlWindow/FontFaceFixed", m_Parser->m_FontFaceFixed);
-    cfg->Write("wxHtmlWindow/FontFaceNormal", m_Parser->m_FontFaceNormal);
-    for (int i = 0; i < 7; i++) 
+    cfg->Write(wxT("wxHtmlWindow/Borders"), (long) m_Borders);
+    cfg->Write(wxT("wxHtmlWindow/FontFaceFixed"), m_Parser->m_FontFaceFixed);
+    cfg->Write(wxT("wxHtmlWindow/FontFaceNormal"), m_Parser->m_FontFaceNormal);
+    for (int i = 0; i < 7; i++)
     {
         tmp.Printf(wxT("wxHtmlWindow/FontsSize%i"), i);
         cfg->Write(tmp, (long) m_Parser->m_FontsSizes[i]);
@@ -393,13 +466,13 @@ bool wxHtmlWindow::HistoryBack()
     // store scroll position into history item:
     int x, y;
     ViewStart(&x, &y);
-    m_History[m_HistoryPos].SetPos(y);
+    (*m_History)[m_HistoryPos].SetPos(y);
 
     // go to previous position:
     m_HistoryPos--;
 
-    l = m_History[m_HistoryPos].GetPage();
-    a = m_History[m_HistoryPos].GetAnchor();
+    l = (*m_History)[m_HistoryPos].GetPage();
+    a = (*m_History)[m_HistoryPos].GetAnchor();
     m_HistoryOn = FALSE;
     m_tmpCanDrawLocks++;
     if (a == wxEmptyString) LoadPage(l);
@@ -407,7 +480,7 @@ bool wxHtmlWindow::HistoryBack()
     m_HistoryOn = TRUE;
     wxYield();
     m_tmpCanDrawLocks--;
-    Scroll(0, m_History[m_HistoryPos].GetPos());
+    Scroll(0, (*m_History)[m_HistoryPos].GetPos());
     Refresh();
     return TRUE;
 }
@@ -424,13 +497,13 @@ bool wxHtmlWindow::HistoryForward()
     wxString a, l;
 
     if (m_HistoryPos == -1) return FALSE;
-    if (m_HistoryPos >= (int)m_History.GetCount() - 1)return FALSE;
+    if (m_HistoryPos >= (int)m_History->GetCount() - 1)return FALSE;
 
     m_OpenedPage = wxEmptyString; // this will disable adding new entry into history in LoadPage()
 
     m_HistoryPos++;
-    l = m_History[m_HistoryPos].GetPage();
-    a = m_History[m_HistoryPos].GetAnchor();
+    l = (*m_History)[m_HistoryPos].GetPage();
+    a = (*m_History)[m_HistoryPos].GetAnchor();
     m_HistoryOn = FALSE;
     m_tmpCanDrawLocks++;
     if (a == wxEmptyString) LoadPage(l);
@@ -438,7 +511,7 @@ bool wxHtmlWindow::HistoryForward()
     m_HistoryOn = TRUE;
     wxYield();
     m_tmpCanDrawLocks--;
-    Scroll(0, m_History[m_HistoryPos].GetPos());
+    Scroll(0, (*m_History)[m_HistoryPos].GetPos());
     Refresh();
     return TRUE;
 }
@@ -446,32 +519,75 @@ bool wxHtmlWindow::HistoryForward()
 bool wxHtmlWindow::HistoryCanForward()
 {
     if (m_HistoryPos == -1) return FALSE;
-    if (m_HistoryPos >= (int)m_History.GetCount() - 1)return FALSE;
+    if (m_HistoryPos >= (int)m_History->GetCount() - 1)return FALSE;
     return TRUE ;
 }
 
 
 void wxHtmlWindow::HistoryClear()
 {
-    m_History.Empty();
+    m_History->Empty();
     m_HistoryPos = -1;
 }
 
+void wxHtmlWindow::AddProcessor(wxHtmlProcessor *processor)
+{
+    if (!m_Processors)
+    {
+        m_Processors = new wxHtmlProcessorList;
+        m_Processors->DeleteContents(TRUE);
+    }
+    wxHtmlProcessorList::Node *node;
+
+    for (node = m_Processors->GetFirst(); node; node = node->GetNext())
+    {
+        if (processor->GetPriority() > node->GetData()->GetPriority())
+        {
+            m_Processors->Insert(node, processor);
+            return;
+        }
+    }
+    m_Processors->Append(processor);
+}
+
+/*static */ void wxHtmlWindow::AddGlobalProcessor(wxHtmlProcessor *processor)
+{
+    if (!m_GlobalProcessors)
+    {
+        m_GlobalProcessors = new wxHtmlProcessorList;
+        m_GlobalProcessors->DeleteContents(TRUE);
+    }
+    wxHtmlProcessorList::Node *node;
+    
+    for (node = m_GlobalProcessors->GetFirst(); node; node = node->GetNext())
+    {
+        if (processor->GetPriority() > node->GetData()->GetPriority())
+        {
+            m_GlobalProcessors->Insert(node, processor);
+            return;
+        }
+    }
+    m_GlobalProcessors->Append(processor);
+}
+
 
 
 wxList wxHtmlWindow::m_Filters;
 wxHtmlFilter *wxHtmlWindow::m_DefaultFilter = NULL;
 wxCursor *wxHtmlWindow::s_cur_hand = NULL;
 wxCursor *wxHtmlWindow::s_cur_arrow = NULL;
+wxHtmlProcessorList *wxHtmlWindow::m_GlobalProcessors = NULL;
 
 void wxHtmlWindow::CleanUpStatics()
 {
-    if (m_DefaultFilter) delete m_DefaultFilter;
+    delete m_DefaultFilter;
     m_DefaultFilter = NULL;
     m_Filters.DeleteContents(TRUE);
     m_Filters.Clear();
-    if (s_cur_hand) delete s_cur_hand;
-    if (s_cur_arrow) delete s_cur_arrow;
+    delete m_GlobalProcessors;
+    m_GlobalProcessors = NULL;
+    delete s_cur_hand;
+    delete s_cur_arrow;
 }
 
 
@@ -498,10 +614,10 @@ void wxHtmlWindow::OnDraw(wxDC& dc)
     int v_y, v_h;
 
     if (m_tmpCanDrawLocks > 0) return;
-    
+
     dc.SetMapMode(wxMM_TEXT);
 #if 0
-/* VS - I don't think this is neccessary any longer 
+/* VS - I don't think this is neccessary any longer
         MSC_VER 1200 means MSVC 6.0 and it works fine */
 #if defined(_MSC_VER) && (_MSC_VER == 1200)
     ::SetMapMode((HDC)dc.GetHDC(), MM_TEXT);
@@ -510,7 +626,7 @@ void wxHtmlWindow::OnDraw(wxDC& dc)
     dc.SetBackgroundMode(wxTRANSPARENT);
     ViewStart(&x, &y);
 
-    while (upd) 
+    while (upd)
     {
         v_y = upd.GetY();
         v_h = upd.GetH();
@@ -534,7 +650,7 @@ void wxHtmlWindow::OnMouseEvent(wxMouseEvent& event)
 {
     m_tmpMouseMoved = TRUE;
 
-    if (event.ButtonDown()) 
+    if (event.ButtonDown())
     {
         int sx, sy;
         wxPoint pos;
@@ -550,15 +666,15 @@ void wxHtmlWindow::OnMouseEvent(wxMouseEvent& event)
 
 
 
-void wxHtmlWindow::OnIdle(wxIdleEvent& event)
+void wxHtmlWindow::OnIdle(wxIdleEvent& WXUNUSED(event))
 {
-    if (s_cur_hand == NULL) 
+    if (s_cur_hand == NULL)
     {
         s_cur_hand = new wxCursor(wxCURSOR_HAND);
         s_cur_arrow = new wxCursor(wxCURSOR_ARROW);
     }
 
-    if (m_tmpMouseMoved && (m_Cell != NULL)) 
+    if (m_tmpMouseMoved && (m_Cell != NULL))
     {
         int sx, sy;
         int x, y;
@@ -569,17 +685,17 @@ void wxHtmlWindow::OnIdle(wxIdleEvent& event)
         ScreenToClient(&x, &y);
         lnk = m_Cell->GetLink(sx + x, sy + y);
 
-        if (lnk != m_tmpLastLink) 
+        if (lnk != m_tmpLastLink)
            {
-            if (lnk == NULL) 
+            if (lnk == NULL)
                {
                 SetCursor(*s_cur_arrow);
                 if (m_RelatedStatusBar != -1) m_RelatedFrame->SetStatusText(wxEmptyString, m_RelatedStatusBar);
             }
-            else 
+            else
                {
                 SetCursor(*s_cur_hand);
-                if (m_RelatedStatusBar != -1) 
+                if (m_RelatedStatusBar != -1)
                     m_RelatedFrame->SetStatusText(lnk->GetHref(), m_RelatedStatusBar);
             }
             m_tmpLastLink = lnk;
@@ -589,7 +705,7 @@ void wxHtmlWindow::OnIdle(wxIdleEvent& event)
 }
 
 
-
+IMPLEMENT_ABSTRACT_CLASS(wxHtmlProcessor,wxObject)
 
 IMPLEMENT_DYNAMIC_CLASS(wxHtmlWindow,wxScrolledWindow)