path: root/src/CBot/ClassFILE.cpp

// * This file is part of the COLOBOT source code
// * Copyright (C) 2001-2008, Daniel ROUX & EPSITEC SA, www.epsitec.ch
// *
// * This program 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 3 of the License, or
// * (at your option) any later version.
// *
// * This program is distributed 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 this program. If not, see  http://www.gnu.org/licenses/.// ClassFile.cpp
//
// d�finition des m�thodes pour la classe FILE



// Variables statiques

static CBotClass*	m_pClassFILE;
static CBotProgram*	m_pFuncFile;
static int			m_CompteurFileOpen = 0;



// Pr�pare un nom de fichier.

void PrepareFilename(CBotString &filename)  //DD!
{
	int			pos;

	pos = filename.ReverseFind('\\');
	if ( pos > 0 )
	{
		filename = filename.Mid(pos+1);		// enl�ve les dossiers
	}

	pos = filename.ReverseFind('/');
	if ( pos > 0 )
	{
		filename = filename.Mid(pos+1);		// aussi ceux avec /
	}

	pos = filename.ReverseFind(':');
	if ( pos > 0 )
	{
		filename = filename.Mid(pos+1);		// enl�ve aussi la lettre d'unit� C:
	}

	filename = CBotString("files\\") + filename;
}


// constructeur de la classe
// re�ois le nom du fichier en param�tre

// ex�cution
BOOL rfconstruct (CBotVar* pThis, CBotVar* pVar, CBotVar* pResult, int& Exception) 
{
	CBotString	mode;

	// accepte sans param�tre
	if ( pVar == NULL ) return TRUE;

	// qui doit �tre une cha�ne de caract�res
	if ( pVar->GivType() != CBotTypString ) { Exception = CBotErrBadString; return FALSE; }

	CBotString	filename = pVar->GivValString();
	PrepareFilename(filename);  //DR

	// il peut y avoir  un second param�tre
	pVar = pVar->GivNext();
	if ( pVar != NULL )
	{
		// r�cup�re le mode
		mode = pVar->GivValString();
		if ( mode != "r" && mode != "w" ) { Exception = CBotErrBadParam; return FALSE; }

		// pas de 3e param�tre
		if ( pVar->GivNext() != NULL ) { Exception = CBotErrOverParam; return FALSE; } 
	}

	// enregistre le nom du fichier
	pVar = pThis->GivItem("filename");
	pVar->SetValString(filename);

	if ( ! mode.IsEmpty() )
	{
		// ouvre le ficher demand�
		FILE*	pFile = fopen( filename, mode );
		if ( pFile == NULL ) { Exception = CBotErrFileOpen; return FALSE; }

		m_CompteurFileOpen ++;

		// enregiste le canal du fichier
		pVar = pThis->GivItem("handle");
		pVar->SetValInt((long)pFile);
	}

	return TRUE;
}

// compilation
CBotTypResult cfconstruct (CBotVar* pThis, CBotVar* &pVar)
{
	// accepte sans param�tre
	if ( pVar == NULL ) return CBotTypResult( 0 );

	// qui doit �tre une chaine
	if ( pVar->GivType() != CBotTypString )
						return CBotTypResult( CBotErrBadString );

	// il peut y avoir un second param�tre
	pVar = pVar->GivNext();
	if ( pVar != NULL )
	{
		// qui doit �tre une chaine
		if ( pVar->GivType() != CBotTypString )
							return CBotTypResult( CBotErrBadString );
		// pas de 3e param�tre
		if ( pVar->GivNext() != NULL ) return CBotTypResult( CBotErrOverParam );
	}

	// le r�sultat est de type void (constructeur)
	return CBotTypResult( 0 );
}


// destructeur de la classe

// ex�cution
BOOL rfdestruct (CBotVar* pThis, CBotVar* pVar, CBotVar* pResult, int& Exception)
{
	// r�cup�re l'�l�ment "handle"
	pVar = pThis->GivItem("handle");

	// pas ouvert ? pas de probl�me
	if ( pVar->GivInit() != IS_DEF) return TRUE;

	FILE* pFile= (FILE*)pVar->GivValInt();
	fclose(pFile);
	m_CompteurFileOpen --;

	pVar->SetInit(IS_NAN);

	return TRUE;
}


// m�thode FILE :: open
// re�ois le mode r/w en param�tre

// ex�cution
BOOL rfopen (CBotVar* pThis, CBotVar* pVar, CBotVar* pResult, int& Exception)
{
	// il doit y avoir un param�tre
	if ( pVar == NULL ) { Exception = CBotErrLowParam; return FALSE; }

	// qui doit �tre une cha�ne de caract�res
	if ( pVar->GivType() != CBotTypString ) { Exception = CBotErrBadString; return FALSE; }

	// il peut y avoir  un second param�tre
	if ( pVar->GivNext() != NULL )
	{
		// dans ce cas le premier param�tre est le nom du fichier
		CBotString	filename = pVar->GivValString();
		PrepareFilename(filename);  //DR

		// enregistre le nom du fichier
		CBotVar* pVar2 = pThis->GivItem("filename");
		pVar2->SetValString(filename);

		// param�tre suivant est le mode
		pVar = pVar -> GivNext();
	}

	CBotString	mode = pVar->GivValString();
	if ( mode != "r" && mode != "w" ) { Exception = CBotErrBadParam; return FALSE; }

	// pas de 3e param�tre
	if ( pVar->GivNext() != NULL ) { Exception = CBotErrOverParam; return FALSE; }

	// r�cup�re l'�l�ment "handle"
	pVar = pThis->GivItem("handle");

	// qui doit pas �tre initialis�
	if ( pVar->GivInit() == IS_DEF) { Exception = CBotErrFileOpen; return FALSE; }

	// reprend le nom du fichier
	pVar = pThis->GivItem("filename");
	CBotString	filename = pVar->GivValString();

	PrepareFilename(filename);  //DD! (si le nom a �t� attribu� par h.filename = "...";

	// ouvre le ficher demand�
	FILE*	pFile = fopen( filename, mode );
	if ( pFile == NULL )  //DR
	{
		pResult->SetValInt(FALSE);  //DR
		return TRUE;  //DR
	}

	m_CompteurFileOpen ++;

	// enregiste le canal du fichier
	pVar = pThis->GivItem("handle");
	pVar->SetValInt((long)pFile);

	pResult->SetValInt(TRUE);  //DR
	return TRUE;
}

// compilation
CBotTypResult cfopen (CBotVar* pThis, CBotVar* &pVar)
{
	// il doit y avoir un param�tre
	if ( pVar == NULL ) return CBotTypResult( CBotErrLowParam );

	// qui doit �tre une chaine
	if ( pVar->GivType() != CBotTypString )
						return CBotTypResult( CBotErrBadString );

	// il peut y avoir  un second param�tre
	pVar = pVar->GivNext();
	if ( pVar != NULL )
	{
		// qui doit �tre une chaine
		if ( pVar->GivType() != CBotTypString )
						return CBotTypResult( CBotErrBadString );

		// pas de 3e param�tre
		if ( pVar->GivNext() != NULL ) return CBotTypResult( CBotErrOverParam );
	}

	// le r�sultat est de type bool
	return CBotTypResult(CBotTypBoolean);  //DR
}

	
// m�thode FILE :: close

// ex�cution
BOOL rfclose (CBotVar* pThis, CBotVar* pVar, CBotVar* pResult, int& Exception)
{
	// il ne doit pas y avoir de param�tre
	if ( pVar != NULL ) return CBotErrOverParam;

	// r�cup�re l'�l�ment "handle"
	pVar = pThis->GivItem("handle");

	if ( pVar->GivInit() != IS_DEF) { Exception = CBotErrNotOpen; return FALSE; }

	FILE* pFile= (FILE*)pVar->GivValInt();
	fclose(pFile);
	m_CompteurFileOpen --;

	pVar->SetInit(IS_NAN);

	return TRUE;
}

// compilation
CBotTypResult cfclose (CBotVar* pThis, CBotVar* &pVar)
{
	// il ne doit pas y avoir de param�tre
	if ( pVar != NULL ) return CBotTypResult( CBotErrOverParam );

	// la fonction retourne un r�sultat "void"
	return CBotTypResult( 0 );
}

// m�thode FILE :: writeln

// ex�cution
BOOL rfwrite (CBotVar* pThis, CBotVar* pVar, CBotVar* pResult, int& Exception)
{
	// il doit y avoir un param�tre
	if ( pVar == NULL ) { Exception = CBotErrLowParam; return FALSE; }

	// qui doit �tre une cha�ne de caract�res
	if ( pVar->GivType() != CBotTypString ) { Exception = CBotErrBadString; return FALSE; }

	CBotString param = pVar->GivValString();

	// r�cup�re l'�l�ment "handle"
	pVar = pThis->GivItem("handle");

	if ( pVar->GivInit() != IS_DEF) { Exception = CBotErrNotOpen; return FALSE; }

	FILE* pFile= (FILE*)pVar->GivValInt();
	
	int res = fputs(param+CBotString("\n"), pFile);

	// en cas d'erreur g�n�re une exception
	if ( res < 0 ) { Exception = CBotErrWrite; return FALSE; }

	return TRUE;
}

// compilation
CBotTypResult cfwrite (CBotVar* pThis, CBotVar* &pVar)
{
	// il doit y avoir un param�tre
	if ( pVar == NULL ) return CBotTypResult( CBotErrLowParam );

	// qui doit �tre une cha�ne de caract�res
	if ( pVar->GivType() != CBotTypString ) return CBotTypResult( CBotErrBadString );

	// pas d'autre param�tre
	if ( pVar->GivNext() != NULL ) return CBotTypResult( CBotErrOverParam );

	// la fonction retourne un r�sultat void
	return CBotTypResult( 0 );
}

// m�thode FILE :: readln

// ex�cution
BOOL rfread (CBotVar* pThis, CBotVar* pVar, CBotVar* pResult, int& Exception)
{
	// il ne doit pas y avoir de param�tre
	if ( pVar != NULL ) { Exception = CBotErrOverParam; return FALSE; }

	// r�cup�re l'�l�ment "handle"
	pVar = pThis->GivItem("handle");

	if ( pVar->GivInit() != IS_DEF) { Exception = CBotErrNotOpen; return FALSE; }

	FILE* pFile= (FILE*)pVar->GivValInt();

	char	chaine[2000];
	int		i;
	for ( i = 0 ; i < 2000 ; i++ ) chaine[i] = 0;

	fgets(chaine, 1999, pFile);

	for ( i = 0 ; i < 2000 ; i++ ) if (chaine[i] == '\n') chaine[i] = 0;

	// en cas d'erreur g�n�re une exception
	if ( ferror(pFile) ) { Exception = CBotErrRead; return FALSE; }

	pResult->SetValString( chaine );

	return TRUE;
}

// compilation
CBotTypResult cfread (CBotVar* pThis, CBotVar* &pVar)
{
	// il ne doit pas y avoir de param�tre
	if ( pVar != NULL ) return CBotTypResult( CBotErrOverParam );

	// la fonction retourne un r�sultat "string"
	return CBotTypResult( CBotTypString );
}
// m�thode FILE :: readln


// ex�cution
BOOL rfeof (CBotVar* pThis, CBotVar* pVar, CBotVar* pResult, int& Exception)
{
	// il ne doit pas y avoir de param�tre
	if ( pVar != NULL ) { Exception = CBotErrOverParam; return FALSE; }

	// r�cup�re l'�l�ment "handle"
	pVar = pThis->GivItem("handle");

	if ( pVar->GivInit() != IS_DEF) { Exception = CBotErrNotOpen; return FALSE; }

	FILE* pFile= (FILE*)pVar->GivValInt();

	pResult->SetValInt( feof( pFile ) );

	return TRUE;
}

// compilation
CBotTypResult cfeof (CBotVar* pThis, CBotVar* &pVar)
{
	// il ne doit pas y avoir de param�tre
	if ( pVar != NULL ) return CBotTypResult( CBotErrOverParam );

	// la fonction retourne un r�sultat booleen
	return CBotTypResult( CBotTypBoolean );
}





void InitClassFILE()
{
// cr�e une classe pour la gestion des fichiers
// l'utilisation en est la suivante:
// file canal( "NomFichier.txt" )
// canal.open( "r" );	// ouvre en lecture
// s = canal.readln( ); // lit une ligne
// canal.close();		// referme le fichier

	// cr�e la classe FILE
	m_pClassFILE	= new CBotClass("file", NULL);
	// ajoute le composant ".filename"
	m_pClassFILE->AddItem("filename", CBotTypString);
	// ajoute le composant ".handle"
	m_pClassFILE->AddItem("handle", CBotTypInt, PR_PRIVATE);

	// d�fini un constructeur et un destructeur
	m_pClassFILE->AddFunction("file", rfconstruct, cfconstruct );
	m_pClassFILE->AddFunction("~file", rfdestruct, NULL );

	// d�fini les m�thodes associ�es
	m_pClassFILE->AddFunction("open", rfopen, cfopen );
	m_pClassFILE->AddFunction("close", rfclose, cfclose );
	m_pClassFILE->AddFunction("writeln", rfwrite, cfwrite );
	m_pClassFILE->AddFunction("readln", rfread, cfread );
	m_pClassFILE->AddFunction("eof", rfeof, cfeof );

	m_pFuncFile = new CBotProgram( );
	CBotStringArray ListFonctions;
	m_pFuncFile->Compile( "public file openfile(string name, string mode) {return new file(name, mode);}", ListFonctions);
	m_pFuncFile->SetIdent(-2);	// identificateur sp�cial pour RestoreState dans cette fonction
}