]> git.saurik.com Git - wxWidgets.git/blame - include/wx/filefn.h
added AppendText method, now used by operator <<
[wxWidgets.git] / include / wx / filefn.h
CommitLineData
c801d85f
KB
1/////////////////////////////////////////////////////////////////////////////
2// Name: filefn.h
3// Purpose: File- and directory-related functions
4// Author: Julian Smart
5// Modified by:
6// Created: 29/01/98
7// RCS-ID: $Id$
8// Copyright: (c) 1998 Julian Smart
45ea509a 9// Licence: wxWindows license
c801d85f
KB
10/////////////////////////////////////////////////////////////////////////////
11
34138703
JS
12#ifndef _FILEFN_H_
13#define _FILEFN_H_
c801d85f
KB
14
15#ifdef __GNUG__
16#pragma interface "filefn.h"
17#endif
18
e49f47aa
GL
19#include <wx/list.h>
20
45ea509a
VZ
21// ----------------------------------------------------------------------------
22// constants
23// ----------------------------------------------------------------------------
c801d85f 24
45ea509a 25// define off_t
17dff81c 26#ifndef __WXMAC__
45ea509a 27#include <sys/types.h>
17dff81c
SC
28#else
29typedef long off_t;
30#endif
45ea509a
VZ
31
32#ifdef _MSC_VER
33 #define off_t _off_t
34#endif
35
62448488
JS
36#if defined(__BORLANDC__) && defined(__WIN16__)
37typedef long off_t;
38#endif
39
2432b92d
JS
40#if defined(__SC__)
41typedef long off_t;
42#endif
43
1678ad78
GL
44const off_t wxInvalidOffset = (off_t)-1;
45
45ea509a
VZ
46typedef enum {
47 wxFromStart,
48 wxFromCurrent,
49 wxFromEnd
50} wxSeekMode;
51
cffee23b
RR
52WXDLLEXPORT_DATA(extern const char*) wxEmptyString;
53
45ea509a
VZ
54// ----------------------------------------------------------------------------
55// functions
56// ----------------------------------------------------------------------------
184b5d99 57WXDLLEXPORT bool wxFileExists(const wxString& filename);
c801d85f
KB
58#define FileExists wxFileExists
59
60// does the path exist? (may have or not '/' or '\\' at the end)
184b5d99 61WXDLLEXPORT bool wxPathExists(const char *pszPathName);
c801d85f
KB
62
63#define wxDirExists wxPathExists
64#define DirExists wxDirExists
65
184b5d99 66WXDLLEXPORT bool wxIsAbsolutePath(const wxString& filename);
c801d85f
KB
67#define IsAbsolutePath wxIsAbsolutePath
68
69// Get filename
184b5d99
JS
70WXDLLEXPORT char* wxFileNameFromPath(char *path);
71WXDLLEXPORT wxString wxFileNameFromPath(const wxString& path);
c801d85f
KB
72#define FileNameFromPath wxFileNameFromPath
73
74// Get directory
184b5d99
JS
75WXDLLEXPORT char* wxPathOnly(char *path);
76WXDLLEXPORT wxString wxPathOnly(const wxString& path);
c801d85f
KB
77#define PathOnly wxPathOnly
78
79// wxString version
184b5d99 80WXDLLEXPORT wxString wxRealPath(const wxString& path);
c801d85f 81
184b5d99 82WXDLLEXPORT void wxDos2UnixFilename(char *s);
c801d85f
KB
83#define Dos2UnixFilename wxDos2UnixFilename
84
184b5d99 85WXDLLEXPORT void wxUnix2DosFilename(char *s);
c801d85f
KB
86#define Unix2DosFilename wxUnix2DosFilename
87
17dff81c
SC
88#ifdef __WXMAC__
89 WXDLLEXPORT void wxMacPathToFSSpec( const char *path , FSSpec *spec ) ;
90 WXDLLEXPORT void wxMac2UnixFilename(char *s);
91 WXDLLEXPORT void wxUnix2MacFilename(char *s);
92#endif
c801d85f 93// Strip the extension, in situ
184b5d99
JS
94WXDLLEXPORT void wxStripExtension(char *buffer);
95WXDLLEXPORT void wxStripExtension(wxString& buffer);
c801d85f
KB
96
97// Get a temporary filename, opening and closing the file.
184b5d99 98WXDLLEXPORT char* wxGetTempFileName(const wxString& prefix, char *buf = (char *) NULL);
c801d85f
KB
99
100// Expand file name (~/ and ${OPENWINHOME}/ stuff)
184b5d99 101WXDLLEXPORT char* wxExpandPath(char *dest, const char *path);
c801d85f
KB
102
103// Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
104// and make (if under the home tree) relative to home
105// [caller must copy-- volatile]
3c67202d 106WXDLLEXPORT char* wxContractPath(const wxString& filename,
0a240683
JS
107 const wxString& envname = wxEmptyString,
108 const wxString& user = wxEmptyString);
c801d85f
KB
109
110// Destructive removal of /./ and /../ stuff
184b5d99 111WXDLLEXPORT char* wxRealPath(char *path);
c801d85f
KB
112
113// Allocate a copy of the full absolute path
184b5d99 114WXDLLEXPORT char* wxCopyAbsolutePath(const wxString& path);
c801d85f
KB
115
116// Get first file name matching given wild card.
117// Flags are reserved for future use.
118#define wxFILE 1
119#define wxDIR 2
184b5d99
JS
120WXDLLEXPORT char* wxFindFirstFile(const char *spec, int flags = wxFILE);
121WXDLLEXPORT char* wxFindNextFile(void);
c801d85f
KB
122
123// Does the pattern contain wildcards?
184b5d99 124WXDLLEXPORT bool wxIsWild(const wxString& pattern);
c801d85f
KB
125
126// Does the pattern match the text (usually a filename)?
127// If dot_special is TRUE, doesn't match * against . (eliminating
128// `hidden' dot files)
184b5d99 129WXDLLEXPORT bool wxMatchWild(const wxString& pattern, const wxString& text, bool dot_special = TRUE);
c801d85f
KB
130
131// Concatenate two files to form third
184b5d99 132WXDLLEXPORT bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3);
c801d85f
KB
133
134// Copy file1 to file2
184b5d99 135WXDLLEXPORT bool wxCopyFile(const wxString& file1, const wxString& file2);
c801d85f
KB
136
137// Remove file
184b5d99 138WXDLLEXPORT bool wxRemoveFile(const wxString& file);
c801d85f
KB
139
140// Rename file
184b5d99 141WXDLLEXPORT bool wxRenameFile(const wxString& file1, const wxString& file2);
c801d85f
KB
142
143// Get current working directory.
144// If buf is NULL, allocates space using new, else
145// copies into buf.
146// IMPORTANT NOTE getcwd is know not to work under some releases
147// of Win32s 1.3, according to MS release notes!
184b5d99 148WXDLLEXPORT char* wxGetWorkingDirectory(char *buf = (char *) NULL, int sz = 1000);
c801d85f
KB
149
150// Set working directory
184b5d99 151WXDLLEXPORT bool wxSetWorkingDirectory(const wxString& d);
c801d85f
KB
152
153// Make directory
184b5d99 154WXDLLEXPORT bool wxMkdir(const wxString& dir);
c801d85f
KB
155
156// Remove directory. Flags reserved for future use.
184b5d99 157WXDLLEXPORT bool wxRmdir(const wxString& dir, int flags = 0);
c801d85f
KB
158
159// separators in file names
160#define FILE_SEP_EXT '.'
161#define FILE_SEP_DSK ':'
162#define FILE_SEP_PATH_DOS '\\'
163#define FILE_SEP_PATH_UNIX '/'
164
165// separator in the path list (as in PATH environment variable)
166// NB: these are strings and not characters on purpose!
167#define PATH_SEP_DOS ";"
168#define PATH_SEP_UNIX ":"
169
170// platform independent versions
171#ifdef __UNIX__
172 #define FILE_SEP_PATH FILE_SEP_PATH_UNIX
173 #define PATH_SEP PATH_SEP_UNIX
174#else // Windows
175 #define FILE_SEP_PATH FILE_SEP_PATH_DOS
176 #define PATH_SEP PATH_SEP_DOS
177#endif // Unix/Windows
178
92abb45d
VZ
179// this is useful for wxString::IsSameAs(): to compare two file names use
180// filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)
181#ifdef __UNIX__
182 #define wxARE_FILENAMES_CASE_SENSITIVE TRUE
183#else // Windows
184 #define wxARE_FILENAMES_CASE_SENSITIVE FALSE
185#endif // Unix/Windows
186
c801d85f
KB
187// is the char a path separator?
188inline bool wxIsPathSeparator(char c)
189 { return c == FILE_SEP_PATH_DOS || c == FILE_SEP_PATH_UNIX; }
190
191// does the string ends with path separator?
184b5d99 192WXDLLEXPORT bool wxEndsWithPathSeparator(const char *pszFileName);
c801d85f 193
92abb45d
VZ
194// split the full path into path (including drive for DOS), name and extension
195// (understands both '/' and '\\')
184b5d99 196WXDLLEXPORT void wxSplitPath(const char *pszFileName,
92abb45d
VZ
197 wxString *pstrPath,
198 wxString *pstrName,
199 wxString *pstrExt);
200
c801d85f 201// find a file in a list of directories, returns false if not found
184b5d99 202WXDLLEXPORT bool wxFindFileInPath(wxString *pStr, const char *pszPath, const char *pszFile);
c801d85f 203
45ea509a
VZ
204// ----------------------------------------------------------------------------
205// classes
206// ----------------------------------------------------------------------------
207
c801d85f 208// Path searching
a6f6393c 209class WXDLLEXPORT wxPathList : public wxStringList
c801d85f 210{
a6f6393c
VZ
211public:
212 void AddEnvList(const wxString& envVariable); // Adds all paths in environment variable
c330a2cf 213
a6f6393c 214 void Add(const wxString& path);
c330a2cf
JS
215 // Avoid compiler warning
216 wxNode *Add(const char *s) { return wxStringList::Add(s); }
217
a6f6393c
VZ
218 wxString FindValidPath(const wxString& filename); // Find the first full path
219 // for which the file exists
220 wxString FindAbsoluteValidPath(const wxString& filename); // Find the first full path
221 // for which the file exists; ensure it's an absolute
222 // path that gets returned.
223 void EnsureFileAccessible(const wxString& path); // Given full path and filename,
224 // add path to list
225 bool Member(const wxString& path);
226
227private:
228 DECLARE_DYNAMIC_CLASS(wxPathList)
c801d85f
KB
229};
230
231#endif
34138703 232 // _WX_FILEFN_H_
c801d85f 233