src/html/htmlwin.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        htmlwin.cpp
   3 // Purpose:     wxHtmlWindow class for parsing & displaying HTML (implementation)
   4 // Author:      Vaclav Slavik
   5 // RCS-ID:      $Id$
   6 // Copyright:   (c) 1999 Vaclav Slavik
   7 // Licence:     wxWindows Licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10
  11 #ifdef __GNUG__
  12 #pragma implementation
  13 #endif
  14
  15 #include "wx/wxprec.h"
  16
  17 #include "wx/defs.h"
  18 #if wxUSE_HTML
  19
  20 #ifdef __BORDLANDC__
  21 #pragma hdrstop
  22 #endif
  23
  24 #ifndef WXPRECOMP
  25 #include "wx/wx.h"
  26 #endif
  27
  28 #include "wx/html/htmlwin.h"
  29 #include "wx/html/forcelnk.h"
  30 #include "wx/log.h"
  31
  32
  33 //-----------------------------------------------------------------------------
  34 // wxHtmlWindow
  35 //-----------------------------------------------------------------------------
  36
  37
  38
  39 #include "wx/arrimpl.cpp"
  40 WX_DEFINE_OBJARRAY(HtmlHistoryArray)
  41
  42
  43 wxHtmlWindow::wxHtmlWindow(wxWindow *parent, wxWindowID id, const wxPoint& pos, const wxSize& size,
  44                 long style, const wxString& name) : wxScrolledWindow(parent, id, pos, size, wxVSCROLL | wxHSCROLL, name)
  45 {
  46     m_tmpMouseMoved = FALSE;
  47     m_tmpLastLink = NULL;
  48     m_tmpCanDrawLocks = 0;
  49     m_FS = new wxFileSystem();
  50     m_RelatedStatusBar = -1;
  51     m_RelatedFrame = NULL;
  52     m_TitleFormat = "%s";
  53     m_OpenedPage = m_OpenedAnchor = m_OpenedPageTitle = wxEmptyString;
  54     m_Cell = NULL;
  55     m_Parser = new wxHtmlWinParser(this);
  56     m_Parser -> SetFS(m_FS);
  57     SetBorders(10);
  58     m_HistoryPos = -1;
  59     m_HistoryOn = TRUE;
  60     m_Style = style;
  61     SetPage("<html><body></body></html>");
  62 }
  63
  64
  65
  66 wxHtmlWindow::~wxHtmlWindow()
  67 {
  68     HistoryClear();
  69
  70     if (m_Cell) delete m_Cell;
  71
  72     delete m_Parser;
  73     delete m_FS;
  74 }
  75
  76
  77
  78 void wxHtmlWindow::SetRelatedFrame(wxFrame* frame, const wxString& format)
  79 {
  80     m_RelatedFrame = frame;
  81     m_TitleFormat = format;
  82 }
  83
  84
  85
  86 void wxHtmlWindow::SetRelatedStatusBar(int bar)
  87 {
  88     m_RelatedStatusBar = bar;
  89 }
  90
  91
  92
  93 void wxHtmlWindow::SetFonts(wxString normal_face, wxString fixed_face, const int *sizes)
  94 {
  95     wxString op = m_OpenedPage;
  96
  97     m_Parser -> SetFonts(normal_face, fixed_face, sizes);
  98     SetPage(wxT("<html><body></body></html>")); // fonts changed => contents invalid
  99     if (!op.IsEmpty()) LoadPage(op);
 100 }
 101
 102
 103
 104 bool wxHtmlWindow::SetPage(const wxString& source)
 105 {
 106     wxClientDC *dc = new wxClientDC(this);
 107
 108     dc -> SetMapMode(wxMM_TEXT);
 109     SetBackgroundColour(wxColour(0xFF, 0xFF, 0xFF));
 110     m_OpenedPage = m_OpenedAnchor = m_OpenedPageTitle = wxEmptyString;
 111     m_Parser -> SetDC(dc);
 112     if (m_Cell) {
 113         delete m_Cell;
 114         m_Cell = NULL;
 115     }
 116     m_Cell = (wxHtmlContainerCell*) m_Parser -> Parse(source);
 117     delete dc;
 118     m_Cell -> SetIndent(m_Borders, wxHTML_INDENT_ALL, wxHTML_UNITS_PIXELS);
 119     m_Cell -> SetAlignHor(wxHTML_ALIGN_CENTER);
 120     CreateLayout();
 121     if (m_tmpCanDrawLocks == 0) Refresh();
 122     return TRUE;
 123 }
 124
 125
 126 bool wxHtmlWindow::LoadPage(const wxString& location)
 127 {
 128     wxFSFile *f;
 129     bool rt_val;
 130     bool needs_refresh = FALSE;
 131
 132     SetCursor(*wxHOURGLASS_CURSOR);
 133     wxYield(); Refresh(FALSE);
 134
 135     m_tmpCanDrawLocks++;
 136     if (m_HistoryOn && (m_HistoryPos != -1)) { // store scroll position into history item
 137         int x, y;
 138         ViewStart(&x, &y);
 139         m_History[m_HistoryPos].SetPos(y);
 140     }
 141
 142     if (location[0] == wxT('#')) { // local anchor
 143         wxString anch = location.Mid(1) /*1 to end*/;
 144         m_tmpCanDrawLocks--;
 145         rt_val = ScrollToAnchor(anch);
 146         m_tmpCanDrawLocks++;
 147     }
 148     else if (location.Find(wxT('#')) != wxNOT_FOUND && location.BeforeFirst(wxT('#')) == m_OpenedPage) {
 149         wxString anch = location.AfterFirst(wxT('#'));
 150         m_tmpCanDrawLocks--;
 151         rt_val = ScrollToAnchor(anch);
 152         m_tmpCanDrawLocks++;
 153     }
 154     else if (location.Find(wxT('#')) != wxNOT_FOUND &&
 155              (m_FS -> GetPath() + location.BeforeFirst(wxT('#'))) == m_OpenedPage) {
 156         wxString anch = location.AfterFirst(wxT('#'));
 157         m_tmpCanDrawLocks--;
 158         rt_val = ScrollToAnchor(anch);
 159         m_tmpCanDrawLocks++;
 160     }
 161
 162     else {
 163         needs_refresh = TRUE;
 164         // load&display it:
 165         if (m_RelatedStatusBar != -1) {
 166             m_RelatedFrame -> SetStatusText(_("Connecting..."), m_RelatedStatusBar);
 167             Refresh(FALSE);
 168         }
 169
 170         f = m_FS -> OpenFile(location);
 171
 172         if (f == NULL) {
 173             wxString err;
 174
 175             wxLogError(_("Unable to open requested HTML document: %s"), location.mb_str());
 176             m_tmpCanDrawLocks--;
 177
 178             SetCursor(*wxSTANDARD_CURSOR);
 179             return FALSE;
 180         }
 181
 182         else {
 183             wxNode *node;
 184             wxString src = wxEmptyString;
 185
 186             if (m_RelatedStatusBar != -1) {
 187                 wxString msg = _("Loading : ") + location;
 188                 m_RelatedFrame -> SetStatusText(msg, m_RelatedStatusBar);
 189                 Refresh(FALSE);
 190             }
 191
 192             node = m_Filters.GetFirst();
 193             while (node){
 194                 wxHtmlFilter *h = (wxHtmlFilter*) node -> GetData();
 195                 if (h -> CanRead(*f)) {
 196                     src = h -> ReadFile(*f);
 197                     break;
 198                 }
 199                 node = node -> GetNext();
 200             }
 201             if (src == wxEmptyString) {
 202                 if (m_DefaultFilter == NULL) m_DefaultFilter = GetDefaultFilter();
 203                 src = m_DefaultFilter -> ReadFile(*f);
 204             }
 205
 206             m_FS -> ChangePathTo(f -> GetLocation());
 207             rt_val = SetPage(src);
 208             m_OpenedPage = f -> GetLocation();
 209             if (f -> GetAnchor() != wxEmptyString) {
 210                 wxYield();
 211                 ScrollToAnchor(f -> GetAnchor());
 212             }
 213
 214             delete f;
 215
 216             if (m_RelatedStatusBar != -1) m_RelatedFrame -> SetStatusText(_("Done"), m_RelatedStatusBar);
 217         }
 218     }
 219
 220     if (m_HistoryOn) { // add this page to history there:
 221         int c = m_History.GetCount() - (m_HistoryPos + 1);
 222
 223         m_HistoryPos++;
 224         for (int i = 0; i < c; i++)
 225             m_History.Remove(m_HistoryPos);
 226         m_History.Add(new HtmlHistoryItem(m_OpenedPage, m_OpenedAnchor));
 227     }
 228
 229     if (m_OpenedPageTitle == wxEmptyString)
 230         OnSetTitle(wxFileNameFromPath(m_OpenedPage));
 231     SetCursor(*wxSTANDARD_CURSOR);
 232
 233     if (needs_refresh) {
 234         wxYield();
 235         m_tmpCanDrawLocks--;
 236         Refresh();
 237     }
 238     else
 239         m_tmpCanDrawLocks--;
 240
 241     return rt_val;
 242 }
 243
 244
 245
 246 bool wxHtmlWindow::ScrollToAnchor(const wxString& anchor)
 247 {
 248     const wxHtmlCell *c = m_Cell -> Find(wxHTML_COND_ISANCHOR, &anchor);
 249     if (!c)
 250     {
 251         wxLogWarning(_("HTML anchor %s does not exist."), anchor.mb_str());
 252         return FALSE;
 253     }
 254     else {
 255         int y;
 256
 257         for (y = 0; c != NULL; c = c -> GetParent()) y += c -> GetPosY();
 258         Scroll(-1, y / wxHTML_SCROLL_STEP);
 259         m_OpenedAnchor = anchor;
 260         return TRUE;
 261     }
 262 }
 263
 264
 265 void wxHtmlWindow::OnSetTitle(const wxString& title)
 266 {
 267     if (m_RelatedFrame) {
 268         wxString tit;
 269         tit.Printf(m_TitleFormat, title.c_str());
 270         m_RelatedFrame -> SetTitle(tit);
 271     }
 272     m_OpenedPageTitle = title;
 273 }
 274
 275
 276
 277
 278
 279 void wxHtmlWindow::CreateLayout()
 280 {
 281     int ClientWidth, ClientHeight;
 282
 283     if (!m_Cell) return;
 284
 285     if (m_Style == wxHW_SCROLLBAR_NEVER) {
 286         SetScrollbars(wxHTML_SCROLL_STEP, 1, m_Cell -> GetWidth() / wxHTML_SCROLL_STEP, 0); // always off
 287         GetClientSize(&ClientWidth, &ClientHeight);
 288         m_Cell -> Layout(ClientWidth);
 289     }
 290
 291     else {
 292         GetClientSize(&ClientWidth, &ClientHeight);
 293         m_Cell -> Layout(ClientWidth);
 294         if (ClientHeight < m_Cell -> GetHeight() + GetCharHeight()) {
 295             SetScrollbars(
 296                   wxHTML_SCROLL_STEP, wxHTML_SCROLL_STEP,
 297                   m_Cell -> GetWidth() / wxHTML_SCROLL_STEP,
 298                   (m_Cell -> GetHeight() + GetCharHeight()) / wxHTML_SCROLL_STEP
 299                   /*cheat: top-level frag is always container*/);
 300         }
 301         else { /* we fit into window, no need for scrollbars */
 302             SetScrollbars(wxHTML_SCROLL_STEP, 1, m_Cell -> GetWidth() / wxHTML_SCROLL_STEP, 0); // disable...
 303             GetClientSize(&ClientWidth, &ClientHeight);
 304             m_Cell -> Layout(ClientWidth); // ...and relayout
 305         }
 306     }
 307 }
 308
 309
 310
 311 void wxHtmlWindow::ReadCustomization(wxConfigBase *cfg, wxString path)
 312 {
 313     wxString oldpath;
 314     wxString tmp;
 315     int p_fontsizes[7];
 316     wxString p_fff, p_ffn;
 317
 318     if (path != wxEmptyString) {
 319         oldpath = cfg -> GetPath();
 320         cfg -> SetPath(path);
 321     }
 322
 323     m_Borders = cfg -> Read("wxHtmlWindow/Borders", m_Borders);
 324     p_fff = cfg -> Read("wxHtmlWindow/FontFaceFixed", m_Parser -> m_FontFaceFixed);
 325     p_ffn = cfg -> Read("wxHtmlWindow/FontFaceNormal", m_Parser -> m_FontFaceNormal);
 326     for (int i = 0; i < 7; i++) {
 327         tmp.Printf(wxT("wxHtmlWindow/FontsSize%i"), i);
 328         p_fontsizes[i] = cfg -> Read(tmp, m_Parser -> m_FontsSizes[i]);
 329     }
 330     SetFonts(p_ffn, p_fff, p_fontsizes);
 331
 332     if (path != wxEmptyString)
 333         cfg -> SetPath(oldpath);
 334 }
 335
 336
 337
 338 void wxHtmlWindow::WriteCustomization(wxConfigBase *cfg, wxString path)
 339 {
 340     wxString oldpath;
 341     wxString tmp;
 342
 343     if (path != wxEmptyString) {
 344         oldpath = cfg -> GetPath();
 345         cfg -> SetPath(path);
 346     }
 347
 348     cfg -> Write("wxHtmlWindow/Borders", (long) m_Borders);
 349     cfg -> Write("wxHtmlWindow/FontFaceFixed", m_Parser -> m_FontFaceFixed);
 350     cfg -> Write("wxHtmlWindow/FontFaceNormal", m_Parser -> m_FontFaceNormal);
 351     for (int i = 0; i < 7; i++) {
 352         tmp.Printf(wxT("wxHtmlWindow/FontsSize%i"), i);
 353         cfg -> Write(tmp, (long) m_Parser -> m_FontsSizes[i]);
 354     }
 355
 356     if (path != wxEmptyString)
 357         cfg -> SetPath(oldpath);
 358 }
 359
 360
 361
 362 bool wxHtmlWindow::HistoryBack()
 363 {
 364     wxString a, l;
 365
 366     if (m_HistoryPos < 1) return FALSE;
 367
 368     m_HistoryPos--;
 369
 370     l = m_History[m_HistoryPos].GetPage();
 371     a = m_History[m_HistoryPos].GetAnchor();
 372     m_HistoryOn = FALSE;
 373     m_tmpCanDrawLocks++;
 374     if (a == wxEmptyString) LoadPage(l);
 375     else LoadPage(l + wxT("#") + a);
 376     m_HistoryOn = TRUE;
 377     wxYield();
 378     m_tmpCanDrawLocks--;
 379     Scroll(0, m_History[m_HistoryPos].GetPos());
 380     Refresh();
 381     return TRUE;
 382 }
 383
 384
 385
 386 bool wxHtmlWindow::HistoryForward()
 387 {
 388     wxString a, l;
 389
 390     if (m_HistoryPos == -1) return FALSE;
 391     if (m_HistoryPos >= (int)m_History.GetCount() - 1)return FALSE;
 392
 393     m_OpenedPage = wxEmptyString; // this will disable adding new entry into history in LoadPage()
 394
 395     m_HistoryPos++;
 396     l = m_History[m_HistoryPos].GetPage();
 397     a = m_History[m_HistoryPos].GetAnchor();
 398     m_HistoryOn = FALSE;
 399     m_tmpCanDrawLocks++;
 400     if (a == wxEmptyString) LoadPage(l);
 401     else LoadPage(l + wxT("#") + a);
 402     m_HistoryOn = TRUE;
 403     wxYield();
 404     m_tmpCanDrawLocks--;
 405     Scroll(0, m_History[m_HistoryPos].GetPos());
 406     Refresh();
 407     return TRUE;
 408 }
 409
 410
 411
 412 void wxHtmlWindow::HistoryClear()
 413 {
 414     m_History.Empty();
 415     m_HistoryPos = -1;
 416 }
 417
 418
 419
 420 wxList wxHtmlWindow::m_Filters;
 421 wxHtmlFilter *wxHtmlWindow::m_DefaultFilter = NULL;
 422 wxCursor *wxHtmlWindow::s_cur_hand = NULL;
 423 wxCursor *wxHtmlWindow::s_cur_arrow = NULL;
 424
 425 void wxHtmlWindow::CleanUpStatics()
 426 {
 427     if (m_DefaultFilter) delete m_DefaultFilter;
 428     m_DefaultFilter = NULL;
 429     m_Filters.DeleteContents(TRUE);
 430     m_Filters.Clear();
 431     if (s_cur_hand) delete s_cur_hand;
 432     if (s_cur_arrow) delete s_cur_arrow;
 433 }
 434
 435
 436
 437 void wxHtmlWindow::AddFilter(wxHtmlFilter *filter)
 438 {
 439     m_Filters.Append(filter);
 440 }
 441
 442
 443
 444
 445 void wxHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo& link)
 446 {
 447     LoadPage(link.GetHref());
 448 }
 449
 450
 451
 452 void wxHtmlWindow::OnDraw(wxDC& dc)
 453 {
 454     int x, y;
 455     wxRegionIterator upd(GetUpdateRegion()); // get the update rect list
 456     int v_y, v_h;
 457
 458     if (m_tmpCanDrawLocks > 0) return;
 459
 460     dc.SetMapMode(wxMM_TEXT);
 461 #if 0
 462 /* VS - I don't think this is neccessary any longer
 463         MSC_VER 1200 means MSVC 6.0 and it works fine */
 464 #if defined(_MSC_VER) && (_MSC_VER == 1200)
 465     ::SetMapMode((HDC)dc.GetHDC(), MM_TEXT);
 466 #endif
 467 #endif
 468     dc.SetBackgroundMode(wxTRANSPARENT);
 469     ViewStart(&x, &y);
 470
 471     while (upd) {
 472         v_y = upd.GetY();
 473         v_h = upd.GetH();
 474         if (m_Cell) m_Cell -> Draw(dc, 0, 0, y * wxHTML_SCROLL_STEP + v_y, y * wxHTML_SCROLL_STEP + v_h + v_y);
 475         upd++;
 476     }
 477 }
 478
 479
 480
 481
 482 void wxHtmlWindow::OnSize(wxSizeEvent& event)
 483 {
 484     wxScrolledWindow::OnSize(event);
 485     CreateLayout();
 486 }
 487
 488
 489 void wxHtmlWindow::OnMouseEvent(wxMouseEvent& event)
 490 {
 491     m_tmpMouseMoved = TRUE;
 492
 493     if (event.ButtonDown()) {
 494         int sx, sy;
 495         wxPoint pos;
 496         wxString lnk;
 497
 498         ViewStart(&sx, &sy); sx *= wxHTML_SCROLL_STEP; sy *= wxHTML_SCROLL_STEP;
 499         pos = event.GetPosition();
 500
 501         if (m_Cell)
 502             m_Cell -> OnMouseClick(this, sx + pos.x, sy + pos.y, event);
 503     }
 504 }
 505
 506
 507
 508 void wxHtmlWindow::OnIdle(wxIdleEvent& event)
 509 {
 510     if (s_cur_hand == NULL)
 511     {
 512         s_cur_hand = new wxCursor(wxCURSOR_HAND);
 513         s_cur_arrow = new wxCursor(wxCURSOR_ARROW);
 514     }
 515
 516     if (m_tmpMouseMoved && (m_Cell != NULL)) {
 517         int sx, sy;
 518         int x, y;
 519         wxHtmlLinkInfo *lnk;
 520
 521         ViewStart(&sx, &sy); sx *= wxHTML_SCROLL_STEP; sy *= wxHTML_SCROLL_STEP;
 522         wxGetMousePosition(&x, &y);
 523         ScreenToClient(&x, &y);
 524         lnk = m_Cell -> GetLink(sx + x, sy + y);
 525
 526         if (lnk != m_tmpLastLink) {
 527             if (lnk == NULL) {
 528                 SetCursor(*s_cur_arrow);
 529                 if (m_RelatedStatusBar != -1) m_RelatedFrame -> SetStatusText(wxEmptyString, m_RelatedStatusBar);
 530             }
 531             else {
 532                 SetCursor(*s_cur_hand);
 533                 if (m_RelatedStatusBar != -1)
 534                     m_RelatedFrame -> SetStatusText(lnk -> GetHref(), m_RelatedStatusBar);
 535             }
 536             m_tmpLastLink = lnk;
 537         }
 538         m_tmpMouseMoved = FALSE;
 539     }
 540 }
 541
 542
 543
 544
 545 IMPLEMENT_DYNAMIC_CLASS(wxHtmlWindow,wxScrolledWindow)
 546
 547 BEGIN_EVENT_TABLE(wxHtmlWindow, wxScrolledWindow)
 548     EVT_SIZE(wxHtmlWindow::OnSize)
 549     EVT_LEFT_DOWN(wxHtmlWindow::OnMouseEvent)
 550     EVT_MOTION(wxHtmlWindow::OnMouseEvent)
 551     EVT_IDLE(wxHtmlWindow::OnIdle)
 552 END_EVENT_TABLE()
 553
 554
 555
 556
 557
 558 // A module to allow initialization/cleanup
 559 // without calling these functions from app.cpp or from
 560 // the user's application.
 561
 562 class wxHtmlWinModule: public wxModule
 563 {
 564 DECLARE_DYNAMIC_CLASS(wxHtmlWinModule)
 565 public:
 566     wxHtmlWinModule() : wxModule() {}
 567     bool OnInit() { return TRUE; }
 568     void OnExit() { wxHtmlWindow::CleanUpStatics(); }
 569 };
 570
 571 IMPLEMENT_DYNAMIC_CLASS(wxHtmlWinModule, wxModule)
 572
 573
 574
 575
 576 ///// default mod handlers are forced there:
 577
 578 FORCE_LINK(m_layout)
 579 FORCE_LINK(m_fonts)
 580 FORCE_LINK(m_image)
 581 FORCE_LINK(m_list)
 582 FORCE_LINK(m_dflist)
 583 FORCE_LINK(m_pre)
 584 FORCE_LINK(m_hline)
 585 FORCE_LINK(m_links)
 586 FORCE_LINK(m_tables)
 587 FORCE_LINK(m_meta)
 588
 589
 590 #endif