133 lines
4.8 KiB
C++
133 lines
4.8 KiB
C++
/**
|
|
* @file llapr.h
|
|
* @author Phoenix
|
|
* @date 2004-11-28
|
|
* @brief Helper functions for using the apache portable runtime library.
|
|
*
|
|
* $LicenseInfo:firstyear=2004&license=viewerlgpl$
|
|
* Second Life Viewer Source Code
|
|
* Copyright (C) 2010, Linden Research, Inc.
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation;
|
|
* version 2.1 of the License only.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*
|
|
* Linden Research, Inc., 945 Battery Street, San Francisco, CA 94111 USA
|
|
* $/LicenseInfo$
|
|
*/
|
|
|
|
#ifndef LL_LLAPR_H
|
|
#define LL_LLAPR_H
|
|
|
|
#if LL_LINUX || LL_SOLARIS
|
|
#include <sys/param.h> // Need PATH_MAX in APR headers...
|
|
#endif
|
|
|
|
#include "llwin32headerslean.h"
|
|
|
|
#include <boost/noncopyable.hpp>
|
|
|
|
#include "apr_thread_proc.h"
|
|
#include "apr_getopt.h"
|
|
#include "llstring.h"
|
|
|
|
class LLAPRPool;
|
|
class LLVolatileAPRPool;
|
|
|
|
// File IO convenience functions.
|
|
// Returns NULL if the file fails to open, sets *sizep to file size if not NULL
|
|
// abbreviated flags
|
|
#define LL_APR_R (APR_READ) // "r"
|
|
#define LL_APR_W (APR_CREATE|APR_TRUNCATE|APR_WRITE) // "w"
|
|
#define LL_APR_RB (APR_READ|APR_BINARY) // "rb"
|
|
#define LL_APR_WB (APR_CREATE|APR_TRUNCATE|APR_WRITE|APR_BINARY) // "wb"
|
|
#define LL_APR_RPB (APR_READ|APR_WRITE|APR_BINARY) // "r+b"
|
|
#define LL_APR_WPB (APR_CREATE|APR_TRUNCATE|APR_READ|APR_WRITE|APR_BINARY) // "w+b"
|
|
|
|
//
|
|
//apr_file manager
|
|
//which: 1)only keeps one file open;
|
|
// 2)closes the open file in the destruction function
|
|
// 3)informs the apr_pool to clean the memory when the file is closed.
|
|
//Note: please close an open file at the earliest convenience.
|
|
// especially do not put some time-costly operations between open() and close().
|
|
// otherwise it might lock the APRFilePool.
|
|
//there are two different apr_pools the APRFile can use:
|
|
// 1, a temporary pool passed to an APRFile function, which is used within this function and only once.
|
|
// 2, a global pool.
|
|
//
|
|
|
|
class LL_COMMON_API LLAPRFile : boost::noncopyable
|
|
{
|
|
// make this non copyable since a copy closes the file
|
|
private:
|
|
apr_file_t* mFile ;
|
|
LLVolatileAPRPool* mVolatileFilePoolp; // (Thread local) APR pool currently in use.
|
|
LLAPRPool* mRegularFilePoolp; // ...or a regular pool.
|
|
|
|
public:
|
|
enum access_t {
|
|
long_lived, // Use a global pool for long-lived file accesses.
|
|
short_lived // Use a volatile pool for short-lived file accesses.
|
|
};
|
|
|
|
LLAPRFile() ;
|
|
LLAPRFile(const std::string& filename, apr_int32_t flags, S32* sizep = NULL, access_t access_type = short_lived);
|
|
~LLAPRFile() ;
|
|
|
|
apr_status_t open(const std::string& filename, apr_int32_t flags, access_t access_type = short_lived, S32* sizep = NULL);
|
|
apr_status_t open(const std::string& filename, apr_int32_t flags, BOOL use_global_pool); //use global pool.
|
|
apr_status_t close() ;
|
|
|
|
// Returns actual offset, -1 if seek fails
|
|
S32 seek(apr_seek_where_t where, S32 offset);
|
|
apr_status_t eof() { return apr_file_eof(mFile);}
|
|
|
|
// Returns bytes read/written, 0 if read/write fails:
|
|
S32 read(void* buf, U64 nbytes);
|
|
S32 write(const void* buf, U64 nbytes);
|
|
|
|
apr_file_t* getFileHandle() {return mFile;}
|
|
|
|
//
|
|
// *******************************************************************************************************************************
|
|
//static components
|
|
//
|
|
private:
|
|
static S32 seek(apr_file_t* file, apr_seek_where_t where, S32 offset);
|
|
public:
|
|
// returns false if failure:
|
|
static bool remove(const std::string& filename);
|
|
static bool rename(const std::string& filename, const std::string& newname);
|
|
static bool isExist(const std::string& filename, apr_int32_t flags = APR_READ);
|
|
static S32 size(const std::string& filename);
|
|
static bool makeDir(const std::string& dirname);
|
|
static bool removeDir(const std::string& dirname);
|
|
|
|
// Returns bytes read/written, 0 if read/write fails:
|
|
static S32 readEx(const std::string& filename, void *buf, S32 offset, S32 nbytes);
|
|
static S32 writeEx(const std::string& filename, void *buf, S32 offset, S32 nbytes);
|
|
// *******************************************************************************************************************************
|
|
};
|
|
|
|
/**
|
|
* @brief Function which appropriately logs error or remains quiet on
|
|
* APR_SUCCESS.
|
|
* @return Returns <code>true</code> if status is an error condition.
|
|
*/
|
|
bool LL_COMMON_API ll_apr_warn_status(apr_status_t status);
|
|
|
|
void LL_COMMON_API ll_apr_assert_status(apr_status_t status);
|
|
|
|
#endif // LL_LLAPR_H
|