michael@0: /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
michael@0:  *
michael@0:  * This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #include "nsISupports.idl"
michael@0: 
michael@0: [scriptable, uuid(67f42475-ba80-40f8-ac0b-649c89230184)]
michael@0: interface nsIUnicharLineInputStream : nsISupports
michael@0: {
michael@0:   /**
michael@0:    * Read a single line from the stream, where a line is a 
michael@0:    * possibly zero length sequence of characters terminated by a
michael@0:    * CR, LF, CRLF, LFCR, or eof.
michael@0:    * The line terminator is not returned.
michael@0:    * @retval false
michael@0:    *         End of file. This line is the last line of the file
michael@0:    *         (aLine is valid).
michael@0:    * @retval true
michael@0:    *         The file contains further lines.
michael@0:    * @note Do not mix readLine with other read functions.
michael@0:    *       Doing so can cause various problems and is not supported.
michael@0:    */
michael@0:   boolean readLine(out AString aLine);
michael@0: };