From 221e464df3c4853b201de91afd8808fab50431b6 Mon Sep 17 00:00:00 2001
From: Melven Roehrig-Zoellner <Melven.Roehrig-Zoellner@DLR.de>
Date: Wed, 12 Jun 2024 09:52:49 +0200
Subject: [PATCH] py-pyopengl: new package (#32357)

* py-pyopengl: new simple package

* py-pyopengl: Fix typo in comment

Co-authored-by: Adam J. Stewart <ajstewart426@gmail.com>

* py-pyopengl: add variants and dependencies

* py-pyopengl: build from source and improve variants

* py-pyopengl: use corrected freeglut libs

* py-pyopengl: update copyright

* py-pyopengl: remove duplicate conflict clause

* py-pyopengl: change dependency to link

---------

Co-authored-by: Adam J. Stewart <ajstewart426@gmail.com>
---
 .../builtin/packages/py-pyopengl/package.py   | 68 +++++++++++++++++++
 1 file changed, 68 insertions(+)
 create mode 100644 var/spack/repos/builtin/packages/py-pyopengl/package.py

diff --git a/var/spack/repos/builtin/packages/py-pyopengl/package.py b/var/spack/repos/builtin/packages/py-pyopengl/package.py
new file mode 100644
index 00000000000..64f4913dc28
--- /dev/null
+++ b/var/spack/repos/builtin/packages/py-pyopengl/package.py
@@ -0,0 +1,68 @@
+# Copyright 2013-2024 Lawrence Livermore National Security, LLC and other
+# Spack Project Developers. See the top-level COPYRIGHT file for details.
+#
+# SPDX-License-Identifier: (Apache-2.0 OR MIT)
+
+import sys
+
+from spack.package import *
+
+
+class PyPyopengl(PythonPackage):
+    """PyOpenGL is the most common cross platform Python binding to OpenGL and related APIs."""
+
+    homepage = "http://pyopengl.sourceforge.net"
+    pypi = "pyopengl/PyOpenGL-3.1.6.tar.gz"
+
+    version("3.1.6", sha256="8ea6c8773927eda7405bffc6f5bb93be81569a7b05c8cac50cd94e969dce5e27")
+
+    variant("glu", default=True, description="Enable OpenGL Utility (GLU) binding.")
+    variant("glut", default=True, description="Enable OpenGL Utility Toolkit (GLUT) binding.")
+
+    conflicts("osmesa", when="^glx")
+
+    depends_on("py-setuptools", type="build")
+    # actually installing PyOpenGL itself just requires python
+    # but tests (and possibly dependent packages) need OpenGL libraries
+    depends_on("gl", type="link")
+    depends_on("glu", when="+glu", type="link")
+    depends_on("freeglut+shared", when="+glut", type="link")
+
+    def setup_run_environment(self, env):
+        # PyOpenGL uses ctypes.cdll (or similar), which searches LD_LIBRARY_PATH
+        lib_dirs = self.spec["gl"].libs.directories
+        if "^glx" in self.spec:
+            lib_dirs.extend(self.spec["glx"].libs.directories)
+            env.set("PYOPENGL_PLATFORM", "glx")
+        if "^osmesa" in self.spec:
+            lib_dirs.extend(self.spec["osmesa"].libs.directories)
+            env.set("PYOPENGL_PLATFORM", "osmesa")
+        if "+glu" in self.spec:
+            lib_dirs.extend(self.spec["glu"].libs.directories)
+        if "+glut" in self.spec:
+            lib_dirs.extend(self.spec["freeglut"].libs.directories)
+        libs = ":".join(lib_dirs)
+        if sys.platform == "darwin":
+            env.prepend_path("DYLD_FALLBACK_LIBRARY_PATH", libs)
+        else:
+            env.prepend_path("LD_LIBRARY_PATH", libs)
+
+    def setup_dependent_build_environment_(self, env, dependent_spec):
+        self.setup_run_environment(env)
+
+    # only test import available module
+    @property
+    def import_modules(self):
+        modules = ["OpenGL", "OpenGL.GL"]
+        if "gl=glx" in self.spec:
+            modules.append("OpenGL.GLX")
+        if "gl=osmesa" in self.spec:
+            modules.append("OpenGL.osmesa")
+        if "+glu" in self.spec:
+            modules.append("OpenGL.GLU")
+        if "+glut" in self.spec:
+            modules.append("OpenGL.GLUT")
+        if "^python+tkinter" in self.spec:
+            modules.append("OpenGL.Tk")
+
+        return modules