ShellPkg: Fix spelling mistake for occurred

[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / HexEdit / Misc.c

/** @file\r
  Implementation of various string and line routines\r
\r
  Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved. <BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "HexEditor.h"\r
\r
extern BOOLEAN  HEditorMouseAction;\r
\r
/**\r
  Free a line and it's internal buffer.\r
\r
  @param[in] Src    The line to be freed.\r
**/\r
VOID\r
HLineFree (\r
  IN  HEFI_EDITOR_LINE *Src\r
  )\r
{\r
  if (Src == NULL) {\r
    return ;\r
  }\r
\r
  SHELL_FREE_NON_NULL (Src);\r
\r
}\r
\r
/**\r
  Advance to the next Count lines.\r
\r
  @param[in] Count      The line number to advance.\r
\r
  @retval NULL An error occurred.\r
  @return A pointer to the line after advance.\r
**/\r
HEFI_EDITOR_LINE *\r
HLineAdvance (\r
  IN  UINTN Count\r
  )\r
{\r
  UINTN             Index;\r
  HEFI_EDITOR_LINE  *Line;\r
\r
  Line = HMainEditor.BufferImage->CurrentLine;\r
  if (Line == NULL) {\r
    return NULL;\r
  }\r
\r
  for (Index = 0; Index < Count; Index++) {\r
    //\r
    // if already last line\r
    //\r
    if (Line->Link.ForwardLink == HMainEditor.BufferImage->ListHead) {\r
      return NULL;\r
    }\r
\r
    Line = CR (Line->Link.ForwardLink, HEFI_EDITOR_LINE, Link, EFI_EDITOR_LINE_LIST);\r
  }\r
\r
  return Line;\r
}\r
\r
/**\r
  Retreat to the previous Count lines.\r
\r
  @param[in] Count    The line number to retreat.\r
\r
  @retval NULL An error occurred.\r
  @return A pointer to the line after retreat.\r
**/\r
HEFI_EDITOR_LINE *\r
HLineRetreat (\r
  IN  UINTN Count\r
  )\r
{\r
  UINTN             Index;\r
  HEFI_EDITOR_LINE  *Line;\r
\r
  Line = HMainEditor.BufferImage->CurrentLine;\r
  if (Line == NULL) {\r
    return NULL;\r
  }\r
\r
  for (Index = 0; Index < Count; Index++) {\r
    //\r
    // already the first line\r
    //\r
    if (Line->Link.BackLink == HMainEditor.BufferImage->ListHead) {\r
      return NULL;\r
    }\r
\r
    Line = CR (Line->Link.BackLink, HEFI_EDITOR_LINE, Link, EFI_EDITOR_LINE_LIST);\r
  }\r
\r
  return Line;\r
}\r
\r
/**\r
  Advance/Retreat lines.\r
\r
  @param[in] Count      The line number to advance/retreat.\r
                            >0 : advance\r
                            <0: retreat\r
\r
  @retval NULL An error occurred.\r
  @return A pointer to the line after move.\r
**/\r
HEFI_EDITOR_LINE *\r
HMoveLine (\r
  IN  INTN Count\r
  )\r
{\r
  HEFI_EDITOR_LINE  *Line;\r
  UINTN             AbsCount;\r
\r
  //\r
  // difference with MoveCurrentLine\r
  //     just return Line\r
  //     do not set currentline to Line\r
  //\r
  if (Count <= 0) {\r
    AbsCount  = (UINTN)ABS(Count);\r
    Line      = HLineRetreat (AbsCount);\r
  } else {\r
    Line = HLineAdvance ((UINTN)Count);\r
  }\r
\r
  return Line;\r
}\r
\r
/**\r
  Advance/Retreat lines and set CurrentLine in BufferImage to it.\r
\r
  @param[in] Count    The line number to advance/retreat.\r
                          >0 : advance\r
                          <0: retreat\r
\r
  @retval NULL An error occurred.\r
  @return A pointer to the line after move.\r
**/\r
HEFI_EDITOR_LINE *\r
HMoveCurrentLine (\r
  IN  INTN Count\r
  )\r
{\r
  HEFI_EDITOR_LINE  *Line;\r
  UINTN             AbsCount;\r
\r
  //\r
  // <0: retreat\r
  // >0: advance\r
  //\r
  if (Count <= 0) {\r
    AbsCount  = (UINTN)ABS(Count);\r
    Line      = HLineRetreat (AbsCount);\r
  } else {\r
    Line = HLineAdvance ((UINTN)Count);\r
  }\r
\r
  if (Line == NULL) {\r
    return NULL;\r
  }\r
\r
  HMainEditor.BufferImage->CurrentLine = Line;\r
\r
  return Line;\r
}\r
\r
\r
/**\r
  Free all the lines in HBufferImage.\r
    Fields affected:\r
    Lines\r
    CurrentLine\r
    NumLines\r
    ListHead\r
\r
  @param[in] ListHead     The list head.\r
  @param[in] Lines        The lines.\r
\r
  @retval EFI_SUCCESS     The operation was successful.\r
**/\r
EFI_STATUS\r
HFreeLines (\r
  IN LIST_ENTRY   *ListHead,\r
  IN HEFI_EDITOR_LINE *Lines\r
  )\r
{\r
  LIST_ENTRY        *Link;\r
  HEFI_EDITOR_LINE  *Line;\r
\r
  //\r
  // release all the lines\r
  //\r
  if (Lines != NULL) {\r
\r
    Line  = Lines;\r
    Link  = &(Line->Link);\r
    do {\r
      Line  = CR (Link, HEFI_EDITOR_LINE, Link, EFI_EDITOR_LINE_LIST);\r
      Link  = Link->ForwardLink;\r
      HLineFree (Line);\r
    } while (Link != ListHead);\r
  }\r
\r
  ListHead->ForwardLink = ListHead;\r
  ListHead->BackLink = ListHead;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Get the X information for the mouse.\r
\r
  @param[in] GuidX      The change.\r
\r
  @return the new information.\r
**/\r
INT32\r
HGetTextX (\r
  IN INT32 GuidX\r
  )\r
{\r
  INT32 Gap;\r
\r
  HMainEditor.MouseAccumulatorX += GuidX;\r
  Gap = (HMainEditor.MouseAccumulatorX * (INT32) HMainEditor.ScreenSize.Column) / (INT32) (50 * (INT32) HMainEditor.MouseInterface->Mode->ResolutionX);\r
  HMainEditor.MouseAccumulatorX = (HMainEditor.MouseAccumulatorX * (INT32) HMainEditor.ScreenSize.Column) % (INT32) (50 * (INT32) HMainEditor.MouseInterface->Mode->ResolutionX);\r
  HMainEditor.MouseAccumulatorX = HMainEditor.MouseAccumulatorX / (INT32) HMainEditor.ScreenSize.Column;\r
  return Gap;\r
}\r
\r
/**\r
  Get the Y information for the mouse.\r
\r
  @param[in] GuidY      The change.\r
\r
  @return the new information.\r
**/\r
INT32\r
HGetTextY (\r
  IN INT32 GuidY\r
  )\r
{\r
  INT32 Gap;\r
\r
  HMainEditor.MouseAccumulatorY += GuidY;\r
  Gap = (HMainEditor.MouseAccumulatorY * (INT32) HMainEditor.ScreenSize.Row) / (INT32) (50 * (INT32) HMainEditor.MouseInterface->Mode->ResolutionY);\r
  HMainEditor.MouseAccumulatorY = (HMainEditor.MouseAccumulatorY * (INT32) HMainEditor.ScreenSize.Row) % (INT32) (50 * (INT32) HMainEditor.MouseInterface->Mode->ResolutionY);\r
  HMainEditor.MouseAccumulatorY = HMainEditor.MouseAccumulatorY / (INT32) HMainEditor.ScreenSize.Row;\r
\r
  return Gap;\r
}\r