refreshing with latest fixes and implementations from ironfede's repo

https://github.com/ironfede/openmcdf/

Author: salaros

src/shared/OpenMcdf/CFException.cs

@@ -1,9 +1,9 @@
 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at http://mozilla.org/MPL/2.0/.
- *
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. 
+ * 
  * The Original Code is OpenMCDF - Compound Document Format library.
- *
+ * 
  * The Initial Developer of the Original Code is Federico Blaseotto.*/
 
 using System;
@@ -180,8 +180,8 @@ public CFInvalidOperation(string message, Exception innerException)
     /// </summary>
     /// <remarks>
     /// Items are compared by name as indicated by specs.
-    /// Two items with the same name CANNOT be added within
-    /// the same storage or sub-storage.
+    /// Two items with the same name CANNOT be added within 
+    /// the same storage or sub-storage. 
     /// </remarks>
     [Serializable]
     public class CFDuplicatedItemException : CFException
@@ -212,7 +212,7 @@ public CFDuplicatedItemException(string message, Exception innerException)
     }
 
     /// <summary>
-    /// Raised when trying to load a Compound File with invalid, corrupted or mismatched fields (4.1 - specifications)
+    /// Raised when trying to load a Compound File with invalid, corrupted or mismatched fields (4.1 - specifications) 
     /// </summary>
     /// <remarks>
     /// This exception is NOT raised when Compound file has been opened with NO_VALIDATION_EXCEPTION option.

src/shared/OpenMcdf/CFItem.cs

@@ -1,10 +1,10 @@
 
 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at http://mozilla.org/MPL/2.0/.
- *
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. 
+ * 
  * The Original Code is OpenMCDF - Compound Document Format library.
- *
+ * 
  * The Initial Developer of the Original Code is Federico Blaseotto.*/
 
 using System;
@@ -16,7 +16,7 @@ namespace OpenMcdf
     /// </summary>
     /// <example>
     /// <code>
-    ///
+    /// 
     /// const String STORAGE_NAME = "report.xls";
     /// CompoundFile cf = new CompoundFile(STORAGE_NAME);
     ///
@@ -32,7 +32,7 @@ namespace OpenMcdf
     /// cf.RootStorage.VisitEntries(va, true);
     ///
     /// tw.Close();
-    ///
+    /// 
     /// </code>
     /// </example>
     public abstract class CFItem : IComparable<CFItem>
@@ -140,7 +140,7 @@ public String Name
         }
 
         /// <summary>
-        /// Size in bytes of the item. It has a valid value
+        /// Size in bytes of the item. It has a valid value 
         /// only if entity is a stream, otherwise it is setted to zero.
         /// </summary>
         public long Size

src/shared/OpenMcdf/CFStorage.cs

@@ -1,9 +1,9 @@
 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at http://mozilla.org/MPL/2.0/.
- *
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. 
+ * 
  * The Original Code is OpenMCDF - Compound Document Format library.
- *
+ * 
  * The Initial Developer of the Original Code is Federico Blaseotto.*/
 
 
@@ -20,7 +20,7 @@ namespace OpenMcdf
     /// <param name="item">Currently visited <see cref="T:OpenMcdf.CFItem">item</see></param>
     /// <example>
     /// <code>
-    ///
+    /// 
     /// //We assume that xls file should be a valid OLE compound file
     /// const String STORAGE_NAME = "report.xls";
     /// CompoundFile cf = new CompoundFile(STORAGE_NAME);
@@ -108,7 +108,7 @@ private RBTree LoadChildren(int SID)
         /// <exception cref="T:OpenMcdf.CFException">Raised when adding a stream with null or empty name</exception>
         /// <example>
         /// <code>
-        ///
+        /// 
         ///  String filename = "A_NEW_COMPOUND_FILE_YOU_CAN_WRITE_TO.cfs";
         ///
         ///  CompoundFile cf = new CompoundFile();
@@ -119,7 +119,7 @@ private RBTree LoadChildren(int SID)
         ///  sm.SetData(b);
         ///
         ///  cf.Save(filename);
-        ///
+        ///  
         /// </code>
         /// </example>
         public CFStream AddStream(String streamName)
@@ -129,7 +129,7 @@ public CFStream AddStream(String streamName)
             if (String.IsNullOrEmpty(streamName))
                 throw new CFException("Stream name cannot be null or empty");
 
-
+            
 
             IDirectoryEntry dirEntry = DirectoryEntry.TryNew(streamName, StgType.StgStream, this.CompoundFile.GetDirectories());
 
@@ -147,7 +147,7 @@ public CFStream AddStream(String streamName)
             catch (RBTreeException)
             {
                 CompoundFile.ResetDirectoryEntry(dirEntry.SID);
-
+                
                 throw new CFDuplicatedItemException("An entry with name '" + streamName + "' is already present in storage '" + this.Name + "' ");
             }
 
@@ -253,7 +253,7 @@ public CFStream TryGetStream(String streamName)
         /// <exception cref="T:OpenMcdf.CFItemNotFound">Raised if item to delete is not found</exception>
         /// <example>
         /// <code>
-        ///
+        /// 
         /// String FILENAME = "MultipleStorage2.cfs";
         /// CompoundFile cf = new CompoundFile(FILENAME, UpdateMode.ReadOnly, false, false);
         ///
@@ -288,7 +288,7 @@ public CFStorage GetStorage(String storageName)
         /// <exception cref="T:OpenMcdf.CFDisposedException">Raised if trying to delete item from a closed compound file</exception>
         /// <example>
         /// <code>
-        ///
+        /// 
         /// String FILENAME = "MultipleStorage2.cfs";
         /// CompoundFile cf = new CompoundFile(FILENAME, UpdateMode.ReadOnly, false, false);
         ///
@@ -326,7 +326,7 @@ public CFStorage TryGetStorage(String storageName)
         /// <exception cref="T:OpenMcdf.CFException">Raised when adding a storage with null or empty name</exception>
         /// <example>
         /// <code>
-        ///
+        /// 
         ///  String filename = "A_NEW_COMPOUND_FILE_YOU_CAN_WRITE_TO.cfs";
         ///
         ///  CompoundFile cf = new CompoundFile();
@@ -337,7 +337,7 @@ public CFStorage TryGetStorage(String storageName)
         ///  sm.SetData(b);
         ///
         ///  cf.Save(filename);
-        ///
+        ///  
         /// </code>
         /// </example>
         public CFStorage AddStorage(String storageName)
@@ -403,32 +403,32 @@ public void VisitEntries(Action<CFItem> action, bool recursive)
                 return;
             List<IRBNode> subStorages = new List<IRBNode>();
 
-            Action<IRBNode> internalAction =
-                delegate(IRBNode targetNode)
-                {
-                    IDirectoryEntry d = targetNode as IDirectoryEntry;
-                    if (d.StgType == StgType.StgStream)
-                        action(new CFStream(this.CompoundFile, d));
-                    else
-                        action(new CFStorage(this.CompoundFile, d));
+                Action<IRBNode> internalAction =
+                    delegate(IRBNode targetNode)
+                    {
+                        IDirectoryEntry d = targetNode as IDirectoryEntry;
+                        if (d.StgType == StgType.StgStream)
+                            action(new CFStream(this.CompoundFile, d));
+                        else
+                            action(new CFStorage(this.CompoundFile, d));
 
-                    if (d.Child != DirectoryEntry.NOSTREAM)
-                        subStorages.Add(targetNode);
+                        if (d.Child != DirectoryEntry.NOSTREAM)
+                            subStorages.Add(targetNode);
 
-                    return;
-                };
+                        return;
+                    };
 
-            this.Children.VisitTreeNodes(internalAction);
+                this.Children.VisitTreeNodes(internalAction);
 
             if (!recursive || subStorages.Count <= 0)
                 return;
 
-            foreach (IRBNode n in subStorages)
-            {
-                IDirectoryEntry d = n as IDirectoryEntry;
-                (new CFStorage(this.CompoundFile, d)).VisitEntries(action, recursive);
+                    foreach (IRBNode n in subStorages)
+                    {
+                        IDirectoryEntry d = n as IDirectoryEntry;
+                        (new CFStorage(this.CompoundFile, d)).VisitEntries(action, recursive);
+                    }
             }
-        }
 
         /// <summary>
         /// Remove an entry from the current storage and compound file.
@@ -505,7 +505,7 @@ public void Delete(String entryName)
 
                 case StgType.StgStream:
 
-                    // Free directory associated data stream.
+                    // Free directory associated data stream. 
                     CompoundFile.FreeAssociatedData((foundObj as IDirectoryEntry).SID);
 
                     // Remove item from children tree
@@ -537,7 +537,7 @@ public void Delete(String entryName)
             //    if( ((IDirectoryEntry)target).SID>foundObj.SID )
             //    {
             //        ((IDirectoryEntry)target).SID--;
-            //    }
+            //    }                   
 
 
             //    ((IDirectoryEntry)target).LeftSibling--;

src/shared/OpenMcdf/CFStream.cs

@@ -1,9 +1,9 @@
-/* This Source Code Form is subject to the terms of the Mozilla Public
+/* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at http://mozilla.org/MPL/2.0/.
- *
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. 
+ * 
  * The Original Code is OpenMCDF - Compound Document Format library.
- *
+ * 
  * The Initial Developer of the Original Code is Federico Blaseotto.*/
 
 using System;
@@ -53,25 +53,25 @@ public void SetData(Byte[] data)
         /// </summary>
         /// <param name="data">Data buffer to Write</param>
         /// <param name="position">Position into the stream object to start writing from</param>
-        /// <remarks>Current stream will be extended to receive data buffer over
+        /// <remarks>Current stream will be extended to receive data buffer over 
         /// its current size</remarks>
         public void Write(byte[] data, long position)
         {
             this.Write(data, position, 0, data.Length);
         }
 
         /// <summary>
-        /// Write <paramref name="count">count</paramref> bytes of a data buffer to a specific position into
+        /// Write <paramref name="count">count</paramref> bytes of a data buffer to a specific position into 
         /// the current CFStream object starting from the specified position.
         /// </summary>
         /// <param name="data">Data buffer to copy bytes from</param>
         /// <param name="position">Position into the stream object to start writing from</param>
-        /// <param name="offset">The zero-based byte offset in buffer at which to
+        /// <param name="offset">The zero-based byte offset in buffer at which to 
         /// begin copying bytes to the current <see cref="T:OpenMcdf.CFStream">CFStream</see>. </param>
         /// <param name="count">The number of bytes to be written to the current <see cref="T:OpenMcdf.CFStream">CFStream</see> </param>
-        /// <remarks>Current stream will be extended to receive data buffer over
+        /// <remarks>Current stream will be extended to receive data buffer over 
         /// its current size.</remarks>
-        public void Write(byte[] data, long position, int offset, int count)
+        internal void Write(byte[] data, long position, int offset, int count)
         {
             CheckDisposed();
             this.CompoundFile.WriteData(this, data, position, offset, count);
@@ -94,7 +94,7 @@ public void Write(byte[] data, long position, int offset, int count)
         /// </example>
         /// <param name="data">Data bytes to append to this stream</param>
         /// <remarks>
-        /// This method allows user to create stream with more than 2GB of data,
+        /// This method allows user to create stream with more than 2GB of data, 
         /// appending data to the end of existing ones.
         /// Large streams (>2GB) are only supported by CFS version 4.
         /// Append data can also be invoked on streams with no data in order
@@ -136,7 +136,7 @@ public Byte[] GetData()
 
         /// <summary>
         /// Read <paramref name="count"/> bytes associated with the stream object, starting from
-        /// a provided <paramref name="offset"/>. Method returns the effective count of bytes
+        /// a provided <paramref name="offset"/>. Method returns the effective count of bytes 
         /// read.
         /// </summary>
         /// <param name="buffer">Array of bytes that will contain stream data</param>
@@ -145,7 +145,6 @@ public Byte[] GetData()
         /// <param name="count">The maximum number of bytes to be read from the current stream.</param>
         /// <returns>The count of bytes effectively read</returns>
         /// <remarks>Method may read a number of bytes lesser then the requested one.</remarks>
-        /// <example>
         /// <code>
         ///  CompoundFile cf = null;
         ///  byte[] b = Helpers.GetBuffer(1024 * 2, 0xAA); //2MB buffer
@@ -170,7 +169,7 @@ public int Read(byte[] buffer, long position, int count)
 
         /// <summary>
         /// Read <paramref name="count"/> bytes associated with the stream object, starting from
-        /// a provided <paramref name="position"/>. Method returns the effective count of bytes
+        /// a provided <paramref name="position"/>. Method returns the effective count of bytes 
         /// read.
         /// </summary>
         /// <param name="buffer">Array of bytes that will contain stream data</param>
@@ -180,7 +179,6 @@ public int Read(byte[] buffer, long position, int count)
         /// <param name="count">The maximum number of bytes to be read from the current stream.</param>
         /// <returns>The count of bytes effectively read</returns>
         /// <remarks>Method may read a number of bytes lesser then the requested one.</remarks>
-        /// <example>
         /// <code>
         ///  CompoundFile cf = null;
         ///  byte[] b = Helpers.GetBuffer(1024 * 2, 0xAA); //2MB buffer
@@ -197,12 +195,13 @@ public int Read(byte[] buffer, long position, int count)
         /// <exception cref="T:OpenMcdf.CFDisposedException">
         /// Raised when the owner compound file has been closed.
         /// </exception>
-        public int Read(byte[] buffer, long position, int offset, int count)
+        internal int Read(byte[] buffer, long position, int offset, int count)
         {
             CheckDisposed();
             return this.CompoundFile.ReadData(this, position, buffer, offset, count);
         }
 
+
         /// <summary>
         /// Copy data from an existing stream.
         /// </summary>