-/*++\r
+/** @file\r
+ Driver to implement English version of Unicode Collation Protocol.\r
\r
-Copyright (c) 2006, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
-Module Name:\r
-\r
- UnicodeCollationEng.c\r
-\r
-Abstract:\r
-\r
- Unicode Collation Protocol (English)\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
\r
\r
#include "UnicodeCollationEng.h"\r
\r
-CHAR8 mEngUpperMap[0x100];\r
-CHAR8 mEngLowerMap[0x100];\r
-CHAR8 mEngInfoMap[0x100];\r
+CHAR8 mEngUpperMap[MAP_TABLE_SIZE];\r
+CHAR8 mEngLowerMap[MAP_TABLE_SIZE];\r
+CHAR8 mEngInfoMap[MAP_TABLE_SIZE];\r
\r
CHAR8 mOtherChars[] = {\r
'0',\r
\r
EFI_HANDLE mHandle = NULL;\r
\r
-EFI_UNICODE_COLLATION_PROTOCOL UnicodeEng = {\r
+//\r
+// EFI Unicode Collation Protocol supporting ISO 639-2 language code\r
+//\r
+GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_COLLATION_PROTOCOL UnicodeEng = {\r
EngStriColl,\r
EngMetaiMatch,\r
EngStrLwr,\r
};\r
\r
//\r
+// EFI Unicode Collation2 Protocol supporting RFC 4646 language code\r
//\r
-//\r
+GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_COLLATION_PROTOCOL Unicode2Eng = {\r
+ EngStriColl,\r
+ EngMetaiMatch,\r
+ EngStrLwr,\r
+ EngStrUpr,\r
+ EngFatToStr,\r
+ EngStrToFat,\r
+ "en"\r
+};\r
+\r
+/**\r
+ The user Entry Point for English module.\r
+ \r
+ This function initializes unicode character mapping and then installs Unicode\r
+ Collation & Unicode Collation 2 Protocols based on the feature flags. \r
+\r
+ @param ImageHandle The firmware allocated handle for the EFI image. \r
+ @param SystemTable A pointer to the EFI System Table.\r
+ \r
+ @retval EFI_SUCCESS The entry point is executed successfully.\r
+ @retval other Some error occurs when executing this entry point.\r
+\r
+**/\r
EFI_STATUS\r
+EFIAPI\r
InitializeUnicodeCollationEng (\r
IN EFI_HANDLE ImageHandle,\r
IN EFI_SYSTEM_TABLE *SystemTable\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Initializes the Unicode Collation Driver\r
-\r
-Arguments:\r
-\r
- ImageHandle -\r
-\r
- SystemTable -\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS\r
- EFI_OUT_OF_RESOURCES\r
-\r
---*/\r
{\r
+ EFI_STATUS Status;\r
UINTN Index;\r
UINTN Index2;\r
\r
//\r
// Initialize mapping tables for the supported languages\r
//\r
- for (Index = 0; Index < 0x100; Index++) {\r
+ for (Index = 0; Index < MAP_TABLE_SIZE; Index++) {\r
mEngUpperMap[Index] = (CHAR8) Index;\r
mEngLowerMap[Index] = (CHAR8) Index;\r
mEngInfoMap[Index] = 0;\r
}\r
}\r
\r
- for (Index = 0; mOtherChars[Index]; Index++) {\r
+ for (Index = 0; mOtherChars[Index] != 0; Index++) {\r
Index2 = mOtherChars[Index];\r
mEngInfoMap[Index2] |= CHAR_FAT_VALID;\r
}\r
- //\r
- // Create a handle for the device\r
- //\r
- return gBS->InstallProtocolInterface (\r
- &mHandle,\r
- &gEfiUnicodeCollationProtocolGuid,\r
- EFI_NATIVE_INTERFACE,\r
- &UnicodeEng\r
- );\r
-}\r
\r
-INTN\r
-EFIAPI\r
-EngStriColl (\r
- IN EFI_UNICODE_COLLATION_PROTOCOL *This,\r
- IN CHAR16 *s1,\r
- IN CHAR16 *s2\r
- )\r
-/*++\r
+ if (FeaturePcdGet (PcdUnicodeCollation2Support)) {\r
+ if (FeaturePcdGet (PcdUnicodeCollationSupport)) {\r
+ Status = gBS->InstallMultipleProtocolInterfaces (\r
+ &mHandle,\r
+ &gEfiUnicodeCollationProtocolGuid,\r
+ &UnicodeEng,\r
+ &gEfiUnicodeCollation2ProtocolGuid,\r
+ &Unicode2Eng,\r
+ NULL\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+ } else {\r
+ Status = gBS->InstallMultipleProtocolInterfaces (\r
+ &mHandle,\r
+ &gEfiUnicodeCollation2ProtocolGuid,\r
+ &Unicode2Eng,\r
+ NULL\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+ }\r
+ } else {\r
+ if (FeaturePcdGet (PcdUnicodeCollationSupport)) {\r
+ Status = gBS->InstallMultipleProtocolInterfaces (\r
+ &mHandle,\r
+ &gEfiUnicodeCollationProtocolGuid,\r
+ &UnicodeEng,\r
+ NULL\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+ } else {\r
+ //\r
+ // This module must support to produce at least one of Unicode Collation Protocol\r
+ // and Unicode Collation 2 Protocol.\r
+ //\r
+ ASSERT (FALSE);\r
+ Status = EFI_UNSUPPORTED;\r
+ }\r
+ }\r
\r
-Routine Description:\r
+ return Status;\r
+}\r
\r
- Performs a case-insensitive comparison of two Null-terminated Unicode strings.\r
\r
-Arguments:\r
+/**\r
+ Performs a case-insensitive comparison of two Null-terminated Unicode \r
+ strings.\r
\r
- This\r
- s1\r
- s2\r
+ @param This Protocol instance pointer.\r
+ @param Str1 A pointer to a Null-terminated Unicode string.\r
+ @param Str2 A pointer to a Null-terminated Unicode string.\r
\r
-Returns:\r
+ @retval 0 Str1 is equivalent to Str2\r
+ @retval > 0 Str1 is lexically greater than Str2\r
+ @retval < 0 Str1 is lexically less than Str2\r
\r
---*/\r
+**/\r
+INTN\r
+EFIAPI\r
+EngStriColl (\r
+ IN EFI_UNICODE_COLLATION_PROTOCOL *This,\r
+ IN CHAR16 *Str1,\r
+ IN CHAR16 *Str2\r
+ )\r
{\r
- while (*s1) {\r
- if (ToUpper (*s1) != ToUpper (*s2)) {\r
+ while (*Str1 != 0) {\r
+ if (TO_UPPER (*Str1) != TO_UPPER (*Str2)) {\r
break;\r
}\r
\r
- s1 += 1;\r
- s2 += 1;\r
+ Str1 += 1;\r
+ Str2 += 1;\r
}\r
\r
- return ToUpper (*s1) - ToUpper (*s2);\r
+ return TO_UPPER (*Str1) - TO_UPPER (*Str2);\r
}\r
\r
+\r
+/**\r
+ Converts all the Unicode characters in a Null-terminated Unicode string to \r
+ lower case Unicode characters.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param Str A pointer to a Null-terminated Unicode string.\r
+\r
+**/\r
VOID\r
EFIAPI\r
EngStrLwr (\r
IN EFI_UNICODE_COLLATION_PROTOCOL *This,\r
IN OUT CHAR16 *Str\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Converts all the Unicode characters in a Null-terminated Unicode string\r
- to lower case Unicode characters.\r
-\r
-Arguments:\r
-\r
- This - A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.\r
- Str1 - A pointer to a Null-terminated Unicode string.\r
- Str2 - A pointer to a Null-terminated Unicode string.\r
-\r
-Returns:\r
-\r
- 0 - s1 is equivalent to s2.\r
- > 0 - s1 is lexically greater than s2.\r
- < 0 - s1 is lexically less than s2.\r
-\r
---*/\r
{\r
- while (*Str) {\r
- *Str = ToLower (*Str);\r
+ while (*Str != 0) {\r
+ *Str = TO_LOWER (*Str);\r
Str += 1;\r
}\r
}\r
\r
+\r
+/**\r
+ Converts all the Unicode characters in a Null-terminated Unicode string to upper\r
+ case Unicode characters.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param Str A pointer to a Null-terminated Unicode string.\r
+\r
+**/\r
VOID\r
EFIAPI\r
EngStrUpr (\r
IN EFI_UNICODE_COLLATION_PROTOCOL *This,\r
IN OUT CHAR16 *Str\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Converts all the Unicode characters in a Null-terminated\r
- Unicode string to upper case Unicode characters.\r
-\r
-Arguments:\r
- This\r
- Str\r
-\r
-Returns:\r
- None\r
-\r
---*/\r
{\r
- while (*Str) {\r
- *Str = ToUpper (*Str);\r
+ while (*Str != 0) {\r
+ *Str = TO_UPPER (*Str);\r
Str += 1;\r
}\r
}\r
\r
+/**\r
+ Performs a case-insensitive comparison of a Null-terminated Unicode \r
+ pattern string and a Null-terminated Unicode string.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param String A pointer to a Null-terminated Unicode string.\r
+ @param Pattern A pointer to a Null-terminated Unicode pattern string.\r
+\r
+ @retval TRUE Pattern was found in String.\r
+ @retval FALSE Pattern was not found in String.\r
+\r
+**/\r
BOOLEAN\r
EFIAPI\r
EngMetaiMatch (\r
IN CHAR16 *String,\r
IN CHAR16 *Pattern\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Performs a case-insensitive comparison between a Null-terminated\r
- Unicode pattern string and a Null-terminated Unicode string.\r
-\r
- The pattern string can use the '?' wildcard to match any character,\r
- and the '*' wildcard to match any sub-string.\r
-\r
-Arguments:\r
-\r
- This - A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.\r
- String - A pointer to a Null-terminated Unicode string.\r
- Pattern - A pointer to a Null-terminated Unicode pattern string.\r
-\r
-Returns:\r
-\r
- TRUE - Pattern was found in String.\r
- FALSE - Pattern was not found in String.\r
-\r
---*/\r
{\r
CHAR16 CharC;\r
CHAR16 CharP;\r
//\r
// End of pattern. If end of string, TRUE match\r
//\r
- if (*String) {\r
+ if (*String != 0) {\r
return FALSE;\r
} else {\r
return TRUE;\r
//\r
// Match zero or more chars\r
//\r
- while (*String) {\r
+ while (*String != 0) {\r
if (EngMetaiMatch (This, String, Pattern)) {\r
return TRUE;\r
}\r
//\r
// Match any one char\r
//\r
- if (!*String) {\r
+ if (*String == 0) {\r
return FALSE;\r
}\r
\r
// Match char set\r
//\r
CharC = *String;\r
- if (!CharC) {\r
+ if (CharC == 0) {\r
//\r
// syntax problem\r
//\r
\r
Index3 = 0;\r
CharP = *Pattern++;\r
- while (CharP) {\r
+ while (CharP != 0) {\r
if (CharP == ']') {\r
return FALSE;\r
}\r
return FALSE;\r
}\r
\r
- if (ToUpper (CharC) >= ToUpper (Index3) && ToUpper (CharC) <= ToUpper (CharP)) {\r
+ if (TO_UPPER (CharC) >= TO_UPPER (Index3) && TO_UPPER (CharC) <= TO_UPPER (CharP)) {\r
//\r
// if in range, it's a match\r
//\r
}\r
\r
Index3 = CharP;\r
- if (ToUpper (CharC) == ToUpper (CharP)) {\r
+ if (TO_UPPER (CharC) == TO_UPPER (CharP)) {\r
//\r
// if char matches\r
//\r
//\r
// skip to end of match char set\r
//\r
- while (CharP && CharP != ']') {\r
+ while ((CharP != 0) && (CharP != ']')) {\r
CharP = *Pattern;\r
Pattern += 1;\r
}\r
\r
default:\r
CharC = *String;\r
- if (ToUpper (CharC) != ToUpper (CharP)) {\r
+ if (TO_UPPER (CharC) != TO_UPPER (CharP)) {\r
return FALSE;\r
}\r
\r
}\r
}\r
\r
+\r
+/**\r
+ Converts an 8.3 FAT file name in an OEM character set to a Null-terminated \r
+ Unicode string.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param FatSize The size of the string Fat in bytes.\r
+ @param Fat A pointer to a Null-terminated string that contains an 8.3 file\r
+ name using an OEM character set.\r
+ @param String A pointer to a Null-terminated Unicode string. The string must\r
+ be preallocated to hold FatSize Unicode characters.\r
+\r
+**/\r
VOID\r
EFIAPI\r
EngFatToStr (\r
IN CHAR8 *Fat,\r
OUT CHAR16 *String\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Converts an 8.3 FAT file name using an OEM character set\r
- to a Null-terminated Unicode string.\r
-\r
- BUGBUG: Function has to expand DBCS FAT chars, currently not.\r
-\r
-Arguments:\r
- This\r
- FatSize\r
- Fat\r
- String\r
-\r
-Returns:\r
-\r
---*/\r
{\r
//\r
// No DBCS issues, just expand and add null terminate to end of string\r
//\r
- while (*Fat && FatSize) {\r
+ while ((*Fat != 0) && (FatSize != 0)) {\r
*String = *Fat;\r
String += 1;\r
Fat += 1;\r
*String = 0;\r
}\r
\r
+\r
+/**\r
+ Converts a Null-terminated Unicode string to legal characters in a FAT \r
+ filename using an OEM character set. \r
+\r
+ @param This Protocol instance pointer.\r
+ @param String A pointer to a Null-terminated Unicode string. The string must\r
+ be preallocated to hold FatSize Unicode characters.\r
+ @param FatSize The size of the string Fat in bytes.\r
+ @param Fat A pointer to a Null-terminated string that contains an 8.3 file\r
+ name using an OEM character set.\r
+\r
+ @retval TRUE Fat is a Long File Name\r
+ @retval FALSE Fat is an 8.3 file name\r
+\r
+**/\r
BOOLEAN\r
EFIAPI\r
EngStrToFat (\r
IN UINTN FatSize,\r
OUT CHAR8 *Fat\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Converts a Null-terminated Unicode string to legal characters\r
- in a FAT filename using an OEM character set.\r
-\r
- Functions has to crunch string to a fat string. Replacing\r
- any chars that can't be represented in the fat name.\r
-\r
-Arguments:\r
- This\r
- String\r
- FatSize\r
- Fat\r
-\r
-Returns:\r
- TRUE\r
- FALSE\r
---*/\r
{\r
BOOLEAN SpecialCharExist;\r
\r
SpecialCharExist = FALSE;\r
- while (*String && FatSize) {\r
+ while ((*String != 0) && (FatSize != 0)) {\r
//\r
// Skip '.' or ' ' when making a fat name\r
//\r
if (*String != '.' && *String != ' ') {\r
//\r
// If this is a valid fat char, move it.\r
- // Otherwise, move a '_' and flag the fact that the name needs an Lfn\r
+ // Otherwise, move a '_' and flag the fact that the name needs a long file name.\r
//\r
- if (*String < 0x100 && (mEngInfoMap[*String] & CHAR_FAT_VALID)) {\r
+ if (*String < MAP_TABLE_SIZE && ((mEngInfoMap[*String] & CHAR_FAT_VALID) != 0)) {\r
*Fat = mEngUpperMap[*String];\r
} else {\r
*Fat = '_';\r
projects / mirror_edk2.git / blobdiff