]> git.saurik.com Git - wxWidgets.git/blobdiff - src/html/htmlwin.cpp
added new text event macros description
[wxWidgets.git] / src / html / htmlwin.cpp
index 5f14c0e50870e932e9dc3b582819919b23ff1764..30164dc55da4899988aa9ec251085c0f05210fa8 100644 (file)
@@ -9,7 +9,8 @@
 
 
 #ifdef __GNUG__
-#pragma implementation
+#pragma implementation "htmlwin.h"
+#pragma implementation "htmlproc.h"
 #endif
 
 #include "wx/wxprec.h"
 #endif
 
 #ifndef WXPRECOMP
-#include "wx/wx.h"
+    #include "wx/log.h"
+    #include "wx/intl.h"
+    #include "wx/dcclient.h"
+    #include "wx/frame.h"
 #endif
 
 #include "wx/html/htmlwin.h"
 #include "wx/html/forcelnk.h"
-#include "wx/log.h"
+#include "wx/html/htmlproc.h"
+#include "wx/list.h"
 
+#include "wx/arrimpl.cpp"
+#include "wx/listimpl.cpp"
 
 //-----------------------------------------------------------------------------
-// wxHtmlWindow
+// 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;
+};
 
 
-#include "wx/arrimpl.cpp"
-WX_DEFINE_OBJARRAY(HtmlHistoryArray)
+//-----------------------------------------------------------------------------
+// our private arrays:
+//-----------------------------------------------------------------------------
+
+WX_DECLARE_OBJARRAY(wxHtmlHistoryItem, wxHtmlHistoryArray);
+WX_DEFINE_OBJARRAY(wxHtmlHistoryArray);
+
+WX_DECLARE_LIST(wxHtmlProcessor, wxHtmlProcessorList);
+WX_DEFINE_LIST(wxHtmlProcessorList);
+
+//-----------------------------------------------------------------------------
+// wxHtmlWindow
+//-----------------------------------------------------------------------------
 
 
 wxHtmlWindow::wxHtmlWindow(wxWindow *parent, wxWindowID id, const wxPoint& pos, const wxSize& size,
@@ -49,7 +82,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 +90,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 +106,8 @@ wxHtmlWindow::~wxHtmlWindow()
 
     delete m_Parser;
     delete m_FS;
+    delete m_History;
+    delete m_Processors;
 }
 
 
@@ -95,7 +132,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,8 +141,43 @@ 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;
@@ -114,12 +187,13 @@ bool wxHtmlWindow::SetPage(const wxString& source)
         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;
 }
 
@@ -134,15 +208,17 @@ bool wxHtmlWindow::LoadPage(const wxString& location)
     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);
+        GetViewStart(&x, &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);
@@ -157,7 +233,7 @@ bool wxHtmlWindow::LoadPage(const wxString& location)
     }
     else if (location.Find(wxT('#')) != wxNOT_FOUND &&
              (m_FS->GetPath() + location.BeforeFirst(wxT('#'))) == m_OpenedPage)
-       {
+    {
         wxString anch = location.AfterFirst(wxT('#'));
         m_tmpCanDrawLocks--;
         rt_val = ScrollToAnchor(anch);
@@ -169,7 +245,7 @@ bool wxHtmlWindow::LoadPage(const wxString& location)
         needs_refresh = TRUE;
         // load&display it:
         if (m_RelatedStatusBar != -1)
-           {
+        {
             m_RelatedFrame->SetStatusText(_("Connecting..."), m_RelatedStatusBar);
             Refresh(FALSE);
         }
@@ -177,9 +253,7 @@ bool wxHtmlWindow::LoadPage(const wxString& location)
         f = m_FS->OpenFile(location);
 
         if (f == NULL)
-           {
-            wxString err;
-
+        {
             wxLogError(_("Unable to open requested HTML document: %s"), location.c_str());
             m_tmpCanDrawLocks--;
 
@@ -188,12 +262,12 @@ bool wxHtmlWindow::LoadPage(const wxString& location)
         }
 
         else
-       {
+        {
             wxNode *node;
             wxString src = wxEmptyString;
 
             if (m_RelatedStatusBar != -1)
-               {
+            {
                 wxString msg = _("Loading : ") + location;
                 m_RelatedFrame->SetStatusText(msg, m_RelatedStatusBar);
                 Refresh(FALSE);
@@ -201,17 +275,17 @@ bool wxHtmlWindow::LoadPage(const wxString& location)
 
             node = m_Filters.GetFirst();
             while (node)
-               {
+            {
                 wxHtmlFilter *h = (wxHtmlFilter*) node->GetData();
                 if (h->CanRead(*f))
-                       {
+                {
                     src = h->ReadFile(*f);
                     break;
                 }
                 node = node->GetNext();
             }
             if (src == wxEmptyString)
-               {
+            {
                 if (m_DefaultFilter == NULL) m_DefaultFilter = GetDefaultFilter();
                 src = m_DefaultFilter->ReadFile(*f);
             }
@@ -220,7 +294,7 @@ bool wxHtmlWindow::LoadPage(const wxString& location)
             rt_val = SetPage(src);
             m_OpenedPage = f->GetLocation();
             if (f->GetAnchor() != wxEmptyString)
-               {
+            {
                 wxYield();
                 ScrollToAnchor(f->GetAnchor());
             }
@@ -233,12 +307,17 @@ bool wxHtmlWindow::LoadPage(const wxString& location)
 
     if (m_HistoryOn) // add this page to history there:
     {
-        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));
+        int c = m_History->GetCount() - (m_HistoryPos + 1);
+
+        if (m_HistoryPos < 0 || 
+            (*m_History)[m_HistoryPos].GetPage() != m_OpenedPage ||
+            (*m_History)[m_HistoryPos].GetAnchor() != m_OpenedAnchor)
+        {
+            m_HistoryPos++;
+            for (int i = 0; i < c; i++)
+                m_History->RemoveAt(m_HistoryPos);
+            m_History->Add(new wxHtmlHistoryItem(m_OpenedPage, m_OpenedAnchor));
+        }
     }
 
     if (m_OpenedPageTitle == wxEmptyString)
@@ -311,7 +390,7 @@ void wxHtmlWindow::CreateLayout()
         GetClientSize(&ClientWidth, &ClientHeight);
         m_Cell->Layout(ClientWidth);
         if (ClientHeight < m_Cell->GetHeight() + GetCharHeight())
-           {
+        {
             SetScrollbars(
                   wxHTML_SCROLL_STEP, wxHTML_SCROLL_STEP,
                   m_Cell->GetWidth() / wxHTML_SCROLL_STEP,
@@ -319,7 +398,7 @@ void wxHtmlWindow::CreateLayout()
                   /*cheat: top-level frag is always container*/);
         }
         else /* we fit into window, no need for scrollbars */
-           {
+        {
             SetScrollbars(wxHTML_SCROLL_STEP, 1, m_Cell->GetWidth() / wxHTML_SCROLL_STEP, 0); // disable...
             GetClientSize(&ClientWidth, &ClientHeight);
             m_Cell->Layout(ClientWidth); // ...and relayout
@@ -342,9 +421,9 @@ void wxHtmlWindow::ReadCustomization(wxConfigBase *cfg, wxString path)
         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);
+    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);
@@ -369,9 +448,9 @@ void wxHtmlWindow::WriteCustomization(wxConfigBase *cfg, wxString path)
         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);
+    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);
@@ -392,14 +471,14 @@ bool wxHtmlWindow::HistoryBack()
 
     // store scroll position into history item:
     int x, y;
-    ViewStart(&x, &y);
-    m_History[m_HistoryPos].SetPos(y);
+    GetViewStart(&x, &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 +486,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 +503,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 +517,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 +525,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;
 }
 
 
@@ -508,7 +630,7 @@ void wxHtmlWindow::OnDraw(wxDC& dc)
 #endif
 #endif
     dc.SetBackgroundMode(wxTRANSPARENT);
-    ViewStart(&x, &y);
+    GetViewStart(&x, &y);
 
     while (upd)
     {
@@ -540,7 +662,7 @@ void wxHtmlWindow::OnMouseEvent(wxMouseEvent& event)
         wxPoint pos;
         wxString lnk;
 
-        ViewStart(&sx, &sy); sx *= wxHTML_SCROLL_STEP; sy *= wxHTML_SCROLL_STEP;
+        GetViewStart(&sx, &sy); sx *= wxHTML_SCROLL_STEP; sy *= wxHTML_SCROLL_STEP;
         pos = event.GetPosition();
 
         if (m_Cell)
@@ -564,20 +686,20 @@ void wxHtmlWindow::OnIdle(wxIdleEvent& WXUNUSED(event))
         int x, y;
         wxHtmlLinkInfo *lnk;
 
-        ViewStart(&sx, &sy); sx *= wxHTML_SCROLL_STEP; sy *= wxHTML_SCROLL_STEP;
+        GetViewStart(&sx, &sy); sx *= wxHTML_SCROLL_STEP; sy *= wxHTML_SCROLL_STEP;
         wxGetMousePosition(&x, &y);
         ScreenToClient(&x, &y);
         lnk = m_Cell->GetLink(sx + x, sy + y);
 
         if (lnk != m_tmpLastLink)
-           {
+        {
             if (lnk == NULL)
-               {
+            {
                 SetCursor(*s_cur_arrow);
                 if (m_RelatedStatusBar != -1) m_RelatedFrame->SetStatusText(wxEmptyString, m_RelatedStatusBar);
             }
             else
-               {
+            {
                 SetCursor(*s_cur_hand);
                 if (m_RelatedStatusBar != -1)
                     m_RelatedFrame->SetStatusText(lnk->GetHref(), m_RelatedStatusBar);
@@ -589,7 +711,7 @@ void wxHtmlWindow::OnIdle(wxIdleEvent& WXUNUSED(event))
 }
 
 
-
+IMPLEMENT_ABSTRACT_CLASS(wxHtmlProcessor,wxObject)
 
 IMPLEMENT_DYNAMIC_CLASS(wxHtmlWindow,wxScrolledWindow)