xpcom/io/nsILineInputStream.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is mozilla.org code.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Boris Zbarsky <bzbarsky@mit.edu>.
  20  * Portions created by the Initial Developer are Copyright (C) 2001
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40
  41 interface nsILineInputStream;
  42
  43 [scriptable, uuid(c97b466c-1e6e-4773-a4ab-2b2b3190a7a6)]
  44 interface nsILineInputStream : nsISupports
  45 {
  46   /**
  47    * Read a single line from the stream, where a line is a
  48    * possibly zero length sequence of 8bit chars terminated by a
  49    * CR, LF, CRLF, LFCR, or eof.
  50    * The line terminator is not returned.
  51    * @retval false
  52    *         End of file. This line is the last line of the file
  53    *         (aLine is valid).
  54    * @retval true
  55    *         The file contains further lines.
  56    * @note Do not mix readLine with other read functions.
  57    *       Doing so can cause various problems and is not supported.
  58    */
  59   boolean readLine(out ACString aLine);
  60 };