source: trunk/tools/common/kFileFormatBase.cpp

/* $Id: kFileFormatBase.cpp,v 1.6 2002-02-24 02:47:25 bird Exp $
 *
 * kFileFormatBase - Base class for kFile<format> classes.
 *
 * Copyright (c) 1999-2001 knut st. osmundsen (knut.stange.osmundsen@mynd.no)
 *
 * Project Odin Software License can be found in LICENSE.TXT
 *
 */



/*******************************************************************************
*   Header Files                                                               *
*******************************************************************************/
#include "kTypes.h"
#include "kError.h"
#include "kFile.h"
#include "kFileInterfaces.h"
#include "kFileFormatBase.h"



/**
 * Constructor.
 * Saves the file object pointer.
 * @param   pFile   This will be deleted if the object is
 *                  successfully constructed (by the destructor).
 * @status  completely implemented.
 * @author  knut st. osmundsen (knut.stange.osmundsen@mynd.no)
 */
kFileFormatBase::kFileFormatBase(kFile *pFile) throw (kError)
    : pFile(pFile)
{
}


/**
 * Destructor.
 * Deletes the file object if it exists.
 * @status  completely implemented.
 * @author  knut st. osmundsen (knut.stange.osmundsen@mynd.no)
 */
kFileFormatBase::~kFileFormatBase() throw (kError)
{
    if (pFile)
        delete pFile;
    pFile = NULL;
}


/**
 * Dump function.
 * @returns Successindicator.
 * @param   pOut    Output file.
 */
KBOOL   kFileFormatBase::dump(kFile *pOut)
{
    pOut->printf("Sorry, dump() is not implemented for this file format.\n");
    return FALSE;
}