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