debian-packages/dyaml
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

More commit style/whitespace changes.

Browse source
This commit is contained in:
Ferdinand Majerech 2014-07-22 00:41:13 +02:00
parent 1d81148aef
commit 3bb486de0b
1 changed files with 87 additions and 104 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

157
source/dyaml/reader.d
View file

@ -113,13 +113,11 @@ final class Reader
UTFFastDecoder decoder_; UTFFastDecoder decoder_;
public: public:
/* /// Construct a Reader.
* Construct a Reader. ///
* /// Params: stream = Input stream. Must be readable and seekable.
* Params: stream = Input stream. Must be readable and seekable. ///
* /// Throws: ReaderException if the stream is invalid.
* Throws: ReaderException if the stream is invalid.
*/
this(Stream stream) @trusted //!nothrow this(Stream stream) @trusted //!nothrow
in in
{ {
@ -140,17 +138,15 @@ final class Reader
buffer_ = bufferAllocated_ = null; buffer_ = bufferAllocated_ = null;
} }
/** /// Get character at specified index relative to current position.
* Get character at specified index relative to current position. ///
* /// Params: index = Index of the character to get relative to current position
* Params: index = Index of the character to get relative to current position /// in the stream.
* in the stream. ///
* /// Returns: Character at specified position.
* Returns: Character at specified position. ///
* /// Throws: ReaderException if trying to read past the end of the stream
* Throws: ReaderException if trying to read past the end of the stream /// or if invalid data is read.
* or if invalid data is read.
*/
dchar peek(size_t index = 0) @trusted dchar peek(size_t index = 0) @trusted
{ {
if(buffer_.length < bufferOffset_ + index + 1) if(buffer_.length < bufferOffset_ + index + 1)
@ -166,32 +162,28 @@ final class Reader
return buffer_[bufferOffset_ + index]; return buffer_[bufferOffset_ + index];
} }
/** /// Get specified number of characters starting at current position.
* Get specified number of characters starting at current position. ///
* /// Note: This gets only a "view" into the internal buffer,
* Note: This gets only a "view" into the internal buffer, /// which WILL get invalidated after other Reader calls.
* which WILL get invalidated after other Reader calls. ///
* /// Params: length = Number of characters to get.
* Params: length = Number of characters to get. ///
* /// Returns: Characters starting at current position or an empty slice if out of bounds.
* Returns: Characters starting at current position or an empty slice if out of bounds.
*/
const(dstring) prefix(size_t length) @safe const(dstring) prefix(size_t length) @safe
{ {
return slice(0, length); return slice(0, length);
} }
/** /// Get a slice view of the internal buffer.
* Get a slice view of the internal buffer. ///
* /// Note: This gets only a "view" into the internal buffer,
* Note: This gets only a "view" into the internal buffer, /// which WILL get invalidated after other Reader calls.
* which WILL get invalidated after other Reader calls. ///
* /// Params: start = Start of the slice relative to current position.
* Params: start = Start of the slice relative to current position. /// end = End of the slice relative to current position.
* end = End of the slice relative to current position. ///
* /// Returns: Slice into the internal buffer or an empty slice if out of bounds.
* Returns: Slice into the internal buffer or an empty slice if out of bounds.
*/
const(dstring) slice(size_t start, size_t end) @trusted const(dstring) slice(size_t start, size_t end) @trusted
{ {
if(buffer_.length <= bufferOffset_ + end) if(buffer_.length <= bufferOffset_ + end)
@ -206,14 +198,12 @@ final class Reader
return end > start ? cast(dstring)buffer_[start .. end] : ""; return end > start ? cast(dstring)buffer_[start .. end] : "";
} }
/** /// Get the next character, moving stream position beyond it.
* Get the next character, moving stream position beyond it. ///
* /// Returns: Next character.
* Returns: Next character. ///
* /// Throws: ReaderException if trying to read past the end of the stream
* Throws: ReaderException if trying to read past the end of the stream /// or if invalid data is read.
* or if invalid data is read.
*/
dchar get() @safe dchar get() @safe
{ {
const result = peek(); const result = peek();
@ -221,16 +211,14 @@ final class Reader
return result; return result;
} }
/** /// Get specified number of characters, moving stream position beyond them.
* Get specified number of characters, moving stream position beyond them. ///
* /// Params: length = Number or characters to get.
* Params: length = Number or characters to get. ///
* /// Returns: Characters starting at current position.
* Returns: Characters starting at current position. ///
* /// Throws: ReaderException if trying to read past the end of the stream
* Throws: ReaderException if trying to read past the end of the stream /// or if invalid data is read.
* or if invalid data is read.
*/
dstring get(size_t length) @safe dstring get(size_t length) @safe
{ {
auto result = prefix(length).idup; auto result = prefix(length).idup;
@ -238,14 +226,12 @@ final class Reader
return result; return result;
} }
/** /// Move current position forward.
* Move current position forward. ///
* /// Params: length = Number of characters to move position forward.
* Params: length = Number of characters to move position forward. ///
* /// Throws: ReaderException if trying to read past the end of the stream
* Throws: ReaderException if trying to read past the end of the stream /// or if invalid data is read.
* or if invalid data is read.
*/
void forward(size_t length = 1) @trusted void forward(size_t length = 1) @trusted
{ {
if(buffer_.length <= bufferOffset_ + length + 1) if(buffer_.length <= bufferOffset_ + length + 1)
@ -287,17 +273,15 @@ final class Reader
@property final Encoding encoding() const pure @safe nothrow {return decoder_.encoding;} @property final Encoding encoding() const pure @safe nothrow {return decoder_.encoding;}
private: private:
/** // Update buffer to be able to read length characters after buffer offset.
* Update buffer to be able to read length characters after buffer offset. //
* // If there are not enough characters in the stream, it will get
* If there are not enough characters in the stream, it will get // as many as possible.
* as many as possible. //
* // Params: length = Number of characters we need to read.
* Params: length = Number of characters we need to read. //
* // Throws: ReaderException if trying to read past the end of the stream
* Throws: ReaderException if trying to read past the end of the stream // or if invalid data is read.
* or if invalid data is read.
*/
void updateBuffer(const size_t length) @system void updateBuffer(const size_t length) @system
{ {
// Get rid of unneeded data in the buffer. // Get rid of unneeded data in the buffer.
@ -328,17 +312,16 @@ final class Reader
} }
} }
/** // Load more characters to the buffer.
* Load more characters to the buffer. //
* // Params: chars = Recommended number of characters to load.
* Params: chars = Recommended number of characters to load. // More characters might be loaded.
* More characters might be loaded. // Less will be loaded if not enough available.
* Less will be loaded if not enough available. //
* // Throws: ReaderException on Unicode decoding error,
* Throws: ReaderException on Unicode decoding error, // if nonprintable characters are detected, or
* if nonprintable characters are detected, or // if there is an error reading from the stream.
* if there is an error reading from the stream. //
*/
void loadChars(size_t chars) @system void loadChars(size_t chars) @system
{ {
const oldLength = buffer_.length; const oldLength = buffer_.length;