svn_io.h File Reference

General file I/O for Subversion. More...

#include <apr.h>
#include <apr_pools.h>
#include <apr_time.h>
#include <apr_hash.h>
#include <apr_tables.h>
#include <apr_file_io.h>
#include <apr_file_info.h>
#include <apr_thread_proc.h>
#include "svn_types.h"
#include "svn_string.h"
#include "svn_checksum.h"

Go to the source code of this file.

Data Structures
struct	svn_io_dirent2_t
	A set of directory entry data elements as returned by svn_io_get_dirents. More...
struct	svn_io_dirent_t
	Represents the kind and special status of a directory entry. More...
Typedefs
typedef enum svn_io_file_del_t	svn_io_file_del_t
	Used as an argument when creating temporary files to indicate when a file should be removed.
typedef struct svn_io_dirent2_t	svn_io_dirent2_t
	A set of directory entry data elements as returned by svn_io_get_dirents.
typedef struct svn_io_dirent_t	svn_io_dirent_t
	Represents the kind and special status of a directory entry.
typedef struct svn_stream_t	svn_stream_t
	An abstract stream of bytes--either incoming or outgoing or both.
typedef svn_error_t (	svn_read_fn_t )(void baton, char buffer, apr_size_t *len)
	Read handler function for a generic stream.
typedef svn_error_t (	svn_stream_skip_fn_t )(void *baton, apr_size_t len)
	Skip data handler function for a generic stream.
typedef svn_error_t (	svn_write_fn_t )(void baton, const char data, apr_size_t *len)
	Write handler function for a generic stream.
typedef svn_error_t (	svn_close_fn_t )(void *baton)
	Close handler function for a generic stream.
typedef struct svn_stream_mark_t	svn_stream_mark_t
	An opaque type which represents a mark on a stream.
typedef svn_error_t (	svn_stream_mark_fn_t )(void baton, svn_stream_mark_t mark, apr_pool_t pool)
	Mark handler function for a generic stream.
typedef svn_error_t (	svn_stream_seek_fn_t )(void baton, const svn_stream_mark_t mark)
	Seek handler function for a generic stream.
typedef svn_error_t (	svn_io_walk_func_t )(void baton, const char path, const apr_finfo_t finfo, apr_pool_t pool)
	Callback function type for svn_io_dir_walk().
Enumerations
enum	svn_io_file_del_t { svn_io_file_del_none = 0, svn_io_file_del_on_close, svn_io_file_del_on_pool_cleanup }
	Used as an argument when creating temporary files to indicate when a file should be removed. More...
Functions
svn_io_dirent2_t *	svn_io_dirent2_create (apr_pool_t *result_pool)
	Creates a new svn_io_dirent2_t structure.
svn_io_dirent2_t *	svn_io_dirent2_dup (const svn_io_dirent2_t item, apr_pool_t result_pool)
	Duplicates a `svn_io_dirent2_t` structure into result_pool.
svn_error_t *	svn_io_check_path (const char path, svn_node_kind_t kind, apr_pool_t *pool)
	Determine the kind of path.
svn_error_t *	svn_io_check_special_path (const char path, svn_node_kind_t kind, svn_boolean_t is_special, apr_pool_t pool)
	Like svn_io_check_path(), but also set *is_special to `TRUE` if the path is not a normal file.
svn_error_t *	svn_io_check_resolved_path (const char path, svn_node_kind_t kind, apr_pool_t *pool)
	Like svn_io_check_path(), but resolve symlinks.
svn_error_t *	svn_io_open_uniquely_named (apr_file_t file, const char unique_name, const char dirpath, const char filename, const char suffix, svn_io_file_del_t delete_when, apr_pool_t result_pool, apr_pool_t *scratch_pool)
	Open a new file (for reading and writing) with a unique name based on utf-8 encoded filename, in the directory dirpath.
svn_error_t *	svn_io_open_unique_file3 (apr_file_t file, const char temp_path, const char dirpath, svn_io_file_del_t delete_when, apr_pool_t result_pool, apr_pool_t *scratch_pool)
	Create a writable file, with an arbitrary and unique name, in the directory dirpath.
SVN_DEPRECATED svn_error_t *	svn_io_open_unique_file2 (apr_file_t f, const char unique_name_p, const char path, const char suffix, svn_io_file_del_t delete_when, apr_pool_t *pool)
	Like svn_io_open_uniquely_named(), but takes a joined dirpath and filename, and a single pool.
SVN_DEPRECATED svn_error_t *	svn_io_open_unique_file (apr_file_t f, const char unique_name_p, const char path, const char suffix, svn_boolean_t delete_on_close, apr_pool_t *pool)
	Like svn_io_open_unique_file2, but can't delete on pool cleanup.
svn_error_t *	svn_io_create_unique_link (const char *unique_name_p, const char path, const char dest, const char suffix, apr_pool_t *pool)
	Like svn_io_open_unique_file(), except that instead of creating a file, a symlink is generated that references the path dest.
svn_error_t *	svn_io_read_link (svn_string_t *dest, const char path, apr_pool_t *pool)
	Set dest to the path that the symlink at path* references.
svn_error_t *	svn_io_temp_dir (const char *dir, apr_pool_t pool)
	Set dir to a directory path (allocated in pool*) deemed usable for the creation of temporary files and subdirectories.
svn_error_t *	svn_io_copy_file (const char src, const char dst, svn_boolean_t copy_perms, apr_pool_t *pool)
	Copy src to dst atomically, in a "byte-for-byte" manner.
svn_error_t *	svn_io_copy_perms (const char src, const char dst, apr_pool_t *pool)
	Copy permission flags from src onto the file at dst.
svn_error_t *	svn_io_copy_link (const char src, const char dst, apr_pool_t *pool)
	Copy symbolic link src to dst atomically.
svn_error_t *	svn_io_copy_dir_recursively (const char src, const char dst_parent, const char dst_basename, svn_boolean_t copy_perms, svn_cancel_func_t cancel_func, void cancel_baton, apr_pool_t *pool)
	Recursively copy directory src into dst_parent, as a new entry named dst_basename.
svn_error_t *	svn_io_make_dir_recursively (const char path, apr_pool_t pool)
	Create directory path on the file system, creating intermediate directories as required, like `mkdir -p`.
svn_error_t *	svn_io_dir_empty (svn_boolean_t is_empty_p, const char path, apr_pool_t *pool)
	Set is_empty_p to `TRUE` if directory path* is empty, else to `FALSE` if it is not empty.
svn_error_t *	svn_io_append_file (const char src, const char dst, apr_pool_t *pool)
	Append src to dst.
svn_error_t *	svn_io_set_file_read_only (const char path, svn_boolean_t ignore_enoent, apr_pool_t pool)
	Make a file as read-only as the operating system allows.
svn_error_t *	svn_io_set_file_read_write (const char path, svn_boolean_t ignore_enoent, apr_pool_t pool)
	Make a file as writable as the operating system allows.
SVN_DEPRECATED svn_error_t *	svn_io_set_file_read_write_carefully (const char path, svn_boolean_t enable_write, svn_boolean_t ignore_enoent, apr_pool_t pool)
	Similar to svn_io_set_file_read_* functions.
svn_error_t *	svn_io_set_file_executable (const char path, svn_boolean_t executable, svn_boolean_t ignore_enoent, apr_pool_t pool)
	Set path's "executability" (but do nothing if it is a symlink).
svn_error_t *	svn_io_is_file_executable (svn_boolean_t executable, const char path, apr_pool_t *pool)
	Determine whether a file is executable by the current user.
svn_error_t *	svn_io_read_length_line (apr_file_t file, char buf, apr_size_t limit, apr_pool_t pool)
	Read a line from file into buf, but not exceeding *limit bytes.
svn_error_t *	svn_io_file_affected_time (apr_time_t apr_time, const char path, apr_pool_t *pool)
	Set apr_time to the time of last modification of the contents of the file path*.
svn_error_t *	svn_io_set_file_affected_time (apr_time_t apr_time, const char path, apr_pool_t pool)
	Set the timestamp of file path to apr_time.
void	svn_io_sleep_for_timestamps (const char path, apr_pool_t pool)
	Sleep to ensure that any files modified after we exit have a different timestamp than the one we recorded.
svn_error_t *	svn_io_filesizes_different_p (svn_boolean_t different_p, const char file1, const char file2, apr_pool_t pool)
	Set different_p to non-zero if file1* and file2 have different sizes, else set to zero.
svn_error_t *	svn_io_file_checksum2 (svn_checksum_t *checksum, const char file, svn_checksum_kind_t kind, apr_pool_t *pool)
	Return in checksum the checksum of type kind* of file Use pool for temporary allocations and to allocate *checksum.
SVN_DEPRECATED svn_error_t *	svn_io_file_checksum (unsigned char digest[], const char file, apr_pool_t pool)
	Put the md5 checksum of file into digest.
svn_error_t *	svn_io_files_contents_same_p (svn_boolean_t same, const char file1, const char file2, apr_pool_t pool)
	Set same to TRUE if file1* and file2 have the same contents, else set it to FALSE.
svn_error_t *	svn_io_file_create (const char file, const char contents, apr_pool_t *pool)
	Create file at utf8-encoded file with contents contents.
SVN_DEPRECATED svn_error_t *	svn_io_file_lock (const char lock_file, svn_boolean_t exclusive, apr_pool_t pool)
	Lock file at lock_file.
svn_error_t *	svn_io_file_lock2 (const char lock_file, svn_boolean_t exclusive, svn_boolean_t nonblocking, apr_pool_t pool)
	Lock file at lock_file.
svn_error_t *	svn_io_file_flush_to_disk (apr_file_t file, apr_pool_t pool)
	Flush any unwritten data from file to disk.
svn_error_t *	svn_io_dir_file_copy (const char src_path, const char dest_path, const char file, apr_pool_t pool)
	Copy the file whose basename (or relative path) is file within directory src_path to the same basename (or relative path) within directory dest_path.
svn_stream_t *	svn_stream_create (void baton, apr_pool_t pool)
	Create a generic stream.
void	svn_stream_set_baton (svn_stream_t stream, void baton)
	Set stream's baton to baton.
void	svn_stream_set_read (svn_stream_t *stream, svn_read_fn_t read_fn)
	Set stream's read function to read_fn.
void	svn_stream_set_skip (svn_stream_t *stream, svn_stream_skip_fn_t skip_fn)
	Set stream's skip function to skip_fn.
void	svn_stream_set_write (svn_stream_t *stream, svn_write_fn_t write_fn)
	Set stream's write function to write_fn.
void	svn_stream_set_close (svn_stream_t *stream, svn_close_fn_t close_fn)
	Set stream's close function to close_fn.
void	svn_stream_set_mark (svn_stream_t *stream, svn_stream_mark_fn_t mark_fn)
	Set stream's mark function to mark_fn.
void	svn_stream_set_seek (svn_stream_t *stream, svn_stream_seek_fn_t seek_fn)
	Set stream's seek function to seek_fn.
svn_stream_t *	svn_stream_empty (apr_pool_t *pool)
	Create a stream that is empty for reading and infinite for writing.
svn_stream_t *	svn_stream_disown (svn_stream_t stream, apr_pool_t pool)
	Return a stream allocated in pool which forwards all requests to stream.
svn_error_t *	svn_stream_open_readonly (svn_stream_t *stream, const char path, apr_pool_t result_pool, apr_pool_t scratch_pool)
	Create a stream to read the file at path.
svn_error_t *	svn_stream_open_writable (svn_stream_t *stream, const char path, apr_pool_t result_pool, apr_pool_t scratch_pool)
	Create a stream to write a file at path.
svn_error_t *	svn_stream_open_unique (svn_stream_t stream, const char temp_path, const char dirpath, svn_io_file_del_t delete_when, apr_pool_t result_pool, apr_pool_t *scratch_pool)
	Create a writable stream to a file in the directory dirpath.
svn_stream_t *	svn_stream_from_aprfile2 (apr_file_t file, svn_boolean_t disown, apr_pool_t pool)
	Create a stream from an APR file.
SVN_DEPRECATED svn_stream_t *	svn_stream_from_aprfile (apr_file_t file, apr_pool_t pool)
	Similar to svn_stream_from_aprfile2(), except that the file will always be disowned.
svn_error_t *	svn_stream_for_stdin (svn_stream_t *in, apr_pool_t pool)
	Set in to a generic stream connected to stdin, allocated in pool*.
svn_error_t *	svn_stream_for_stderr (svn_stream_t *err, apr_pool_t pool)
	Set err to a generic stream connected to stderr, allocated in pool*.
svn_error_t *	svn_stream_for_stdout (svn_stream_t *out, apr_pool_t pool)
	Set out to a generic stream connected to stdout, allocated in pool*.
svn_stream_t *	svn_stream_from_stringbuf (svn_stringbuf_t str, apr_pool_t pool)
	Return a generic stream connected to stringbuf str.
svn_stream_t *	svn_stream_from_string (const svn_string_t str, apr_pool_t pool)
	Return a generic read-only stream connected to string str.
svn_stream_t *	svn_stream_compressed (svn_stream_t stream, apr_pool_t pool)
	Return a stream that decompresses all data read and compresses all data written.
svn_stream_t *	svn_stream_checksummed2 (svn_stream_t stream, svn_checksum_t read_checksum, svn_checksum_t write_checksum, svn_checksum_kind_t checksum_kind, svn_boolean_t read_all, apr_pool_t pool)
	Return a stream that calculates checksums for all data read and written.
SVN_DEPRECATED svn_stream_t *	svn_stream_checksummed (svn_stream_t stream, const unsigned char read_digest, const unsigned char write_digest, svn_boolean_t read_all, apr_pool_t pool)
	Similar to svn_stream_checksummed2(), but always returning the MD5 checksum in read_digest and write_digest.
svn_error_t *	svn_stream_read (svn_stream_t stream, char buffer, apr_size_t *len)
	Read from a generic stream.
svn_error_t *	svn_stream_skip (svn_stream_t *stream, apr_size_t len)
	Skip len bytes from a generic stream.
svn_error_t *	svn_stream_write (svn_stream_t stream, const char data, apr_size_t *len)
	Write to a generic stream.
svn_error_t *	svn_stream_close (svn_stream_t *stream)
	Close a generic stream.
svn_error_t *	svn_stream_reset (svn_stream_t *stream)
	Reset a generic stream back to its origin.
svn_boolean_t	svn_stream_supports_mark (svn_stream_t *stream)
	Returns `TRUE` if the generic stream supports svn_stream_mark().
svn_error_t *	svn_stream_mark (svn_stream_t stream, svn_stream_mark_t mark, apr_pool_t pool)
	Set a mark at the current position of a generic stream, which can later be sought back to using svn_stream_seek().
svn_error_t *	svn_stream_seek (svn_stream_t stream, const svn_stream_mark_t mark)
	Seek to a mark in a generic stream.
svn_stream_t *	svn_stream_tee (svn_stream_t out1, svn_stream_t out2, apr_pool_t *pool)
	Return a writable stream which, when written to, writes to both of the underlying streams.
svn_error_t *	svn_stream_printf (svn_stream_t stream, apr_pool_t pool, const char *fmt,...)
	Write to stream using a printf-style fmt specifier, passed through apr_psprintf() using memory from pool.
svn_error_t *	svn_stream_printf_from_utf8 (svn_stream_t stream, const char encoding, apr_pool_t pool, const char fmt,...)
	Write to stream using a printf-style fmt specifier, passed through apr_psprintf() using memory from pool.
svn_error_t *	svn_stream_readline (svn_stream_t stream, svn_stringbuf_t stringbuf, const char eol, svn_boolean_t eof, apr_pool_t pool)
	Allocate stringbuf in pool, and read into it one line (terminated by eol) from stream*.
svn_error_t *	svn_stream_copy3 (svn_stream_t from, svn_stream_t to, svn_cancel_func_t cancel_func, void cancel_baton, apr_pool_t pool)
	Read the contents of the readable stream from and write them to the writable stream to calling cancel_func before copying each chunk.
SVN_DEPRECATED svn_error_t *	svn_stream_copy2 (svn_stream_t from, svn_stream_t to, svn_cancel_func_t cancel_func, void cancel_baton, apr_pool_t pool)
	Same as svn_stream_copy3() but the streams are not closed.
SVN_DEPRECATED svn_error_t *	svn_stream_copy (svn_stream_t from, svn_stream_t to, apr_pool_t *pool)
	Same as svn_stream_copy3(), but without the cancellation function or stream closing.
svn_error_t *	svn_stream_contents_same2 (svn_boolean_t same, svn_stream_t stream1, svn_stream_t stream2, apr_pool_t pool)
	Set same to TRUE if stream1* and stream2 have the same contents, else set it to FALSE.
SVN_DEPRECATED svn_error_t *	svn_stream_contents_same (svn_boolean_t same, svn_stream_t stream1, svn_stream_t stream2, apr_pool_t pool)
	Same as svn_stream_contents_same2(), but the streams will not be closed.
svn_error_t *	svn_string_from_stream (svn_string_t *result, svn_stream_t stream, apr_pool_t result_pool, apr_pool_t scratch_pool)
	Read the contents of stream into memory, returning the data in result.
svn_error_t *	svn_stringbuf_from_file2 (svn_stringbuf_t *result, const char filename, apr_pool_t *pool)
	Set result to a string containing the contents of filename*, which is either "-" (indicating that stdin should be read) or the utf8-encoded path of a real file.
SVN_DEPRECATED svn_error_t *	svn_stringbuf_from_file (svn_stringbuf_t *result, const char filename, apr_pool_t *pool)
	Similar to svn_stringbuf_from_file2(), except that if filename is "-", return the error SVN_ERR_UNSUPPORTED_FEATURE and don't touch *result.
svn_error_t *	svn_stringbuf_from_aprfile (svn_stringbuf_t *result, apr_file_t file, apr_pool_t *pool)
	Sets result to a string containing the contents of the already opened file*.
svn_error_t *	svn_io_remove_file2 (const char path, svn_boolean_t ignore_enoent, apr_pool_t scratch_pool)
	Remove file path, a utf8-encoded path.
SVN_DEPRECATED svn_error_t *	svn_io_remove_file (const char path, apr_pool_t pool)
	Similar to svn_io_remove_file2(), except with ignore_enoent set to FALSE.
svn_error_t *	svn_io_remove_dir2 (const char path, svn_boolean_t ignore_enoent, svn_cancel_func_t cancel_func, void cancel_baton, apr_pool_t *pool)
	Recursively remove directory path.
SVN_DEPRECATED svn_error_t *	svn_io_remove_dir (const char path, apr_pool_t pool)
	Similar to svn_io_remove_dir2(), but with ignore_enoent set to `FALSE` and cancel_func and cancel_baton set to `NULL`.
SVN_DEPRECATED svn_error_t *	svn_io_get_dir_filenames (apr_hash_t *dirents, const char path, apr_pool_t *pool)
	Read all of the disk entries in directory path, a utf8-encoded path.
svn_error_t *	svn_io_get_dirents3 (apr_hash_t *dirents, const char path, svn_boolean_t only_check_type, apr_pool_t result_pool, apr_pool_t scratch_pool)
	Read all of the disk entries in directory path, a utf8-encoded path.
SVN_DEPRECATED svn_error_t *	svn_io_get_dirents2 (apr_hash_t *dirents, const char path, apr_pool_t *pool)
	Similar to svn_io_get_dirents3, but returns a mapping to svn_io_dirent_t structures instead of svn_io_dirent2_t and with only a single pool.
SVN_DEPRECATED svn_error_t *	svn_io_get_dirents (apr_hash_t *dirents, const char path, apr_pool_t *pool)
	Similar to svn_io_get_dirents2(), but *dirents is a hash table with svn_node_kind_t values.
svn_error_t *	svn_io_stat_dirent (const svn_io_dirent2_t *dirent_p, const char path, svn_boolean_t ignore_enoent, apr_pool_t result_pool, apr_pool_t scratch_pool)
	Create a svn_io_dirent2_t instance for path.
svn_error_t *	svn_io_dir_walk2 (const char dirname, apr_int32_t wanted, svn_io_walk_func_t walk_func, void walk_baton, apr_pool_t *pool)
	Recursively walk the directory rooted at dirname, a utf8-encoded path, invoking walk_func (with walk_baton) for each item in the tree.
SVN_DEPRECATED svn_error_t *	svn_io_dir_walk (const char dirname, apr_int32_t wanted, svn_io_walk_func_t walk_func, void walk_baton, apr_pool_t *pool)
	Similar to svn_io_dir_walk(), but only calls walk_func for files of type APR_DIR (directory) and APR_REG (regular file).
svn_error_t *	svn_io_start_cmd2 (apr_proc_t cmd_proc, const char path, const char cmd, const char const args, svn_boolean_t inherit, svn_boolean_t infile_pipe, apr_file_t infile, svn_boolean_t outfile_pipe, apr_file_t outfile, svn_boolean_t errfile_pipe, apr_file_t errfile, apr_pool_t *pool)
	Start cmd with args, using utf8-encoded path as working directory.
SVN_DEPRECATED svn_error_t *	svn_io_start_cmd (apr_proc_t cmd_proc, const char path, const char cmd, const char const args, svn_boolean_t inherit, apr_file_t infile, apr_file_t outfile, apr_file_t errfile, apr_pool_t *pool)
	Similar to svn_io_start_cmd2() but with infile_pipe, outfile_pipe, and errfile_pipe always FALSE.
svn_error_t *	svn_io_wait_for_cmd (apr_proc_t cmd_proc, const char cmd, int exitcode, apr_exit_why_e exitwhy, apr_pool_t *pool)
	Wait for the process *cmd_proc to complete and optionally retrieve its exit code.
svn_error_t *	svn_io_run_cmd (const char path, const char cmd, const char const args, int exitcode, apr_exit_why_e exitwhy, svn_boolean_t inherit, apr_file_t infile, apr_file_t outfile, apr_file_t errfile, apr_pool_t pool)
	Run a command to completion, by first calling svn_io_start_cmd() and then calling svn_io_wait_for_cmd().
svn_error_t *	svn_io_run_diff2 (const char dir, const char const user_args, int num_user_args, const char label1, const char label2, const char from, const char to, int exitcode, apr_file_t outfile, apr_file_t errfile, const char diff_cmd, apr_pool_t pool)
	Invoke the configured `diff` program, with user_args (an array of utf8-encoded num_user_args arguments) if they are specified (that is, if user_args is non-NULL), or "-u" if they are not.
SVN_DEPRECATED svn_error_t *	svn_io_run_diff (const char dir, const char const user_args, int num_user_args, const char label1, const char label2, const char from, const char to, int exitcode, apr_file_t outfile, apr_file_t errfile, const char diff_cmd, apr_pool_t pool)
	Similar to svn_io_run_diff2() but with diff_cmd encoded in internal encoding used by APR.
svn_error_t *	svn_io_run_diff3_3 (int exitcode, const char dir, const char mine, const char older, const char yours, const char mine_label, const char older_label, const char yours_label, apr_file_t merged, const char diff3_cmd, const apr_array_header_t user_args, apr_pool_t pool)
	Invoke the configured `diff3` program, in utf8-encoded dir like this:
SVN_DEPRECATED svn_error_t *	svn_io_run_diff3_2 (int exitcode, const char dir, const char mine, const char older, const char yours, const char mine_label, const char older_label, const char yours_label, apr_file_t merged, const char diff3_cmd, const apr_array_header_t user_args, apr_pool_t pool)
	Similar to svn_io_run_diff3_3(), but with diff3_cmd encoded in internal encoding used by APR.
SVN_DEPRECATED svn_error_t *	svn_io_run_diff3 (const char dir, const char mine, const char older, const char yours, const char mine_label, const char older_label, const char yours_label, apr_file_t merged, int exitcode, const char diff3_cmd, apr_pool_t *pool)
	Similar to svn_io_run_diff3_2(), but with user_args set to `NULL`.
svn_error_t *	svn_io_parse_mimetypes_file (apr_hash_t *type_map, const char mimetypes_file, apr_pool_t *pool)
	Parse utf8-encoded mimetypes_file as a MIME types file (such as is provided with Apache HTTP Server), and set type_map to a hash mapping `const char ` filename extensions to `const char *` MIME types.
svn_error_t *	svn_io_detect_mimetype2 (const char *mimetype, const char file, apr_hash_t mimetype_map, apr_pool_t pool)
	Examine utf8-encoded file to determine if it can be described by a known (as in, known by this function) Multipurpose Internet Mail Extension (MIME) type.
SVN_DEPRECATED svn_error_t *	svn_io_detect_mimetype (const char *mimetype, const char file, apr_pool_t *pool)
	Like svn_io_detect_mimetype2, but with mimetypes_map set to `NULL`.
svn_boolean_t	svn_io_is_binary_data (const void *buf, apr_size_t len)
	Examine up to len bytes of data in buf to determine if the can be considered binary data, in which case return TRUE.
svn_error_t *	svn_io_file_open (apr_file_t *new_file, const char fname, apr_int32_t flag, apr_fileperms_t perm, apr_pool_t *pool)
	Wrapper for apr_file_open().
svn_error_t *	svn_io_file_close (apr_file_t file, apr_pool_t pool)
	Wrapper for apr_file_close().
svn_error_t *	svn_io_file_getc (char ch, apr_file_t file, apr_pool_t *pool)
	Wrapper for apr_file_getc().
svn_error_t *	svn_io_file_putc (char ch, apr_file_t file, apr_pool_t pool)
	Wrapper for apr_file_putc().
svn_error_t *	svn_io_file_info_get (apr_finfo_t finfo, apr_int32_t wanted, apr_file_t file, apr_pool_t *pool)
	Wrapper for apr_file_info_get().
svn_error_t *	svn_io_file_read (apr_file_t file, void buf, apr_size_t nbytes, apr_pool_t pool)
	Wrapper for apr_file_read().
svn_error_t *	svn_io_file_read_full2 (apr_file_t file, void buf, apr_size_t nbytes, apr_size_t bytes_read, svn_boolean_t hit_eof, apr_pool_t *pool)
	Wrapper for apr_file_read_full().
SVN_DEPRECATED svn_error_t *	svn_io_file_read_full (apr_file_t file, void buf, apr_size_t nbytes, apr_size_t bytes_read, apr_pool_t pool)
	Similar to svn_io_file_read_full2 with hit_eof being set to `NULL`.
svn_error_t *	svn_io_file_seek (apr_file_t file, apr_seek_where_t where, apr_off_t offset, apr_pool_t *pool)
	Wrapper for apr_file_seek().
svn_error_t *	svn_io_file_write (apr_file_t file, const void buf, apr_size_t nbytes, apr_pool_t pool)
	Wrapper for apr_file_write().
svn_error_t *	svn_io_file_write_full (apr_file_t file, const void buf, apr_size_t nbytes, apr_size_t bytes_written, apr_pool_t pool)
	Wrapper for apr_file_write_full().
svn_error_t *	svn_io_write_unique (const char *tmp_path, const char dirpath, const void buf, apr_size_t nbytes, svn_io_file_del_t delete_when, apr_pool_t pool)
	Open a unique file in dirpath, and write nbytes from buf to the file before flushing it to disk and closing it.
svn_error_t *	svn_io_file_trunc (apr_file_t file, apr_off_t offset, apr_pool_t pool)
	Wrapper for apr_file_trunc().
svn_error_t *	svn_io_stat (apr_finfo_t finfo, const char fname, apr_int32_t wanted, apr_pool_t *pool)
	Wrapper for apr_stat().
svn_error_t *	svn_io_file_rename (const char from_path, const char to_path, apr_pool_t *pool)
	Rename and/or move the node (not necessarily a regular file) at from_path to a new path to_path within the same filesystem.
svn_error_t *	svn_io_file_move (const char from_path, const char to_path, apr_pool_t *pool)
	Move the file from from_path to to_path, even across device boundaries.
svn_error_t *	svn_io_dir_make (const char path, apr_fileperms_t perm, apr_pool_t pool)
	Wrapper for apr_dir_make().
svn_error_t *	svn_io_dir_make_hidden (const char path, apr_fileperms_t perm, apr_pool_t pool)
	Same as svn_io_dir_make(), but sets the hidden attribute on the directory on systems that support it.
svn_error_t *	svn_io_dir_make_sgid (const char path, apr_fileperms_t perm, apr_pool_t pool)
	Same as svn_io_dir_make(), but attempts to set the sgid on the directory on systems that support it.
svn_error_t *	svn_io_dir_open (apr_dir_t *new_dir, const char dirname, apr_pool_t *pool)
	Wrapper for apr_dir_open().
svn_error_t *	svn_io_dir_close (apr_dir_t *thedir)
	Wrapper for apr_dir_close().
svn_error_t *	svn_io_dir_remove_nonrecursive (const char dirname, apr_pool_t pool)
	Wrapper for apr_dir_remove().
svn_error_t *	svn_io_dir_read (apr_finfo_t finfo, apr_int32_t wanted, apr_dir_t thedir, apr_pool_t *pool)
	Wrapper for apr_dir_read().
svn_error_t *	svn_io_file_name_get (const char *filename, apr_file_t file, apr_pool_t *pool)
	Wrapper for apr_file_name_get().
svn_error_t *	svn_io_read_version_file (int version, const char path, apr_pool_t *pool)
	Set version to the integer that starts the file at path*.
svn_error_t *	svn_io_write_version_file (const char path, int version, apr_pool_t pool)
	Create (or overwrite) the file at path with new contents, formatted as a non-negative integer version followed by a single newline.

Detailed Description

General file I/O for Subversion.

Definition in file svn_io.h.

Typedef Documentation

typedef struct svn_io_dirent2_t svn_io_dirent2_t

A set of directory entry data elements as returned by svn_io_get_dirents.

Note that the first two fields are exactly identical to svn_io_dirent_t to allow returning a svn_io_dirent2_t as a svn_io_dirent_t.

Use svn_io_dirent2_create() to create new svn_dirent2_t instances or svn_io_dirent2_dup() to duplicate an existing instance.

Since:: New in 1.7.

typedef struct svn_io_dirent_t svn_io_dirent_t

Represents the kind and special status of a directory entry.

Note that the first two fields are exactly identical to svn_io_dirent2_t to allow returning a svn_io_dirent2_t as a svn_io_dirent_t.

Since:: New in 1.3.

typedef enum svn_io_file_del_t svn_io_file_del_t

Used as an argument when creating temporary files to indicate when a file should be removed.

Since:: New in 1.4.

Not specifying any of these means no removal at all.

Enumeration Type Documentation

enum svn_io_file_del_t

Used as an argument when creating temporary files to indicate when a file should be removed.

Since:: New in 1.4.

Not specifying any of these means no removal at all.

Enumerator:

svn_io_file_del_none	No deletion ever.
svn_io_file_del_on_close	Remove when the file is closed.
svn_io_file_del_on_pool_cleanup	Remove when the associated pool is cleared.

Definition at line 58 of file svn_io.h.

Function Documentation

svn_error_t* svn_io_append_file	(	const char *	src,
		const char *	dst,
		apr_pool_t *	pool
	)

Append src to dst.

dst will be appended to if it exists, else it will be created. Both src and dst are utf8-encoded.

svn_error_t* svn_io_check_path	(	const char *	path,
		svn_node_kind_t *	kind,
		apr_pool_t *	pool
	)

Determine the kind of path.

path should be UTF-8 encoded.

If path is a file, set *kind to svn_node_file.

If path is a directory, set *kind to svn_node_dir.

If path does not exist, set *kind to svn_node_none.

If path exists but is none of the above, set *kind to svn_node_unknown.

If path is not a valid pathname, set *kind to svn_node_none. If unable to determine path's kind for any other reason, return an error, with *kind's value undefined.

Use pool for temporary allocations.

See also:: svn_node_kind_t

svn_error_t* svn_io_check_resolved_path	(	const char *	path,
		svn_node_kind_t *	kind,
		apr_pool_t *	pool
	)

Like svn_io_check_path(), but resolve symlinks.

This returns the same varieties of kind as svn_io_check_path().

svn_error_t* svn_io_check_special_path	(	const char *	path,
		svn_node_kind_t *	kind,
		svn_boolean_t *	is_special,
		apr_pool_t *	pool
	)

Like svn_io_check_path(), but also set *is_special to TRUE if the path is not a normal file.

Since:: New in 1.1.

svn_error_t* svn_io_copy_dir_recursively	(	const char *	src,
		const char *	dst_parent,
		const char *	dst_basename,
		svn_boolean_t	copy_perms,
		svn_cancel_func_t	cancel_func,
		void *	cancel_baton,
		apr_pool_t *	pool
	)

Recursively copy directory src into dst_parent, as a new entry named dst_basename.

If dst_basename already exists in dst_parent, return error. copy_perms will be passed through to svn_io_copy_file() when any files are copied. src, dst_parent, and dst_basename are all utf8-encoded.

If cancel_func is non-NULL, invoke it with cancel_baton at various points during the operation. If it returns any error (typically SVN_ERR_CANCELLED), return that error immediately.

svn_error_t* svn_io_copy_file	(	const char *	src,
		const char *	dst,
		svn_boolean_t	copy_perms,
		apr_pool_t *	pool
	)

Copy src to dst atomically, in a "byte-for-byte" manner.

Overwrite dst if it exists, else create it. Both src and dst are utf8-encoded filenames. If copy_perms is TRUE, set dst's permissions to match those of src.

svn_error_t* svn_io_copy_link	(	const char *	src,
		const char *	dst,
		apr_pool_t *	pool
	)

Copy symbolic link src to dst atomically.

Overwrite dst if it exists, else create it. Both src and dst are utf8-encoded filenames. After copying, the dst link will point to the same thing src does.

Since:: New in 1.1.

svn_error_t* svn_io_copy_perms	(	const char *	src,
		const char *	dst,
		apr_pool_t *	pool
	)

Copy permission flags from src onto the file at dst.

Both filenames are utf8-encoded filenames.

Since:: New in 1.6.

svn_error_t* svn_io_create_unique_link	(	const char **	unique_name_p,
		const char *	path,
		const char *	dest,
		const char *	suffix,
		apr_pool_t *	pool
	)

Like svn_io_open_unique_file(), except that instead of creating a file, a symlink is generated that references the path dest.

Since:: New in 1.1.

SVN_DEPRECATED svn_error_t* svn_io_detect_mimetype	(	const char **	mimetype,
		const char *	file,
		apr_pool_t *	pool
	)

Like svn_io_detect_mimetype2, but with mimetypes_map set to NULL.

Deprecated:: Provided for backward compatibility with the 1.4 API

svn_error_t* svn_io_detect_mimetype2	(	const char **	mimetype,
		const char *	file,
		apr_hash_t *	mimetype_map,
		apr_pool_t *	pool
	)

Examine utf8-encoded file to determine if it can be described by a known (as in, known by this function) Multipurpose Internet Mail Extension (MIME) type.

If so, set *mimetype to a character string describing the MIME type, else set it to NULL.

If not NULL, mimetype_map is a hash mapping const char * filename extensions to const char * MIME types, and is the first source consulted regarding file's MIME type.

Use pool for any necessary allocations.

Since:: New in 1.5.

svn_error_t* svn_io_dir_close ( apr_dir_t * thedir )

Wrapper for apr_dir_close().

Since:: New in 1.7.

svn_error_t* svn_io_dir_empty	(	svn_boolean_t *	is_empty_p,
		const char *	path,
		apr_pool_t *	pool
	)

Set *is_empty_p to TRUE if directory path is empty, else to FALSE if it is not empty.

path must be a directory, and is utf8-encoded. Use pool for temporary allocation.

svn_error_t* svn_io_dir_file_copy	(	const char *	src_path,
		const char *	dest_path,
		const char *	file,
		apr_pool_t *	pool
	)

Copy the file whose basename (or relative path) is file within directory src_path to the same basename (or relative path) within directory dest_path.

Overwrite the destination file if it already exists. The destination directory (including any directory components in name) must already exist. Set the destination file's permissions to match those of the source. Use pool for memory allocations.

svn_error_t* svn_io_dir_make	(	const char *	path,
		apr_fileperms_t	perm,
		apr_pool_t *	pool
	)

Wrapper for apr_dir_make().

path is utf8-encoded.

svn_error_t* svn_io_dir_make_hidden	(	const char *	path,
		apr_fileperms_t	perm,
		apr_pool_t *	pool
	)

Same as svn_io_dir_make(), but sets the hidden attribute on the directory on systems that support it.

svn_error_t* svn_io_dir_make_sgid	(	const char *	path,
		apr_fileperms_t	perm,
		apr_pool_t *	pool
	)

Same as svn_io_dir_make(), but attempts to set the sgid on the directory on systems that support it.

Does not return an error if the attempt to set the sgid bit fails. On Unix filesystems, setting the sgid bit on a directory ensures that files and subdirectories created within inherit group ownership from the parent instead of from the primary gid.

Since:: New in 1.1.

svn_error_t* svn_io_dir_open	(	apr_dir_t **	new_dir,
		const char *	dirname,
		apr_pool_t *	pool
	)

Wrapper for apr_dir_open().

dirname is utf8-encoded.

svn_error_t* svn_io_dir_read	(	apr_finfo_t *	finfo,
		apr_int32_t	wanted,
		apr_dir_t *	thedir,
		apr_pool_t *	pool
	)

Wrapper for apr_dir_read().

Ensures that finfo->name is utf8-encoded, which means allocating finfo->name in pool, which may or may not be the same as finfo's pool. Use pool for error allocation as well.

svn_error_t* svn_io_dir_remove_nonrecursive	(	const char *	dirname,
		apr_pool_t *	pool
	)

Wrapper for apr_dir_remove().

dirname is utf8-encoded.

Note:: This function has this name to avoid confusion with svn_io_remove_dir2(), which is recursive.

SVN_DEPRECATED svn_error_t* svn_io_dir_walk	(	const char *	dirname,
		apr_int32_t	wanted,
		svn_io_walk_func_t	walk_func,
		void *	walk_baton,
		apr_pool_t *	pool
	)

Similar to svn_io_dir_walk(), but only calls walk_func for files of type APR_DIR (directory) and APR_REG (regular file).

Deprecated:: Provided for backwards compatibility with the 1.6 API.

svn_error_t* svn_io_dir_walk2	(	const char *	dirname,
		apr_int32_t	wanted,
		svn_io_walk_func_t	walk_func,
		void *	walk_baton,
		apr_pool_t *	pool
	)

Recursively walk the directory rooted at dirname, a utf8-encoded path, invoking walk_func (with walk_baton) for each item in the tree.

For a given directory, invoke walk_func on the directory itself before invoking it on any children thereof.

Deliver to walk_func the information specified by wanted, which is a combination of APR_FINFO_* flags, plus the information specified by APR_FINFO_TYPE and APR_FINFO_NAME.

Use pool for all allocations.

Note:: This function does not currently pass all file types to walk_func -- only APR_DIR, APR_REG, and APR_LNK. We reserve the right to pass additional file types through this interface in the future, though, so implementations of this callback should explicitly test FINFO->filetype. See the APR library's apr_filetype_e enum for the various filetypes and their meanings.

Since:: New in 1.7.

svn_io_dirent2_t* svn_io_dirent2_create ( apr_pool_t * result_pool )

Creates a new svn_io_dirent2_t structure.

Since:: New in 1.7.

svn_io_dirent2_t* svn_io_dirent2_dup	(	const svn_io_dirent2_t *	item,
		apr_pool_t *	result_pool
	)

Duplicates a svn_io_dirent2_t structure into result_pool.

Since:: New in 1.7.

svn_error_t* svn_io_file_affected_time	(	apr_time_t *	apr_time,
		const char *	path,
		apr_pool_t *	pool
	)

Set *apr_time to the time of last modification of the contents of the file path.

path is utf8-encoded.

Note:: This is the APR mtime which corresponds to the traditional mtime on Unix, and the last write time on Windows.

SVN_DEPRECATED svn_error_t* svn_io_file_checksum	(	unsigned char	digest[],
		const char *	file,
		apr_pool_t *	pool
	)

Put the md5 checksum of file into digest.

digest points to APR_MD5_DIGESTSIZE bytes of storage. Use pool only for temporary allocations.

Deprecated:: Provided for backward compatibility with the 1.5 API.

svn_error_t* svn_io_file_checksum2	(	svn_checksum_t **	checksum,
		const char *	file,
		svn_checksum_kind_t	kind,
		apr_pool_t *	pool
	)

Return in *checksum the checksum of type kind of file Use pool for temporary allocations and to allocate *checksum.

Since:: New in 1.6.

svn_error_t* svn_io_file_close	(	apr_file_t *	file,
		apr_pool_t *	pool
	)

Wrapper for apr_file_close().

svn_error_t* svn_io_file_create	(	const char *	file,
		const char *	contents,
		apr_pool_t *	pool
	)

Create file at utf8-encoded file with contents contents.

file must not already exist. Use pool for memory allocations.

svn_error_t* svn_io_file_flush_to_disk	(	apr_file_t *	file,
		apr_pool_t *	pool
	)

Flush any unwritten data from file to disk.

Use pool for memory allocations.

Since:: New in 1.1.

svn_error_t* svn_io_file_getc	(	char *	ch,
		apr_file_t *	file,
		apr_pool_t *	pool
	)

Wrapper for apr_file_getc().

svn_error_t* svn_io_file_info_get	(	apr_finfo_t *	finfo,
		apr_int32_t	wanted,
		apr_file_t *	file,
		apr_pool_t *	pool
	)

Wrapper for apr_file_info_get().

SVN_DEPRECATED svn_error_t* svn_io_file_lock	(	const char *	lock_file,
		svn_boolean_t	exclusive,
		apr_pool_t *	pool
	)

Lock file at lock_file.

If exclusive is TRUE, obtain exclusive lock, otherwise obtain shared lock. Lock will be automatically released when pool is cleared or destroyed. Use pool for memory allocations.

Deprecated:: Provided for backward compatibility with the 1.0 API.

svn_error_t* svn_io_file_lock2	(	const char *	lock_file,
		svn_boolean_t	exclusive,
		svn_boolean_t	nonblocking,
		apr_pool_t *	pool
	)

Lock file at lock_file.

If exclusive is TRUE, obtain exclusive lock, otherwise obtain shared lock.

If nonblocking is TRUE, do not wait for the lock if it is not available: throw an error instead.

Lock will be automatically released when pool is cleared or destroyed. Use pool for memory allocations.

Since:: New in 1.1.

svn_error_t* svn_io_file_move	(	const char *	from_path,
		const char *	to_path,
		apr_pool_t *	pool
	)

Move the file from from_path to to_path, even across device boundaries.

Overwrite to_path if it exists.

Note:: This function is different from svn_io_file_rename in that the latter fails in the 'across device boundaries' case.

Since:: New in 1.3.

svn_error_t* svn_io_file_name_get	(	const char **	filename,
		apr_file_t *	file,
		apr_pool_t *	pool
	)

Wrapper for apr_file_name_get().

*filename is utf8-encoded.

Note:: The file name may be NULL.

Since:: New in 1.7.

svn_error_t* svn_io_file_open	(	apr_file_t **	new_file,
		const char *	fname,
		apr_int32_t	flag,
		apr_fileperms_t	perm,
		apr_pool_t *	pool
	)

Wrapper for apr_file_open().

fname is utf8-encoded.

svn_error_t* svn_io_file_putc	(	char	ch,
		apr_file_t *	file,
		apr_pool_t *	pool
	)

Wrapper for apr_file_putc().

Since:: New in 1.7

svn_error_t* svn_io_file_read	(	apr_file_t *	file,
		void *	buf,
		apr_size_t *	nbytes,
		apr_pool_t *	pool
	)

Wrapper for apr_file_read().

SVN_DEPRECATED svn_error_t* svn_io_file_read_full	(	apr_file_t *	file,
		void *	buf,
		apr_size_t	nbytes,
		apr_size_t *	bytes_read,
		apr_pool_t *	pool
	)

Similar to svn_io_file_read_full2 with hit_eof being set to NULL.

Deprecated:: Provided for backward compatibility with the 1.6 API

svn_error_t* svn_io_file_read_full2	(	apr_file_t *	file,
		void *	buf,
		apr_size_t	nbytes,
		apr_size_t *	bytes_read,
		svn_boolean_t *	hit_eof,
		apr_pool_t *	pool
	)

Wrapper for apr_file_read_full().

If hit_eof is not NULL, EOF will be indicated there and no svn_error_t error object will be created upon EOF.

Since:: New in 1.7

svn_error_t* svn_io_file_rename	(	const char *	from_path,
		const char *	to_path,
		apr_pool_t *	pool
	)

Rename and/or move the node (not necessarily a regular file) at from_path to a new path to_path within the same filesystem.

In some cases, an existing node at to_path will be overwritten.

A wrapper for apr_file_rename(). from_path and to_path are utf8-encoded.

svn_error_t* svn_io_file_seek	(	apr_file_t *	file,
		apr_seek_where_t	where,
		apr_off_t *	offset,
		apr_pool_t *	pool
	)

Wrapper for apr_file_seek().

svn_error_t* svn_io_file_trunc	(	apr_file_t *	file,
		apr_off_t	offset,
		apr_pool_t *	pool
	)

Wrapper for apr_file_trunc().

Since:: New in 1.6.

svn_error_t* svn_io_file_write	(	apr_file_t *	file,
		const void *	buf,
		apr_size_t *	nbytes,
		apr_pool_t *	pool
	)

Wrapper for apr_file_write().

svn_error_t* svn_io_file_write_full	(	apr_file_t *	file,
		const void *	buf,
		apr_size_t	nbytes,
		apr_size_t *	bytes_written,
		apr_pool_t *	pool
	)

Wrapper for apr_file_write_full().

svn_error_t* svn_io_files_contents_same_p	(	svn_boolean_t *	same,
		const char *	file1,
		const char *	file2,
		apr_pool_t *	pool
	)

Set *same to TRUE if file1 and file2 have the same contents, else set it to FALSE.

Use pool for temporary allocations.

svn_error_t* svn_io_filesizes_different_p	(	svn_boolean_t *	different_p,
		const char *	file1,
		const char *	file2,
		apr_pool_t *	pool
	)

Set *different_p to non-zero if file1 and file2 have different sizes, else set to zero.

Both file1 and file2 are utf8-encoded.

Setting *different_p to zero does not mean the files definitely have the same size, it merely means that the sizes are not definitely different. That is, if the size of one or both files cannot be determined, then the sizes are not known to be different, so *different_p is set to 0.

SVN_DEPRECATED svn_error_t* svn_io_get_dir_filenames	(	apr_hash_t **	dirents,
		const char *	path,
		apr_pool_t *	pool
	)

Read all of the disk entries in directory path, a utf8-encoded path.

Set *dirents to a hash mapping dirent names (char *) to undefined non-NULL values, allocated in pool.

Note:: The `.' and `..' directories normally returned by apr_dir_read() are NOT returned in the hash.

Since:: New in 1.4.

Deprecated:: Provided for backward compatibility with the 1.6 API.

SVN_DEPRECATED svn_error_t* svn_io_get_dirents	(	apr_hash_t **	dirents,
		const char *	path,
		apr_pool_t *	pool
	)

Similar to svn_io_get_dirents2(), but *dirents is a hash table with svn_node_kind_t values.

Deprecated:: Provided for backwards compatibility with the 1.2 API.

SVN_DEPRECATED svn_error_t* svn_io_get_dirents2	(	apr_hash_t **	dirents,
		const char *	path,
		apr_pool_t *	pool
	)

Similar to svn_io_get_dirents3, but returns a mapping to svn_io_dirent_t structures instead of svn_io_dirent2_t and with only a single pool.

Since:: New in 1.3.

Deprecated:: Provided for backward compatibility with the 1.6 API.

svn_error_t* svn_io_get_dirents3	(	apr_hash_t **	dirents,
		const char *	path,
		svn_boolean_t	only_check_type,
		apr_pool_t *	result_pool,
		apr_pool_t *	scratch_pool
	)

Read all of the disk entries in directory path, a utf8-encoded path.

Set *dirents to a hash mapping dirent names (char *) to svn_io_dirent2_t structures, allocated in pool.

If only_check_type is set to TRUE, only the kind and special fields of the svn_io_dirent2_t are filled.

Note:: The `.' and `..' directories normally returned by apr_dir_read() are NOT returned in the hash.; The kind field in the dirents is set according to the mapping as documented for svn_io_check_path().

Since:: New in 1.7.

svn_boolean_t svn_io_is_binary_data	(	const void *	buf,
		apr_size_t	len
	)

Examine up to len bytes of data in buf to determine if the can be considered binary data, in which case return TRUE.

If the data can be considered plain-text data, return FALSE.

Since:: New in 1.7.

svn_error_t* svn_io_is_file_executable	(	svn_boolean_t *	executable,
		const char *	path,
		apr_pool_t *	pool
	)

Determine whether a file is executable by the current user.

Set *executable to TRUE if the file path is executable by the current user, otherwise set it to FALSE.

On Windows and on platforms without userids, always returns FALSE.

svn_error_t* svn_io_make_dir_recursively	(	const char *	path,
		apr_pool_t *	pool
	)

Create directory path on the file system, creating intermediate directories as required, like mkdir -p.

Report no error if path already exists. path is utf8-encoded.

This is essentially a wrapper for apr_dir_make_recursive(), passing APR_OS_DEFAULT as the permissions.

SVN_DEPRECATED svn_error_t* svn_io_open_unique_file	(	apr_file_t **	f,
		const char **	unique_name_p,
		const char *	path,
		const char *	suffix,
		svn_boolean_t	delete_on_close,
		apr_pool_t *	pool
	)

Like svn_io_open_unique_file2, but can't delete on pool cleanup.

Deprecated:: Provided for backward compatibility with the 1.3 API

Note:: In 1.4 the API was extended to require either f or unique_name_p (the other can be NULL). Before that, both were required.

SVN_DEPRECATED svn_error_t* svn_io_open_unique_file2	(	apr_file_t **	f,
		const char **	unique_name_p,
		const char *	path,
		const char *	suffix,
		svn_io_file_del_t	delete_when,
		apr_pool_t *	pool
	)

Like svn_io_open_uniquely_named(), but takes a joined dirpath and filename, and a single pool.

Since:: New in 1.4

Deprecated:: Provided for backward compatibility with the 1.5 API

svn_error_t* svn_io_open_unique_file3	(	apr_file_t **	file,
		const char **	temp_path,
		const char *	dirpath,
		svn_io_file_del_t	delete_when,
		apr_pool_t *	result_pool,
		apr_pool_t *	scratch_pool
	)

Create a writable file, with an arbitrary and unique name, in the directory dirpath.

Set *temp_path to its full path, and set *file to the file handle, both allocated from result_pool. Either file or unique_name may be NULL. If file is NULL, the file will be created but not open.

If dirpath is NULL, use the path returned from svn_io_temp_dir(). (Note that when using the system-provided temp directory, it may not be possible to atomically rename the resulting file due to cross-device issues.)

The file will be deleted according to delete_when. If delete_when is svn_io_file_del_on_close and file is NULL, the file will be deleted before this function returns.

When passing svn_io_file_del_none please don't forget to eventually remove the temporary file to avoid filling up the system temp directory. It is often appropriate to bind the lifetime of the temporary file to the lifetime of a pool by using svn_io_file_del_on_pool_cleanup.

Temporary allocations will be performed in scratch_pool.

Since:: New in 1.6

See also:: svn_stream_open_unique()

svn_error_t* svn_io_open_uniquely_named	(	apr_file_t **	file,
		const char **	unique_name,
		const char *	dirpath,
		const char *	filename,
		const char *	suffix,
		svn_io_file_del_t	delete_when,
		apr_pool_t *	result_pool,
		apr_pool_t *	scratch_pool
	)

Open a new file (for reading and writing) with a unique name based on utf-8 encoded filename, in the directory dirpath.

The file handle is returned in *file, and the name, which ends with suffix, is returned in *unique_name, also utf8-encoded. Either file or unique_name may be NULL. If file is NULL, the file will be created but not open.

If delete_when is svn_io_file_del_on_close, then the APR_DELONCLOSE flag will be used when opening the file. The APR_BUFFERED flag will always be used.

The first attempt will just append suffix. If the result is not a unique name, then subsequent attempts will append a dot, followed by an iteration number ("2", then "3", and so on), followed by the suffix. For example, successive calls to

svn_io_open_uniquely_named(&f, &u, "tests/t1/A/D/G", "pi", ".tmp", ...)

will open

tests/t1/A/D/G/pi.tmp tests/t1/A/D/G/pi.2.tmp tests/t1/A/D/G/pi.3.tmp tests/t1/A/D/G/pi.4.tmp tests/t1/A/D/G/pi.5.tmp ...

Assuming suffix is non-empty, *unique_name will never be exactly the same as filename, even if filename does not exist.

If dirpath is NULL, then the directory returned by svn_io_temp_dir() will be used.

If filename is NULL, then "tempfile" will be used.

If suffix is NULL, then ".tmp" will be used.

Allocates *file and *unique_name in result_pool. All intermediate allocations will be performed in scratch_pool.

If no unique name can be found, SVN_ERR_IO_UNIQUE_NAMES_EXHAUSTED is the error returned.

Claim of Historical Inevitability: this function was written because

tmpnam() is not thread-safe.
tempname() tries standard system tmp areas first.

Since:: New in 1.6

svn_error_t* svn_io_parse_mimetypes_file	(	apr_hash_t **	type_map,
		const char *	mimetypes_file,
		apr_pool_t *	pool
	)

Parse utf8-encoded mimetypes_file as a MIME types file (such as is provided with Apache HTTP Server), and set *type_map to a hash mapping const char * filename extensions to const char * MIME types.

Since:: New in 1.5.

svn_error_t* svn_io_read_length_line	(	apr_file_t *	file,
		char *	buf,
		apr_size_t *	limit,
		apr_pool_t *	pool
	)

Read a line from file into buf, but not exceeding *limit bytes.

Does not include newline, instead '\0' is put there. Length (as in strlen) is returned in *limit. buf should be pre-allocated. file should be already opened.

When the file is out of lines, APR_EOF will be returned.

svn_error_t* svn_io_read_link	(	svn_string_t **	dest,
		const char *	path,
		apr_pool_t *	pool
	)

Set *dest to the path that the symlink at path references.

Allocate the string from pool.

Since:: New in 1.1.

SVN_DEPRECATED svn_error_t* svn_io_remove_dir	(	const char *	path,
		apr_pool_t *	pool
	)

Similar to svn_io_remove_dir2(), but with ignore_enoent set to FALSE and cancel_func and cancel_baton set to NULL.

Deprecated:: Provided for backward compatibility with the 1.4 API

svn_error_t* svn_io_remove_dir2	(	const char *	path,
		svn_boolean_t	ignore_enoent,
		svn_cancel_func_t	cancel_func,
		void *	cancel_baton,
		apr_pool_t *	pool
	)

Recursively remove directory path.

path is utf8-encoded. If ignore_enoent is TRUE, don't fail if the target directory doesn't exist. Use pool for temporary allocations.

Because recursive delete of a directory tree can be a lengthy operation, provide cancel_func and cancel_baton for interruptibility.

Since:: New in 1.5.

SVN_DEPRECATED svn_error_t* svn_io_remove_file	(	const char *	path,
		apr_pool_t *	pool
	)

Similar to svn_io_remove_file2(), except with ignore_enoent set to FALSE.

Deprecated:: Provided for backwards compatibility with the 1.6 API.

svn_error_t* svn_io_remove_file2	(	const char *	path,
		svn_boolean_t	ignore_enoent,
		apr_pool_t *	scratch_pool
	)

Remove file path, a utf8-encoded path.

This wraps apr_file_remove(), converting any error to a Subversion error. If ignore_enoent is TRUE, and the file is not present (APR_STATUS_IS_ENOENT returns TRUE), then no error will be returned.

The file will be removed even if it is not writable. (On Windows and OS/2, this function first clears the file's read-only bit.)

Since:: New in 1.7.

svn_error_t* svn_io_run_cmd	(	const char *	path,
		const char *	cmd,
		const char const	args,
		int *	exitcode,
		apr_exit_why_e *	exitwhy,
		svn_boolean_t	inherit,
		apr_file_t *	infile,
		apr_file_t *	outfile,
		apr_file_t *	errfile,
		apr_pool_t *	pool
	)

Run a command to completion, by first calling svn_io_start_cmd() and then calling svn_io_wait_for_cmd().

The parameters correspond to the same-named parameters of those two functions.

SVN_DEPRECATED svn_error_t* svn_io_run_diff	(	const char *	dir,
		const char const	user_args,
		int	num_user_args,
		const char *	label1,
		const char *	label2,
		const char *	from,
		const char *	to,
		int *	exitcode,
		apr_file_t *	outfile,
		apr_file_t *	errfile,
		const char *	diff_cmd,
		apr_pool_t *	pool
	)

Similar to svn_io_run_diff2() but with diff_cmd encoded in internal encoding used by APR.

Deprecated:: Provided for backwards compatibility with the 1.5 API.

svn_error_t* svn_io_run_diff2	(	const char *	dir,
		const char const	user_args,
		int	num_user_args,
		const char *	label1,
		const char *	label2,
		const char *	from,
		const char *	to,
		int *	exitcode,
		apr_file_t *	outfile,
		apr_file_t *	errfile,
		const char *	diff_cmd,
		apr_pool_t *	pool
	)

Invoke the configured diff program, with user_args (an array of utf8-encoded num_user_args arguments) if they are specified (that is, if user_args is non-NULL), or "-u" if they are not.

If user_args is NULL, the value of num_user_args is ignored.

Diff runs in utf8-encoded dir, and its exit status is stored in exitcode, if it is not NULL.

If label1 and/or label2 are not NULL they will be passed to the diff process as the arguments of "-L" options. label1 and label2 are also in utf8, and will be converted to native charset along with the other args.

from is the first file passed to diff, and to is the second. The stdout of diff will be sent to outfile, and the stderr to errfile.

diff_cmd must be non-NULL.

Do all allocation in pool.

Since:: New in 1.6.0.

SVN_DEPRECATED svn_error_t* svn_io_run_diff3	(	const char *	dir,
		const char *	mine,
		const char *	older,
		const char *	yours,
		const char *	mine_label,
		const char *	older_label,
		const char *	yours_label,
		apr_file_t *	merged,
		int *	exitcode,
		const char *	diff3_cmd,
		apr_pool_t *	pool
	)

Similar to svn_io_run_diff3_2(), but with user_args set to NULL.

Deprecated:: Provided for backwards compatibility with the 1.3 API.

SVN_DEPRECATED svn_error_t* svn_io_run_diff3_2	(	int *	exitcode,
		const char *	dir,
		const char *	mine,
		const char *	older,
		const char *	yours,
		const char *	mine_label,
		const char *	older_label,
		const char *	yours_label,
		apr_file_t *	merged,
		const char *	diff3_cmd,
		const apr_array_header_t *	user_args,
		apr_pool_t *	pool
	)

Similar to svn_io_run_diff3_3(), but with diff3_cmd encoded in internal encoding used by APR.

Deprecated:: Provided for backwards compatibility with the 1.5 API.

Since:: New in 1.4.

svn_error_t* svn_io_run_diff3_3	(	int *	exitcode,
		const char *	dir,
		const char *	mine,
		const char *	older,
		const char *	yours,
		const char *	mine_label,
		const char *	older_label,
		const char *	yours_label,
		apr_file_t *	merged,
		const char *	diff3_cmd,
		const apr_array_header_t *	user_args,
		apr_pool_t *	pool
	)

Invoke the configured diff3 program, in utf8-encoded dir like this:

diff3 -E -m mine older yours > merged

(See the diff3 documentation for details.)

If user_args is non-NULL, replace "-E" with the const char* elements that user_args contains.

mine, older and yours are utf8-encoded paths (relative to dir or absolute) to three files that already exist.

merged is an open file handle, and is left open after the merge result is written to it. (merged should *not* be the same file as mine, or nondeterministic things may happen!)

mine_label, older_label, yours_label are utf8-encoded label parameters for diff3's -L option. Any of them may be NULL, in which case the corresponding mine, older, or yours parameter is used instead.

Set *exitcode to diff3's exit status. If *exitcode is anything other than 0 or 1, then return SVN_ERR_EXTERNAL_PROGRAM. (Note the following from the diff3 info pages: "An exit status of 0 means `diff3' was successful, 1 means some conflicts were found, and 2 means trouble.")

diff3_cmd must be non-NULL.

Do all allocation in pool.

Since:: New in 1.4.

svn_error_t* svn_io_set_file_affected_time	(	apr_time_t	apr_time,
		const char *	path,
		apr_pool_t *	pool
	)

Set the timestamp of file path to apr_time.

path is utf8-encoded.

Note:: This is the APR mtime which corresponds to the traditional mtime on Unix, and the last write time on Windows.

svn_error_t* svn_io_set_file_executable	(	const char *	path,
		svn_boolean_t	executable,
		svn_boolean_t	ignore_enoent,
		apr_pool_t *	pool
	)

Set path's "executability" (but do nothing if it is a symlink).

path is the utf8-encoded path to the file. If executable is TRUE, then make the file executable. If FALSE, make it non-executable. If ignore_enoent is TRUE, don't fail if the target file doesn't exist.

When making the file executable on operating systems with unix style permissions, never add an execute permission where there is not already a read permission: that is, only make the file executable for the user, group or world if the corresponding read permission is already set for user, group or world.

When making the file non-executable on operating systems with unix style permissions, remove all execute permissions.

On other operating systems, toggle the file's "executability" as much as the operating system allows.

Note:: If path is a directory, act on it as though it were a file, as described above, but note that you probably don't want to call this function on directories. We have left it effective on directories for compatibility reasons, but as its name implies, it should be used only for files.

svn_error_t* svn_io_set_file_read_only	(	const char *	path,
		svn_boolean_t	ignore_enoent,
		apr_pool_t *	pool
	)

Make a file as read-only as the operating system allows.

path is the utf8-encoded path to the file. If ignore_enoent is TRUE, don't fail if the target file doesn't exist.

If path is a symlink, do nothing.

Note:: If path is a directory, act on it as though it were a file, as described above, but note that you probably don't want to call this function on directories. We have left it effective on directories for compatibility reasons, but as its name implies, it should be used only for files.

svn_error_t* svn_io_set_file_read_write	(	const char *	path,
		svn_boolean_t	ignore_enoent,
		apr_pool_t *	pool
	)

Make a file as writable as the operating system allows.

path is the utf8-encoded path to the file. If ignore_enoent is TRUE, don't fail if the target file doesn't exist.

Warning:: On Unix this function will do the equivalent of chmod a+w path. If this is not what you want you should not use this function, but rather use apr_file_perms_set().

If path is a symlink, do nothing.

Note:: If path is a directory, act on it as though it were a file, as described above, but note that you probably don't want to call this function on directories. We have left it effective on directories for compatibility reasons, but as its name implies, it should be used only for files.

SVN_DEPRECATED svn_error_t* svn_io_set_file_read_write_carefully	(	const char *	path,
		svn_boolean_t	enable_write,
		svn_boolean_t	ignore_enoent,
		apr_pool_t *	pool
	)

Similar to svn_io_set_file_read_* functions.

Change the read-write permissions of a file.

Since:: New in 1.1.

When making path read-write on operating systems with unix style permissions, set the permissions on path to the permissions that are set when a new file is created (effectively honoring the user's umask).

When making the file read-only on operating systems with unix style permissions, remove all write permissions.

On other operating systems, toggle the file's "writability" as much as the operating system allows.

path is the utf8-encoded path to the file. If enable_write is TRUE, then make the file read-write. If FALSE, make it read-only. If ignore_enoent is TRUE, don't fail if the target file doesn't exist.

Deprecated:: Provided for backward compatibility with the 1.3 API.

void svn_io_sleep_for_timestamps	(	const char *	path,
		apr_pool_t *	pool
	)

Sleep to ensure that any files modified after we exit have a different timestamp than the one we recorded.

If path is not NULL, check if we can determine how long we should wait for a new timestamp on the filesystem containing path, an existing file or directory. If path is NULL or we can't determine the timestamp resolution, sleep until the next second.

Use pool for any necessary allocations. pool can be null if path is NULL.

Errors while retrieving the timestamp resolution will result in sleeping to the next second, to keep the working copy stable in error conditions.

Since:: New in 1.6.

SVN_DEPRECATED svn_error_t* svn_io_start_cmd	(	apr_proc_t *	cmd_proc,
		const char *	path,
		const char *	cmd,
		const char const	args,
		svn_boolean_t	inherit,
		apr_file_t *	infile,
		apr_file_t *	outfile,
		apr_file_t *	errfile,
		apr_pool_t *	pool
	)

Similar to svn_io_start_cmd2() but with infile_pipe, outfile_pipe, and errfile_pipe always FALSE.

Deprecated:: Provided for backward compatibility with the 1.6 API

Since:: New in 1.3.

svn_error_t* svn_io_start_cmd2	(	apr_proc_t *	cmd_proc,
		const char *	path,
		const char *	cmd,
		const char const	args,
		svn_boolean_t	inherit,
		svn_boolean_t	infile_pipe,
		apr_file_t *	infile,
		svn_boolean_t	outfile_pipe,
		apr_file_t *	outfile,
		svn_boolean_t	errfile_pipe,
		apr_file_t *	errfile,
		apr_pool_t *	pool
	)

Start cmd with args, using utf8-encoded path as working directory.

Return the process handle for the invoked program in *cmd_proc.

If infile_pipe is TRUE, connect cmd's stdin to a pipe; otherwise, connect it to infile (which may be NULL). If outfile_pipe is TRUE, connect cmd's stdout to a pipe; otherwise, connect it to outfile (which may be NULL). If errfile_pipe is TRUE, connect cmd's stderr to a pipe; otherwise, connect it to errfile (which may be NULL). (Callers must pass FALSE for each of these boolean values for which the corresponding file handle is non-NULL.)

args is a list of utf8-encoded const char * arguments, terminated by NULL. args[0] is the name of the program, though it need not be the same as cmd.

If inherit is TRUE, the invoked program inherits its environment from the caller and cmd, if not absolute, is searched for in PATH. Otherwise, the invoked program runs with an empty environment and cmd must be an absolute path.

Note:: On some platforms, failure to execute cmd in the child process will result in error output being written to errfile, if non-NULL, and a non-zero exit status being returned to the parent process.

Since:: New in 1.7.

svn_error_t* svn_io_stat	(	apr_finfo_t *	finfo,
		const char *	fname,
		apr_int32_t	wanted,
		apr_pool_t *	pool
	)

Wrapper for apr_stat().

fname is utf8-encoded.

svn_error_t* svn_io_stat_dirent	(	const svn_io_dirent2_t **	dirent_p,
		const char *	path,
		svn_boolean_t	ignore_enoent,
		apr_pool_t *	result_pool,
		apr_pool_t *	scratch_pool
	)

Create a svn_io_dirent2_t instance for path.

Specialized variant of svn_io_stat() that directly translates node_kind and special.

If ignore_enoent is set to TRUE, set *dirent_p->kind to svn_node_none instead of returning an error.

Since:: New in 1.7.

svn_error_t* svn_io_wait_for_cmd	(	apr_proc_t *	cmd_proc,
		const char *	cmd,
		int *	exitcode,
		apr_exit_why_e *	exitwhy,
		apr_pool_t *	pool
	)

Wait for the process *cmd_proc to complete and optionally retrieve its exit code.

cmd is used only in error messages.

If exitcode is not NULL, set *exitcode to the exit code of the process and do not consider any exit code to be an error. If exitcode is NULL, then if the exit code of the process is non-zero then return an SVN_ERR_EXTERNAL_PROGRAM error.

If exitwhy is not NULL, set *exitwhy to indicate why the process terminated and do not consider any reason to be an error. If exitwhy is NULL, then if the termination reason is not APR_PROC_CHECK_EXIT() then return an SVN_ERR_EXTERNAL_PROGRAM error.

Since:: New in 1.3.

svn_error_t* svn_io_write_unique	(	const char **	tmp_path,
		const char *	dirpath,
		const void *	buf,
		apr_size_t	nbytes,
		svn_io_file_del_t	delete_when,
		apr_pool_t *	pool
	)

Open a unique file in dirpath, and write nbytes from buf to the file before flushing it to disk and closing it.

Return the name of the newly created file in *tmp_path, allocated in pool.

If dirpath is NULL, use the path returned from svn_io_temp_dir(). (Note that when using the system-provided temp directory, it may not be possible to atomically rename the resulting file due to cross-device issues.)

The file will be deleted according to delete_when.

Since:: New in 1.6.

svn_error_t* svn_stringbuf_from_aprfile	(	svn_stringbuf_t **	result,
		apr_file_t *	file,
		apr_pool_t *	pool
	)

Sets *result to a string containing the contents of the already opened file.

Reads from the current position in file to the end. Does not close the file or reset the cursor position.

Note:: due to memory pseudo-reallocation behavior (due to pools), this can be a memory-intensive operation for large files.

SVN_DEPRECATED svn_error_t* svn_stringbuf_from_file	(	svn_stringbuf_t **	result,
		const char *	filename,
		apr_pool_t *	pool
	)

Similar to svn_stringbuf_from_file2(), except that if filename is "-", return the error SVN_ERR_UNSUPPORTED_FEATURE and don't touch *result.

Deprecated:: Provided for backwards compatibility with the 1.4 API.

svn_error_t* svn_stringbuf_from_file2	(	svn_stringbuf_t **	result,
		const char *	filename,
		apr_pool_t *	pool
	)

Set *result to a string containing the contents of filename, which is either "-" (indicating that stdin should be read) or the utf8-encoded path of a real file.

Warning:: Callers should be aware of possible unexpected results when using this function to read from stdin where additional stdin-reading processes abound. For example, if a program tries both to invoke an external editor and to read from stdin, stdin could be trashed and the editor might act funky or die outright.

Note:: due to memory pseudo-reallocation behavior (due to pools), this can be a memory-intensive operation for large files.

Since:: New in 1.5.

svn_io.h File Reference

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation