OneScript icon indicating copy to clipboard operation
OneScript copied to clipboard

Конвертеры CLR-BSL

Open akpaevj opened this issue 5 months ago • 1 comments

Добавлено автоматическое оборачивание не AutoContext объекта во враппер и возможность установки конвертера clr-bsl значений для свойств и возвращаемых значений методов

Summary by CodeRabbit

  • New Features

    • Support for custom value converters with an interface to implement them.
    • Expose arbitrary CLR objects to the script runtime via a wrapper so annotated members are accessible.
  • Bug Fixes

    • More flexible handling of return values from static constructor calls.
  • Refactor

    • Internal method/property mapping and value conversion updated to integrate converters and improve marshalling.
  • Chores

    • Test debug configuration updated to .NET 8.0.

akpaevj avatar Aug 08 '25 18:08 akpaevj

Walkthrough

Adds a pluggable CLR↔script conversion mechanism: new generic converter interface, attribute-level Converter properties with validation, metadata exposure and instantiation helpers, mapper/marshaller updates to use converters, a NotBslValueWrapper to expose CLR objects to script, and small runtime/debug tweaks.

Changes

Cohort / File(s) Change Summary
Attribute Converter Support
src/OneScript.Core/Contexts/ContextMethodAttribute.cs, src/OneScript.Core/Contexts/ContextPropertyAttribute.cs
Added nullable enable, backing fields for boolean flags, and a Converter property with setter validation (must implement IContextValueConverter<>, non-abstract, non-interface).
Metadata Converter Exposure
src/OneScript.Core/Contexts/ContextMethodInfo.cs, src/OneScript.Core/Contexts/ContextPropertyInfo.cs
Added ConverterType property and methods to initialize/instantiate converters: TryGetConverter(out object) and TryGetStrictConverter<T>(out IContextValueConverter<T>).
Generic Converter Interface
src/OneScript.Core/Contexts/IContextValueConverter.cs
New interface IContextValueConverter<TClr> with ToIValue / ToClr and static helper ImplementsIt(Type).
Method Mapper & Expressions
src/ScriptEngine/Machine/Contexts/ContextMethodMapper.cs
Adjusted expression-tree construction: support optional ConverterType for return conversion, reorder/complete parameter conversion calls, and refactor initializers.
Property Mapping & Conversion
src/ScriptEngine/Machine/Contexts/ContextPropertyMapper.cs
Switched _propertyInfo to ContextPropertyInfo; replaced static converters with instance methods that prefer strict converters and fall back to ContextValuesMarshaller; updated setter/getter conversion usage.
Value Marshalling Enhancements
src/ScriptEngine/Machine/Contexts/ContextValuesMarshaller.cs
Reworked return conversion branching and added handling to wrap CLR types annotated with ContextClassAttribute into NotBslValueWrapper when appropriate.
Non-BSL Value Wrapper
src/ScriptEngine/Machine/NotBslValueWrapper.cs
New class exposing annotated CLR objects to script: caches metadata, reflects properties/methods, converts arguments/returns via converters or marshaller, and implements wrapper invocation/properties.
Type Factory Fallback Handling
src/ScriptEngine/Machine/TypeFactory.cs
FallbackConstructor now accepts IValue or IRuntimeContextInstance returns directly; otherwise converts arbitrary return via ContextValuesMarshaller.ConvertDynamicValue.
Debug Configuration Update
tests/.vscode/launch.json
Updated debug runtime paths from net6.0 to net8.0.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as ScriptEngine/Wrapper
    participant Meta as ContextMethodInfo/ContextPropertyInfo
    participant Conv as IContextValueConverter
    participant Marshaller as ContextValuesMarshaller
    participant CLR as CLR value
    participant IVal as IValue

    Caller->>Meta: Read ConverterType
    alt ConverterType exists
        Caller->>Meta: TryGetConverter(out conv)
        Meta-->>Caller: conv instance
        Caller->>Conv: ToIValue(CLR)
        Conv-->>Caller: IVal
    else no converter
        Caller->>Marshaller: ConvertReturnValue(CLR)
        Marshaller-->>Caller: IVal
    end
sequenceDiagram
    participant Script
    participant Wrapper as NotBslValueWrapper
    participant Under as Underlying CLR object
    participant Meta as ContextMethodInfo
    participant Conv as IContextValueConverter
    participant Marshaller as ContextValuesMarshaller
    participant IVal as IValue

    Script->>Wrapper: CallAsFunction(methodNum, args)
    Wrapper->>Meta: resolve MethodInfo, ConverterType
    alt ConverterType exists
        Wrapper->>Meta: TryGetConverter(out conv)
        Wrapper->>Conv: conv.ToClr(argIValue) for each arg
    else
        Wrapper->>Marshaller: ConvertParams(args) -> CLR args
    end
    Wrapper->>Under: invoke method with CLR args
    Under-->>Wrapper: CLR result
    alt ConverterType exists
        Wrapper->>Conv: conv.ToIValue(result)
        Conv-->>Wrapper: IVal
    else
        Wrapper->>Marshaller: ConvertReturnValue(result)
        Marshaller-->>Wrapper: IVal
    end
    Wrapper-->>Script: ret IVal

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~40 minutes

Suggested reviewers

  • EvilBeaver

Poem

A rabbit nibble, quick and spry,
I stitched converters, let types fly.
CLR and script now shake a paw—
small hops, big bridges, magic law. 🐇✨

✨ Finishing Touches
  • [ ] 📝 Generate Docstrings
🧪 Generate unit tests
  • [ ] Create PR with unit tests
  • [ ] Post copyable unit tests in a comment

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Aug 08 '25 18:08 coderabbitai[bot]