sw/inc/htmltbl.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SW_INC_HTMLTBL_HXX
  21 #define INCLUDED_SW_INC_HTMLTBL_HXX
  22
  23 #include <memory>
  24 #include <vcl/timer.hxx>
  25 #include <editeng/svxenum.hxx>
  26
  27 #include "swtypes.hxx"
  28 #include "node.hxx"
  29
  30 class SwTableBox;
  31 class SwTable;
  32 class SwHTMLTableLayout;
  33 class SwDoc;
  34 class SwFrameFormat;
  35
  36 #define HTMLTABLE_RESIZE_NOW (ULONG_MAX)
  37
  38 class SwHTMLTableLayoutCnts
  39 {
  40     std::shared_ptr<SwHTMLTableLayoutCnts> xNext;   ///< The next content.
  41
  42     /// Only one of the following two pointers may be set!
  43     SwTableBox *pBox;               ///< A Box.
  44     std::shared_ptr<SwHTMLTableLayout> xTable;      ///< A "table within a table".
  45
  46     /** During first run there are still no boxes. In this case
  47        pStartNode is used instead of pBox. */
  48     const SwStartNode *pStartNode;
  49
  50     /** The following counters indicate how often a pass has been
  51         done for this content. Therefore they are compared against
  52         a reference value. If 255 is reached the continue with 0.
  53         This avoids reinitialization on every resize. */
  54     sal_uInt8 nPass1Done;           ///< How many times has Pass 1 been called?
  55     sal_uInt8 nWidthSet;            ///< How many times has the width been set?
  56
  57     bool const bNoBreakTag;           ///< <NOBR>-Tag over complete content.
  58
  59 public:
  60
  61     SwHTMLTableLayoutCnts(const SwStartNode* pSttNd, std::shared_ptr<SwHTMLTableLayout> const& rTab,
  62                           bool bNoBreakTag, std::shared_ptr<SwHTMLTableLayoutCnts> const& rNxt);
  63
  64     void SetTableBox( SwTableBox *pBx ) { pBox = pBx; }
  65     SwTableBox *GetTableBox() const { return pBox; }
  66
  67     SwHTMLTableLayout *GetTable() const { return xTable.get(); }
  68
  69     const SwStartNode *GetStartNode() const;
  70
  71     /// Calculation of next node.
  72     const std::shared_ptr<SwHTMLTableLayoutCnts>& GetNext() const { return xNext; }
  73
  74     void SetWidthSet( sal_uInt8 nRef ) { nWidthSet = nRef; }
  75     bool IsWidthSet( sal_uInt8 nRef ) const { return nRef==nWidthSet; }
  76
  77     void SetPass1Done( sal_uInt8 nRef ) { nPass1Done = nRef; }
  78     bool IsPass1Done( sal_uInt8 nRef ) const { return nRef==nPass1Done; }
  79
  80     bool HasNoBreakTag() const { return bNoBreakTag; }
  81 };
  82
  83 class SwHTMLTableLayoutCell
  84 {
  85     std::shared_ptr<SwHTMLTableLayoutCnts> xContents;  ///< Content of cell.
  86
  87     sal_uInt16 nRowSpan;               ///< ROWSPAN of cell.
  88     sal_uInt16 nColSpan;               ///< COLSPAN of cell.
  89     sal_uInt16 const nWidthOption;           ///< Given width of cell in Twip or %.
  90
  91     bool const bPrcWidthOption : 1;      ///< nWidth is %-value.
  92     bool const bNoWrapOption : 1;        ///< NOWRAP-option.
  93
  94 public:
  95
  96     SwHTMLTableLayoutCell(std::shared_ptr<SwHTMLTableLayoutCnts> const& rCnts,
  97                          sal_uInt16 nRSpan, sal_uInt16 nCSpan,
  98                          sal_uInt16 nWidthOpt, bool bPrcWdthOpt,
  99                          bool bNWrapOpt );
 100
 101     /// Set or get content of a cell.
 102     void SetContents(std::shared_ptr<SwHTMLTableLayoutCnts> const& rCnts) { xContents = rCnts; }
 103     const std::shared_ptr<SwHTMLTableLayoutCnts>& GetContents() const { return xContents; }
 104
 105     inline void SetProtected();
 106
 107     /// Set or get ROWSPAN/COLSPAN of cell.
 108     void SetRowSpan( sal_uInt16 nRSpan ) { nRowSpan = nRSpan; }
 109     sal_uInt16 GetRowSpan() const { return nRowSpan; }
 110     sal_uInt16 GetColSpan() const { return nColSpan; }
 111
 112     sal_uInt16 GetWidthOption() const { return nWidthOption; }
 113     bool IsPrcWidthOption() const { return bPrcWidthOption; }
 114
 115     bool HasNoWrapOption() const { return bNoWrapOption; }
 116 };
 117
 118 class SwHTMLTableLayoutColumn
 119 {
 120
 121     /// Interim values of AutoLayoutPass1,
 122     sal_uLong nMinNoAlign, nMaxNoAlign, nAbsMinNoAlign;
 123
 124     /// Results of AutoLayoutPass1
 125     sal_uLong nMin, nMax;
 126
 127     /// Results of Pass 2.
 128     sal_uInt16 nAbsColWidth;                ///< In Twips.
 129     sal_uInt16 nRelColWidth;                ///< In Twips or relative to USHRT_MAX.
 130
 131     sal_uInt16 nWidthOption;                ///< Options of <COL> or <TD>/<TH>.
 132
 133     bool bRelWidthOption : 1;
 134     bool const bLeftBorder : 1;
 135
 136 public:
 137
 138     SwHTMLTableLayoutColumn( sal_uInt16 nColWidthOpt, bool bRelColWidthOpt,
 139                              bool bLBorder );
 140
 141     inline void MergeCellWidthOption( sal_uInt16 nWidth, bool bPrc );
 142     inline void SetWidthOption( sal_uInt16 nWidth );
 143
 144     sal_uInt16 GetWidthOption() const { return nWidthOption; }
 145     bool IsRelWidthOption() const { return bRelWidthOption; }
 146
 147     inline void MergeMinMaxNoAlign( sal_uLong nMin, sal_uLong nMax, sal_uLong nAbsMin );
 148     sal_uLong GetMinNoAlign() const { return nMinNoAlign; }
 149     sal_uLong GetMaxNoAlign() const { return nMaxNoAlign; }
 150     sal_uLong GetAbsMinNoAlign() const { return nAbsMinNoAlign; }
 151     inline void ClearPass1Info( bool bWidthOpt );
 152
 153     inline void SetMinMax( sal_uLong nMin, sal_uLong nMax );
 154     void SetMax( sal_uLong nVal ) { nMax = nVal; }
 155     void AddToMin( sal_uLong nVal ) { nMin += nVal; }
 156     void AddToMax( sal_uLong nVal ) { nMax += nVal; }
 157     sal_uLong GetMin() const { return nMin; }
 158     sal_uLong GetMax() const { return nMax; }
 159
 160     void SetAbsColWidth( sal_uInt16 nWidth ) { nAbsColWidth = nWidth; }
 161     sal_uInt16 GetAbsColWidth() const { return nAbsColWidth; }
 162
 163     void SetRelColWidth( sal_uInt16 nWidth ) { nRelColWidth = nWidth; }
 164     sal_uInt16 GetRelColWidth() const { return nRelColWidth; }
 165
 166     bool HasLeftBorder() const { return bLeftBorder; }
 167 };
 168
 169 class SwHTMLTableLayout
 170 {
 171     Timer m_aResizeTimer;             ///< Timer for DelayedResize.
 172
 173     std::vector<std::unique_ptr<SwHTMLTableLayoutColumn>> m_aColumns;
 174     std::vector<std::unique_ptr<SwHTMLTableLayoutCell>>   m_aCells;
 175
 176     const SwTable *m_pSwTable;            ///< SwTable (Top-Table only).
 177
 178     sal_uLong m_nMin;                     ///< Minimal width of table (Twips).
 179     sal_uLong m_nMax;                     ///< Maximal width of table (Twips).
 180
 181     sal_uInt16 const m_nRows;                   ///< Row count.
 182     sal_uInt16 m_nCols;                   ///< Column count.
 183
 184     sal_uInt16 const m_nLeftMargin;             ///< Space to left margin (from paragraph).
 185     sal_uInt16 const m_nRightMargin;            ///< Space to left margin (from paragraph).
 186
 187     sal_uInt16 m_nInhAbsLeftSpace;        ///< Space inherited from surrounding box
 188     sal_uInt16 m_nInhAbsRightSpace;       ///< that was added to boxes.
 189
 190     sal_uInt16 m_nRelLeftFill;            ///< Width of boxes relative to alignment
 191     sal_uInt16 m_nRelRightFill;           ///< of tables in tables.
 192
 193     sal_uInt16 m_nRelTabWidth;            ///< Relative width of table.
 194
 195     sal_uInt16 m_nWidthOption;            ///< Width of table (in Twips or %).
 196     sal_uInt16 const m_nCellPadding;            ///< Space to contents (in Twips).
 197     sal_uInt16 const m_nCellSpacing;            ///< Cell spacing (in Twips).
 198     sal_uInt16 const m_nBorder;                 /** Line strength of outer border, or rather the
 199                                         space needed for it as calculated by Netscape. */
 200
 201     sal_uInt16 const m_nLeftBorderWidth;
 202     sal_uInt16 const m_nRightBorderWidth;
 203     sal_uInt16 m_nInhLeftBorderWidth;
 204     sal_uInt16 m_nInhRightBorderWidth;
 205     sal_uInt16 const m_nBorderWidth;
 206
 207     sal_uInt16 m_nDelayedResizeAbsAvail;  ///< Param for delayed Resize.
 208     sal_uInt16 m_nLastResizeAbsAvail;
 209
 210     sal_uInt8 m_nPass1Done;               ///< Reference-values for
 211     sal_uInt8 m_nWidthSet;                ///< the runs through loop.
 212
 213     SvxAdjust const m_eTableAdjust;             ///< Alignment of table.
 214
 215     bool const m_bColsOption : 1;           ///< Table has a COLS-option.
 216     bool const m_bColTags : 1;              ///< Table has COL/COLGRP tags.
 217     bool const m_bPrcWidthOption : 1;       ///< Width is given in percent.
 218     bool m_bUseRelWidth : 1;          ///< SwTable gets relative width.
 219
 220     bool m_bMustResize : 1;           ///< Table width must be defined.
 221     bool m_bExportable : 1;           ///< Layout may be used for export.
 222     bool m_bBordersChanged : 1;       ///< Borders have been changed.
 223     bool m_bMayBeInFlyFrame : 1;      ///< Table could be within frame.
 224
 225     bool m_bDelayedResizeRecalc : 1;  ///< Param for delayed Resize.
 226     bool m_bMustNotResize : 1;        ///< Table may not be resized.
 227     bool m_bMustNotRecalc : 1;        ///< Table may not be adapted to its contents.
 228
 229     void AddBorderWidth( sal_uLong &rMin, sal_uLong &rMax, sal_uLong& rAbsMin,
 230                          sal_uInt16 nCol, sal_uInt16 nColSpan,
 231                          bool bSwBorders=true ) const;
 232     void SetBoxWidth( SwTableBox *pBox, sal_uInt16 nCol, sal_uInt16 nColSpan ) const;
 233
 234     const SwStartNode *GetAnyBoxStartNode() const;
 235     SwFrameFormat *FindFlyFrameFormat() const;
 236     const SwDoc *GetDoc() const { return GetAnyBoxStartNode()->GetDoc(); }
 237
 238     void Resize_( sal_uInt16 nAbsAvail, bool bRecalc );
 239
 240     DECL_LINK( DelayedResize_Impl, Timer*, void );
 241
 242     static sal_uInt16 GetBrowseWidthByVisArea( const SwDoc& rDoc );
 243 public:
 244
 245     SwHTMLTableLayout( const SwTable *pSwTable,
 246                        sal_uInt16 nRows, sal_uInt16 nCols, bool bColsOpt, bool ColTgs,
 247                        sal_uInt16 nWidth, bool bPrcWidth, sal_uInt16 nBorderOpt,
 248                        sal_uInt16 nCellPad, sal_uInt16 nCellSp, SvxAdjust eAdjust,
 249                        sal_uInt16 nLMargin, sal_uInt16 nRMargin, sal_uInt16 nBWidth,
 250                        sal_uInt16 nLeftBWidth, sal_uInt16 nRightBWidth );
 251
 252     ~SwHTMLTableLayout();
 253
 254     sal_uInt16 GetLeftCellSpace( sal_uInt16 nCol, sal_uInt16 nColSpan,
 255                              bool bSwBorders=true ) const;
 256     sal_uInt16 GetRightCellSpace( sal_uInt16 nCol, sal_uInt16 nColSpan,
 257                               bool bSwBorders=true ) const;
 258     inline sal_uInt16 GetInhCellSpace( sal_uInt16 nCol, sal_uInt16 nColSpan ) const;
 259
 260     inline void SetInhBorderWidths( sal_uInt16 nLeft, sal_uInt16 nRight );
 261
 262     void GetAvail( sal_uInt16 nCol, sal_uInt16 nColSpan, sal_uInt16& rAbsAvail,
 263                    sal_uInt16& rRelAvail ) const;
 264
 265     void AutoLayoutPass1();
 266     void AutoLayoutPass2( sal_uInt16 nAbsAvail, sal_uInt16 nRelAvail,
 267                           sal_uInt16 nAbsLeftSpace, sal_uInt16 nAbsRightSpace,
 268                           sal_uInt16 nParentInhSpace );
 269     void SetWidths( bool bCallPass2=false, sal_uInt16 nAbsAvail=0,
 270                     sal_uInt16 nRelAvail=0, sal_uInt16 nAbsLeftSpace=0,
 271                     sal_uInt16 nAbsRightSpace=0,
 272                     sal_uInt16 nParentInhSpace=0 );
 273
 274     inline SwHTMLTableLayoutColumn *GetColumn( sal_uInt16 nCol ) const;
 275     inline void SetColumn( std::unique_ptr<SwHTMLTableLayoutColumn> pCol, sal_uInt16 nCol );
 276
 277     inline SwHTMLTableLayoutCell *GetCell( sal_uInt16 nRow, sal_uInt16 nCol ) const;
 278     inline void SetCell( std::unique_ptr<SwHTMLTableLayoutCell> pCell, sal_uInt16 nRow, sal_uInt16 nCol );
 279
 280     sal_uLong GetMin() const { return m_nMin; }
 281     sal_uLong GetMax() const { return m_nMax; }
 282
 283     inline long GetBrowseWidthMin() const;
 284
 285     bool HasColsOption() const { return m_bColsOption; }
 286     bool HasColTags() const { return m_bColTags; }
 287
 288     bool IsTopTable() const  { return m_pSwTable != nullptr; }
 289
 290     void SetMustResize( bool bSet ) { m_bMustResize = bSet; }
 291     void SetMustNotResize( bool bSet ) { m_bMustNotResize = bSet; }
 292     void SetMustNotRecalc( bool bSet ) { m_bMustNotRecalc = bSet; }
 293
 294     /** Recalculation of table widths for available width that has been passed.
 295      - If bRecalc is set, contents of boxes are included into calculation.
 296      - If bForce is set, table will be recalculated even if this was
 297        disallowed by SetMustNotResize.
 298      - If nDelay > 0 the calculation is delayed accordingly. Resizing calls
 299        occurring during delay-time are ignored, but the delay may be counted
 300        under certain circumstances.
 301      - If nDelay == HTMLTABLE_RESIZE_NOW, resize immediately and do not
 302        consider any resize-calls that might possibly be in order.
 303      - The return value indicates whether the table has been changed. */
 304     bool Resize( sal_uInt16 nAbsAvail, bool bRecalc=false, bool bForce=false,
 305                  sal_uLong nDelay=0 );
 306
 307     void BordersChanged( sal_uInt16 nAbsAvail );
 308
 309     /** Calculate available width. This works only if a layout or a
 310      SwViewShell exists. Otherwise returns 0.
 311      This is needed by HTML-filter because it doesn't have access to the layout.) */
 312     static sal_uInt16 GetBrowseWidth( const SwDoc& rDoc );
 313
 314     /// Calculates available width by table-frame.
 315     sal_uInt16 GetBrowseWidthByTabFrame( const SwTabFrame& rTabFrame ) const;
 316
 317     /** Calculates available width by the table-frame or
 318      static GetBrowseWidth if no layout exists. */
 319     sal_uInt16 GetBrowseWidthByTable( const SwDoc& rDoc ) const;
 320
 321     /// For Export.
 322     sal_uInt16 GetWidthOption() const { return m_nWidthOption; }
 323     bool   HasPrcWidthOption() const { return m_bPrcWidthOption; }
 324
 325     sal_uInt16 GetCellPadding() const { return m_nCellPadding; }
 326     sal_uInt16 GetCellSpacing() const { return m_nCellSpacing; }
 327     sal_uInt16 GetBorder() const { return m_nBorder; }
 328
 329     sal_uInt16 GetRowCount() const { return m_nRows; }
 330     sal_uInt16 GetColCount() const { return m_nCols; }
 331
 332     void SetExportable( bool bSet ) { m_bExportable = bSet; }
 333     bool IsExportable() const { return m_bExportable; }
 334
 335     bool HaveBordersChanged() const { return m_bBordersChanged; }
 336
 337     void SetMayBeInFlyFrame( bool bSet ) { m_bMayBeInFlyFrame = bSet; }
 338     bool MayBeInFlyFrame() const { return m_bMayBeInFlyFrame; }
 339 };
 340
 341 inline void SwHTMLTableLayoutCell::SetProtected()
 342 {
 343     nRowSpan = 1;
 344     nColSpan = 1;
 345     xContents.reset();
 346 }
 347
 348 inline void SwHTMLTableLayoutColumn::MergeMinMaxNoAlign( sal_uLong nCMin,
 349     sal_uLong nCMax,    sal_uLong nAbsMin )
 350 {
 351     if( nCMin > nMinNoAlign )
 352         nMinNoAlign = nCMin;
 353     if( nCMax > nMaxNoAlign )
 354         nMaxNoAlign = nCMax;
 355     if( nAbsMin > nAbsMinNoAlign )
 356         nAbsMinNoAlign = nAbsMin;
 357 }
 358
 359 inline void SwHTMLTableLayoutColumn::ClearPass1Info( bool bWidthOpt )
 360 {
 361     nMinNoAlign = nMaxNoAlign = nAbsMinNoAlign = MINLAY;
 362     nMin = nMax = 0;
 363     if( bWidthOpt )
 364     {
 365         nWidthOption = 0;
 366         bRelWidthOption = false;
 367     }
 368 }
 369
 370 inline void SwHTMLTableLayoutColumn::MergeCellWidthOption(
 371     sal_uInt16 nWidth, bool bRel )
 372 {
 373     if( !nWidthOption ||
 374         (bRel==bRelWidthOption && nWidthOption < nWidth) )
 375     {
 376         nWidthOption = nWidth;
 377         bRelWidthOption = bRel;
 378     }
 379 }
 380
 381 inline void SwHTMLTableLayoutColumn::SetMinMax( sal_uLong nMn, sal_uLong nMx )
 382 {
 383     nMin = nMn;
 384     nMax = nMx;
 385 }
 386
 387 inline sal_uInt16 SwHTMLTableLayout::GetInhCellSpace( sal_uInt16 nCol,
 388                                                   sal_uInt16 nColSpan ) const
 389 {
 390     sal_uInt16 nSpace = 0;
 391     if( nCol==0 )
 392         nSpace = nSpace + m_nInhAbsLeftSpace;
 393     if( nCol+nColSpan==m_nCols )
 394         nSpace = nSpace + m_nInhAbsRightSpace;
 395
 396     return nSpace;
 397 }
 398
 399 inline SwHTMLTableLayoutColumn *SwHTMLTableLayout::GetColumn( sal_uInt16 nCol ) const
 400 {
 401     return m_aColumns[nCol].get();
 402 }
 403
 404 inline void SwHTMLTableLayoutColumn::SetWidthOption( sal_uInt16 nWidth )
 405 {
 406     nWidthOption = nWidth;
 407     bRelWidthOption = true;
 408 }
 409
 410 inline void SwHTMLTableLayout::SetColumn( std::unique_ptr<SwHTMLTableLayoutColumn> pCol, sal_uInt16 nCol )
 411 {
 412     m_aColumns[nCol] = std::move(pCol);
 413 }
 414
 415 inline SwHTMLTableLayoutCell *SwHTMLTableLayout::GetCell( sal_uInt16 nRow, sal_uInt16 nCol ) const
 416 {
 417     return m_aCells[static_cast<size_t>(nRow)*m_nCols+nCol].get();
 418 }
 419
 420 inline void SwHTMLTableLayout::SetCell( std::unique_ptr<SwHTMLTableLayoutCell> pCell,
 421                                sal_uInt16 nRow, sal_uInt16 nCol )
 422 {
 423     m_aCells[static_cast<size_t>(nRow)*m_nCols+nCol] = std::move(pCell);
 424 }
 425
 426 inline long SwHTMLTableLayout::GetBrowseWidthMin() const
 427 {
 428     return static_cast<long>( (!m_nWidthOption || m_bPrcWidthOption) ? m_nMin : m_nRelTabWidth );
 429 }
 430
 431 void SwHTMLTableLayout::SetInhBorderWidths( sal_uInt16 nLeft, sal_uInt16 nRight )
 432 {
 433     m_nInhLeftBorderWidth = nLeft;
 434     m_nInhRightBorderWidth = nRight;
 435 }
 436
 437 #endif
 438
 439 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */