include/vcl/fontcharmap.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_FONTCHARMAP_HXX
  21 #define INCLUDED_FONTCHARMAP_HXX
  22
  23 #include <vcl/dllapi.h>
  24 #include <vcl/vclenum.hxx>
  25 #include <tools/ref.hxx>
  26 #include <vector>
  27
  28 class ImplFontCharMap;
  29 class FontCharMap;
  30 class OutputDevice;
  31
  32 typedef tools::SvRef<ImplFontCharMap> ImplFontCharMapRef;
  33 typedef tools::SvRef<FontCharMap> FontCharMapRef;
  34
  35 class VCL_DLLPUBLIC FontCharMap final : public SvRefBase
  36 {
  37 public:
  38     /** A new FontCharMap is created based on a "default" map, which includes
  39         all codepoints in the Unicode BMP range, including surrogates.
  40      **/
  41     FontCharMap();
  42
  43     /** A new FontCharMap is created based on passed arguments.
  44      */
  45     FontCharMap(bool bMicrosoftSymbolMap, std::vector<sal_UCS4> aRangeCodes);
  46
  47     virtual ~FontCharMap() override;
  48
  49     /** Get the default font character map
  50
  51         @returns the default font character map.
  52      */
  53     static FontCharMapRef GetDefaultMap(bool bMicrosoftSymbolMap);
  54
  55     /** Determines if the font character map is the "default". The default map
  56         includes all codepoints in the Unicode BMP range, including surrogates.
  57
  58         @returns true if default map, false if not default map.
  59      */
  60     bool                IsDefaultMap() const;
  61
  62     /** Does the font character map include the UCS4 character?
  63
  64         @returns true if character exists in font character map, false is not.
  65      */
  66     bool                HasChar( sal_UCS4 ) const;
  67
  68     /** Returns the number of chars supported by the font, which
  69         are inside the unicode range from cMin to cMax (inclusive).
  70
  71         @param  cMin        Lowest codepoint in range to be counted
  72         @param  cMax        Highest codepoint in range to be counted
  73
  74         @returns number of characters in the font charmap between the two
  75                  codepoints.
  76      */
  77     int                 CountCharsInRange( sal_UCS4 cMin, sal_UCS4 cMax ) const;
  78
  79     /** Get the number of characters in the font character map.
  80
  81         @returns number of characters in the font character map.
  82      */
  83     int                 GetCharCount() const;
  84
  85     /** Get the first character in the font character map.
  86
  87         @returns first character in the font character map.
  88      */
  89     sal_UCS4            GetFirstChar() const;
  90
  91     /** Get the last character in the font character map.
  92
  93         @returns last character in the font character map.
  94      */
  95     sal_UCS4            GetLastChar() const;
  96
  97     /** Get the next character in the font character map. This is important
  98         because character maps (e.g. the default map which holds the characters
  99         in the BMP plane) can have discontiguous ranges.
 100
 101         @param  cChar       Character from which to find next character
 102
 103         @returns next character in the font character map.
 104      */
 105     sal_UCS4            GetNextChar( sal_UCS4 cChar ) const;
 106
 107     /** Get the previous character in the font character map. This is important
 108         because character maps (e.g. the default map which holds the characters
 109         in the BMP plane) can have discontiguous ranges.
 110
 111         @param  cChar       Character from which to find previous character
 112
 113         @returns previous character in the font character map.
 114      */
 115     sal_UCS4            GetPrevChar( sal_UCS4 cChar ) const;
 116
 117     /** Get the index of a particular character in the font character map. The
 118         index is different from the codepoint, because font character maps can
 119
 120         determine the index.
 121
 122         @param  cChar       Character used to find index number
 123
 124         @returns Index of character in font character map.
 125      */
 126     int                 GetIndexFromChar( sal_UCS4 cChar ) const;
 127
 128     /** Get the character at a particular index in the font character map. The
 129         index is different from the codepoint, because font character maps can
 130
 131         determine the character.
 132
 133         @param  nCharIndex  Index used to find the character
 134
 135         @returns Character in font character map.
 136      */
 137     sal_UCS4            GetCharFromIndex( int nCharIndex ) const;
 138
 139     bool isMicrosoftSymbolMap() const;
 140
 141 private:
 142     ImplFontCharMapRef mpImplFontCharMap;
 143
 144     friend class ::OutputDevice;
 145
 146     int                 findRangeIndex( sal_UCS4 ) const;
 147
 148                         FontCharMap( ImplFontCharMapRef pIFCMap );
 149
 150     // prevent assignment and copy construction
 151                         FontCharMap( const FontCharMap& ) = delete;
 152     void                operator=( const FontCharMap& ) = delete;
 153 };
 154
 155 #endif // INCLUDED_FONTCHARMAP_HXX
 156
 157 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */