/*
 * This source file is part of KEOS (Free 3D Engine)
 * For the latest info, see http://www.keosengine.org/
 * E-mails : thierry.vouriot@keosengine.org, yeri@keosengine.org
 * 
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation; either version 2 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place - Suite 330, Boston, MA 02111-1307, USA, or go to
 * http://www.gnu.org/copyleft/lesser.txt.
 *
 */

#ifndef KEOS_FILE_H
#define KEOS_FILE_H

#include "KeosPlatform.h"
#include "KeosStdHeaders.h"

namespace Keos
{
    typedef std::string String;

    //-----------------------------------------------------------------------
    /** Class facilitating the manipulation of files.
     *
     */
    class KEOS_EXPORT CFile
    {
    public :

        /** Constructor using a String.
         *  @param strName Complete path of th file.
         */
        CFile(const String& strName = "unknown");

        /** Constructor using a const char*.
         *  @param strName Complete path of th file.
         */
        CFile(const char* strName);

        /** Indicate if the file exists or not.
         *  @return True if the file exists.
         */
        bool Exists() const;

        /** Return the name of the file with its path.
         *  @return The name of the file without its path.
         */
        const String& Fullname() const;

        /** Return the name of the file without its path.
         *  @return The name of the file without its path.
         */
        String Filename() const;

        /** Return the name of the file without path nor extension.
         *  @return The name of the file without path nor extension.
         */
        String ShortFilename() const;

        /** Return the file extension.
         *  @return The tile extension.
         */
        String Extension() const;

    private :
            
        //! Complete path of the file
        String m_strName; 
    };

} // namespace Keos

#endif // KEOS_FILE_H
