UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

[mirror_edk2.git] / BaseTools / Source / C / Common / StringFuncs.c

/** @file\r
Function prototypes and defines for string routines.\r
\r
Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <string.h>\r
#include <ctype.h>\r
#include "StringFuncs.h"\r
\r
//\r
// Functions implementations\r
//\r
\r
CHAR8*\r
CloneString (\r
  IN CHAR8       *String\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Allocates a new string and copies 'String' to clone it\r
\r
Arguments:\r
\r
  String          The string to clone\r
\r
Returns:\r
\r
  CHAR8* - NULL if there are not enough resources\r
\r
--*/\r
{\r
  CHAR8* NewString;\r
\r
  NewString = malloc (strlen (String) + 1);\r
  if (NewString != NULL) {\r
    strcpy (NewString, String);\r
  }\r
\r
  return NewString;\r
}\r
\r
\r
EFI_STATUS\r
StripInfDscStringInPlace (\r
  IN CHAR8       *String\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Remove all comments, leading and trailing whitespace from the string.\r
\r
Arguments:\r
\r
  String          The string to 'strip'\r
\r
Returns:\r
\r
  EFI_STATUS\r
\r
--*/\r
{\r
  CHAR8 *Pos;\r
\r
  if (String == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Remove leading whitespace\r
  //\r
  for (Pos = String; isspace ((int)*Pos); Pos++) {\r
  }\r
  if (Pos != String) {\r
    memmove (String, Pos, strlen (Pos) + 1);\r
  }\r
\r
  //\r
  // Comment BUGBUGs!\r
  //\r
  // What about strings?  Comment characters are okay in strings.\r
  // What about multiline comments?\r
  //\r
\r
  Pos = (CHAR8 *) strstr (String,  "//");\r
  if (Pos != NULL) {\r
    *Pos = '\0';\r
  }\r
\r
  Pos = (CHAR8 *) strchr (String, '#');\r
  if (Pos != NULL) {\r
    *Pos = '\0';\r
  }\r
\r
  //\r
  // Remove trailing whitespace\r
  //\r
  for (Pos = String + strlen (String);\r
       ((Pos - 1) >= String) && (isspace ((int)*(Pos - 1)));\r
       Pos--\r
      ) {\r
  }\r
  *Pos = '\0';\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
STRING_LIST*\r
SplitStringByWhitespace (\r
  IN CHAR8       *String\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Creates and returns a 'split' STRING_LIST by splitting the string\r
  on whitespace boundaries.\r
\r
Arguments:\r
\r
  String          The string to 'split'\r
\r
Returns:\r
\r
  EFI_STATUS\r
\r
--*/\r
{\r
  CHAR8       *Pos;\r
  CHAR8       *EndOfSubString;\r
  CHAR8       *EndOfString;\r
  STRING_LIST *Output;\r
  UINTN       Item;\r
\r
  String = CloneString (String);\r
  if (String == NULL) {\r
    return NULL;\r
  }\r
  EndOfString = String + strlen (String);\r
\r
  Output = NewStringList ();\r
\r
  for (Pos = String, Item = 0; Pos < EndOfString; Item++) {\r
    while (isspace ((int)*Pos)) {\r
      Pos++;\r
    }\r
\r
    for (EndOfSubString=Pos;\r
         (*EndOfSubString != '\0') && !isspace ((int)*EndOfSubString);\r
         EndOfSubString++\r
         ) {\r
    }\r
\r
    if (EndOfSubString == Pos) {\r
      break;\r
    }\r
\r
    *EndOfSubString = '\0';\r
\r
    AppendCopyOfStringToList (&Output, Pos);\r
\r
    Pos = EndOfSubString + 1;\r
  }\r
\r
  free (String);\r
  return Output;\r
}\r
\r
\r
STRING_LIST*\r
NewStringList (\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Creates a new STRING_LIST with 0 strings.\r
\r
Returns:\r
\r
  STRING_LIST* - Null if there is not enough resources to create the object.\r
\r
--*/\r
{\r
  STRING_LIST *NewList;\r
  NewList = AllocateStringListStruct (0);\r
  if (NewList != NULL) {\r
    NewList->Count = 0;\r
  }\r
  return NewList;\r
}\r
\r
\r
EFI_STATUS\r
AppendCopyOfStringToList (\r
  IN OUT STRING_LIST **StringList,\r
  IN CHAR8       *String\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Adds String to StringList.  A new copy of String is made before it is\r
  added to StringList.\r
\r
Returns:\r
\r
  EFI_STATUS\r
\r
--*/\r
{\r
  STRING_LIST *OldList;\r
  STRING_LIST *NewList;\r
  CHAR8       *NewString;\r
\r
  OldList = *StringList;\r
  NewList = AllocateStringListStruct (OldList->Count + 1);\r
  if (NewList == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  NewString = CloneString (String);\r
  if (NewString == NULL) {\r
    free (NewList);\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  memcpy (\r
    NewList->Strings,\r
    OldList->Strings,\r
    sizeof (OldList->Strings[0]) * OldList->Count\r
    );\r
  NewList->Count = OldList->Count + 1;\r
  NewList->Strings[OldList->Count] = NewString;\r
\r
  *StringList = NewList;\r
  free (OldList);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
EFI_STATUS\r
RemoveLastStringFromList (\r
  IN STRING_LIST       *StringList\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Removes the last string from StringList and frees the memory associated\r
  with it.\r
\r
Arguments:\r
\r
  StringList        The string list to remove the string from\r
\r
Returns:\r
\r
  EFI_STATUS\r
\r
--*/\r
{\r
  if (StringList->Count == 0) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  free (StringList->Strings[StringList->Count - 1]);\r
  StringList->Count--;\r
  return EFI_SUCCESS;\r
}\r
\r
\r
STRING_LIST*\r
AllocateStringListStruct (\r
  IN UINTN StringCount\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Allocates a STRING_LIST structure that can store StringCount strings.\r
\r
Arguments:\r
\r
  StringCount        The number of strings that need to be stored\r
\r
Returns:\r
\r
  EFI_STATUS\r
\r
--*/\r
{\r
  return malloc (OFFSET_OF(STRING_LIST, Strings[StringCount + 1]));\r
}\r
\r
\r
VOID\r
FreeStringList (\r
  IN STRING_LIST       *StringList\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Frees all memory associated with StringList.\r
\r
Arguments:\r
\r
  StringList        The string list to free\r
\r
Returns:\r
\r
  VOID\r
--*/\r
{\r
  while (StringList->Count > 0) {\r
    RemoveLastStringFromList (StringList);\r
  }\r
\r
  free (StringList);\r
}\r
\r
\r
CHAR8*\r
StringListToString (\r
  IN STRING_LIST       *StringList\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Generates a string that represents the STRING_LIST\r
\r
Arguments:\r
\r
  StringList        The string list to convert to a string\r
\r
Returns:\r
\r
  CHAR8* - The string list represented with a single string.  The returned\r
           string must be freed by the caller.\r
\r
--*/\r
{\r
  UINTN Count;\r
  UINTN Length;\r
  CHAR8 *NewString;\r
\r
  Length = 2;\r
  for (Count = 0; Count < StringList->Count; Count++) {\r
    if (Count > 0) {\r
      Length += 2;\r
    }\r
    Length += strlen (StringList->Strings[Count]) + 2;\r
  }\r
\r
  NewString = malloc (Length + 1);\r
  if (NewString == NULL) {\r
    return NewString;\r
  }\r
  NewString[0] = '\0';\r
\r
  strcat (NewString, "[");\r
  for (Count = 0; Count < StringList->Count; Count++) {\r
    if (Count > 0) {\r
      strcat (NewString, ", ");\r
    }\r
    strcat (NewString, "\"");\r
    strcat (NewString, StringList->Strings[Count]);\r
    strcat (NewString, "\"");\r
  }\r
  strcat (NewString, "]");\r
\r
  return NewString;\r
}\r
\r
\r
VOID\r
PrintStringList (\r
  IN STRING_LIST       *StringList\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Prints out the string list\r
\r
Arguments:\r
\r
  StringList        The string list to print\r
\r
Returns:\r
\r
  EFI_STATUS\r
\r
--*/\r
{\r
  CHAR8* String;\r
  String = StringListToString (StringList);\r
  if (String != NULL) {\r
    printf ("%s", String);\r
    free (String);\r
  }\r
}\r
\r
\r