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
 131     SetCursor(*wxHOURGLASS_CURSOR);
 132     wxYield();
 133
 134     m_tmpCanDrawLocks++;
 135     if (m_HistoryOn && (m_HistoryPos != -1)) { // store scroll position into history item
 136         int x, y;
 137         ViewStart(&x, &y);
 138         m_History[m_HistoryPos].SetPos(y);
 139     }
 140
 141     if (location[0] == '#') { // local anchor
 142         wxString anch = location.Mid(1) /*1 to end*/;
 143         m_tmpCanDrawLocks--;
 144         rt_val = ScrollToAnchor(anch);
 145     }
 146
 147     else {
 148         // load&display it:
 149         if (m_RelatedStatusBar != -1) {
 150             m_RelatedFrame -> SetStatusText(_("Connecting..."), m_RelatedStatusBar);
 151             Refresh();
 152         }
 153
 154         f = m_FS -> OpenFile(location);
 155         if (f == NULL) {
 156             wxString err;
 157
 158             wxLogError(_("Unable to open requested HTML document: %s"), location.mb_str());
 159             m_tmpCanDrawLocks--;
 160
 161             SetCursor(*wxSTANDARD_CURSOR);
 162             return FALSE;
 163         }
 164
 165         else {
 166             wxNode *node;
 167             wxString src = wxEmptyString;
 168
 169             if (m_RelatedStatusBar != -1) {
 170                 wxString msg = _("Loading : ") + location;
 171                 m_RelatedFrame -> SetStatusText(msg, m_RelatedStatusBar);
 172                 Refresh();
 173             }
 174
 175             node = m_Filters.GetFirst();
 176             while (node){
 177                 wxHtmlFilter *h = (wxHtmlFilter*) node -> GetData();
 178                 if (h -> CanRead(*f)) {
 179                     src = h -> ReadFile(*f);
 180                     break;
 181                 }
 182                 node = node -> GetNext();
 183             }
 184             if (src == wxEmptyString) {
 185                 if (m_DefaultFilter == NULL) m_DefaultFilter = GetDefaultFilter();
 186                 src = m_DefaultFilter -> ReadFile(*f);
 187             }
 188
 189             m_FS -> ChangePathTo(f -> GetLocation());
 190             rt_val = SetPage(src);
 191             m_OpenedPage = f -> GetLocation();
 192             if (f -> GetAnchor() != wxEmptyString) {
 193 //                m_tmpCanDrawLocks--;
 194                 ScrollToAnchor(f -> GetAnchor());
 195 //                m_tmpCanDrawLocks++;
 196             }
 197
 198             delete f;
 199
 200             if (m_RelatedStatusBar != -1) m_RelatedFrame -> SetStatusText(_("Done"), m_RelatedStatusBar);
 201         }
 202     }
 203
 204     if (m_HistoryOn) { // add this page to history there:
 205         int c = m_History.GetCount() - (m_HistoryPos + 1);
 206
 207         m_HistoryPos++;
 208         for (int i = 0; i < c; i++)
 209             m_History.Remove(m_HistoryPos);
 210         m_History.Add(new HtmlHistoryItem(m_OpenedPage, m_OpenedAnchor));
 211     }
 212
 213     if (m_OpenedPageTitle == wxEmptyString)
 214         OnSetTitle(wxFileNameFromPath(m_OpenedPage));
 215     SetCursor(*wxSTANDARD_CURSOR);
 216
 217     wxYield();
 218     m_tmpCanDrawLocks--;
 219     Refresh();
 220     return rt_val;
 221 }
 222
 223
 224
 225 bool wxHtmlWindow::ScrollToAnchor(const wxString& anchor)
 226 {
 227     const wxHtmlCell *c = m_Cell -> Find(wxHTML_COND_ISANCHOR, &anchor);
 228     if (!c)
 229     {
 230         wxLogWarning(_("HTML anchor %s does not exist."), anchor.mb_str());
 231         return FALSE;
 232     }
 233     else {
 234         int y;
 235
 236         for (y = 0; c != NULL; c = c -> GetParent()) y += c -> GetPosY();
 237         Scroll(-1, y / wxHTML_SCROLL_STEP);
 238         m_OpenedAnchor = anchor;
 239         return TRUE;
 240     }
 241 }
 242
 243
 244 void wxHtmlWindow::OnSetTitle(const wxString& title)
 245 {
 246     if (m_RelatedFrame) {
 247         wxString tit;
 248         tit.Printf(m_TitleFormat, title.c_str());
 249         m_RelatedFrame -> SetTitle(tit);
 250     }
 251     m_OpenedPageTitle = title;
 252 }
 253
 254
 255
 256
 257
 258 void wxHtmlWindow::CreateLayout()
 259 {
 260     int ClientWidth, ClientHeight;
 261
 262     if (!m_Cell) return;
 263
 264     if (m_Style == wxHW_SCROLLBAR_NEVER) {
 265         SetScrollbars(wxHTML_SCROLL_STEP, 1, m_Cell -> GetWidth() / wxHTML_SCROLL_STEP, 0); // always off
 266         GetClientSize(&ClientWidth, &ClientHeight);
 267         m_Cell -> Layout(ClientWidth);
 268     }
 269
 270     else {
 271         GetClientSize(&ClientWidth, &ClientHeight);
 272 #ifndef __WXMSW__
 273         // VS : this looks extremely ugly under windoze, better fix needed!
 274         SetScrollbars(wxHTML_SCROLL_STEP, 1, m_Cell -> GetWidth() / wxHTML_SCROLL_STEP, ClientHeight * 2); // always on
 275 #endif
 276         GetClientSize(&ClientWidth, &ClientHeight);
 277         m_Cell -> Layout(ClientWidth);
 278         if (ClientHeight < m_Cell -> GetHeight() + GetCharHeight()) {
 279             SetScrollbars(
 280                   wxHTML_SCROLL_STEP, wxHTML_SCROLL_STEP,
 281                   m_Cell -> GetWidth() / wxHTML_SCROLL_STEP,
 282                   (m_Cell -> GetHeight() + GetCharHeight()) / wxHTML_SCROLL_STEP
 283                   /*cheat: top-level frag is always container*/);
 284         }
 285         else { /* we fit into window, no need for scrollbars */
 286             SetScrollbars(wxHTML_SCROLL_STEP, 1, m_Cell -> GetWidth() / wxHTML_SCROLL_STEP, 0); // disable...
 287             GetClientSize(&ClientWidth, &ClientHeight);
 288             m_Cell -> Layout(ClientWidth); // ...and relayout
 289         }
 290     }
 291 }
 292
 293
 294
 295 void wxHtmlWindow::ReadCustomization(wxConfigBase *cfg, wxString path)
 296 {
 297     wxString oldpath;
 298     wxString tmp;
 299     int p_fontsizes[7];
 300     wxString p_fff, p_ffn;
 301
 302     if (path != wxEmptyString) {
 303         oldpath = cfg -> GetPath();
 304         cfg -> SetPath(path);
 305     }
 306
 307     m_Borders = cfg -> Read("wxHtmlWindow/Borders", m_Borders);
 308     p_fff = cfg -> Read("wxHtmlWindow/FontFaceFixed", m_Parser -> m_FontFaceFixed);
 309     p_ffn = cfg -> Read("wxHtmlWindow/FontFaceNormal", m_Parser -> m_FontFaceNormal);
 310     for (int i = 0; i < 7; i++) {
 311         tmp.Printf(wxT("wxHtmlWindow/FontsSize%i"), i);
 312         p_fontsizes[i] = cfg -> Read(tmp, m_Parser -> m_FontsSizes[i]);
 313     }
 314     SetFonts(p_ffn, p_fff, p_fontsizes);
 315
 316     if (path != wxEmptyString)
 317         cfg -> SetPath(oldpath);
 318 }
 319
 320
 321
 322 void wxHtmlWindow::WriteCustomization(wxConfigBase *cfg, wxString path)
 323 {
 324     wxString oldpath;
 325     wxString tmp;
 326
 327     if (path != wxEmptyString) {
 328         oldpath = cfg -> GetPath();
 329         cfg -> SetPath(path);
 330     }
 331
 332     cfg -> Write("wxHtmlWindow/Borders", (long) m_Borders);
 333     cfg -> Write("wxHtmlWindow/FontFaceFixed", m_Parser -> m_FontFaceFixed);
 334     cfg -> Write("wxHtmlWindow/FontFaceNormal", m_Parser -> m_FontFaceNormal);
 335     for (int i = 0; i < 7; i++) {
 336         tmp.Printf(wxT("wxHtmlWindow/FontsSize%i"), i);
 337         cfg -> Write(tmp, (long) m_Parser -> m_FontsSizes[i]);
 338     }
 339
 340     if (path != wxEmptyString)
 341         cfg -> SetPath(oldpath);
 342 }
 343
 344
 345
 346 bool wxHtmlWindow::HistoryBack()
 347 {
 348     wxString a, l;
 349
 350     if (m_HistoryPos < 1) return FALSE;
 351
 352     m_HistoryPos--;
 353
 354     l = m_History[m_HistoryPos].GetPage();
 355     a = m_History[m_HistoryPos].GetAnchor();
 356     m_HistoryOn = FALSE;
 357     m_tmpCanDrawLocks++;
 358     if (a == wxEmptyString) LoadPage(l);
 359     else LoadPage(l + "#" + a);
 360     m_HistoryOn = TRUE;
 361     wxYield();
 362     m_tmpCanDrawLocks--;
 363     Scroll(0, m_History[m_HistoryPos].GetPos());
 364     Refresh();
 365     return TRUE;
 366 }
 367
 368
 369
 370 bool wxHtmlWindow::HistoryForward()
 371 {
 372     wxString a, l;
 373
 374     if (m_HistoryPos == -1) return FALSE;
 375     if (m_HistoryPos >= (int)m_History.GetCount() - 1)return FALSE;
 376
 377     m_OpenedPage = wxEmptyString; // this will disable adding new entry into history in LoadPage()
 378
 379     m_HistoryPos++;
 380     l = m_History[m_HistoryPos].GetPage();
 381     a = m_History[m_HistoryPos].GetAnchor();
 382     m_HistoryOn = FALSE;
 383     m_tmpCanDrawLocks++;
 384     if (a == wxEmptyString) LoadPage(l);
 385     else LoadPage(l + "#" + a);
 386     m_HistoryOn = TRUE;
 387     wxYield();
 388     m_tmpCanDrawLocks--;
 389     Scroll(0, m_History[m_HistoryPos].GetPos());
 390     Refresh();
 391     return TRUE;
 392 }
 393
 394
 395
 396 void wxHtmlWindow::HistoryClear()
 397 {
 398     m_History.Empty();
 399     m_HistoryPos = -1;
 400 }
 401
 402
 403
 404 wxList wxHtmlWindow::m_Filters;
 405 wxHtmlFilter *wxHtmlWindow::m_DefaultFilter = NULL;
 406
 407 void wxHtmlWindow::CleanUpStatics()
 408 {
 409     if (m_DefaultFilter) delete m_DefaultFilter;
 410     m_DefaultFilter = NULL;
 411     m_Filters.DeleteContents(TRUE);
 412     m_Filters.Clear();
 413
 414 }
 415
 416
 417
 418 void wxHtmlWindow::AddFilter(wxHtmlFilter *filter)
 419 {
 420     m_Filters.Append(filter);
 421 }
 422
 423
 424
 425
 426 void wxHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo& link)
 427 {
 428     LoadPage(link.GetHref());
 429 }
 430
 431
 432
 433 void wxHtmlWindow::OnDraw(wxDC& dc)
 434 {
 435     int x, y;
 436     wxRegionIterator upd(GetUpdateRegion()); // get the update rect list
 437     int v_y, v_h;
 438
 439     if (m_tmpCanDrawLocks > 0) return;
 440     dc.SetMapMode(wxMM_TEXT);
 441 #if 0
 442 /* VS - I don't think this is neccessary any longer
 443         MSC_VER 1200 means MSVC 6.0 and it works fine */
 444 #if defined(_MSC_VER) && (_MSC_VER == 1200)
 445     ::SetMapMode((HDC)dc.GetHDC(), MM_TEXT);
 446 #endif
 447 #endif
 448     dc.SetBackgroundMode(wxTRANSPARENT);
 449     ViewStart(&x, &y);
 450
 451     while (upd) {
 452         v_y = upd.GetY();
 453         v_h = upd.GetH();
 454         if (m_Cell) m_Cell -> Draw(dc, 0, 0, y * wxHTML_SCROLL_STEP + v_y, y * wxHTML_SCROLL_STEP + v_h + v_y);
 455         upd++;
 456     }
 457 }
 458
 459
 460
 461
 462 void wxHtmlWindow::OnSize(wxSizeEvent& event)
 463 {
 464     wxScrolledWindow::OnSize(event);
 465     CreateLayout();
 466 }
 467
 468
 469
 470 void wxHtmlWindow::OnKeyDown(wxKeyEvent& event)
 471 {
 472     int dummy;
 473     int sty, szy, cliy;
 474
 475     ViewStart(&dummy, &sty);
 476     GetClientSize(&dummy, &cliy); cliy /= wxHTML_SCROLL_STEP;
 477     GetVirtualSize(&dummy, &szy); szy /= wxHTML_SCROLL_STEP;
 478
 479     switch (event.KeyCode()) {
 480         case WXK_PAGEUP :
 481         case WXK_PRIOR :
 482                 Scroll(-1, sty - (5 * cliy / 6));
 483                 break;
 484         case WXK_PAGEDOWN :
 485         case WXK_NEXT :
 486                 Scroll(-1, sty + (5 * cliy / 6));
 487                 break;
 488         case WXK_HOME :
 489                 Scroll(-1, 0);
 490                 break;
 491         case WXK_END :
 492                 Scroll(-1, szy - cliy);
 493                 break;
 494         case WXK_UP :
 495                 Scroll(-1, sty - 1);
 496                 break;
 497         case WXK_DOWN :
 498                 Scroll(-1, sty + 1);
 499                 break;
 500     }
 501 }
 502
 503
 504
 505 void wxHtmlWindow::OnMouseEvent(wxMouseEvent& event)
 506 {
 507     m_tmpMouseMoved = TRUE;
 508
 509     if (event.ButtonDown()) {
 510         int sx, sy;
 511         wxPoint pos;
 512         wxString lnk;
 513
 514         ViewStart(&sx, &sy); sx *= wxHTML_SCROLL_STEP; sy *= wxHTML_SCROLL_STEP;
 515         pos = event.GetPosition();
 516
 517         if (m_Cell)
 518             m_Cell -> OnMouseClick(this, sx + pos.x, sy + pos.y, event);
 519     }
 520 }
 521
 522
 523
 524 void wxHtmlWindow::OnIdle(wxIdleEvent& event)
 525 {
 526     static wxCursor cur_hand(wxCURSOR_HAND), cur_arrow(wxCURSOR_ARROW);
 527
 528     if (m_tmpMouseMoved && (m_Cell != NULL)) {
 529         int sx, sy;
 530         int x, y;
 531         wxHtmlLinkInfo *lnk;
 532
 533         ViewStart(&sx, &sy); sx *= wxHTML_SCROLL_STEP; sy *= wxHTML_SCROLL_STEP;
 534         wxGetMousePosition(&x, &y);
 535         ScreenToClient(&x, &y);
 536         lnk = m_Cell -> GetLink(sx + x, sy + y);
 537
 538         if (lnk != m_tmpLastLink) {
 539             if (lnk == NULL) {
 540                 SetCursor(cur_arrow);
 541                 if (m_RelatedStatusBar != -1) m_RelatedFrame -> SetStatusText(wxEmptyString, m_RelatedStatusBar);
 542             }
 543             else {
 544                 SetCursor(cur_hand);
 545                 if (m_RelatedStatusBar != -1)
 546                     m_RelatedFrame -> SetStatusText(lnk -> GetHref(), m_RelatedStatusBar);
 547             }
 548             m_tmpLastLink = lnk;
 549         }
 550         m_tmpMouseMoved = FALSE;
 551     }
 552 }
 553
 554
 555
 556
 557 IMPLEMENT_DYNAMIC_CLASS(wxHtmlWindow,wxScrolledWindow)
 558
 559 BEGIN_EVENT_TABLE(wxHtmlWindow, wxScrolledWindow)
 560     EVT_SIZE(wxHtmlWindow::OnSize)
 561     EVT_LEFT_DOWN(wxHtmlWindow::OnMouseEvent)
 562     EVT_MOTION(wxHtmlWindow::OnMouseEvent)
 563     EVT_IDLE(wxHtmlWindow::OnIdle)
 564     EVT_KEY_DOWN(wxHtmlWindow::OnKeyDown)
 565 END_EVENT_TABLE()
 566
 567
 568
 569
 570
 571 // A module to allow initialization/cleanup
 572 // without calling these functions from app.cpp or from
 573 // the user's application.
 574
 575 class wxHtmlWinModule: public wxModule
 576 {
 577 DECLARE_DYNAMIC_CLASS(wxHtmlWinModule)
 578 public:
 579     wxHtmlWinModule() : wxModule() {}
 580     bool OnInit() { return TRUE; }
 581     void OnExit() { wxHtmlWindow::CleanUpStatics(); }
 582 };
 583
 584 IMPLEMENT_DYNAMIC_CLASS(wxHtmlWinModule, wxModule)
 585
 586
 587
 588
 589 ///// default mod handlers are forced there:
 590
 591 FORCE_LINK(m_layout)
 592 FORCE_LINK(m_fonts)
 593 FORCE_LINK(m_image)
 594 FORCE_LINK(m_list)
 595 FORCE_LINK(m_dflist)
 596 FORCE_LINK(m_pre)
 597 FORCE_LINK(m_hline)
 598 FORCE_LINK(m_links)
 599 FORCE_LINK(m_tables)
 600 FORCE_LINK(m_meta)
 601
 602
 603 #endif