[Gnash-commit] gnash ChangeLog server/stream.h

[Sandro Santilli]

CVSROOT:        /sources/gnash
Module name:    gnash
Changes by:     Sandro Santilli <strk>  07/12/05 10:57:29

Modified files:
        .              : ChangeLog 
        server         : stream.h 

Log message:
        document align() and get_position().

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/ChangeLog?cvsroot=gnash&r1=1.5090&r2=1.5091
http://cvs.savannah.gnu.org/viewcvs/gnash/server/stream.h?cvsroot=gnash&r1=1.35&r2=1.36

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/gnash/gnash/ChangeLog,v
retrieving revision 1.5090
retrieving revision 1.5091
diff -u -b -r1.5090 -r1.5091
--- ChangeLog   5 Dec 2007 10:13:44 -0000       1.5090
+++ ChangeLog   5 Dec 2007 10:57:29 -0000       1.5091
@@ -1,5 +1,6 @@
 2007-12-05 Sandro Santilli <address@hidden>
 
+       * server/stream.h: document align() and get_position().
        * testsuite/server/StreamTest.cpp: add tests for
          stream::get_position()
        * server/parser/shape_character_def.cpp (read):

Index: server/stream.h
===================================================================
RCS file: /sources/gnash/gnash/server/stream.h,v
retrieving revision 1.35
retrieving revision 1.36
diff -u -b -r1.35 -r1.36
--- server/stream.h     4 Dec 2007 11:45:29 -0000       1.35
+++ server/stream.h     5 Dec 2007 10:57:29 -0000       1.36
@@ -90,8 +90,13 @@
        /// Read 64-bit double values.
        long double read_d64();
 
-       /// \brief
-       /// Discard any left-over bits from previous bit reads
+       /// Consume all bits of current byte
+       //
+       /// NOTE:
+       /// The position returned by get_position() won't be changed
+       /// by calls to this function, altought any subsequent reads
+       /// will start on next byte. See get_position() for more info.
+       ///
        void    align()
        {
                m_unused_bits=0;
@@ -227,6 +232,14 @@
        void    read_string_with_length(unsigned len, std::string& to);
 
        /// Return our current (byte) position in the input stream.
+       //
+       /// NOTE:
+       /// This is not necessarely the byte you'll read on next read.
+       /// - For bit reads the byte will be used only if not
+       ///   completely consumed. See align().
+       /// - For aligned reads the byte will be used only if not
+       ///   consumed at all.
+       ///
        unsigned long get_position();
 
        /// Set the file position to the given value.