Python Package

Author: donn

.gitignore

@@ -6,11 +6,12 @@ libparse.cc
 
 # swig
 libparse.py
-libparse_wrap.c
-libparse_wrap.cxx
+libparse_wrap.*
 
 # python
 __pycache__
+/venv
+*.egg-info
 
 # binaries
 *.out

Makefile

@@ -1,31 +1,42 @@
 
+SRC_DIR = libparse
+SWIG_IN = $(SRC_DIR)/libparse.i
+SWIG_OUT = $(SRC_DIR)/libparse_wrap.cpp $(SRC_DIR)/libparse.py 
+SOURCES = $(SRC_DIR)/libparse_wrap.cpp $(SRC_DIR)/libparse.cpp
+OBJECTS = $(patsubst %.cpp,%.o,$(SOURCES))
+HEADERS = $(SRC_DIR)/libparse.h $(SRC_DIR)/py_iostream.h
+
 CXXFLAGS += -g -std=c++17 -I$(shell python3 -c "import sysconfig; print(sysconfig.get_path('include'))")
 
 
 all: _libparse.so
+swig_out: $(SWIG_OUT)
+
+_libparse.so: $(OBJECTS)
+	$(CXX) -shared $^ -o $@
 
-_libparse.so: libparse.cc libparse_wrap.cxx libparse.h py_iostream.h
-	$(CXX) -fPIC -c $(CXXFLAGS) -DFILTERLIB libparse.cc 
-	$(CXX) -fPIC -c $(CXXFLAGS) -DFILTERLIB libparse_wrap.cxx 
-	$(CXX) -shared libparse.o libparse_wrap.o -o $@
+$(OBJECTS): %.o : %.cpp $(HEADERS)
+	$(CXX) -fPIC -o $@ -c $(CXXFLAGS) -DFILTERLIB $<
 
-libparse.py libparse_wrap.cxx: libparse.i libparse.h
-	swig -c++ -python $<
+$(SWIG_OUT): $(SWIG_IN) $(HEADERS)
+	swig -c++ -o $(SRC_DIR)/libparse_wrap.cpp -oh $(SRC_DIR)/libparse.h -python $<
 
-libparse.h: yosys/passes/techmap/libparse.h libparse.h.patch
+$(SRC_DIR)/libparse.h: yosys/passes/techmap/libparse.h $(SRC_DIR)/libparse.h.patch
 	cp $< $@
-	patch libparse.h libparse.h.patch
+	patch $@ $(SRC_DIR)/libparse.h.patch
 
-libparse.cc: yosys/passes/techmap/libparse.cc
+$(SRC_DIR)/libparse.cpp: yosys/passes/techmap/libparse.cc $(SRC_DIR)/libparse.cpp.patch
 	cp $< $@
-	patch libparse.cc libparse.cc.patch
+	patch $@ $(SRC_DIR)/libparse.cpp.patch
 
 .PHONY: regen-patches
 regen-patches:
-	diff yosys/passes/techmap/libparse.h libparse.h > libparse.h.patch || true
-	diff yosys/passes/techmap/libparse.cc libparse.cc > libparse.cc.patch || true
+	diff yosys/passes/techmap/libparse.h $(SRC_DIR)/libparse.h > $(SRC_DIR)/libparse.h.patch || true
+	diff yosys/passes/techmap/libparse.cc $(SRC_DIR)/libparse.cpp > $(SRC_DIR)/libparse.cpp.patch || true
 
 .PHONY: clean
 clean:
-	rm -f libparse*.cc libparse*.cxx libparse.h libparse.py
-	rm -f *.so *.o *.dylib *.dll
+	rm -f $(SRC_DIR)/*.cpp $(SRC_DIR)/*.o $(SRC_DIR)/libparse.py $(SRC_DIR)/libparse.h  
+	rm -f *.so *.o *.dylib *.dll
+	rm -rf build/
+	rm -rf libparse.egg-info/

Readme.md

@@ -0,0 +1,57 @@
+# libparse-python
+
+A SWIG-based Python wrapper around [Yosys](https://github.com/yosyshq/yosys)'s
+`libparse`, for all your lib file parsing needs.
+
+# Requirements
+* Python 3.2+
+* A C++17 compiler
+* GNU Make
+
+# License
+Apache 2.0. Check 'License'.
+
+## Acknowledgements
+`libparse` from [Yosys](https://github.com/yosyshq/yosys) used under the following conditions:
+
+```
+Copyright (C) 2012 - 2020  Claire Xenia Wolf <[email protected]>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+```
+
+`stdio_filebuf` from [Android Frameworks](https://android.googlesource.com/platform/frameworks/native/+/refs/heads/main/services/vr/performanced) used under the following conditions:
+
+```
+// Copyright (c) 2009-2014 by the contributors listed in CREDITS.TXT
+// Copyright (c) 2016 Google, Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+```
+> The `CREDITS.TXT` in question could not be located at press time.

libparse.cc.patch libparse/libparse.cpp.patchlibparse.cc.patch renamed to libparse/libparse.cpp.patch

@@ -0,0 +1,57 @@
+#!/usr/bin/env python3
+import os
+import subprocess
+from setuptools import setup, find_packages, Extension
+from setuptools.command.build_py import build_py
+
+module_name = "libparse"
+__dir__ = os.path.dirname(__file__)
+
+ext = Extension(
+    name='_libparse',
+    swig_opts=['-c++'],
+    sources=[
+        'libparse/libparse.cpp',
+        'libparse/libparse.i',
+    ],
+    include_dirs=[
+        'libparse',
+    ],
+    extra_compile_args=[
+        '-std=c++17',
+        "-DFILTERLIB"
+    ]
+)
+
+class BuildPy(build_py):
+    def run(self):
+        subprocess.check_call([
+            "make",
+            "swig_out"
+        ])
+        self.run_command('build_ext')
+        super(build_py, self).run()
+
+setup(
+    name=module_name,
+    packages=find_packages(),
+    version="0.1.0",
+    description="Python wrapper around Yosys' libparse module",
+    long_description=open("Readme.md").read(),
+    long_description_content_type="text/markdown",
+    author="Efabless Corporation and Contributors",
+    author_email="[email protected]",
+    install_requires=[],
+    classifiers=[
+        "License :: OSI Approved :: Apache Software License",
+        "Programming Language :: Python :: 3",
+        "Intended Audience :: Developers",
+        "Operating System :: POSIX :: Linux",
+        "Operating System :: MacOS :: MacOS X",
+    ],
+    python_requires=">3.6",
+    ext_modules=[ext],
+    cmdclass={
+        'build_py': BuildPy,
+    },
+)

libparse.h.patch libparse/libparse.h.patchlibparse.h.patch renamed to libparse/libparse.h.patch

@@ -6,5 +6,6 @@ with pkgs; mkShell {
         swig
         clang
         python3Full
+        valgrind
     ];
 }