file.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef _LOG4CXX_FILE_H
#define _LOG4CXX_FILE_H
 
#include <log4cxx/logger.h>
#include <log4cxx/logstring.h>
 
extern "C" {
    struct apr_file_t;
    struct apr_finfo_t;
}
 
namespace LOG4CXX_NS
{
namespace helpers
{
class Transcoder;
class Pool;
}

class LOG4CXX_EXPORT File
{
    public:
        File();
        File(const char* path);
        File(const std::string& path);
#if LOG4CXX_WCHAR_T_API
        File(const wchar_t* path);
        File(const std::wstring& path);
#endif
#if LOG4CXX_UNICHAR_API || LOG4CXX_LOGCHAR_IS_UNICHAR
        File(const UniChar* path);
        File(const std::basic_string<UniChar>& path);
#endif
#if LOG4CXX_CFSTRING_API
        File(const CFStringRef& path);
#endif
        File(const File& src);
        File& operator=(const File& src);
        ~File();

        bool exists() const;
        size_t length() const;
        log4cxx_time_t lastModified() const;
        LogString getName() const;
        LogString getPath() const;
        const char* getAPRPath() const;
        File& setPath(const LogString& newVAlue);
 
#if LOG4CXX_ABI_VERSION <= 15
        [[ deprecated( "open is no longer supported" ) ]]
        log4cxx_status_t open(apr_file_t** file, int flags, int perm, helpers::Pool& p) const;
#endif

        std::vector<LogString> list() const;

        bool deleteFile() const;
        bool renameTo(const File& dest) const;

        LogString getParent() const;
        bool mkdirs() const;

        void setAutoDelete(bool newValue);

        bool getAutoDelete() const;
 
#if LOG4CXX_ABI_VERSION <= 15
        [[ deprecated( "Pool is no longer required" ) ]]
        bool exists(helpers::Pool& p) const;
        [[ deprecated( "Pool is no longer required" ) ]]
        size_t length(helpers::Pool& p) const;
        [[ deprecated( "Pool is no longer required" ) ]]
        log4cxx_time_t lastModified(helpers::Pool& p) const;
        [[ deprecated( "Pool is no longer required" ) ]]
        std::vector<LogString> list(helpers::Pool& p) const;
        [[ deprecated( "Pool is no longer required" ) ]]
        bool deleteFile(helpers::Pool& p) const;
        [[ deprecated( "Pool is no longer required" ) ]]
        bool renameTo(const File& dest, helpers::Pool& p) const;
        [[ deprecated( "Pool is no longer required" ) ]]
        LogString getParent(helpers::Pool& p) const;
        [[ deprecated( "Pool is no longer required" ) ]]
        bool mkdirs(helpers::Pool& p) const;
#endif
    private:
        LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(FilePrivate, m_priv)
};
} // namespace log4cxx
 
#define LOG4CXX_FILE(name) File(name)
 
#endif // _LOG4CXX_FILE_H