Back to index

lightning-sunbird  0.9+nobinonly
mimecth.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 /* 
00039  * This is the definitions for the Content Type Handler plugins for
00040  * libmime. This will allow developers the dynamically add the ability
00041  * for libmime to render new content types in the MHTML rendering of
00042  * HTML messages.
00043  */
00044  
00045 #ifndef _MIMECTH_H_
00046 #define _MIMECTH_H_
00047 
00048 #include "mimei.h"
00049 #include "mimeobj.h" /*  MimeObject (abstract)                                             */
00050 #include "mimecont.h"       /*   |--- MimeContainer (abstract)                             */
00051 #include "mimemult.h"       /*   |     |--- MimeMultipart (abstract)                */
00052 #include "mimemsig.h"       /*   |     |     |--- MimeMultipartSigned (abstract)*/
00053 #include "mimetext.h"       /*   |     |--- MimeInlineText (abstract)               */
00054 
00055 /*
00056   This header exposes functions that are necessary to access the 
00057   object heirarchy for the mime chart. The class hierarchy is:
00058 
00059      MimeObject (abstract)
00060       |
00061       |--- MimeContainer (abstract)
00062       |     |
00063       |     |--- MimeMultipart (abstract)
00064       |     |     |
00065       |     |     |--- MimeMultipartMixed
00066       |     |     |
00067       |     |     |--- MimeMultipartDigest
00068       |     |     |
00069       |     |     |--- MimeMultipartParallel
00070       |     |     |
00071       |     |     |--- MimeMultipartAlternative
00072       |     |     |
00073       |     |     |--- MimeMultipartRelated
00074       |     |     |
00075       |     |     |--- MimeMultipartAppleDouble
00076       |     |     |
00077       |     |     |--- MimeSunAttachment
00078       |     |     |
00079       |     |     |--- MimeMultipartSigned (abstract)
00080       |     |          |
00081       |     |          |--- MimeMultipartSigned
00082       |     |
00083       |     |--- MimeXlateed (abstract)
00084       |     |     |
00085       |     |     |--- MimeXlateed
00086       |     |
00087       |     |--- MimeMessage
00088       |     |
00089       |     |--- MimeUntypedText
00090       |
00091       |--- MimeLeaf (abstract)
00092       |     |
00093       |     |--- MimeInlineText (abstract)
00094       |     |     |
00095       |     |     |--- MimeInlineTextPlain
00096       |     |     |
00097       |     |     |--- MimeInlineTextHTML
00098       |     |     |
00099       |     |     |--- MimeInlineTextRichtext
00100       |     |     |     |
00101       |     |     |     |--- MimeInlineTextEnriched
00102       |     |     |
00103       |     |     |--- MimeInlineTextVCard
00104       |     |
00105       |     |--- MimeInlineImage
00106       |     |
00107       |     |--- MimeExternalObject
00108       |
00109       |--- MimeExternalBody
00110  */
00111 
00112 #include "nsIMimeContentTypeHandler.h"
00113 
00114 /*
00115  * These functions are exposed by libmime to be used by content type
00116  * handler plugins for processing stream data. 
00117  */
00118 /*
00119  * This is the write call for outputting processed stream data.
00120  */ 
00121 extern int                        MIME_MimeObject_write(MimeObject *, 
00122                                                         const char *data, 
00123                                                         PRInt32 length, 
00124                                                         PRBool user_visible_p);
00125 /*
00126  * The following group of calls expose the pointers for the object
00127  * system within libmime. 
00128  */                                                        
00129 extern MimeInlineTextClass       *MIME_GetmimeInlineTextClass(void);
00130 extern MimeLeafClass             *MIME_GetmimeLeafClass(void);
00131 extern MimeObjectClass           *MIME_GetmimeObjectClass(void);
00132 extern MimeContainerClass        *MIME_GetmimeContainerClass(void);
00133 extern MimeMultipartClass        *MIME_GetmimeMultipartClass(void);
00134 extern MimeMultipartSignedClass  *MIME_GetmimeMultipartSignedClass(void);
00135 
00136 /*
00137  * These are the functions that need to be implemented by the
00138  * content type handler plugin. They will be called by by libmime
00139  * when the module is loaded at runtime. 
00140  */
00141  
00142 /* 
00143  * MIME_GetContentType() is called by libmime to identify the content
00144  * type handled by this plugin.
00145  */ 
00146 extern "C" 
00147 char            *MIME_GetContentType(void);
00148 
00149 /* 
00150  * This will create the MimeObjectClass object to be used by the libmime
00151  * object system.
00152  */
00153 extern "C" 
00154 MimeObjectClass *MIME_CreateContentTypeHandlerClass(const char *content_type, 
00155                                    contentTypeHandlerInitStruct *initStruct);
00156 
00157 /* 
00158  * Typedefs for libmime to use when locating and calling the above
00159  * defined functions.
00160  */
00161 typedef char * (*mime_get_ct_fn_type)(void);
00162 typedef MimeObjectClass * (*mime_create_class_fn_type)
00163                               (const char *, contentTypeHandlerInitStruct *);
00164 
00165 #endif /* _MIMECTH_H_ */