Fix the comments to follow UEFI Spec regarding how to check an EFI_HANDLE is valid...

[mirror_edk2.git] / MdeModulePkg / Universal / Console / TerminalDxe / Ansi.c

/** @file\r
  Implementation of translation upon PC ANSI.\r
\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
\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
**/\r
\r
\r
#include "Terminal.h"\r
\r
/**\r
  Translate all raw data in the Raw FIFO into unicode, and insert\r
  them into Unicode FIFO.\r
\r
  @param TerminalDevice          The terminal device.\r
\r
**/\r
VOID\r
AnsiRawDataToUnicode (\r
  IN  TERMINAL_DEV    *TerminalDevice\r
  )\r
{\r
  UINT8 RawData;\r
\r
  //\r
  // pop the raw data out from the raw fifo,\r
  // and translate it into unicode, then push\r
  // the unicode into unicode fifo, until the raw fifo is empty.\r
  //\r
  while (!IsRawFiFoEmpty (TerminalDevice)) {\r
\r
    RawFiFoRemoveOneKey (TerminalDevice, &RawData);\r
\r
    UnicodeFiFoInsertOneKey (TerminalDevice, (UINT16) RawData);\r
  }\r
}\r
\r
/**\r
  Check if input string is valid Ascii string, valid EFI control characters\r
  or valid text graphics.\r
\r
  @param  TerminalDevice          The terminal device.\r
  @param  WString                 The input string.          \r
 \r
  @retval EFI_UNSUPPORTED         If not all input characters are valid.\r
  @retval EFI_SUCCESS             If all input characters are valid.\r
\r
**/\r
EFI_STATUS\r
AnsiTestString (\r
  IN  TERMINAL_DEV    *TerminalDevice,\r
  IN  CHAR16          *WString\r
  )\r
{\r
  CHAR8 GraphicChar;\r
\r
  //\r
  // support three kind of character:\r
  // valid ascii, valid efi control char, valid text graphics.\r
  //\r
  for (; *WString != CHAR_NULL; WString++) {\r
\r
    if ( !(TerminalIsValidAscii (*WString) ||\r
        TerminalIsValidEfiCntlChar (*WString) ||\r
        TerminalIsValidTextGraphics (*WString, &GraphicChar, NULL) )) {\r
\r
      return EFI_UNSUPPORTED;\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r