pssparser Documentation

pssparser provides a Portable Test and Stimulus Standard (PSS) language parser with C++ and Python APIs. The parser supports both PSS 2.x and PSS 3.0 specifications.

Overview

pssparser is a comprehensive PSS language parser that converts PSS source code into an Abstract Syntax Tree (AST) for further processing. It provides both C++ and Python APIs and includes full support for PSS 3.0 features including monitors, string enhancements, reference collections, and more.

Key Features

• PSS 3.0 Support - Full grammar support for PSS 3.0 (August 2024)

• Monitors - Behavioral coverage with temporal operators

• String Enhancements - String methods and substring operator

• Reference Collections - Collections of reference types

• C++ and Python APIs - Use from either language

• Complete AST - Full abstract syntax tree representation

• High Performance - Fast parsing with minimal memory overhead

Getting Started:

• Quickstart
  • Installing pssparser
  • Trying pssparser
• CLI
  • Basic usage
  • Common options
  • Examples
  • Checker flags
• Checker Plug-in Guide
  • Concept
  • Writing a Checker
  • Declaring Markers
  • Registering via entry_points
  • Ad-hoc Loading
  • Checker Selection
  • Querying the Registry
  • Accessing the AST
• PSS 3.0 Migration Guide
  • Backward Compatibility
  • Breaking Changes
  • New Features
  • Common Migration Patterns
  • Testing Your Migration
  • Known Migration Issues
  • Performance Considerations
  • Getting Help
  • Best Practices
  • Example: Complete Migration
  • Summary
  • See Also

PSS 3.0 Features:

• PSS 3.0 Features
  • Overview
  • Monitors and Behavioral Coverage
  • String Enhancements
  • Reference Collections
  • Procedural Randomization
  • Activity Atomic Blocks
  • Yield Statements
  • Platform Qualifiers
  • Limitations and Known Issues
  • Migration from PSS 2.x
  • See Also
• PSS 3.0 API Documentation
  • AST Nodes for PSS 3.0
  • Visitor API
  • Python API Integration
  • C++ API Usage Examples
  • Best Practices
  • Error Handling
  • Performance Considerations
  • Thread Safety
  • Deprecations
  • See Also

Developer Documentation:

• PSS 3.0 Architecture & Design
  • Overview
  • Architecture Layers
  • Grammar Design
  • AST Design
  • Visitor Implementation
  • Semantic Validation
  • Linking and Resolution
  • Extension Mechanism
  • Performance Considerations
  • Extensibility
  • Design Decisions
  • Testing Strategy
  • Code Quality
  • Future Enhancements
  • See Also
• AST Structure
• AST Usage Guide
  • Getting Started
  • Traversing the AST
  • Working with Expressions
  • Working with Activities
  • Working with Constraints
  • PSS to AST Mapping Examples
  • Advanced Topics
  • Best Practices
  • Common Patterns
  • Error Handling
  • Next Steps
• AST Class Hierarchy
  • Inheritance Overview
  • Complete Class Hierarchy
  • When to Use Which Class
  • Common Design Patterns
  • Next Steps

Reference:

• API Reference
  • Checker Plug-in API
  • Core AST Structure
  • Type System
  • Declarations
  • Expressions
  • Activities
  • Constraints
  • Procedural Code
  • Functions
  • Monitors
  • Templates
  • Symbol Resolution
  • Extensions
  • Type Identifiers