/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */

/*

 * This file is part of the LibreOffice project.

 *

 * This Source Code Form is subject to the terms of the Mozilla Public

 * License, v. 2.0. If a copy of the MPL was not distributed with this

 * file, You can obtain one at http://mozilla.org/MPL/2.0/.

 *

 * This file incorporates work covered by the following license notice:

 *

 *   Licensed to the Apache Software Foundation (ASF) under one or more

 *   contributor license agreements. See the NOTICE file distributed

 *   with this work for additional information regarding copyright

 *   ownership. The ASF licenses this file to you under the Apache

 *   License, Version 2.0 (the "License"); you may not use this file

 *   except in compliance with the License. You may obtain a copy of

 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .

 */

#pragma once

#include <sal/config.h>

#include <memory>

#include <freetype/config/ftheader.h>

#include FT_FREETYPE_H

#include FT_GLYPH_H

#include <vcl/dllapi.h>

#include <vcl/outdev.hxx>

#include <fontattributes.hxx>

#include <font/FontMetricData.hxx>

#include <glyphid.hxx>

#include <unordered_map>

class FreetypeFont;

class FreetypeFontFile;

class FreetypeFontInstance;

class FreetypeFontInfo;

class FontConfigFontOptions;

namespace vcl::font

{

class PhysicalFontCollection;

}

namespace basegfx { class B2DPolyPolygon; }

 /**

  * The FreetypeManager caches various aspects of Freetype fonts

  *

  * It mainly consists of two std::unordered_map lists, which hold the items of the cache.

  *

  * They form kind of a tree, with FreetypeFontFile as the roots, referenced by multiple FreetypeFontInfo

  * entries, which are referenced by the FreetypeFont items.

  *

  * All of these items have reference counters, but these don't control the items life-cycle, but that of

  * the managed resources.

  *

  * The respective resources are:

  *   FreetypeFontFile = holds the mmapped font file, as long as it's used by any FreetypeFontInfo.

  *   FreetypeFontInfo = holds the FT_FaceRec_ object, as long as it's used by any FreetypeFont.

  *   FreetypeFont     = holds the FT_SizeRec_ and is owned by a FreetypeFontInstance

  *

  * FreetypeFontInfo therefore is embedded in the Freetype subclass of PhysicalFontFace.

  * FreetypeFont is owned by FreetypeFontInstance, the Freetype subclass of LogicalFontInstance.

  *

  * Nowadays there is not really a reason to have separate files for the classes, as the FreetypeManager

  * is just about handling of Freetype based fonts, not some abstract glyphs.

  **/

class VCL_DLLPUBLIC FreetypeManager final

{

public:

    FreetypeManager(const FreetypeManager&) = delete;

    FreetypeManager& operator=(const FreetypeManager&) = delete;

    SAL_DLLPRIVATE ~FreetypeManager();

    static FreetypeManager& get();

    void                    AddFontFile(const OString& rNormalizedName,

                                int nFaceNum, int nVariantNum,

                                sal_IntPtr nFontId,

                                const FontAttributes&);

    void                    RemoveFontFile(sal_IntPtr nFontId);

    SAL_DLLPRIVATE void     AnnounceFonts( vcl::font::PhysicalFontCollection* ) const;

    void                    ClearFontCache();

    SAL_DLLPRIVATE FreetypeFont* CreateFont(FreetypeFontInstance& rLogicalFont);

private:

    // to access the constructor

    friend class GenericUnixSalData;

    SAL_DLLPRIVATE explicit FreetypeManager();

    SAL_DLLPRIVATE static void InitFreetype();

    SAL_DLLPRIVATE FreetypeFontFile* FindFontFile(const OString& rNativeFileName);

    typedef std::unordered_map<sal_IntPtr, std::shared_ptr<FreetypeFontInfo>> FontInfoList;

    typedef std::unordered_map<const char*, std::unique_ptr<FreetypeFontFile>, rtl::CStringHash, rtl::CStringEqual> FontFileList;

    FontInfoList            m_aFontInfoList;

    FontFileList            m_aFontFileList;

};

class VCL_DLLPUBLIC FreetypeFont final

{

public:

    SAL_DLLPRIVATE ~FreetypeFont();

    SAL_DLLPRIVATE const OString&          GetFontFileName() const;

    SAL_DLLPRIVATE int                     GetFontFaceIndex() const;

    SAL_DLLPRIVATE int                     GetFontFaceVariation() const;

    bool                    TestFont() const { return mbFaceOk;}

    SAL_DLLPRIVATE FT_Face                 GetFtFace() const;

    const FontConfigFontOptions* GetFontOptions() const;

    SAL_DLLPRIVATE void                    GetFontMetric(FontMetricDataRef const &) const;

    SAL_DLLPRIVATE bool                    GetGlyphOutline(sal_GlyphId, basegfx::B2DPolyPolygon&, bool) const;

    bool                    GetAntialiasAdvice() const;

private:

    friend class FreetypeFontInstance;

    friend class FreetypeManager;

    SAL_DLLPRIVATE explicit FreetypeFont(FreetypeFontInstance&, std::shared_ptr<FreetypeFontInfo>  rFontInfo);

    SAL_DLLPRIVATE void ApplyGlyphTransform(bool bVertical, FT_Glyph) const;

    FreetypeFontInstance& mrFontInstance;

    // 16.16 fixed point values used for a rotated font

    tools::Long                    mnCos;

    tools::Long                    mnSin;

    int                     mnWidth;

    int                     mnPrioAntiAlias;

    std::shared_ptr<FreetypeFontInfo> mxFontInfo;

    double                  mfStretch;

    FT_FaceRec_*            maFaceFT;

    FT_SizeRec_*            maSizeFT;

    mutable std::unique_ptr<FontConfigFontOptions> mxFontOptions;

    bool                    mbFaceOk;

};

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */