pyvbaanalysis 2.2.0__tar.gz → 2.3.0__tar.gz

{pyvbaanalysis-2.2.0 → pyvbaanalysis-2.3.0}/CHANGELOG.md

@@ -5,6 +5,202 @@ All notable changes to pyVBAanalysis are recorded here. The format follows
 follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html): a minor version
 per milestone.
 
+## 2.3.0 - 2026-09-26
+
+Sync to XLIDE 10.14.0 (commit 110c76e), from 10.7.1. Upstream measured the
+analyzer against Excel, Word and PowerPoint 16.0 (build 20326) through
+pyVBAharness and answered each finding (XLIDE issues #96 to #148): 34 new
+diagnostics, 19 of them runtime errors in code the VBE compiles, and false
+positives removed on code that compiles and runs. XLIDE 10.7.2, 10.8.0, 10.11.0
+and 10.12.0 changed nothing the port reads.
+
+The port now returns what XLIDE shows, not its raw rule list, and it analyzes
+procedures nested past Python's recursion limit and long With blocks and member
+chains in linear time.
+
+### Added
+
+* Nineteen runtime errors in code the VBE compiles, each reported as "This will
+  raise Run-time error ...":
+  * Overflow (#116): `arithmetic-overflow` for Integer arithmetic such as
+    `60 * 60 * 24`, an assignment that rounds past its target, and conversions
+    out of range; `for-counter-overflow` for `For i = 1 To 32767` on an Integer.
+  * Control flow (#117): `handler-fall-through` into an error handler that
+    re-raises, `resume-without-error`, `return-without-gosub`, and
+    `recursive-property-accessor`.
+  * Collections and Variants (#121): `collection-index-out-of-range`,
+    `collection-key-not-found`, `collection-key-in-use`, `variant-value-misuse`
+    and `runtime-member-not-found` (438 on a late-bound object).
+  * Host arguments (#122): `host-argument-out-of-range` for index 0 into a
+    1-based Office collection, `Cells(0, 1)` or an Offset off the sheet;
+    `multi-cell-range-as-scalar`; `sheet-name-invalid`.
+  * File statements (#123): `file-number-zero`, `file-used-after-close`,
+    `file-mode-mismatch`, `file-already-open` and `file-record-zero`.
+* Fifteen compile errors: `const-overflow` (#116); `array-parameter-form`,
+  `bracketed-variable-name` and `duplicate-deftype` (#124);
+  `collection-operand`, `sub-used-as-value`, `implements-member-missing`,
+  `implements-member-signature` and `rem-after-then` (#125);
+  `directive-trailing-statement` and `duplicate-const-directive` (#130);
+  `stray-character` for characters VBA does not use and a no-break space
+  (#132); `line-too-long`, `date-literal-invalid` and `float-literal-overflow`
+  (#133).
+* Existing rules report more of what the code states (#118 to #120, #124 to
+  #126): `Asc("")`, `Sqr(-1)`, `Log(0)`, `CLng("abc")`, `"abc" + 1` into a
+  Variant, a divisor local that holds 0, array bounds known from `Split`,
+  `Array` or a Range literal's `Value`, `ReDim a(-1)`, `Next i, j` out of
+  order, and the line continuations the VBE refuses.
+* `AnalyzeModuleOptions.raw_rule_output`: the rules' own list, as upstream's
+  `analyzeModule` returns it, without the two steps below.
+* `resolve_host_member` in `pyvbaanalysis.host`, and `declaredType` on a host
+  model member: the type its library declares, where the model's `returns`
+  is repaired from the reference documentation.
+
+### Changed
+
+* `analyze_module`, and everything built on it, returns what XLIDE shows. A
+  runtime-error finding under `On Error Resume Next`, from that statement to the
+  next `On Error` or the end of the procedure, is dropped, since the error is
+  raised and handled there (`n = UBound(a)` is the usual allocated-array
+  test, XLIDE issue #106). Findings with one code and span are merged, the later
+  one kept. `diagnostics/module_analysis.py` ports both from XLIDE's
+  `analyzeVbaModuleSource`.
+* `member-not-found` works in Word, PowerPoint and Access: their models carry
+  the type libraries' hidden members and prove a member absent where the
+  library marks the interface NONEXTENSIBLE (#127). Document, Form, Report and
+  Control stay open. The data file `excel_closed_types.json` is replaced by
+  `host_closed_types.json`, which covers all four hosts.
+* A host member the type library declares `As Object`, such as `ActiveSheet`
+  or a `Worksheets(1)` item, is late bound (#114).
+* A hex or octal literal is the signed value of its bits: `&H8000` is -32768
+  and `&H80000000` is -2147483648 (#141). `parse_vba_integer_literal` returns
+  that value.
+* The parser opens and closes a block written in a one-line If's tail (#128),
+  reads `Else:` as the If's Else (#129), counts a block keyword restated in both
+  arms of an `#If` once (#130), and reads a numbered one-line If with an `=`
+  condition as an If (#131).
+* An Enum value or Optional default keeps its leading number, so `= 300 - 100`
+  is not the literal -100, and a module's Consts fold once with a procedure's
+  own Consts layered on top (XLIDE 10.13.0).
+
+### Fixed
+
+* False positives on code the VBE compiles and runs (#96 to #115): `Choose` and
+  `Switch` arity, `Open path` without `For`, `On Local Error`, a ReDim that
+  declares its array, `total&+1`, a library qualifier such as `Excel.`, a
+  `#Const` never defined, DAO constants in Access, `Left(Null, 1)`, a string
+  into a Byte array, a division the code guards, the Let and Set pairings of a
+  property, Nothing tracking past a GoSub or an early `Exit For`, two project
+  types sharing an instance, a Public Enum in a class, a Const or parenthesized
+  ByRef argument, `Len` in an Enum value, Option placement after a Deftype, and
+  a Function's return assigned by For, ReDim, `Line Input #` or `Get #`.
+* False positives found by this port's own hunt and fixed upstream in 10.14.0
+  (#140 to #147): `If c Is Nothing Then Set c = New Collection`, `Set a(i) = c`
+  and `AddressOf` a Sub reported as compile errors; Win32 flag Enums such as
+  `GENERIC_READ = &H80000000` as Overflow; `Err.Raise vbObjectError + 513` as
+  error 5; the `;` of `If x Then Debug.Print a; b`; a string default holding a
+  comma in an Implements signature; `32000 \ 2 * 4` folded at the wrong
+  precedence; a For counter in a loop that leaves through `Exit For`; a file
+  reopened after `Reset` or a closing helper, an error handler's `Print #`,
+  and hex file numbers; and an item added through `Set o = c`.
+* Misses from the same issues: `1 Mod 200 * 200` (error 6), `Resume Next`
+  after `On Error GoTo -1` (20), a `Print #` after `Reset` (52), a duplicate
+  key added through an alias (457), and a read-write interface property
+  implemented with its Get alone.
+* `analyze_project` raised RecursionError on a procedure nested about 490 blocks
+  deep, where the VBE compiles a thousand. Every walk over a procedure body now
+  runs on an explicit stack, and `tests/test_deep_nesting.py` fails on one that
+  recurses per block.
+
+### Performance
+
+* A long With block and a long member chain are analyzed in linear time: the
+  pass keeps upstream's With-scan index (XLIDE issue #134) and receiver-chain
+  results (#135). A 500-line With block took 14.2 seconds in 2.2.1 and takes
+  0.19; a 3,000-member chain took 16 seconds and takes 0.56.
+* Expression strings the parser carried on their own are lexed without
+  evicting the module from the token cache, and a test fails if one pass lexes
+  a module twice (#139). On two parts of the differential corpus's Office files
+  (66 modules), 2.3.0 is 12% faster than 2.2.1, new rules included.
+
+### Verified
+
+* Upstream's own 10.14.0 test suite, recorded and replayed through the port:
+  1419 standalone and 992 project calls, identical in code, span and message.
+* The oracle corpus (2155 diagnostics in 1229 modules), 16 real workbooks, 195
+  Office files of every host, 693 further projects (948 modules) and 7 VB6
+  projects: identical findings from both analyzers, compared at what XLIDE
+  shows.
+* Every expectation in the new sync tests was also run through the pinned
+  upstream analyzer.
+
+## 2.2.1 - 2026-09-23
+
+Sync to XLIDE 10.7.1 (commit 6ead73d), from 10.6.0. Upstream fixed how its
+lexer and parser read a handful of lines the VBE compiles (XLIDE issues #82 to
+#90), and the port takes each fix. XLIDE 10.7.0 changed nothing the port reads.
+
+### Added
+
+* `LoadedModule.designer_block`: the export header a reader stripped ahead of
+  `source`, empty when there was none. `designer_block + source` is the module
+  text as read, so a span in the analyzed body can be placed in the file.
+
+### Changed
+
+* A contextual keyword is a `KEYWORD` token only inside the statement that
+  makes it one: `Text` after `Option Compare`, `Step` in a `For` header,
+  `Output` in an `Open` statement. Elsewhere, as in `Dim text As String`, it is
+  an `IDENTIFIER` (XLIDE issue #86). `PtrSafe` joins these words, as it did
+  upstream with issue #41.
+* A comment ending in ` _` runs on through the next line, so its token can span
+  physical lines (#82). A line continuation may have whitespace after its `_`
+  (#83).
+* `1.` lexes as a float and `&17` as an octal literal. `=>`, `=<` and `><` are
+  one operator token, whose `canonical_text` gives the standard spelling (#87).
+
+### Fixed
+
+False positives 2.2.0 reported on code that compiles, and two errors it missed:
+
+* `unreachable-code` on the line after
+  `If conn Is Nothing Then ACCT = CVErr(xlErrNA): Exit Function`. Every
+  statement a one-line `If` runs after a colon belongs to the If (MS-VBAL
+  5.4.2.9). After a `Set x = Nothing` or an `Erase` there, the next line no
+  longer reports an unset object or an unallocated array. A `Set` inside a
+  one-line `If` no longer leaves the object reported as Nothing after it.
+* Findings on the line after a comment ending in ` _` (#82), and a missing
+  `Then` or a call to a variable on the line after a continuation with spaces
+  after its `_` (#83).
+* `If x Then:` read as a block If (#84), and a one-word `EndIf` read as no
+  closer, so the lines after it reported as unreachable (#88).
+* `invalid-expression-syntax` on `1.`, `&17`, `a => b`, `a < > b` and the other
+  spellings the VBE reads (#87). `s = "a" &1`, which the VBE refuses, is now
+  reported, and `s = "a" &9` is still a concatenation.
+* `argument-count` missed on `Needs, 2`: a comma touching the callee opens its
+  argument list, as the VBE reads it (#85).
+* `assignment-object-type-mismatch` on `Shape.Duplicate` assigned to a `Shape`,
+  on `SparklineGroup.SeriesColor` assigned to a `FormatColor`, and on a
+  `Charts` or `Worksheets` collection assigned to a `Sheets` variable (#90).
+* `Err.LastDllError` is spelled the way the VBE writes it (#89).
+* The command line counted lines in a `.cls` or `.frm` export from the end of
+  its designer header (the `VERSION` line and `Begin ... End` block the reader
+  strips before analysis), so a class module's findings printed four lines
+  early and a UserForm's early by the height of its form block. Lines, and the
+  JSON `start` and `end` offsets, now count the file as saved. Modules read
+  from an Office container are numbered as before, since pyOpenVBA reads them
+  without a designer header. The library's spans still index the code body.
+
+### Verified
+
+* Upstream's own 10.7.1 test suite, recorded and replayed through the port:
+  1081 standalone and 936 project calls, every result identical in code, span
+  and message. Before the port changes 24 of them differed, so the replay sees
+  what this release changes.
+* The oracle corpus (1820 diagnostics), 16 real workbooks, 195 Office files of
+  every host, 693 further projects (948 modules) and 7 VB6 projects: identical
+  diagnostics from both analyzers.
+* Against 2.2.0, the largest module (26,721 lines) takes the same CPU time.
+
 ## 2.2.0 - 2026-09-22
 
 Sync to XLIDE 10.6.0 (commit 5682c8f), from 6.2.0: twelve new diagnostics, early

{pyvbaanalysis-2.2.0 → pyvbaanalysis-2.3.0}/CONTRIBUTING.md

@@ -80,7 +80,8 @@ python tools/differential/harness.py projects artifacts/differential/cases/mine.
   the port, rebuilding the project index behind a call made with project context,
   and compares the diagnostics by code, span and message. It finds the gaps
   nothing else exercises: whole checks never ported, fixes older than the last
-  sync point.
+  sync point. The recorded calls are the rules alone, so the port is asked for its
+  `raw_rule_output`.
 * `corpus` runs the oracle corpus through both analyzers, each module standalone
   and with its case's modules as a project.
 * `cases` turns Office files, and folders searched for them and for exported
@@ -88,6 +89,16 @@ python tools/differential/harness.py projects artifacts/differential/cases/mine.
   block of upstream's syntax corpus, and `--host` names a host for the cases no
   file implies one for. `projects` runs a cases file through both analyzers.
 
+`corpus` and `projects` compare what XLIDE shows. Upstream runs its rules
+through `analyzeVbaModuleSource`, which drops a runtime-error finding under
+`On Error Resume Next` and merges findings with one code and span, as
+`analyze_module` does (`pyvbaanalysis/diagnostics/module_analysis.py`). Its own
+additions the port leaves out, the structural block-balance pass and XLIDE's test
+and suppression directives, are cut from its list by keeping only what its rules
+produced (`tools/differential/upstream/shown.mjs`). One step the port lacks does
+remove findings: a procedure marked `'@xlide-test expected-error=N` hides a runtime
+finding for error N. No corpus has one.
+
 `replay`, `corpus` and `projects` exit 1 when anything differs and print what only
 one side reports. Where the port reports more, the port is wrong. Where upstream
 reports more it may be an upstream false positive, so check before porting it.
@@ -104,6 +115,11 @@ run ends. `harness.py unpatch` restores a pin a run left patched, and
 ## Adding or changing a rule
 
 * Port the rule from its XLIDE source; match the behavior, not just the shape.
+* Walk a procedure body with `iter_body_nodes` or `iter_body_nodes_in_context`
+  (`pyvbaanalysis/parser/nodes.py`), not with a function that calls itself for
+  each nested block. XLIDE's walks recurse, which JavaScript's stack absorbs;
+  Python stops at 1,000 frames, and the VBE compiles blocks nested a thousand
+  deep. `tests/test_deep_nesting.py` fails on a walk that recurses per block.
 * A rule ships only with oracle backing. Validate it against the vendored corpus
   and add direct tests for the positive and the no-false-positive control cases.
 * The diagnostic rule registry order is a contract: it is the diagnostic

{pyvbaanalysis-2.2.0 → pyvbaanalysis-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pyvbaanalysis
-Version: 2.2.0
+Version: 2.3.0
 Summary: Pure-Python static analysis for Excel VBA
 Project-URL: Homepage, https://github.com/WilliamSmithEdward/pyVBAanalysis
 Project-URL: Repository, https://github.com/WilliamSmithEdward/pyVBAanalysis

{pyvbaanalysis-2.2.0 → pyvbaanalysis-2.3.0}/docs/api-reference.md

@@ -54,6 +54,9 @@ These are re-exported at the package root for convenience:
   `modules`, the `host` its extension implies, and `referenced_hosts`, the other
   Office libraries its project references (`None` when the reference list could
   not be read).
+* A `LoadedModule` carries a module's `name`, `kind`, and `source` (the code body
+  the analyzer reads), plus `designer_block`, the export header the reader stripped
+  ahead of `source` (empty when there was none).
 * Building blocks: `LoadedModule`, `strip_export_header`, `classify_module_kind`,
   `module_name_from_text`, `loaded_module_from_text`, `WorkbookReadError`,
   `LooseFileReadError`, and the extension sets `LOOSE_EXTENSIONS`,

{pyvbaanalysis-2.2.0 → pyvbaanalysis-2.3.0}/docs/diagnostics-catalogue.md

@@ -1,20 +1,24 @@
 # Diagnostic catalogue
 
-The diagnostic codes pyVBAanalysis can emit, generated from the rule metadata (`tools/generate_diagnostics_catalogue.py`). This table lists the 131 rule-metadata codes across 6 categories. A further 3 structural block-balance codes (`mismatched-end-keyword`, `missing-block-closer`, `unmatched-block-closer`) are emitted by the parser pass and are not in the metadata table, for a full set of 134 codes.
+The diagnostic codes pyVBAanalysis can emit, generated from the rule metadata (`tools/generate_diagnostics_catalogue.py`). This table lists the 165 rule-metadata codes across 6 categories. A further 3 structural block-balance codes (`mismatched-end-keyword`, `missing-block-closer`, `unmatched-block-closer`) are emitted by the parser pass and are not in the metadata table, for a full set of 168 codes.
 
 Each code is reported only when it is provably correct; anything unknown or ambiguous stays quiet (the no-false-positive discipline). The **kind** column says what a code means: a *compile error* is rejected by the VBE compiler, a *runtime error* is a deterministic Run-time error, a *runtime risk* is a likely fault, and *style* is advisory.
 
 Override a code's severity with `AnalyzeModuleOptions.severity_overrides` (or the `severity_overrides` argument of `analyze_project` / the reader functions), keyed by code. Use `"off"`, `"information"`, `"warning"`, or `"error"`; the allowed values per code are constrained by policy (some codes can be downgraded but not disabled). See [docs/usage.md](usage.md).
 
-## Declaration (42)
+## Declaration (46)
 
 | Code | Title | Default | Kind | Spec reference |
 | --- | --- | --- | --- | --- |
+| `array-parameter-form` | Array parameter cannot be ByVal or Optional | error | compile error | MS-VBAL 5.3.1.5; VBE "Array argument must be ByRef" / "Optional argument must be Variant or intrinsic type with a default value" (issue #124, Excel 16.0) |
 | `byval-udt-parameter` | User-defined type parameter cannot be ByVal | error | compile error | MS-VBAL 5.3.1 (parameter passing) / VBE compiler |
+| `const-overflow` | Const value overflows | error | compile error | MS-VBAL 5.6.9.3; VBE compile error: Overflow (issue #116, Excel 16.0) |
 | `const-value-not-constant` | Const value must be a constant expression | error | compile error | MS-VBAL 5.2.4 (Const declaration value is a constant-expression) |
 | `declare-missing-ptrsafe` | Declare statement missing PtrSafe for 64-bit Office | error | compile error | VBA 7 Declare statement PtrSafe requirement for 64-bit Office |
 | `dim-initializer` | Declaration cannot include an initializer (VB.NET syntax) | error | compile error | MS-VBAL 5.2.3.1 |
+| `duplicate-const-directive` | Duplicate #Const | error | compile error | MS-VBAL 3.4.1 #Const; VBE "Duplicate definition" (issue #130, Excel 16.0) |
 | `duplicate-declaration` | Duplicate declaration in the current scope | error | compile error | MS-VBAL 5.2 / 5.3 |
+| `duplicate-deftype` | Duplicate Deftype statement | error | compile error | MS-VBAL 5.2.3.1.3; VBE "Duplicate Deftype statement" (issue #124, Excel 16.0) |
 | `duplicate-enum-member` | Duplicate Enum member | error | compile error | MS-VBAL 5.2.3.4 |
 | `duplicate-module-variable` | Duplicate module-level declaration | error | compile error | MS-VBAL 5.2.3 |
 | `duplicate-option` | Duplicate Option statement | error | compile error | MS-VBAL 5.2.1 (module options) |
@@ -34,7 +38,7 @@ Override a code's severity with `AnalyzeModuleOptions.severity_overrides` (or th
 | `module-declaration-after-procedure` | Module-level declaration after procedure | error | compile error | MS-VBAL 5.2 / 5.3 |
 | `module-declaration-in-procedure` | Module-level declaration inside procedure | error | compile error | MS-VBAL 5.2 / 5.3 |
 | `object-module-public-member` | Invalid public member in object module | error | compile error | VBE compiler: public object-module member restrictions |
-| `option-after-declaration` | Option statement must precede all declarations | error | compile error | MS-VBAL 5.2.1 |
+| `option-after-declaration` | Option statement after a procedure | error | compile error | MS-VBAL 5.2.1 |
 | `optional-udt-parameter` | Optional parameter cannot be a user-defined type | error | compile error | MS-VBAL 5.3.1 (Optional parameter) / VBE compiler |
 | `paramarray-non-variant` | ParamArray elements must be Variant | error | compile error | MS-VBAL 5.3.1.6 |
 | `paramarray-not-last` | ParamArray must be the final parameter | error | compile error | MS-VBAL 5.3.1.6 |
@@ -70,7 +74,7 @@ Override a code's severity with `AnalyzeModuleOptions.severity_overrides` (or th
 | `undeclared-variable` | Variable not defined | error | compile error | MS-VBAL 5.2.4.1.1 |
 | `unknown-call` | Sub or Function not defined | error | compile error | MS-VBAL 5.4.2.1 |
 
-## Semantic (52)
+## Semantic (75)
 
 | Code | Title | Default | Kind | Spec reference |
 | --- | --- | --- | --- | --- |
@@ -80,6 +84,7 @@ Override a code's severity with `AnalyzeModuleOptions.severity_overrides` (or th
 | `argument-object-type-mismatch` | Object argument type mismatch | error | compile error | MS-VBAL 5.3.1 |
 | `argument-shape-mismatch` | Argument shape (array/Type vs scalar) mismatch | error | compile error | MS-VBAL 5.3.1 (argument passing) / VBE compiler: ByRef argument type mismatch; array or user-defined type expected |
 | `argument-type-mismatch` | Argument type mismatch | error | runtime error | MS-VBAL 5.3.1 / runtime type coercion and numeric overflow |
+| `arithmetic-overflow` | Arithmetic overflow | error | runtime error | MS-VBAL 5.6.9.3 operator result types; VBE runtime error 6: Overflow (issue #116, Excel 16.0) |
 | `array-assignment-to-scalar` | Array cannot be assigned to scalar | error | compile error | MS-VBAL 5.4.3 / VBE compiler: Type mismatch |
 | `array-bound-requires-array` | Array bound function requires array | error | compile error | MS-VBAL LBound/UBound / VBE compiler: Expected array |
 | `array-declaration-impossible-bounds` | Array declaration lower bound is greater than upper bound | error | compile error | MS-VBAL 5.2.3.1 (array declaration bounds) |
@@ -88,6 +93,10 @@ Override a code's severity with `AnalyzeModuleOptions.severity_overrides` (or th
 | `assignment-type-mismatch` | Assignment type mismatch | error | runtime error | MS-VBAL 5.4.3 / runtime type coercion and numeric overflow |
 | `byref-argument-type-mismatch` | ByRef argument type mismatch | error | compile error | MS-VBAL 5.3.1 / VBE compiler: ByRef argument type mismatch |
 | `case-outside-select` | Case statement outside Select Case | error | compile error | MS-VBAL 5.4.2.4 |
+| `collection-index-out-of-range` | Collection index out of range | error | runtime error | VBE runtime errors 5 and 9 on VBA.Collection (issue #121, Excel 16.0) |
+| `collection-key-in-use` | Collection key already in use | error | runtime error | VBE runtime error 457 on VBA.Collection (issue #121, Excel 16.0) |
+| `collection-key-not-found` | Collection key not found | error | runtime error | VBE runtime error 5 on VBA.Collection (issue #121, Excel 16.0) |
+| `collection-operand` | Collection used as an operand | error | compile error | VBE "Argument not optional" on a Collection whose default member Item takes an index (issue #125, Excel 16.0) |
 | `const-assignment` | Assignment to a constant | error | compile error | MS-VBAL 5.4.3.1 |
 | `division-by-zero` | Division by zero | error | runtime error | MS-VBAL 5.6 / runtime division by zero |
 | `duplicate-case-else` | Duplicate Case Else in Select Case | error | compile error | MS-VBAL 5.4.2.10 (Select Case) |
@@ -96,9 +105,19 @@ Override a code's severity with `AnalyzeModuleOptions.severity_overrides` (or th
 | `erase-requires-array` | Erase target must be array or Variant | error | compile error | MS-VBAL Erase statement / VBE compiler: Expected array |
 | `exit-outside-block` | Loop exit statement outside matching loop | error | compile error | MS-VBAL 5.4.1.3 |
 | `exit-wrong-proc` | Exit statement does not match the enclosing procedure | error | compile error | MS-VBAL 5.4.1.3 |
+| `file-already-open` | File number opened twice | error | runtime error | VBE runtime error 55: File already open (issue #123, Excel 16.0) |
+| `file-mode-mismatch` | File statement the open mode forbids | error | runtime error | VBE runtime error 54: Bad file mode (issue #123, Excel 16.0) |
+| `file-number-zero` | File number 0 | error | runtime error | VBE runtime error 52: Bad file name or number (issue #123, Excel 16.0) |
+| `file-record-zero` | Record number 0 | error | runtime error | VBE runtime error 63: Bad record number (issue #123, Excel 16.0) |
+| `file-used-after-close` | File statement on a closed file number | error | runtime error | VBE runtime error 52: Bad file name or number (issue #123, Excel 16.0) |
 | `fixed-array-redim` | Fixed-size array cannot be ReDimmed | error | compile error | MS-VBAL ReDim statement |
+| `for-counter-overflow` | For counter overflows after its last pass | error | runtime error | MS-VBAL 5.4.2.3; VBE runtime error 6: Overflow (issue #116, Excel 16.0) |
 | `for-each-control-variable-type` | For Each control variable must be Variant or Object | error | compile error | MS-VBAL 5.4.2.5 |
 | `for-each-source-type` | For Each source must be collection or array | error | compile error | MS-VBAL 5.4.2.5 / VBE compiler: For Each may only iterate over a collection object or an array |
+| `handler-fall-through` | Execution falls into an error handler that re-raises | error | runtime error | VBE runtime error 5 from Err.Raise Err.Number with Err.Number 0 (issue #117, Excel 16.0) |
+| `host-argument-out-of-range` | Host argument out of range | error | runtime error | Office object model: 1-based collections, cell rows and columns from 1 (issue #122, Excel/Word/PowerPoint 16.0) |
+| `implements-member-missing` | Interface member not implemented | error | compile error | MS-VBAL 5.2.4.1; VBE "Object module needs to implement ... for interface ..." (issue #125, Excel 16.0) |
+| `implements-member-signature` | Interface member implemented with another signature | error | compile error | MS-VBAL 5.2.4.1; VBE "Procedure declaration does not match description of event or procedure having the same name" (issue #125, Excel 16.0) |
 | `invalid-assignment-target` | Cannot assign to a literal value | error | compile error | MS-VBAL 5.4.3 (assignment) / VBE compiler |
 | `is-operator-non-object` | 'Is' operator requires object operands | error | compile error | MS-VBAL 5.6 (Is operator) |
 | `late-bound-friend-member` | Friend member reached through a late-bound receiver | error | runtime error | VBE runtime error 438: Object does not support this property or method |
@@ -108,24 +127,32 @@ Override a code's severity with `AnalyzeModuleOptions.severity_overrides` (or th
 | `mid-statement-literal-target` | Mid statement target must be a writable String variable | error | compile error | MS-VBAL 5.4.3.4 (Mid/MidB statement) |
 | `missing-library-reference` | Type library not referenced | error | compile error | VBE compiler: User-defined type not defined |
 | `missing-return-assignment` | Function has no return assignment | warning | runtime risk | VBA Function return variable semantics |
+| `multi-cell-range-as-scalar` | Multi-cell range read as a scalar | error | runtime error | VBE runtime error 13: Type mismatch on a Range value that is an array (issue #122, Excel 16.0) |
 | `next-variable-mismatch` | Next variable does not match active For loop | error | compile error | MS-VBAL 5.4.2.5 |
 | `non-callable-call` | Identifier is not callable | error | compile error | MS-VBAL 5.4.2.1 |
 | `non-scalar-binary-operand` | Operator requires a scalar operand | error | compile error | MS-VBAL 5.6 (binary operators) / VBE compiler: array operand Type mismatch |
 | `object-variable-not-set` | Object variable not set | error | runtime error | VBE runtime error 91: Object variable or With block variable not set |
 | `raiseevent-undeclared-event` | RaiseEvent target is not declared | error | compile error | MS-VBAL RaiseEvent statement: event name resolution |
 | `readonly-member-assignment` | Assignment to a read-only member | error | compile error | VBE compiler: Can't assign to read-only property |
+| `recursive-property-accessor` | Property procedure calls itself | error | runtime error | VBE runtime error 28: Out of stack space (issue #117, Excel 16.0) |
 | `redim-impossible-bounds` | ReDim lower bound is greater than upper bound | error | runtime error | MS-VBAL ReDim statement / VBE compiler runtime error 9 |
 | `redim-preserve-dimension-change` | ReDim Preserve can only resize the last dimension | error | runtime error | MS-VBAL ReDim Preserve statement |
+| `resume-without-error` | Resume with no error handler installed | error | runtime error | VBE runtime error 20: Resume without error (issue #117, Excel 16.0) |
+| `return-without-gosub` | Execution falls into a GoSub target | error | runtime error | VBE runtime error 3: Return without GoSub (issue #117, Excel 16.0) |
 | `runtime-argument-value` | Invalid runtime argument value | error | runtime error | MS-VBAL 5.6 / VBA runtime argument bounds and VBE compiler runtime error 5 |
 | `runtime-conversion-value` | Invalid runtime conversion value | error | runtime error | MS-VBAL 5.6 / VBA runtime conversion and VBE compiler runtime error 13 |
+| `runtime-member-not-found` | Member not found at run time | error | runtime error | VBE runtime error 438: Object doesn't support this property or method (issue #121, Excel 16.0) |
 | `scalar-member-access` | Member access on scalar variable | error | compile error | VBE compiler: Invalid qualifier / Syntax error |
 | `scalar-redim` | Scalar variable cannot be ReDimmed | error | compile error | MS-VBAL ReDim statement / VBE compiler: Expected array |
 | `set-required` | Object assignment requires Set | error | runtime error | VBE runtime error 91: Object variable or With block variable not set (MS-VBAL 5.4.3 / Set statement) |
 | `set-requires-object` | Set assignment requires an object variable | error | compile error | MS-VBAL 5.4.3 |
+| `sheet-name-invalid` | Sheet name Excel refuses | error | runtime error | Excel runtime error 1004: invalid name for a sheet or chart (issue #122, Excel 16.0) |
 | `string-arithmetic-coercion` | Nonnumeric string in numeric expression | error | runtime error | MS-VBAL 5.6 / runtime type coercion |
+| `sub-used-as-value` | Sub used as a value | error | compile error | VBE "Expected Function or variable" (issue #125, Excel 16.0) |
 | `typeof-is-always-false` | 'TypeOf ... Is' is always False | warning | runtime risk | MS-VBAL 5.6 (TypeOf...Is expression) |
 | `unallocated-dynamic-array-access` | Dynamic array is not allocated | error | runtime error | VBE runtime error 9: Subscript out of range |
 | `undefined-label` | Label not defined | error | compile error | MS-VBAL 5.4.1 / VBE compiler: Label not defined |
+| `variant-value-misuse` | Variant value used as another kind | error | runtime error | VBE runtime errors 424 and 13 on a Variant holding a scalar or an array (issue #121, Excel 16.0) |
 
 ## Style (13)
 
@@ -145,23 +172,30 @@ Override a code's severity with `AnalyzeModuleOptions.severity_overrides` (or th
 | `variable-never-read` | Variable is assigned but never read | information | style-policy | MS-VBAL 5.4.3 (assignment) plus dead-code policy |
 | `vba-test-directive` | Invalid VBA test directive | warning | style-policy | VBA test directive comment syntax |
 
-## Syntax (17)
+## Syntax (24)
 
 | Code | Title | Default | Kind | Spec reference |
 | --- | --- | --- | --- | --- |
+| `bracketed-variable-name` | Bracketed name in a variable declaration | error | compile error | MS-VBAL 3.3.5.3 foreign-name; VBE "Syntax error" on Dim [name] (issue #124, Excel 16.0) |
 | `call-requires-parens` | Call statement requires parentheses around arguments | error | compile error | MS-VBAL 5.4.2.1 |
 | `call-statement-forbids-parens` | Standalone zero-argument call cannot use empty parentheses | error | compile error | MS-VBAL 5.4.2.1 |
 | `call-statement-multi-arg-parens` | Standalone call cannot parenthesize multiple arguments | error | compile error | MS-VBAL 5.4.2.1 |
+| `date-literal-invalid` | Date literal the VBE refuses | error | compile error | MS-VBAL 3.3.3 date tokens; VBE "Syntax error" (issue #133, Excel 16.0) |
+| `directive-trailing-statement` | Code after a compiler directive on its line | error | compile error | MS-VBAL 3.4 conditional compilation; VBE "An # ElseIf, # Else, or # EndIf must be preceded by an # If clause" (issue #130, Excel 16.0) |
 | `else-branch-order` | Else branch must be final in conditional block | error | compile error | MS-VBAL 3.4 / 5.4.2.1 |
 | `expression-call-requires-parens` | Function call in an expression requires parentheses around arguments | error | compile error | MS-VBAL 5.6.9 |
+| `float-literal-overflow` | Floating-point literal overflows | error | compile error | MS-VBAL 3.3.2 FLOAT; VBE "Syntax error" on 1E400 (issue #125, Excel 16.0) |
 | `if-missing-then` | If statement is missing Then | error | compile error | MS-VBAL 5.4.2.1 |
 | `if-reserved-keyword-in-condition` | Reserved keyword in If condition | error | compile error | MS-VBAL 5.4.2.1 (If block) / 3.3.5.2 (reserved identifiers) / VBE compiler: Syntax error |
 | `invalid-erase-target` | Erase target must be a variable or array name | error | compile error | MS-VBAL Erase statement |
 | `invalid-explicit-call-target` | Invalid explicit Call target | error | compile error | VBE compiler: Syntax error |
 | `invalid-expression-syntax` | Invalid expression syntax | error | compile error | MS-VBAL 5.6 / VBE compiler: Syntax error |
 | `invalid-line-continuation` | Invalid line continuation | error | compile error | MS-VBAL 3.2.2 |
-| `open-missing-for` | 'Open' statement requires 'For <mode>' | error | compile error | MS-VBAL 5.4.5.1 (Open statement) / VBE compiler |
+| `line-too-long` | Physical line over 1023 characters | error | compile error | VBE line limit: 1023 characters compile, 1024 are refused (issue #133, Excel 16.0) |
+| `open-missing-for` | 'Open' statement mode without 'For', or no 'As' clause | error | compile error | MS-VBAL 5.4.5.1 (Open statement) / VBE compiler |
+| `rem-after-then` | Rem after Then | error | compile error | MS-VBAL 3.3.1 comment / 5.4.2.9 single-line If; VBE "Syntax error" (issue #125, Excel 16.0) |
 | `statement-outside-procedure` | Statement outside procedure | error | compile error | MS-VBAL 5.2 / 5.4 |
+| `stray-character` | Character VBA does not use | error | compile error | MS-VBAL 3.3.1 special-token; VBE "Syntax error" on ; ` { } @ ~ \| and a non-breaking space (issue #132, Excel 16.0) |
 | `suffixed-literal-overflow` | Type-suffixed literal out of range | error | compile error | MS-VBAL 3.3.2 (number tokens / type suffixes) / VBE compiler |
 | `typeof-missing-operand` | 'TypeOf' requires an object expression | error | compile error | MS-VBAL 5.6 (TypeOf...Is) / VBE compiler |
 | `unbalanced-parens` | Unbalanced parentheses | error | compile error | MS-VBAL 3.3.1 |

{pyvbaanalysis-2.2.0 → pyvbaanalysis-2.3.0}/docs/usage.md

@@ -136,6 +136,11 @@ analyze_loose_files(["Module1.bas", "Widget.cls"])     # several, as one project
 skipped for it (see "Whole project vs a single file" below). Use `analyze_loose_files`
 to analyze several files together with shared cross-module context.
 
+Spans index the code body the analyzer reads, which starts after the stripped header.
+`load_loose_module` returns a `LoadedModule` whose `designer_block` holds that header,
+so `line_col(module.designer_block + module.source, len(module.designer_block) + span.start)`
+places a span in the file. The command line reports positions this way.
+
 ### Office macro containers
 
 The container reader reads VBA directly out of an Office file via pyOpenVBA (the one
@@ -291,6 +296,12 @@ project), or an Office macro container, whose extension selects the host model.
 `pyvbaanalysis --version` prints the version, and `python -m pyvbaanalysis` is
 equivalent to the `pyvbaanalysis` command.
 
+Each diagnostic is placed by line and column in the module text as read. For a loose
+file that is the file itself, so the `VERSION` and `Begin ... End` header of a `.cls`
+or `.frm` export counts and the numbers match an editor. For an Office container it
+is the module's stored text, which begins at its `Attribute` lines; the VBE hides
+those lines, so its line numbers run lower by their count.
+
 Flags:
 
 | Flag | Effect |
@@ -336,7 +347,8 @@ diagnostics are reported or a file cannot be read, and `2` for a usage error.
 ]
 ```
 
-`start` and `end` are character offsets; `line` and `column` are 1-based.
+`start` and `end` are character offsets and `line` and `column` are 1-based, all in
+the module text as read (see above).
 
 ## Use in CI
 

{pyvbaanalysis-2.2.0 → pyvbaanalysis-2.3.0}/pyvbaanalysis/__init__.py

@@ -41,7 +41,7 @@ from .reader import (
 )
 from .symbols import ModuleInput, ModuleSymbolKind, ProjectIndex, ProjectIndexOptions
 
-__version__ = "2.2.0"
+__version__ = "2.3.0"
 
 __all__ = [
     "AnalyzeModuleOptions",

{pyvbaanalysis-2.2.0 → pyvbaanalysis-2.3.0}/pyvbaanalysis/call/call_context.py

@@ -142,7 +142,10 @@ def bare_call_statement_target(source: str, span: Span) -> BareCallStatementTarg
         after_close = toks[close + 1] if 0 <= close and close + 1 < len(toks) else None
         if after_close is None or after_close.raw_text in (".", "("):
             return None
-    elif not explicit_call:
+    elif not explicit_call and r != ",":
+        # A comma cannot continue the callee, so it opens the argument list with
+        # or without a space: the VBE reads `Needs, 2` as `Needs , 2`, a missing
+        # first argument and 2 (XLIDE issue #85).
         gap = source[span.start + callee.end : span.start + next_tok.start]
         if _WHITESPACE.search(gap) is None:
             return None

{pyvbaanalysis-2.2.0 → pyvbaanalysis-2.3.0}/pyvbaanalysis/cli.py

@@ -33,6 +33,7 @@ from .project import analyze_project
 from .reader import (
     LOOSE_EXTENSIONS,
     OFFICE_EXTENSIONS,
+    LoadedModule,
     LooseFileReadError,
     WorkbookReadError,
     load_loose_module,
@@ -137,8 +138,7 @@ def _analyze_loose_group(
         whole_project=whole_project,
         inline_suppression=inline_suppression,
     )
-    sources = {m.name: m.source for m in unique}
-    return [_ProjectResult("(loose files)", diagnostics, sources)], warnings, errors
+    return [_ProjectResult("(loose files)", diagnostics, unique)], warnings, errors
 
 
 def _analyze_workbook_group(
@@ -167,8 +167,7 @@ def _analyze_workbook_group(
             host=project.host,
             referenced_hosts=project.referenced_hosts,
         )
-        sources = {m.name: m.source for m in modules}
-        results.append(_ProjectResult(str(path), diagnostics, sources))
+        results.append(_ProjectResult(str(path), diagnostics, modules))
     return results, errors
 
 
@@ -179,11 +178,23 @@ class _ProjectResult:
         self,
         label: str,
         diagnostics: dict[str, list[VbaDiagnostic]],
-        sources: dict[str, str],
+        modules: Sequence[LoadedModule],
     ) -> None:
         self.label = label
         self.diagnostics = diagnostics
-        self.sources = sources
+        self.modules = {module.name: module for module in modules}
+
+
+def _text_as_read(module: LoadedModule | None) -> tuple[str, int]:
+    """A module's text as read, and where the body the analyzer saw starts in it.
+
+    The reader strips a .cls or .frm export's designer block before analysis, so a
+    span indexes the body; shifting it by the block's length places it in the file
+    as saved, which is where a user will look for it.
+    """
+    if module is None:
+        return "", 0
+    return module.designer_block + module.source, len(module.designer_block)
 
 
 def _render_text(results: Sequence[_ProjectResult]) -> str:
@@ -195,10 +206,10 @@ def _render_text(results: Sequence[_ProjectResult]) -> str:
             if not diagnostics:
                 continue
             any_in_project = True
-            source = result.sources.get(module_name, "")
+            text, shift = _text_as_read(result.modules.get(module_name))
             lines.append(f"  {module_name}")
             for diag in diagnostics:
-                line, column = line_col(source, diag.span.start)
+                line, column = line_col(text, shift + diag.span.start)
                 lines.append(
                     f"    {line}:{column} {diag.severity.value} {diag.code}  {diag.message}"
                 )
@@ -207,28 +218,31 @@ def _render_text(results: Sequence[_ProjectResult]) -> str:
     return "\n".join(lines)
 
 
+def _diagnostic_json(diag: VbaDiagnostic, text: str, shift: int) -> dict[str, object]:
+    start = shift + diag.span.start
+    line, column = line_col(text, start)
+    return {
+        "code": diag.code,
+        "severity": diag.severity.value,
+        "message": diag.message,
+        "start": start,
+        "end": shift + diag.span.end,
+        "line": line,
+        "column": column,
+        "spec_reference": diag.spec_reference,
+    }
+
+
 def _render_json(results: Sequence[_ProjectResult]) -> str:
     payload = []
     for result in results:
         modules = []
         for module_name, diagnostics in result.diagnostics.items():
-            source = result.sources.get(module_name, "")
+            text, shift = _text_as_read(result.modules.get(module_name))
             modules.append(
                 {
                     "module": module_name,
-                    "diagnostics": [
-                        {
-                            "code": diag.code,
-                            "severity": diag.severity.value,
-                            "message": diag.message,
-                            "start": diag.span.start,
-                            "end": diag.span.end,
-                            "line": line_col(source, diag.span.start)[0],
-                            "column": line_col(source, diag.span.start)[1],
-                            "spec_reference": diag.spec_reference,
-                        }
-                        for diag in diagnostics
-                    ],
+                    "diagnostics": [_diagnostic_json(diag, text, shift) for diag in diagnostics],
                 }
             )
         payload.append({"project": result.label, "modules": modules})