Skip to content

Commit

Permalink
[UnicodeEncoding] Remove unncessary comments
Browse files Browse the repository at this point in the history
  • Loading branch information
@jamesqo
jamesqo committed Jul 4, 2016
1 parent 95ff597 commit f09b521
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 62 deletions.
2 changes: 1 addition & 1 deletion src/mscorlib/src/System/Text/ASCIIEncoding.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ public override String GetString(byte[] bytes, int byteIndex, int byteCount)
return EncodingForwarder.GetString(this, bytes, byteIndex, byteCount);
}

// End of overriden methods which use EncodingForwarder
// End of overridden methods which use EncodingForwarder

// GetByteCount
// Note: We start by assuming that the output will be the same as count. Having
Expand Down
76 changes: 15 additions & 61 deletions src/mscorlib/src/System/Text/UnicodeEncoding.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,42 +77,35 @@ internal override void SetDefaultFallbacks()
}
}

//
// The following methods are copied from EncodingNLS.cs.
// Unfortunately EncodingNLS.cs is internal and we're public, so we have to reimpliment them here.
// These should be kept in sync for the following classes:
// EncodingNLS, UTF7Encoding, UTF8Encoding, UTF32Encoding, ASCIIEncoding, UnicodeEncoding
//
// NOTE: Many methods in this class forward to EncodingForwarder for
// validating arguments/wrapping the unsafe methods in this class
// which do the actual work. That class contains
// shared logic for doing this which is used by
// ASCIIEncoding, EncodingNLS, UnicodeEncoding, UTF32Encoding,
// UTF7Encoding, and UTF8Encoding.
// The reason the code is separated out into a static class, rather
// than a base class which overrides all of these methods for us
// (which is what EncodingNLS is for internal Encodings) is because
// that's really more of an implementation detail so it's internal.
// At the same time, C# doesn't allow a public class subclassing an
// internal/private one, so we end up having to re-override these
// methods in all of the public Encodings + EncodingNLS.

// Returns the number of bytes required to encode a range of characters in
// a character array.
//
// All of our public Encodings that don't use EncodingNLS must have this (including EncodingNLS)
// So if you fix this, fix the others. Currently those include:
// EncodingNLS, UTF7Encoding, UTF8Encoding, UTF32Encoding, ASCIIEncoding, UnicodeEncoding
// parent method is safe

[System.Security.SecuritySafeCritical] // auto-generated
public override int GetByteCount(char[] chars, int index, int count)
{
return EncodingForwarder.GetByteCount(this, chars, index, count);
}

// All of our public Encodings that don't use EncodingNLS must have this (including EncodingNLS)
// So if you fix this, fix the others. Currently those include:
// EncodingNLS, UTF7Encoding, UTF8Encoding, UTF32Encoding, ASCIIEncoding, UnicodeEncoding
// parent method is safe

[System.Security.SecuritySafeCritical] // auto-generated
public override int GetByteCount(String s)
{
return EncodingForwarder.GetByteCount(this, s);
}

// All of our public Encodings that don't use EncodingNLS must have this (including EncodingNLS)
// So if you fix this, fix the others. Currently those include:
// EncodingNLS, UTF7Encoding, UTF8Encoding, UTF32Encoding, ASCIIEncoding, UnicodeEncoding

[System.Security.SecurityCritical] // auto-generated
[CLSCompliant(false)]
[System.Runtime.InteropServices.ComVisible(false)]
Expand All @@ -121,11 +114,6 @@ public override unsafe int GetByteCount(char* chars, int count)
return EncodingForwarder.GetByteCount(this, chars, count);
}

// Parent method is safe.
// All of our public Encodings that don't use EncodingNLS must have this (including EncodingNLS)
// So if you fix this, fix the others. Currently those include:
// EncodingNLS, UTF7Encoding, UTF8Encoding, UTF32Encoding, ASCIIEncoding, UnicodeEncoding

[System.Security.SecuritySafeCritical] // auto-generated
public override int GetBytes(String s, int charIndex, int charCount,
byte[] bytes, int byteIndex)
Expand All @@ -141,11 +129,6 @@ public override int GetBytes(String s, int charIndex, int charCount,
// Alternatively, the GetMaxByteCount method can be used to
// determine the maximum number of bytes that will be produced for a given
// number of characters, regardless of the actual character values.
//
// All of our public Encodings that don't use EncodingNLS must have this (including EncodingNLS)
// So if you fix this, fix the others. Currently those include:
// EncodingNLS, UTF7Encoding, UTF8Encoding, UTF32Encoding, ASCIIEncoding, UnicodeEncoding
// parent method is safe

[System.Security.SecuritySafeCritical] // auto-generated
public override int GetBytes(char[] chars, int charIndex, int charCount,
Expand All @@ -154,10 +137,6 @@ public override int GetBytes(char[] chars, int charIndex, int charCount,
return EncodingForwarder.GetBytes(this, chars, charIndex, charCount, bytes, byteIndex);
}

// All of our public Encodings that don't use EncodingNLS must have this (including EncodingNLS)
// So if you fix this, fix the others. Currently those include:
// EncodingNLS, UTF7Encoding, UTF8Encoding, UTF32Encoding, ASCIIEncoding, UnicodeEncoding

[System.Security.SecurityCritical] // auto-generated
[CLSCompliant(false)]
[System.Runtime.InteropServices.ComVisible(false)]
Expand All @@ -168,22 +147,13 @@ public override unsafe int GetBytes(char* chars, int charCount, byte* bytes, int

// Returns the number of characters produced by decoding a range of bytes
// in a byte array.
//
// All of our public Encodings that don't use EncodingNLS must have this (including EncodingNLS)
// So if you fix this, fix the others. Currently those include:
// EncodingNLS, UTF7Encoding, UTF8Encoding, UTF32Encoding, ASCIIEncoding, UnicodeEncoding
// parent method is safe

[System.Security.SecuritySafeCritical] // auto-generated
public override int GetCharCount(byte[] bytes, int index, int count)
{
return EncodingForwarder.GetCharCount(this, bytes, index, count);
}

// All of our public Encodings that don't use EncodingNLS must have this (including EncodingNLS)
// So if you fix this, fix the others. Currently those include:
// EncodingNLS, UTF7Encoding, UTF8Encoding, UTF32Encoding, ASCIIEncoding, UnicodeEncoding

[System.Security.SecurityCritical] // auto-generated
[CLSCompliant(false)]
[System.Runtime.InteropServices.ComVisible(false)]
Expand All @@ -192,22 +162,13 @@ public override unsafe int GetCharCount(byte* bytes, int count)
return EncodingForwarder.GetCharCount(this, bytes, count);
}

// All of our public Encodings that don't use EncodingNLS must have this (including EncodingNLS)
// So if you fix this, fix the others. Currently those include:
// EncodingNLS, UTF7Encoding, UTF8Encoding, UTF32Encoding, ASCIIEncoding, UnicodeEncoding
// parent method is safe

[System.Security.SecuritySafeCritical] // auto-generated
public override int GetChars(byte[] bytes, int byteIndex, int byteCount,
char[] chars, int charIndex)
{
return EncodingForwarder.GetChars(this, bytes, byteIndex, byteCount, chars, charIndex);
}

// All of our public Encodings that don't use EncodingNLS must have this (including EncodingNLS)
// So if you fix this, fix the others. Currently those include:
// EncodingNLS, UTF7Encoding, UTF8Encoding, UTF32Encoding, ASCIIEncoding, UnicodeEncoding

[System.Security.SecurityCritical] // auto-generated
[CLSCompliant(false)]
[System.Runtime.InteropServices.ComVisible(false)]
Expand All @@ -218,22 +179,15 @@ public unsafe override int GetChars(byte* bytes, int byteCount, char* chars, int

// Returns a string containing the decoded representation of a range of
// bytes in a byte array.
//
// All of our public Encodings that don't use EncodingNLS must have this (including EncodingNLS)
// So if you fix this, fix the others. Currently those include:
// EncodingNLS, UTF7Encoding, UTF8Encoding, UTF32Encoding, ASCIIEncoding, UnicodeEncoding
// parent method is safe

[System.Security.SecuritySafeCritical] // auto-generated
[System.Runtime.InteropServices.ComVisible(false)]
public override String GetString(byte[] bytes, int index, int count)
{
return EncodingForwarder.GetString(this, bytes, index, count);
}

//
// End of standard methods copied from EncodingNLS.cs
//

// End of overridden methods which use EncodingForwarder

[System.Security.SecurityCritical] // auto-generated
internal override unsafe int GetByteCount(char* chars, int count, EncoderNLS encoder)
Expand Down

0 comments on commit f09b521

Please sign in to comment.