-Documentation

-Performance
This commit is contained in:
James Newton-King
2012-11-01 17:32:05 +13:00
parent d92b8ceeb5
commit 92ce080f24
14 changed files with 1023 additions and 343 deletions
+78 -88
View File
@@ -54,7 +54,6 @@ namespace Newtonsoft.Json
Array,
ConstructorStart,
Constructor,
Bytes,
Closed,
Error
}
@@ -69,7 +68,7 @@ namespace Newtonsoft.Json
/* StartObject */new[]{ State.ObjectStart, State.ObjectStart, State.Error, State.Error, State.ObjectStart, State.ObjectStart, State.ObjectStart, State.ObjectStart, State.Error, State.Error },
/* StartArray */new[]{ State.ArrayStart, State.ArrayStart, State.Error, State.Error, State.ArrayStart, State.ArrayStart, State.ArrayStart, State.ArrayStart, State.Error, State.Error },
/* StartConstructor */new[]{ State.ConstructorStart, State.ConstructorStart, State.Error, State.Error, State.ConstructorStart, State.ConstructorStart, State.ConstructorStart, State.ConstructorStart, State.Error, State.Error },
/* StartProperty */new[]{ State.Property, State.Error, State.Property, State.Property, State.Error, State.Error, State.Error, State.Error, State.Error, State.Error },
/* Property */new[]{ State.Property, State.Error, State.Property, State.Property, State.Error, State.Error, State.Error, State.Error, State.Error, State.Error },
/* Comment */new[]{ State.Start, State.Property, State.ObjectStart, State.Object, State.ArrayStart, State.Array, State.Constructor, State.Constructor, State.Error, State.Error },
/* Raw */new[]{ State.Start, State.Property, State.ObjectStart, State.Object, State.ArrayStart, State.Array, State.Constructor, State.Constructor, State.Error, State.Error },
/* Value (this will be copied) */new[]{ State.Start, State.Object, State.Error, State.Error, State.Array, State.Array, State.Constructor, State.Constructor, State.Error, State.Error }
@@ -157,7 +156,7 @@ namespace Newtonsoft.Json
return JsonPosition.BuildPath(positions);
}
}
/// <summary>
/// Gets the state of the writer.
/// </summary>
@@ -316,10 +315,15 @@ namespace Newtonsoft.Json
/// Writes the beginning of a Json object.
/// </summary>
public virtual void WriteStartObject()
{
InternalWriteStart(JsonToken.StartObject, JsonContainerType.Object);
}
internal void InternalWriteStart(JsonToken token, JsonContainerType container)
{
UpdateScopeWithFinishedValue();
AutoComplete(JsonToken.StartObject);
Push(JsonContainerType.Object);
AutoComplete(token);
Push(container);
}
/// <summary>
@@ -327,7 +331,7 @@ namespace Newtonsoft.Json
/// </summary>
public virtual void WriteEndObject()
{
AutoCompleteClose(JsonContainerType.Object);
InternalWriteEnd(JsonContainerType.Object);
}
/// <summary>
@@ -335,9 +339,7 @@ namespace Newtonsoft.Json
/// </summary>
public virtual void WriteStartArray()
{
UpdateScopeWithFinishedValue();
AutoComplete(JsonToken.StartArray);
Push(JsonContainerType.Array);
InternalWriteStart(JsonToken.StartArray, JsonContainerType.Array);
}
/// <summary>
@@ -345,7 +347,7 @@ namespace Newtonsoft.Json
/// </summary>
public virtual void WriteEndArray()
{
AutoCompleteClose(JsonContainerType.Array);
InternalWriteEnd(JsonContainerType.Array);
}
/// <summary>
@@ -354,9 +356,7 @@ namespace Newtonsoft.Json
/// <param name="name">The name of the constructor.</param>
public virtual void WriteStartConstructor(string name)
{
UpdateScopeWithFinishedValue();
AutoComplete(JsonToken.StartConstructor);
Push(JsonContainerType.Constructor);
InternalWriteStart(JsonToken.StartConstructor, JsonContainerType.Constructor);
}
/// <summary>
@@ -364,7 +364,12 @@ namespace Newtonsoft.Json
/// </summary>
public virtual void WriteEndConstructor()
{
AutoCompleteClose(JsonContainerType.Constructor);
InternalWriteEnd(JsonContainerType.Constructor);
}
internal void InternalWriteEnd(JsonContainerType container)
{
AutoCompleteClose(container);
}
/// <summary>
@@ -372,6 +377,11 @@ namespace Newtonsoft.Json
/// </summary>
/// <param name="name">The name of the property.</param>
public virtual void WritePropertyName(string name)
{
InternalWritePropertyName(name);
}
internal void InternalWritePropertyName(string name)
{
_currentPosition.PropertyName = name;
AutoComplete(JsonToken.PropertyName);
@@ -564,21 +574,6 @@ namespace Newtonsoft.Json
}
}
private JsonContainerType GetTypeForCloseToken(JsonToken token)
{
switch (token)
{
case JsonToken.EndObject:
return JsonContainerType.Object;
case JsonToken.EndArray:
return JsonContainerType.Array;
case JsonToken.EndConstructor:
return JsonContainerType.Constructor;
default:
throw JsonWriterException.Create(this, "No type for token: " + token, null);
}
}
private JsonToken GetCloseTokenForType(JsonContainerType type)
{
switch (type)
@@ -699,22 +694,16 @@ namespace Newtonsoft.Json
{
WriteValueDelimiter();
}
else if (_currentState == State.Property)
{
if (_formatting == Formatting.Indented)
WriteIndentSpace();
}
if (_formatting == Formatting.Indented)
{
WriteState writeState = WriteState;
if (_currentState == State.Property)
WriteIndentSpace();
// don't indent a property when it is the first token to be written (i.e. at the start)
if ((tokenBeingWritten == JsonToken.PropertyName && writeState != WriteState.Start) ||
writeState == WriteState.Array || writeState == WriteState.Constructor)
{
if ((_currentState == State.Array || _currentState == State.ArrayStart || _currentState == State.Constructor || _currentState == State.ConstructorStart)
|| (tokenBeingWritten == JsonToken.PropertyName && _currentState != State.Start))
WriteIndent();
}
}
_currentState = newState;
@@ -725,6 +714,11 @@ namespace Newtonsoft.Json
/// Writes a null value.
/// </summary>
public virtual void WriteNull()
{
InternalWriteNull();
}
internal void InternalWriteNull()
{
UpdateScopeWithFinishedValue();
AutoComplete(JsonToken.Null);
@@ -734,6 +728,11 @@ namespace Newtonsoft.Json
/// Writes an undefined value.
/// </summary>
public virtual void WriteUndefined()
{
InternalWriteUndefined();
}
internal void InternalWriteUndefined()
{
UpdateScopeWithFinishedValue();
AutoComplete(JsonToken.Undefined);
@@ -744,6 +743,11 @@ namespace Newtonsoft.Json
/// </summary>
/// <param name="json">The raw JSON to write.</param>
public virtual void WriteRaw(string json)
{
InternalWriteRaw();
}
internal void InternalWriteRaw()
{
}
@@ -764,9 +768,14 @@ namespace Newtonsoft.Json
/// </summary>
/// <param name="value">The <see cref="String"/> value to write.</param>
public virtual void WriteValue(string value)
{
InternalWriteValue(JsonToken.String);
}
internal void InternalWriteValue(JsonToken token)
{
UpdateScopeWithFinishedValue();
AutoComplete(JsonToken.String);
AutoComplete(token);
}
/// <summary>
@@ -775,8 +784,7 @@ namespace Newtonsoft.Json
/// <param name="value">The <see cref="Int32"/> value to write.</param>
public virtual void WriteValue(int value)
{
UpdateScopeWithFinishedValue();
AutoComplete(JsonToken.Integer);
InternalWriteValue(JsonToken.Integer);
}
/// <summary>
@@ -786,8 +794,7 @@ namespace Newtonsoft.Json
[CLSCompliant(false)]
public virtual void WriteValue(uint value)
{
UpdateScopeWithFinishedValue();
AutoComplete(JsonToken.Integer);
InternalWriteValue(JsonToken.Integer);
}
/// <summary>
@@ -796,8 +803,7 @@ namespace Newtonsoft.Json
/// <param name="value">The <see cref="Int64"/> value to write.</param>
public virtual void WriteValue(long value)
{
UpdateScopeWithFinishedValue();
AutoComplete(JsonToken.Integer);
InternalWriteValue(JsonToken.Integer);
}
/// <summary>
@@ -807,8 +813,7 @@ namespace Newtonsoft.Json
[CLSCompliant(false)]
public virtual void WriteValue(ulong value)
{
UpdateScopeWithFinishedValue();
AutoComplete(JsonToken.Integer);
InternalWriteValue(JsonToken.Integer);
}
/// <summary>
@@ -817,8 +822,7 @@ namespace Newtonsoft.Json
/// <param name="value">The <see cref="Single"/> value to write.</param>
public virtual void WriteValue(float value)
{
UpdateScopeWithFinishedValue();
AutoComplete(JsonToken.Float);
InternalWriteValue(JsonToken.Float);
}
/// <summary>
@@ -827,8 +831,7 @@ namespace Newtonsoft.Json
/// <param name="value">The <see cref="Double"/> value to write.</param>
public virtual void WriteValue(double value)
{
UpdateScopeWithFinishedValue();
AutoComplete(JsonToken.Float);
InternalWriteValue(JsonToken.Float);
}
/// <summary>
@@ -837,8 +840,7 @@ namespace Newtonsoft.Json
/// <param name="value">The <see cref="Boolean"/> value to write.</param>
public virtual void WriteValue(bool value)
{
UpdateScopeWithFinishedValue();
AutoComplete(JsonToken.Boolean);
InternalWriteValue(JsonToken.Boolean);
}
/// <summary>
@@ -847,8 +849,7 @@ namespace Newtonsoft.Json
/// <param name="value">The <see cref="Int16"/> value to write.</param>
public virtual void WriteValue(short value)
{
UpdateScopeWithFinishedValue();
AutoComplete(JsonToken.Integer);
InternalWriteValue(JsonToken.Integer);
}
/// <summary>
@@ -858,8 +859,7 @@ namespace Newtonsoft.Json
[CLSCompliant(false)]
public virtual void WriteValue(ushort value)
{
UpdateScopeWithFinishedValue();
AutoComplete(JsonToken.Integer);
InternalWriteValue(JsonToken.Integer);
}
/// <summary>
@@ -868,8 +868,7 @@ namespace Newtonsoft.Json
/// <param name="value">The <see cref="Char"/> value to write.</param>
public virtual void WriteValue(char value)
{
UpdateScopeWithFinishedValue();
AutoComplete(JsonToken.String);
InternalWriteValue(JsonToken.String);
}
/// <summary>
@@ -878,8 +877,7 @@ namespace Newtonsoft.Json
/// <param name="value">The <see cref="Byte"/> value to write.</param>
public virtual void WriteValue(byte value)
{
UpdateScopeWithFinishedValue();
AutoComplete(JsonToken.Integer);
InternalWriteValue(JsonToken.Integer);
}
/// <summary>
@@ -889,8 +887,7 @@ namespace Newtonsoft.Json
[CLSCompliant(false)]
public virtual void WriteValue(sbyte value)
{
UpdateScopeWithFinishedValue();
AutoComplete(JsonToken.Integer);
InternalWriteValue(JsonToken.Integer);
}
/// <summary>
@@ -899,8 +896,7 @@ namespace Newtonsoft.Json
/// <param name="value">The <see cref="Decimal"/> value to write.</param>
public virtual void WriteValue(decimal value)
{
UpdateScopeWithFinishedValue();
AutoComplete(JsonToken.Float);
InternalWriteValue(JsonToken.Float);
}
/// <summary>
@@ -909,8 +905,7 @@ namespace Newtonsoft.Json
/// <param name="value">The <see cref="DateTime"/> value to write.</param>
public virtual void WriteValue(DateTime value)
{
UpdateScopeWithFinishedValue();
AutoComplete(JsonToken.Date);
InternalWriteValue(JsonToken.Date);
}
#if !PocketPC && !NET20
@@ -920,8 +915,7 @@ namespace Newtonsoft.Json
/// <param name="value">The <see cref="DateTimeOffset"/> value to write.</param>
public virtual void WriteValue(DateTimeOffset value)
{
UpdateScopeWithFinishedValue();
AutoComplete(JsonToken.Date);
InternalWriteValue(JsonToken.Date);
}
#endif
@@ -931,8 +925,7 @@ namespace Newtonsoft.Json
/// <param name="value">The <see cref="Guid"/> value to write.</param>
public virtual void WriteValue(Guid value)
{
UpdateScopeWithFinishedValue();
AutoComplete(JsonToken.String);
InternalWriteValue(JsonToken.String);
}
/// <summary>
@@ -941,8 +934,7 @@ namespace Newtonsoft.Json
/// <param name="value">The <see cref="TimeSpan"/> value to write.</param>
public virtual void WriteValue(TimeSpan value)
{
UpdateScopeWithFinishedValue();
AutoComplete(JsonToken.String);
InternalWriteValue(JsonToken.String);
}
/// <summary>
@@ -1162,14 +1154,9 @@ namespace Newtonsoft.Json
public virtual void WriteValue(byte[] value)
{
if (value == null)
{
WriteNull();
}
else
{
UpdateScopeWithFinishedValue();
AutoComplete(JsonToken.Bytes);
}
InternalWriteValue(JsonToken.Bytes);
}
/// <summary>
@@ -1179,14 +1166,9 @@ namespace Newtonsoft.Json
public virtual void WriteValue(Uri value)
{
if (value == null)
{
WriteNull();
}
else
{
UpdateScopeWithFinishedValue();
AutoComplete(JsonToken.String);
}
InternalWriteValue(JsonToken.String);
}
/// <summary>
@@ -1297,7 +1279,11 @@ namespace Newtonsoft.Json
/// <param name="text">Text to place inside the comment.</param>
public virtual void WriteComment(string text)
{
UpdateScopeWithFinishedValue();
InternalWriteComment();
}
internal void InternalWriteComment()
{
AutoComplete(JsonToken.Comment);
}
@@ -1306,6 +1292,11 @@ namespace Newtonsoft.Json
/// </summary>
/// <param name="ws">The string of white space characters.</param>
public virtual void WriteWhitespace(string ws)
{
InternalWriteWhitespace(ws);
}
internal void InternalWriteWhitespace(string ws)
{
if (ws != null)
{
@@ -1314,7 +1305,6 @@ namespace Newtonsoft.Json
}
}
void IDisposable.Dispose()
{
Dispose(true);