mirror of
https://github.com/php/php-src.git
synced 2024-09-23 02:47:26 +00:00
b628fc219a
[DOC] # Class FilesystemIterator was introduced to have a better DirectoryIterator # without having to change DirectoryIterator or RecursiveDirectoryIterator. # On top of FilterIterator the new GlobIterator was introduced. This one allows # to implement Countable(). But a glob stream flattens all structure, so it # cannot be derived from RedursiveIterator. With the new structure all children # of FilesystemIterator have nearly the same behavior. Just their capabilities # are a bit different. Check out new inheritance tree on SplFileInfo: # # [marcus@frodo PHP_5_3]$ php ext/spl/examples/class_tree.php SplFileInfo # make: `sapi/cli/php' is up to date. # SplFileInfo # |-DirectoryIterator (Iterator) # | \-FilesystemIterator # | |-GlobIterator (Countable) # | \-RecursiveDirectoryIterator (RecursiveIterator) # | \-Phar (ArrayAccess, Countable) # |-PharFileInfo # \-SplFileObject (RecursiveIterator, SeekableIterator) # \-SplTempFileObject
136 lines
4.8 KiB
C
Executable File
136 lines
4.8 KiB
C
Executable File
/*
|
|
+----------------------------------------------------------------------+
|
|
| PHP Version 5 |
|
|
+----------------------------------------------------------------------+
|
|
| Copyright (c) 1997-2008 The PHP Group |
|
|
+----------------------------------------------------------------------+
|
|
| This source file is subject to version 3.01 of the PHP license, |
|
|
| that is bundled with this package in the file LICENSE, and is |
|
|
| available through the world-wide-web at the following url: |
|
|
| http://www.php.net/license/3_01.txt |
|
|
| If you did not receive a copy of the PHP license and are unable to |
|
|
| obtain it through the world-wide-web, please send a note to |
|
|
| license@php.net so we can mail you a copy immediately. |
|
|
+----------------------------------------------------------------------+
|
|
| Authors: Marcus Boerger <helly@php.net> |
|
|
+----------------------------------------------------------------------+
|
|
*/
|
|
|
|
/* $Id$ */
|
|
|
|
#ifndef SPL_DIRECTORY_H
|
|
#define SPL_DIRECTORY_H
|
|
|
|
#include "php.h"
|
|
#include "php_spl.h"
|
|
|
|
extern PHPAPI zend_class_entry *spl_ce_SplFileInfo;
|
|
extern PHPAPI zend_class_entry *spl_ce_DirectoryIterator;
|
|
extern PHPAPI zend_class_entry *spl_ce_FilesystemIterator;
|
|
extern PHPAPI zend_class_entry *spl_ce_RecursiveDirectoryIterator;
|
|
extern PHPAPI zend_class_entry *spl_ce_GlobIterator;
|
|
extern PHPAPI zend_class_entry *spl_ce_SplFileObject;
|
|
extern PHPAPI zend_class_entry *spl_ce_SplTempFileObject;
|
|
|
|
PHP_MINIT_FUNCTION(spl_directory);
|
|
|
|
typedef enum {
|
|
SPL_FS_INFO, /* must be 0 */
|
|
SPL_FS_DIR,
|
|
SPL_FS_FILE
|
|
} SPL_FS_OBJ_TYPE;
|
|
|
|
typedef struct _spl_filesystem_object spl_filesystem_object;
|
|
|
|
typedef void (*spl_foreign_dtor_t)(spl_filesystem_object *object TSRMLS_DC);
|
|
typedef void (*spl_foreign_clone_t)(spl_filesystem_object *src, spl_filesystem_object *dst TSRMLS_DC);
|
|
|
|
PHPAPI char* spl_filesystem_object_get_path(spl_filesystem_object *intern, int *len TSRMLS_DC);
|
|
|
|
typedef struct _spl_other_handler {
|
|
spl_foreign_dtor_t dtor;
|
|
spl_foreign_clone_t clone;
|
|
} spl_other_handler;
|
|
|
|
/* define an overloaded iterator structure */
|
|
typedef struct {
|
|
zend_object_iterator intern;
|
|
zval *current;
|
|
spl_filesystem_object *object;
|
|
} spl_filesystem_iterator;
|
|
|
|
struct _spl_filesystem_object {
|
|
zend_object std;
|
|
void *oth;
|
|
spl_other_handler *oth_handler;
|
|
char *_path;
|
|
int _path_len;
|
|
char *file_name;
|
|
int file_name_len;
|
|
SPL_FS_OBJ_TYPE type;
|
|
long flags;
|
|
zend_class_entry *file_class;
|
|
zend_class_entry *info_class;
|
|
union {
|
|
struct {
|
|
php_stream *dirp;
|
|
php_stream_dirent entry;
|
|
char *sub_path;
|
|
int sub_path_len;
|
|
int index;
|
|
int is_recursive;
|
|
} dir;
|
|
struct {
|
|
php_stream *stream;
|
|
php_stream_context *context;
|
|
zval *zcontext;
|
|
char *open_mode;
|
|
int open_mode_len;
|
|
zval *current_zval;
|
|
char *current_line;
|
|
size_t current_line_len;
|
|
size_t max_line_len;
|
|
long current_line_num;
|
|
zval zresource;
|
|
zend_function *func_getCurr;
|
|
char delimiter;
|
|
char enclosure;
|
|
char escape;
|
|
} file;
|
|
} u;
|
|
spl_filesystem_iterator it;
|
|
};
|
|
|
|
static inline spl_filesystem_iterator* spl_filesystem_object_to_iterator(spl_filesystem_object *obj)
|
|
{
|
|
return &obj->it;
|
|
}
|
|
|
|
static inline spl_filesystem_object* spl_filesystem_iterator_to_object(spl_filesystem_iterator *it)
|
|
{
|
|
return (spl_filesystem_object*)((char*)it - XtOffsetOf(spl_filesystem_object, it));
|
|
}
|
|
|
|
#define SPL_FILE_OBJECT_DROP_NEW_LINE 0x00000001 /* drop new lines */
|
|
#define SPL_FILE_OBJECT_READ_AHEAD 0x00000002 /* read on rewind/next */
|
|
#define SPL_FILE_OBJECT_SKIP_EMPTY 0x00000006 /* skip empty lines */
|
|
#define SPL_FILE_OBJECT_READ_CSV 0x00000008 /* read via fgetcsv */
|
|
|
|
#define SPL_FILE_DIR_CURRENT_AS_FILEINFO 0x00000010 /* make RecursiveDirectoryTree::current() return SplFileInfo */
|
|
#define SPL_FILE_DIR_CURRENT_AS_PATHNAME 0x00000020 /* make RecursiveDirectoryTree::current() return getPathname() */
|
|
#define SPL_FILE_DIR_CURRENT_MODE_MASK 0x000000F0 /* mask RecursiveDirectoryTree::current() */
|
|
|
|
#define SPL_FILE_DIR_KEY_AS_FILENAME 0x00000100 /* make RecursiveDirectoryTree::key() return getFilename() */
|
|
#define SPL_FILE_DIR_KEY_MODE_MASK 0x00000F00 /* mask RecursiveDirectoryTree::key() */
|
|
|
|
#endif /* SPL_DIRECTORY_H */
|
|
|
|
/*
|
|
* Local Variables:
|
|
* c-basic-offset: 4
|
|
* tab-width: 4
|
|
* End:
|
|
* vim600: fdm=marker
|
|
* vim: noet sw=4 ts=4
|
|
*/
|