IFontMgr.h

//========================================================================================
// 
// $File$
// 
// Owner: emenning
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// Purpose:
// IFontMgr is the Interface used to retrieve Fonts, FontGroups, etc.
// The Interfaces returned are not boss objects (as of 10/17/96) but are RefCounted objects
// 
//========================================================================================

#ifndef __IFontMgr__
#define __IFontMgr__

#include "FontMgrID.h"
#include "PMString.h"
#include "PMMatrix.h"

#include "BravoForwardDecl.h"

#include <string> // for virtual std::string GetDefaultFontPSName()


class IPMFont;
class IFontInstance;
class IFontGroup;
class FontGroupIteratorCallBack;
class IUsedFontList;
class IFontFamily;
class IWRFontContext;
class IFontMenuData;

class IPMFont;
class UIDList;

//----------------------------------------------------------------------------------------
// Interface IFontMgr
//----------------------------------------------------------------------------------------

class IFontMgr : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IFONTMGR };

 enum FontStyleBits{ kNormal = 0x00, kItalic = 0x01, kBold = 0x02, kBoldItalic = 0x03,
 kSmallCaps = 0x04, kCapStyles = 0x04
 } ;

 enum WritingDirection{ kWD_LeftToRight = 0, kWD_RightToLeft, kWD_TopToBottom
 } ;

 enum InternalFake{
 kInternalFake_Not = 0x0000,
 kInternal_Substitution = 0x0001,
 kInternalFake_Smallcap = 0x0004
 } ;

 // matches CTOriginatingOS enum from cooltype.
 enum OriginalOS{
 kOriginalMacOS,
 kOriginalWinOS,
 kOriginalUnknownOS
 } ;

 struct FontNameInfo
 {
 public:
 typedef object_type data_type;
 PMString fPostScriptName;
 PMString fFamilyName;
 PMString fStyleName;
 PMString fFamilyNameNative;
 PMString fStyleNameNative;
 bool16 fFontInfoSet;
 } ;

 virtual int32 CurrentFontSystemSeed(bool16 fullCheck = kFalse, bool16 cooltypeSeedOnly = kFalse) const = 0;

 virtual void CoolTypeShuttingDown() = 0;

 virtual const PMString& GetDefaultFontName() = 0;

 virtual void SetDefaultFontName(const PMString& s) = 0;

 virtual bool16 IsFontAvailable(const PMString &fontname, int32 writingscript = kDontKnowScript) = 0;

 virtual bool16 IsSuitableUIFont(IPMFont* pmFont) = 0;

 
 virtual IPMFont* QueryFont(const std::string &fontName, FontStyleBits style = kNormal, int32 writingscript = kDontKnowScript,
 PMReal smallcapscale = 0.7, InternalFake fake = kInternalFake_Not) = 0;

 virtual IPMFont* QueryFont(const PMString &fontName, FontStyleBits style = kNormal, int32 writingscript = kDontKnowScript,
 PMReal smallcapscale = 0.7, InternalFake fake = kInternalFake_Not) = 0;

 virtual IPMFont* QueryFont(const IFontGroup *fontGroup, int32 index, FontStyleBits style = kNormal,
 PMReal smallcapscale = 0.7, InternalFake fake = kInternalFake_Not) = 0;

 virtual IPMFont* QueryFont(const CTFontDict* rawFont, InternalFake fake = kInternalFake_Not, int32 index = -1,
 bool16 bIsEPSFont = kFalse, bool16 bIsEmbeddedFont = kFalse, CCTEncoding *encoding = nil) = 0;

 virtual IPMFont* QueryFont(const CTFontDict* rawFont, Fixed *designAxes, InternalFake fake = kInternalFake_Not,
 bool16 bIsEPSFont = kFalse, bool16 bIsEmbeddedFont = kFalse, CCTEncoding *encoding = nil) = 0;

 virtual IPMFont* QueryFontPlatform(const PMString &fontName, FontStyleBits style,
 int32 ctScript = kDontKnowScript, OriginalOS os = kOriginalUnknownOS, FontNameInfo* outNameInfo = nil) = 0;

 virtual IFontInstance *QueryFontInstance(const PMString &fontName, const PMMatrix &matrix, int32 writingscript = kDontKnowScript, WritingDirection dir = kWD_LeftToRight,
 FontStyleBits style = kNormal, Fixed *designV = nil, PMReal smallcapscale = 0.7) = 0;
 virtual IFontInstance *QueryFontInstance(const IPMFont* font, const PMMatrix &matrix, WritingDirection dir = kWD_LeftToRight) = 0;

 virtual IFontGroup *QueryFontGroup(const PMString &groupName) = 0;
 virtual IFontGroup *QueryFontGroup(int32 groupIndex) = 0;

 virtual int32 GetNumFontGroups() = 0;

 virtual void IterateFontGroups( FontGroupIteratorCallBack *callBack ) = 0;

 virtual void ForceUpdateFontSystem() = 0;

 virtual IPMFont *FindVariant (IPMFont *basefont, FontStyleBits stylebits, PMReal smallCapScale, int32 technology) = 0;

 virtual void MarkBadFont (CTFontDict *badFontDict) = 0;

 virtual IPMFont *QueryFontFromDisplayName(const PMString &displayFamilyName, PMString &fontStyle) = 0;

 virtual void AddFont (CTFontDict *dict) = 0;
 virtual void DeleteFont (CTFontDict *dict) = 0;

 virtual std::string GetDefaultFontPSName(int32 script = kDontKnowScript) = 0;

 virtual IWRFontContext* GetWRFontContext() const = 0;

 virtual void AllowPurge() = 0;
 virtual void DisallowPurge() = 0;

 virtual void AddDirectory(IDFile fontsPath) = 0;
 virtual void RemoveUnusedFontsFromCache() = 0;

 virtual ActionID IterateTypeQuestFonts(const ActionID lastLocalActionID, IFontMenuData* fontMenuData) = 0;
 virtual HarfbuzzCooltype* GetHarfbuzzFontAccess() = 0;
 virtual bool16 AddCustomOTVarInstance(IFontGroup *fontGroup, const Fixed *designAxis) = 0;
 
 virtual bool16 HasExtraDefaultVariableFont(CTFontDict* dict) const = 0;
 
 virtual void GetDefaultVariableFontName(PMString& fontName, CTFontDict* dict) const = 0;
 
 virtual IPMFont* QueryVariableFont(const IFontGroup *fontGroup,const PMString& styleName) const = 0;

};



//----------------------------------------------------------------------------------------
// Class FontGroupIteratorCallBack
//----------------------------------------------------------------------------------------

class FontGroupIteratorCallBack
{
public:
 enum MissingFonts { kSkip, // skip missing fonts.
 kBeforeFonts, // iterate missing fonts before the other fonts.
 kAfterFonts, // iterate missing fonts after the other fonts.
 kOnly // iterate only over missing fonts, skip the other fonts.
 };

 virtual void OnStart() = 0;

 virtual void OnEnd() = 0;

 virtual void OnLocaleScriptFontsStart() = 0;

 virtual void OnLocaleScriptFontsEnd() = 0;

 virtual void OnMMFontsStart() = 0;
 virtual void OnMMFontsEnd() = 0;
 virtual void OnMMAxes( IPMFont *pFont, const Fixed *sourceAxes, int32 numAxes ) = 0;


 virtual void OnFont( IPMFont *pFont, IFontGroup *fontGroup, const PMString &displayFamilyName, const PMString &displayStyleName ) = 0;

 virtual void OnFontGroupStart( IFontGroup *fontGroup ) = 0;
 virtual void OnFontGroupEnd( IFontGroup *fontGroup ) = 0;

 virtual void OnFontsAddedForLastScript() = 0;


 virtual bool16 RunFamilyOnly() const = 0;

 virtual int16 GetNamesFlag() const = 0;

 virtual bool16 RunMMFonts() const = 0;

 virtual bool16 SkipThisFont( IPMFont *font ) const = 0;

 // missing fonts
 virtual MissingFonts RunMissingFonts() const = 0;
 virtual void OnMissingFontsStart() = 0;
 virtual void OnMissingFontsEnd() = 0;
 virtual IUsedFontList * QueryUsedFontList() = 0;
 virtual void OnMissingFont( IFontFamily *fontFamily, int32 faceIndex, const PMString &displayFamilyName, const PMString &displayStyleName ) = 0;

 virtual const UIDList * UseFontUIDList() const = 0;
 virtual bool16 RunDuplicateFonts() const = 0;
};

#endif