Update to ReadMe.

Author: SolidsoftReplyDevelopment

README.md

@@ -152,7 +152,7 @@ Each time the Parser calls back to the client code, it provides a ResolvedApplic
 
 ### Performance
 
-The GS1 AI Parser is a high-performance library. As far as possible, parsing operations are carried out on the stack and heap allocations are avoided. This significantly increases the performance of the library and avoids unnecessary garbage collection.
+The GS1 AI Parser is a high-performance library. As far as possible, parsing operations are carried out on the stack and heap allocations are avoided. This significantly increases the performance of the library and avoids unnecessary garbage collection. Internally, modern versions of .NET use SIMD instructions where appropriate to further boost performance.
 
 
 
@@ -164,9 +164,9 @@ If the client application is written using the older .NET Framework, it will not
 
 
 
-To eliminate heap allocations, use ParseEx(). This method is supported only on the .NET 7.0 platform, or higher. Again, there is little difference in performance. However, ParseEx() invokes a ResolvedElementDelegate, passing a ResolvedApplicationIdentifierRef ref struct which lives on the stack.
+To eliminate heap allocations, use ParseEx(). This method is supported only on the .NET 7.0 platform, or higher. ParseEx() does not generally provide any significant performance improvement. However, it invokes a ResolvedElementDelegate, passing a ResolvedApplicationIdentifierRef ref struct which lives on the stack.  ParseEx() is only recommended for use in systems that require reliable high-performance and real-time processing.
+
 
- 
 
 As a broad indication of performance, you could reasonably expect, in an ideal scenario, that a modern CPU can parse 600,000 - 800,000 instances per second of valid barcode data containing four GS1 entities (e.g., unique identifiers on the secondary packaging of medicinal products). Of course, actual performance will depend on other factors, including the version of .NET, the number of errors detected in the barcode data, the performance of your client code, CPU and memory specifications, environmental load on the CPU, etc.
 
@@ -191,6 +191,118 @@ Performance drops when data relationship rules are performed. Memory allocations
 
 
 
+The library is not compiled using pre-jitting ('ready-to-run' - requires the .NET runtime). This could be useful to maximise performance in scenarios where the parser is instantiated and invoked in a one-shot manner. While it is possible to publish multiple pre-jitted images in a NuGet package, there are limitations which make the package harder to use. If you need to pre-jit the code, try pre-jitting your client code. Alternatively, compile and publish the source code yourself.  For example, to publish for the Win-64 platform, use the following command lines:
+
+
+
+dotnet restore -p:PublishReadyToRun=true
+
+dotnet publish .\\Solidsoft.Reply.Parsers.Gs1Ai.csproj -c Release -f net7.0 -r win-x64 -p:PublishReadyToRun=true
+
+
+
+### Interoperability
+
+
+
+The GS1 parser library is CLS-compliant, ensuring good interoperability across different .NET languages.
+
+
+
+#### Native Code Library
+
+Modern versions of .NET provide good support for AOT (Ahead-of-Time) Native code generation. The generated code targets a specific platform (e.g., win-x64) and runs independently of the .NET runtime. Native code libraries can be used by a wide range of compiler technologies, bytecode environments (Java, WASM etc.) and languages. To facilitate this approach to interoperability, we provide the Solidsoft.Reply.Parsers.Gs1Ai.Native.win-x64 project. This project is configured to publish a native code library for win-x64. To build the code, you must ensure you have the correct toolchain installed. For example, Visual Studio users can include the 'Desktop development with C++' workload in their Visual Studio installation to build the code for the win-x64 target platform. See https://learn.microsoft.com/uk-ua/dotnet/core/deploying/native-aot/?tabs=windows%2Cnet8 for additional information. To demonstrate the use of the native code generated by this project, we have included the Solidsoft.Reply.Parsers.Gs1Ai.Native.Tester project. This is a C++ Console application that demonstrates the use of the native GS1 Parser library.
+
+
+
+The native code library exports three functions as a C ABI:
+
+
+
+Gs1Ai\_Callback
+
+Gs1Ai\_SetExceptionCallback
+
+Gs1Ai\_Parse
+
+
+
+Use the first two functions to set the main call-back and an additional call-back for exceptions. Then use Gs1\_Parse to parse the input string.
+
+
+
+void \_\_stdcall Gs1Ai\_Callback(
+
+    wchar\_t\*,        // identifier (UTF-16 on Windows)
+
+    int,             // length of identifier
+
+    wchar\_t\*,        // value (UTF-16 on Windows)
+
+    int,             // length of value
+
+    int,             // entity
+
+    wchar\_t\*,        // Data title (UTF-16 on Windows)
+
+    int,             // Length of data title
+
+    wchar\_t\*,        // Description (UTF-16 on Windows)
+
+    int,             // Length of description
+
+    int,             // Inverse exponent
+
+    int,             // Sequence
+
+    int,             // Is fixed width (1 = true, 0 = false)
+
+    int,             // Is error (1 = true, 0 = false) 
+
+    int,             // Is fatal (1 = true, 0 = false) 
+
+    int,             // Character position 
+
+    int)             // Index
+
+
+
+void \_\_stdcall Gs1Ai\_SetExceptionCallback(
+
+    int,             // Entity
+
+    int,             // Error number
+
+    wchar\_t\*,        // Message (UTF-16 on Windows)
+
+    int,             // length of message
+
+    int,             // Is fatal (1 = true, 0 = false)
+
+    int)             // Offset
+
+
+
+int \_\_stadcall Gs1Ai\_Parse(
+
+    wchar\_t\*,        // Input (UTF-16 on Windows)
+
+    int,             // Length of input
+
+    int,             // Relationship Tests - 0 = None, 1 = Invalid pairs, 2 = All
+
+    int,             // GTIN semantics = 0 = General, 1 = Variable Measure, 2 = Custom
+
+    int,             // Expiry Date semantics - 0 = Trade Item, 1 = Coupon
+
+    int,             // Amount Payable semantics - 0 = Invoice, 1 - Coupon Value
+
+    const wchar\_t\*\*, // GCP list (UTF-16 on Windows)
+
+    int)             // Count of GCPs in list
+
+
+
 ### Validation Errors and Warnings
 
 The GS1 Parser raises errors and warnings in the range of 2000-2499. Each error is categorised as fatal or non-fatal. Warnings are always non-fatal.