X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/82a46104231c6b92a174812830fa8b1abce7ad48..04fa04d8067d235ab45b5bc05b65f0679634b541:/src/html/htmlwin.cpp?ds=sidebyside diff --git a/src/html/htmlwin.cpp b/src/html/htmlwin.cpp index 3ef8f9a1f9..1eefb4b3cb 100644 --- a/src/html/htmlwin.cpp +++ b/src/html/htmlwin.cpp @@ -31,17 +31,21 @@ #include "wx/html/htmlwin.h" #include "wx/html/htmlproc.h" #include "wx/clipbrd.h" +#include "wx/recguard.h" #include "wx/arrimpl.cpp" #include "wx/listimpl.cpp" +// uncomment this line to visually show the extent of the selection +//#define DEBUG_HTML_SELECTION + // HTML events: IMPLEMENT_DYNAMIC_CLASS(wxHtmlLinkEvent, wxCommandEvent) IMPLEMENT_DYNAMIC_CLASS(wxHtmlCellEvent, wxCommandEvent) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_HTML_CELL_CLICKED) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_HTML_CELL_HOVER) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_HTML_LINK_CLICKED) +wxDEFINE_EVENT( wxEVT_COMMAND_HTML_CELL_CLICKED, wxHtmlCellEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_HTML_CELL_HOVER, wxHtmlCellEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_HTML_LINK_CLICKED, wxHtmlLinkEvent ); #if wxUSE_CLIPBOARD @@ -71,7 +75,7 @@ private: int m_pos, m_orient; - DECLARE_NO_COPY_CLASS(wxHtmlWinAutoScrollTimer) + wxDECLARE_NO_COPY_CLASS(wxHtmlWinAutoScrollTimer); }; void wxHtmlWinAutoScrollTimer::Notify() @@ -244,7 +248,7 @@ bool wxHtmlWindowMouseHelper::OnCellClicked(wxHtmlCell *cell, { // if the event wasn't handled, do the default processing here: - wxASSERT_MSG( cell, _T("can't be called with NULL cell") ); + wxASSERT_MSG( cell, wxT("can't be called with NULL cell") ); cell->ProcessMouseClick(m_interface, ev.GetPoint(), ev.GetMouseEvent()); } @@ -312,8 +316,6 @@ void wxHtmlWindow::Init() m_timerAutoScroll = NULL; m_lastDoubleClick = 0; #endif // wxUSE_CLIPBOARD - m_backBuffer = NULL; - m_eraseBgInOnPaint = false; m_tmpSelFromCell = NULL; } @@ -326,7 +328,20 @@ bool wxHtmlWindow::Create(wxWindow *parent, wxWindowID id, name)) return false; + // We can't erase our background in EVT_ERASE_BACKGROUND handler and use + // double buffering in EVT_PAINT handler as this requires blitting back + // something already drawn on the window to the backing store bitmap when + // handling EVT_PAINT but blitting in this direction is simply not + // supported by OS X. + // + // So instead we use a hack with artificial EVT_ERASE_BACKGROUND generation + // from OnPaint() and this means that we never need the "real" erase event + // at all so disable it to avoid executing any user-defined handlers twice + // (and to avoid processing unnecessary event if no handlers are defined). + SetBackgroundStyle(wxBG_STYLE_PAINT); SetPage(wxT("")); + + SetInitialSize(size); return true; } @@ -351,7 +366,6 @@ wxHtmlWindow::~wxHtmlWindow() delete m_FS; delete m_History; delete m_Processors; - delete m_backBuffer; } @@ -455,11 +469,13 @@ bool wxHtmlWindow::DoSetPage(const wxString& source) SetBackgroundImage(wxNullBitmap); m_Parser->SetDC(dc); - if (m_Cell) - { - delete m_Cell; - m_Cell = NULL; - } + + // notice that it's important to set m_Cell to NULL here before calling + // Parse() below, even if it will be overwritten by its return value as + // without this we may crash if it's used from inside Parse(), so use + // wxDELETE() and not just delete here + wxDELETE(m_Cell); + m_Cell = (wxHtmlContainerCell*) m_Parser->Parse(newsrc); delete dc; m_Cell->SetIndent(m_Borders, wxHTML_INDENT_ALL, wxHTML_UNITS_PIXELS); @@ -641,6 +657,16 @@ bool wxHtmlWindow::ScrollToAnchor(const wxString& anchor) } else { + // Go to next visible cell in current container, if it exists. This + // yields a bit better (even though still imperfect) results in that + // there's better chance of using a suitable cell for upper Y + // coordinate value. See bug #11406 for additional discussion. + const wxHtmlCell *c_save = c; + while ( c && c->IsFormattingCell() ) + c = c->GetNext(); + if ( !c ) + c = c_save; + int y; for (y = 0; c != NULL; c = c->GetParent()) y += c->GetPosY(); @@ -663,44 +689,116 @@ void wxHtmlWindow::OnSetTitle(const wxString& title) } - +// return scroll steps such that a) scrollbars aren't shown needlessly +// and b) entire content is viewable (i.e. round up) +static int ScrollSteps(int size, int available) +{ + if ( size <= available ) + return 0; + else + return (size + wxHTML_SCROLL_STEP - 1) / wxHTML_SCROLL_STEP; +} void wxHtmlWindow::CreateLayout() { - int ClientWidth, ClientHeight; + // SetScrollbars() results in size change events -- and thus a nested + // CreateLayout() call -- on some platforms. Ignore nested calls, toplevel + // CreateLayout() will do the right thing eventually. + static wxRecursionGuardFlag s_flagReentrancy; + wxRecursionGuard guard(s_flagReentrancy); + if ( guard.IsInside() ) + return; + + if (!m_Cell) + return; + + int clientWidth, clientHeight; + GetClientSize(&clientWidth, &clientHeight); + + const int vscrollbar = wxSystemSettings::GetMetric(wxSYS_VSCROLL_X); + const int hscrollbar = wxSystemSettings::GetMetric(wxSYS_HSCROLL_Y); - if (!m_Cell) return; + if ( HasScrollbar(wxHORIZONTAL) ) + clientHeight += hscrollbar; + + if ( HasScrollbar(wxVERTICAL) ) + clientWidth += vscrollbar; if ( HasFlag(wxHW_SCROLLBAR_NEVER) ) { SetScrollbars(1, 1, 0, 0); // always off - GetClientSize(&ClientWidth, &ClientHeight); - m_Cell->Layout(ClientWidth); + m_Cell->Layout(clientWidth); } else // !wxHW_SCROLLBAR_NEVER { - GetClientSize(&ClientWidth, &ClientHeight); - m_Cell->Layout(ClientWidth); - if (ClientHeight < m_Cell->GetHeight() + GetCharHeight()) + // Lay the content out with the assumption that it's too large to fit + // in the window (this is likely to be the case): + m_Cell->Layout(clientWidth - vscrollbar); + + // If the layout is wider than the window, horizontal scrollbar will + // certainly be shown. Account for it here for subsequent computations. + if ( m_Cell->GetWidth() > clientWidth ) + clientHeight -= hscrollbar; + + if ( m_Cell->GetHeight() <= clientHeight ) { - SetScrollbars( - wxHTML_SCROLL_STEP, wxHTML_SCROLL_STEP, - m_Cell->GetWidth() / wxHTML_SCROLL_STEP, - (m_Cell->GetHeight() + GetCharHeight()) / wxHTML_SCROLL_STEP - /*cheat: top-level frag is always container*/); + // we fit into the window, hide vertical scrollbar: + SetScrollbars + ( + wxHTML_SCROLL_STEP, wxHTML_SCROLL_STEP, + ScrollSteps(m_Cell->GetWidth(), clientWidth - vscrollbar), + 0 + ); + // ...and redo the layout to use the extra space + m_Cell->Layout(clientWidth); } - else /* we fit into window, no need for scrollbars */ + else { - SetScrollbars(wxHTML_SCROLL_STEP, 1, m_Cell->GetWidth() / wxHTML_SCROLL_STEP, 0); // disable... - GetClientSize(&ClientWidth, &ClientHeight); - m_Cell->Layout(ClientWidth); // ...and relayout + // If the content doesn't fit into the window by only a small + // margin, chances are that it may fit fully with scrollbar turned + // off. It's something worth trying but on the other hand, we don't + // want to waste too much time redoing the layout (twice!) for + // long -- and thus expensive to layout -- pages. The cut-off value + // is an arbitrary heuristics. + static const int SMALL_OVERLAP = 60; + if ( m_Cell->GetHeight() <= clientHeight + SMALL_OVERLAP ) + { + m_Cell->Layout(clientWidth); + + if ( m_Cell->GetHeight() <= clientHeight ) + { + // Great, we fit in. Hide the scrollbar. + SetScrollbars + ( + wxHTML_SCROLL_STEP, wxHTML_SCROLL_STEP, + ScrollSteps(m_Cell->GetWidth(), clientWidth), + 0 + ); + return; + } + else + { + // That didn't work out, go back to previous layout. Note + // that redoing the layout once again here isn't as bad as + // it looks -- thanks to the small cut-off value, it's a + // reasonably small page. + m_Cell->Layout(clientWidth - vscrollbar); + } + } + // else: the page is very long, it will certainly need scrollbar + + SetScrollbars + ( + wxHTML_SCROLL_STEP, wxHTML_SCROLL_STEP, + ScrollSteps(m_Cell->GetWidth(), clientWidth - vscrollbar), + ScrollSteps(m_Cell->GetHeight(), clientHeight) + ); } } } - - +#if wxUSE_CONFIG void wxHtmlWindow::ReadCustomization(wxConfigBase *cfg, wxString path) { wxString oldpath; @@ -753,8 +851,7 @@ void wxHtmlWindow::WriteCustomization(wxConfigBase *cfg, wxString path) if (path != wxEmptyString) cfg->SetPath(oldpath); } - - +#endif // wxUSE_CONFIG bool wxHtmlWindow::HistoryBack() { @@ -890,21 +987,27 @@ wxString wxHtmlWindow::DoSelectionToText(wxHtmlSelection *sel) return wxEmptyString; wxClientDC dc(this); - - const wxHtmlCell *end = sel->GetToCell(); wxString text; - wxHtmlTerminalCellsInterator i(sel->GetFromCell(), end); - if ( i ) - { - text << i->ConvertToText(sel); - ++i; - } - const wxHtmlCell *prev = *i; + + wxHtmlTerminalCellsInterator i(sel->GetFromCell(), sel->GetToCell()); + const wxHtmlCell *prev = NULL; + while ( i ) { - if ( prev->GetParent() != i->GetParent() ) - text << _T('\n'); - text << i->ConvertToText(*i == end ? sel : NULL); + // When converting HTML content to plain text, the entire paragraph + // (container in wxHTML) goes on single line. A new paragraph (that + // should go on its own line) has its own container. Therefore, the + // simplest way of detecting where to insert newlines in plain text + // is to check if the parent container changed -- if it did, we moved + // to a new paragraph. + if ( prev && prev->GetParent() != i->GetParent() ) + text << '\n'; + + // NB: we don't need to pass the selection to ConvertToText() in the + // middle of the selected text; it's only useful when only part of + // a cell is selected + text << i->ConvertToText(sel); + prev = *i; ++i; } @@ -946,7 +1049,7 @@ bool wxHtmlWindow::CopySelection(ClipboardType t) const wxString txt(SelectionToText()); wxTheClipboard->SetData(new wxTextDataObject(txt)); wxTheClipboard->Close(); - wxLogTrace(_T("wxhtmlselection"), + wxLogTrace(wxT("wxhtmlselection"), _("Copied to clipboard:\"%s\""), txt.c_str()); return true; @@ -973,90 +1076,90 @@ void wxHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo& link) } } -void wxHtmlWindow::OnEraseBackground(wxEraseEvent& event) +void wxHtmlWindow::DoEraseBackground(wxDC& dc) { - if ( !m_bmpBg.Ok() ) + // if we don't have any background bitmap we just fill it with background + // colour and we also must do it if the background bitmap is not fully + // opaque as otherwise junk could be left there + if ( !m_bmpBg.IsOk() || m_bmpBg.GetMask() ) { - // don't even skip the event, if we don't have a bg bitmap we're going - // to overwrite background in OnPaint() below anyhow, so letting the - // default handling take place would only result in flicker, just set a - // flag to erase the background below - m_eraseBgInOnPaint = true; - return; - } - - wxDC& dc = *event.GetDC(); - - // if the image is not fully opaque, we have to erase the background before - // drawing it, however avoid doing it for opaque images as this would just - // result in extra flicker without any other effect as background is - // completely covered anyhow - if ( m_bmpBg.GetMask() ) - { - dc.SetBackground(wxBrush(GetBackgroundColour(), wxBRUSHSTYLE_SOLID)); + dc.SetBackground(GetBackgroundColour()); dc.Clear(); } - const wxSize sizeWin(GetClientSize()); - const wxSize sizeBmp(m_bmpBg.GetWidth(), m_bmpBg.GetHeight()); - for ( wxCoord x = 0; x < sizeWin.x; x += sizeBmp.x ) + if ( m_bmpBg.IsOk() ) { - for ( wxCoord y = 0; y < sizeWin.y; y += sizeBmp.y ) + // draw the background bitmap tiling it over the entire window area + const wxSize sz = GetClientSize(); + const wxSize sizeBmp(m_bmpBg.GetWidth(), m_bmpBg.GetHeight()); + for ( wxCoord x = 0; x < sz.x; x += sizeBmp.x ) { - dc.DrawBitmap(m_bmpBg, x, y, true /* use mask */); + for ( wxCoord y = 0; y < sz.y; y += sizeBmp.y ) + { + dc.DrawBitmap(m_bmpBg, x, y, true /* use mask */); + } } } } void wxHtmlWindow::OnPaint(wxPaintEvent& WXUNUSED(event)) { - wxPaintDC dc(this); + wxPaintDC dcPaint(this); if (m_tmpCanDrawLocks > 0 || m_Cell == NULL) return; int x, y; GetViewStart(&x, &y); - wxRect rect = GetUpdateRegion().GetBox(); - wxSize sz = GetSize(); - + const wxRect rect = GetUpdateRegion().GetBox(); + const wxSize sz = GetClientSize(); + + // set up the DC we're drawing on: if the window is already double buffered + // we do it directly on wxPaintDC, otherwise we allocate a backing store + // buffer and compose the drawing there and then blit it to screen all at + // once + wxDC *dc; wxMemoryDC dcm; - if ( !m_backBuffer ) - m_backBuffer = new wxBitmap(sz.x, sz.y); - dcm.SelectObject(*m_backBuffer); - - if ( m_eraseBgInOnPaint ) + if ( IsDoubleBuffered() ) { - dcm.SetBackground(wxBrush(GetBackgroundColour(), wxBRUSHSTYLE_SOLID)); - dcm.Clear(); - - m_eraseBgInOnPaint = false; + dc = &dcPaint; + } + else // window is not double buffered by the system, do it ourselves + { + if ( !m_backBuffer.IsOk() ) + m_backBuffer.Create(sz.x, sz.y); + dcm.SelectObject(m_backBuffer); + dc = &dcm; } - else // someone has already erased the background, keep it + + PrepareDC(*dc); + + // erase the background: for compatibility, we must generate the event to + // allow the user-defined handlers to do it + wxEraseEvent eraseEvent(GetId(), dc); + eraseEvent.SetEventObject(this); + if ( !ProcessWindowEvent(eraseEvent) ) { - // preserve the existing background, otherwise we'd erase anything the - // user code had drawn in its EVT_ERASE_BACKGROUND handler when we do - // the Blit back below - dcm.Blit(0, rect.GetTop(), - sz.x, rect.GetBottom() - rect.GetTop() + 1, - &dc, - 0, rect.GetTop()); + // erase background ourselves + DoEraseBackground(*dc); } + //else: background erased by the user-defined handler - PrepareDC(dcm); - dcm.SetMapMode(wxMM_TEXT); - dcm.SetBackgroundMode(wxBRUSHSTYLE_TRANSPARENT); + + // draw the HTML window contents + dc->SetMapMode(wxMM_TEXT); + dc->SetBackgroundMode(wxBRUSHSTYLE_TRANSPARENT); + dc->SetLayoutDirection(GetLayoutDirection()); wxHtmlRenderingInfo rinfo; wxDefaultHtmlRenderingStyle rstyle; rinfo.SetSelection(m_selection); rinfo.SetStyle(&rstyle); - m_Cell->Draw(dcm, 0, 0, + m_Cell->Draw(*dc, 0, 0, y * wxHTML_SCROLL_STEP + rect.GetTop(), y * wxHTML_SCROLL_STEP + rect.GetBottom(), rinfo); -//#define DEBUG_HTML_SELECTION #ifdef DEBUG_HTML_SELECTION { int xc, yc, x, y; @@ -1069,27 +1172,30 @@ void wxHtmlWindow::OnPaint(wxPaintEvent& WXUNUSED(event)) wxHtmlCell *after = m_Cell->FindCellByPos(x, y, wxHTML_FIND_NEAREST_AFTER); - dcm.SetBrush(*wxTRANSPARENT_BRUSH); - dcm.SetPen(*wxBLACK_PEN); + dc->SetBrush(*wxTRANSPARENT_BRUSH); + dc->SetPen(*wxBLACK_PEN); if (at) - dcm.DrawRectangle(at->GetAbsPos(), + dc->DrawRectangle(at->GetAbsPos(), wxSize(at->GetWidth(),at->GetHeight())); - dcm.SetPen(*wxGREEN_PEN); + dc->SetPen(*wxGREEN_PEN); if (before) - dcm.DrawRectangle(before->GetAbsPos().x+1, before->GetAbsPos().y+1, + dc->DrawRectangle(before->GetAbsPos().x+1, before->GetAbsPos().y+1, before->GetWidth()-2,before->GetHeight()-2); - dcm.SetPen(*wxRED_PEN); + dc->SetPen(*wxRED_PEN); if (after) - dcm.DrawRectangle(after->GetAbsPos().x+2, after->GetAbsPos().y+2, + dc->DrawRectangle(after->GetAbsPos().x+2, after->GetAbsPos().y+2, after->GetWidth()-4,after->GetHeight()-4); } -#endif +#endif // DEBUG_HTML_SELECTION - dcm.SetDeviceOrigin(0,0); - dc.Blit(0, rect.GetTop(), - sz.x, rect.GetBottom() - rect.GetTop() + 1, - &dcm, - 0, rect.GetTop()); + if ( dc != &dcPaint ) + { + dc->SetDeviceOrigin(0,0); + dcPaint.Blit(0, rect.GetTop(), + sz.x, rect.GetBottom() - rect.GetTop() + 1, + dc, + 0, rect.GetTop()); + } } @@ -1097,9 +1203,10 @@ void wxHtmlWindow::OnPaint(wxPaintEvent& WXUNUSED(event)) void wxHtmlWindow::OnSize(wxSizeEvent& event) { - wxDELETE(m_backBuffer); + event.Skip(); + + m_backBuffer = wxNullBitmap; - wxScrolledWindow::OnSize(event); CreateLayout(); // Recompute selection if necessary: @@ -1382,7 +1489,7 @@ void wxHtmlWindow::OnMouseLeave(wxMouseEvent& event) // but seems to happen sometimes under wxMSW - maybe it's a bug // there but for now just ignore it - //wxFAIL_MSG( _T("can't understand where has mouse gone") ); + //wxFAIL_MSG( wxT("can't understand where has mouse gone") ); return; } @@ -1469,7 +1576,7 @@ void wxHtmlWindow::SelectLine(const wxPoint& pos) { // We use following heuristic to find a "line": let the line be all // cells in same container as the cell under mouse cursor that are - // neither completely above nor completely bellow the clicked cell + // neither completely above nor completely below the clicked cell // (i.e. are likely to be words positioned on same line of text). int y1 = cell->GetAbsPos().y; @@ -1533,9 +1640,6 @@ void wxHtmlWindow::SelectAll() IMPLEMENT_ABSTRACT_CLASS(wxHtmlProcessor,wxObject) -#if wxUSE_EXTENDED_RTTI -IMPLEMENT_DYNAMIC_CLASS_XTI(wxHtmlWindow, wxScrolledWindow,"wx/html/htmlwin.h") - wxBEGIN_PROPERTIES_TABLE(wxHtmlWindow) /* TODO PROPERTIES @@ -1550,9 +1654,8 @@ wxBEGIN_HANDLERS_TABLE(wxHtmlWindow) wxEND_HANDLERS_TABLE() wxCONSTRUCTOR_5( wxHtmlWindow , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size , long , WindowStyle ) -#else -IMPLEMENT_DYNAMIC_CLASS(wxHtmlWindow,wxScrolledWindow) -#endif + +wxIMPLEMENT_DYNAMIC_CLASS_XTI(wxHtmlWindow, wxScrolledWindow,"wx/html/htmlwin.h") BEGIN_EVENT_TABLE(wxHtmlWindow, wxScrolledWindow) EVT_SIZE(wxHtmlWindow::OnSize) @@ -1560,7 +1663,6 @@ BEGIN_EVENT_TABLE(wxHtmlWindow, wxScrolledWindow) EVT_LEFT_UP(wxHtmlWindow::OnMouseUp) EVT_RIGHT_UP(wxHtmlWindow::OnMouseUp) EVT_MOTION(wxHtmlWindow::OnMouseMove) - EVT_ERASE_BACKGROUND(wxHtmlWindow::OnEraseBackground) EVT_PAINT(wxHtmlWindow::OnPaint) #if wxUSE_CLIPBOARD EVT_LEFT_DCLICK(wxHtmlWindow::OnDoubleClick)