Standard Libraries for EDK II.

[mirror_edk2.git] / StdLib / LibC / Wchar / Comparison.c

/** @file\r
    Comparison Functions for <wchar.h>.\r
\r
    Unless explicitly stated otherwise, the functions defined in this file order\r
    two wide characters the same way as two integers of the underlying integer\r
    type designated by wchar_t.\r
\r
    Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>\r
    This program and the accompanying materials are licensed and made available under\r
    the terms and conditions of the BSD License that accompanies this distribution.\r
    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
#include  <Uefi.h>\r
#include  <Library/BaseLib.h>\r
#include  <Library/BaseMemoryLib.h>\r
\r
#include  <LibConfig.h>\r
\r
#include  <wchar.h>\r
\r
/** The wcscmp function compares the wide string pointed to by s1 to the wide\r
    string pointed to by s2.\r
\r
    @return   The wcscmp function returns an integer greater than, equal to, or\r
              less than zero, accordingly as the wide string pointed to by s1\r
              is greater than, equal to, or less than the wide string\r
              pointed to by s2.\r
**/\r
int wcscmp(const wchar_t *s1, const wchar_t *s2)\r
{\r
  return (int)StrCmp( (CONST CHAR16 *)s1, (CONST CHAR16 *)s2);\r
}\r
\r
/** The wcscoll function compares the wide string pointed to by s1 to the wide\r
    string pointed to by s2, both interpreted as appropriate to the LC_COLLATE\r
    category of the current locale.\r
\r
    @return   The wcscoll function returns an integer greater than, equal to,\r
              or less than zero, accordingly as the wide string pointed to by\r
              s1 is greater than, equal to, or less than the wide string\r
              pointed to by s2 when both are interpreted as appropriate to\r
              the current locale.\r
**/\r
//int wcscoll(const wchar_t *s1, const wchar_t *s2)\r
//{\r
//  return -1;  // STUBB\r
//}\r
\r
/** The wcsncmp function compares not more than n wide characters (those that\r
    follow a null wide character are not compared) from the array pointed to by\r
    s1 to the array pointed to by s2.\r
\r
    @return   The wcsncmp function returns an integer greater than, equal to,\r
              or less than zero, accordingly as the possibly null-terminated\r
              array pointed to by s1 is greater than, equal to, or less than\r
              the possibly null-terminated array pointed to by s2.\r
**/\r
int wcsncmp(const wchar_t *s1, const wchar_t *s2, size_t n)\r
{\r
  return (int)StrnCmp( (CONST CHAR16 *)s1, (CONST CHAR16 *)s2, (UINTN)n);\r
}\r
\r
/** The wcsxfrm function transforms the wide string pointed to by s2 and places\r
    the resulting wide string into the array pointed to by s1. The\r
    transformation is such that if the wcscmp function is applied to two\r
    transformed wide strings, it returns a value greater than, equal to, or\r
    less than zero, corresponding to the result of the wcscoll function applied\r
    to the same two original wide strings. No more than n wide characters are\r
    placed into the resulting array pointed to by s1, including the terminating\r
    null wide character. If n is zero, s1 is permitted to be a null pointer.\r
\r
    @return   The wcsxfrm function returns the length of the transformed wide\r
              string (not including the terminating null wide character). If\r
              the value returned is n or greater, the contents of the array\r
              pointed to by s1 are indeterminate.\r
**/\r
//size_t wcsxfrm(wchar_t * __restrict s1, const wchar_t * __restrict s2, size_t n)\r
//{\r
//  return n;  // STUBB\r
//}\r
\r
/** The wmemcmp function compares the first n wide characters of the object\r
    pointed to by s1 to the first n wide characters of the object pointed to\r
    by s2.\r
\r
    @return   The wmemcmp function returns an integer greater than, equal to,\r
              or less than zero, accordingly as the object pointed to by s1 is\r
              greater than, equal to, or less than the object pointed to by s2.\r
**/\r
int wmemcmp(const wchar_t *s1, const wchar_t *s2, size_t n)\r
{\r
  return (int)CompareMem( s1, s2, (UINTN)(n * sizeof(wchar_t)));\r
}\r