mirrors/z3
3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2026-02-14 12:51:48 +00:00
Code Activity

copilot: don't use std::format and try using clang-tidy

Browse source
This commit is contained in:
Nuno Lopes 2026-01-14 09:17:49 +00:00
parent d5e0216070
commit 888d2fc480
1 changed files with 13 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

35
.github/workflows/code-conventions-analyzer.md vendored
View file

@ -77,7 +77,7 @@ Z3 uses C++20 (as specified in `.clang-format`). Look for opportunities to use:
- Range-based for loops instead of iterator loops - Range-based for loops instead of iterator loops
- `nullptr` instead of `NULL` or `0` - `nullptr` instead of `NULL` or `0`
- `override` and `final` keywords for virtual functions - `override` and `final` keywords for virtual functions
- Smart pointers (`unique_ptr`, `shared_ptr`) instead of raw pointers - Smart pointers (`unique_ptr`) instead of raw pointers
- Move semantics and `std::move` - Move semantics and `std::move`
- Scoped enums (`enum class`) instead of plain enums - Scoped enums (`enum class`) instead of plain enums
- `constexpr` for compile-time constants - `constexpr` for compile-time constants
@ -98,7 +98,6 @@ Z3 uses C++20 (as specified in `.clang-format`). Look for opportunities to use:
- Three-way comparison operator (`<=>`) - Three-way comparison operator (`<=>`)
- Ranges library - Ranges library
- Coroutines (if beneficial) - Coroutines (if beneficial)
- `std::format` for string formatting (replace stringstream for exceptions)
### 3. Common Library Function Usage ### 3. Common Library Function Usage
@ -121,7 +120,8 @@ Identify opportunities specific to Z3's architecture and coding patterns:
- **Empty destructors**: Trivial destructors that can be removed or use `= default` - **Empty destructors**: Trivial destructors that can be removed or use `= default`
- Destructors with empty body `~Class() {}` - Destructors with empty body `~Class() {}`
- Non-virtual destructors that don't need to be explicitly defined - Non-virtual destructors that don't need to be explicitly defined
- Virtual destructors (keep explicit even if empty for polymorphic classes) - Virtual destructors (keep explicit even if empty for polymorphic classes),
but remove empty overridden destructors since those are implicit
- **Non-virtual destructors**: Analyze consistency and correctness - **Non-virtual destructors**: Analyze consistency and correctness
- Classes with virtual functions but non-virtual destructors (potential issue) - Classes with virtual functions but non-virtual destructors (potential issue)
- Base classes without virtual destructors (check if inheritance is intended) - Base classes without virtual destructors (check if inheritance is intended)
@ -167,11 +167,6 @@ Identify opportunities specific to Z3's architecture and coding patterns:
- Replace with `std::optional<T>` return values - Replace with `std::optional<T>` return values
- Cleaner API that avoids pointer/reference output parameters - Cleaner API that avoids pointer/reference output parameters
**Exception String Construction:**
- Using `stringstream` to build exception messages
- Unnecessary string copies when raising exceptions
- Replace with `std::format` for cleaner, more efficient code
**Bitfield Opportunities:** **Bitfield Opportunities:**
- Structs with multiple boolean flags - Structs with multiple boolean flags
- Small integer fields that could use bitfields - Small integer fields that could use bitfields
@ -208,6 +203,13 @@ Identify opportunities specific to Z3's architecture and coding patterns:
- `glob` to identify file groups for analysis - `glob` to identify file groups for analysis
- `view` to examine specific files in detail - `view` to examine specific files in detail
- `bash` with git commands to check file history - `bash` with git commands to check file history
- If compile_commands.json can be generated with clang, and clang-tidy
is available, run a targeted checkset on the selected files:
- modernize-use-nullptr
- modernize-use-override
- modernize-loop-convert (review carefully)
- bugprone-* (selected high-signal checks)
- performance-* (selected)
3. **Identify patterns** by examining multiple files: 3. **Identify patterns** by examining multiple files:
- Look at 10-15 representative files per major area - Look at 10-15 representative files per major area
@ -421,24 +423,18 @@ For each opportunity, provide:
- **API Improvements**: [Specific function signatures to update] - **API Improvements**: [Specific function signatures to update]
- **Examples**: [File:line references with before/after] - **Examples**: [File:line references with before/after]
### 4.9 Exception String Construction ### 4.9 Array Parameter Modernization
- **Current**: [stringstream usage for building exception messages]
- **Modern**: [std::format opportunities]
- **String Copies**: [Unnecessary copies when raising exceptions]
- **Examples**: [Specific exception construction sites]
### 4.10 Array Parameter Modernization
- **Current**: [Pointer + size parameter pairs] - **Current**: [Pointer + size parameter pairs]
- **Modern**: [std::span usage opportunities] - **Modern**: [std::span usage opportunities]
- **Type Safety**: [How span improves API safety] - **Type Safety**: [How span improves API safety]
- **Examples**: [Function signatures to update] - **Examples**: [Function signatures to update]
### 4.11 Increment Operator Patterns ### 4.10 Increment Operator Patterns
- **Postfix Usage**: [Count of i++ where result is unused] - **Postfix Usage**: [Count of i++ where result is unused]
- **Prefix Preference**: [Places to use ++i instead] - **Prefix Preference**: [Places to use ++i instead]
- **Iterator Loops**: [Heavy iterator usage areas] - **Iterator Loops**: [Heavy iterator usage areas]
### 4.12 Exception Control Flow ### 4.11 Exception Control Flow
- **Current Usage**: [Exceptions used for normal control flow] - **Current Usage**: [Exceptions used for normal control flow]
- **Modern Alternatives**: [std::expected, std::optional, error codes] - **Modern Alternatives**: [std::expected, std::optional, error codes]
- **Performance**: [Impact of exception-based control flow] - **Performance**: [Impact of exception-based control flow]
@ -632,11 +628,6 @@ grep pattern: "return.*nullptr.*&" glob: "src/**/*.{h,cpp}"
grep pattern: "bool.*\(.*\*.*\)|bool.*\(.*&" glob: "src/**/*.h" grep pattern: "bool.*\(.*\*.*\)|bool.*\(.*&" glob: "src/**/*.h"
``` ```
**Find stringstream usage for exceptions:**
```
grep pattern: "stringstream.*throw|ostringstream.*throw" glob: "src/**/*.cpp"
```
**Find pointer + size parameters:** **Find pointer + size parameters:**
``` ```
grep pattern: "\([^,]+\*[^,]*,\s*size_t|, unsigned.*size\)" glob: "src/**/*.h" grep pattern: "\([^,]+\*[^,]*,\s*size_t|, unsigned.*size\)" glob: "src/**/*.h"