lcn_directory.h

Go to the documentation of this file.

/* Copyright 2005 The Apache Software Foundation or its licensors, as
 * applicable.
 *
 * Licensed 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.
 */

/**
 * @file lcn_directory.h
 * @brief Routines for working with various types of directories
 */

#ifndef _LCN_DIRECTORY_H
#define _LCN_DIRECTORY_H

#include "lcn_types.h"
#include "lcn_istream.h"

#include <apr_hash.h>
#include <apr_tables.h>
#include <apr_time.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/** An opaque directory object. */
typedef struct lcn_directory_t lcn_directory_t;

/** An entry in a ram-based directory. */
typedef struct {
  const char *bytes; /**< The actual contents of the file */
  apr_size_t len;    /**< The length of the contents in bytes */
  apr_time_t mtime;  /**< The time the file was last modified on */
} lcn_directory_entry_t;

/** Open a new ram-backed directory @a dir, allocated within @a pool.
 *
 * @a contents maps from <tt>const char *</tt> filenames to pointers to
 * @c lcn_directory_entry_t objects.
 */
lcn_error_t *
lcn_ram_directory_open (lcn_directory_t **dir,
                        apr_hash_t *contents,
                        apr_pool_t *pool);

/** Open a new directory object @a dir which corresponds to the filesystem
 * directory located at @a path, all allocation is done within @a pool.
 */
lcn_error_t *
lcn_fs_directory_open (lcn_directory_t **dir,
                       const char *path,
                       apr_pool_t *pool);

/** Open an new compound file stream directory @a dir, using the stream
 * @a cfsfile for the backing store, all allocation is done within @a pool.
 */
lcn_error_t *
lcn_cfs_directory_open (lcn_directory_t **dir,
                        lcn_istream_t *cfsfile,
                        apr_pool_t *pool);

/** Return in @a contents a list of the files within directory @a d, allocated
 * in @a pool.
 *
 * @a contents will contain <tt>const char *</tt> filenames.
 */
lcn_error_t *
lcn_directory_list (apr_array_header_t **contents,
                    const lcn_directory_t *d,
                    apr_pool_t *pool);

/** If file @a name exists in directory @a d return @c TRUE in @a result,
 * otherwise return @c FALSE in @a result.
 *
 * @a pool is used for all temporary allocations.
 */
lcn_error_t *
lcn_directory_file_exists (lcn_boolean_t *result,
                           const lcn_directory_t *d,
                           const char *name,
                           apr_pool_t *pool);

/** Return the time file @a name in directory @a d was modified in @a result,
 * using @a pool for temporary allocations.
 */
lcn_error_t *
lcn_directory_file_modified (apr_time_t *result,
                             const lcn_directory_t *d,
                             const char *name,
                             apr_pool_t *pool);

/** Update the modification time for file @a name in directory @a d, using
 * @a pool for any temporary allocations.
 */
lcn_error_t *
lcn_directory_touch_file (lcn_directory_t *d,
                          const char *name,
                          apr_pool_t *pool);

/** Delete file @a name in directory @a d, using @a pool for any temporary
 * allocations.
 */
lcn_error_t *
lcn_directory_delete_file (lcn_directory_t *d,
                           const char *name,
                           apr_pool_t *pool);

/** Rename file @a from to @a to within directory @a d, using @a pool for
 * temporary allocations.
 */
lcn_error_t *
lcn_directory_rename_file (lcn_directory_t *d,
                           const char *from,
                           const char *to,
                           apr_pool_t *pool);

#ifdef NOTYET
lcn_error_t *
lcn_directory_create_file (lcn_ostream_t **result,
                           lcn_directory_t *d,
                           const char *name,
                           apr_pool_t *pool);
#endif

/** Open file @a name in directory @a d for reading, returning a corresponding
 * stream in @a result, using @a pool for all allocation.
 */
lcn_error_t *
lcn_directory_open_file (lcn_istream_t **result,
                         const lcn_directory_t *d,
                         const char *name,
                         apr_pool_t *pool);

#ifdef NOTYET
lcn_error_t *
lcn_directory_make_lock (lcn_lock_t **lock,
                         lcn_directory_t *d,
                         const char *name,
                         apr_pool_t *pool);
#endif

/** Close directory @a d, using @a pool for any temporary allocation.
 *
 * @note This isn't strictly necessary, you can just let pool cleanups clean
 * up the directory for you if you want.
 */
lcn_error_t *
lcn_directory_close (lcn_directory_t *d, apr_pool_t *pool);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif

---