Finalized cross platform support for build system.

MANIFEST.in

@@ -1,4 +1,8 @@
-recursive-include bookworm/resources/soundfiles *
-recursive-include bookworm/resources/non_breaking_prefixes *
+include bookworm/bookworm.ico
+recursive-include bookworm/resources/docs *.html *.txt
+recursive-include bookworm/resources/icons *.ico
+recursive-include bookworm/resources/non_breaking_prefixes *.txt
+recursive-include bookworm/resources/soundfiles *.wav
 recursive-include bookworm/resources/locale *.mo
 recursive-exclude tests *
+

bookworm/bookworm.py

@@ -3,36 +3,16 @@
 """Make sure that runtime components are OK and run the app."""
 
 import sys
-
-
-def check_runtime_components():
-    """
-    Make sure that critical runtime components are OK.
-    Raise EnvironmentError.
-    """
-    # TODO: Make sure that .NET Framework 4.0 or higher
-    # is available in the target system.
-    try:
-        # This is a basic sanity check
-        import clr
-        import System
-    except:
-        raise EnvironmentError
+from bookworm.platform_services import check_runtime_components
 
 
 def main():
     try:
         check_runtime_components()
-    except EnvironmentError:
+    except EnvironmentError as e:
         import wx
 
-        wx.SafeShowMessage(
-            "Unable To Start",
-            "Bookworm is unable to start because some key components are missing from your system.\n"
-            "Bookworm requires that the .NET Framework v4.0 or a later version is present in the target system.\n"
-            "Head over to the following link to download and install the .NET Framework v4.0:\n"
-            "https://www.microsoft.com/en-us/download/details.aspx?id=17718",
-        )
+        wx.SafeShowMessage("Unable To Start", e.args[0])
         sys.exit(1)
     try:
         from bookworm import bootstrap

bookworm/gui/book_viewer/menubar.py

@@ -557,9 +557,10 @@ def onRestartWithDebugMode(self, event):
         restart_application(debug=True)
 
     def onOpenDocumentation(self, event):
-        help_filename = f"bookworm.{'html' if app.is_frozen else 'md'}"
-        lang = app.current_language.given_lang
-        docs = paths.docs_path(lang, help_filename)
+        docs = paths.docs_path(
+            app.current_language.pylang,
+            "bookworm.html"
+        )
         wx.LaunchDefaultApplication(str(docs))
 
 

bookworm/i18n/core.py

@@ -62,13 +62,12 @@ def get_available_locales(force_update=False):
 def set_locale(locale_identifier):
     log.debug(f"Setting application locale to {locale_identifier}.")
     available_locales = tuple(get_available_locales().values())
-    localeinfo = LocaleInfo(locale_identifier)
-    if localeinfo not in available_locales:
-        localeinfo = (
-            localeinfo.parent
-            if localeinfo.parent in available_locales
-            else _AVAILABLE_LOCALES["default"]
-        )
+    if locale_identifier in _AVAILABLE_LOCALES:
+        localeinfo = _AVAILABLE_LOCALES[locale_identifier]
+    else:
+        localeinfo = _AVAILABLE_LOCALES["default"]
+        config.conf["general"]["language"] = "default"
+        config.save()
     lang = localeinfo.pylang
     try:
         translation = gettext.translation(

bookworm/ocr/ocr_gui.py

@@ -201,7 +201,7 @@ def _get_ocr_options(self, from_cache=True, **dlg_kw):
             saved_values = {}
             if pre_saved:
                 saved_values["lang"] = [
-                    l.given_lang for l in get_recognition_languages()
+                    l.pylang for l in get_recognition_languages()
                 ].index(pre_saved[0])
                 saved_values["zoom_factor"] = pre_saved[1]
                 saved_values["should_enhance"] = pre_saved[2]
@@ -237,7 +237,7 @@ def _get_ocr_options_from_dlg(self, saved_values=None, **dlg_kw):
         ocr_opts = dlg.ShowModal()
         if ocr_opts is not None:
             res = list(ocr_opts)
-            res[0] = langs[res[0]].given_lang
+            res[0] = langs[res[0]].pylang
             return res
 
     def onScanCurrentPage(self, event):

bookworm/paths.py

@@ -7,13 +7,13 @@
 from platform_utils import paths as path_finder
 from functools import wraps
 from bookworm import app
-from bookworm.runtime import IS_RUNNING_PORTABLE
+from bookworm.runtime import CURRENT_PACKAGING_MODE, PackagingMode
 
 
 log = logging.getLogger("bookworm.paths")
 
-
-DATA_PATH_DEBUG = Path(bookworm.__path__[0]).parent / ".appdata"
+# The appdata path when running from source
+DATA_PATH_SOURCE = Path.cwd() / ".appdata"
 
 
 def merge_paths(func):
@@ -26,21 +26,20 @@ def merge_paths_wrapper(*a):
 
 @merge_paths
 def data_path():
-    if not app.is_frozen:
-        data_path = DATA_PATH_DEBUG
+    if CURRENT_PACKAGING_MODE is PackagingMode.Installed:
+        data_path = Path(path_finder.app_data_path(app.name))
+    elif CURRENT_PACKAGING_MODE is PackagingMode.Portable:
+        data_path = app_path("user-config")
     else:
-        if IS_RUNNING_PORTABLE:
-            data_path = app_path("user-config")
-        else:
-            data_path = Path(path_finder.app_data_path(app.display_name))
+        data_path = DATA_PATH_SOURCE
     if not data_path.exists():
         data_path.mkdir(parents=True, exist_ok=True)
     return data_path
 
 
 @merge_paths
 def app_path():
-    if app.is_frozen:
+    if CURRENT_PACKAGING_MODE in (PackagingMode.Installed, PackagingMode.Portable):
         return Path(path_finder.app_path())
     else:
         import bookworm
@@ -68,9 +67,7 @@ def logs_path():
 
 @merge_paths
 def locale_path():
-    if app.is_frozen:
-        return app_path("resources", "locale")
-    return Path(app.__file__).parent / "resources" / "locale"
+    return app_path("resources", "locale")
 
 
 @merge_paths
@@ -84,25 +81,20 @@ def db_path():
 
 @merge_paths
 def docs_path():
-    if not app.is_frozen:
-        parent = Path(DATA_PATH_DEBUG).parent
-        path = parent / "docs" / "userguides"
-    else:
-        path = app_path("resources", "docs")
+    path = app_path("resources", "docs")
     if not path.exists():
         log.warning(f"Documentation files was not found in {path}. Folder not Found.")
     return path
 
 
 @merge_paths
 def home_data_path():
-    if app.is_frozen:
-        if IS_RUNNING_PORTABLE:
-            path = data_path(".saved_data")
-        else:
-            path = Path.home() / f".{app.name}"
+    if CURRENT_PACKAGING_MODE is PackagingMode.Installed:
+        path = Path.home() / f".{app.name}"
+    elif CURRENT_PACKAGING_MODE is PackagingMode.Portable:
+        path = data_path(".saved_data")
     else:
-        path = DATA_PATH_DEBUG / "home_data"
+        path = DATA_PATH_SOURCE / "home_data"
     if not path.exists():
         log.debug("%s path does not exist, creating..." % (path,))
         path.mkdir(parents=True, exist_ok=True)

bookworm/platform_services/__init__.py

@@ -3,3 +3,9 @@
 import sys
 
 PLATFORM = sys.platform
+
+
+if PLATFORM == 'win32':
+    from ._win32 import check_runtime_components
+else:
+    from ._linux import check_runtime_components

bookworm/platform_services/_win32/__init__.py

@@ -1 +1,21 @@
 # coding: utf-8
+
+
+def check_runtime_components():
+    """
+    Make sure that critical runtime components are OK.
+    Raise EnvironmentError.
+    """
+    # TODO: Make sure that .NET Framework 4.0 or higher
+    # is available in the target system.
+    try:
+        # This is a basic sanity check
+        import clr
+        import System
+    except:
+        raise EnvironmentError(
+            "Bookworm is unable to start because some key components are missing from your system.\n"
+            "Bookworm requires that the .NET Framework v4.0 or a later version is present in the target system.\n"
+            "Head over to the following link to download and install the .NET Framework v4.0:\n"
+            "https://www.microsoft.com/en-us/download/details.aspx?id=17718",
+        )