Back to index

lightning-sunbird  0.9+nobinonly
mimeleaf.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 _MIMELEAF_H_
00039 #define _MIMELEAF_H_
00040 
00041 #include "mimeobj.h"
00042 #include "modmimee.h"
00043 
00044 /* MimeLeaf is the class for the objects representing all MIME types which
00045    are not containers for other MIME objects.  The implication of this is
00046    that they are MIME types which can have Content-Transfer-Encodings 
00047    applied to their data.  This class provides that service in its 
00048    parse_buffer() method:
00049 
00050      int (*parse_decoded_buffer) (const char *buf, PRInt32 size, MimeObject *obj)
00051 
00052    The `parse_buffer' method of MimeLeaf passes each block of data through
00053    the appropriate decoder (if any) and then calls `parse_decoded_buffer'
00054    on each block (not line) of output.
00055 
00056    The default `parse_decoded_buffer' method of MimeLeaf line-buffers the
00057    now-decoded data, handing each line to the `parse_line' method in turn.
00058    If different behavior is desired (for example, if a class wants access
00059    to the decoded data before it is line-buffered) the `parse_decoded_buffer'
00060    method should be overridden.  (MimeExternalObject does this.)
00061  */
00062 
00063 typedef struct MimeLeafClass MimeLeafClass;
00064 typedef struct MimeLeaf      MimeLeaf;
00065 
00066 struct MimeLeafClass {
00067   MimeObjectClass object;
00068   /* This is the callback that is handed to the decoder. */
00069   int (*parse_decoded_buffer) (const char *buf, PRInt32 size, MimeObject *obj);
00070   int (*close_decoder) (MimeObject *obj);
00071 };
00072 
00073 extern MimeLeafClass mimeLeafClass;
00074 
00075 struct MimeLeaf {
00076   MimeObject object;        /* superclass variables */
00077 
00078   /* If we're doing Base64, Quoted-Printable, or UU decoding, this is the
00079         state object for the decoder. */
00080   MimeDecoderData *decoder_data;
00081 };
00082 
00083 #endif /* _MIMELEAF_H_ */