Sofu Documentation
BinaryParser0200 Class
NamespacesSofu.SofuBinaryParser0200
This is a parser for binary Sofu files of the version 0.2.0.0
Declaration Syntax
C#
public class BinaryParser0200 : Map
Members
All MembersConstructorsMethods



IconMemberDescription
BinaryParser0200(Stream)
Creates a new Map from an input stream. You must be sure that the stream data is in the binary Sofu format. Otherwise use SofuReader.LoadFile(Stream) instead.

BinaryParser0200(String)
Creates a new Map from a file. You must be sure that the file is binary. Otherwise use SofuReader.LoadFile(Stream) if you aren't sure.

AppendComment(String)
Appends to the comment of this SofuObject
(Inherited from SofuObject.)
AsList()()()
Tries to convert itself to a Sofu.List.
(Inherited from SofuObject.)
AsMap()()()
Tests if this Map is really a Map.
(Inherited from Map.)
AsReference()()()
Seldom used, this allows to access the reference itself, while AsMap, AsList and AsValue access the referenced Object.
(Inherited from SofuObject.)
AsValue()()()
Tries to convert itself to a Sofu.Value
(Inherited from SofuObject.)
AttributeKey(SofuObject)
Tries to find the name of a key for an element. Not implemented for now!.
(Inherited from Map.)
Binarify(String, Stream)
Writes this Map into a binary stream, does no Cross Reference checking.
(Inherited from Map.)
Binary(String, Stream)
Writes this Object into a Stream, does Cross Reference checking.
(Inherited from SofuObject.)
BinaryPack(Stream)
Starts the binary packing as a file.
(Inherited from Map.)
Dup()()()
Creates a shallow copy of itself.
(Inherited from Map.)
Equals(Object) (Inherited from Object.)
Finalize()()() (Inherited from Object.)
GetComment()()()
Accesses the comment of this SofuObject.
(Inherited from SofuObject.)
GetEnumerator()()()
Emumerator for foreach
(Inherited from Map.)
GetHashCode()()() (Inherited from Object.)
GetType()()() (Inherited from Object.)
HasAttribute(String)
Tests if an element exists in this Map.
(Inherited from Map.)
HasComment()()()
Tests if this SofuObject has a comment.
(Inherited from SofuObject.)
HasList(String)
Tests if a specific element in this Map exists and is a Sofu.List
(Inherited from Map.)
HasMap(String)
Tests if a specific element in this Map exists and is a Sofu.Map
(Inherited from Map.)
HasValue(String)
Tests if a specific element in this Map exists and is a Sofu.Value
(Inherited from Map.)
IsDefined()()()
Tests if this SofuObject is anything else than a Sofu.Sofu.Undefined
(Inherited from SofuObject.)
IsList()()()
Tests if this SofuObject is a Sofu.List
(Inherited from SofuObject.)
IsMap()()()
Tests if this Map is really a Map.
(Inherited from Map.)
IsReference()()()
Tests if this SofuObject is a Sofu.Reference
(Inherited from SofuObject.)
IsValue()()()
Tests if this SofuObject is a Sofu.Value
(Inherited from SofuObject.)
Length()()()
Returns the amount key/value pairs in this Map
(Inherited from Map.)
list(String)
Retrives a specifc Sofu.List from this Map indentified by key.
(Inherited from Map.)
map(String)
Retrives a specifc Sofu.Map from this Map indentified by key.
(Inherited from Map.)
MemberwiseClone()()() (Inherited from Object.)
Object(String)
Retrives a specifc SofuObject from this Map indentified by key.
(Inherited from Map.)
Pack()()()
Packs this SofuObject and all those it contains into a string.
(Inherited from SofuObject.)
PackComment(Stream)
Writes the comments of this Object into a Stream
(Inherited from SofuObject.)
PackHeader(Stream)
Creates the Header of a binary sofu file into a stream
(Inherited from SofuObject.)
PackLong(UInt32, Stream)
Packs one unsigned Integer into the output stream
(Inherited from SofuObject.)
PackLong(Int32, Stream)
Packs one unsigned Integer into the output stream
(Inherited from SofuObject.)
PackText(String, Stream)
Writes a text into an output stream
(Inherited from SofuObject.)
RemAttribute(String)
Removes one element from this Map.
(Inherited from Map.)
SetAttribute(String, SofuObject)
Inserts a new element into the Map. Any other element with the same key is replaced
(Inherited from Map.)
SetComment(String)
Sets a comment for this SofuObject.
(Inherited from SofuObject.)
String(String, StringBuilder)
Identifies cross references and calls Stringify with its parameters
(Inherited from SofuObject.)
String(String, TextWriter, Int32)
Identifies cross references and calls Stringify with its parameters
(Inherited from SofuObject.)
Stringify(String, StringBuilder)
Converts this Map and all its attributes to a string representing this Map
(Inherited from Map.)
Stringify(String, TextWriter, Int32)
Converts this Map and all its attributes to a string representing this Map
(Inherited from Map.)
StringML(XmlWriter)
Writes this Object into Xml, does Cross Reference checking.
(Inherited from SofuObject.)
ToString()()() (Inherited from Object.)
TypeString()()()
Used to identify this as a Map
(Inherited from Map.)
value(String)
Retrives a specifc Sofu.Value from this Map indentified by key.
(Inherited from Map.)
Write(TextWriter)
Writes the contents of this SofuObject into a TextWriter
(Inherited from SofuObject.)
Write(String)
Write this SofuObject into a file. Uses the default encoding of UTF-16.
(Inherited from SofuObject.)
Write(String, Encoding)
Write this SofuObject into a file.
(Inherited from SofuObject.)
WriteBinary(Stream, Int32, Endianness)
Writes this SofuObject and all its children into a binary sofu file
(Inherited from SofuObject.)
WriteBinary(Stream, Encoding, Endianness)
Writes this SofuObject and all its children into a binary sofu file
(Inherited from SofuObject.)
WriteBinary(Stream, Encoding)
Writes this SofuObject and all its children into a binary sofu file
(Inherited from SofuObject.)
WriteBinary(Stream, Int32)
Writes this SofuObject and all its children into a binary sofu file
(Inherited from SofuObject.)
WriteBinary(Stream, Endianness)
Writes this SofuObject and all its children into a binary sofu file
(Inherited from SofuObject.)
WriteBinary(Stream)
Writes this SofuObject and all its children into a binary sofu file
(Inherited from SofuObject.)
WriteBinary(String, Int32, Endianness)
Writes this SofuObject and all its children into a binary sofu file
(Inherited from SofuObject.)
WriteBinary(String, Encoding, Endianness)
Writes this SofuObject and all its children into a binary sofu file
(Inherited from SofuObject.)
WriteBinary(String, Encoding)
Writes this SofuObject and all its children into a binary sofu file
(Inherited from SofuObject.)
WriteBinary(String, Int32)
Writes this SofuObject and all its children into a binary sofu file
(Inherited from SofuObject.)
WriteBinary(String, Endianness)
Writes this SofuObject and all its children into a binary sofu file
(Inherited from SofuObject.)
WriteBinary(String)
Writes this SofuObject and all its children into a binary sofu file
(Inherited from SofuObject.)
WriteML(XmlWriter)
Writes this Map into a XMLWriter
(Inherited from Map.)
WriteML(String)
Writes this Object into a SofuML file
(Inherited from SofuObject.)
XMLcomment(XmlWriter)
Writes this Objects comments to XML
(Inherited from SofuObject.)
Xmlify(XmlWriter)
Writes this Map into a XMLWriter
(Inherited from Map.)
Remarks
This class might use BinaryReader sometimes soon. But it can't switch Endianness that easily.
Examples

Load a binary file and write its top level elements

CopyC#
Sofu.Sofu.Map file = SofuReader.LoadFile("file.bsofu"); //binary sofu file: file.bsofu
foreach (KeyValuePair<string,Sofu.SofuObject> entry in file) {
           Console.Write("Key : " + entry.Key + " Value: ");
           Console.WriteLine(entry.Value.AsValue().ToString());
}
Inheritance Hierarchy
Object
SofuObject
 Map
  BinaryParser0200

Assembly: Sofu (Module: Sofu) Version: 0.2.1.0 (0.2.1.0)