pyOpenVBA 6.1.0__tar.gz → 6.1.2__tar.gz

{pyopenvba-6.1.0 → pyopenvba-6.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pyOpenVBA
-Version: 6.1.0
+Version: 6.1.2
 Summary: Read and write VBA macros and Excel Power Query in pure Python, no dependencies.
 Project-URL: Homepage, https://github.com/WilliamSmithEdward/pyOpenVBA
 Project-URL: Repository, https://github.com/WilliamSmithEdward/pyOpenVBA
@@ -361,7 +361,9 @@ form.remove_page("Page2", multipage="Wizard")
 ```
 
 A form can be built from nothing. `add_form` creates the designer storage
-and the code-behind module together:
+and the code-behind module together. A project with no Microsoft Forms
+reference gets the one the editor adds with a first form, so code that
+names `MSForms` types compiles:
 
 ```python
 with pyopenvba.ExcelFile("book.xlsm") as wb:

{pyopenvba-6.1.0 → pyopenvba-6.1.2}/README.md

@@ -324,7 +324,9 @@ form.remove_page("Page2", multipage="Wizard")
 ```
 
 A form can be built from nothing. `add_form` creates the designer storage
-and the code-behind module together:
+and the code-behind module together. A project with no Microsoft Forms
+reference gets the one the editor adds with a first form, so code that
+names `MSForms` types compiles:
 
 ```python
 with pyopenvba.ExcelFile("book.xlsm") as wb:

{pyopenvba-6.1.0 → pyopenvba-6.1.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pyOpenVBA"
-version = "6.1.0"
+version = "6.1.2"
 description = "Read and write VBA macros and Excel Power Query in pure Python, no dependencies."
 readme = "README.md"
 license = { text = "MIT" }

{pyopenvba-6.1.0 → pyopenvba-6.1.2}/src/pyopenvba/__init__.py

@@ -293,4 +293,4 @@ def push_power_query(
     """
     return _push_queries(src_dir, workbook, out=out, encoding=encoding, remove_missing=remove_missing)
 
-__version__ = "6.1.0"
+__version__ = "6.1.2"

{pyopenvba-6.1.0 → pyopenvba-6.1.2}/src/pyopenvba/_host.py

@@ -289,7 +289,9 @@ class VBAHostFile(ReferenceManager):
         a storage without a module is not a component the host will show,
         and a module without a storage is a class rather than a form.
         Geometry is in points; the defaults are the size Excel gives a new
-        form.
+        form.  A project that does not reference Microsoft Forms yet gets
+        the reference the editor adds with a first form, so code naming
+        ``MSForms`` types compiles.
 
         The form is returned ready to edit -- ``add_control`` and friends
         work on it straight away -- and lands on disk at :meth:`save`.
@@ -305,6 +307,8 @@ class VBAHostFile(ReferenceManager):
             code_page=project.code_page,
         )
         project.add_module(name, header, kind=VBAModuleKind.other)
+        # The editor declares Microsoft Forms with a project's first form, and code naming its types needs it.
+        self._ensure_forms_reference()
         # The cache was read before this form existed.
         self._forms = None
         return next(f for f in self.forms() if f.name == name)

{pyopenvba-6.1.0 → pyopenvba-6.1.2}/src/pyopenvba/_references.py

@@ -9,6 +9,12 @@ from pyopenvba.exceptions import VBAProjectError
 from pyopenvba.vba import VBAReference, encoding_for_codepage
 
 MSFORMS_GUID = "{0D452EE1-E08F-101A-852E-02608C4D0BB4}"
+#: The Microsoft Forms library as the editor's reference names it, path included, whatever FM20.DLL's real
+#: location: the host resolves the library by GUID and version (tests/fixtures/form_reference.json).
+MSFORMS_LIBID = ("*\\G{0D452EE1-E08F-101A-852E-02608C4D0BB4}#2.0#0#C:\\WINDOWS\\system32\\FM20.DLL"
+                 "#Microsoft Forms 2.0 Object Library")
+#: A control reference's twiddled libid, which is the null one.
+_NULL_LIBID = "*\\G{00000000-0000-0000-0000-000000000000}#0.0#0##"
 VBA_GUID = "{000204EF-0000-0000-C000-000000000046}"
 
 
@@ -114,6 +120,32 @@ def registered_block(reference: VBAReference, code_page: int) -> bytes:
             + record(0xD, struct.pack("<I", len(libid)) + libid + bytes(6)))
 
 
+def is_msforms(reference: VBAReference) -> bool:
+    """Whether ``reference`` is the Microsoft Forms library, by name or GUID."""
+    return reference.name.lower() == "msforms" or reference.guid.upper() == MSFORMS_GUID
+
+
+def msforms_block(code_page: int) -> bytes:
+    """The Microsoft Forms reference the editor declares with a project's first UserForm.
+
+    Excel, Word and PowerPoint write the same control reference
+    (tests/fixtures/form_reference.json): the name, the original libid,
+    the null twiddled libid, the name again, and the extended record
+    with the type library's GUID and cookie 1. Their extended libid
+    names the .exd cache the editor keeps in the saving user's Temp
+    folder, under a GUID of that cache's own; here it repeats the
+    original libid, which the editor compiles against and Excel keeps
+    when it saves the file again, so no user's folder is written.
+    """
+    encoding = encoding_for_codepage(code_page)
+    name = record(0x16, "MSForms".encode(encoding)) + record(0x3E, "MSForms".encode("utf-16-le"))
+    original, twiddled = MSFORMS_LIBID.encode(encoding), _NULL_LIBID.encode(encoding)
+    extended = (struct.pack("<I", len(original)) + original + bytes(6) + UUID(MSFORMS_GUID).bytes_le
+                + struct.pack("<I", 1))
+    return (name + record(0x33, original) + record(0x2F, struct.pack("<I", len(twiddled)) + twiddled + bytes(6))
+            + name + record(0x30, extended))
+
+
 class ReferenceManager:
     """One public reference surface; subclasses supply only storage hooks."""
 
@@ -190,7 +222,7 @@ class ReferenceManager:
                 if span.reference.name.lower() == wanted or (guid and span.reference.guid.lower() == guid)]
         if not cuts:
             return False
-        if any(s.reference.name.lower() == "msforms" or s.reference.guid.upper() == MSFORMS_GUID for s in cuts):
+        if any(is_msforms(s.reference) for s in cuts):
             forms = self._reference_forms()
             if forms:
                 raise self._reference_error(f"Microsoft Forms is required by UserForms: {', '.join(forms)}")
@@ -203,6 +235,18 @@ class ReferenceManager:
         self._write_reference_data(b"".join(parts))
         return True
 
+    def _ensure_forms_reference(self) -> None:
+        """Declare Microsoft Forms as the editor does with a project's first UserForm, unless it is declared.
+
+        remove_reference refuses to take the library out while a form is
+        there; this is the other half of that rule.
+        """
+        raw, code_page = self._reference_data()
+        if any(is_msforms(span.reference) for span in reference_spans(raw)):
+            return
+        at = module_offset(raw)
+        self._write_reference_data(raw[:at] + msforms_block(code_page) + raw[at:])
+
     def drop_reference(self, name: str) -> None:
         """Compatibility spelling: remove, raising when the reference is absent."""
         if not self.remove_reference(name):