Apache Log4cxx  Version 1.1.0
file.h
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #ifndef _LOG4CXX_FILE_H
19 #define _LOG4CXX_FILE_H
20 
21 #include <log4cxx/logger.h>
22 #include <log4cxx/logstring.h>
23 
24 extern "C" {
25  struct apr_file_t;
26  struct apr_finfo_t;
27 }
28 
29 namespace log4cxx
30 {
31 namespace helpers
32 {
33 class Transcoder;
34 class Pool;
35 }
36 
40 class LOG4CXX_EXPORT File
41 {
42  public:
46  File();
51  File(const char* path);
56  File(const std::string& path);
57 #if LOG4CXX_WCHAR_T_API
62  File(const wchar_t* path);
67  File(const std::wstring& path);
68 #endif
69 #if LOG4CXX_UNICHAR_API
74  File(const UniChar* path);
79  File(const std::basic_string<UniChar>& path);
80 #endif
81 #if LOG4CXX_CFSTRING_API
86  File(const CFStringRef& path);
87 #endif
91  File(const File& src);
95  File& operator=(const File& src);
99  ~File();
100 
112  size_t length(log4cxx::helpers::Pool& p) const;
118  log4cxx_time_t lastModified(log4cxx::helpers::Pool& p) const;
133 
142  log4cxx_status_t open(apr_file_t** file, int flags,
143  int perm, log4cxx::helpers::Pool& p) const;
144 
150  std::vector<LogString> list(log4cxx::helpers::Pool& p) const;
151 
164  bool renameTo(const File& dest, log4cxx::helpers::Pool& p) const;
165 
178 
183  void setAutoDelete(bool autoDelete);
184 
191  bool getAutoDelete() const;
192 
193  private:
194  LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(FilePrivate, m_priv)
195  static char* convertBackSlashes(char*);
196  char* getPath(log4cxx::helpers::Pool& p) const;
197 };
198 } // namespace log4cxx
199 
200 #define LOG4CXX_FILE(name) log4cxx::File(name)
201 
202 #endif // _LOG4CXX_FILE_H
An abstract representation of file and directory path names.
Definition: file.h:41
File(const wchar_t *path)
Construct a new instance.
bool getAutoDelete() const
Return the value of the autodelete setting.
log4cxx_time_t lastModified(log4cxx::helpers::Pool &p) const
Determines last modification date.
File(const std::basic_string< UniChar > &path)
Construct a new instance.
LogString getName() const
Get final portion of file path.
bool renameTo(const File &dest, log4cxx::helpers::Pool &p) const
Rename file.
LogString getParent(log4cxx::helpers::Pool &p) const
Get path of parent directory.
bool exists(log4cxx::helpers::Pool &p) const
Determines if file exists.
std::vector< LogString > list(log4cxx::helpers::Pool &p) const
List files if current file is a directory.
~File()
Destructor.
File(const CFStringRef &path)
Construct a new instance.
File(const std::wstring &path)
Construct a new instance.
bool deleteFile(log4cxx::helpers::Pool &p) const
Delete file.
log4cxx_status_t open(apr_file_t **file, int flags, int perm, log4cxx::helpers::Pool &p) const
Open file.
File(const File &src)
Copy constructor.
File()
Construct a new instance.
File(const std::string &path)
Construct a new instance.
File(const char *path)
Construct a new instance.
void setAutoDelete(bool autoDelete)
Set the file to be deleted when this object is destroyed.
File & setPath(const LogString &)
Set file path.
File & operator=(const File &src)
Assignment operator.
LogString getPath() const
Get file path.
size_t length(log4cxx::helpers::Pool &p) const
Determines length of file.
bool mkdirs(log4cxx::helpers::Pool &p) const
Make directories recursively.
File(const UniChar *path)
Construct a new instance.
Definition: pool.h:33
const struct __CFString * CFStringRef
Definition: logstring.h:30
Definition: appender.h:27
std::basic_string< logchar > LogString
Definition: logstring.h:60
unsigned short UniChar
Definition: logstring.h:38