Back to index

lightning-sunbird  0.9+nobinonly
mimepbuf.h
Go to the documentation of this file.
00001 /* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef _MIMEPBUF_H_
00039 #define _MIMEPBUF_H_
00040 
00041 #include "mimei.h"
00042 
00043 /* This file provides the ability to save up the entire contents of a MIME
00044    object (of arbitrary size), and then emit it all at once later.  The
00045    buffering is done in an efficient way that works well for both very large
00046    and very small objects.
00047 
00048    This is used in two places:
00049 
00050    = The implementation of multipart/alternative uses this code to do a
00051      one-part-lookahead.  As it traverses its children, it moves forward
00052      until it finds a part which cannot be displayed; and then it displays
00053      the *previous* part (the last which *could* be displayed.)  This code
00054      is used to hold the previous part until it is needed.
00055 */
00056 
00057 #ifdef MOZ_SECURITY
00058 HG37486
00059 #endif
00060 
00061 /* An opaque object used to represent the buffered data.
00062  */
00063 typedef struct MimePartBufferData MimePartBufferData;
00064 
00065 /* Create an empty part buffer object.
00066  */
00067 extern MimePartBufferData *MimePartBufferCreate (void);
00068 
00069 /* Assert that the buffer is now full (EOF has been reached on the current
00070    part.)  This will free some resources, but leaves the part in the buffer.
00071    After calling MimePartBufferReset, the buffer may be used to store a
00072    different object.
00073  */
00074 void MimePartBufferClose (MimePartBufferData *data);
00075 
00076 /* Reset a part buffer object to the default state, discarding any currently-
00077    buffered data.
00078  */
00079 extern void MimePartBufferReset (MimePartBufferData *data);
00080 
00081 /* Free the part buffer itself, and discard any buffered data.
00082  */
00083 extern void MimePartBufferDestroy (MimePartBufferData *data);
00084 
00085 /* Push a chunk of a MIME object into the buffer.
00086  */
00087 extern int MimePartBufferWrite (MimePartBufferData *data,
00088                                                         const char *buf, PRInt32 size);
00089 
00090 /* Read the contents of the buffer back out.  This will invoke the provided
00091    read_fn with successive chunks of data until the buffer has been drained.
00092    The provided function may be called once, or multiple times.
00093  */
00094 extern int
00095 MimePartBufferRead (MimePartBufferData *data,
00096                                    nsresult (*read_fn) (const char *buf, PRInt32 size, void *closure),
00097                                    void *closure);
00098 
00099 #endif /* _MIMEPBUF_H_ */