-
-
Notifications
You must be signed in to change notification settings - Fork 30
Merge generics support in mscorlib #245
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
josesimoes
wants to merge
51
commits into
main
Choose a base branch
from
develop
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 37 commits
Commits
Show all changes
51 commits
Select commit
Hold shift + click to select a range
85086ea
Update core library to add support for generics <T> (#242)
josesimoes 2bb1d2d
Work CI-CD
josesimoes f9a9158
Work CI-CD
josesimoes e37e4b8
Work CI-CD
josesimoes 488ab3b
Merge branch 'main' of https://github.com/nanoframework/CoreLibrary i…
josesimoes 6303710
Work CI-CD
josesimoes 7005c52
Fix and improvements in `String` class (#248)
josesimoes fa61139
Merge branch 'main' into develop
josesimoes ed90c8e
Add `Span<T>` and `ReadOnlySpan<T>` (#249)
josesimoes 32a57c5
Add `ByRefLikeGenerics` to runtime features (#250)
josesimoes ab7909f
Remove exclusion of `DebuggerTypeProxyAttribute` (#251)
josesimoes e99e3aa
Add `IsReferenceOrContainsReferences` runtime helper (#252)
josesimoes 03e6ddb
Work CD-CI
josesimoes 412684a
Add collection related interfaces and classes (#253)
josesimoes 3cf3175
Add IntelliSense comments to `Nullable` classes (#254)
josesimoes 5d24cd3
Remove test struct with nested field ref
josesimoes d2b908e
Work CI-CD
josesimoes 668efa7
Bump test framework sub-module @602d512
josesimoes 7c0182d
Merge branch 'main' of https://github.com/nanoframework/CoreLibrary i…
josesimoes 5b23ee9
Add `SZArrayHelper` and `Unsafe.As<T>` (#257)
josesimoes 4738eed
Fixed null references and added == and != overloads in `Guid` (#247)
dcyonce 51be470
Add benchmark tests for ToString
josesimoes ce5c6d8
Fix `Guid` constructor (#259)
josesimoes d92a1c1
Update test framework sub-module @9f6e02c
josesimoes 903c2b2
Work CI-CD
josesimoes b0bf1e3
Work CI-CD
josesimoes 2a79b7a
Work CI-CD
josesimoes 7977eda
Add new constructors to `Span<T>` and `ReadOnlySpan<T>` (#260)
josesimoes 6996df8
Moved `String.Format()` to native (#261)
josesimoes b3427e4
Improvements in `ReadOnlySpan<T>` and `Span<T>` (#262)
josesimoes f4163d3
Work CI-CD
josesimoes 0d014fa
Add `MemoryExtensions` class (#263)
josesimoes ebb5481
Add interfaces for generic collections (#264)
josesimoes bfcba6a
Update test sub-module @2e5c15c
josesimoes 6c93600
Add implicit operator to `Span<T>` to allow conversion from array (#265)
josesimoes 50352eb
Work CI-CD
josesimoes 7c5e825
Add .github/copilot-instructions.md for Copilot cloud agent onboardin…
Copilot 46cf909
Merge branch 'main' into develop
josesimoes c326223
Merge branch 'main' of https://github.com/nanoframework/CoreLibrary i…
josesimoes 2aa5d2a
Fix unit test for `String.Format()` (#269)
josesimoes 1474d8c
Improvements in `String` class (#270)
josesimoes 1d0f540
Fix file
josesimoes 779da80
Rewrote `Guid.CompareTo` (#271)
josesimoes 30df403
Fix `ReadOnlySpan<T>` operator == to use identity semantics (#272)
josesimoes 17440c8
Add unit tests group to release notes config
josesimoes 7a33d32
Update test framework sub-module @521b03b
josesimoes 974d1db
Work CI-CD
josesimoes eac1915
Update test framework sub-module @6aa00b2
josesimoes 9cba9c3
Update test framework sub-module @9d8b809
josesimoes 6cf6098
Merge branch 'main' of https://github.com/nanoframework/CoreLibrary i…
josesimoes 3dd272a
Merge branch 'main' of https://github.com/nanoframework/CoreLibrary i…
josesimoes File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| # Copilot Instructions for nanoFramework CoreLibrary | ||
|
|
||
| ## Repository Overview | ||
|
|
||
| This repository contains the **Base Class Library (BCL)** for [.NET nanoFramework](https://www.nanoframework.net/) — a free, open-source platform that enables writing managed .NET code for embedded systems and microcontrollers. The BCL provides the core `System` namespace types and is the nanoFramework equivalent of `mscorlib`. | ||
|
|
||
| ## Key Architectural Concepts | ||
|
|
||
| ### This Is NOT Standard .NET | ||
| - The code targets embedded systems (MCUs) with severe memory and flash constraints. | ||
| - Many methods are implemented in native C++ ("native stubs") and are declared with `[MethodImpl(MethodImplOptions.InternalCall)]` — **do not add a body to these methods**. | ||
| - Some standard .NET APIs are intentionally unsupported (throw `NotSupportedException`) to preserve assembly/image size. Do not remove these stubs; they exist to satisfy interface contracts. | ||
| - The library targets `TargetFrameworkVersion v1.0` (the nanoFramework target, not desktop .NET). | ||
|
|
||
| ### Two Library Flavours | ||
| | Project | Description | NuGet | | ||
| |---|---|---| | ||
| | `nanoFramework.CoreLibrary` | Full BCL **with** `System.Reflection` | `nanoFramework.CoreLibrary` | | ||
| | `nanoFramework.CoreLibrary.NoReflection` | BCL **without** reflection (smaller flash footprint) | `nanoFramework.CoreLibrary.NoReflection` | | ||
|
|
||
| Both produce an assembly named `mscorlib`. The no-reflection variant excludes files under `System/Reflection/` and sets no `NANOCLR_REFLECTION` define. | ||
|
|
||
| ### Project File Format | ||
| Projects use `.nfproj` files (nanoFramework MSBuild project system), not standard `.csproj`. These require Visual Studio with the **nanoFramework VS extension** installed, or MSBuild with `NFProjectSystem.CSharp.targets`. | ||
|
|
||
| ## Repository Structure | ||
|
|
||
| ``` | ||
| nanoFramework.CoreLibrary/ # Main BCL project (with reflection) | ||
| System/ # All System.* source files | ||
| Collections/ # IEnumerable, ArrayList, generic interfaces | ||
| Diagnostics/ # Debug, Debugger, attributes | ||
| Globalization/ # CultureInfo, DateTimeFormatInfo, etc. | ||
| IO/ # IOException | ||
| Reflection/ # Assembly, MethodInfo, FieldInfo, etc. | ||
| Runtime/ # CompilerServices, InteropServices, Remoting | ||
| Threading/ # Thread, Monitor, Timer, WaitHandle, etc. | ||
| CoreLibrary.nfproj | ||
| Directory.Build.props | ||
|
|
||
| nanoFramework.CoreLibrary.NoReflection/ # BCL without reflection | ||
| System/ # Subset of System.* files (no Reflection/) | ||
| CoreLibrary.NoReflection.nfproj | ||
|
|
||
| Tests/ # Unit tests (one folder per test suite) | ||
| NFUnitTestArithmetic/ | ||
| NFUnitTestArray/ | ||
| NFUnitTestBitConverter/ | ||
| NFUnitTestSystemLib/ # Covers most primitive types, strings, DateTime, etc. | ||
| NFUnitTestThread/ | ||
| ... (21 test suites total) | ||
|
|
||
| nanoFramework.TestFramework/ # Git submodule: test framework source | ||
| azure-pipelines.yml # CI/CD pipeline (Azure Pipelines, Windows) | ||
| nanoFramework.CoreLibrary.sln # Main solution (library + tests) | ||
| nanoFramework.CoreLibrary.Benchmarks.sln # Benchmarks solution | ||
| version.json # Nerdbank.GitVersioning configuration | ||
| ``` | ||
|
|
||
| ## Build & Test | ||
|
|
||
| ### Build Requirements | ||
| - **Windows only** — the nanoFramework build toolchain runs on Windows (Azure Pipelines uses `windows-latest`). | ||
| - Visual Studio 2022 with the nanoFramework VS extension, or MSBuild 17+. | ||
| - NuGet packages are restored automatically; `packages.lock.json` enforces locked restore in CI. | ||
|
|
||
| ### Building | ||
| ```powershell | ||
| # Restore NuGet packages first | ||
| nuget restore nanoFramework.CoreLibrary.sln | ||
|
|
||
| # Build the solution (Release) | ||
| msbuild nanoFramework.CoreLibrary.sln /p:Configuration=Release /p:Platform="Any CPU" | ||
|
|
||
| # Build only CoreLibrary (Debug) | ||
| msbuild nanoFramework.CoreLibrary\CoreLibrary.nfproj /p:Configuration=Debug | ||
| ``` | ||
|
|
||
| ### Running Tests | ||
| Tests use the [nanoFramework.TestFramework](https://github.com/nanoframework/nanoFramework.TestFramework) with the **nanoCLR Win32 emulator** (no real hardware needed by default). | ||
|
|
||
| ```powershell | ||
| # From Developer Command Prompt for VS 2022: | ||
| vstest.console.exe .\Tests\NFUnitTestBitConverter\bin\Release\NFUnitTest.dll ^ | ||
| /Settings:.\.runsettings ^ | ||
| /TestAdapterPath:.\nanoFramework.TestFramework\source\TestAdapter\bin\Debug\net4.8 | ||
|
|
||
| # Run all tests using runsettings: | ||
| # .runsettings -> uses preview nanoCLR from NuGet (default) | ||
| # local_clr.runsettings -> uses a locally built nanoCLR | ||
| ``` | ||
|
|
||
| Key runsettings config: | ||
| - `IsRealHardware=False` — runs on emulator | ||
| - `UsePreviewClr=True` — downloads latest preview nanoCLR | ||
| - `MaxCpuCount=1` — tests run sequentially | ||
| - `TestSessionTimeout=1200000` (20 min) | ||
|
|
||
| ### Adding Tests | ||
| - Each test suite is a separate `.nfproj` in `Tests/`. | ||
| - Use `nanoFramework.TestFramework` attributes: `[TestClass]`, `[TestMethod]`, `[Setup]`, `[Cleanup]`, `[DataRow]`. | ||
| - **Do not** reference the NuGet `nanoFramework.TestFramework` — use the project reference from `nanoFramework.TestFramework/` submodule instead (this is required for the CoreLibrary because it replaces mscorlib). | ||
| - **Do not** reference `mscorlib`, `nanoFramework.TestFramework`, or `nanoFramework.UnitTestLauncher` NuGet packages; use project references. | ||
| - Every new API **must** have test coverage for all methods, properties, events, and exceptions. | ||
|
|
||
| ## Coding Conventions | ||
|
|
||
| ### File Header | ||
| Every `.cs` file must begin with: | ||
| ```csharp | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
| ``` | ||
|
|
||
| ### Naming | ||
| | Item | Convention | Example | | ||
| |---|---|---| | ||
| | Constants | PascalCase | `MaxValue` | | ||
| | Private/internal fields | `_camelCase` | `_thread` | | ||
| | Private/internal static fields | `s_camelCase` | `s_instance` | | ||
| | Public members | PascalCase | `GetEnumerator` | | ||
|
|
||
| ### Formatting (from `.editorconfig`) | ||
| - Indent: 4 spaces (C#), 2 spaces (XML/project files) | ||
| - Line endings: CRLF | ||
| - Encoding: UTF-8 BOM | ||
| - Always use braces, even for single-line blocks | ||
| - `using` directives outside namespace | ||
| - System directives first | ||
|
|
||
| ### C# Language | ||
| - Language version: C# 13.0 (main project); `default` for NoReflection variant | ||
| - Avoid `var` — use explicit types | ||
| - Prefer expression-bodied members where appropriate | ||
| - `[MethodImpl(MethodImplOptions.InternalCall)]` for native implementations — never add a body | ||
|
|
||
| ### Assembly Size Awareness | ||
|
josesimoes marked this conversation as resolved.
|
||
| - Avoid adding features that significantly increase binary size. | ||
| - Throw `NotSupportedException` (without a message string) when a method cannot be implemented on the constrained target. | ||
| - Comment rationale when omitting functionality for size reasons. | ||
|
|
||
| ## CI/CD Pipeline | ||
|
|
||
| CI runs on **Azure Pipelines** (`azure-pipelines.yml`), not GitHub Actions. There is no GitHub Actions CI workflow for the main build. The pipeline: | ||
| 1. Builds `nanoFramework.CoreLibrary.sln` on Windows | ||
| 2. Runs all unit tests with nanoCLR emulator | ||
| 3. Packages and publishes two NuGet packages | ||
| 4. Updates dependent repositories on tag releases | ||
|
|
||
| ## Important Notes for Contributions | ||
|
|
||
| 1. **Avoid breaking native interop**: Methods marked `[MethodImpl(MethodImplOptions.InternalCall)]` have matching native C++ implementations in the nanoFramework interpreter. Changing their signatures requires coordinated changes to the native runtime. | ||
| 2. **Two-project sync**: When adding or removing files from `nanoFramework.CoreLibrary`, evaluate whether the same change applies to `nanoFramework.CoreLibrary.NoReflection`. Reflection-related files belong only in the main project. | ||
| 3. **Versioning**: Versions are managed by [Nerdbank.GitVersioning](https://github.com/dotnet/Nerdbank.GitVersioning) via `version.json`. Do not manually edit version numbers. | ||
| 4. **Assembly signing**: The assembly is strong-named with `key.snk`. Do not replace or remove this file. | ||
| 5. **`Friends.cs`**: This file declares `InternalsVisibleTo` attributes for test projects. Add new test projects here if they need access to internals. | ||
|
|
||
| ## Known Constraints & Workarounds | ||
|
|
||
| - The build requires Windows and the nanoFramework MSBuild extension. Running builds in a Linux environment (e.g., standard GitHub Actions) will fail because `NFProjectSystem.CSharp.targets` is not available there. | ||
| - Tests must be run via `vstest.console.exe` with the nanoFramework test adapter; standard `dotnet test` does not work. | ||
| - The `RestoreLockedMode` is enabled in CI to prevent unexpected package version changes — if packages need updating, the `packages.lock.json` must be regenerated and committed. | ||
| - Some APIs intentionally throw `NotSupportedException` or return stub values — this is by design for embedded constraints, not a bug. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using System; | ||
| using System.Runtime.CompilerServices; | ||
| using nanoFramework.TestFramework; | ||
|
|
||
| namespace NFUnitTestSystemLib | ||
| { | ||
| [TestClass] | ||
| class RuntimeHelpersTests | ||
| { | ||
| [TestMethod] | ||
| public static void IsReferenceOrContainsReferences() | ||
| { | ||
| Assert.IsFalse(RuntimeHelpers.IsReferenceOrContainsReferences<int>()); | ||
| Assert.IsTrue(RuntimeHelpers.IsReferenceOrContainsReferences<string>()); | ||
| Assert.IsFalse(RuntimeHelpers.IsReferenceOrContainsReferences<Guid>()); | ||
| Assert.IsFalse(RuntimeHelpers.IsReferenceOrContainsReferences<StructWithoutReferences>()); | ||
| Assert.IsTrue(RuntimeHelpers.IsReferenceOrContainsReferences<StructWithReferences>()); | ||
| Assert.IsFalse(RuntimeHelpers.IsReferenceOrContainsReferences<RefStructWithoutReferences>()); | ||
| Assert.IsTrue(RuntimeHelpers.IsReferenceOrContainsReferences<RefStructWithReferences>()); | ||
| Assert.IsTrue(RuntimeHelpers.IsReferenceOrContainsReferences<Span<char>>()); | ||
| Assert.IsTrue(RuntimeHelpers.IsReferenceOrContainsReferences<ReadOnlySpan<char>>()); | ||
| //Assert.IsTrue(RuntimeHelpers.IsReferenceOrContainsReferences<RefStructWithRef>()); | ||
| //Assert.IsTrue(RuntimeHelpers.IsReferenceOrContainsReferences<RefStructWithNestedRef>()); | ||
| } | ||
|
|
||
| private struct StructWithoutReferences | ||
| { | ||
| public int a, b, c; | ||
| } | ||
|
|
||
| private struct StructWithReferences | ||
| { | ||
| public int a, b, c; | ||
| public object d; | ||
| } | ||
|
|
||
| private ref struct RefStructWithoutReferences | ||
| { | ||
| public int a; | ||
| public long b; | ||
| } | ||
|
|
||
| private ref struct RefStructWithReferences | ||
| { | ||
| public int a; | ||
| public object b; | ||
| } | ||
|
|
||
| // TODO: add after checking viability of ref fields in ref structs | ||
| //private ref struct RefStructWithRef | ||
| //{ | ||
| // public ref int a; | ||
|
|
||
| // internal RefStructWithRef(ref int aVal) | ||
| // { | ||
| // a = ref aVal; | ||
| // } | ||
| //} | ||
|
|
||
| //private ref struct RefStructWithNestedRef | ||
| //{ | ||
| // public Span<char> a; | ||
| //} | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.