wrowe 2002/12/16 17:07:01
Modified: include apr_file_info.h
Log:
Ryan correctly reminds me I didn't get this straight...
Clarify the distinction between APR_NOFILE and APR_UNKFILE.
APR_NOFILE is the traditional 'no type known' or 'not a file'.
APR_UNKFILE is the 'we have a filetype, and can't represent it!'
Revision Changes Path
1.35 +21 -4 apr/include/apr_file_info.h
Index: apr_file_info.h
===================================================================
RCS file: /home/cvs/apr/include/apr_file_info.h,v
retrieving revision 1.34
retrieving revision 1.35
diff -u -r1.34 -r1.35
--- apr_file_info.h 14 Dec 2002 05:52:56 -0000 1.34
+++ apr_file_info.h 17 Dec 2002 01:07:00 -0000 1.35
@@ -78,8 +78,24 @@
* @{
*/
+/* Many applications use the type member to determine the
+ * existance of a file or initialization of the file info,
+ * so the APR_NOFILE value must be distinct from APR_UNKFILE.
+ */
+
+/** apr_filetype_e values for the filetype member of the
+ * apr_file_info_t structure
+ * @warning: Not all of the filetypes below can be determined.
+ * For example, a given platform might not correctly report
+ * a socket descriptor as APR_SOCK if that type isn't
+ * well-identified on that platform. In such cases where
+ * a filetype exists but cannot be described by the recognized
+ * flags below, the filetype will be APR_UNKFILE. If the
+ * filetype member is not determined, the type will be APR_NOFILE.
+ */
+
typedef enum {
- APR_NOFILE = 0, /**< the file exists, but APR doesn't know its type
*/
+ APR_NOFILE = 0, /**< no file type determined */
APR_REG, /**< a regular file */
APR_DIR, /**< a directory */
APR_CHR, /**< a character device */
@@ -87,7 +103,7 @@
APR_PIPE, /**< a FIFO / pipe */
APR_LNK, /**< a symbolic link */
APR_SOCK, /**< a [unix domain] socket */
- APR_UNKFILE = 127 /**< a file of unknown type */
+ APR_UNKFILE = 127 /**< a file of some other unknown type */
} apr_filetype_e;
/**
@@ -188,8 +204,9 @@
apr_int32_t valid;
/** The access permissions of the file. Mimics Unix access rights. */
apr_fileperms_t protection;
- /** The type of file. One of APR_NOFILE, APR_REG, APR_DIR, APR_CHR,
- * APR_BLK, APR_PIPE, APR_LNK, APR_SOCK
+ /** The type of file. One of APR_REG, APR_DIR, APR_CHR, APR_BLK,
APR_PIPE,
+ * APR_LNK or APR_SOCK. If the type is undetermined, the value is
APR_NOFILE.
+ * If the type cannot be determined, the value is APR_UNKFILE.
*/
apr_filetype_e filetype;
/** The user id that owns the file */
