Add attribute to declare struct properties relevant for its marshalling.

.idea/.idea.DiscImageChef/.idea/contentModel.xml

@@ -92,8 +92,12 @@
         </e>
       </e>
       <e p="DiscImageChef.CommonTypes" t="IncludeRecursive">
+        <e p="Attributes" t="Include">
+          <e p="MarshallingPropertiesAttribute.cs" t="Include" />
+        </e>
         <e p="DiscImageChef.CommonTypes.csproj" t="IncludeRecursive" />
         <e p="Enums" t="Include">
+          <e p="BitEndian.cs" t="Include" />
           <e p="DeviceType.cs" t="Include" />
           <e p="ErrorNumber.cs" t="Include" />
           <e p="Images.cs" t="Include" />

DiscImageChef.CommonTypes/Attributes/MarshallingPropertiesAttribute.cs

@@ -0,0 +1,65 @@
+// /***************************************************************************
+// The Disc Image Chef
+// ----------------------------------------------------------------------------
+//
+// Filename       : MarshallingPropertiesAttribute.cs
+// Author(s)      : Natalia Portillo <claunia@claunia.com>
+//
+// Component      : Common types.
+//
+// --[ Description ] ----------------------------------------------------------
+//
+//     Declares properties of structs for marshalling.
+//
+// --[ License ] --------------------------------------------------------------
+//
+//     Permission is hereby granted, free of charge, to any person obtaining a
+//     copy of this software and associated documentation files (the
+//     "Software"), to deal in the Software without restriction, including
+//     without limitation the rights to use, copy, modify, merge, publish,
+//     distribute, sublicense, and/or sell copies of the Software, and to
+//     permit persons to whom the Software is furnished to do so, subject to
+//     the following conditions:
+//
+//     The above copyright notice and this permission notice shall be included
+//     in all copies or substantial portions of the Software.
+//
+//     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+//     OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+//     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+//     IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+//     CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+//     TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+//     SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+//
+// ----------------------------------------------------------------------------
+// Copyright © 2011-2019 Natalia Portillo
+// ****************************************************************************/
+
+using System;
+using DiscImageChef.CommonTypes.Enums;
+
+namespace DiscImageChef.CommonTypes.Attributes
+{
+    /// <summary>
+    ///     Defines properties to help marshalling structs from binary data
+    /// </summary>
+    [AttributeUsage(AttributeTargets.Struct)]
+    public class MarshallingPropertiesAttribute : Attribute
+    {
+        /// <summary>c</summary>
+        public BitEndian Endian { get; }
+        /// <summary>
+        ///     Tells if the structure, or any nested structure, has any non-value type (e.g. arrays, strings, etc).
+        /// </summary>
+        public bool HasReferences { get; set; }
+
+        /// <summary>Defines properties to help marshalling structs from binary data</summary>
+        /// <param name="endian">Defines properties to help marshalling structs from binary data</param>
+        public MarshallingPropertiesAttribute(BitEndian endian)
+        {
+            Endian        = endian;
+            HasReferences = true;
+        }
+    }
+}

DiscImageChef.CommonTypes/DiscImageChef.CommonTypes.csproj

@@ -49,6 +49,7 @@
     <Compile Include="..\CICMMetadata\dotnet\cicm.cs">
       <Link>Metadata/cicm.cs</Link>
     </Compile>
+    <Compile Include="Attributes\MarshallingPropertiesAttribute.cs" />
     <Compile Include="Enums\BitEndian.cs" />
     <Compile Include="Enums\DeviceType.cs" />
     <Compile Include="Enums\ErrorNumber.cs" />

DiscImageChef.CommonTypes/Enums/BitEndian.cs

@@ -35,24 +35,17 @@
 // ----------------------------------------------------------------------------
 // Copyright © 2011-2019 Natalia Portillo
 // ****************************************************************************/
+
 namespace DiscImageChef.CommonTypes.Enums
 {
-    /// <summary>
+    /// <summary>Describes the endianness of bits on a data structure</summary>
-    /// Describes the endianness of bits on a data structure
-    /// </summary>
     public enum BitEndian
     {
-        /// <summary>
+        /// <summary>Little-endian, or least significant bit</summary>
-        /// Little-endian, or least significant bit
-        /// </summary>
         Little,
-        /// <summary>
+        /// <summary>Big-endian, or most significant bit</summary>
-        /// Big-endian, or most significant bit
-        /// </summary>
         Big,
-        /// <summary>
+        /// <summary>PDP-11 endian, little endian except for 32-bit integers where the 16 halves are swapped between them</summary>
-        /// PDP-11 endian, little endian except for 32-bit integers where the 16 halves are swapped between them
-        /// </summary>
         Pdp
     }
 }