Merge pull request #36 from FlachyJoe/dev

v 0.4.0

Author: FlachyJoe

InitGui.py

@@ -48,6 +48,7 @@ def Initialize(self):
 
         self.commandList = [
             "FCPD_Launch",
+            "FCPD_Stop",
             "FCPD_AddInclude",
             "FCPD_AddPopulatedInclude",
         ]
@@ -68,5 +69,8 @@ def ContextMenu(self, recipient):
     def GetClassName(self):
         return "Gui::PythonWorkbench"
 
+    def __del__(self):
+        self.statusWidget.deleteLater()
+
 
 Gui.addWorkbench(FCPDWorkbench())

README.md

@@ -42,19 +42,30 @@ Please see [FCPDWorkbench_Samples](https://github.com/FlachyJoe/FCPDWorkbench_Sa
 
 ## Requirements
 
-The PySide2 (or PySide6) Python bindings for Qt5 (or Qt6) Network is required. Linux users can install python3-pyside2.qtnetwork (or python3-pyside6.qtnetwork) package.
-
-External libraries are needed for Pure-Data :
+These external Pure-Data libraries are mandatory:
 * [list-abs](https://puredata.info/downloads/list-abs)
 * [iemlib](https://puredata.info/downloads/iemlib)
+* [iemguts](https://puredata.info/downloads/iemguts)
+
+These external Pure-Data libraries are optional:
+* [pddp](https://puredata.info/downloads/pddp) used in documentation only
+
+
+See Pure-Data documentation to install them with the Deken package system\
+**OR** install a system package from your distribution repository\
+**OR** use an already populated Pure-Data clone as [Purr-Data](http://l2ork.music.vt.edu/main/make-your-own-l2ork/software/) or [PlugData](https://plugdata.org/).
+
+These python libraries are optional:
+* [ikpy](https://github.com/Phylliade/ikpy) for inverse kinematic features
 
-See Pure-Data documentation to install them with the Deken package system
-or install a system package from your distribution repository (e.g. `sudo apt install pd-list-abs pd-iemlib`)
-or use an already populated Pure-Data clone as [Purr-Data](http://l2ork.music.vt.edu/main/make-your-own-l2ork/software/) or [PlugData](https://plugdata.org/).
+### Debian like install
 
-Inverse kinematic features request [ikpy](https://github.com/Phylliade/ikpy).
+For debian like linux distributions (Debian, Ubuntu, Mint, …) these command lines install all the needed:
+```bash
+sudo apt install puredata pd-list-abs pd-iemlib pd-iemguts
+sudo apt install pd-pddp
+```
 
-=======
 ## License
 
 Copyright 2020-2025 @flachyjoe and other contributors
@@ -77,5 +88,5 @@ The Pure-Data part is coded in Pure-Data language. Thus it require some extra-li
 
 As FUDI protocol can only deal with text, all the FreeCAD data are converted to be usable in Pure-Data. Some objects are still not string-representable. These ones are simply keeped in FreeCAD and Pure-Data can refer to them by reference indexes.
 
-Due to the latency in client/server communication and FreeCAD stuff, *fcpd_** Pure-Data objects are **asynchronous**. So you can't know when outlets trigger. Nevertheless outlets are still triggered right to left.
+Due to the latency in client/server communication and FreeCAD stuff, `fc_` Pure-Data objects are **asynchronous**. So you can't know when outlets trigger. Nevertheless outlets are still triggered right to left.
 This breaks the usual PD codding and require some more work to let other objects wait for FC datas.

fcpd/__init__.py

@@ -26,6 +26,7 @@
 import os
 import sys
 import time
+import shutil
 
 from PySide import QtGui, QtWidgets
 from PySide.QtCore import QProcess
@@ -60,23 +61,30 @@ def runPD():
     if not pdIsRunning():
         pdBin = userPref.GetString("pd_path")
 
+        if not shutil.which(pdBin):
+            FreeCAD.Console.PrintError(
+                f"Unable to find {pdBin}.\r\nPlease check the pure-data client binary path in the Edit menu/Preferences…/FCPD page."
+            )
+            return
+
+        pdlib = "pdlib"
+        if not userPref.GetBool("pd_useExtend", True):
+            pdlib = "pdlib.light"
+
         pdArgs = [
             "-path",
-            os.path.join(locator.PD_PATH, "pdlib"),
+            os.path.join(locator.PD_PATH, pdlib),
             "-helppath",
             os.path.join(locator.PD_PATH, "pdhelp"),
         ]
 
-        if userPref.GetBool("fc_allowRaw", False):
-            clientTemplate = "client_raw.pdtemplate"
-            pdArgs += [
-                "-path",
-                os.path.join(locator.PD_PATH, "pdautogen"),
-                "-helppath",
-                os.path.join(locator.PD_PATH, "pdautogenhelp"),
-            ]
-        else:
-            clientTemplate = "client.pdtemplate"
+        clientTemplate = "client_raw.pdtemplate"
+        pdArgs += [
+            "-path",
+            os.path.join(locator.PD_PATH, "pdautogen"),
+            "-helppath",
+            os.path.join(locator.PD_PATH, "pdautogenhelp"),
+        ]
 
         with open(os.path.join(locator.PD_PATH, clientTemplate), "r") as f:
             clientContents = f.read()
@@ -92,6 +100,7 @@ def runPD():
             f.write(clientContents)
 
         pdProcess.startDetached(pdBin, pdArgs + ["-open", clientFilePath])
+
         if TRY2EMBED:
             time.sleep(1)
             embedPD()

fcpd/pdinclude.py

@@ -65,7 +65,7 @@ def addCloseDetection(filePath):
         )
         fd.seek(0)
         fd.writelines(newContents)
-    Log("close detection added\n")
+    Log("FCPD", "close detection added\n")
 
 
 def hasCloseDetection(filePath):
@@ -90,7 +90,7 @@ def updateCloseDetection(filePath):
             newContents = contents[:lineNumber] + [onClose] + contents[lineNumber + 1 :]
             fd.seek(0)
             fd.writelines(newContents)
-            Log("close detection updated\n")
+            Log("FCPD", "close detection updated\n")
     else:
         addCloseDetection(filePath)
 
@@ -137,7 +137,7 @@ def __init__(self, target_doc, caller, fileName):
 
                     def slotStartSaveDocument(self, doc, label):
                         if doc == self.target_doc:
-                            Log("Ask PD to save\n")
+                            Log("FCPD", "Ask PD to save\n")
                             self.caller.pdServer.send("0 pd-{self.fileName} menusave;")
                             Gui.updateGui()
                             # give PD 500ms to save
@@ -154,14 +154,14 @@ def fileChanged(self, filename):
         if self.skipChange > 0:
             self.skipChange -= 1
         elif os.path.exists(self.tmpFile):
-            Log(f"{self.tmpFile} changed\n")
+            Log("FCPD", f"{self.tmpFile} changed\n")
             self.object.PDFile = self.tmpFile
             App.ActiveDocument.recompute()
         else:
-            Log(f"{self.tmpFile} deleted\n")
+            Log("FCPD", f"{self.tmpFile} deleted\n")
 
     def endEdit(self):
-        Log(f"{self.tmpFile} closed\n")
+        Log("FCPD", f"{self.tmpFile} closed\n")
         try:
             os.remove(self.tmpFile)
             os.remove(self.tmpFile + "_")

fcpd/pdmsgtranslator.py

@@ -209,7 +209,7 @@ def valueFromStr(cls, words):
                     index = int(words[0][1:])
                     retValue = cls.objectsStore[index]
                     retType = cls.OBJECT
-                    Log(f"{words[0]} refers to {str(retValue)}\n")
+                    Log("FCPD", f"{words[0]} refers to {str(retValue)}\n")
                     usedWords = 1
                 elif App.ActiveDocument is not None and App.ActiveDocument.getObject(
                     words[0]

fcpd/pdrawtools.py

@@ -328,7 +328,7 @@ def pdRaw(pdServer, words):
                 className = ".".join(modFunc[:-2])
                 exec("import %s" % className)
             except ModuleNotFoundError as e:
-                Wrn(f"Error : {e}\n")
+                Wrn("FCPD", f"Error : {e}\n")
                 return f"ERROR module not found {className}"
     obj = eval(objectName)
     func = getattr(obj, funcName)
@@ -360,25 +360,25 @@ def pdGiveMe(pdServer, words):
     filePath = os.path.join(modulePath, funcName)
 
     if not os.path.isfile(filePath):
-        Log(f"PDServer : add {filePath}\n")
+        Log("FCPD", f"PDServer : add {filePath}\n")
         try:
-            Log(f"PDServer : try to import {moduleName}\n")
+            Log("FCPD", f"PDServer : try to import {moduleName}\n")
             exec(f"import {moduleName}")
-            Log("PDServer : import ok\n")
+            Log("FCPD", "PDServer : import ok\n")
         except ModuleNotFoundError:
             if args[:-2]:
                 try:
                     className = ".".join(args[:-2])
-                    Log(f"PDServer : try to import {className}\n")
+                    Log("FCPD", f"PDServer : try to import {className}\n")
                     exec(f"import {className}")
-                    Log("PDServer : import ok\n")
+                    Log("FCPD", "PDServer : import ok\n")
                 except ModuleNotFoundError as e:
-                    Wrn(f"Error : {e}\n")
+                    Wrn("FCPD", f"Error : {e}\n")
                     return f"ERROR module not found {className}"
         try:
             obj = eval(moduleName)
         except Exception as e:
-            Wrn(f"Error : {e}\n")
+            Wrn("FCPD", f"Error : {e}\n")
         if hasattr(obj, funcName):
             func = getattr(obj, funcName)
             if not generate(func, words[2], modulePath, paramCount):

fcpd/pdserver.py

@@ -46,6 +46,7 @@
 Msg = App.Console.PrintMessage
 Wrn = App.Console.PrintWarning
 Err = App.Console.PrintError
+Notif = App.Console.PrintNotification
 
 
 ## Deal with PureData connection
@@ -122,7 +123,7 @@ def _pdMsgListProcessor(self, msgList):
         for msg in msgList:
             # remove trailing semicolon and newline
             msg = msg[:-2]
-            Log(f"PDServer : <<<{msg}\r\n")
+            Log("FCPD", f"PDServer : <<<{msg}\r\n")
 
             # split words
             words = msg.split(" ")
@@ -134,16 +135,21 @@ def _pdMsgListProcessor(self, msgList):
                 if self.outputSocket.waitForConnected(1000):
                     self.isWaiting = False
                     Log(
-                        f"PDServer : Callback initialized to {self.remoteAddress.toString()}:{words[1]}\n"
+                        "FCPD",
+                        f"PDServer : Callback initialized to {self.remoteAddress.toString()}:{words[1]}\n",
                     )
                     if self.writeBuffer:
-                        Wrn("PDServer : The data previously stored are now sent\n")
+                        Wrn(
+                            "FCPD",
+                            "PDServer : The data previously stored are now sent\n",
+                        )
                         self.outputSocket.write(bytes(self.writeBuffer, "utf8"))
-                        Log(f"PDServer : >>> {self.writeBuffer}\r\n")
+                        Log("FCPD", f"PDServer : >>> {self.writeBuffer}\r\n")
                         self.writeBuffer = ""
                 else:
                     Log(
-                        f"PDServer : ERROR during callback initialization\n{self.outputSocket.error()}\n"
+                        "FCPD",
+                        f"PDServer : ERROR during callback initialization\n{self.outputSocket.error()}\n",
                     )
             elif words[0] == "close":
                 self.terminate()
@@ -173,12 +179,13 @@ def send(self, *data):
         writeBuffer += ";\n"
         if self.isAvailable() and self.outputSocket.isOpen():
             self.outputSocket.write(bytes(writeBuffer, "utf8"))
-            Log(f"PDServer : >>> {writeBuffer}\r\n")
+            Log("FCPD", f"PDServer : >>> {writeBuffer}\r\n")
         else:
             self.writeBuffer = writeBuffer
             Wrn(
+                "FCPD",
                 "WARNING : Data are sent to PDServer but Pure-Data is not connected.\n"
-                "The data will be kept until connection.\n"
+                "The data will be kept until connection.\n",
             )
 
     ## launch the server
@@ -188,16 +195,19 @@ def run(self):
         if self.tcpServer.listen(QHostAddress(self.listenAddress), self.listenPort):
             self.isRunning = True
             self.isWaiting = True
-            Log(f"PDServer : Listening on port {self.listenPort}\r\n")
+            Log("FCPD", f"PDServer : Listening on port {self.listenPort}\r\n")
+            Notif("FCPD", "The server is waiting for a PureData connection.")
         else:
-            Err(f"PDServer : unable to listen port {self.listenPort}\r\n")
+            Err("FCPD", f"PDServer : unable to listen port {self.listenPort}\r\n")
 
     ## Ask the server to terminate
     #  @param self
     def terminate(self):
-        self.outputSocket.write(b"0 close;")
-        self.outputSocket.disconnectFromHost()
-        self.inputSocket.disconnectFromHost()
+        if self.outputSocket:
+            self.outputSocket.write(b"0 close;")
+            self.outputSocket.disconnectFromHost()
+        if self.inputSocket:
+            self.inputSocket.disconnectFromHost()
         self.isRunning = False
 
     def newConnection(self):
@@ -207,8 +217,10 @@ def newConnection(self):
         self.tcpServer.close()  # no new connection accepted
         self.remoteAddress = self.inputSocket.peerAddress()
         Log(
-            f"PDServer : Connection from {self.remoteAddress.toString()}:{self.inputSocket.peerPort()}\r\n"
+            "FCPD",
+            f"PDServer : Connection from {self.remoteAddress.toString()}:{self.inputSocket.peerPort()}\r\n",
         )
+        Notif("FCPD", "The server is now connected.")
 
     def readyRead(self):
         data = self.inputSocket.readAll()
@@ -228,7 +240,8 @@ def readyRead(self):
 
     def remoteClose(self):
         Log(
-            f"PDServer : {self.inputSocket.peerAddress().toString()} close connection\r\n"
+            "FCPD",
+            f"PDServer : {self.inputSocket.peerAddress().toString()} close connection\r\n",
         )
         if self.isRunning:
             self.terminate()

fcpdwb_commands.py

@@ -56,16 +56,17 @@ def GetResources(self):
         }
 
     def Activated(self):
-        if not fcpd.pdIsRunning():
+        if not fcpd.pdServer.isRunning:
             FreeCADGui.runCommand("FCPD_Run")
+
+        if not fcpd.pdIsRunning():
             fcpd.runPD()
         else:
             Log(QT_TRANSLATE_NOOP("FCPD_Launch", "Pure-Data is already running.\n"))
         return
 
     def IsActive(self):
-        # return FCPD.pdProcess is None or FCPD.pdProcess.poll() is not None
-        return True
+        return not fcpd.pdIsRunning()
 
 
 class FCPD_CommandRun:
@@ -114,8 +115,7 @@ def Activated(self):
         return
 
     def IsActive(self):
-        # return FCPD.pdServer.isRunning
-        return True
+        return fcpd.pdServer.isRunning
 
 
 class FCPD_CommandAddInclude:
@@ -180,8 +180,8 @@ def IsActive(self):
         return True
 
 
-FreeCADGui.addCommand('FCPD_Run', FCPD_CommandRun())
-FreeCADGui.addCommand('FCPD_Stop', FCPD_CommandStop())
+FreeCADGui.addCommand("FCPD_Run", FCPD_CommandRun())
+FreeCADGui.addCommand("FCPD_Stop", FCPD_CommandStop())
 FreeCADGui.addCommand("FCPD_Launch", FCPD_CommandLaunch())
 FreeCADGui.addCommand("FCPD_AddInclude", FCPD_CommandAddInclude())
 FreeCADGui.addCommand("FCPD_AddPopulatedInclude", FCPD_CommandAddPopulatedInclude())

package.xml

@@ -2,8 +2,8 @@
 <package format="1" xmlns="https://wiki.freecad.org/Package_Metadata">
     <name>FCPDWorkbench</name>
     <description>A FreeCAD workbench to use Pure-Data as a graphical macro langage.</description>
-    <version>0.3.1</version>
-    <date>2025-04-14</date>
+    <version>0.4.0</version>
+    <date>2025-04-16</date>
     <maintainer email="[email protected]">Florian Foinant-Willig</maintainer>
     <license file="LICENSE">GPL-3.0-or-later</license>
     <url type="repository" branch="main">https://github.com/FlachyJoe/FCPDWorkbench</url>
@@ -17,7 +17,7 @@
             <subdirectory>./</subdirectory>
             <icon>resources/icons/FCPDLogo.svg</icon>
             <tag>developers</tag>
-            <version>0.3.1</version>
+            <version>0.4.0</version>
         </workbench>
 
         <depend optional="true" type="python">ikpy</depend>