PMLocaleId.h

//========================================================================================
// 
// $File$
// 
// Owner: Michael Burbidge
// 
// $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 __PMLocaleId_h__
#define __PMLocaleId_h__

#include "ICUForwardDeclare.h"
#include "PMTypes.h"
#include "IPMStream.h"
#include "PMLocaleIds.h"


#ifdef PUBLIC_BUILD
#endif

class PMLocaleId
{
public:
 typedef base_type data_type;

 inline PMLocaleId();
 inline explicit PMLocaleId(int32 combinedId);
 inline PMLocaleId(int16 featureSetId, int16 userInterfaceId);
 
 inline bool16 operator==(const PMLocaleId& other) const;

 inline bool16 operator!=(const PMLocaleId& other) const;
 
 
 bool16 Match(const PMLocaleId& other) const; 
 
 inline int32 operator*() const;
 
 inline void ReadWrite(IPMStream* s);
 
 inline int16 GetFeatureSetId() const;
 
 inline int16 GetProductFS() const;

 inline int16 GetLanguageFS() const;
 
 inline int16 GetUserInterfaceId() const;

 inline int16 GetDefaultLanguageId() const;

 inline bool16 IsProductFS(const int16 productFS) const;

 inline bool16 IsLanguageFS(const int16 languageFS) const;
 
 int32 GetFeatureSetScript() const;
 
 int32 GetUIScript() const;

 ID_ICU_NAMESPACE::Locale GetUserInterfaceICULocale() const;

 bool16 IsRightToLeftUI() const;

 void SetUserInterface(ID_ICU_NAMESPACE::Locale newLocale);

 inline bool operator<(const PMLocaleId& other) const;

private:
 int16 fFeatureSetId;
 int16 fUserInterfaceId;
};


//========================================================================================
// METHODS PMLocaleId
//========================================================================================

inline PMLocaleId::PMLocaleId() :
 fFeatureSetId(0),
 fUserInterfaceId(0)
{
}

inline PMLocaleId::PMLocaleId(int32 combinedId) :
 fFeatureSetId((combinedId & 0xFFFF0000) >> 16),
 fUserInterfaceId(combinedId & 0x0000FFFF)
{
}

inline PMLocaleId::PMLocaleId(int16 featureSetId, int16 userInterfaceId) :
 fFeatureSetId(featureSetId),
 fUserInterfaceId(userInterfaceId)
{
}

inline bool16 PMLocaleId::operator==(const PMLocaleId& other) const
{
 return fFeatureSetId == other.fFeatureSetId && fUserInterfaceId == other.fUserInterfaceId;
}

inline bool16 PMLocaleId::operator!=(const PMLocaleId& other) const
{
 return fFeatureSetId != other.fFeatureSetId || fUserInterfaceId != other.fUserInterfaceId;
}

inline int32 PMLocaleId::operator*() const
{
 return (fFeatureSetId << 16) & fUserInterfaceId;
}

inline bool PMLocaleId::operator< (const PMLocaleId& other) const
{
 if (fFeatureSetId < other.fFeatureSetId)
 return true;
 else if (fFeatureSetId == other.fFeatureSetId && fUserInterfaceId < other.fUserInterfaceId)
 return true;
 else
 return false;
}

inline int16 PMLocaleId::GetFeatureSetId() const
{
 return fFeatureSetId;
}

inline int16 PMLocaleId::GetUserInterfaceId() const
{
 if (fUserInterfaceId == k_enAE || fUserInterfaceId == k_enIL)
 return k_enUS;
 return fUserInterfaceId;
}

inline int16 PMLocaleId::GetDefaultLanguageId() const
{
 return fUserInterfaceId;
}

inline int16 PMLocaleId::GetProductFS() const
{
 return (fFeatureSetId & 0xFF00);
}

inline int16 PMLocaleId::GetLanguageFS() const
{
 return (fFeatureSetId & 0x00FF);
}

// if either is wild or they match
inline bool16 PMLocaleId::IsProductFS(const int16 productFS) const
{
 uint16 product = static_cast<uint16>(fFeatureSetId) & 0xFF00;
#if 1
 return ((product == kAllProductsFS) || (static_cast<uint16>(productFS) == kAllProductsFS) || (product == static_cast<uint16>(productFS)));
#else
 //11/24/03 pboctor/mburbidge - The last part of this expression was changed to allow a ScriptInfo resource to be something like this:
 // kInDesignRomanFS | kInDesignServerRomanFS
 // In order for this to work: 1. The product feature set values must occupy unique bits 2. We can't have a product feature set value of 0
 //5/13/04 jwbrown - ScriptInfo resources no longer require/permit OR'd feature sets, so I've reverted this code
 return ((product == (int16)kAllProductsFS) || (productFS == (int16)kAllProductsFS) || ((productFS & product) != 0));
#endif
}

// if either is wild or they match
inline bool16 PMLocaleId::IsLanguageFS(const int16 languageFS) const
{
 int16 language = fFeatureSetId & 0x00FF;
 return ((language == (int16)kAllLanguagesFS) || (languageFS == (int16)kAllLanguagesFS) || (language == languageFS));
}

inline bool16 PMLocaleId::IsRightToLeftUI() const
{
 return ((GetUserInterfaceId() == k_arAE) || (GetUserInterfaceId() == k_heIL));
}



inline void PMLocaleId::ReadWrite(IPMStream* s)
{
 s->XferInt16(fFeatureSetId);
 s->XferInt16(fUserInterfaceId);
}

#endif // __PMLocaleId_h__