Merge pull request #516 from Inxton/ixc-should-transpile-protected-and-internal-members

Enhance transpilation support for member visibility and data exchange operations

Author: PTKu

docfx/articles/compiler/README.md

@@ -2,6 +2,15 @@
 
 **AXSharp Compiler (`ixc`) translates PLC data structures into C# (PLC .NET Twin), which makes the PLC data available in a structured way for any .NET application.**
 
+### Member visibility and generated code behavior
+
+AXSharp transpilation now supports members declared as `public`, `protected`, and `internal`.
+
+- **Transpilation / twin generation:** `public`, `protected`, and `internal` members can be generated into twin/onliner classes.
+- **Data exchange (Plain/POCO and Shadow mappings):** only `public` members participate in `OnlineToPlain`, `PlainToOnline`, `ShadowToPlain`, `PlainToShadow`, and related `HasChanged` evaluation.
+
+This means non-public members can exist in generated twins but are intentionally excluded from Plain/Shadow data-transfer operations.
+
 ### Adding types and members to the communication over WebAPI
 
 Starting from the version v2.0.0+ of `sld`, to make member or type accessible over the communication there is a need to add pragma `{S7.extern=ReadWrite}` or `{S7.extern=ReadOnly}` in the appropriate place in the code.

docfx/articles/connectors/README.md

@@ -158,6 +158,9 @@ See also
 
 Shadows are off-line value holders. Each primitive type has a shadow property. This property only affects the Online values if explicitly instructed to do so by the program. Shadows are helpful when we need to modify multiple values, but we need to send them into the PLC in one shot.
 
+> [!NOTE]
+> Data exchange mappings are limited to `public` members. Members transpiled as `protected` or `internal` are not included in Online/Shadow/Plain transfer operations.
+
 ### Sending data from online to shadow
 
 ~~~C#
@@ -180,6 +183,8 @@ See also
 
 Onliners are somewhat heavy objects that are well suited for communication with the controller, but they carry too much information that are a burden in some use cases. AXSharp compiler, therefore, creates `Plain/POCO` objects that are light CLR (C#) objects that can retrieve and send data from and to the controller.
 
+Only `public` members are included when converting between online/shadow twins and Plain/POCO objects.
+
 ### Getting POCO object
 
 ~~~C#

src/AXSharp.blazor/src/AXSharp.Presentation.Blazor.Controls/wwwroot/css/operon-variables.css

@@ -142,7 +142,7 @@
     --color-result-inprogress: #0065B3;
     --color-result-exclude: #7866B9;
     --color-result-bypasse: #912B88;
-    --color-result-inconcllusive: #B58840;
+    --color-result-inconclusive: #B58840;
     --color-result-running: #00A2A3;
     --color-result-noaction: #949494;
     /* #end of result colors*/

src/AXSharp.compiler/src/AXSharp.Cs.Compiler/Helpers/SemanticsHelpers.cs

@@ -1,4 +1,4 @@
-// AXSharp.Compiler
+// AXSharp.Compiler
 // Copyright (c) 2023 MTS spol. s r.o.,  and Contributors. All Rights Reserved.
 // Contributors: https://github.com/inxton/axsharp/graphs/contributors
 // See the LICENSE file in the repository root for more information.
@@ -34,8 +34,8 @@ public static (bool isEligible, ITypeDeclaration eligibleType) IsMemberEligibleF
                                     string coBuilder = "", bool warnMissingOrInconsistent = false)
     {
         var eligibility = field.IsEligibleForTranspile(sourceBuilder, warnMissingOrInconsistent);
-        var isEligible = (field.AccessModifier == AccessModifier.Public
-                            && eligibility.isEligibe
+        var isEligible = ((field.AccessModifier == AccessModifier.Public || field.AccessModifier == AccessModifier.Protected || field.AccessModifier == AccessModifier.Internal)
+                            && eligibility.isEligibe 
                             && !IsToBeOmitted(field, sourceBuilder, coBuilder));
 
         return (isEligible, eligibility.eligibleType);
@@ -362,7 +362,7 @@ public static (bool isEligibe, ITypeDeclaration? eligibleType) IsMemberEligibleF
     public static (bool isEligibe, ITypeDeclaration? eligibleType) IsMemberEligibleForConstructor(this IFieldDeclaration field, ISourceBuilder sourceBuilder, string coBuilder = "")
     {
         var eligibility = field.IsMemberEligibleForTranspile(sourceBuilder, coBuilder);
-        return ((field.AccessModifier == AccessModifier.Public && eligibility.isEligible), eligibility.eligibleType);
+        return (eligibility.isEligible, eligibility.eligibleType);
     }
 
     /// <summary>
@@ -377,6 +377,24 @@ public static (bool isEligibe, ITypeDeclaration? eligibleType) IsMemberEligibleF
         return variable.IsMemberEligibleForTranspile(sourceBuilder, coBuilder);
     }
 
+    /// <summary>
+    ///     Determines whether a field member is eligible for data exchange operations
+    ///     (OnlineToPlain, PlainToOnline, PlainToShadow, ShadowToPlain, HasChanged, and POCO generation).
+    ///     Only public members participate in data exchange; internal and private members are excluded.
+    /// </summary>
+    /// <param name="field">Field declaration</param>
+    /// <param name="sourceBuilder">Source builder</param>
+    /// <param name="coBuilder">Co-builder signature (e.g. POCO, Onliner, etc.)</param>
+    /// <param name="warnMissingOrInconsistent">Issues warning when the type is eligible but not available.</param>
+    /// <returns>True when the member is eligible for data exchange.</returns>
+    public static (bool isEligible, ITypeDeclaration eligibleType) IsMemberEligibleForDataExchange(this IFieldDeclaration field, ISourceBuilder sourceBuilder,
+                                    string coBuilder = "", bool warnMissingOrInconsistent = false)
+    {
+        var eligibility = field.IsMemberEligibleForTranspile(sourceBuilder, coBuilder, warnMissingOrInconsistent);
+        var isEligible = eligibility.isEligible && field.AccessModifier == AccessModifier.Public;
+        return (isEligible, eligibility.eligibleType);
+    }
+
     private static bool IsAvailableForComm(this IDeclaration declaration, ISourceBuilder sourceBuilder)
     {
         if (sourceBuilder.CompilerOptions is { IgnoreS7Pragmas: true }) return true;
@@ -449,4 +467,4 @@ public static string AddDocumentationComment(this IDocComment docComment, ISourc
     {
         return docComment.Content;
     }
-}
+}

src/AXSharp.compiler/src/AXSharp.Cs.Compiler/Onliner/CsOnlinerPlainerOnlineToPlainBuilder.cs

@@ -1,4 +1,4 @@
-// AXSharp.Compiler.Cs
+// AXSharp.Compiler.Cs
 // Copyright (c) 2023 MTS spol. s r.o.,  and Contributors. All Rights Reserved.
 // Contributors: https://github.com/inxton/axsharp/graphs/contributors
 // See the LICENSE file in the repository root for more information.
@@ -36,7 +36,7 @@ protected CsOnlinerPlainerOnlineToPlainBuilder(ISourceBuilder sourceBuilder)
 
     public void CreateFieldDeclaration(IFieldDeclaration fieldDeclaration, IxNodeVisitor visitor)
     {
-        var eligible = fieldDeclaration.IsMemberEligibleForTranspile(SourceBuilder, "POCO");
+        var eligible = fieldDeclaration.IsMemberEligibleForDataExchange(SourceBuilder, "POCO");
         if (eligible.isEligible)
         {
             CreateAssignment(fieldDeclaration.Type, fieldDeclaration);
@@ -212,4 +212,4 @@ public void CreateDocComment(IDocComment semanticTypeAccess, ICombinedThreeVisit
     {
         AddToSource(semanticTypeAccess.AddDocumentationComment(SourceBuilder));
     }
-}
+}

src/AXSharp.compiler/src/AXSharp.Cs.Compiler/Onliner/CsOnlinerPlainerPlainToOnlineBuilder.cs

@@ -1,4 +1,4 @@
-// AXSharp.Compiler.Cs
+// AXSharp.Compiler.Cs
 // Copyright (c) 2023 MTS spol. s r.o.,  and Contributors. All Rights Reserved.
 // Contributors: https://github.com/inxton/axsharp/graphs/contributors
 // See the LICENSE file in the repository root for more information.
@@ -36,7 +36,7 @@ protected CsOnlinerPlainerPlainToOnlineBuilder(ISourceBuilder sourceBuilder)
 
     public void CreateFieldDeclaration(IFieldDeclaration fieldDeclaration, IxNodeVisitor visitor)
     {
-        var eligibility = fieldDeclaration.IsMemberEligibleForTranspile(SourceBuilder, "POCO");
+        var eligibility = fieldDeclaration.IsMemberEligibleForDataExchange(SourceBuilder, "POCO");
         if (eligibility.isEligible)
         {
             CreateAssignment(fieldDeclaration.Type, fieldDeclaration);
@@ -215,4 +215,4 @@ public void CreateDocComment(IDocComment semanticTypeAccess, ICombinedThreeVisit
     {
         AddToSource(semanticTypeAccess.AddDocumentationComment(SourceBuilder));
     }
-}
+}

src/AXSharp.compiler/src/AXSharp.Cs.Compiler/Onliner/CsOnlinerPlainerPlainToShadowBuilder.cs

@@ -1,4 +1,4 @@
-// AXSharp.Compiler.Cs
+// AXSharp.Compiler.Cs
 // Copyright (c) 2023 MTS spol. s r.o.,  and Contributors. All Rights Reserved.
 // Contributors: https://github.com/inxton/axsharp/graphs/contributors
 // See the LICENSE file in the repository root for more information.
@@ -35,7 +35,7 @@ protected CsOnlinerPlainerPlainToShadowBuilder(ISourceBuilder sourceBuilder)
 
         public void CreateFieldDeclaration(IFieldDeclaration fieldDeclaration, IxNodeVisitor visitor)
         {
-            var eligibility = fieldDeclaration.IsMemberEligibleForTranspile(SourceBuilder, "POCO");
+            var eligibility = fieldDeclaration.IsMemberEligibleForDataExchange(SourceBuilder, "POCO");
             if (eligibility.isEligible)
             {
                 CreateAssignment(fieldDeclaration.Type, fieldDeclaration);

src/AXSharp.compiler/src/AXSharp.Cs.Compiler/Onliner/CsOnlinerPlainerShadowToPlainBuilder.cs

@@ -1,4 +1,4 @@
-// AXSharp.Compiler.Cs
+// AXSharp.Compiler.Cs
 // Copyright (c) 2023 MTS spol. s r.o.,  and Contributors. All Rights Reserved.
 // Contributors: https://github.com/inxton/axsharp/graphs/contributors
 // See the LICENSE file in the repository root for more information.
@@ -35,7 +35,7 @@ protected CsOnlinerPlainerShadowToPlainBuilder(ISourceBuilder sourceBuilder)
 
         public void CreateFieldDeclaration(IFieldDeclaration fieldDeclaration, IxNodeVisitor visitor)
         {
-            var eligibility = fieldDeclaration.IsMemberEligibleForTranspile(SourceBuilder, "POCO");
+            var eligibility = fieldDeclaration.IsMemberEligibleForDataExchange(SourceBuilder, "POCO");
             if (eligibility.isEligible)
             {
                 CreateAssignment(fieldDeclaration.Type, fieldDeclaration);

src/AXSharp.compiler/src/AXSharp.Cs.Compiler/Onliner/HasChangedBuilder/CsOnlinerHasChangedBuilder.cs

@@ -1,4 +1,4 @@
-// AXSharp.Compiler.Cs
+// AXSharp.Compiler.Cs
 // Copyright (c) 2023 MTS spol. s r.o.,  and Contributors. All Rights Reserved.
 // Contributors: https://github.com/inxton/axsharp/graphs/contributors
 // See the LICENSE file in the repository root for more information.
@@ -35,7 +35,7 @@ protected CsOnlinerHasChangedBuilder(ISourceBuilder sourceBuilder)
 
         public void CreateFieldDeclaration(IFieldDeclaration fieldDeclaration, IxNodeVisitor visitor)
         {
-            var eligibility = fieldDeclaration.IsMemberEligibleForTranspile(SourceBuilder, "POCO");
+            var eligibility = fieldDeclaration.IsMemberEligibleForDataExchange(SourceBuilder, "POCO");
             if (eligibility.isEligible)
             {
                 CreateAssignment(fieldDeclaration.Type, fieldDeclaration);

src/AXSharp.compiler/src/AXSharp.Cs.Compiler/Plain/CsPlainConstructorBuilder.cs

@@ -1,4 +1,4 @@
-// AXSharp.Compiler.Cs
+// AXSharp.Compiler.Cs
 // Copyright (c) 2023 MTS spol. s r.o.,  and Contributors. All Rights Reserved.
 // Contributors: https://github.com/inxton/axsharp/graphs/contributors
 // See the LICENSE file in the repository root for more information.
@@ -66,8 +66,8 @@ public void CreateStructuredType(IStructuredTypeDeclaration structuredTypeDeclar
 
     public void CreateFieldDeclaration(IFieldDeclaration fieldDeclaration, IxNodeVisitor visitor)
     {
-        var eligibility = fieldDeclaration.IsMemberEligibleForConstructor(SourceBuilder);
-        if (eligibility.isEligibe)
+        var eligibility = fieldDeclaration.IsMemberEligibleForDataExchange(SourceBuilder);
+        if (eligibility.isEligible)
         {
             switch (fieldDeclaration.Type)
             {
@@ -192,4 +192,4 @@ public void CreateDocComment(IDocComment semanticTypeAccess, ICombinedThreeVisit
     {
         AddToSource(semanticTypeAccess.AddDocumentationComment(SourceBuilder));
     }
-}
+}