writerfilter/source/doctok/WW8PieceTable.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: WW8PieceTable.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_PIECE_TABLE_HXX
  32 #define INCLUDED_WW8_PIECE_TABLE_HXX
  33
  34 #include <sal/types.h>
  35 #include <doctok/WW8Document.hxx>
  36
  37 #include <boost/shared_ptr.hpp>
  38 #include <iostream>
  39
  40 namespace writerfilter {
  41 namespace doctok {
  42
  43 using namespace ::std;
  44
  45 struct Cp;
  46 struct Fc;
  47 class CpAndFc;
  48
  49 /**
  50    The piece table of a Word document.
  51
  52    The piece table associates character positions (CP) and File
  53    character positions (FC). In a FC based view the piece table
  54    defines intervals of FCs that contain consecutive text.
  55
  56    CPs and FCs can be complex, i.e. the associated text is stored in
  57    bytes. Otherwise the text encoding is UTF-16.
  58  */
  59 class WW8PieceTable
  60 {
  61 public:
  62     virtual ~WW8PieceTable() {}
  63     /**
  64        Shared pointer to piece table
  65      */
  66     typedef boost::shared_ptr<WW8PieceTable> Pointer_t;
  67
  68     /**
  69        Convert CP to FC.
  70
  71        @param aCpIn    CP to convert
  72
  73        @return FC associated with CP
  74      */
  75     virtual Fc cp2fc(const Cp & aCpIn) const = 0;
  76
  77     /**
  78        Convert FC to CP.
  79
  80        @param aFcIn    FC to convert
  81
  82        @return CP associated with FC
  83      */
  84     virtual Cp fc2cp(const Fc & aFcIn) const = 0;
  85
  86     /**
  87        Check if CP is complex.
  88
  89        @param  aCp    CP to check
  90        @retval true   CP is complex
  91        @retval false  else
  92      */
  93     virtual bool isComplex(const Cp & aCp) const = 0;
  94
  95     /**
  96        Check if FC is complex.
  97
  98        @param  aFc    FC to check
  99        @retval true   FC is complex
 100        @retval false  else
 101      */
 102     virtual bool isComplex(const Fc & aFc) const = 0;
 103
 104     /**
 105        Return number of entries.
 106      */
 107     virtual sal_uInt32 getCount() const = 0;
 108
 109     /**
 110        Return first CP.
 111      */
 112     virtual Cp getFirstCp() const = 0;
 113
 114     /**
 115        Return first FC.
 116     */
 117     virtual Fc getFirstFc() const = 0;
 118
 119     /**
 120        Return last CP.
 121     */
 122     virtual Cp getLastCp() const = 0;
 123
 124     /**
 125         Return last FC.
 126     */
 127     virtual Fc getLastFc() const = 0;
 128
 129     /**
 130        Return CP at index.
 131
 132        @param  nIndex    index of CP to return
 133      */
 134     virtual Cp getCp(sal_uInt32 nIndex) const = 0;
 135
 136     /**
 137        Return FC at index.
 138
 139        @param nIndex     index of FC to return
 140     */
 141     virtual Fc getFc(sal_uInt32 nIndex) const = 0;
 142
 143     /**
 144         Create CpAndFc from Cp.
 145
 146         @param rCp   the Cp
 147
 148         @return CpAndFc containing rCp and corresponding Fc
 149     */
 150     virtual CpAndFc createCpAndFc(const Cp & rCp, PropertyType eType) const = 0;
 151
 152     /**
 153         Create CpAndFc from Fc.
 154
 155         @param rFc   the Fc
 156
 157         @return CpAndFc containing rFc and corresponding Cp
 158     */
 159     virtual CpAndFc createCpAndFc(const Fc & rFc, PropertyType eType) const = 0;
 160
 161     /**
 162        Dump piece table.
 163
 164        @param o        stream to dump to
 165     */
 166     virtual void dump(ostream & o) const = 0;
 167 };
 168
 169 /**
 170    Dump piece table.
 171
 172    @param o             stream to dump to
 173    @param rPieceTable   piece table to dump
 174 */
 175 ostream & operator << (ostream & o, const WW8PieceTable & rPieceTable);
 176 }}
 177
 178 #endif // INCLUDED_WW8_PIECE_TABLE_HXX