add test, fix yosys version, match yosys version

Author: donn

.github/workflows/ci.yml

@@ -63,6 +63,8 @@ jobs:
           fetch-depth: 0
           submodules: true
           persist-credentials: false
+      - run: |
+          perl -i -pe 'print "__attribute__((weak)) " if /LibertyParser::error/' yosys/passes/techmap/libparse.cc
       - uses: actions/setup-python@v5
       - if: ${{ matrix.os.family == 'macos' && matrix.os.archs == 'arm64' }}
         name: "[macOS/arm64] Install Python 3.8 (see: https://cibuildwheel.pypa.io/en/stable/faq/#macos-building-cpython-38-wheels-on-arm64)"

Readme.md

@@ -76,3 +76,6 @@ 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.
+
+Test suite from [liberty2json](https://github.com/silimate/liberty2json) by
+Silimate.

default.nix

@@ -4,6 +4,8 @@
   buildPythonPackage,
   pytest,
   pybind11,
+  pytestCheckHook,
+  perl,
 }: let
   version_file = builtins.readFile ./libparse/__version__.py;
   version_list = builtins.match ''.+''\n__version__ = "([^"]+)"''\n.+''$'' version_file;
@@ -14,17 +16,31 @@ in
     inherit version;
 
     inherit src;
+    
+    postPatch = ''
+      perl -i -pe 'print "__attribute__((weak)) " if /LibertyParser::error/' yosys/passes/techmap/libparse.cc
+    '';
+
+    nativeBuildInputs = [
+      perl
+    ];
 
     buildInputs = [
       pybind11
     ];
 
     pythonImportsCheck = [ "libparse" ];
+    
+    doCheck = true;
+    
+    nativeCheckInputs = [
+      pytestCheckHook
+    ];
 
-    meta = with lib; {
+    meta = {
       description = "Python wrapper around Yosys's libparse";
-      license = with licenses; [asl20];
+      license = with lib.licenses; [asl20];
       homepage = "https://github.com/librelane/libparse-python";
-      platforms = platforms.linux ++ platforms.darwin;
+      platforms = with lib.platforms; linux ++ darwin;
     };
   }

libparse/__init__.py

@@ -1,2 +1,15 @@
-from _libparse import *
+from _libparse import LibertyAst, LibertyParser
 from .__version__ import __version__
+
+def __LibertyAst__to_dict(self):
+    result = {}
+    result["id"] = self.id
+    if len(self.args):
+        result["args"] = self.args
+    if self.value != "":
+        result["value"] = self.value
+    if len(self.children):
+        result["children"] = [child.to_dict() for child in self.children]
+    return result
+
+LibertyAst.to_dict = __LibertyAst__to_dict

libparse/__main__.py

@@ -0,0 +1,22 @@
+
+import sys
+import json
+from argparse import ArgumentParser
+
+from . import LibertyParser, __version__
+
+def main(argv):
+    p = ArgumentParser("libparse")
+    p.add_argument("-v", "--version", action='version', version=f'%(prog)s {__version__}')
+    p.add_argument("file", nargs=1)
+    ns = p.parse_args(argv)
+    f = open(ns.file[0], "r")
+    try:
+        parsed = LibertyParser(f)
+    except RuntimeError as e:
+        print(e, file=sys.stderr)
+        exit(1)
+    print(json.dumps(parsed.ast.to_dict()))
+
+if __name__ == "__main__":
+    main(sys.argv[1:])

libparse/__version__.py

@@ -16,7 +16,7 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-__version__ = "1.0.0"
+__version__ = "0.56.0"
 
 if __name__ == "__main__":
     print(__version__, end="")

libparse/wrapper.cpp

@@ -15,16 +15,34 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+#define private public
+#include "libparse.h"
+#undef private
 
 #include <pybind11/pybind11.h>
 #include <pybind11/stl.h>
 
-#include "libparse.h"
 #include "stdio_filebuf.h"
 
 namespace py = pybind11;
 using namespace Yosys;
 
+void LibertyParser::error() const
+{
+    std::ostringstream oss;
+    oss << "Syntax error in liberty file on line " << line << ".\n";
+    throw std::runtime_error(oss.str());
+}
+
+void LibertyParser::error(const std::string &str) const
+{
+	std::stringstream oss;
+	oss << "Syntax error in liberty file on line " << line << ".\n";
+	oss << "  " << str << "\n";
+    throw std::runtime_error(oss.str());
+}
+
+
 struct PyIStream : public std::istream {
 	PyIStream(FILE *f) : std::istream(&buffer_), buffer_(f) {}
 
@@ -35,7 +53,8 @@ struct PyIStream : public std::istream {
 		}
 
 		auto fd_attr = pyfile.attr("fileno");
-        auto fd = fd_attr.cast<int>();
+		auto fd_obj = fd_attr();
+		auto fd = fd_obj.cast<int>();
 		if (fd == -1) {
 			throw std::runtime_error("Failed to get file descriptor");
 		}
@@ -58,6 +77,7 @@ LibertyParser *from_file(const py::object &pyfile)
 	return new LibertyParser(*cxx_stream);
 }
 
+
 PYBIND11_MODULE(_libparse, m)
 {
 	m.doc() = "libparse from yosys, native component";

pyproject.toml

@@ -4,3 +4,6 @@ requires = [
     "pybind11>=2.10.0",
 ]
 build-backend = "setuptools.build_meta"
+
+[tool.pytest.ini_options]
+testpaths = ["test"]

setup.py

@@ -31,7 +31,7 @@
     author="Mohamed Gaber",
     author_email="me@donn.website",
     install_requires=["wheel"],
-    python_requires=">3.8",
+    python_requires=">=3.8",
     ext_modules=[ext],
     cmdclass={"build_ext": build_ext},
 )

test/.gitignore

@@ -0,0 +1,2 @@
+*.diff.json
+*.log