writerfilter/source/doctok/WW8Clx.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_WW8_CLX_HXX
  21 #define INCLUDED_WW8_CLX_HXX
  22
  23 #include <doctok/resources.hxx>
  24
  25 #include "WW8OutputWithDepth.hxx"
  26
  27 namespace writerfilter {
  28 namespace doctok
  29 {
  30
  31 /**
  32    Piece table as stored in a Word file.
  33
  34    It contains character positions (CPs) and file character positions
  35    (FCs). Each CP is correlated to one FC.
  36  */
  37 class WW8Clx : public WW8StructBase
  38 {
  39     /// Pointer to the file information block.
  40     WW8Fib::Pointer_t pFib;
  41
  42     /// Offset where FCs begin
  43     sal_uInt32 nOffsetPieceTable;
  44
  45 public:
  46     /// Pointer to Clx.
  47     typedef boost::shared_ptr<WW8Clx> Pointer_t;
  48
  49     WW8Clx(WW8Stream & rStream,
  50            sal_uInt32 nOffset, sal_uInt32 nCount);
  51
  52     virtual void dump(OutputWithDepth<string> & o) const;
  53
  54     /**
  55        Return the number of pieces.
  56     */
  57     sal_uInt32 getPieceCount() const;
  58
  59     /**
  60        Return a certain character position.
  61
  62        @param nIndex     index of the character position
  63      */
  64     sal_uInt32 getCp(sal_uInt32 nIndex) const;
  65
  66     /**
  67        Return a certain file character position.
  68
  69        @param nIndex     index of the file character position
  70      */
  71     sal_uInt32 getFc(sal_uInt32 nIndex) const;
  72
  73     /**
  74        Return if a certain FC is complex.
  75
  76        @nIndex           index of the FC
  77      */
  78     sal_Bool isComplexFc(sal_uInt32 nIndex) const;
  79
  80 };
  81 }}
  82
  83 #endif
  84
  85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */