llparse 0.3.0__tar.gz → 0.3.1__tar.gz

{llparse-0.3.0 → llparse-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: llparse
-Version: 0.3.0
+Version: 0.3.1
 Summary: A Parody of llparse written for writing C Parsers with Python
 Author-email: Vizonex <VizonexBusiness@gmail.com>
 Requires-Python: >=3.10

{llparse-0.3.0 → llparse-0.3.1}/llparse/__init__.py

@@ -8,5 +8,5 @@ A Pythonic version of the typescript llparse library.
 from .dot import Dot
 from .llparse import LLParse
 
-__version__ = "0.3.0"
+__version__ = "0.3.1"
 __all__ = ("Dot", "LLParse")

{llparse-0.3.0 → llparse-0.3.1}/llparse/capi_builder.py

@@ -5,6 +5,7 @@ from __future__ import annotations
 
 import re  # inspired by rust's bindgen clang compiler
 import sys
+from pathlib import Path
 from contextlib import contextmanager
 from dataclasses import dataclass, field
 from enum import IntEnum
@@ -50,7 +51,7 @@ API_C_CODE = Template("""
 
 #include "{{header}}"
  
-/* Prevent Interfearing with other parsers (example: llhttp) */
+/* Prevent Interfearing with other parsers (example: {{prefix}}) */
 #define {{upper}}_CALLBACK_MAYBE(PARSER, NAME)                                      \\
    do {                                                                        \\
      {{prefix}}_settings_t* settings;                                                  \\
@@ -73,7 +74,7 @@ API_C_CODE = Template("""
     err = settings->NAME((PARSER), (START), (LEN));                           \\
   } while (0)
 
-/* Custom Underrived from llhttp */
+/* Custom Underrived from {{prefix}} */
 #define {{upper}}_VALUE_CALLBACK_MAYBE(PARSER, NAME, VALUE)                        \\
    do {                                                                        \\
      {{prefix}}_settings_t* settings;                                                  \\
@@ -123,6 +124,15 @@ void {{prefix}}_settings_init({{prefix}}_settings_t* settings) {
     memset(settings, 0, sizeof(*settings));
 }
 
+int {{prefix}}_execute({{prefix}}_t* parser, const char* data, size_t len) {
+  return {{prev_prefix}}_execute(parser, data, data + len);
+}
+                      
+{{if extra_code}}
+/* EXTRAS */
+{{extra_code}}
+{{endif}}
+
 """)
 
 
@@ -134,6 +144,7 @@ API_C_HEADER = Template(
 extern "C" {
 #endif
 #include <stddef.h>
+#include <stdint.h>
 
 #if defined(__wasm__)
 #define {{export}} __attribute__((visibility("default")))
@@ -161,20 +172,36 @@ typedef int (*{{prefix}}_value_cb)({{prefix}}_t*, int value);
 struct {{prefix}}_settings_s {
     {{if spans}}
     /* Spans */
-    {{for _, name in spans}}{{prefix}}_data_cb      {{name}};{{endfor}}
+    {{for _, name in spans}}
+    {{prefix}}_data_cb      {{name}};
+    {{endfor}}
     
     {{endif}}
     {{if values}}
     /* Value Callbacks */
-    {{for _, name in values}}{{prefix}}_value_cb      {{name}};{{endfor}}
+    {{for _, name in values}}
+    {{prefix}}_value_cb      {{name}};
+    {{endfor}}
     
     {{endif}}
     {{if matches}}
     /* Callbacks */
-    {{for _, name in matches}}{{prefix}}_cb     {{name}};{{endfor}}
+    {{for _, name in matches}}
+    {{prefix}}_cb     {{name}};
+    {{endfor}}
     {{endif}}
 };
 
+{{export}}
+void {{prefix}}_settings_init({{prefix}}_settings_t* settings);
+
+{{export}}
+int {{prefix}}_execute({{prefix}}_t* parser, const char* data, size_t len);
+
+{{if extra_code}}
+{{extra_code}}
+{{endif}}
+
 #ifdef __cplusplus
 } /* extern "C" */
 #endif
@@ -268,7 +295,7 @@ class CythonWriter(CodeWriter):
 
 class Filter:
     """A Filter to go off for match, value, and spans
-    to help organize the output for an llhttp-like C
+    to help organize the output for an {{prefix}}-like C
     Library"""
 
     __slots__ = ("_pattern", "_is_re", "_use")
@@ -302,10 +329,10 @@ class Filter:
     def is_match(self, name: str) -> bool:
         """Determines if the source matches up"""
         if self._is_re:
-            return re.search(self._pattern) is not None
+            return re.search(self._pattern, name) is not None
         else:
             # it's most likely a prefix of ignorable callbacks...
-            return name.startswith(self._pattern)
+            return name.startswith(self._pattern) or self._pattern == name
 
     def edit_name(self, name: str) -> str:
         """Ran when use is enabled"""
@@ -374,7 +401,7 @@ class UsedResults:
             raise TypeError(f"unknown type for name:{name} type:{ty}")
 
 
-@dataclass
+@dataclass(slots=True)
 class Results:
     ignore: IgnoredResults = field(default_factory=IgnoredResults)
     """Seperates into a non-api file under a .c suffix these
@@ -395,6 +422,73 @@ class CAPIResult:
     c: str
     header: str
 
+    def write(self, c: Path | str, header:Path | str) -> None:
+        """
+        Writes the output to the chosen file locations
+
+        :param c: Output for where to write the C File
+        :type c: Path | str
+        :param header: Output for where to write the Header File
+        :type header: Path | str
+        """
+        Path(c).write_text(self.c)
+        Path(header).write_text(self.header)
+    
+
+# Undecided on implementing yet...
+# class Getter:
+#     """A property that can be defined and obtained with a C wrapper"""
+
+#     def __init__(
+#         self, 
+#         name: str, 
+#         reset: bool = False,
+#         init: bool = False,
+#         recast_type:str | None = None 
+#     ) -> None:
+#         self.name = name
+#         self.reset = reset
+#         self.init = init
+#         self.recast_type = recast_type
+
+
+# class ErrnoGetter(Getter):
+#     """
+#     Creates a list of errors that your parser can raise 
+#     if you provided enums originally.
+#     """
+
+#     def __init__(
+#         self, 
+#         ty: type[IntEnum],
+#         recast_type: str | None = None,
+#         pause:IntEnum | None=  None,
+#     ) -> None:
+#         self.pause = pause
+#         self.emap = {k:v.value for k, v in ty._member_map_.items()}
+
+#         super().__init__(name="error", reset=False, init=False, recast_type=recast_type)
+
+#     def write_enum(self, prefix:str) -> str:
+#         code  = f"enum {prefix}_errno" + "{"
+#         code += ",\n".join([f"  {k} = {v}" for k, v in self.emap.items()])
+#         code += "\n};"
+#         code += f"typedef enum {prefix}_errno {prefix}_errno_t;\n"
+#         return code
+
+#     def write_map(self, prefix:str):
+#         code = "#define " + prefix.upper() + "_ERRNO_MAP(XX) \\\n"
+#         for v, k in self.emap.items():
+#             code += f"XX({v}, {k}, {k}) \\\n"
+#         code += "\n\n"
+#         return code
+
+
+
+
+   
+
+
 
 class LibraryCompiler:
     """Used for writing in what callbacks to mark as wrappable or don't use
@@ -403,7 +497,7 @@ class LibraryCompiler:
 
     __slots__ = ("_filters", "_dummy_ignore", "_prefix", "_previous_prefix")
 
-    def __init__(self, prefix: str, llparse: LLParse):
+    def __init__(self, prefix: str, llparse: LLParse) -> None:
         self._filters: set[Filter] = set()
         # Put all ignored spans, matches and values here...
         self._dummy_ignore = Filter("dummy", False)
@@ -491,6 +585,8 @@ class LibraryCompiler:
         root: builder.Node,
         header: str | None = None,
         headerguard: str | None = None,
+        extra_header_code:str | None = None,
+        extra_c_code:str | None = None
     ) -> CAPIResult:
         """
         Compile library's data and create a header file and other external for the library's c-api
@@ -501,6 +597,10 @@ class LibraryCompiler:
         :type header: str | None
         :param headerguard: The Macro's name for the Header guard
         :type headerguard: str | None
+        :param extra_header_code: Applies extra code to the header file if extra functions or things were required
+        :type extra_header_code:str | None
+        :param extra_c_code: Applies extra code to the c file if extra functions or things were required
+        :type extra_c_code:str | None
         :return: The CAPI Result containing extra files for the c-wrapper
         :rtype: CAPIResult
 
@@ -515,6 +615,8 @@ class LibraryCompiler:
             spans=used.spans,
             upper=self._prefix.upper(),
             header=header or (self._prefix + ".h"),
+            prev_prefix=self._previous_prefix,
+            extra_code=extra_c_code
         )
         header_code = API_C_HEADER.substitute(
             prefix=self._prefix,
@@ -525,5 +627,6 @@ class LibraryCompiler:
             export=self._prefix.upper() + "_EXPORT",
             headerguard=headerguard or f"{self._prefix.upper()}_CAPI_INCLUDE",
             prev_prefix=self._previous_prefix,
+            extra_code=extra_header_code
         )
         return CAPIResult(api_code, header_code)

{llparse-0.3.0 → llparse-0.3.1}/llparse/llparse.py

@@ -1,6 +1,5 @@
-""""""
-
 from dataclasses import dataclass
+from pathlib import Path
 
 from .C_compiler import CCompiler
 from .frontend import (
@@ -14,34 +13,35 @@ from .header import HeaderBuilder
 from .capi_builder import LibraryCompiler
 
 
-@dataclass
+@dataclass(slots=True)
 class CompilerResult:
     c: str
     """Textual C code"""
     header: str
     """Textual C header file"""
 
-    # NOTE Coming soon... I will making a settings compiler which is attached to CompilerResult to Compile your own
-    # settings structures and be able to concate it to the existing header file like in llhttp
-    # I'm also in the works of adding a Cython .pxd import as well...
+    def write(self, c: Path | str, header:Path | str) -> None:
+        """
+        Writes the output to the chosen file locations
 
+        :param c: Output for where to write the C File
+        :type c: Path | str
+        :param header: Output for where to write the Header File
+        :type header: Path | str
+        """
+        Path(c).write_text(self.c)
+        Path(header).write_text(self.header)
+    
 
+# It's just small enough to write the compile as a dataclass
+@dataclass(slots=True)
 class Compiler:
     """Used to Compile C code together"""
-
-    def __init__(
-        self,
-        prefix: str,
-        headerGuard: str | None = None,
-        debug: str | None = None,
-        maxTableElemWidth: int | None = None,
-        minTableSize: int | None = None,
-    ):
-        self.prefix = prefix
-        self.headerGuard = headerGuard
-        self.debug = debug
-        self.maxTableElemWidth = maxTableElemWidth
-        self.minTableSize = minTableSize
+    prefix: str
+    headerGuard: str | None = None
+    debug: str | None = None
+    maxTableElemWidth: int | None = None
+    minTableSize: int | None = None
 
     def to_frontend(
         self,
@@ -167,6 +167,6 @@ class LLParse(source.Builder):
             minTableSize if minTableSize else DEFAULT_MIN_TABLE_SIZE,
         ).to_frontend(root, self.properties)
 
-    def capi(self, prefix: str):
+    def capi(self, prefix: str) -> LibraryCompiler:
         """Using a new prefix this tool enables helping build c-api wrapper that is simillar to llhttp"""
         return LibraryCompiler(prefix, self)

{llparse-0.3.0 → llparse-0.3.1}/llparse.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: llparse
-Version: 0.3.0
+Version: 0.3.1
 Summary: A Parody of llparse written for writing C Parsers with Python
 Author-email: Vizonex <VizonexBusiness@gmail.com>
 Requires-Python: >=3.10

{llparse-0.3.0 → llparse-0.3.1}/llparse.egg-info/SOURCES.txt

@@ -38,6 +38,7 @@ llparse/pyfront/namespace.py
 llparse/pyfront/nodes.py
 llparse/pyfront/peephole.py
 llparse/pyfront/transform.py
+tests/test_capi.py
 tests/test_compilator.py
 tests/test_frontend.py
 tests/test_loop_checker.py

llparse-0.3.1/tests/test_capi.py

@@ -0,0 +1,121 @@
+"""
+Tests tools for writing C-API Wrappers
+"""
+from llparse import LLParse
+import re
+
+import pytest
+
+DUMMY_HEADER = """#ifndef LLPARSE_CAPI_INCLUDE
+#define LLPARSE_CAPI_INCLUDE
+#ifdef __cplusplus
+extern "C" {
+#endif
+#include <stddef.h>
+#include <stdint.h>
+
+#if defined(__wasm__)
+#define LLPARSE_EXPORT __attribute__((visibility("default")))
+#elif defined(_WIN32)
+#define LLPARSE_EXPORT __declspec(dllexport)
+#else
+#define LLPARSE_EXPORT
+#endif
+
+typedef llparse_internal_t llparse_t;
+typedef struct llparse_settings_s llparse_settings_t;
+typedef int (*llparse_data_cb)(llparse_t*, const char* at, size_t length);
+typedef int (*llparse_cb)(llparse_t*);
+
+struct llparse_settings_s {
+    /* Spans */
+    llparse_data_cb      llparse_on_span;
+    /* Callbacks */
+    llparse_cb     llparse_on_test;
+};
+
+LLPARSE_EXPORT
+void llparse_settings_init(llparse_settings_t* settings);
+
+LLPARSE_EXPORT
+int llparse_execute(llparse_t* parser, const char* data, size_t len);
+
+#ifdef __cplusplus
+} /* extern "C" */
+#endif
+
+#endif /* LLPARSE_CAPI_INCLUDE */
+"""
+
+
+
+@pytest.fixture()
+def llparse() -> LLParse:
+    return LLParse("llparse_internal")
+
+def test_collecting_spans(llparse:LLParse):
+    lc = llparse.capi("llparse")
+    span = llparse.span(llparse.code.span("span"))
+    start = llparse.node("start")
+    body = llparse.node("body")
+
+    start.otherwise(span.start(body))
+
+    body.skipTo(span.end(start))
+
+    lc.use("span")
+    result = lc.filter(start)
+    assert result.use.spans, "No spans found"
+
+
+def test_collecting_matches(llparse:LLParse):
+    lc = llparse.capi("lc")
+    span = llparse.span(llparse.code.span("llparse_on_span"))
+    on_test = llparse.code.match("llparse_on_test")
+
+    start = llparse.node("start")
+    body = llparse.node("body")
+
+    start.otherwise(
+        span.start(body)
+    )
+
+    body.skipTo(
+        span.end(
+            llparse.invoke(on_test, {0:start}, llparse.error(-1, "error"))
+        )
+    )
+    lc.use("llparse_")
+    result = lc.filter(start)
+    assert result.use.spans, "No spans found"
+    assert result.use.matches, "No matches found"
+
+
+def test_write_capi(llparse:LLParse):
+    lc = llparse.capi("llparse")
+    span = llparse.span(llparse.code.span("llparse_on_span"))
+    on_test = llparse.code.match("llparse_on_test")
+
+    start = llparse.node("start")
+    body = llparse.node("body")
+
+    start.otherwise(
+        span.start(body)
+    )
+
+    body.skipTo(
+        span.end(
+            llparse.invoke(on_test, {0:start}, llparse.error(-1, "error"))
+        )
+    )
+
+    lc.use("span")
+    lc.use_regex(r"llparse_([^\s]+)")
+
+    
+    result = lc.build(start)
+    assert result.header.strip() == DUMMY_HEADER.strip()
+
+
+
+