sc/source/filter/inc/xlstring.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_SC_SOURCE_FILTER_INC_XLSTRING_HXX
  21 #define INCLUDED_SC_SOURCE_FILTER_INC_XLSTRING_HXX
  22
  23 #include <vector>
  24 #include <o3tl/typed_flags_set.hxx>
  25
  26 // Constants and enumerations =================================================
  27
  28 /** Flags used to specify import/export mode of strings. */
  29 enum class XclStrFlags : sal_uInt16 {
  30     NONE              = 0x0000,   /// Default string settings.
  31     ForceUnicode      = 0x0001,   /// Always use UCS-2 characters (default: try to compress). BIFF8 only.
  32     EightBitLength    = 0x0002,   /// 8-bit string length field (default: 16-bit).
  33     SmartFlags        = 0x0004,   /// Omit flags on empty string (default: read/write always). BIFF8 only.
  34     SeparateFormats   = 0x0008,   /// Import: Keep old formats when reading unformatted string (default: clear formats); Export: Write unformatted string.
  35     NoHeader          = 0x0010,   /// Export: Don't write the length and flag fields.
  36 };
  37 namespace o3tl {
  38     template<> struct typed_flags<XclStrFlags> : is_typed_flags<XclStrFlags, 0x001f> {};
  39 }
  40
  41
  42 const sal_uInt16 EXC_STR_MAXLEN_8BIT        = 0x00FF;
  43 const sal_uInt16 EXC_STR_MAXLEN             = 0x7FFF;
  44
  45 const sal_uInt8 EXC_STRF_16BIT              = 0x01;
  46 const sal_uInt8 EXC_STRF_FAREAST            = 0x04;
  47 const sal_uInt8 EXC_STRF_RICH               = 0x08;
  48 const sal_uInt8 EXC_STRF_UNKNOWN            = 0xF2;
  49
  50 // Fixed-size characters
  51 const sal_uInt8 EXC_LF_C                    = '\x0A';       /// LF character (used for line break).
  52 const sal_uInt16 EXC_LF                     = EXC_LF_C;     /// LF character (unicode).
  53 const sal_uInt8 EXC_NUL_C                   = '\x00';       /// NUL character.
  54 const sal_uInt16 EXC_NUL                    = EXC_NUL_C;    /// NUL character (unicode).
  55
  56 // Rich-string formatting runs ================================================
  57
  58 /** Represents a formatting run for rich-strings.
  59
  60     An Excel formatting run stores the first formatted character in a
  61     rich-string and the index of a font used to format this and the following
  62     characters.
  63  */
  64 struct XclFormatRun
  65 {
  66     sal_uInt16          mnChar;         /// First character this format applies to.
  67     sal_uInt16          mnFontIdx;      /// Excel font index for the next characters.
  68
  69     explicit XclFormatRun() : mnChar( 0 ), mnFontIdx( 0 ) {}
  70     explicit XclFormatRun( sal_uInt16 nChar, sal_uInt16 nFontIdx ) :
  71                             mnChar( nChar ), mnFontIdx( nFontIdx ) {}
  72 };
  73
  74 inline bool operator==( const XclFormatRun& rLeft, const XclFormatRun& rRight )
  75 {
  76     return (rLeft.mnChar == rRight.mnChar) && (rLeft.mnFontIdx == rRight.mnFontIdx);
  77 }
  78
  79 inline bool operator<( const XclFormatRun& rLeft, const XclFormatRun& rRight )
  80 {
  81     return (rLeft.mnChar < rRight.mnChar) || ((rLeft.mnChar == rRight.mnChar) && (rLeft.mnFontIdx < rRight.mnFontIdx));
  82 }
  83
  84 /** A vector with all formatting runs for a rich-string. */
  85 typedef ::std::vector< XclFormatRun > XclFormatRunVec;
  86
  87 #endif
  88
  89 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */