Add i18n support

.github/workflows/ci.yml

@@ -1,15 +1,15 @@
 name: Abaddon CI
 
-on: [ push, pull_request ]
+on: [push, pull_request]
 
 jobs:
   msys2:
     name: msys2-mingw64
     runs-on: windows-latest
     strategy:
       matrix:
-        buildtype: [ Debug, RelWithDebInfo, MinSizeRel ]
-        mindeps: [ false ]
+        buildtype: [Debug, RelWithDebInfo, MinSizeRel]
+        mindeps: [false]
         include:
           - buildtype: RelWithDebInfo
             mindeps: true
@@ -84,6 +84,7 @@ jobs:
           mkdir -p ${artifact_dir}/bin ${artifact_dir}/etc/ssl/certs ${artifact_dir}/lib ${artifact_dir}/share/glib-2.0/schemas
           cd build
           cp *.exe ../${artifact_dir}/bin
+          cp -r ./locale/ ../${artifact_dir}/bin
           cd ..
           cp /mingw64/etc/ssl/certs/ca-bundle.crt ${artifact_dir}/etc/ssl/certs
           cp -r /mingw64/lib/gdk-pixbuf-2.0 ${artifact_dir}/lib
@@ -132,7 +133,7 @@ jobs:
     runs-on: macos-latest
     strategy:
       matrix:
-        buildtype: [ Debug, RelWithDebInfo ]
+        buildtype: [Debug, RelWithDebInfo]
     steps:
       - uses: actions/checkout@v1
         with:
@@ -177,7 +178,7 @@ jobs:
     runs-on: ubuntu-22.04
     strategy:
       matrix:
-        buildtype: [ Debug, RelWithDebInfo, MinSizeRel ]
+        buildtype: [Debug, RelWithDebInfo, MinSizeRel]
     steps:
       - uses: actions/checkout@v1
         with:
@@ -199,6 +200,7 @@ jobs:
           cmake ..
           make
           sudo make install
+          sudo apt-get install gettext
           sudo apt-get install libgtkmm-3.0-dev
           sudo apt-get install libcurl4-gnutls-dev
           sudo apt-get install libopus-dev
@@ -221,6 +223,7 @@ jobs:
           artifact_dir=${{ runner.workspace }}/artifactdir/abaddon-${{ matrix.buildtype }}-${GITHUB_SHA::7}
           mkdir -p "${artifact_dir}"
           cp "${{runner.workspace}}/build/abaddon" "${artifact_dir}/abaddon"
+          cp -r "${{runner.workspace}}/build/locale" "${artifact_dir}/locale"
           cp -r "${{ github.workspace }}/res/css" "${artifact_dir}/css"
           cp -r "${{ github.workspace }}/res/res" "${artifact_dir}/res"
 

CMakeLists.txt

@@ -19,6 +19,7 @@ find_package(CURL)
 find_package(ZLIB REQUIRED)
 find_package(SQLite3 REQUIRED)
 find_package(gtkmm REQUIRED)
+find_package(Intl REQUIRED)
 
 set(USE_TLS TRUE)
 set(USE_OPEN_SSL TRUE)
@@ -56,6 +57,9 @@ target_include_directories(abaddon PUBLIC ${GTKMM_INCLUDE_DIRS})
 target_include_directories(abaddon PUBLIC ${ZLIB_INCLUDE_DIRS})
 target_include_directories(abaddon PUBLIC ${SQLite3_INCLUDE_DIRS})
 target_include_directories(abaddon PUBLIC ${NLOHMANN_JSON_INCLUDE_DIRS})
+target_include_directories(abaddon PUBLIC ${Intl_INCLUDE_DIRS})
+
+add_subdirectory(po)
 
 if (ENABLE_QRCODE_LOGIN)
     add_library(qrcodegen subprojects/qrcodegen/cpp/qrcodegen.hpp subprojects/qrcodegen/cpp/qrcodegen.cpp)
@@ -119,6 +123,10 @@ target_link_libraries(abaddon ${ZLIB_LIBRARY})
 target_link_libraries(abaddon ${NLOHMANN_JSON_LIBRARIES})
 target_link_libraries(abaddon ${CMAKE_DL_LIBS})
 
+if (MINGW OR APPLE)
+    target_link_libraries(abaddon ${Intl_LIBRARIES})
+endif()
+
 target_link_libraries(abaddon CURL::libcurl)
 
 include(CheckAtomic)

po/CMakeLists.txt

@@ -0,0 +1,37 @@
+find_program(MSGMERGE msgmerge REQUIRED)
+find_program(MSGFMT msgfmt REQUIRED)
+
+set(POT_FILENAME ${CMAKE_CURRENT_SOURCE_DIR}/abaddon.pot)
+set(MO_FILENAME abaddon.mo)
+set(LOCALE_DIRECTORY ${PROJECT_BINARY_DIR}/locale)
+
+list(APPEND PO_NAMES pt_BR)
+
+foreach(PO_NAME IN LISTS PO_NAMES)
+	list(APPEND PO_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/${PO_NAME}.po)
+endforeach()
+
+# Updates all the translation
+foreach(PO_SOURCE PO_NAME IN ZIP_LISTS PO_SOURCES PO_NAMES)
+    add_custom_target("update-${PO_NAME}" DEPENDS ${PO_SOURCE})
+    add_custom_command(
+        TARGET "update-${PO_NAME}" PRE_BUILD
+        COMMAND ${MSGMERGE} -U -N ${PO_SOURCE} ${POT_FILENAME}
+        DEPENDS ${POT_FILENAME}
+    )
+    add_dependencies(abaddon "update-${PO_NAME}")
+endforeach()
+
+# Compiles all the translation files onto locales directory
+foreach(PO_SOURCE PO_NAME IN ZIP_LISTS PO_SOURCES PO_NAMES)
+    file(MAKE_DIRECTORY ${LOCALE_DIRECTORY}/${PO_NAME}/LC_MESSAGES/)
+    add_custom_command(
+        OUTPUT ${LOCALE_DIRECTORY}/${PO_NAME}/LC_MESSAGES/${MO_FILENAME}
+        COMMAND ${MSGFMT} --output-file=${LOCALE_DIRECTORY}/${PO_NAME}/LC_MESSAGES/${MO_FILENAME}
+                      ${PO_SOURCE}
+        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+        DEPENDS ${PO_SOURCE}
+    )
+    add_custom_target("compile-${PO_NAME}" DEPENDS ${LOCALE_DIRECTORY}/${PO_NAME}/LC_MESSAGES/${MO_FILENAME})
+    add_dependencies(abaddon "compile-${PO_NAME}")
+endforeach()

po/POTFILES

@@ -0,0 +1,34 @@
+src/abaddon.cpp
+src/startup.cpp
+src/discord/permissions.cpp
+src/dialogs/confirm.cpp
+src/dialogs/friendpicker.cpp
+src/dialogs/setstatus.cpp
+src/dialogs/textinput.cpp
+src/dialogs/token.cpp
+src/dialogs/verificationgate.cpp
+src/components/chatinput.cpp
+src/components/chatinputindicator.cpp
+src/components/chatlist.cpp
+src/components/chatmessage.cpp
+src/components/chatwindow.cpp
+src/components/friendslist.cpp
+src/components/ratelimitindicator.cpp
+src/components/voiceinfobox.cpp
+src/components/channellist/channellisttree.cpp
+src/windows/guildsettingswindow.cpp
+src/windows/mainwindow.cpp
+src/windows/pinnedwindow.cpp
+src/windows/profilewindow.cpp
+src/windows/threadswindow.cpp
+src/windows/voicesettingswindow.cpp
+src/windows/profile/mutualguildspane.cpp
+src/windows/profile/userinfopane.cpp
+src/windows/guildsettings/auditlogpane.cpp
+src/windows/guildsettings/banspane.cpp
+src/windows/guildsettings/emojispane.cpp
+src/windows/guildsettings/infopane.cpp
+src/windows/guildsettings/invitespane.cpp
+src/windows/guildsettings/memberspane.cpp
+src/windows/guildsettings/rolespane.cpp
+src/windows/voice/voicewindow.cpp

po/TRANSLATING.md

@@ -0,0 +1,68 @@
+# Working with translations
+
+Translators must first ensure that the tools coming with the gettext package are
+installed. If that's not the case install it using your package manager.
+
+```sh
+# On Debian/Ubuntu systems. Use your package manager
+sudo apt install gettext
+```
+
+## Adding new translation files
+
+Adding new translation files is as easy as issuing a command. In the command
+below, replace `LL_CC` for the country code you are translating the project to
+and set an appropriate encoding to the country code.
+
+```sh
+msginit -i po/abaddon.pot -o po/LL_CC.po --locale LL_CC[.ENCODING]
+```
+
+After that, you'll have to append the country code to `PO_NAMES` variable in
+[CMakeLists.txt](CMakeLists.txt), build file responsible for compiling and
+updating the translations.
+
+```cmake
+# Insert the country code in alphabetical order.
+# Replace LL_CC for the country code
+list(APPEND PO_NAMES pt_BR LL_CC)
+```
+
+Then, compile the translation file by simply issuing the build command within
+the build directory. Doing this won't only compile but it'll also update the .po
+file in case there is any modification made to abaddon.pot.
+
+```sh
+cmake --build build-dir/
+```
+
+To ensure that everything is in place, run the program with `LANGUAGE`
+environment variable set to the country code you are providing a translation
+for:
+
+```sh
+# This snippet assumes that the current directory is the build directory
+LANGUAGE=pt_BR ./abaddon
+```
+
+## Adding new strings to be translated
+
+When expanding the software, there might be some text that will be shown to
+the user (this does not include log messages as these are meant to be read
+by any developer) that needs to be translated as well. Marking a string for
+translation is as easy as closing the target string with `_(<your_string>)`.
+It may look like this
+
+```cpp
+some_label->set_text(_("I will appear in the user's native language"))
+```
+
+Make sure that the file where the marked strings are is registered in the
+**POTFILES** file, so the main pot file can be updated by calling gettext
+functions. After that, the main .pot file has to be updated so the
+remaining translation files can be synchronised with the new strings.
+
+```sh
+    xgettext -f po/POTFILES -o po/abaddon.pot --from-code=UTF-8 --keyword=_
+    cmake --build build_dir/
+```