[PATCH v2 0/1] MR2609: shlwapi: Implement StrFormatByteSizeEx

[David Kahurani (＠kahurani)]

Wine-Bug: https://bugs.winehq.org/show_bug.cgi?id=54733

Signed-off-by: David Kahurani <k.kahurani(a)gmail.com>

--
  v2: shlwapi: Implement StrFormatByteSizeEx
 
https://gitlab.winehq.org/wine/wine/-/merge_requests/2609

[PATCH v2 1/1] shlwapi: Implement StrFormatByteSizeEx

[David Kahurani]

From: David Kahurani <k.kahurani(a)gmail.com>

Wine-Bug: https://bugs.winehq.org/show_bug.cgi?id=54733
Signed-off-by: David Kahurani <k.kahurani(a)gmail.com>
---
 dlls/shlwapi/shlwapi.spec   |   1 +
 dlls/shlwapi/string.c       | 135 +++++++++++++++++++++++-------------
 dlls/shlwapi/tests/string.c |  33 +++++++++
 include/shlwapi.h           |   1 +
 include/shtypes.idl         |   5 ++
 5 files changed, 127 insertions(+), 48 deletions(-)

diff --git a/dlls/shlwapi/shlwapi.spec b/dlls/shlwapi/shlwapi.spec
index 801b2c9a890..0d4729b432f 100644
--- a/dlls/shlwapi/shlwapi.spec
+++ b/dlls/shlwapi/shlwapi.spec
@@ -783,6 +783,7 @@
 @ stdcall StrFormatByteSizeA(long ptr long)
 @ stdcall StrFormatByteSizeW(int64 ptr long)
 @ stdcall StrFormatKBSizeA(int64 str long)
+@ stdcall StrFormatByteSizeEx(int64 long ptr long)
 @ stdcall StrFormatKBSizeW(int64 wstr long)
 @ stdcall StrFromTimeIntervalA(ptr long long long)
 @ stdcall StrFromTimeIntervalW(ptr long long long)
diff --git a/dlls/shlwapi/string.c b/dlls/shlwapi/string.c
index 77e3b978cee..dbf86b8eb5a 100644
--- a/dlls/shlwapi/string.c
+++ b/dlls/shlwapi/string.c
@@ -840,6 +840,72 @@ typedef struct tagSHLWAPI_BYTEFORMATS
  *  There is no StrFormatByteSize64W function, it is called StrFormatByteSizeW().
  */
 LPWSTR WINAPI StrFormatByteSizeW(LONGLONG llBytes, LPWSTR lpszDest, UINT cchMax)
+{
+  HRESULT hr;
+
+  TRACE("(0x%s,%p,%d)\n", wine_dbgstr_longlong(llBytes), lpszDest, cchMax);
+
+  if (!lpszDest || !cchMax)
+    return lpszDest;
+
+  hr = StrFormatByteSizeEx(llBytes, SFBS_FLAGS_TRUNCATE_UNDISPLAYED_DECIMAL_DIGITS,
+                           lpszDest, cchMax);
+
+  if (FAILED(hr))
+    return NULL;
+
+  return lpszDest;
+}
+
+/*************************************************************************
+ * StrFormatByteSize64A	[SHLWAPI.@]
+ *
+ * See StrFormatByteSizeW.
+ */
+LPSTR WINAPI StrFormatByteSize64A(LONGLONG llBytes, LPSTR lpszDest, UINT cchMax)
+{
+  WCHAR wszBuff[32];
+
+  StrFormatByteSizeW(llBytes, wszBuff, ARRAY_SIZE(wszBuff));
+
+  if (lpszDest)
+    WideCharToMultiByte(CP_ACP, 0, wszBuff, -1, lpszDest, cchMax, 0, 0);
+  return lpszDest;
+}
+
+/*************************************************************************
+ * StrFormatByteSizeA	[SHLWAPI.@]
+ *
+ * Create a string containing an abbreviated byte count of up to 2^31-1.
+ *
+ * PARAMS
+ *  dwBytes  [I] Byte size to format
+ *  lpszDest [I] Destination for formatted string
+ *  cchMax   [I] Size of lpszDest
+ *
+ * RETURNS
+ *  lpszDest.
+ *
+ * NOTES
+ *  The ANSI and Unicode versions of this function accept a different
+ *  integer type for dwBytes. See StrFormatByteSize64A().
+ */
+LPSTR WINAPI StrFormatByteSizeA(DWORD dwBytes, LPSTR lpszDest, UINT cchMax)
+{
+  TRACE("(%ld,%p,%d)\n", dwBytes, lpszDest, cchMax);
+
+  return StrFormatByteSize64A(dwBytes, lpszDest, cchMax);
+}
+
+/*************************************************************************
+ * StrFormatByteSizeEx  [SHLWAPI.@]
+ *
+ * Create a string containing an abbreviated by count with rounding options
+ *
+ */
+
+HRESULT WINAPI StrFormatByteSizeEx(LONGLONG llBytes, SFBS_FLAGS flags, LPWSTR lpszDest,
+                                   UINT cchMax)
 {
 #define KB ((ULONGLONG)1024)
 #define MB (KB*KB)
@@ -866,21 +932,21 @@ LPWSTR WINAPI StrFormatByteSizeW(LONGLONG llBytes, LPWSTR lpszDest, UINT cchMax)
     { 1000*PB, 1073741824.0, 1.00, 0, 'P' }, /* 1000 PB */
     { 0, 10995116277.76, 100.00, 2, 'E' } /* EB's, catch all */
   };
+  UINT i = 0;
   WCHAR wszAdd[] = {' ','?','B',0};
   double dBytes;
-  UINT i = 0;
 
-  TRACE("(0x%s,%p,%d)\n", wine_dbgstr_longlong(llBytes), lpszDest, cchMax);
+  TRACE("(0x%s,%d,%p,%d)\n", wine_dbgstr_longlong(llBytes), flags, lpszDest, cchMax);
 
-  if (!lpszDest || !cchMax)
-    return lpszDest;
+  if (!cchMax)
+    return E_INVALIDARG;
 
   if (llBytes < 1024)  /* 1K */
   {
     WCHAR wszBytesFormat[64];
     LoadStringW(shlwapi_hInstance, IDS_BYTES_FORMAT, wszBytesFormat, 64);
     swprintf(lpszDest, cchMax, wszBytesFormat, (int)llBytes);
-    return lpszDest;
+    return S_OK;
   }
 
   /* Note that if this loop completes without finding a match, i will be
@@ -892,6 +958,7 @@ LPWSTR WINAPI StrFormatByteSizeW(LONGLONG llBytes, LPWSTR lpszDest, UINT cchMax)
       break;
     i++;
   }
+
   /* Above 1 TB we encounter problems with FP accuracy. So for amounts above
    * this number we integer shift down by 1 MB first. The table above has
    * the divisors scaled down from the '< 10 TB' entry onwards, to account
@@ -903,53 +970,25 @@ LPWSTR WINAPI StrFormatByteSizeW(LONGLONG llBytes, LPWSTR lpszDest, UINT cchMax)
   else
     dBytes = (double)llBytes + 0.00001;
 
-  dBytes = floor(dBytes / bfFormats[i].dDivisor) / bfFormats[i].dNormaliser;
+  switch(flags)
+  {
+  case SFBS_FLAGS_ROUND_TO_NEAREST_DISPLAYED_DIGIT:
+      dBytes = round(dBytes / bfFormats[i].dDivisor) / bfFormats[i].dNormaliser;
+      break;
+  case SFBS_FLAGS_TRUNCATE_UNDISPLAYED_DECIMAL_DIGITS:
+      dBytes = floor(dBytes / bfFormats[i].dDivisor) / bfFormats[i].dNormaliser;
+      break;
+  default:
+      return E_INVALIDARG;
+  }
 
+  /* Not sure about the error code. Can't find a way to trigger the error here */
   if (!FormatDouble(dBytes, bfFormats[i].nDecimals, lpszDest, cchMax))
-    return NULL;
+    return E_UNEXPECTED;
+
   wszAdd[1] = bfFormats[i].wPrefix;
   StrCatBuffW(lpszDest, wszAdd, cchMax);
-  return lpszDest;
-}
-
-/*************************************************************************
- * StrFormatByteSize64A	[SHLWAPI.@]
- *
- * See StrFormatByteSizeW.
- */
-LPSTR WINAPI StrFormatByteSize64A(LONGLONG llBytes, LPSTR lpszDest, UINT cchMax)
-{
-  WCHAR wszBuff[32];
-
-  StrFormatByteSizeW(llBytes, wszBuff, ARRAY_SIZE(wszBuff));
-
-  if (lpszDest)
-    WideCharToMultiByte(CP_ACP, 0, wszBuff, -1, lpszDest, cchMax, 0, 0);
-  return lpszDest;
-}
-
-/*************************************************************************
- * StrFormatByteSizeA	[SHLWAPI.@]
- *
- * Create a string containing an abbreviated byte count of up to 2^31-1.
- *
- * PARAMS
- *  dwBytes  [I] Byte size to format
- *  lpszDest [I] Destination for formatted string
- *  cchMax   [I] Size of lpszDest
- *
- * RETURNS
- *  lpszDest.
- *
- * NOTES
- *  The ANSI and Unicode versions of this function accept a different
- *  integer type for dwBytes. See StrFormatByteSize64A().
- */
-LPSTR WINAPI StrFormatByteSizeA(DWORD dwBytes, LPSTR lpszDest, UINT cchMax)
-{
-  TRACE("(%ld,%p,%d)\n", dwBytes, lpszDest, cchMax);
-
-  return StrFormatByteSize64A(dwBytes, lpszDest, cchMax);
+  return S_OK;
 }
 
 /*************************************************************************
diff --git a/dlls/shlwapi/tests/string.c b/dlls/shlwapi/tests/string.c
index d988e26acb4..f3d91ff579e 100644
--- a/dlls/shlwapi/tests/string.c
+++ b/dlls/shlwapi/tests/string.c
@@ -52,6 +52,7 @@ static DWORD   (WINAPI *pStrCatChainW)(LPWSTR,DWORD,DWORD,LPCWSTR);
 static LPSTR   (WINAPI *pStrCpyNXA)(LPSTR,LPCSTR,int);
 static LPWSTR  (WINAPI *pStrCpyNXW)(LPWSTR,LPCWSTR,int);
 static LPSTR   (WINAPI *pStrFormatByteSize64A)(LONGLONG,LPSTR,UINT);
+static HRESULT (WINAPI *pStrFormatByteSizeEx)(LONGLONG,SFBS_FLAGS,LPWSTR,UINT);
 static LPSTR   (WINAPI *pStrFormatKBSizeA)(LONGLONG,LPSTR,UINT);
 static LPWSTR  (WINAPI *pStrFormatKBSizeW)(LONGLONG,LPWSTR,UINT);
 static BOOL    (WINAPI *pStrIsIntlEqualA)(BOOL,LPCSTR,LPCSTR,int);
@@ -715,6 +716,36 @@ static void test_StrFormatByteSize64A(void)
   }
 }
 
+static void test_StrFormatByteSizeEx(void)
+{
+  WCHAR szBuff[256];
+  HRESULT hr;
+  LONGLONG test_value = 2147483647;
+
+  if (!pStrFormatByteSizeEx)
+  {
+    win_skip("StrFormatByteSizeEx is not available \n");
+    return;
+  }
+
+  hr = pStrFormatByteSizeEx(0xdeadbeef,
+                            SFBS_FLAGS_TRUNCATE_UNDISPLAYED_DECIMAL_DIGITS, szBuff, 0);
+  ok(hr == E_INVALIDARG, "Unexpected hr: %#lx expected: %#lx\n", hr, E_INVALIDARG);
+
+  hr = pStrFormatByteSizeEx(0xdeadbeef, 10, szBuff, 256);
+  ok(hr == E_INVALIDARG, "Unexpected hr: %#lx expected: %#lx\n", hr, E_INVALIDARG);
+
+  hr = pStrFormatByteSizeEx(test_value, 1, szBuff, 256);
+  ok(hr == S_OK, "Invalid arguments \n");
+  ok(!wcscmp(szBuff, L"2.00 GB"), "Formatted %s wrong: got %ls, expected 2.00 GB\n",
+     wine_dbgstr_longlong(test_value), szBuff);
+
+  hr = pStrFormatByteSizeEx(test_value, 2, szBuff, 256);
+  ok(hr == S_OK, "Invalid arguments \n");
+  ok(!wcscmp(szBuff, L"1.99 GB"), "Formatted %s wrong: got %ls, expected 1.99 GB\n",
+     wine_dbgstr_longlong(test_value), szBuff);
+}
+
 static void test_StrFormatKBSizeW(void)
 {
   WCHAR szBuffW[256];
@@ -1680,6 +1711,7 @@ START_TEST(string)
   pStrCpyNXW = (void *)GetProcAddress(hShlwapi, (LPSTR)400);
   pStrChrNW = (void *)GetProcAddress(hShlwapi, "StrChrNW");
   pStrFormatByteSize64A = (void *)GetProcAddress(hShlwapi, "StrFormatByteSize64A");
+  pStrFormatByteSizeEx = (void*)GetProcAddress(hShlwapi, "StrFormatByteSizeEx");
   pStrFormatKBSizeA = (void *)GetProcAddress(hShlwapi, "StrFormatKBSizeA");
   pStrFormatKBSizeW = (void *)GetProcAddress(hShlwapi, "StrFormatKBSizeW");
   pStrIsIntlEqualA = (void *)GetProcAddress(hShlwapi, "StrIsIntlEqualA");
@@ -1716,6 +1748,7 @@ START_TEST(string)
   if (is_lang_english() && is_locale_english())
   {
     test_StrFormatByteSize64A();
+    test_StrFormatByteSizeEx();
     test_StrFormatKBSizeA();
     test_StrFormatKBSizeW();
   }
diff --git a/include/shlwapi.h b/include/shlwapi.h
index eee41abf0dc..4f9803e0e0f 100644
--- a/include/shlwapi.h
+++ b/include/shlwapi.h
@@ -855,6 +855,7 @@ WINSHLWAPI HRESULT WINAPI SHStrDupW(LPCWSTR,WCHAR**);
 #define SHStrDup WINELIB_NAME_AW(SHStrDup)
 
 WINSHLWAPI LPSTR WINAPI StrFormatByteSizeA (DWORD,LPSTR,UINT);
+WINSHLWAPI HRESULT WINAPI StrFormatByteSizeEx(LONGLONG,SFBS_FLAGS,LPWSTR,UINT);
 
 /* A/W Pairing is broken for this function */
 WINSHLWAPI LPSTR WINAPI StrFormatByteSize64A (LONGLONG,LPSTR,UINT);
diff --git a/include/shtypes.idl b/include/shtypes.idl
index c83562a24bb..1b6e7c78e90 100644
--- a/include/shtypes.idl
+++ b/include/shtypes.idl
@@ -182,3 +182,8 @@ typedef [v1_enum] enum DEVICE_SCALE_FACTOR
   SCALE_450_PERCENT = 450,
   SCALE_500_PERCENT = 500
 } DEVICE_SCALE_FACTOR;
+
+typedef [v1_enum] enum tagSFBS_FLAGS {
+  SFBS_FLAGS_ROUND_TO_NEAREST_DISPLAYED_DIGIT = 0x0001,
+  SFBS_FLAGS_TRUNCATE_UNDISPLAYED_DECIMAL_DIGITS = 0x0002
+} SFBS_FLAGS;
-- 
GitLab

https://gitlab.winehq.org/wine/wine/-/merge_requests/2609