DgnFontManager.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once


#include "DgnPlatform.h"
#include <Bentley/CodePages.h>
#include <Bentley/RefCounted.h>
#include <Bentley/btree/btree_set.h>

DGNPLATFORM_TYPEDEFS (DgnFontNamedSymbol);
DGNPLATFORM_TYPEDEFS (DgnFont);
DGNPLATFORM_TYPEDEFS (DgnFontList);
DGNPLATFORM_TYPEDEFS (DgnFontConfig);
DGNPLATFORM_TYPEDEFS (DgnFontConfigSet);


BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE


typedef RefCountedPtr<DgnFontList>          DgnFontListPtr;
typedef RefCountedPtr<DgnFontNamedSymbol>   DgnFontNamedSymbolPtr;


//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
enum SpecialCharValues
{
    SPECIALCHAR_Degree_Shx                      = 0x007f,
    SPECIALCHAR_PlusMinus_Shx                   = 0x0080,
    SPECIALCHAR_Diameter_Shx                    = 0x0081,
    
    SPECIALCHAR_Degree_Unicode                  = 0x00b0,
    SPECIALCHAR_PlusMinus_Unicode               = 0x00b1,
    SPECIALCHAR_Diameter_Unicode                = 0x2205,   
    SPECIALCHAR_DiameterSign_Unicode            = 0x2300,
    SPECIALCHAR_CapitalOWithStroke_Unicode      = 0x00d8,
    SPECIALCHAR_SmallOWithStroke_Unicode        = 0x00f8,
    SPECIALCHAR_FirstStandardRscFraction        = 0x81,     // While technically customizable per-font, I have never seen this in practice, and the font utility no longer allows it.
    SPECIALCHAR_LastStandardRscFraction         = 0xbf,     // While technically customizable per-font, I have never seen this in practice, and the font utility no longer allows it.

    SPECIALCHAR_UnicodeFraction_1_4             = 0x00bc,
    SPECIALCHAR_UnicodeFraction_1_2             = 0x00bd,
    SPECIALCHAR_UnicodeFraction_3_4             = 0x00be,
    SPECIALCHAR_UnicodeFraction_1_7             = 0x2150,
    SPECIALCHAR_UnicodeFraction_1_9             = 0x2151,
    SPECIALCHAR_UnicodeFraction_1_10            = 0x2152,
    SPECIALCHAR_UnicodeFraction_1_3             = 0x2153,
    SPECIALCHAR_UnicodeFraction_2_3             = 0x2154,
    SPECIALCHAR_UnicodeFraction_1_5             = 0x2155,
    SPECIALCHAR_UnicodeFraction_2_5             = 0x2156,
    SPECIALCHAR_UnicodeFraction_3_5             = 0x2157,
    SPECIALCHAR_UnicodeFraction_4_5             = 0x2158,
    SPECIALCHAR_UnicodeFraction_1_6             = 0x2159,
    SPECIALCHAR_UnicodeFraction_5_6             = 0x215a,
    SPECIALCHAR_UnicodeFraction_1_8             = 0x215b,
    SPECIALCHAR_UnicodeFraction_3_8             = 0x215c,
    SPECIALCHAR_UnicodeFraction_5_8             = 0x215d,
    SPECIALCHAR_UnicodeFraction_7_8             = 0x215e,
    
    // Private use is to allow us to round-trip characters with custom meaning. It is from 0xe0000 through 0xf8ff.
    SPECIALCHAR_PrivateUse_Degree_Unicode       = 0xe000,
    SPECIALCHAR_PrivateUse_PlusMinus_Unicode    = 0xe001,
    SPECIALCHAR_PrivateUse_Diameter_Unicode     = 0xe002,
    SPECIALCHAR_PrivateUse_FirstRscFraction     = 0xe100,
    SPECIALCHAR_PrivateUse_LastRscFraction      = 0xe100 + 63
};

//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
enum class DgnFontType
{
    None       = 0,
    Rsc        = 1,
    TrueType   = 2,
    Shx        = 3,
};

//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
enum class DgnFontFilter
{
    None        = 0,
    Resource    = 1<<0,                                                 
    Shx         = 1<<1,                                                 
    ShxBig      = 1<<2,                                                 
    TrueType    = 1<<3,                                                 
    Missing     = 1<<4,                                                 
    Symbol      = 1<<5,                                                 
    Hidden      = 1<<6,                                                 
    Normal      = 0x000b,   /* Resource | Shx | TrueType, */            
    AllShx      = 0x0006,   /* Shx | ShxBig,  */                        
    All         = 0x007f,   /* Normal | Missing | Hidden | ShxBig, */   
    ResourceShx = 0x0003,   /* Resource | Shx */                        
};

ENUM_IS_FLAGS(DgnFontFilter)

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct DgnFontList : RefCountedBase
{

    //=======================================================================================
    //  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
    // @bsiclass                                                     Bentley Systems
    //=======================================================================================
    enum SortOrder
        {
        SORT_ByType = 0,    
        SORT_ByName = 1     
        };

    public: DGNPLATFORM_EXPORT size_t GetCount ();

    public: DGNPLATFORM_EXPORT DgnFontP GetEntryP (size_t n);

    public: DGNPLATFORM_EXPORT void Sort (SortOrder);
};


//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct DgnFontVisitor
{

    virtual ~DgnFontVisitor ()  {}
    
    virtual bool VisitFont (DgnFontR) = 0;
};

//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
enum class DgnFontNamedSymbolSource
{
    HardCoded,
    CustomFromFontConfig
};

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct DgnFontNamedSymbol : public RefCountedBase
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    DGNPLATFORM_EXPORT DgnFontNamedSymbolSource GetSource () const;
    
    DGNPLATFORM_EXPORT WStringCR GetKey () const;
    
    DGNPLATFORM_EXPORT WStringCR GetDisplayName () const;
    
    DGNPLATFORM_EXPORT UInt32 GetCodePoint () const;
};


//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
CLRPUBLIC struct DgnFont : RefCountedBase
    {
private:
    virtual void MakeClassAbstract() = 0;
public:
public:    
    DGNPLATFORM_EXPORT bool IsCharacterPresent (UInt16 glyphCode) const;

    DGNPLATFORM_EXPORT bool IsPresent () const;

    DGNPLATFORM_EXPORT bool IsMissingFontReported () const;

    DGNPLATFORM_EXPORT void SetMissingFontIsReported ();

    DGNPLATFORM_EXPORT bool IsHidden () const;

    DGNPLATFORM_EXPORT bool IsShxBigFont () const;

    DGNPLATFORM_EXPORT bool IsSymbolFont () const;

    DGNPLATFORM_EXPORT bool IsUnicode () const;

    DGNPLATFORM_EXPORT bool IsValid () const;

    DGNPLATFORM_EXPORT bool IsOutlineFont () const;

    DGNPLATFORM_EXPORT WStringCR GetName () const;

    DGNPLATFORM_EXPORT DgnFontType GetType () const;

    DGNPLATFORM_EXPORT UInt16 GetDegreeCharCode () const;

    DGNPLATFORM_EXPORT UInt16 GetDiameterCharCode () const;

    DGNPLATFORM_EXPORT UInt16 GetPlusMinusCharCode () const;

    DGNPLATFORM_EXPORT UInt32 GetMaxFractionDenominator () const;

    DGNPLATFORM_EXPORT UInt16 GetCharCodeFromFraction (UInt32 numerator, UInt32 denominator, bool reduce=true) const;

    DGNPLATFORM_EXPORT BentleyStatus GetFractionFromCharCode (UInt32& numerator, UInt32& denominator, UInt16 glyphCode) const;

    DGNPLATFORM_EXPORT LangCodePage GetCodePage () const;

    DGNPLATFORM_EXPORT UInt16 GetFirstCharCode () const;

    DGNPLATFORM_EXPORT UInt16 GetLastCharCode () const;

    DGNPLATFORM_EXPORT DgnGlyphP GetGlyphP (UInt16) const;
    
    DGNPLATFORM_EXPORT void GetNamedSymbols (bvector<DgnFontNamedSymbolPtr>&) const;

    DGNPLATFORM_EXPORT void CompressRscFractions (WStringR outStr, WCharCP inStr) const;
                           
    DGNPLATFORM_EXPORT void ExpandRscFractions (WStringR outStr, WCharCP inStr) const;

    DGNPLATFORM_EXPORT void CompressEscapeSequences (WStringR outStr, WCharCP inStr) const;

    DGNPLATFORM_EXPORT void ExpandEscapeSequences (WStringR outStr, WCharCP inStr) const;
    
    }; // DgnFont

typedef bvector<DgnFontCP> T_DgnFontCPVector;

typedef T_DgnFontCPVector*         T_DgnFontCPVectorP, &T_DgnFontCPVectorR;
typedef T_DgnFontCPVector const*   T_DgnFontCPVectorCP;
typedef T_DgnFontCPVector const&   T_DgnFontCPVectorCR;

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
CLRPUBLIC struct DgnFontNumMap : RefCountedBase
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:

    DGNPLATFORM_EXPORT DgnFontP GetFontP (UInt32 fontNum);

    DGNPLATFORM_EXPORT DgnFontR ResolveFont (UInt32 fontNum);

    DGNPLATFORM_EXPORT StatusInt GetFontNumber (UInt32& fontNum, DgnFontCR font, bool addIfNotFound);

    DGNPLATFORM_EXPORT bool VisitFonts (DgnFontVisitor& visitor, DgnFontFilter filter);

    DGNPLATFORM_EXPORT DgnFontP FindFontByName (UInt32* foundNum, WCharCP fontName, DgnFontFilter filter=DgnFontFilter::Normal);

    DGNPLATFORM_EXPORT DgnFontListPtr CreateUsedFontList (DgnFontFilter filter=DgnFontFilter::Normal);
};


//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct DgnFontManager : DgnHost::IHostObject
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    DGNPLATFORM_EXPORT static DgnFontNumMapP GetDgnFontMapP (DgnFileP dgnFile);
    
    static DgnFontNumMapP GetDgnFontMapP (DgnModelRefP modelRef) {return GetDgnFontMapP(modelRef->GetDgnFileP());}

    DGNPLATFORM_EXPORT static DgnFontR GetDefaultRscFont ();

    DGNPLATFORM_EXPORT static DgnFontR GetDefaultShxFont ();

    DGNPLATFORM_EXPORT static DgnFontP GetDefaultShxBigFont ();

    DGNPLATFORM_EXPORT static DgnFontR GetDefaultTrueTypeFont ();

    DGNPLATFORM_EXPORT static DgnFontR GetDecoratorFont ();

    DGNPLATFORM_EXPORT static DgnFontP GetFontByNumber (UInt32 fontNum, DgnFileP dgnFile);
    
    static DgnFontP GetFontByNumber (UInt32 fontNum, DgnModelRefP modelRef) {return GetFontByNumber (fontNum, modelRef->GetDgnFileP());}

    DGNPLATFORM_EXPORT static DgnFontR ResolveFontNum (UInt32 fontNum, DgnFileP dgnFile);
    
    static DgnFontR ResolveFontNum (UInt32 fontNum, DgnModelRefP modelRef) {return ResolveFontNum (fontNum, modelRef->GetDgnFileP());}

    DGNPLATFORM_EXPORT static DgnFontP FindSystemFont (WCharCP fontName, DgnFontFilter filter=DgnFontFilter::Normal);

    DGNPLATFORM_EXPORT static bool VisitAllSystemFonts (DgnFontVisitor& visitor, DgnFontFilter filter=DgnFontFilter::Normal);

    DGNPLATFORM_EXPORT static DgnFontListPtr CreateKnownFontList (DgnFileP dgnFile=NULL, DgnFontFilter filter=DgnFontFilter::Normal);

    DGNPLATFORM_EXPORT static DgnFontCR GetFontForCodePage (UInt32 fontNum, UInt32 bigFontNum, DgnFileR);
};


//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct DgnGlyph
{
private:
    virtual void MakeClassAbstract() = 0;
public:

public:     
    DGNPLATFORM_EXPORT BentleyStatus GetGPA (GPArrayP gpa);
}; 



END_BENTLEY_DGNPLATFORM_NAMESPACE