Line data    Source code

       1              : /*
       2              :  * SPDX-License-Identifier: GPL-3.0-only
       3              :  * MuseScore-CLA-applies
       4              :  *
       5              :  * MuseScore Studio
       6              :  * Music Composition & Notation
       7              :  *
       8              :  * Copyright (C) 2024 MuseScore Limited and others
       9              :  *
      10              :  * This program is free software: you can redistribute it and/or modify
      11              :  * it under the terms of the GNU General Public License version 3 as
      12              :  * published by the Free Software Foundation.
      13              :  *
      14              :  * This program is distributed in the hope that it will be useful,
      15              :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      16              :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      17              :  * GNU General Public License for more details.
      18              :  *
      19              :  * You should have received a copy of the GNU General Public License
      20              :  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
      21              :  */
      22              : #pragma once
      23              : 
      24              : #include <string>
      25              : 
      26              : #include "global/io/path.h"
      27              : #include "global/modularity/imoduleinterface.h"
      28              : #include "types/font.h"
      29              : #include "types/geometry.h"
      30              : #include "types/fontstypes.h"
      31              : 
      32              : namespace muse::draw {
      33              : class IFontsEngine : MODULE_GLOBAL_INTERFACE
      34              : {
      35          109 :     INTERFACE_ID(muse::draw::IFontsEngine)
      36              : public:
      37           23 :     virtual ~IFontsEngine() = default;
      38              : 
      39              :     virtual void setRenderCacheDirPath(const io::path_t& path, const std::string& revision = std::string()) = 0;
      40              :     virtual void clearLoadedFaces() = 0;
      41              : 
      42              :     virtual double lineSpacing(const Font& f) const = 0;
      43              :     virtual double xHeight(const Font& f) const = 0;
      44              :     virtual double height(const Font& f) const = 0;
      45              :     virtual double capHeight(const Font& ff) const = 0;
      46              :     virtual double ascent(const Font& f) const = 0;
      47              :     virtual double descent(const Font& f) const = 0;
      48              : 
      49              :     virtual double underlinePos(const Font& f) const = 0;
      50              :     virtual double lineWidth(const Font& f) const = 0;
      51              :     virtual double strikeOutPos(const Font& f) const = 0;
      52              : 
      53              :     virtual bool inFont(const Font& f, char32_t ucs4) const = 0;
      54              : 
      55              :     virtual double horizontalAdvance(const Font& f, const char32_t& ch) const = 0;
      56              :     virtual double horizontalAdvance(const Font& f, const std::u32string& text) const = 0;
      57              : 
      58              :     virtual RectF boundingRect(const Font& f, const char32_t& ch) const = 0;
      59              :     virtual RectF boundingRect(const Font& f, const std::u32string& text) const = 0;
      60              :     virtual RectF tightBoundingRect(const Font& f, const std::u32string& text) const = 0;
      61              : 
      62              :     // Draw
      63              :     virtual std::vector<GlyphImage> render(const Font& f, const std::u32string& text) const = 0;
      64              : };
      65              : }