/**************************************************************
 * 
 * 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
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/



#ifndef _SV_METRIC_HXX
#define _SV_METRIC_HXX

#include <vcl/dllapi.h>
#include <vcl/font.hxx>

class ImplFontMetric;
class ImplFontCharMap;

typedef sal_uInt32 sal_UCS4;

// ------------
// - FontInfo -
// ------------

class VCL_DLLPUBLIC FontInfo : public Font
{
	friend class OutputDevice;

protected:
	ImplFontMetric* 	mpImplMetric;	 // Implementation

public:
						FontInfo();
						FontInfo( const FontInfo& );
						~FontInfo();

	FontType			GetType() const;
	sal_Bool				IsDeviceFont() const;
	sal_Bool				SupportsLatin() const;
	sal_Bool				SupportsCJK() const;
	sal_Bool				SupportsCTL() const;

	FontInfo&			operator=( const FontInfo& );
	sal_Bool				operator==( const FontInfo& ) const;
	sal_Bool				operator!=( const FontInfo& rInfo ) const
							{ return !operator==( rInfo ); }
};

// --------------
// - FontMetric -
// --------------

class VCL_DLLPUBLIC FontMetric : public FontInfo
{
public:
						FontMetric() {}
						FontMetric( const FontMetric& );
						~FontMetric() {}

	long				GetAscent() const;
	long				GetDescent() const;
	long				GetIntLeading() const;
	long				GetExtLeading() const;
	long				GetLineHeight() const;
	long				GetSlant() const;

	FontMetric& 		operator=( const FontMetric& rMetric );
	sal_Bool				operator==( const FontMetric& rMetric ) const;
	sal_Bool				operator!=( const FontMetric& rMetric ) const
							{ return !operator==( rMetric ); }
};

// ---------------
// - FontCharMap -
// ---------------

class VCL_DLLPUBLIC FontCharMap
{
private:
    const ImplFontCharMap* mpImpl;

public:
                        FontCharMap();
                        ~FontCharMap();

	bool                IsDefaultMap( void ) const;
	bool                HasChar( sal_UCS4 ) const;
	int                 CountCharsInRange( sal_UCS4 cMin, sal_UCS4 cMax ) const;
	int                 GetCharCount( void ) const;

	sal_UCS4            GetFirstChar( void ) const;
	sal_UCS4            GetLastChar( void ) const;

	sal_UCS4            GetNextChar( sal_UCS4 ) const;
	sal_UCS4            GetPrevChar( sal_UCS4 ) const;

	int                 GetIndexFromChar( sal_UCS4 ) const;
	sal_UCS4            GetCharFromIndex( int ) const;


private:
    friend class OutputDevice;
    void                Reset( const ImplFontCharMap* pNewMap = NULL );

    // prevent assignment and copy construction
                        FontCharMap( const FontCharMap& );
    void                operator=( const FontCharMap& );
};

// ----------------
// - TextRectInfo -
// ----------------

class VCL_DLLPUBLIC TextRectInfo
{
	friend class OutputDevice;

private:
	long			mnMaxWidth;
	sal_uInt16			mnLineCount;
	sal_Bool			mbEllipsis;

public:
					TextRectInfo();

	sal_uInt16			GetLineCount() const { return mnLineCount; }
	long			GetMaxLineWidth() const { return mnMaxWidth; }
	sal_Bool			IsEllipses() const { return mbEllipsis; }

	sal_Bool			operator ==( const TextRectInfo& rInfo ) const
						{ return ((mnMaxWidth	== rInfo.mnMaxWidth)	&&
								  (mnLineCount	== rInfo.mnLineCount)	&&
								  (mbEllipsis	== rInfo.mbEllipsis)); }
	sal_Bool			operator !=( const TextRectInfo& rInfo ) const
						{ return !(TextRectInfo::operator==( rInfo )); }
};

inline TextRectInfo::TextRectInfo()
{
	mnMaxWidth		= 0;
	mnLineCount 	= 0;
	mbEllipsis		= sal_False;
}

#endif // _SV_METRIC_HXX