Sync all bug fixes between EDK1.04 and EDK1.06 into EdkCompatibilityPkg.

[mirror_edk2.git] / EdkCompatibilityPkg / Sample / Tools / Source / StrGather / StringDB.h

/*++\r
\r
Copyright (c) 2004 - 2010, 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
                                                                                          \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
  StringDB.h\r
\r
Abstract:\r
\r
  Common defines and prototypes for string database management\r
  \r
--*/\r
\r
#ifndef _STRING_DB_H_\r
#define _STRING_DB_H_\r
\r
#define LANGUAGE_NAME_STRING_NAME           L"$LANGUAGE_NAME"\r
#define PRINTABLE_LANGUAGE_NAME_STRING_NAME L"$PRINTABLE_LANGUAGE_NAME"\r
\r
void\r
StringDBConstructor (\r
  void\r
  )\r
;\r
void\r
StringDBDestructor (\r
  void\r
  )\r
;\r
\r
STATUS\r
StringDBAddString (\r
  WCHAR   *LanguageName,\r
  WCHAR   *StringIdentifier,\r
  WCHAR   *Scope,\r
  WCHAR   *String,\r
  BOOLEAN Format,\r
  UINT16  Flags\r
  )\r
;\r
\r
STATUS\r
StringDBSetScope (\r
  WCHAR   *Scope\r
  )\r
;\r
\r
#define STRING_FLAGS_REFERENCED           0x0001  // if referenced somewhere\r
#define STRING_FLAGS_UNDEFINED            0x0002  // if we added it for padding purposes\r
#define STRING_FLAGS_INDEX_ASSIGNED       0x0004  // so don't change the index value\r
#define STRING_ID_INVALID                 0xFFFF\r
#define STRING_ID_LANGUAGE_NAME           0x0000\r
#define STRING_ID_PRINTABLE_LANGUAGE_NAME 0x0001\r
\r
STATUS\r
StringDBAddStringIdentifier (\r
  WCHAR     *StringIdentifier,\r
  UINT16    *NewId,\r
  UINT16    Flags\r
  )\r
;\r
\r
STATUS\r
StringDBReadDatabase (\r
  INT8    *DBFileName,\r
  BOOLEAN IgnoreIfNotExist,\r
  BOOLEAN Verbose\r
  )\r
;\r
\r
STATUS\r
StringDBWriteDatabase (\r
  INT8    *DBFileName,\r
  BOOLEAN Verbose\r
  )\r
;\r
\r
STATUS\r
StringDBDumpDatabase (\r
  INT8                *DBFileName,\r
  INT8                *OutputFileName,\r
  BOOLEAN             Verbose\r
  )\r
;\r
\r
STATUS\r
StringDBAddLanguage (\r
  WCHAR *LanguageName,\r
  WCHAR *PrintableLanguageName\r
  )\r
;\r
\r
STATUS\r
StringDBDumpCStrings (\r
  INT8                        *FileName,\r
  INT8                        *BaseName,\r
  WCHAR_STRING_LIST           *LanguagesOfInterest,\r
  WCHAR_MATCHING_STRING_LIST  *IndirectionList\r
  )\r
;\r
\r
STATUS\r
StringDBDumpStringDefines (\r
  INT8                *FileName,\r
  INT8                *BaseName\r
  )\r
;\r
\r
STATUS\r
StringDBSetCurrentLanguage (\r
  WCHAR *LanguageName\r
  )\r
;\r
\r
STATUS\r
StringDBSetStringReferenced (\r
  INT8      *StringIdentifierName,\r
  BOOLEAN   IgnoreNotFound\r
  )\r
;\r
\r
void\r
StringDBFormatString (\r
  WCHAR   *String\r
  )\r
;\r
\r
STATUS\r
StringDBCreateHiiExportPack (\r
  INT8                *OutputFileName,\r
  WCHAR_STRING_LIST   *LanguagesOfInterest\r
  );\r
\r
\r
#endif // #ifndef _STRING_DB_H_\r