writerfilter/source/doctok/WW8Clx.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: WW8Clx.hxx,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef INCLUDED_WW8_CLX_HXX
  32 #define INCLUDED_WW8_CLX_HXX
  33
  34 #include <resources.hxx>
  35
  36 #ifndef INCLUDED_WW8_OUTPUT_WITH_DEPTH_HXX
  37 #include <WW8OutputWithDepth.hxx>
  38 #endif
  39
  40 namespace writerfilter {
  41 namespace doctok
  42 {
  43
  44 /**
  45    Piece table as stored in a Word file.
  46
  47    It contains character positions (CPs) and file character positions
  48    (FCs). Each CP is correlated to one FC.
  49  */
  50 class WW8Clx : public WW8StructBase
  51 {
  52     /// Pointer to the file information block.
  53     WW8Fib::Pointer_t pFib;
  54
  55     /// Offset where FCs begin
  56     sal_uInt32 nOffsetPieceTable;
  57
  58 public:
  59     /// Pointer to Clx.
  60     typedef boost::shared_ptr<WW8Clx> Pointer_t;
  61
  62     WW8Clx(WW8Stream & rStream,
  63            sal_uInt32 nOffset, sal_uInt32 nCount);
  64
  65     virtual void dump(OutputWithDepth<string> & o) const;
  66
  67     /**
  68        Return the number of pieces.
  69     */
  70     sal_uInt32 getPieceCount() const;
  71
  72     /**
  73        Return a certain character position.
  74
  75        @param nIndex     index of the character position
  76      */
  77     sal_uInt32 getCp(sal_uInt32 nIndex) const;
  78
  79     /**
  80        Return a certain file character position.
  81
  82        @param nIndex     index of the file character position
  83      */
  84     sal_uInt32 getFc(sal_uInt32 nIndex) const;
  85
  86     /**
  87        Return if a certain FC is complex.
  88
  89        @nIndex           index of the FC
  90      */
  91     sal_Bool isComplexFc(sal_uInt32 nIndex) const;
  92
  93 };
  94 }}
  95
  96 #endif