API_REF/Public_API: comparison epoc32/include/fntstore.h

equal deleted inserted replaced

-:e1b950c65cb4
+:837f303aceeb
-// Copyright (c) 1995-2009 Nokia Corporation and/or its subsidiary(-ies).
+/*
-// All rights reserved.
+* Copyright (c) 1995-2009 Nokia Corporation and/or its subsidiary(-ies).
-// This component and the accompanying materials are made available
+* All rights reserved.
-// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
+* This component and the accompanying materials are made available
-// which accompanies this distribution, and is available
+* under the terms of "Eclipse Public License v1.0"
-// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
+* which accompanies this distribution, and is available
-//
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
-// Initial Contributors:
+*
-// Nokia Corporation - initial contribution.
+* Initial Contributors:
-//
+* Nokia Corporation - initial contribution.
-// Contributors:
+*
-//
+* Contributors:
-// Description:
+*
-//
+* Description:
+*
+*/
 #ifndef FNTSTORE_H__
 #define FNTSTORE_H__
 #include <e32std.h>
 #include <f32file.h>
 #include <gdi.h>
 #include <openfont.h>
+#include <linkedfonts.h>
+/** Defines the maximum number of linked typefaces that may be placed in a linked typeface specification
+WARNING: Constant for internal use ONLY.  Compatibility is not guaranteed in future releases.
+@publishedAll
+@released
+*/
+const TInt KMaxLinkedTypefaces = 12;
+/** Defines the maximum number of linked typeface groups that may be placed in a linked typeface specification
+WARNING: Constant for internal use ONLY.  Compatibility is not guaranteed in future releases.
+@publishedAll
+@released
+*/
+const TInt KMaxLinkedTypefaceGroups = 12;
+/** Defines the maximun number of threads that may tranverse the COpenFontSessionCacheList (read-only)
+@publishedAll
+@released
+*/
+const TInt KSessionCacheSemaphoreCount = 12;
+/** Defines the name of the semaphore which is used to exclude threads that may tranverse
+* the COpenFontSessionCacheList (read-only) with FBserv.
+@publishedAll
+@released
+*/
+_LIT(KSessionCacheSemaphoreName,"FBSSessionCacheSemaphore");
 class CLinkedTypefaceSpecification;
-class CLinkedFontSpecification;
+class TLinkedTypefaceSpecificationArgs;
-class TLinkedTypefaceSpecArgs;
 class CFbClient;
 class CFontStoreFile;
 class CFontBitmap;
 class RReadStream;
 class TTypefaceFontBitmap;
 class TShapeHeader;
 class TShapeMessageParameters;
 class CTypefaceSupportInfo;
+class COpenFontRasterizer;
+class CLinkedTypefaceGroup;
+IMPORT_C extern const TInt8 KLinkedFontDrive;
+IMPORT_C extern const TUint32 KFontTable_GlyphOutline_CacheMaxMem;
 /**
-@internalTechnology
+WARNING: Class for internal use ONLY.  Compatibility is not guaranteed in future releases.
-*/
+@publishedAll
+@released
+*/
 class TCharacterMetrics
 	{
-	public:
+public:
 	IMPORT_C TCharacterMetrics();
+public:
 	TInt16 iAscentInPixels;
 	TInt16 iHeightInPixels;
 	TInt16 iLeftAdjustInPixels;
 	TInt16 iMoveInPixels;
 	TInt16 iRightAdjustInPixels;
 	};
-class TAlgStyle
 /**
 An algorithmic style for how a font is drawn.
 Holds attributes such as whether the font is bold or italic, and the width
 and height factors. This is used as an input parameter for the GetFontById() method
 @released
 @see CWsScreenDevice::GetFontById()
 @see CFbsTypefaceStore::GetFontById()
 @see CFbsDevice::GetFontById()
 */
+class TAlgStyle
 	{
 public:
 	IMPORT_C TAlgStyle();
 	IMPORT_C void SetIsBold(TBool aIsBold);
 	IMPORT_C void SetIsItalic(TBool aIsItalic);
 	TInt8 iWidthFactor;
 	/** This member is private and not intended for use. */
 	TInt8 iHeightFactor;
 	};
-class CLinkedFontInformation;
 /**
 Bitmap font class.
 An object of this class may either access and use a bitmap font (a CFontBitmap)
 or an open font (a COpenFont).
 Stored in a CFontStore.
 @publishedAll
 @released
 */
 class CBitmapFont : public CFont
 	{
+	friend class CFbsFont;
 	friend class CFontStore;
-	friend class CLinkedFontSpecification;
+	friend class CFbsBitGc;
-	friend class CLinkedFontInformation;
 public:
 	// New functions
 	TUid Uid() const;
 	IMPORT_C TCharacterMetrics CharacterMetrics(TInt aCode,const TUint8*& aBytes) const;
 	IMPORT_C TBool GetCharacterData(TInt aSessionHandle, TInt aCode, TOpenFontCharMetrics& aMetrics, const TUint8*& aBitmap) const;
 	IMPORT_C void DeleteShape(TInt aSessionHandle,TShapeHeader* aHeader);
 	IMPORT_C void operator delete(TAny*);
 	inline TBool IsOpenFont() const;
 	inline COpenFont* OpenFont() const;
 	inline TGlyphBitmapType GlyphBitmapType() const;
-	IMPORT_C CLinkedFontInformation* LinkedFontInformation() const;
+	IMPORT_C TUint32 UniqueFontId();
-	IMPORT_C CBitmapFont* NextFontClientSpace() const;
+	IMPORT_C TInt GetFontTable(TUint32 aTag, TAny*& aTableContent,
-	IMPORT_C TBool IsLinkedFont()const;
+	        TInt& aLength, TInt aSessionHandle);
-	IMPORT_C CBitmapFont* FontWithCharacter(TInt aCode, CLinkedFontInformation *&aInfo, TBool aSearchAllFonts, TBool aGetCanonicalDefault) const;
+IMPORT_C TInt GetGlyphOutline(TUint aCode,
+TBool aHinted, TAny*& aOutline, TInt& aLength, TInt aSessionHandle);
+IMPORT_C void ReleaseGlyphOutlines(TInt aCount, const TUint* aCodes,
+TBool aHinted, TInt aSessionHandle);
+IMPORT_C void ReleaseFontTable(TUint32 aTag, TInt aSessionHandle);
 private:
 	// From CFont
 	IMPORT_C virtual TUid DoTypeUid() const;
 	IMPORT_C virtual TInt DoHeightInPixels() const;
 	IMPORT_C virtual TInt DoAscentInPixels() const;
 	inline void operator delete(TAny*, TAny*) {}
 	TInt Width(TInt aNum) const;
 	TInt Height(TInt aNum) const;
 	CFontBitmap* FontBitmap() const;
 	void InstallOpenFontShaper(COpenFont* aOpenFont, CShaper::TInput& aShaperInput);
+	TInt DoTextWidthInPixels(const TDesC &aText, const TMeasureTextInput* aParam) const;
+	void SetUniqueFontId(TUint32 aUniqueFontId);
 private:
 	TFontSpec iFontSpecInTwips;
 public:
 	/** The algorithmic font style. */
 	TAlgStyle iAlgStyle;	// must not move this member
 private:
-	// Binary Compatibility warning - data member iOpenFont is referenced by inline methods
+// Binary Compatibility warning - data member iOpenFont is referenced by inline methods
-	RHeap* iHeap;
+RHeap* iHeap;
-	TInt iFontBitmapOffset;
+TInt iFontBitmapOffset;
-	COpenFont* iOpenFont;	// if iOpenFont is non-null this is an open font and many functions are forwarded to it
+// In order to be able to work with the flexible memory model, iOpenFont is
-#ifdef SYMBIAN_SUPPORT_LINKED_FONTS
+// actually an offset from the address of this class.
-	CLinkedFontInformation *iFontLinkage;
+// iOpenFont's type remains unchanged.
-#endif
+// As Qt code that uses OpenFont() must be able to run on new and old versions
-	};
+// of Symbian OS, it must be able to determine whether iOpenFont is a pointer or
+// an offset at run-time.  Therefore an offset will have its lowest significant bit set to 1.
+// If iOpenFont is null, this object is not an open font.
+// Assumption: a pointer always has least significant bit value of zero.
+COpenFont* iOpenFont; // if iOpenFont is non-null this is an open font and many functions are forwarded to it
+TUint32 iReserved;
+TUint32 iUniqueFontId; // unique id for this instance of this font
+	};
+/**
+WARNING: Class for internal and partner use ONLY.  Compatibility is not guaranteed in future releases.
+@publishedAll
+@released
+*/
+class TLinkedTypefaceGroupArgs
+	{
+public:
+	TInt iGroupId;
+	CLinkedTypefaceGroup::TScalingOption iScalingOption;
+	CLinkedTypefaceGroup::TBaselineShift iBaselineShift;
+	TInt iAntialiasingThreshold;
+	TInt iBoldnessPercentage;
+	TInt iItalicAngle;
+public:
+	void operator =(const CLinkedTypefaceGroup* aRhs);
+	};
+class COpenFontLinkedTypefaceElementSpec;
+class COpenFontLinkedTypefaceSpecification;
+/**
+WARNING: Class for internal and partner use ONLY.  Compatibility is not guaranteed in future releases.
+@publishedAll
+@released
+*/
+class TLinkedTypefaceElementSpecArgs
+	{
+public:
+	TBufC<KMaxTypefaceNameLength> iName;
+	TBool iIsCanonical;
+	TInt iGroupId;
+	void operator = (const CLinkedTypefaceElementSpec* aRhs);
+	void operator = (const COpenFontLinkedTypefaceElementSpec* aRhs);
+	};
+/**
+WARNING: Class for internal and partner use ONLY.  Compatibility is not guaranteed in future releases.
+@publishedAll
+@released
+*/
+class TLinkedTypefaceSpecificationArgs
+	{
+public:
+	TBufC<KMaxTypefaceNameLength> iName;
+	TLinkedTypefaceElementSpecArgs iTypefaces[KMaxLinkedTypefaces];
+	TLinkedTypefaceGroupArgs iGroups[KMaxLinkedTypefaceGroups];
+	TInt	iSize;
+	TInt	iGroupSize;
+	TInt	iCanonicalIndex;
+	IMPORT_C void operator = (const CLinkedTypefaceSpecification& aRhs);
+	IMPORT_C void operator = (const COpenFontLinkedTypefaceSpecification& aRhs);
+	};
+class TUnhintedOutlineId;
+class THintedOutlineId;
+class CFontTableCache;
+class CUnhintedOutlineCache;
+class CHintedOutlineCache;
+class TFontTableGlyphOutlineCacheMemMonitor;
 class CFontStore : public CTypefaceStore
 /**
 A store for fonts.
 Stores and handles both open and fixed-size fonts. Open fonts are made from
 via a rasterizer.
 @publishedAll
 @released
 */
 {
-#ifdef SYMBIAN_SUPPORT_LINKED_FONTS
 friend class CLinkedFonts;
-friend class CLinkedFontSpecification;
 friend class CLinkedTypefaceSpecification;
-#endif
 public:
 	IMPORT_C static CFontStore* NewL(RHeap* aHeap);
 	IMPORT_C ~CFontStore();
 	IMPORT_C TUid AddFileL(const TDesC& aName);
 	void SetShaperCacheMemUsage(TInt aUsage);
 	CArrayPtrFlat<COpenFontFile>* GetOpenFontFileList();
 	void IncNumShaperCaches();
 	void DecNumShaperCaches();
 	TInt GetNumShaperCaches();
-	IMPORT_C TInt CreateLinkedTypeface(const TLinkedTypefaceSpecArgs &aLinkedTypefaceSpec, TInt aSession, TInt& aId);
+	IMPORT_C TInt CreateLinkedTypeface(const TLinkedTypefaceSpecificationArgs &aLinkedTypefaceSpec, TInt aSession, TInt& aId);
-	IMPORT_C void RemoveLinkedFont(CBitmapFont *aFont);
+	IMPORT_C void GetLinkedTypefaceL(TLinkedTypefaceSpecificationArgs &aLinkedTypefaceSpec);
-	IMPORT_C TBool IsValidLinkedFontSpecification(TInt aHandle);
 	IMPORT_C TBool HaveTypefaceFamilyName(const TDesC& aName);
+	IMPORT_C void UpdateLinkedTypefaceL(const TLinkedTypefaceSpecificationArgs& aLinkedTypefaceSpec);
+	IMPORT_C void LoadFontsAtStartupL();
+	IMPORT_C TBool GetFontFilePath(const TDesC& aFontName, TFileName& aFilePath) const;
+IMPORT_C void CleanupCacheOnFbsSessionTermination(TInt aSessionHandle);
+	TInt CacheFontTable(TUid aFileUid, TUint32 aTag, TAny*& aContent, TInt aLength);
+	TInt ReleaseFontTable(TUid aFileUid, TUint32 aTag, TInt aSessionHandle);
+	TInt FindFontTableInCache(TUid aFileUid, TUint32 aTag, TAny*& aContent, TInt& aLength);
+	TInt IncFontTableRefCount(TUid aFileUid, TUint32 aTag, TInt aSessionHandle);
+	TInt DecFontTableRefCount(TUid aFileUid, TUint32 aTag, TInt aSessionHandle);
+	TInt CacheUnhintedOutline(const TUnhintedOutlineId& aOutlineId, TAny* aData,
+	        TInt aLength, TAny*& aOutline, TInt& aLen);
+	TInt CacheHintedOutline(const THintedOutlineId& aOutlineId, TAny* aData, TInt aLength,
+	        TAny*& aOutline, TInt& aLen);
+	TInt ReleaseUnhintedOutline(const TUnhintedOutlineId& aOutlineId, TInt aSessionHandle);
+	TInt ReleaseHintedOutline(const THintedOutlineId& aOutlineId, TInt aSessionHandle);
+	TInt IncreaseUnhintedOutlineRefCount(const TUnhintedOutlineId& aOutlineId, TInt aSessionHandle);
+	TInt IncreaseHintedOutlineRefCount(const THintedOutlineId& aOutlineId, TInt aSessionHandle);
+	TInt FindUnhintedOutlineInCache(const TUnhintedOutlineId& aOutlineId, TAny*& aData,
+	        TInt &aLength);
+	TInt FindHintedOutlineInCache(const THintedOutlineId& aOutlineId, TAny*& aData, TInt& aLength);
+void CleanupCacheOnOpenFontRemoval(COpenFont* aFont);
+void CleanupCacheOnOpenFontFileRemoval(COpenFontFile* aFontFile);
 private:
 	CFontStore(RHeap* aHeap);
 	void ConstructL();
 	void InternalizeFontStoreFileL(CFontStoreFile* aFontStoreFile, TInt aFontVersion);
 	TTypeface* GetNearestTypeface(const TTypeface& aTypeface) const;
 	TInt VerticalPixelsToTwips(TInt aPixelHeight) const;
 	TInt VerticalTwipsToPixels(TInt aTwipsHeight) const;
 	void GetNearestBitmapFontInPixelsL(CFont*& aFont, TFontSpec& aFontSpec, TInt aMaxHeight);
 	void GetNearestOpenFontInPixelsL(
 	CFont*& aFont, TOpenFontSpec& aActualFontSpec, const TOpenFontSpec& aDesiredFontSpec, TInt aMaxHeight);
-#ifdef SYMBIAN_SUPPORT_LINKED_FONTS
 	TInt GetNearestRealFontInPixels(CFont*& aFont, const TOpenFontSpec& aFontSpec, TInt aMaxHeight);
 	TInt GetNearestFontInPixelsL(CFont*& aFont, const TOpenFontSpec& aFontSpec, TInt aMaxHeight);
-	TInt CreateLinkedTypefaceL(const TLinkedTypefaceSpecArgs &aLinkedTypefaceSpec, TInt aSession, TInt& aId);
+	TInt CreateLinkedTypefaceL(const TLinkedTypefaceSpecificationArgs &aLinkedTypefaceSpec, TInt aSession, TInt& aId);
 	TInt GetCanonicalIndex(TInt aTypefaceIndex) const;
 	void TypefaceSupportLinked(TTypefaceSupport &aTypefaceSupport, TInt aTypefaceIndex) const;
-#endif
 	TInt GetNearestFontInPixels(CFont*& aFont, const TOpenFontSpec& aFontSpec, TInt aMaxHeight);
 	void SanityCheckForTtfL(RFile& aFile, TUint aFontFileSize, TBool aStrictChecking);
 	void SanityCheckFontFileL(TParse& aParse);
 	TInt GetNearestOpenFontInPixelsByFontName(COpenFont*& aNearestOpenFont, TOpenFontSpec& aActualFontSpec, const TOpenFontSpec& aDesiredFontSpec, TInt aMaxHeight);
 	TInt GetNearestOpenFontInPixelsBySimilarity(COpenFont*& aNearestOpenFont, TOpenFontSpec& aActualFontSpec, const TOpenFontSpec& aDesiredFontSpec, TInt aMaxHeight);
 	TInt AddTypefacesToSupportList(COpenFontFile* aOpenFontFile);
 	void RemoveTypefacesFromSupportList(COpenFontFile* aOpenFontFile);
 	TInt FindBitmapFontFileIndexByUid(TUid aUid);
-	TBool IncRefCountOfLoadedFont(const TDesC& aFullName, TUid& aFontUid);
+	TBool IncRefCountOfLoadedFont(const TParse& aFileName, TUid& aFontUid);
-	TBool LoadFileAsOpenFontL(const TDesC& aFullName, TUid& aFontUid);
+	TBool LoadFileAsOpenFontL(const TParse& aFileName, TUid& aFontUid);
-	TUid LoadFileAsBitmapFontL(TParse& aParse);
+	TUid LoadFileAsBitmapFontL(const TParse& aParse);
 	static void CleanupRemoveFontFile(TAny* aCleanupInfo);
+	const TAny* FontLinkingInterface() const;
+	TInt ValidateLinkedFontSpecificationL(COpenFontLinkedTypefaceSpecification& aSpec, TBool aOverwrite) const;
+	void GenerateLinkedFontFileL(COpenFontLinkedTypefaceSpecification& aSpec, const TAny* aExtension, TBool aUpdate);
+	void LoadFontsL(const TDesC& aFontsDir);
+	void AddSanityCheckedFontL(const TParse& aFileName, TUid& aUid);
 public:
 	/** The width of 1000 pixels in twips.
 	This is set in the constructor. If the appropriate HALData attributes are
 	set (EDisplayXPixels and EDisplayXTwips) then the value is calculated using
 	CArrayPtrFlat<CFontStoreFile> iFontStoreFileList;
 	CArrayPtrFlat<TTypeface> iTypefaceList;
 	CArrayPtrFlat<CFontBitmap> iFontBitmapList;
 	CArrayFixFlat<TTypefaceFontBitmap> iTypefaceFontBitmapList;
 	CArrayPtrFlat<COpenFontFile> iOpenFontFileList;
-	TInt iReserved[6];		// keep iDefaultBitmapType at the correct offset
+	TInt iReserved[2];		// keep iDefaultBitmapType at the correct offset
+CFontTableCache *iFontTableCache;
+CUnhintedOutlineCache *iUnhintedOutlineCache;
+CHintedOutlineCache *iHintedOutlineCache;
+TFontTableGlyphOutlineCacheMemMonitor *iCacheMemMon;
 	CArrayPtrFlat<COpenFontRasterizer> iOpenFontRasterizerList;
 	COpenFontSessionCacheList* iOpenFontSessionCacheList;
 	TInt iOpenFontUid;
 	TGlyphBitmapType iDefaultBitmapType;
 	CArrayPtrFlat<CShaperFactory> iShaperFactoryList;
 	TInt iOpenFontShaperCacheMemUsage;
 	TInt iNumberOfShaperCaches;
 	RPointerArray<CTypefaceSupportInfo> iOpenFontTypefaceSupportList;
-#ifdef SYMBIAN_SUPPORT_LINKED_FONTS
+	RArray<RHandleBase> *iHandleArray;
-	RPointerArray<CLinkedTypefaceSpecification> *iLinkedTypefaceSpecificationList;
+	TAny* iUnused2;
-	RPointerArray<CLinkedFontSpecification> *iLinkedFontSpecificationList;
+	TUint32 iUniqueFontIdCount;
-#endif
 	};
 // inline functions start here
 /** Returns whether the bitmap font object is an open font (a COpenFont) rather
 inline TBool CBitmapFont::IsOpenFont() const
 	{
 	return iOpenFont != NULL;
 	}
 /** Returns a pointer to the open font being used by the bitmap font object.
 @return A pointer to an open font.
 @see IsOpenFont()
 */
 inline COpenFont* CBitmapFont::OpenFont() const
 	{
-	return iOpenFont;
+if (reinterpret_cast<TInt>(iOpenFont) & 1)
+{
+return reinterpret_cast<COpenFont*>(const_cast<CBitmapFont*>(PtrAdd(this, reinterpret_cast<TInt>(iOpenFont) & ~1)));
+}
+else
+{
+return iOpenFont;
+}
 	}
 /** Gets the anti-aliasing setting for the font, see TGlyphBitmapType for
 the range of values.
 	{
 	iDefaultBitmapType = aType;
 	}
 #endif

branch	Symbian3
changeset 4	837f303aceeb
parent 2	2fe1408b6811