pyalamake 2.3.0__tar.gz → 2.3.2__tar.gz

{pyalamake-2.3.0/src/pyalamake.egg-info → pyalamake-2.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyalamake
-Version: 2.3.0
+Version: 2.3.2
 Summary: python module to generate Makefiles for arduino, GTest, C/C++, etc.
 Author-email: "J. Arrizza" <cppgent0@gmail.com>
 Maintainer-email: "J. Arrizza" <cppgent0@gmail.com>

{pyalamake-2.3.0 → pyalamake-2.3.2}/pyproject.toml

@@ -19,7 +19,7 @@ dependencies = [
 
 # common values
 name = 'pyalamake'
-version = '2.3.0'
+version = '2.3.2'
 requires-python = '>=3.9'
 authors = [{ name = 'J. Arrizza', email = 'cppgent0@gmail.com' }]
 maintainers = [

{pyalamake-2.3.0 → pyalamake-2.3.2}/src/pyalamake/constants_version.py

@@ -6,4 +6,4 @@ from dataclasses import dataclass
 @dataclass
 class ConstantsVersion:
     ## current App version
-    version = '2.3.0'
+    version = '2.3.2'

{pyalamake-2.3.0 → pyalamake-2.3.2}/src/pyalamake/osal.py

@@ -7,47 +7,11 @@ from .svc import svc
 
 # --------------------
 ## Operating System Abstraction Layer; provides functions to make cross-platform behavior similar
-class Osal:
-    # --------------------
-    ## check if a path to a file exists
-    # note: use this function instead of os.path.isfile otherwise it may fail on windows/msys2
-    #
-    # @param path   the path to fix
-    # @return the fixed path
-    @classmethod
-    def isfile(cls, path):
-        path = cls._unfix_path(path)
-        return os.path.isfile(path)
+class _MetaOsal(type):  # pylint: disable=too-many-public-methods
+    ## prefix for paths with home in them
+    _home = os.path.expanduser('~')
 
-    # --------------------
-    ## check if a path exists
-    # note: use this function instead of os.path.isdir otherwise it may fail on windows/msys2
-    #
-    # @param path   the path to fix
-    # @return the fixed path
-    @classmethod
-    def isdir(cls, path):
-        path = cls._unfix_path(path)
-        return os.path.isdir(path)
-
-    # --------------------
-    ## (deprecated) unfix a path
-    # @param path the path to unfix
-    # @return the unfixed path
-    @classmethod
-    def _unfix_path(cls, path):
-        path = os.path.expanduser(path)
-        path = svc.gbl.mf_variables.unfix_path(path)
-        if svc.gbl.os_name == 'win':
-            # assumes there is only one character and it is for a drive letter
-            # can only be done at the start of the path
-            m = re.search(r'^/(.)/(.*)', path)
-            if m:
-                drive = m.group(1).lower()
-                path = f'{drive}:/{m.group(2)}'
-        path = path.replace('\\', '/')
-        path = path.replace('//', '/')
-        return path
+    # === homebrew related
 
     # --------------------
     ## get the homebrew link libraries root directory
@@ -71,6 +35,8 @@ class Osal:
             # '/opt/homebrew/include',
         ]
 
+    # === C/C++ related
+
     # --------------------
     ## get C++ compiler per OS
     # @return C++ compiler
@@ -93,6 +59,8 @@ class Osal:
             comp = 'gcc'
         return svc.gbl.mf_variables.set_get('PAM_GCC', comp)
 
+    # === arduino related
+
     # --------------------
     ## get the root of the arduino cores, tools, etc.
     #
@@ -182,6 +150,8 @@ class Osal:
         # do not fix_path()
         return path
 
+    # === gtest related
+
     # --------------------
     ## return default gtest include directories
     #
@@ -211,6 +181,63 @@ class Osal:
         # do not fix_path()
         return dirs
 
+    # === python related
+
+    # --------------------
+    ## return default python include directories
+    #
+    # @return the list of include directories
+    @classmethod
+    def python_includes(cls):
+        import sysconfig
+
+        incs = [sysconfig.get_path('include')]
+        # do not fix_path()
+        return incs
+
+    # --------------------
+    ## return default link libraries needed for ruby
+    #
+    # @return the list of link libraries
+    @classmethod
+    def python_link_libs(cls):
+        import sysconfig
+
+        if svc.gbl.os_name == 'win':
+            libs = [sysconfig.get_config_var('installed_base'), 'c:/msys64/mingw64/lib']
+        else:
+            libs = [sysconfig.get_config_var('LIBDIR')]
+        # print(f"platlibdir    : {sysconfig.get_config_var('platlibdir')}")
+        # print(f"installed_base: {sysconfig.get_config_var('installed_base')}")
+        # print(f"platbase      : {sysconfig.get_config_var('platbase')}")
+        # libs = [sysconfig.get_config_var('prefix')]
+
+        # do not fix_path()
+        return libs
+
+    # --------------------
+    ## default include path(s) for python when installed using vfox
+    @property
+    def vfox_python_includes(cls):
+        return [f'{cls._home}/.vfox/cache/python/v-3.12.3/python-3.12.3/include/python3.12']
+
+    # --------------------
+    ## default library path(s) for python when installed using vfox
+    @property
+    def vfox_python_link_dirs(cls):
+        return [f'{cls._home}/.vfox/cache/python/v-3.12.3/python-3.12.3/lib']
+
+    # --------------------
+    ## default libraries for python when installed using vfox
+    # ubuntu: not used
+    # macos : needed
+    # win   : TODO
+    @property
+    def vfox_python_libs(cls):
+        return 'python3.12'
+
+    # === ruby related
+
     # --------------------
     ## return default ruby include directories
     #
@@ -308,36 +335,76 @@ class Osal:
         return libs
 
     # --------------------
-    ## return default python include directories
-    #
-    # @return the list of include directories
-    @classmethod
-    def python_includes(cls):
-        import sysconfig
+    ## default include path(s) for ruby when installed using vfox
+    @property
+    def vfox_ruby_includes(cls):
+        incs = []
+        # these must be first:
+        if svc.gbl.os_name == 'ubuntu':
+            incs.append(f'{cls._home}/.vfox/cache/ruby/v-3.4.5/ruby-3.4.5/include/ruby-3.4.0/x86_64-linux')
+        elif svc.gbl.os_name == 'macos':
+            incs.append(f'{cls._home}/.vfox/cache/ruby/v-3.4.5/ruby-3.4.5/include/ruby-3.4.0/arm64-darwin20')
 
-        incs = [sysconfig.get_path('include')]
-        # do not fix_path()
+        incs.append(f'{cls._home}/.vfox/cache/ruby/v-3.4.5/ruby-3.4.5/include/ruby-3.4.0')
         return incs
 
     # --------------------
-    ## return default link libraries needed for ruby
+    ## default library path(s) for ruby when installed using vfox
+    @property
+    def vfox_ruby_link_dirs(cls):
+        return [f'{cls._home}/.vfox/cache/ruby/v-3.4.5/ruby-3.4.5/lib']
+
+    # --------------------
+    ## default libraries for ruby when installed using vfox
+    # ubuntu: not used
+    # macos : needed
+    # win   : TODO
+    @property
+    def vfox_ruby_libs(cls):
+        return 'ruby.3.4-static'
+
+    # === nodejs related
+
+    # --------------------
+    ## default library path(s) for nodejs when installed using vfox
+    @property
+    def vfox_nodejs_includes(cls):
+        return [
+            f'{cls._home}/.vfox/cache/nodejs/v-21.5.0/nodejs-21.5.0/include/node',
+        ]
+
+    # --------------------
+    ## default libraries for ruby when installed using vfox
+    # ubuntu: not used
+    # macos : needed
+    # win   : TODO
+    @property
+    def vfox_nodejs_libs(cls):
+        return 'ruby.3.4-static'
+
+    # === utility functions
+
+    # --------------------
+    ## check if a path to a file exists
+    # note: use this function instead of os.path.isfile otherwise it may fail on windows/msys2
     #
-    # @return the list of link libraries
+    # @param path   the path to fix
+    # @return the fixed path
     @classmethod
-    def python_link_libs(cls):
-        import sysconfig
-
-        if svc.gbl.os_name == 'win':
-            libs = [sysconfig.get_config_var('installed_base'), 'c:/msys64/mingw64/lib']
-        else:
-            libs = [sysconfig.get_config_var('LIBDIR')]
-        # print(f"platlibdir    : {sysconfig.get_config_var('platlibdir')}")
-        # print(f"installed_base: {sysconfig.get_config_var('installed_base')}")
-        # print(f"platbase      : {sysconfig.get_config_var('platbase')}")
-        # libs = [sysconfig.get_config_var('prefix')]
+    def isfile(cls, path):
+        path = cls._unfix_path(path)
+        return os.path.isfile(path)
 
-        # do not fix_path()
-        return libs
+    # --------------------
+    ## check if a path exists
+    # note: use this function instead of os.path.isdir otherwise it may fail on windows/msys2
+    #
+    # @param path   the path to fix
+    # @return the fixed path
+    @classmethod
+    def isdir(cls, path):
+        path = cls._unfix_path(path)
+        return os.path.isdir(path)
 
     # --------------------
     ## run a command
@@ -353,3 +420,28 @@ class Osal:
         )  # Raise error for non-zero exit codes
         # print(f'@@@ osal.run_cmd rc={result.returncode} stdout: {result.stdout.strip()}')
         return result.returncode, result.stdout.strip()
+
+    # --------------------
+    ## unfix a path
+    # @param path the path to unfix
+    # @return the unfixed path
+    @classmethod
+    def _unfix_path(cls, path):
+        path = os.path.expanduser(path)
+        path = svc.gbl.mf_variables.unfix_path(path)
+        if svc.gbl.os_name == 'win':
+            # assumes there is only one character and it is for a drive letter
+            # can only be done at the start of the path
+            m = re.search(r'^/(.)/(.*)', path)
+            if m:
+                drive = m.group(1).lower()
+                path = f'{drive}:/{m.group(2)}'
+        path = path.replace('\\', '/')
+        path = path.replace('//', '/')
+        return path
+
+
+# --------------------
+## public metaclass for Osal
+class Osal(metaclass=_MetaOsal):  # pylint: disable=too-few-public-methods
+    pass

pyalamake-2.3.2/src/pyalamake/package_opengl.py

@@ -0,0 +1,49 @@
+from dataclasses import dataclass
+
+from .svc import svc
+
+
+# --------------------
+## info for the OpenGL package
+class PackageOpengl:
+    # --------------------
+    ## return info about the pkgname
+    #
+    # @param pkgname  the name of the package; default: opengl
+    # @return ref to OpenGl info
+    def find(self, pkgname):
+        svc.log.line(f'finding package: {pkgname}')
+
+        if svc.gbl.os_name == 'ubuntu':
+            #
+            @dataclass
+            class OpenGl:
+                include_dir = '/usr/include'
+                link_libs = ['glut', 'GLU', 'GL']
+                link_dir = []  # not needed
+                link_options = []  # not needed
+
+        elif svc.gbl.os_name == 'macos':
+            # TODO use this for include_dir: brew --prefix freeglut
+            @dataclass
+            class OpenGl:
+                include_dir = []
+                link_libs = []
+                link_dir = []
+                link_options = [
+                    '-framework GLUT',
+                    '-framework OpenGL',
+                ]
+
+        else:
+
+            @dataclass
+            class OpenGl:
+                pass
+                # TODO: set up for win/msys2
+                # include_dir = []
+                # link_libs = []
+                # link_dir = []
+                # link_options = []
+
+        return OpenGl

{pyalamake-2.3.0 → pyalamake-2.3.2}/src/pyalamake/target_arduino.py

@@ -78,16 +78,99 @@ class TargetArduino(TargetBase):
     # @param lib  the library to add
     # @return None
     def add_library(self, lib):
-        if lib == 'Servo':
-            svc.log.line(f'adding arduino library: {lib}')
-            path = PathHandle(f'{self._shared.library_root}/Servo/src')
-            self._check_library_installed(path, lib)
-            self.add_sources(f'{path.fixed}/avr/Servo.cpp')  # pylint: disable=E1101
-            self.add_include_directories(path.fixed)  # pylint: disable=E1101
-            self.add_compile_options('-DARDUINO_ARCH_AVR')  # pylint: disable=E1101
-        else:
+        # TODO use these:
+        # libraries:  arduino-cli lib list "Adafruit Motor Shield V2 Library" --format json
+        # packages :  arduino-cli lib list "Wire" -b arduino:avr:uno --format json
+        # dependcies: arduino-cli lib deps "Adafruit Motor Shield V2 Library"
+
+        valid_libs = {
+            'Servo': self._add_lib_servo,
+            'AdafruitMotorShieldV2': self._add_lib_motorshield_v2,
+            'AdafruitBusIO': self._add_lib_busio,
+            # packages
+            'Wire': self._add_pkg_wire,
+            'SPI': self._add_pkg_spi,
+        }
+        if lib not in valid_libs:
             svc.abort(f'{self.target} target_arduino: unknown arduino library: {lib}')
 
+        svc.log.line(f'adding arduino library: {lib}')
+        valid_libs[lib](lib)
+
+        self.add_compile_options('-DARDUINO_ARCH_AVR')  # pylint: disable=E1101
+
+    # --------------------
+    ## add Servo files
+    # @param lib  the library to add
+    # @return None
+    def _add_lib_servo(self, lib):
+        path = PathHandle(f'{self._shared.library_root}/Servo/src')
+        self._check_library_installed(path, lib)
+        self.add_sources(f'{path.fixed}/avr/Servo.cpp')  # pylint: disable=E1101
+        self.add_include_directories(path.fixed)  # pylint: disable=E1101
+
+    # --------------------
+    ## add Adafruit Motor Shield V2 files
+    # @param lib  the library to add
+    # @return None
+    def _add_lib_motorshield_v2(self, lib):
+        path = PathHandle(f'{self._shared.library_root}/Adafruit_Motor_Shield_V2_Library')
+        self._check_library_installed(path, lib)
+        self.add_sources(
+            [
+                f'{path.fixed}/Adafruit_MotorShield.cpp',
+                f'{path.fixed}/utility/Adafruit_MS_PWMServoDriver.cpp',
+            ]
+        )  # pylint: disable=E1101
+        self.add_include_directories(
+            [
+                path.fixed,
+                f'{path.fixed}/utility',
+            ]
+        )  # pylint: disable=E1101
+
+    # --------------------
+    ## add Adafruit Bus IO files
+    # @param lib  the library to add
+    # @return None
+    def _add_lib_busio(self, lib):
+        path = PathHandle(f'{self._shared.library_root}/Adafruit_BusIO')
+        self._check_library_installed(path, lib)
+        self.add_sources(
+            [
+                f'{path.fixed}/Adafruit_BusIO_Register.cpp',
+                f'{path.fixed}/Adafruit_GenericDevice.cpp',
+                f'{path.fixed}/Adafruit_I2CDevice.cpp',
+                f'{path.fixed}/Adafruit_SPIDevice.cpp',
+            ]
+        )  # pylint: disable=E1101
+        self.add_include_directories(path.fixed)  # pylint: disable=E1101
+
+    # --------------------
+    ## add Wire package files
+    # @param _lib  unused
+    # @return None
+    def _add_pkg_wire(self, _lib):
+        path = PathHandle(f'{svc.osal.arduino_root_dir()}/packages/arduino/hardware/avr/1.8.7/libraries/Wire/src')
+        # built-in package, no installation
+        self.add_sources(
+            [
+                f'{path.fixed}/Wire.cpp',
+                f'{path.fixed}/utility/twi.c',
+            ]
+        )
+        self.add_include_directories([path.fixed, f'{path.fixed}/utility'])  # pylint: disable=E1101
+
+    # --------------------
+    ## add SPI package files
+    # @param _lib  unused
+    # @return None
+    def _add_pkg_spi(self, _lib):
+        path = PathHandle(f'{svc.osal.arduino_root_dir()}/packages/arduino/hardware/avr/1.8.7/libraries/SPI/src')
+        # built-in package, no installation
+        self.add_sources(f'{path.fixed}/SPI.cpp')
+        self.add_include_directories(path.fixed)  # pylint: disable=E1101
+
     # --------------------
     ## check if an arduino library is installed
     #

{pyalamake-2.3.0 → pyalamake-2.3.2/src/pyalamake.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyalamake
-Version: 2.3.0
+Version: 2.3.2
 Summary: python module to generate Makefiles for arduino, GTest, C/C++, etc.
 Author-email: "J. Arrizza" <cppgent0@gmail.com>
 Maintainer-email: "J. Arrizza" <cppgent0@gmail.com>

pyalamake-2.3.0/src/pyalamake/package_opengl.py

@@ -1,23 +0,0 @@
-from dataclasses import dataclass
-
-from .svc import svc
-
-
-# --------------------
-## info for the OpenGL package
-class PackageOpengl:
-    # --------------------
-    ## return info about the pkgname
-    #
-    # @param pkgname  the name of the package; default: opengl
-    # @return ref to OpenGl info
-    def find(self, pkgname):
-        # TODO: check if this works on macos & win/msys2
-        svc.log.line(f'finding package: {pkgname}')
-
-        @dataclass
-        class OpenGl:
-            include_dir = '/usr/include'
-            link_libs = ['glut', 'GLU', 'GL']
-
-        return OpenGl