Documentation Overview
VB6Parse provides comprehensive documentation for both API usage and the internal workings of the VB6 file format parsers. Whether you're using the library or contributing to it, you'll find the information you need here.
API Documentation
🚀 Getting Started
Step-by-step tutorial covering installation, basic parsing, error handling, and common use cases.
- Installation and setup
- Your first parse
- Error handling patterns
- CST navigation examples
- Common use cases
📚 VB6 Library Reference
Comprehensive reference documentation for all 160+ VB6 built-in functions and 40+ statements with syntax, examples, and detailed explanations.
- Functions (Arrays, Math, String, DateTime, etc.)
- Statements (File Operations, Control Flow, etc.)
- Syntax and parameter details
- Comprehensive code examples
- Searchable reference
📖 API Reference (docs.rs)
Complete Rust API documentation with examples for all public types, functions, and modules. Generated from inline documentation comments.
- All public APIs documented
- Usage examples
- Type signatures and traits
- Module organization
💡 Code Examples
Practical examples demonstrating how to use VB6Parse for common tasks.
- Parsing projects, forms, and modules
- Tokenization and CST navigation
- Working with controls and properties
- Resource file handling
📦 Crates.io Package
Official package page with version history, dependencies, and installation instructions.
- Version history and downloads
- Dependency information
- README and quick start
- License and metadata
Technical Documentation
Deep-dive technical specifications and architecture documentation for understanding VB6 file formats and the parser implementation.
📄 FRX Format Specification
Complete specification of the Visual Basic 6 Form Resource file format (.frx).
- Binary file structure and entry types
- Header formats (12-byte, 4-byte, 3-byte, 1-byte)
- Detection algorithms
- Property data storage and encoding
- Cross-referencing with .frm files
- Parsing considerations and edge cases
🏗️ Form File Parsing Architecture
In-depth explanation of the FormFile parser architecture and design decisions.
- Hybrid parsing strategy
- Direct extraction vs CST building
- Performance optimization techniques
- Control hierarchy and property mapping
- Error handling and partial success model
- Design philosophy and trade-offs
📐 ANTLR4 Grammar Specification
Reference documentation for the Visual Basic 6.0 ANTLR4 grammar specification.
- Complete VB6 grammar rules
- Module structure and organization
- Statement types and control flow
- Expression parsing and operators
- Lexer rules and token definitions
- Comparison with VB6Parse implementation
Testing & Performance
Comprehensive testing and performance metrics demonstrating code quality and parser efficiency.
📊 Test Coverage Report
Comprehensive test coverage metrics generated from 5,676 tests.
- Line, function, and region coverage percentages
- File-by-file coverage breakdown
- Interactive coverage explorer
- Real-time filtering and search
⚡ Performance Benchmarks
Criterion benchmark results showing parser performance metrics.
- Mean, median, and standard deviation
- Benchmark comparison and rankings
- Interactive benchmark explorer
- Real-time filtering and search
Contributing
Additional Resources
📚 VB6 Library Reference
Documentation of 160+ built-in VB6 library functions and 42 statements organized by category (array, string, math, file I/O, etc.)
🎨 Control Types
Reference for 50+ VB6 control types including all properties, supported in the type-safe control system.
🧪 Testing Guide
Information about the 5,600+ test suite including unit tests, integration tests, snapshot testing, and fuzz testing.
⚡ Benchmarking
Performance benchmarks and optimization guidelines for parsing VB6 projects at scale.