Extract named constants for 0xf0 pointer shifts

[thedavidmeister]

Summary

• Replaces all 19 occurrences of magic number 0xf0 in shr(0xf0, ...) with named constants per use case
• Each constant documents what the shift extracts and where it's used
• Bytecode is unchanged — constants are inlined by the compiler

Constants introduced:

• OPCODE_FUNCTION_POINTER_SHIFT — LibEval, BaseRainlangExtern, LibIntegrityCheck
• SOURCE_OFFSET_SHIFT — LibEval, LibInterpreterStateDataContract
• ACTIVE_SOURCE_POINTER_SHIFT — LibParseState
• PAREN_POINTER_SHIFT — LibParseState, LibParse
• COMMENT_SEQUENCE_SHIFT — LibParseInterstitial

Closes #475.

Test plan

• Clean build, no warnings
• Creation code tests pass (bytecode unchanged)
• CI green

🤖 Generated with Claude Code

Summary by CodeRabbit

• Refactor
  • Replaced hardcoded bit-shift literals with named constants across parsing, evaluation, integrity, and state handling code to reduce magic numbers and improve maintainability.
  • Introduced centralized shift constants and updated assembly bit-extraction sites to use them.
  • Behavior, control flow, and public APIs remain unchanged.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 131e7500-3075-4bd9-ac37-7eb2e9bf427e

📥 Commits

Reviewing files that changed from the base of the PR and between ec7902d and 5cc2f10.

📒 Files selected for processing (1)

• src/lib/eval/LibEval.sol

🚧 Files skipped from review as they are similar to previous changes (1)

• src/lib/eval/LibEval.sol

---

📝 Walkthrough

Walkthrough

Replaced hardcoded bit-shift literals (0xf0) with named constants for several assembly-extracted values (function-pointer, source-offset, paren pointer, active-source pointer, comment sequence) across eval, parse, integrity, state, and extern code paths. No control flow or semantics were altered.

Changes

Cohort / File(s)	Summary
Eval constants & dispatch src/lib/eval/LibEval.sol	Added OPCODE_FUNCTION_POINTER_SHIFT and SOURCE_OFFSET_SHIFT (both 0xf0) and replaced hardcoded shr(0xf0, ...) uses in opcode dispatch and source-pointer extraction.
Extern & integrity src/abstract/BaseRainlangExtern.sol, src/lib/integrity/LibIntegrityCheck.sol	Replaced inline-assembly shr(0xf0, ...) with shr(OPCODE_FUNCTION_POINTER_SHIFT, ...) when extracting opcode/function pointers.
Parse constants & uses src/lib/parse/LibParseState.sol, src/lib/parse/LibParse.sol	Added ACTIVE_SOURCE_POINTER_SHIFT and PAREN_POINTER_SHIFT (both 0xf0) and replaced shr(0xf0, ...) with these named constants for active-source head and paren-group pointer extraction.
Parse interstitial (comments) src/lib/parse/LibParseInterstitial.sol	Added COMMENT_SEQUENCE_SHIFT (0xf0) and replaced shr(0xf0, ...) with shr(COMMENT_SEQUENCE_SHIFT, ...) in comment delimiter extraction.
Interpreter state deserialization src/lib/state/LibInterpreterStateDataContract.sol	Imported SOURCE_OFFSET_SHIFT and replaced shr(0xf0, mload(cursor)) with shr(SOURCE_OFFSET_SHIFT, mload(cursor)) in unsafeDeserialize.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related issues

• Source linked list uses 16-bit pointers — potential truncation like #473 #476 — The changes add ACTIVE_SOURCE_POINTER_SHIFT and replace shr(0xf0, ...) in LibParseState.sol, matching the objective to name the active/source-pointer shift.
• Extract named constant for function pointer table shift (0xF0) #475 — Directly aligned: extracts a named constant for the function-pointer table shift (0xf0) used across eval, extern, integrity, and state code paths.

Poem

🐰
A nibble, a nibble, the bits now named,
No more mystery where shifts once reigned.
Constants in order, hops light and spry,
I tidy the code and then munch a pie. 🍪

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: extracting hardcoded 0xf0 values into named constants for pointer shifts across multiple files.
Linked Issues check	✅ Passed	The PR fully addresses #475 by replacing ~19 occurrences of 0xf0 shift magic numbers with five named constants (OPCODE_FUNCTION_POINTER_SHIFT, SOURCE_OFFSET_SHIFT, ACTIVE_SOURCE_POINTER_SHIFT, PAREN_POINTER_SHIFT, COMMENT_SEQUENCE_SHIFT) across all required files.
Out of Scope Changes check	✅ Passed	All changes are strictly scoped to extracting 0xf0 shift constants into named constants with no modifications to control flow, logic, or error handling.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch extract-pointer-shift-constant

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

@coderabbitai assess this PR size classification for the totality of the PR with the following criterias and report it in your comment:

S/M/L PR Classification Guidelines:

This guide helps classify merged pull requests by effort and complexity rather than just line count. The goal is to assess the difficulty and scope of changes after they have been completed.

Small (S)

Characteristics:

• Simple bug fixes, typos, or minor refactoring
• Single-purpose changes affecting 1-2 files
• Documentation updates
• Configuration tweaks
• Changes that require minimal context to review

Review Effort: Would have taken 5-10 minutes

Examples:

• Fix typo in variable name
• Update README with new instructions
• Adjust configuration values
• Simple one-line bug fixes
• Import statement cleanup

Medium (M)

Characteristics:

• Feature additions or enhancements
• Refactoring that touches multiple files but maintains existing behavior
• Breaking changes with backward compatibility
• Changes requiring some domain knowledge to review

Review Effort: Would have taken 15-30 minutes

Examples:

• Add new feature or component
• Refactor common utility functions
• Update dependencies with minor breaking changes
• Add new component with tests
• Performance optimizations
• More complex bug fixes

Large (L)

Characteristics:

• Major feature implementations
• Breaking changes or API redesigns
• Complex refactoring across multiple modules
• New architectural patterns or significant design changes
• Changes requiring deep context and multiple review rounds

Review Effort: Would have taken 45+ minutes

Examples:

• Complete new feature with frontend/backend changes
• Protocol upgrades or breaking changes
• Major architectural refactoring
• Framework or technology upgrades

Additional Factors to Consider

When deciding between sizes, also consider:

• Test coverage impact: More comprehensive test changes lean toward larger classification
• Risk level: Changes to critical systems bump up a size category
• Team familiarity: Novel patterns or technologies increase complexity

Notes:

• the assessment must be for the totality of the PR, that means comparing the base branch to the last commit of the PR
• the assessment output must be exactly one of: S, M or L (single-line comment) in format of: SIZE={S/M/L}
• do not include any additional text, only the size classification
• your assessment comment must not include tips or additional sections
• do NOT tag me or anyone else on your comment

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

SIZE=M