/*****************************************************************************
#   Copyright (C) 1994-2008 by David Gordon.
#   All rights reserved.                           
#                                                                           
#   This software is part of a beta-test version of the Consed/Autofinish
#   package.  It should not be redistributed or
#   used for any commercial purpose, including commercially funded
#   sequencing, without written permission from the author and the
#   University of Washington.
#   
#   This software is provided ``AS IS'' and any express or implied
#   warranties, including, but not limited to, the implied warranties of
#   merchantability and fitness for a particular purpose, are disclaimed.
#   In no event shall the authors or the University of Washington be
#   liable for any direct, indirect, incidental, special, exemplary, or
#   consequential damages (including, but not limited to, procurement of
#   substitute goods or services; loss of use, data, or profits; or
#   business interruption) however caused and on any theory of liability,
#   whether in contract, strict liability, or tort (including negligence
#   or otherwise) arising in any way out of the use of this software, even
#   if advised of the possibility of such damage.
#
#   Building Consed from source is error prone and not simple which is
#   why I provide executables.  Due to time limitations I cannot
#   provide any assistance in building Consed.  Even if you do not
#   modify the source, you may introduce errors due to using a
#   different version of the compiler, a different version of motif,
#   different versions of other libraries than I used, etc.  For this
#   reason, if you discover Consed bugs, I can only offer help with
#   those bugs if you first reproduce those bugs with an executable
#   provided by me--not an executable you have built.
# 
#   Modifying Consed is also difficult.  Although Consed is modular,
#   some modules are used by many other modules.  Thus making a change
#   in one place can have unforeseen effects on many other features.
#   It may takes months for you to notice these other side-effects
#   which may not seen connected at all.  It is not feasable for me to
#   provide help with modifying Consed sources because of the
#   potentially huge amount of time involved.
#
#*****************************************************************************/
//
// filename.h
//
// the filename object is a wrapper around a RWCString
// object that supplies convenience member functions,
// including (eventually) extraction of directory, base name, 
// and a simple "versioning" scheme similar to that used by
// VMS based on an appended integer extension.
//

#ifndef FILENAME_INCLUDED
#define FILENAME_INCLUDED


#ifdef SCCS_ID
static const char* filenameSccsId = "@(#)filename.h	1.12 08/25/98 02:00:46";
#endif


#include "rwcstring.h"
#include "sysdepend.h"


class FileName : public RWCString {
 public:
   FileName() {}

   ~FileName() {}

   // from null terminated string
   FileName(const char* szFullPath) : RWCString(szFullPath) {}


   FileName( const size_t nMaxLength ) : RWCString( (size_t) nMaxLength ) {}

   // from RWCString
   FileName(const RWCString& so) : RWCString(so) {}

   // versions of a file are indicated by an appended integer
   // number.  if the initial version is "file.ext", the next
   // version is "file.ext.1", the next "file.ext.2", etc.
   // this function returns a string object containing the
   // next version up from this one
   FileName filGetNextVersion() const;


   // returns -1 if the file has no version
   int  nGetVersion() const;

   // creates a filename with the version 1 higher than any existing
   // filename with the same basename
   FileName filFindOneHigherThanHighestVersion( 
                            const FileName filDirectory,
                            const int nVersionIfNoneExists ) const;

   // same as above, but returns nNewVersion
   FileName filFindOneHigherThanHighestVersion2(
                            const FileName filDirectory,
                            const int nVersionIfNoneExists,
                            int& nNewVersion ) const;

   FileName filFindOneHigherThanHighestVersion3();
                            

   FileName filThisOrOneHigherThanHighestVersion(
                            const FileName filDirectory ) const;


   // returns the directory, i.e. everything up to the last '/'
   // or "./" if there was no directory in the FileName 
   RWCString soGetDirectory() const;


   // returns the file portion of a full path - just like unix
   // basename command, "/blah/foo/myfile.dat.1" becomes "myfile.dat.1"
   RWCString soGetBasename() const;

   // returns the file portion of a full path without the version extension
   // basename command, "/blah/foo/myfile.dat.1" becomes "myfile.dat"

   RWCString soGetBasenameWithoutVersion() const;


   // removes the last extension for the purpose of getting
   // the subclone name
   RWCString soGetBasenameWithoutExtension() const;

   FileName filReplaceExtension( const RWCString& soNewExtension );


   // returns boolean indicating if file by this path name exists
   // uses system stat() call.
   bool bFileByThisNameExists() const;
   bool bIsExecutable();

   RWCString soGetExtension();


   RWCString soGetReadNameFromPhdFileName() const;

   bool bCreateFile();  // puts 1 byte into it.  true if
   // successful

   RWCString soGetProjectFromAceFilename();
   RWCString soGetProjectBeforeEditDir();
   
   long lGetFileSize();

};

#endif