Initial revision

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@2 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

include/wx/filefn.h

@@ -0,0 +1,166 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        filefn.h
+// Purpose:     File- and directory-related functions
+// Author:      Julian Smart
+// Modified by:
+// Created:     29/01/98
+// RCS-ID:      $Id$
+// Copyright:   (c) 1998 Julian Smart
+// Licence:   	wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+#ifndef   __FILEFNH__
+#define   __FILEFNH__
+
+#ifdef __GNUG__
+#pragma interface "filefn.h"
+#endif
+
+#include "wx/list.h"
+
+bool WXDLLEXPORT wxFileExists(const wxString& filename);
+#define FileExists wxFileExists
+
+// does the path exist? (may have or not '/' or '\\' at the end)
+bool WXDLLEXPORT wxPathExists(const char *pszPathName);
+
+#define wxDirExists wxPathExists
+#define DirExists wxDirExists
+
+bool WXDLLEXPORT wxIsAbsolutePath(const wxString& filename);
+#define IsAbsolutePath wxIsAbsolutePath
+
+// Get filename
+char* WXDLLEXPORT wxFileNameFromPath(char *path);
+wxString WXDLLEXPORT wxFileNameFromPath(const wxString& path);
+#define FileNameFromPath wxFileNameFromPath
+
+// Get directory
+char* WXDLLEXPORT wxPathOnly(char *path);
+wxString WXDLLEXPORT wxPathOnly(const wxString& path);
+#define PathOnly wxPathOnly
+
+// wxString version
+wxString WXDLLEXPORT wxRealPath(const wxString& path);
+
+void WXDLLEXPORT wxDos2UnixFilename(char *s);
+#define Dos2UnixFilename wxDos2UnixFilename
+
+void WXDLLEXPORT wxUnix2DosFilename(char *s);
+#define Unix2DosFilename wxUnix2DosFilename
+
+// Strip the extension, in situ
+void WXDLLEXPORT wxStripExtension(char *buffer);
+
+// Get a temporary filename, opening and closing the file.
+char* WXDLLEXPORT wxGetTempFileName(const wxString& prefix, char *buf = NULL);
+
+// Expand file name (~/ and ${OPENWINHOME}/ stuff)
+char* WXDLLEXPORT wxExpandPath(char *dest, const char *path);
+
+// Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
+// and make (if under the home tree) relative to home
+// [caller must copy-- volatile]
+char* WXDLLEXPORT wxContractPath (const wxString& filename,
+   const wxString& envname = "", const wxString& user = "");
+
+// Destructive removal of /./ and /../ stuff
+char* WXDLLEXPORT wxRealPath(char *path);
+
+// Allocate a copy of the full absolute path
+char* WXDLLEXPORT wxCopyAbsolutePath(const wxString& path);
+
+// Get first file name matching given wild card.
+// Flags are reserved for future use.
+#define wxFILE  1
+#define wxDIR   2
+char* WXDLLEXPORT wxFindFirstFile(const char *spec, int flags = wxFILE);
+char* WXDLLEXPORT wxFindNextFile(void);
+
+// Does the pattern contain wildcards?
+bool WXDLLEXPORT wxIsWild(const wxString& pattern);
+
+// Does the pattern match the text (usually a filename)?
+// If dot_special is TRUE, doesn't match * against . (eliminating
+// `hidden' dot files)
+bool WXDLLEXPORT wxMatchWild(const wxString& pattern,  const wxString& text, bool dot_special = TRUE);
+
+// Concatenate two files to form third
+bool WXDLLEXPORT wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3);
+
+// Copy file1 to file2
+bool WXDLLEXPORT wxCopyFile(const wxString& file1, const wxString& file2);
+
+// Remove file
+bool WXDLLEXPORT wxRemoveFile(const wxString& file);
+
+// Rename file
+bool WXDLLEXPORT wxRenameFile(const wxString& file1, const wxString& file2);
+
+// Get current working directory.
+// If buf is NULL, allocates space using new, else
+// copies into buf.
+// IMPORTANT NOTE getcwd is know not to work under some releases
+// of Win32s 1.3, according to MS release notes!
+char* WXDLLEXPORT wxGetWorkingDirectory(char *buf = NULL, int sz = 1000);
+
+// Set working directory
+bool WXDLLEXPORT wxSetWorkingDirectory(const wxString& d);
+
+// Make directory
+bool WXDLLEXPORT wxMkdir(const wxString& dir);
+
+// Remove directory. Flags reserved for future use.
+bool WXDLLEXPORT wxRmdir(const wxString& dir, int flags = 0);
+
+// separators in file names
+#define FILE_SEP_EXT        '.'
+#define FILE_SEP_DSK        ':'
+#define FILE_SEP_PATH_DOS   '\\'
+#define FILE_SEP_PATH_UNIX  '/'
+
+// separator in the path list (as in PATH environment variable)
+// NB: these are strings and not characters on purpose!
+#define PATH_SEP_DOS        ";"
+#define PATH_SEP_UNIX       ":"
+
+// platform independent versions
+#ifdef  __UNIX__
+  #define FILE_SEP_PATH     FILE_SEP_PATH_UNIX
+  #define PATH_SEP          PATH_SEP_UNIX
+#else   // Windows
+  #define FILE_SEP_PATH     FILE_SEP_PATH_DOS
+  #define PATH_SEP          PATH_SEP_DOS
+#endif  // Unix/Windows
+
+// is the char a path separator?
+inline bool wxIsPathSeparator(char c)
+  { return c == FILE_SEP_PATH_DOS || c == FILE_SEP_PATH_UNIX; }
+
+// does the string ends with path separator?
+bool WXDLLEXPORT wxEndsWithPathSeparator(const char *pszFileName);
+
+// find a file in a list of directories, returns false if not found
+bool WXDLLEXPORT wxFindFileInPath(wxString *pStr, const char *pszPath, const char *pszFile);
+
+// Path searching
+class WXDLLEXPORT wxPathList: public wxStringList
+{
+  DECLARE_DYNAMIC_CLASS(wxPathList)
+
+  public:
+  void AddEnvList(const wxString& envVariable);    // Adds all paths in environment variable
+  void Add(const wxString& path);
+  wxString FindValidPath(const wxString& filename);   // Find the first full path
+                                         // for which the file exists
+  wxString FindAbsoluteValidPath(const wxString& filename);   // Find the first full path
+                                         // for which the file exists; ensure it's an absolute
+                                         // path that gets returned.
+  void EnsureFileAccessible(const wxString& path); // Given full path and filename,
+                                         // add path to list
+  bool Member(const wxString& path);
+};
+
+#endif
+  // __FILEFNH__
+