ILanguage.h

//========================================================================================
// 
// $File$
// 
// Owner: Bernd Paradies
// 
// $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.
// 
//========================================================================================

#ifndef __ILanguage__
#define __ILanguage__

#include "IPMUnknown.h"

#include "PMTextUtils.h"
#include "UnicodeClass.h"

#include "ICUForwardDeclare.h"
#include "LanguageID.h"
#include "LinguisticID.h"
#include "OTFeature.h"
#include <map>


class PMString;
class IHyphenationService;
class ISpellingService;
class ITextModel;
class WideString;
class QuoteEntry;



class ILanguage : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ILANGUAGE };

 enum QuotationType { kSingle, kDouble };
 enum QuotationPosition { kLeft, kRight };

 virtual const PMString & GetLanguageName() const = 0;

 virtual const PMString & GetPrimaryLanguageName() const = 0;

 virtual const PMString & GetSubLanguageName() const = 0;

 virtual LanguageID GetLanguageID() const = 0;


 virtual void SetLanguageName( const PMString &rName ) = 0;

 virtual void SetPrimaryLanguageName( const PMString &rName ) = 0;

 virtual void SetSubLanguageName( const PMString &rName ) = 0;

 virtual void SetLanguageID( const LanguageID nLanguage ) = 0;


 virtual void CopyFrom( const ILanguage *pLanguage ) = 0;

 virtual bool16 IsEqual( const ILanguage *pLanguage ) const = 0;

 virtual UTF32TextChar GetQuotationMark( ILanguage::QuotationType nType, ILanguage::QuotationPosition nPosition ) = 0;

 virtual bool16 SetQuotationMarks( const QuoteEntry& newQuoteEntry ) = 0;

 virtual bool16 GetQuotationMarks(QuoteEntry& qe) const = 0;

 virtual TextIndex FindSurroundingWord( const ITextModel *pModel, TextIndex nPosition, int32 *pLength, FuncIsWordChar aFunction) const = 0;

 virtual TextIndex FindSurroundingWordUsingWordCharFuncOnly( const ITextModel *pModel, TextIndex nPosition, int32 *pLength, FuncIsWordChar aFunction) const = 0;

 virtual int16 GetWritingScript() const = 0;

 virtual const char* GetOpenTypeScriptTag() const = 0;

 virtual const char* GetOpenTypeLanguageTag() const = 0;

 virtual bool16 AfterHyphenationCanChange() const = 0;

 virtual int32 LinguisticCompare(const WideString& a, const WideString& b,
 LanguageID aLang = 0, LanguageID bLang = 0, bool16 usePrefixPunctuation = kFalse) const = 0;


#ifdef ID_DEPRECATED

 virtual int32 LinguisticComparePrimary(const WideString& a, const WideString& b,
 LanguageID aLang = 0, LanguageID bLang = 0) const = 0;
#endif

 virtual const OpenTypeFeatureList& GetRequiredOTFeatureList() const = 0;

 virtual const ID_ICU_NAMESPACE::Locale& GetICULocale() const = 0;

 virtual std::string GetICULocaleString() const = 0;

 virtual void SetICULocale(const ID_ICU_NAMESPACE::Locale &newLocale) = 0;

 virtual void SetICULocale(std::string newLocale) = 0;

 virtual void SetSpellingService( ISpellingService *spellingService ) = 0;

 virtual ISpellingService *QuerySpellingService(PMString *error = nil) const = 0;

 virtual void SetHyphenationService( IHyphenationService *hyphenationService ) = 0;

 virtual IHyphenationService *QueryHyphenationService(PMString *error = nil) const = 0;

 virtual void GetHyphenString(WideString &hyphenString) const = 0;
};


struct appUILinguisticLessthan
{
 bool operator()(const PMString &s1, const PMString &s2) const;
};
typedef std::map<PMString,PMString, appUILinguisticLessthan> LinguisticCompareMap;



#endif