feat(native): add Locale module (#938)

* Add locale bindings on macOS

* Add Locale implementation on Linux

* Add locale implementation on Windows

* Add locale to Environment

* Add a CAMLlocal to return

* Add missing newline to format script

* Free Windows pointer

* Add test

* Fix tests

* Fix freeing based on platform

.ci/format.sh

@@ -19,7 +19,7 @@ fi
 
 if [[ $native_output ]]
 then
-    printf "\nFormatted the following native stubs:\n%s" "$native_output"
+    printf "\nFormatted the following native stubs:\n%s\n" "$native_output"
 fi
 
 if [[ $caml_output != 0 ]] || [[ $native_output != "" ]]

src/Core/App.re

@@ -255,6 +255,8 @@ let start = init => {
 
   Revery_Native.initApp();
 
+  AppLog.infof(m => m("Operating in locale : %s", Environment.userLocale));
+
   let appLoop = () => {
     _flushEvents();
 

src/Core/Environment.re

@@ -105,3 +105,6 @@ let getAssetPath = p => {
 let getWorkingDirectory = () => Sys.getcwd();
 
 let getTempDirectory = () => Filename.get_temp_dir_name();
+
+let getUserLocale = () => Revery_Native.Locale.getUser();
+let userLocale = getUserLocale();

src/Core/Environment.rei

@@ -54,3 +54,10 @@ type os =
   | Unknown;
 
 let os: os;
+
+/**
+[getUserLocale] returns the current user locale. Note that on some platforms
+(including macOS) the locale can change during runtime
+*/
+let getUserLocale: unit => string;
+let userLocale: string;

src/Native/Locale.re

@@ -0,0 +1 @@
+external getUser: unit => string = "revery_getUserLocale";

src/Native/ReveryCocoa.h

@@ -12,7 +12,7 @@ void revery_scheduleNotificationFromNow_cocoa(const char *title,
         const char *body,
         long onClickFunc, int mute,
         int seconds);
-void* revery_getIconHandle_cocoa();
+void *revery_getIconHandle_cocoa();
 
 /* Icon progress bar functions */
 void revery_setIconProgress_cocoa(void* dt, double progress);
@@ -22,3 +22,6 @@ void revery_hideIconProgress_cocoa(void* ip);
 /* Open functions */
 int revery_openURL_cocoa(const char *url_string);
 int revery_openFile_cocoa(const char *path_string);
+
+/* Locale functions */
+char *revery_getUserLocale_cocoa();

src/Native/ReveryWin32.h

@@ -4,3 +4,4 @@ void revery_setIconProgress_win32(void *win, void *ih, float progress);
 void revery_setIconProgressIndeterminate_win32(void *win, void *ih);
 void revery_hideIconProgress_win32(void *win, void *ih);
 int revery_openURL_win32(const char *url_string);
+char *revery_getUserLocale_win32();

src/Native/Revery_Native.re

@@ -2,5 +2,6 @@ module Dialog = Dialog;
 module Icon = Icon;
 module Notification = Notification;
 module Shell = Shell;
+module Locale = Locale;
 
 include Initialization;

src/Native/dune

@@ -10,6 +10,7 @@
         notification notification_cocoa
         icon icon_cocoa icon_win32
         shell shell_cocoa shell_gtk shell_win32
+        locale locale_cocoa locale_win32
         utilities
         ReveryAppDelegate ReveryAppDelegate_func
         ReveryProgressBar)

src/Native/icon_win32.c

@@ -31,4 +31,4 @@ void revery_hideIconProgress_win32(void *win, void *ih) {
     iconHandle->lpVtbl->SetProgressState(iconHandle, window, TBPF_NOPROGRESS);
 }
 
-#endif
+#endif

src/Native/locale.c

@@ -0,0 +1,41 @@
+#include <stdio.h>
+
+#include <caml/alloc.h>
+#include <caml/callback.h>
+#include <caml/memory.h>
+#include <caml/mlvalues.h>
+#include <string.h>
+
+#include "caml_values.h"
+
+#ifdef WIN32
+#include "ReveryWin32.h"
+#elif __APPLE__
+#include "ReveryCocoa.h"
+#else
+#include "ReveryGtk.h"
+#include <locale.h>
+#endif
+
+CAMLprim value revery_getUserLocale() {
+    CAMLparam0();
+    CAMLlocal1(camlRet);
+    char *ret;
+    int shouldFree;
+#ifdef __APPLE__
+    ret = revery_getUserLocale_cocoa();
+    shouldFree = 0;
+#elif WIN32
+    ret = revery_getUserLocale_win32();
+    shouldFree = 1;
+#else
+    setlocale(LC_CTYPE, "");
+    ret = setlocale(LC_CTYPE, NULL);
+    shouldFree = 0;
+#endif
+    camlRet = caml_copy_string(ret);
+    if (shouldFree) {
+        free(ret);
+    }
+    CAMLreturn(camlRet);
+}

src/Native/locale_cocoa.c

@@ -0,0 +1,10 @@
+#ifdef __APPLE__
+#include <stdio.h>
+
+#import <Cocoa/Cocoa.h>
+
+char *revery_getUserLocale_cocoa() {
+    NSLocale *nsLocale = [NSLocale currentLocale];
+    return (char *)[[nsLocale localeIdentifier] UTF8String];
+}
+#endif

src/Native/locale_win32.c

@@ -0,0 +1,18 @@
+#ifdef _WIN32
+
+#include "win32_target.h"
+
+#include <windows.h>
+#include <stdlib.h>
+
+char *revery_getUserLocale_win32() {
+    WCHAR locale[LOCALE_NAME_MAX_LENGTH];
+    char *localeStr = malloc(LOCALE_NAME_MAX_LENGTH * sizeof(char));
+
+    GetUserDefaultLocaleName(locale, LOCALE_NAME_MAX_LENGTH);
+
+    wcstombs(localeStr, locale, sizeof(localeStr));
+    return localeStr;
+}
+
+#endif

src/Native/win32_target.h

@@ -0,0 +1,2 @@
+#define WINVER 0x0601
+#define _WIN32_WINNT 0x0601

test/Core/EnvironmentTests.re

@@ -2,7 +2,7 @@ open Revery_Core;
 
 open TestFramework;
 
-describe("Environment", ({test, _}) =>
+describe("Environment", ({test, _}) => {
   test("executingDirectory", _ =>
     test(
       "validate we can load a file adjacent to the executable", ({expect, _}) => {
@@ -11,5 +11,8 @@ describe("Environment", ({test, _}) =>
       ).
         toBeTrue()
     })
-  )
-);
+  );
+  test("userLocale", ({expect, _}) => {
+    expect.equal(~equals=(!=), Environment.userLocale, "")
+  });
+});