Add hsDarwin with helpers for string conversion

dpogue · dpogue · commit 19978b83ed08 · 2023-09-06T19:23:58.000-07:00
The NSString category in the macOS plClient folder is useful, but there
are several other spots where we're wanting to convert between
CFString/NSString and ST::string, so it make sense to have helpers
available throughout the engine. These helper functions are written so
that they can be used from C++ code without needing to bring in
Objective-C.
diff --git a/Sources/Plasma/Apps/plClient/CMakeLists.txt b/Sources/Plasma/Apps/plClient/CMakeLists.txt
@@ -92,22 +92,22 @@ if(WIN32)
 elseif(APPLE)
     set(plClient_SOURCES ${plClient_SOURCES}
         Mac-Cocoa/main.mm
+        Mac-Cocoa/NSString+StringTheory.mm
         Mac-Cocoa/PLSKeyboardEventMonitor.mm
         Mac-Cocoa/PLSView.mm
         Mac-Cocoa/PLSLoginWindowController.mm
         Mac-Cocoa/PLSPatcherWindowController.mm
         Mac-Cocoa/PLSPatcher.mm
         Mac-Cocoa/PLSServerStatus.mm
-        Mac-Cocoa/StringTheory_NSString.mm
     )
     set(plClient_HEADERS ${plClient_HEADERS}
+        Mac-Cocoa/NSString+StringTheory.h
         Mac-Cocoa/PLSKeyboardEventMonitor.h
         Mac-Cocoa/PLSView.h
         Mac-Cocoa/PLSLoginWindowController.h
         Mac-Cocoa/PLSPatcherWindowController.h
         Mac-Cocoa/PLSPatcher.h
         Mac-Cocoa/PLSServerStatus.h
-        Mac-Cocoa/StringTheory_NSString.h
     )
     set(RESOURCES 
         Mac-Cocoa/MainMenu.xib
diff --git a/Sources/Plasma/Apps/plClient/Mac-Cocoa/NSString+StringTheory.h b/Sources/Plasma/Apps/plClient/Mac-Cocoa/NSString+StringTheory.h
@@ -47,7 +47,6 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface NSString (StringTheory)
 
-- (id)initWithSTString:(const ST::string&)string;
 + (id)stringWithSTString:(const ST::string&)string;
 
 - (const ST::string)STString;
diff --git a/Sources/Plasma/Apps/plClient/Mac-Cocoa/NSString+StringTheory.mm b/Sources/Plasma/Apps/plClient/Mac-Cocoa/NSString+StringTheory.mm
@@ -40,24 +40,19 @@
 
 *==LICENSE==*/
 
-#include "StringTheory_NSString.h"
+#include "NSString+StringTheory.h"
+#include "hsDarwin.h"
 
 @implementation NSString (StringTheory)
 
-- (id)initWithSTString:(const ST::string&)string
-{
-    self = [self initWithUTF8String:string.c_str()];
-    return self;
-}
-
 + (id)stringWithSTString:(const ST::string&)string
 {
-    return [[NSString alloc] initWithSTString:string];
+    return NSStringCreateWithSTString(string);
 }
 
 - (const ST::string)STString
 {
-    return ST::string([self UTF8String]);
+    return STStringFromNSString(self);
 }
 
 @end
diff --git a/Sources/Plasma/Apps/plClient/Mac-Cocoa/PLSLoginWindowController.mm b/Sources/Plasma/Apps/plClient/Mac-Cocoa/PLSLoginWindowController.mm
@@ -43,7 +43,7 @@
 #import "PLSLoginWindowController.h"
 #include <regex>
 #import "PLSServerStatus.h"
-#include "StringTheory_NSString.h"
+#import "NSString+StringTheory.h"
 #include "pfPasswordStore/pfPasswordStore.h"
 #include "plNetGameLib/plNetGameLib.h"
 #include "plProduct.h"
@@ -128,8 +128,8 @@ - (void)save
     [[NSUserDefaults standardUserDefaults] synchronize];
 
     if (self.password && ![self.password isEqualToString:FAKE_PASS_STRING]) {
-        ST::string username = ST::string([self.username cStringUsingEncoding:NSUTF8StringEncoding]);
-        ST::string password = ST::string([self.password cStringUsingEncoding:NSUTF8StringEncoding]);
+        ST::string username = [self.username STString];
+        ST::string password = [self.password STString];
 
         pfPasswordStore* store = pfPasswordStore::Instance();
         if (self.rememberPassword)
@@ -160,8 +160,8 @@ - (void)storeHash:(ShaDigest&)namePassHash
     //  Hash username and password before sending over the 'net.
     //  -- Legacy compatibility: @gametap (and other usernames with domains in them) need
     //     to be hashed differently.
-    ST::string username = ST::string([self.username cStringUsingEncoding:NSUTF8StringEncoding]);
-    ST::string password = ST::string([self.password cStringUsingEncoding:NSUTF8StringEncoding]);
+    ST::string username = [self.username STString];
+    ST::string password = [self.password STString];
     static const std::regex re_domain("[^@]+@([^.]+\\.)*([^.]+)\\.[^.]+");
     std::cmatch match;
     std::regex_search(username.c_str(), match, re_domain);
@@ -185,7 +185,7 @@ - (void)makeCurrent
     ShaDigest hash;
     [self storeHash:hash];
 
-    ST::string username = ST::string([self.username cStringUsingEncoding:NSUTF8StringEncoding]);
+    ST::string username = [self.username STString];
     NetCommSetAccountUsernamePassword(username, hash);
     NetCommSetAuthTokenAndOS(nullptr, u"mac");
 }
@@ -214,7 +214,7 @@ - (void)windowDidLoad
 
     [self.window center];
     [self.productTextField
-        setStringValue:[NSString stringWithSTString:plProduct::ProductString().c_str()]];
+        setStringValue:[NSString stringWithSTString:plProduct::ProductString()]];
 }
 
 - (NSNibName)windowNibName
diff --git a/Sources/Plasma/Apps/plClient/Mac-Cocoa/PLSPatcher.mm b/Sources/Plasma/Apps/plClient/Mac-Cocoa/PLSPatcher.mm
@@ -41,10 +41,10 @@
 *==LICENSE==*/
 
 #import "PLSPatcher.h"
+#import "NSString+StringTheory.h"
 
 #include <unordered_set>
 #include <string_theory/format>
-#include "StringTheory_NSString.h"
 
 #include "HeadSpin.h"
 #include "hsTimer.h"
diff --git a/Sources/Plasma/Apps/plClient/Mac-Cocoa/PLSPatcherWindowController.mm b/Sources/Plasma/Apps/plClient/Mac-Cocoa/PLSPatcherWindowController.mm
@@ -41,7 +41,7 @@
 *==LICENSE==*/
 
 #import "PLSPatcherWindowController.h"
-#include <string_theory/string>
+#import "NSString+StringTheory.h"
 #include "PLSServerStatus.h"
 #include "plProduct.h"
 
@@ -111,8 +111,7 @@ - (void)windowDidLoad
     [super windowDidLoad];
 
     [self.progressBar startAnimation:self];
-    self.productLabel.stringValue =
-        [NSString stringWithUTF8String:plProduct::ProductString().c_str()];
+    self.productLabel.stringValue = [NSString stringWithSTString:plProduct::ProductString()];
     // register for an async notification of when status loads
     [[PLSServerStatus sharedStatus]
         addObserver:self
diff --git a/Sources/Plasma/Apps/plClient/Mac-Cocoa/PLSServerStatus.mm b/Sources/Plasma/Apps/plClient/Mac-Cocoa/PLSServerStatus.mm
@@ -41,8 +41,7 @@
 *==LICENSE==*/
 
 #import "PLSServerStatus.h"
-#include <string_theory/string>
-#include "StringTheory_NSString.h"
+#import "NSString+StringTheory.h"
 #include "plNetGameLib/plNetGameLib.h"
 
 @interface PLSServerStatus () <NSURLSessionDelegate>
diff --git a/Sources/Plasma/Apps/plClient/Mac-Cocoa/main.mm b/Sources/Plasma/Apps/plClient/Mac-Cocoa/main.mm
@@ -45,12 +45,12 @@
 #import <QuartzCore/QuartzCore.h>
 
 // Cocoa client
+#import "NSString+StringTheory.h"
 #import "PLSKeyboardEventMonitor.h"
 #import "PLSLoginWindowController.h"
 #import "PLSPatcherWindowController.h"
 #import "PLSServerStatus.h"
 #import "PLSView.h"
-#import "StringTheory_NSString.h"
 
 // stdlib
 #include <algorithm>
diff --git a/Sources/Plasma/CoreLib/CMakeLists.txt b/Sources/Plasma/CoreLib/CMakeLists.txt
@@ -40,6 +40,7 @@ set(CoreLib_HEADERS
     hsBounds.h
     hsColorRGBA.h
     hsCpuID.h
+    hsDarwin.h
     hsExceptions.h
     hsExceptionStack.h
     hsFastMath.h
@@ -81,7 +82,6 @@ target_link_libraries(
         Threads::Threads
         $<$<AND:$<CONFIG:Debug>,$<BOOL:${USE_VLD}>>:VLD::VLD>
         "$<$<PLATFORM_ID:Darwin>:-framework Accelerate>"
-    PRIVATE
         "$<$<PLATFORM_ID:Darwin>:-framework CoreFoundation>"
 )
 target_include_directories(
diff --git a/Sources/Plasma/CoreLib/_CoreLibPch.h b/Sources/Plasma/CoreLib/_CoreLibPch.h
@@ -59,6 +59,7 @@ You can contact Cyan Worlds, Inc. by email legal@cyan.com
 
 #include "HeadSpin.h"
 #include "hsWindows.h"
+#include "hsDarwin.h"
 
 #include <string_theory/formatter>
 #include <string_theory/string>
diff --git a/Sources/Plasma/CoreLib/hsDarwin.h b/Sources/Plasma/CoreLib/hsDarwin.h
@@ -0,0 +1,114 @@
+/*==LICENSE==*
+
+CyanWorlds.com Engine - MMOG client, server and tools
+Copyright (C) 2011  Cyan Worlds, Inc.
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Additional permissions under GNU GPL version 3 section 7
+
+If you modify this Program, or any covered work, by linking or
+combining it with any of RAD Game Tools Bink SDK, Autodesk 3ds Max SDK,
+NVIDIA PhysX SDK, Microsoft DirectX SDK, OpenSSL library, Independent
+JPEG Group JPEG library, Microsoft Windows Media SDK, or Apple QuickTime SDK
+(or a modified version of those libraries),
+containing parts covered by the terms of the Bink SDK EULA, 3ds Max EULA,
+PhysX SDK EULA, DirectX SDK EULA, OpenSSL and SSLeay licenses, IJG
+JPEG Library README, Windows Media SDK EULA, or QuickTime SDK EULA, the
+licensors of this Program grant you additional
+permission to convey the resulting work. Corresponding Source for a
+non-source form of such a combination shall include the source code for
+the parts of OpenSSL and IJG JPEG Library used as well as that of the covered
+work.
+
+You can contact Cyan Worlds, Inc. by email legal@cyan.com
+ or by snail mail at:
+      Cyan Worlds, Inc.
+      14617 N Newport Hwy
+      Mead, WA   99021
+
+*==LICENSE==*/
+
+#ifndef _hsDarwin_inc_
+#define _hsDarwin_inc_
+
+#include <string_theory/string>
+#include <string_theory/format>
+
+#ifdef HS_BUILD_FOR_APPLE
+#include <CoreFoundation/CoreFoundation.h>
+
+[[nodiscard]]
+#if __has_feature(attribute_cf_returns_retained)
+__attribute__((cf_returns_retained))
+#endif
+inline CFStringRef CFStringCreateWithSTString(const ST::string& str)
+{
+    return CFStringCreateWithBytes(kCFAllocatorDefault, (const UInt8*)str.data(), str.size(), kCFStringEncodingUTF8, false);
+}
+
+inline ST::string STStringFromCFString(CFStringRef str, ST::utf_validation_t validation = ST_DEFAULT_VALIDATION)
+{
+    CFRange range = CFRangeMake(0, CFStringGetLength(str));
+    CFIndex strBufSz = 0;
+    CFStringGetBytes(str, range, kCFStringEncodingUTF8, 0, false, nullptr, 0, &strBufSz);
+    ST::char_buffer buffer;
+    buffer.allocate(strBufSz);
+    CFStringGetBytes(str, range, kCFStringEncodingUTF8, 0, false, (UInt8*)buffer.data(), strBufSz, nullptr);
+
+    return ST::string(buffer, validation);
+}
+
+inline void format_type(const ST::format_spec &format, ST::format_writer &output, CFStringRef str)
+{
+    ST::char_buffer utf8 = STStringFromCFString(str).to_utf8();
+    ST::format_string(format, output, utf8.data(), utf8.size());
+}
+
+
+#ifdef __OBJC__
+@class NSString;
+
+[[nodiscard]]
+#if __has_feature(attribute_ns_returns_retained)
+__attribute__((ns_returns_retained))
+#endif
+inline NSString* NSStringCreateWithSTString(const ST::string& str)
+{
+#if __has_feature(objc_arc)
+    return (NSString*)CFBridgingRelease(CFStringCreateWithSTString(str));
+#else
+    return (NSString*)CFStringCreateWithSTString(str);
+#endif
+}
+
+inline ST::string STStringFromNSString(NSString* str, ST::utf_validation_t validation = ST_DEFAULT_VALIDATION)
+{
+#if __has_feature(objc_arc)
+    return STStringFromCFString((__bridge CFStringRef)str, validation);
+#else
+    return STStringFromCFString((CFStringRef)str, validation);
+#endif
+}
+
+inline void format_type(const ST::format_spec &format, ST::format_writer &output, NSString* str)
+{
+    ST::char_buffer utf8 = STStringFromNSString(str).to_utf8();
+    ST::format_string(format, output, utf8.data(), utf8.size());
+}
+#endif // __OBJC__
+
+#endif // HS_BUILD_FOR_APPLE
+
+#endif // _hsDarwin_inc_
diff --git a/Sources/Plasma/CoreLib/hsSystemInfo.cpp b/Sources/Plasma/CoreLib/hsSystemInfo.cpp
@@ -46,6 +46,7 @@ You can contact Cyan Worlds, Inc. by email legal@cyan.com
 #include "plFileSystem.h"
 #include "hsStream.h"
 #include "hsWindows.h"
+#include "hsDarwin.h"
 
 #include <cstring>
 #include <iterator>
@@ -191,13 +192,7 @@ static inline bool IGetAppleVersion(ST::string& system)
         CFRelease(name);
         CFRelease(dict);
 
-        CFIndex infoLen = CFStringGetLength(info);
-        CFIndex infoBufSz = 0;
-        CFStringGetBytes(info, CFRangeMake(0, infoLen), kCFStringEncodingUTF8, 0, false, nullptr, 0, &infoBufSz);
-        ST::char_buffer systemBuf;
-        systemBuf.allocate(infoBufSz);
-        CFStringGetBytes(info, CFRangeMake(0, infoLen), kCFStringEncodingUTF8, 0, false, (UInt8*)systemBuf.data(), infoLen, nullptr);
-        system = ST::string(systemBuf);
+        system = STStringFromCFString(info);
 
         CFRelease(info);
 
diff --git a/Sources/Plasma/FeatureLib/pfPasswordStore/pfPasswordStore_Apple.cpp b/Sources/Plasma/FeatureLib/pfPasswordStore/pfPasswordStore_Apple.cpp
diff --git a/Sources/Plasma/PubUtilLib/plMessageBox/hsMessageBox_Mac.mm b/Sources/Plasma/PubUtilLib/plMessageBox/hsMessageBox_Mac.mm
diff --git a/Sources/Tests/CoreTests/CMakeLists.txt b/Sources/Tests/CoreTests/CMakeLists.txt
diff --git a/Sources/Tests/CoreTests/test_hsDarwin_CF.cpp b/Sources/Tests/CoreTests/test_hsDarwin_CF.cpp
diff --git a/Sources/Tests/CoreTests/test_hsDarwin_NS.mm b/Sources/Tests/CoreTests/test_hsDarwin_NS.mm

Original file line number	Diff line number	Diff line change
`@@ -40,24 +40,19 @@`
`40`	`40`
`41`	`41`	`==LICENSE==/`
`42`	`42`
`43`		`-#include "StringTheory_NSString.h"`
	`43`	`+#include "NSString+StringTheory.h"`
	`44`	`+#include "hsDarwin.h"`
`44`	`45`
`45`	`46`	`@implementation NSString (StringTheory)`
`46`	`47`
`47`		`-- (id)initWithSTString:(const ST::string&)string`
`48`		`-{`
`49`		`- self = [self initWithUTF8String:string.c_str()];`
`50`		`- return self;`
`51`		`-}`
`52`		`-`
`53`	`48`	`+ (id)stringWithSTString:(const ST::string&)string`
`54`	`49`	`{`
`55`		`- return [[NSString alloc] initWithSTString:string];`
	`50`	`+ return NSStringCreateWithSTString(string);`
`56`	`51`	`}`
`57`	`52`
`58`	`53`	`- (const ST::string)STString`
`59`	`54`	`{`
`60`		`- return ST::string([self UTF8String]);`
	`55`	`+ return STStringFromNSString(self);`
`61`	`56`	`}`
`62`	`57`
`63`	`58`	`@end`