/* Copyright (c) 2002-2012 Croteam Ltd. 
This program is free software; you can redistribute it and/or modify
it under the terms of version 2 of the GNU General Public License as published by
the Free Software Foundation


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, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */

#ifndef SE_INCL_FILENAME_H
#define SE_INCL_FILENAME_H
#ifdef PRAGMA_ONCE
  #pragma once
#endif

#include <Engine/Base/CTString.h>

/*
 * Special kind of string, dedicated to storing filenames.
 */
class ENGINE_API CTFileName : public CTString {
public:
  class CSerial *fnm_pserPreloaded;     // pointer to already loaded object if available
private:
  /* Constructor from character string. */
  inline CTFileName(const char *pString) : CTString(pString), fnm_pserPreloaded(NULL) {convertSlashes();};
public:
  /* Default constructor. */
  inline CTFileName(void) : fnm_pserPreloaded(NULL) {convertSlashes();};
  /* Copy constructor. */
  inline CTFileName(const CTString &strOriginal) : CTString(strOriginal), fnm_pserPreloaded(NULL) {convertSlashes();};
  /* Constructor from character string for insertion in exe-file. */
  inline CTFileName(const char *pString, int i) : CTString(pString+i), fnm_pserPreloaded(NULL) {convertSlashes();};

  /* Assignment. */
  CTFileName &operator=(const char *strCharString);
  inline void operator=(const CTString &strOther) {
    CTString::operator=(strOther);
    fnm_pserPreloaded = NULL;
    convertSlashes();
  };

  /* Get directory part of a filename. */
  CTFileName FileDir(void) const;
  /* Get name part of a filename. */
  CTFileName FileName(void) const;
  /* Get extension part of a filename. */
  CTFileName FileExt(void) const;
  /* Get path and file name without extension. */
  CTFileName NoExt(void) const;
  /* Set path to the absolute path, taking \.. and /.. into account. */
  void SetAbsolutePath(void);
  /* Remove application path from a file name. */
  BOOL RemoveApplicationPath_t(void); // throw char *

  // filename is its own name (used for storing in nametable)
  inline const CTFileName &GetName(void) { return *this; };

  void ReadFromText_t(CTStream &strmStream, const CTString &strKeyword=""); // throw char *

  /* Read from stream. */
  ENGINE_API friend CTStream &operator>>(CTStream &strmStream, CTFileName &fnmFileName);
  /* Write to stream. */
  ENGINE_API friend CTStream &operator<<(CTStream &strmStream, const CTFileName &fnmFileName);

  // convert '\' in '/'
  void convertSlashes();

  // convert '/' in '\'
  void convertSlashesIntoWindows();
};

// macro for defining a literal filename in code (EFNM = exe-filename)
#define CTFILENAME(string) CTFileName("EFNM" string, 4)
#define DECLARE_CTFILENAME(name, string) CTFileName name("EFNM" string, 4)



#endif  /* include-once check. */

