X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;f=ucw%2Ffastbuf.h;h=99a9dd47285f04f5adb0c458370ced1c359a2dff;hb=4e2835850dfa4d869e470017d921f4d36293b111;hp=564593dd16094e9ef32a4506b254042ea955f014;hpb=94e34eacc4086c13f68580e153d727739c17cf9c;p=libucw.git diff --git a/ucw/fastbuf.h b/ucw/fastbuf.h index 564593dd..99a9dd47 100644 --- a/ucw/fastbuf.h +++ b/ucw/fastbuf.h @@ -3,6 +3,7 @@ * * (c) 1997--2011 Martin Mares * (c) 2004 Robert Spalek + * (c) 2014 Pavel Charvat * * This software may be freely distributed and used according to the terms * of the GNU Lesser General Public License. @@ -14,6 +15,78 @@ #include #include +#ifdef CONFIG_UCW_CLEAN_ABI +#define bbcopy_slow ucw_bbcopy_slow +#define bclose ucw_bclose +#define bclose_file_helper ucw_bclose_file_helper +#define bconfig ucw_bconfig +#define beof_slow ucw_beof_slow +#define bfdopen ucw_bfdopen +#define bfdopen_internal ucw_bfdopen_internal +#define bfdopen_shared ucw_bfdopen_shared +#define bfilesize ucw_bfilesize +#define bfilesync ucw_bfilesync +#define bfix_tmp_file ucw_bfix_tmp_file +#define bflush ucw_bflush +#define bfmmopen_internal ucw_bfmmopen_internal +#define bgetc_slow ucw_bgetc_slow +#define bgets ucw_bgets +#define bgets0 ucw_bgets0 +#define bgets_bb ucw_bgets_bb +#define bgets_mp ucw_bgets_mp +#define bgets_nodie ucw_bgets_nodie +#define bgets_stk_init ucw_bgets_stk_init +#define bgets_stk_step ucw_bgets_stk_step +#define bopen ucw_bopen +#define bopen_fd_name ucw_bopen_fd_name +#define bopen_file ucw_bopen_file +#define bopen_file_try ucw_bopen_file_try +#define bopen_limited_fd ucw_bopen_limited_fd +#define bopen_tmp ucw_bopen_tmp +#define bopen_tmp_file ucw_bopen_tmp_file +#define bopen_try ucw_bopen_try +#define bpeekc_slow ucw_bpeekc_slow +#define bprintf ucw_bprintf +#define bputc_slow ucw_bputc_slow +#define bread_slow ucw_bread_slow +#define brefill ucw_brefill +#define brewind ucw_brewind +#define bseek ucw_bseek +#define bsetpos ucw_bsetpos +#define bskip_slow ucw_bskip_slow +#define bspout ucw_bspout +#define bthrow ucw_bthrow +#define bwrite_slow ucw_bwrite_slow +#define fb_tie ucw_fb_tie +#define fbatomic_internal_write ucw_fbatomic_internal_write +#define fbatomic_open ucw_fbatomic_open +#define fbbuf_init_read ucw_fbbuf_init_read +#define fbbuf_init_write ucw_fbbuf_init_write +#define fbdir_cheat ucw_fbdir_cheat +#define fbdir_open_fd_internal ucw_fbdir_open_fd_internal +#define fbgrow_create ucw_fbgrow_create +#define fbgrow_create_mp ucw_fbgrow_create_mp +#define fbgrow_get_buf ucw_fbgrow_get_buf +#define fbgrow_reset ucw_fbgrow_reset +#define fbgrow_rewind ucw_fbgrow_rewind +#define fbmem_clone_read ucw_fbmem_clone_read +#define fbmem_create ucw_fbmem_create +#define fbmulti_append ucw_fbmulti_append +#define fbmulti_create ucw_fbmulti_create +#define fbmulti_remove ucw_fbmulti_remove +#define fbnull_open ucw_fbnull_open +#define fbnull_start ucw_fbnull_start +#define fbnull_test ucw_fbnull_test +#define fbpar_cf ucw_fbpar_cf +#define fbpar_def ucw_fbpar_def +#define fbpool_end ucw_fbpool_end +#define fbpool_init ucw_fbpool_init +#define fbpool_start ucw_fbpool_start +#define open_tmp ucw_open_tmp +#define temp_file_name ucw_temp_file_name +#define vbprintf ucw_vbprintf +#endif + /*** * === Internal structure [[internal]] * @@ -38,7 +111,7 @@ * ^ ^ ^ ^ * buffer <= bstop (BE pos) <= bptr (FE pos) <= bufend * - * * This schema describes a fastbuf after its initialization or bflush(). + * * This schema describes a fastbuf after its initialization or @bflush(). * * There is no cached data and we are ready for any read or write operation * (well, only if the back-end supports it). * * The interval `[bptr, bufend]` can be used by front-ends @@ -197,7 +270,7 @@ extern struct fb_params fbpar_def; /** The default `fb_params` **/ * Raises `ucw.fb.open` if the file does not exist. **/ struct fastbuf *bopen_file(const char *name, int mode, struct fb_params *params); -struct fastbuf *bopen_file_try(const char *name, int mode, struct fb_params *params); /** Like bopen_file(), but returns NULL on failure. **/ +struct fastbuf *bopen_file_try(const char *name, int mode, struct fb_params *params); /** Like @bopen_file(), but returns NULL on failure. **/ /** * Opens a temporary file. @@ -401,7 +474,7 @@ struct fbpool { /** Structure for fastbufs & mempools. **/ /** * Initialize a new `fbpool`. The structure is allocated by the caller, - * so bclose() should not be called and no resource tying takes place. + * so @bclose() should not be called and no resource tying takes place. **/ void fbpool_init(struct fbpool *fb); /** Initialize a new mempool fastbuf. **/ /** @@ -473,6 +546,25 @@ static inline void fbatomic_commit(struct fastbuf *b) fbatomic_internal_write(b); } +/*** === Null fastbufs ***/ + +/** + * Creates a new "/dev/null"-like fastbuf. + * Any read attempt returns an EOF, any write attempt is silently ignored. + **/ +struct fastbuf *fbnull_open(uns bufsize); + +/** + * Can be used by any back-end to switch it to the null mode. + * You need to provide at least one byte long buffer for writing. + **/ +void fbnull_start(struct fastbuf *b, byte *buf, uns bufsize); + +/** + * Checks whether a fastbuf has been switched to the null mode. + **/ +bool fbnull_test(struct fastbuf *b); + /*** * === Fastbufs atop other fastbufs [[fbmulti]] * @@ -488,32 +580,37 @@ static inline void fbatomic_commit(struct fastbuf *b) * * This backend is seekable iff all of the supplied fastbufs are seekable. * - * Also, please be aware of direct operations on the underlying buffers. The - * fbmulti backend doesn't expect you doing something directly on them. - * - * You may init a fbmulti by @fbmulti_create(bufsize, fb1, fb2, ..., NULL). - * This call returns a fastbuf that concatenates all the given fastbufs. - * The last parameter of @fbmulti_create must be NULL. + * You aren't allowed to do anything with the underlying buffers while these + * are connected into fbmulti. * - * By default, if @bclose() is called on fbmulti, all the underlying buffers - * get closed recursively. + * The fbmulti is inited by @fbmulti_create(). It returns an empty fbmulti. + * Then you call @fbmulti_append() for each fbmulti. * - * You may init a fbmulti by @fbmulti_create(bufsize) with no underlying buffers - * and then append the underlying buffers one by one. If allow_close is set to 0, - * the fastbuf doesn't get closed at @bclose() and you have to do the cleanup on - * yourself. + * If @bclose() is called on fbmulti, all the underlying buffers get closed + * recursively. * - * If used in some formatter, you'll probably have a large and deep structure - * of nested fastbufs. Just before reading from the fbmulti, you may call - * @fbmulti_flatten() to flatten the structure. After @fbmulti_flatten(), the - * fbmulti is seeked to the beginning, flushed and ready to read the whole buffer. + * If you want to keep an underlying fastbuf open after @bclose, just remove it + * by @fbmulti_remove where the second parameter is a pointer to the removed + * fastbuf. If you pass NULL, all the underlying fastbufs are removed. * - * For performance reasons, use @fbmulti_flatten() only once, just before reading. + * After @fbmulti_remove, the state of the fbmulti is undefined. The only allowed + * operation is either another @fbmulti_remove or @bclose on the fbmulti. ***/ -struct fastbuf* fbmulti_create(uns bufsize, ...) SENTINEL_CHECK; -void fbmulti_append(struct fastbuf *f, struct fastbuf *fa, int allow_close); -void fbmulti_flatten(struct fastbuf *f); +/** + * Create an empty fbmulti + **/ +struct fastbuf *fbmulti_create(void); + +/** + * Append a fb to fbmulti + **/ +void fbmulti_append(struct fastbuf *f, struct fastbuf *fb); + +/** + * Remove a fb from fbmulti + **/ +void fbmulti_remove(struct fastbuf *f, struct fastbuf *fb); /*** === Configuring stream parameters [[bconfig]] ***/