/usr/include/ptlib/textfile.h is in libpt-dev 2.10.11~dfsg-2.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 | /*
* textfile.h
*
* A text file I/O channel class.
*
* Portable Windows Library
*
* Copyright (c) 1993-1998 Equivalence Pty. Ltd.
*
* The contents of this file are subject to the Mozilla Public License
* Version 1.0 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
* the License for the specific language governing rights and limitations
* under the License.
*
* The Original Code is Portable Windows Library.
*
* The Initial Developer of the Original Code is Equivalence Pty. Ltd.
*
* Portions are Copyright (C) 1993 Free Software Foundation, Inc.
* All Rights Reserved.
*
* Contributor(s): ______________________________________.
*
* $Revision: 24177 $
* $Author: rjongbloed $
* $Date: 2010-04-05 06:52:04 -0500 (Mon, 05 Apr 2010) $
*/
#ifndef PTLIB_TEXTFILE_H
#define PTLIB_TEXTFILE_H
#ifdef P_USE_PRAGMA
#pragma interface
#endif
///////////////////////////////////////////////////////////////////////////////
// Text Files
/** A class representing a a structured file that is portable accross CPU
architectures. Essentially this will normalise the end of line character
which differs fromplatform to platform.
*/
class PTextFile : public PFile
{
PCLASSINFO(PTextFile, PFile);
public:
/**@name Construction */
//@{
/** Create a text file object but do not open it. It does not initially
have a valid file name. However, an attempt to open the file using the
<code>PFile::Open()</code> function will generate a unique temporary file.
*/
PTextFile();
/** Create a unique temporary file name, and open the file in the specified
mode and using the specified options. Note that opening a new, unique,
temporary file name in ReadOnly mode will always fail. This would only
be usefull in a mode and options that will create the file.
The <code>PChannel::IsOpen()</code> function may be used after object
construction to determine if the file was successfully opened.
*/
PTextFile(
OpenMode mode, ///< Mode in which to open the file.
int opts = ModeDefault ///< <code>OpenOptions</code> enum# for open operation.
);
/** Create a text file object with the specified name and open it in the
specified mode and with the specified options.
The <code>PChannel::IsOpen()</code> function may be used after object
construction to determine if the file was successfully opened.
*/
PTextFile(
const PFilePath & name, ///< Name of file to open.
OpenMode mode = ReadWrite, ///< Mode in which to open the file.
int opts = ModeDefault ///< <code>OpenOptions</code> enum# for open operation.
);
//@}
/**@name Line I/O functions */
//@{
/** Read a line from the text file. What constitutes an end of line in the
file is platform dependent.
Use the <code>PChannel::GetLastError()</code> function to determine if there
was some error other than end of file.
@return
true if successful, false if at end of file or a read error.
*/
PBoolean ReadLine(
PString & str ///< String into which line of text is read.
);
/** Read a line from the text file. What constitutes an end of line in the
file is platform dependent.
Use the <code>PChannel::GetLastError()</code> function to determine the
failure mode.
@return
true if successful, false if an error occurred.
*/
PBoolean WriteLine(
const PString & str ///< String to write with end of line terminator.
);
//@}
// Include platform dependent part of class
#ifdef _WIN32
#include "msos/ptlib/textfile.h"
#else
#include "unix/ptlib/textfile.h"
#endif
};
#endif // PTLIB_TEXTFILE_H
// End Of File ///////////////////////////////////////////////////////////////
|