1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxHtmlWindow class for parsing & displaying HTML (implementation)
4 // Author: Vaclav Slavik
6 // Copyright: (c) 1999 Vaclav Slavik
7 // Licence: wxWindows Licence
8 /////////////////////////////////////////////////////////////////////////////
12 #pragma implementation "htmlwin.h"
13 #pragma implementation "htmlproc.h"
16 #include "wx/wxprec.h"
19 #if wxUSE_HTML && wxUSE_STREAMS
28 #include "wx/dcclient.h"
32 #include "wx/html/htmlwin.h"
33 #include "wx/html/forcelnk.h"
34 #include "wx/html/htmlproc.h"
37 #include "wx/arrimpl.cpp"
38 #include "wx/listimpl.cpp"
40 //-----------------------------------------------------------------------------
42 //-----------------------------------------------------------------------------
44 // item of history list
45 class WXDLLEXPORT wxHtmlHistoryItem
: public wxObject
48 wxHtmlHistoryItem(const wxString
& p
, const wxString
& a
) {m_Page
= p
, m_Anchor
= a
, m_Pos
= 0;}
49 int GetPos() const {return m_Pos
;}
50 void SetPos(int p
) {m_Pos
= p
;}
51 const wxString
& GetPage() const {return m_Page
;}
52 const wxString
& GetAnchor() const {return m_Anchor
;}
61 //-----------------------------------------------------------------------------
62 // our private arrays:
63 //-----------------------------------------------------------------------------
65 WX_DECLARE_OBJARRAY(wxHtmlHistoryItem
, wxHtmlHistoryArray
);
66 WX_DEFINE_OBJARRAY(wxHtmlHistoryArray
);
68 WX_DECLARE_LIST(wxHtmlProcessor
, wxHtmlProcessorList
);
69 WX_DEFINE_LIST(wxHtmlProcessorList
);
71 //-----------------------------------------------------------------------------
73 //-----------------------------------------------------------------------------
76 wxHtmlWindow::wxHtmlWindow(wxWindow
*parent
, wxWindowID id
, const wxPoint
& pos
, const wxSize
& size
,
77 long style
, const wxString
& name
) : wxScrolledWindow(parent
, id
, pos
, size
, style
| wxVSCROLL
| wxHSCROLL
, name
)
79 m_tmpMouseMoved
= FALSE
;
82 m_tmpCanDrawLocks
= 0;
83 m_FS
= new wxFileSystem();
84 m_RelatedStatusBar
= -1;
85 m_RelatedFrame
= NULL
;
86 m_TitleFormat
= wxT("%s");
87 m_OpenedPage
= m_OpenedAnchor
= m_OpenedPageTitle
= wxEmptyString
;
89 m_Parser
= new wxHtmlWinParser(this);
90 m_Parser
->SetFS(m_FS
);
94 m_History
= new wxHtmlHistoryArray
;
97 SetPage(wxT("<html><body></body></html>"));
102 wxHtmlWindow::~wxHtmlWindow()
106 if (m_Cell
) delete m_Cell
;
116 void wxHtmlWindow::SetRelatedFrame(wxFrame
* frame
, const wxString
& format
)
118 m_RelatedFrame
= frame
;
119 m_TitleFormat
= format
;
124 void wxHtmlWindow::SetRelatedStatusBar(int bar
)
126 m_RelatedStatusBar
= bar
;
131 void wxHtmlWindow::SetFonts(wxString normal_face
, wxString fixed_face
, const int *sizes
)
133 wxString op
= m_OpenedPage
;
135 m_Parser
->SetFonts(normal_face
, fixed_face
, sizes
);
136 // fonts changed => contents invalid, so reload the page:
137 SetPage(wxT("<html><body></body></html>"));
138 if (!op
.IsEmpty()) LoadPage(op
);
143 bool wxHtmlWindow::SetPage(const wxString
& source
)
145 wxString
newsrc(source
);
147 // pass HTML through registered processors:
148 if (m_Processors
|| m_GlobalProcessors
)
150 wxHtmlProcessorList::Node
*nodeL
, *nodeG
;
153 nodeL
= (m_Processors
) ? m_Processors
->GetFirst() : NULL
;
154 nodeG
= (m_GlobalProcessors
) ? m_GlobalProcessors
->GetFirst() : NULL
;
156 // VS: there are two lists, global and local, both of them sorted by
157 // priority. Since we have to go through _both_ lists with
158 // decreasing priority, we "merge-sort" the lists on-line by
159 // processing that one of the two heads that has higher priority
160 // in every iteration
161 while (nodeL
|| nodeG
)
163 prL
= (nodeL
) ? nodeL
->GetData()->GetPriority() : -1;
164 prG
= (nodeG
) ? nodeG
->GetData()->GetPriority() : -1;
167 if (nodeL
->GetData()->IsEnabled())
168 newsrc
= nodeL
->GetData()->Process(newsrc
);
169 nodeL
= nodeL
->GetNext();
173 if (nodeG
->GetData()->IsEnabled())
174 newsrc
= nodeG
->GetData()->Process(newsrc
);
175 nodeG
= nodeG
->GetNext();
180 // ...and run the parser on it:
181 wxClientDC
*dc
= new wxClientDC(this);
182 dc
->SetMapMode(wxMM_TEXT
);
183 SetBackgroundColour(wxColour(0xFF, 0xFF, 0xFF));
184 m_OpenedPage
= m_OpenedAnchor
= m_OpenedPageTitle
= wxEmptyString
;
191 m_Cell
= (wxHtmlContainerCell
*) m_Parser
->Parse(newsrc
);
193 m_Cell
->SetIndent(m_Borders
, wxHTML_INDENT_ALL
, wxHTML_UNITS_PIXELS
);
194 m_Cell
->SetAlignHor(wxHTML_ALIGN_CENTER
);
196 if (m_tmpCanDrawLocks
== 0)
202 bool wxHtmlWindow::LoadPage(const wxString
& location
)
206 bool needs_refresh
= FALSE
;
208 SetCursor(*wxHOURGLASS_CURSOR
);
209 wxYield(); Refresh(FALSE
);
212 if (m_HistoryOn
&& (m_HistoryPos
!= -1))
214 // store scroll position into history item:
216 GetViewStart(&x
, &y
);
217 (*m_History
)[m_HistoryPos
].SetPos(y
);
220 if (location
[0] == wxT('#'))
223 wxString anch
= location
.Mid(1) /*1 to end*/;
225 rt_val
= ScrollToAnchor(anch
);
228 else if (location
.Find(wxT('#')) != wxNOT_FOUND
&& location
.BeforeFirst(wxT('#')) == m_OpenedPage
)
230 wxString anch
= location
.AfterFirst(wxT('#'));
232 rt_val
= ScrollToAnchor(anch
);
235 else if (location
.Find(wxT('#')) != wxNOT_FOUND
&&
236 (m_FS
->GetPath() + location
.BeforeFirst(wxT('#'))) == m_OpenedPage
)
238 wxString anch
= location
.AfterFirst(wxT('#'));
240 rt_val
= ScrollToAnchor(anch
);
246 needs_refresh
= TRUE
;
248 if (m_RelatedStatusBar
!= -1)
250 m_RelatedFrame
->SetStatusText(_("Connecting..."), m_RelatedStatusBar
);
254 f
= m_FS
->OpenFile(location
);
258 wxLogError(_("Unable to open requested HTML document: %s"), location
.c_str());
261 SetCursor(*wxSTANDARD_CURSOR
);
268 wxString src
= wxEmptyString
;
270 if (m_RelatedStatusBar
!= -1)
272 wxString msg
= _("Loading : ") + location
;
273 m_RelatedFrame
->SetStatusText(msg
, m_RelatedStatusBar
);
277 node
= m_Filters
.GetFirst();
280 wxHtmlFilter
*h
= (wxHtmlFilter
*) node
->GetData();
283 src
= h
->ReadFile(*f
);
286 node
= node
->GetNext();
288 if (src
== wxEmptyString
)
290 if (m_DefaultFilter
== NULL
) m_DefaultFilter
= GetDefaultFilter();
291 src
= m_DefaultFilter
->ReadFile(*f
);
294 m_FS
->ChangePathTo(f
->GetLocation());
295 rt_val
= SetPage(src
);
296 m_OpenedPage
= f
->GetLocation();
297 if (f
->GetAnchor() != wxEmptyString
)
300 ScrollToAnchor(f
->GetAnchor());
305 if (m_RelatedStatusBar
!= -1) m_RelatedFrame
->SetStatusText(_("Done"), m_RelatedStatusBar
);
309 if (m_HistoryOn
) // add this page to history there:
311 int c
= m_History
->GetCount() - (m_HistoryPos
+ 1);
313 if (m_HistoryPos
< 0 ||
314 (*m_History
)[m_HistoryPos
].GetPage() != m_OpenedPage
||
315 (*m_History
)[m_HistoryPos
].GetAnchor() != m_OpenedAnchor
)
318 for (int i
= 0; i
< c
; i
++)
319 m_History
->RemoveAt(m_HistoryPos
);
320 m_History
->Add(new wxHtmlHistoryItem(m_OpenedPage
, m_OpenedAnchor
));
324 if (m_OpenedPageTitle
== wxEmptyString
)
325 OnSetTitle(wxFileNameFromPath(m_OpenedPage
));
326 SetCursor(*wxSTANDARD_CURSOR
);
342 bool wxHtmlWindow::ScrollToAnchor(const wxString
& anchor
)
344 const wxHtmlCell
*c
= m_Cell
->Find(wxHTML_COND_ISANCHOR
, &anchor
);
347 wxLogWarning(_("HTML anchor %s does not exist."), anchor
.c_str());
354 for (y
= 0; c
!= NULL
; c
= c
->GetParent()) y
+= c
->GetPosY();
355 Scroll(-1, y
/ wxHTML_SCROLL_STEP
);
356 m_OpenedAnchor
= anchor
;
362 void wxHtmlWindow::OnSetTitle(const wxString
& title
)
367 tit
.Printf(m_TitleFormat
, title
.c_str());
368 m_RelatedFrame
->SetTitle(tit
);
370 m_OpenedPageTitle
= title
;
377 void wxHtmlWindow::CreateLayout()
379 int ClientWidth
, ClientHeight
;
383 if (m_Style
& wxHW_SCROLLBAR_NEVER
)
385 SetScrollbars(wxHTML_SCROLL_STEP
, 1, m_Cell
->GetWidth() / wxHTML_SCROLL_STEP
, 0); // always off
386 GetClientSize(&ClientWidth
, &ClientHeight
);
387 m_Cell
->Layout(ClientWidth
);
391 GetClientSize(&ClientWidth
, &ClientHeight
);
392 m_Cell
->Layout(ClientWidth
);
393 if (ClientHeight
< m_Cell
->GetHeight() + GetCharHeight())
396 wxHTML_SCROLL_STEP
, wxHTML_SCROLL_STEP
,
397 m_Cell
->GetWidth() / wxHTML_SCROLL_STEP
,
398 (m_Cell
->GetHeight() + GetCharHeight()) / wxHTML_SCROLL_STEP
399 /*cheat: top-level frag is always container*/);
401 else /* we fit into window, no need for scrollbars */
403 SetScrollbars(wxHTML_SCROLL_STEP
, 1, m_Cell
->GetWidth() / wxHTML_SCROLL_STEP
, 0); // disable...
404 GetClientSize(&ClientWidth
, &ClientHeight
);
405 m_Cell
->Layout(ClientWidth
); // ...and relayout
412 void wxHtmlWindow::ReadCustomization(wxConfigBase
*cfg
, wxString path
)
417 wxString p_fff
, p_ffn
;
419 if (path
!= wxEmptyString
)
421 oldpath
= cfg
->GetPath();
425 m_Borders
= cfg
->Read(wxT("wxHtmlWindow/Borders"), m_Borders
);
426 p_fff
= cfg
->Read(wxT("wxHtmlWindow/FontFaceFixed"), m_Parser
->m_FontFaceFixed
);
427 p_ffn
= cfg
->Read(wxT("wxHtmlWindow/FontFaceNormal"), m_Parser
->m_FontFaceNormal
);
428 for (int i
= 0; i
< 7; i
++)
430 tmp
.Printf(wxT("wxHtmlWindow/FontsSize%i"), i
);
431 p_fontsizes
[i
] = cfg
->Read(tmp
, m_Parser
->m_FontsSizes
[i
]);
433 SetFonts(p_ffn
, p_fff
, p_fontsizes
);
435 if (path
!= wxEmptyString
)
436 cfg
->SetPath(oldpath
);
441 void wxHtmlWindow::WriteCustomization(wxConfigBase
*cfg
, wxString path
)
446 if (path
!= wxEmptyString
)
448 oldpath
= cfg
->GetPath();
452 cfg
->Write(wxT("wxHtmlWindow/Borders"), (long) m_Borders
);
453 cfg
->Write(wxT("wxHtmlWindow/FontFaceFixed"), m_Parser
->m_FontFaceFixed
);
454 cfg
->Write(wxT("wxHtmlWindow/FontFaceNormal"), m_Parser
->m_FontFaceNormal
);
455 for (int i
= 0; i
< 7; i
++)
457 tmp
.Printf(wxT("wxHtmlWindow/FontsSize%i"), i
);
458 cfg
->Write(tmp
, (long) m_Parser
->m_FontsSizes
[i
]);
461 if (path
!= wxEmptyString
)
462 cfg
->SetPath(oldpath
);
467 bool wxHtmlWindow::HistoryBack()
471 if (m_HistoryPos
< 1) return FALSE
;
473 // store scroll position into history item:
475 GetViewStart(&x
, &y
);
476 (*m_History
)[m_HistoryPos
].SetPos(y
);
478 // go to previous position:
481 l
= (*m_History
)[m_HistoryPos
].GetPage();
482 a
= (*m_History
)[m_HistoryPos
].GetAnchor();
485 if (a
== wxEmptyString
) LoadPage(l
);
486 else LoadPage(l
+ wxT("#") + a
);
490 Scroll(0, (*m_History
)[m_HistoryPos
].GetPos());
495 bool wxHtmlWindow::HistoryCanBack()
497 if (m_HistoryPos
< 1) return FALSE
;
502 bool wxHtmlWindow::HistoryForward()
506 if (m_HistoryPos
== -1) return FALSE
;
507 if (m_HistoryPos
>= (int)m_History
->GetCount() - 1)return FALSE
;
509 m_OpenedPage
= wxEmptyString
; // this will disable adding new entry into history in LoadPage()
512 l
= (*m_History
)[m_HistoryPos
].GetPage();
513 a
= (*m_History
)[m_HistoryPos
].GetAnchor();
516 if (a
== wxEmptyString
) LoadPage(l
);
517 else LoadPage(l
+ wxT("#") + a
);
521 Scroll(0, (*m_History
)[m_HistoryPos
].GetPos());
526 bool wxHtmlWindow::HistoryCanForward()
528 if (m_HistoryPos
== -1) return FALSE
;
529 if (m_HistoryPos
>= (int)m_History
->GetCount() - 1)return FALSE
;
534 void wxHtmlWindow::HistoryClear()
540 void wxHtmlWindow::AddProcessor(wxHtmlProcessor
*processor
)
544 m_Processors
= new wxHtmlProcessorList
;
545 m_Processors
->DeleteContents(TRUE
);
547 wxHtmlProcessorList::Node
*node
;
549 for (node
= m_Processors
->GetFirst(); node
; node
= node
->GetNext())
551 if (processor
->GetPriority() > node
->GetData()->GetPriority())
553 m_Processors
->Insert(node
, processor
);
557 m_Processors
->Append(processor
);
560 /*static */ void wxHtmlWindow::AddGlobalProcessor(wxHtmlProcessor
*processor
)
562 if (!m_GlobalProcessors
)
564 m_GlobalProcessors
= new wxHtmlProcessorList
;
565 m_GlobalProcessors
->DeleteContents(TRUE
);
567 wxHtmlProcessorList::Node
*node
;
569 for (node
= m_GlobalProcessors
->GetFirst(); node
; node
= node
->GetNext())
571 if (processor
->GetPriority() > node
->GetData()->GetPriority())
573 m_GlobalProcessors
->Insert(node
, processor
);
577 m_GlobalProcessors
->Append(processor
);
582 wxList
wxHtmlWindow::m_Filters
;
583 wxHtmlFilter
*wxHtmlWindow::m_DefaultFilter
= NULL
;
584 wxCursor
*wxHtmlWindow::s_cur_hand
= NULL
;
585 wxCursor
*wxHtmlWindow::s_cur_arrow
= NULL
;
586 wxHtmlProcessorList
*wxHtmlWindow::m_GlobalProcessors
= NULL
;
588 void wxHtmlWindow::CleanUpStatics()
590 delete m_DefaultFilter
;
591 m_DefaultFilter
= NULL
;
592 m_Filters
.DeleteContents(TRUE
);
594 delete m_GlobalProcessors
;
595 m_GlobalProcessors
= NULL
;
602 void wxHtmlWindow::AddFilter(wxHtmlFilter
*filter
)
604 m_Filters
.Append(filter
);
610 void wxHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo
& link
)
612 LoadPage(link
.GetHref());
615 void wxHtmlWindow::OnCellClicked(wxHtmlCell
*cell
,
616 wxCoord x
, wxCoord y
,
617 const wxMouseEvent
& event
)
619 wxCHECK_RET( cell
, _T("can't be called with NULL cell") );
621 cell
->OnMouseClick(this, x
, y
, event
);
624 void wxHtmlWindow::OnCellMouseHover(wxHtmlCell
* WXUNUSED(cell
),
625 wxCoord
WXUNUSED(x
), wxCoord
WXUNUSED(y
))
630 void wxHtmlWindow::OnDraw(wxDC
& dc
)
633 wxRegionIterator
upd(GetUpdateRegion()); // get the update rect list
636 if (m_tmpCanDrawLocks
> 0) return;
638 dc
.SetMapMode(wxMM_TEXT
);
640 /* VS - I don't think this is neccessary any longer
641 MSC_VER 1200 means MSVC 6.0 and it works fine */
642 #if defined(_MSC_VER) && (_MSC_VER == 1200)
643 ::SetMapMode((HDC
)dc
.GetHDC(), MM_TEXT
);
646 dc
.SetBackgroundMode(wxTRANSPARENT
);
647 GetViewStart(&x
, &y
);
653 if (m_Cell
) m_Cell
->Draw(dc
, 0, 0, y
* wxHTML_SCROLL_STEP
+ v_y
, y
* wxHTML_SCROLL_STEP
+ v_h
+ v_y
);
661 void wxHtmlWindow::OnSize(wxSizeEvent
& event
)
663 wxScrolledWindow::OnSize(event
);
669 void wxHtmlWindow::OnMouseEvent(wxMouseEvent
& event
)
671 m_tmpMouseMoved
= TRUE
;
673 if (event
.ButtonDown())
678 GetViewStart(&sx
, &sy
);
679 sx
*= wxHTML_SCROLL_STEP
;
680 sy
*= wxHTML_SCROLL_STEP
;
682 wxPoint pos
= event
.GetPosition();
686 wxHtmlCell
*cell
= m_Cell
->FindCellByPos(pos
.x
, pos
.y
);
688 // VZ: is it possible that we don't find anything at all?
690 OnCellClicked(cell
, pos
.x
, pos
.y
, event
);
697 void wxHtmlWindow::OnIdle(wxIdleEvent
& WXUNUSED(event
))
699 if (s_cur_hand
== NULL
)
701 s_cur_hand
= new wxCursor(wxCURSOR_HAND
);
702 s_cur_arrow
= new wxCursor(wxCURSOR_ARROW
);
705 if (m_tmpMouseMoved
&& (m_Cell
!= NULL
))
708 GetViewStart(&sx
, &sy
);
709 sx
*= wxHTML_SCROLL_STEP
;
710 sy
*= wxHTML_SCROLL_STEP
;
713 wxGetMousePosition(&x
, &y
);
714 ScreenToClient(&x
, &y
);
718 wxHtmlCell
*cell
= m_Cell
->FindCellByPos(x
, y
);
719 if ( cell
!= m_tmpLastCell
)
721 wxHtmlLinkInfo
*lnk
= cell
? cell
->GetLink(x
, y
) : NULL
;
723 if (lnk
!= m_tmpLastLink
)
727 SetCursor(*s_cur_arrow
);
728 if (m_RelatedStatusBar
!= -1)
729 m_RelatedFrame
->SetStatusText(wxEmptyString
, m_RelatedStatusBar
);
733 SetCursor(*s_cur_hand
);
734 if (m_RelatedStatusBar
!= -1)
735 m_RelatedFrame
->SetStatusText(lnk
->GetHref(), m_RelatedStatusBar
);
740 m_tmpLastCell
= cell
;
742 else // mouse moved but stayed in the same cell
745 OnCellMouseHover(cell
, x
, y
);
748 m_tmpMouseMoved
= FALSE
;
753 IMPLEMENT_ABSTRACT_CLASS(wxHtmlProcessor
,wxObject
)
755 IMPLEMENT_DYNAMIC_CLASS(wxHtmlWindow
,wxScrolledWindow
)
757 BEGIN_EVENT_TABLE(wxHtmlWindow
, wxScrolledWindow
)
758 EVT_SIZE(wxHtmlWindow::OnSize
)
759 EVT_LEFT_DOWN(wxHtmlWindow::OnMouseEvent
)
760 EVT_RIGHT_DOWN(wxHtmlWindow::OnMouseEvent
)
761 EVT_MOTION(wxHtmlWindow::OnMouseEvent
)
762 EVT_IDLE(wxHtmlWindow::OnIdle
)
769 // A module to allow initialization/cleanup
770 // without calling these functions from app.cpp or from
771 // the user's application.
773 class wxHtmlWinModule
: public wxModule
775 DECLARE_DYNAMIC_CLASS(wxHtmlWinModule
)
777 wxHtmlWinModule() : wxModule() {}
778 bool OnInit() { return TRUE
; }
779 void OnExit() { wxHtmlWindow::CleanUpStatics(); }
782 IMPLEMENT_DYNAMIC_CLASS(wxHtmlWinModule
, wxModule
)
787 ///// default mod handlers are forced there: