License header updated to match correct format.

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

/** @file\r
String routines implementation\r
\r
Copyright (c) 2007 - 2014, 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
#ifndef _EFI_STRING_FUNCS_H\r
#define _EFI_STRING_FUNCS_H\r
\r
#include <stdio.h>\r
#include <stdlib.h>\r
#include <Common/UefiBaseTypes.h>\r
\r
//\r
// Common data structures\r
//\r
typedef struct {\r
  UINTN      Count;\r
  //\r
  // Actually this array can be 0 or more items (based on Count)\r
  //\r
  CHAR8*     Strings[1];\r
} STRING_LIST;\r
\r
\r
//\r
// Functions declarations\r
//\r
\r
CHAR8*\r
CloneString (\r
  IN CHAR8       *String\r
  )\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
\r
EFI_STATUS\r
StripInfDscStringInPlace (\r
  IN CHAR8       *String\r
  )\r
;\r
/**\r
\r
Routine Description:\r
\r
  Remove all comments, leading and trailing whitespace from the string.\r
\r
Arguments:\r
\r
  Strin          The string to 'strip'\r
\r
Returns:\r
\r
  EFI_STATUS\r
\r
**/\r
\r
\r
STRING_LIST*\r
SplitStringByWhitespace (\r
  IN CHAR8       *String\r
  )\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
\r
STRING_LIST*\r
NewStringList (\r
  )\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
\r
EFI_STATUS\r
AppendCopyOfStringToList (\r
  IN OUT STRING_LIST **StringList,\r
  IN CHAR8       *String\r
  )\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
\r
EFI_STATUS\r
RemoveLastStringFromList (\r
  IN STRING_LIST       *StringList\r
  )\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
\r
STRING_LIST*\r
AllocateStringListStruct (\r
  IN UINTN StringCount\r
  )\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
\r
VOID\r
FreeStringList (\r
  IN STRING_LIST       *StringList\r
  )\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
  EFI_STATUS\r
\r
**/\r
\r
\r
CHAR8*\r
StringListToString (\r
  IN STRING_LIST       *StringList\r
  )\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
\r
VOID\r
PrintStringList (\r
  IN STRING_LIST       *StringList\r
  )\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
**/\r
\r
\r
#endif\r