// This is the SIP interface definition for QFile.
//
// Copyright (c) 2007
// 	Riverbank Computing Limited <info@riverbankcomputing.co.uk>
// 
// This file is part of PyQt.
// 
// This copy of PyQt is free software; you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free
// Software Foundation; either version 2, or (at your option) any later
// version.
// 
// PyQt is supplied in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
// details.
// 
// You should have received a copy of the GNU General Public License along with
// PyQt; see the file LICENSE.  If not, write to the Free Software Foundation,
// Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.


%ExportedDoc
<Sect2><Title>QFile</Title>
<FuncSynopsis>
        <FuncDef>bool <Function>open</Function></FuncDef>
        <ParamDef>int <Parameter>m</Parameter></ParamDef>
        <ParamDef>FILE *<Parameter>f</Parameter></ParamDef>
</FuncSynopsis>
<Para>
Not implemented.
</Para>

<FuncSynopsis>
        <FuncDef>Q_LONG <Function>readBlock</Function></FuncDef>
        <ParamDef>char *<Parameter>data</Parameter></ParamDef>
        <ParamDef>Q_ULONG <Parameter>len</Parameter></ParamDef>
</FuncSynopsis>
<Para>
This takes a single <Literal>len</Literal> parameter.  The
<Literal>data</Literal> is returned if there was no error, otherwise
<Literal>None</Literal> is returned.
</Para>

<FuncSynopsis>
        <FuncDef>Q_LONG <Function>readLine</Function></FuncDef>
        <ParamDef>char *<Parameter>data</Parameter></ParamDef>
        <ParamDef>Q_ULONG <Parameter>maxlen</Parameter></ParamDef>
</FuncSynopsis>
<Para>
This takes a single <Literal>maxlen</Literal> parameter.  The
<Literal>data</Literal> is returned if there was no error, otherwise
<Literal>None</Literal> is returned.
</Para>

<FuncSynopsis>
        <FuncDef>static void <Function>setDecodingFunction</Function></FuncDef>
        <ParamDef>EncoderFn <Parameter>f</Parameter></ParamDef>
</FuncSynopsis>
<Para>
Not yet implemented. (Qt v2+)
</Para>

<FuncSynopsis>
        <FuncDef>static void <Function>setEncodingFunction</Function></FuncDef>
        <ParamDef>EncoderFn <Parameter>f</Parameter></ParamDef>
</FuncSynopsis>
<Para>
Not yet implemented. (Qt v2+)
</Para>

<FuncSynopsis>
        <FuncDef>Q_LONG <Function>writeBlock</Function></FuncDef>
        <ParamDef>const char *<Parameter>data</Parameter></ParamDef>
        <ParamDef>Q_ULONG <Parameter>len</Parameter></ParamDef>
</FuncSynopsis>
<Para>
<Literal>len</Literal> is derived from <Literal>data</Literal> and not passed
as a parameter.
</Para>
</Sect2>
%End


class QFile : QIODevice
{
%TypeHeaderCode
#include <qfile.h>
%End

public:
	QFile();
%If (- Qt_2_00)
	QFile(const char *);
%End
%If (Qt_2_00 -)
	QFile(const QString &);
%End

%If (- Qt_2_00)
	const char *name() const;
	void setName(const char *);
%End
%If (Qt_2_00 -)
	QString name() const;
	void setName(const QString &);
%End

%If (Qt_2_00 -)
	static QCString encodeName(const QString &);
	static QString decodeName(const QCString &);
//	static void setEncodingFunction(EncoderFn);
//	static void setDecodingFunction(DecoderFn);
%End

	bool exists() const;
%If (- Qt_2_00)
	static bool exists(const char *);
%End
%If (Qt_2_00 -)
	static bool exists(const QString &);
%End

	bool remove();
%If (- Qt_2_00)
	static bool remove(const char *);
%End
%If (Qt_2_00 -)
	static bool remove(const QString &);
%End

	bool open(int) /ReleaseGIL/;
//	bool open(int,FILE *) /ReleaseGIL/;
	bool open(int,int) /ReleaseGIL/;
	void close();
	void flush() /ReleaseGIL/;

%If (- Qt_3_0_0)
	uint size() const;
	int at() const;
	bool at(int);
%End
%If (Qt_3_0_0 -)
	Offset size() const;
	Offset at() const;
	bool at(Offset);
%End
	bool atEnd() const;

%If (- Qt_3_0_0)
	SIP_PYOBJECT readBlock(uint) /ReleaseGIL/ [int (char *,uint)];
%MethodCode
		char *buf;

		if ((buf = (char *)sipMalloc(a0)) == NULL)
			sipIsErr = 1;
		else
		{
			int actlen;

			Py_BEGIN_ALLOW_THREADS
			actlen = sipSelfWasArg ? sipCpp->QFile::readBlock(buf,a0) : sipCpp->readBlock(buf,a0);
			Py_END_ALLOW_THREADS

			if (actlen < 0)
			{
				Py_INCREF(Py_None);
				sipRes = Py_None;
			}
			else if ((sipRes = PyString_FromStringAndSize(buf,actlen)) == NULL)
				sipIsErr = 1;

			sipFree((ANY *)buf);
		}
%End

	int writeBlock(const char * /Array/,uint /ArraySize/) /ReleaseGIL/;
%End
%If (Qt_3_0_0 -)
	SIP_PYOBJECT readBlock(Q_ULONG) /ReleaseGIL/ [Q_LONG (char *,Q_ULONG)];
%MethodCode
		char *buf;

		if ((buf = (char *)sipMalloc(a0)) == NULL)
			sipIsErr = 1;
		else
		{
			Q_LONG actlen;

			Py_BEGIN_ALLOW_THREADS
			actlen = sipSelfWasArg ? sipCpp->QFile::readBlock(buf,a0) : sipCpp->readBlock(buf,a0);
			Py_END_ALLOW_THREADS

			if (actlen < 0)
			{
				Py_INCREF(Py_None);
				sipRes = Py_None;
			}
			else if ((sipRes = PyString_FromStringAndSize(buf,actlen)) == NULL)
				sipIsErr = 1;

			sipFree((ANY *)buf);
		}
%End


	Q_LONG writeBlock(const char * /Array/,
			  Q_ULONG /ArraySize/) /ReleaseGIL/;
%End
%If (Qt_2_00 - Qt_3_0_0)
	int writeBlock(const QByteArray &) /ReleaseGIL/;
%End
%If (Qt_3_0_0 -)
	Q_LONG writeBlock(const QByteArray &) /ReleaseGIL/;
%End

%If (- Qt_3_0_0)
	SIP_PYOBJECT readLine(uint) /ReleaseGIL/ [int (char *,uint)];
%MethodCode
		char *buf;

		if ((buf = (char *)sipMalloc(a0)) == NULL)
			sipIsErr = 1;
		else
		{
			int actlen;

			Py_BEGIN_ALLOW_THREADS
			actlen = sipSelfWasArg ? sipCpp->QFile::readLine(buf,a0) : sipCpp->readLine(buf,a0);
			Py_END_ALLOW_THREADS

			if (actlen < 0)
			{
				sipFree((ANY *)buf);

				Py_INCREF(Py_None);
				sipRes = Py_None;
			}
			else
			{
				sipRes = PyString_FromStringAndSize(buf,actlen);

				sipFree((ANY *)buf);

				if (sipRes == NULL)
					sipIsErr = 1;
			}
		}
%End
%End
%If (Qt_3_0_0 -)
	SIP_PYOBJECT readLine(Q_ULONG) /ReleaseGIL/ [Q_LONG (char *,Q_ULONG)];
%MethodCode
		char *buf;

		if ((buf = (char *)sipMalloc(a0)) == NULL)
			sipIsErr = 1;
		else
		{
			Q_LONG actlen;

			Py_BEGIN_ALLOW_THREADS
			actlen = sipSelfWasArg ? sipCpp->QFile::readLine(buf,a0) : sipCpp->readLine(buf,a0);
			Py_END_ALLOW_THREADS

			if (actlen < 0)
			{
				sipFree((ANY *)buf);

				Py_INCREF(Py_None);
				sipRes = Py_None;
			}
			else
			{
				sipRes = PyString_FromStringAndSize(buf,actlen);

				sipFree((ANY *)buf);

				if (sipRes == NULL)
					sipIsErr = 1;
			}
		}
%End
%End

%If (Qt_2_00 - Qt_3_0_0)
	int readLine(QString &,uint) /ReleaseGIL/;
%End
%If (Qt_3_0_0 -)
	Q_LONG readLine(QString &,Q_ULONG) /ReleaseGIL/;
%End

	int getch();
	int putch(int);
	int ungetch(int);

	int handle() const;

%If (Qt_3_2_0 -)
	QString errorString() const;
%End

protected:
%If (Qt_3_2_0 -)
	void setErrorString(const QString &);
%End

private:
	QFile(const QFile &);
};
