Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

xmlwriter.h

Go to the documentation of this file.
00001 
00002 /*
00003  * xmlwriter.h : Interfaces,
00004                                          constants and types of the
00005  * text writing API.for XML
00006  *
00007  * For license and disclaimer see the license and disclaimer of
00008  * libxml2.
00009  *
00010  * alfred@mickautsch.de
00011  */
00012 
00013 #ifndef __XML_XMLWRITER_H__
00014 #define __XML_XMLWRITER_H__
00015 
00016 #ifdef __cplusplus
00017 extern "C" {
00018 #endif
00019 
00020 #include <libxml/xmlIO.h>
00021 #include <libxml/list.h>
00022 
00023 typedef struct _xmlTextWriter xmlTextWriter;
00024 typedef xmlTextWriter *xmlTextWriterPtr;
00025 
00026 /*
00027  * Constructors & Destructor
00028  */
00029 XMLPUBFUN xmlTextWriterPtr XMLCALL
00030         xmlNewTextWriter                (xmlOutputBufferPtr out);
00031 XMLPUBFUN xmlTextWriterPtr XMLCALL
00032         xmlNewTextWriterFilename        (const char *uri,
00033                                          int compression);
00034 XMLPUBFUN xmlTextWriterPtr XMLCALL
00035         xmlNewTextWriterMemory          (xmlBufferPtr buf,
00036                                          int compression);
00037 XMLPUBFUN void XMLCALL
00038         xmlFreeTextWriter               (xmlTextWriterPtr writer);
00039 
00040 /*
00041  * Functions
00042  */
00043 
00044 
00045 /*
00046  * Document
00047  */
00048 XMLPUBFUN int XMLCALL
00049         xmlTextWriterStartDocument      (xmlTextWriterPtr writer,
00050                                          const char *version,
00051                                          const char *encoding,
00052                                          const char *standalone);
00053 XMLPUBFUN int XMLCALL
00054         xmlTextWriterEndDocument        (xmlTextWriterPtr writer);
00055 
00056 /*
00057  * Comments
00058  */
00059 XMLPUBFUN int XMLCALL
00060         xmlTextWriterWriteFormatComment (xmlTextWriterPtr writer,
00061                                          const char *format, ...);
00062 XMLPUBFUN int XMLCALL
00063         xmlTextWriterWriteVFormatComment(xmlTextWriterPtr writer,
00064                                          const char *format,
00065                                          va_list argptr);
00066 XMLPUBFUN int XMLCALL
00067         xmlTextWriterWriteComment       (xmlTextWriterPtr writer,
00068                                          const xmlChar * content);
00069 
00070 /*
00071  * Elements
00072  */
00073 XMLPUBFUN int XMLCALL
00074         xmlTextWriterStartElement       (xmlTextWriterPtr writer,
00075                                          const xmlChar * name);
00076 XMLPUBFUN int XMLCALL
00077         xmlTextWriterStartElementNS     (xmlTextWriterPtr writer,
00078                                          const xmlChar * prefix,
00079                                          const xmlChar * name,
00080                                          const xmlChar * namespaceURI);
00081 XMLPUBFUN int XMLCALL
00082         xmlTextWriterEndElement         (xmlTextWriterPtr writer);
00083 XMLPUBFUN int XMLCALL
00084         xmlTextWriterFullEndElement     (xmlTextWriterPtr writer);
00085 
00086 /*
00087  * Elements conveniency functions
00088  */
00089 XMLPUBFUN int XMLCALL
00090         xmlTextWriterWriteFormatElement (xmlTextWriterPtr writer,
00091                                          const xmlChar * name,
00092                                          const char *format, ...);
00093 XMLPUBFUN int XMLCALL
00094         xmlTextWriterWriteVFormatElement(xmlTextWriterPtr writer,
00095                                          const xmlChar * name,
00096                                          const char *format,
00097                                          va_list argptr);
00098 XMLPUBFUN int XMLCALL
00099         xmlTextWriterWriteElement       (xmlTextWriterPtr writer,
00100                                          const xmlChar * name,
00101                                          const xmlChar * content);
00102 XMLPUBFUN int XMLCALL
00103         xmlTextWriterWriteFormatElementNS(xmlTextWriterPtr writer,
00104                                          const xmlChar * prefix,
00105                                          const xmlChar * name,
00106                                          const xmlChar * namespaceURI,
00107                                          const char *format, ...);
00108 XMLPUBFUN int XMLCALL
00109         xmlTextWriterWriteVFormatElementNS(xmlTextWriterPtr writer,
00110                                          const xmlChar * prefix,
00111                                          const xmlChar * name,
00112                                          const xmlChar * namespaceURI,
00113                                          const char *format,
00114                                          va_list argptr);
00115 XMLPUBFUN int XMLCALL
00116         xmlTextWriterWriteElementNS     (xmlTextWriterPtr writer,
00117                                          const xmlChar * prefix,
00118                                          const xmlChar * name,
00119                                          const xmlChar * namespaceURI,
00120                                          const xmlChar * content);
00121 
00122 /*
00123  * Text
00124  */
00125 XMLPUBFUN int XMLCALL
00126         xmlTextWriterWriteFormatRaw     (xmlTextWriterPtr writer,
00127                                          const char *format, ...);
00128 XMLPUBFUN int XMLCALL
00129         xmlTextWriterWriteVFormatRaw    (xmlTextWriterPtr writer,
00130                                          const char *format,
00131                                          va_list argptr);
00132 XMLPUBFUN int XMLCALL
00133         xmlTextWriterWriteRawLen        (xmlTextWriterPtr writer,
00134                                          const xmlChar * content,
00135                                          int len);
00136 XMLPUBFUN int XMLCALL
00137         xmlTextWriterWriteRaw           (xmlTextWriterPtr writer,
00138                                          const xmlChar * content);
00139 XMLPUBFUN int XMLCALL
00140         xmlTextWriterWriteFormatString  (xmlTextWriterPtr writer,
00141                                          const char *format, ...);
00142 XMLPUBFUN int XMLCALL
00143         xmlTextWriterWriteVFormatString (xmlTextWriterPtr writer,
00144                                          const char *format,
00145                                          va_list argptr);
00146 XMLPUBFUN int XMLCALL
00147         xmlTextWriterWriteString        (xmlTextWriterPtr writer,
00148                                          const xmlChar * content);
00149 XMLPUBFUN int XMLCALL
00150         xmlTextWriterWriteBase64        (xmlTextWriterPtr writer,
00151                                          const char *data,
00152                                          int start,
00153                                          int len);
00154 XMLPUBFUN int XMLCALL
00155         xmlTextWriterWriteBinHex        (xmlTextWriterPtr writer,
00156                                          const char *data,
00157                                          int start,
00158                                          int len);
00159 
00160 /*
00161  * Attributes
00162  */
00163 XMLPUBFUN int XMLCALL
00164         xmlTextWriterStartAttribute     (xmlTextWriterPtr writer,
00165                                          const xmlChar * name);
00166 XMLPUBFUN int XMLCALL
00167         xmlTextWriterStartAttributeNS   (xmlTextWriterPtr writer,
00168                                          const xmlChar * prefix,
00169                                          const xmlChar * name,
00170                                          const xmlChar * namespaceURI);
00171 XMLPUBFUN int XMLCALL
00172         xmlTextWriterEndAttribute       (xmlTextWriterPtr writer);
00173 
00174 /*
00175  * Attributes conveniency functions
00176  */
00177 XMLPUBFUN int XMLCALL
00178         xmlTextWriterWriteFormatAttribute(xmlTextWriterPtr writer,
00179                                          const xmlChar * name,
00180                                          const char *format, ...);
00181 XMLPUBFUN int XMLCALL
00182         xmlTextWriterWriteVFormatAttribute(xmlTextWriterPtr writer,
00183                                          const xmlChar * name,
00184                                          const char *format,
00185                                          va_list argptr);
00186 XMLPUBFUN int XMLCALL
00187         xmlTextWriterWriteAttribute     (xmlTextWriterPtr writer,
00188                                          const xmlChar * name,
00189                                          const xmlChar * content);
00190 XMLPUBFUN int XMLCALL
00191         xmlTextWriterWriteFormatAttributeNS(xmlTextWriterPtr writer,
00192                                          const xmlChar * prefix,
00193                                          const xmlChar * name,
00194                                          const xmlChar * namespaceURI,
00195                                          const char *format, ...);
00196 XMLPUBFUN int XMLCALL
00197         xmlTextWriterWriteVFormatAttributeNS(xmlTextWriterPtr writer,
00198                                          const xmlChar * prefix,
00199                                          const xmlChar * name,
00200                                          const xmlChar * namespaceURI,
00201                                          const char *format,
00202                                          va_list argptr);
00203 XMLPUBFUN int XMLCALL
00204         xmlTextWriterWriteAttributeNS   (xmlTextWriterPtr writer,
00205                                          const xmlChar * prefix,
00206                                          const xmlChar * name,
00207                                          const xmlChar * namespaceURI,
00208                                          const xmlChar * content);
00209 
00210 /*
00211  * PI's
00212  */
00213 XMLPUBFUN int XMLCALL
00214         xmlTextWriterStartPI            (xmlTextWriterPtr writer,
00215                                          const xmlChar * target);
00216 XMLPUBFUN int XMLCALL
00217         xmlTextWriterEndPI              (xmlTextWriterPtr writer);
00218 
00219 /*
00220  * PI conveniency functions
00221  */
00222 XMLPUBFUN int XMLCALL
00223         xmlTextWriterWriteFormatPI      (xmlTextWriterPtr writer,
00224                                          const xmlChar * target,
00225                                          const char *format, ...);
00226 XMLPUBFUN int XMLCALL
00227         xmlTextWriterWriteVFormatPI     (xmlTextWriterPtr writer,
00228                                          const xmlChar * target,
00229                                          const char *format,
00230                                          va_list argptr);
00231 XMLPUBFUN int XMLCALL
00232         xmlTextWriterWritePI            (xmlTextWriterPtr writer,
00233                                          const xmlChar * target,
00234                                          const xmlChar * content);
00235 #define xmlTextWriterWriteProcessingInstruction xmlTextWriterWritePI
00236 
00237 /*
00238  * CDATA
00239  */
00240 XMLPUBFUN int XMLCALL
00241         xmlTextWriterStartCDATA         (xmlTextWriterPtr writer);
00242 XMLPUBFUN int XMLCALL
00243         xmlTextWriterEndCDATA           (xmlTextWriterPtr writer);
00244 
00245 /*
00246  * CDATA conveniency functions
00247  */
00248 XMLPUBFUN int XMLCALL
00249         xmlTextWriterWriteFormatCDATA   (xmlTextWriterPtr writer,
00250                                          const char *format, ...);
00251 XMLPUBFUN int XMLCALL
00252         xmlTextWriterWriteVFormatCDATA  (xmlTextWriterPtr writer,
00253                                          const char *format,
00254                                          va_list argptr);
00255 XMLPUBFUN int XMLCALL
00256         xmlTextWriterWriteCDATA         (xmlTextWriterPtr writer,
00257                                          const xmlChar * content);
00258 
00259 /*
00260  * DTD
00261  */
00262 XMLPUBFUN int XMLCALL
00263         xmlTextWriterStartDTD           (xmlTextWriterPtr writer,
00264                                          const xmlChar * name,
00265                                          const xmlChar * pubid,
00266                                          const xmlChar * sysid);
00267 XMLPUBFUN int XMLCALL
00268         xmlTextWriterEndDTD             (xmlTextWriterPtr writer);
00269 
00270 /*
00271  * DTD conveniency functions
00272  */
00273 XMLPUBFUN int XMLCALL
00274         xmlTextWriterWriteFormatDTD     (xmlTextWriterPtr writer,
00275                                          const xmlChar * name,
00276                                          const xmlChar * pubid,
00277                                          const xmlChar * sysid,
00278                                          const char *format, ...);
00279 XMLPUBFUN int XMLCALL
00280         xmlTextWriterWriteVFormatDTD    (xmlTextWriterPtr writer,
00281                                          const xmlChar * name,
00282                                          const xmlChar * pubid,
00283                                          const xmlChar * sysid,
00284                                          const char *format,
00285                                          va_list argptr);
00286 XMLPUBFUN int XMLCALL
00287         xmlTextWriterWriteDTD           (xmlTextWriterPtr writer,
00288                                          const xmlChar * name,
00289                                          const xmlChar * pubid,
00290                                          const xmlChar * sysid,
00291                                          const xmlChar * subset);
00292 #define xmlTextWriterWriteDocType xmlTextWriterWriteDTD
00293 
00294 /*
00295  * DTD element definition
00296  */
00297 XMLPUBFUN int XMLCALL
00298         xmlTextWriterStartDTDElement    (xmlTextWriterPtr writer,
00299                                          const xmlChar * name);
00300 #define xmlTextWriterEndDTDElement xmlTextWriterEndDTD
00301 
00302 /*
00303  * DTD element definition conveniency functions
00304  */
00305 XMLPUBFUN int XMLCALL
00306         xmlTextWriterWriteFormatDTDElement(xmlTextWriterPtr writer,
00307                                          const xmlChar * name,
00308                                          const char *format, ...);
00309 XMLPUBFUN int XMLCALL
00310         xmlTextWriterWriteVFormatDTDElement(xmlTextWriterPtr writer,
00311                                          const xmlChar * name,
00312                                          const char *format,
00313                                          va_list argptr);
00314 XMLPUBFUN int XMLCALL
00315         xmlTextWriterWriteDTDElement    (xmlTextWriterPtr writer,
00316                                          const xmlChar * name,
00317                                          const xmlChar * content);
00318 
00319 /*
00320  * DTD attribute list definition
00321  */
00322 XMLPUBFUN int XMLCALL
00323         xmlTextWriterStartDTDAttlist    (xmlTextWriterPtr writer,
00324                                          const xmlChar * name);
00325 #define xmlTextWriterEndDTDAttlist xmlTextWriterEndDTD
00326 
00327 /*
00328  * DTD attribute list definition conveniency functions
00329  */
00330 XMLPUBFUN int XMLCALL
00331         xmlTextWriterWriteFormatDTDAttlist(xmlTextWriterPtr writer,
00332                                          const xmlChar * name,
00333                                          const char *format, ...);
00334 XMLPUBFUN int XMLCALL
00335         xmlTextWriterWriteVFormatDTDAttlist(xmlTextWriterPtr writer,
00336                                          const xmlChar * name,
00337                                          const char *format,
00338                                          va_list argptr);
00339 XMLPUBFUN int XMLCALL
00340         xmlTextWriterWriteDTDAttlist    (xmlTextWriterPtr writer,
00341                                          const xmlChar * name,
00342                                          const xmlChar * content);
00343 
00344 /*
00345  * DTD entity definition
00346  */
00347 XMLPUBFUN int XMLCALL
00348         xmlTextWriterStartDTDEntity     (xmlTextWriterPtr writer,
00349                                          int pe,
00350                                          const xmlChar * name);
00351 #define xmlTextWriterEndDTDEntity xmlTextWriterEndDTD
00352 
00353 /*
00354  * DTD entity definition conveniency functions
00355  */
00356 XMLPUBFUN int XMLCALL
00357         xmlTextWriterWriteFormatDTDInternalEntity(xmlTextWriterPtr writer,
00358                                          int pe,
00359                                          const xmlChar * name,
00360                                          const char *format, ...);
00361 XMLPUBFUN int XMLCALL
00362         xmlTextWriterWriteVFormatDTDInternalEntity(xmlTextWriterPtr writer,
00363                                          int pe,
00364                                          const xmlChar * name,
00365                                          const char *format,
00366                                          va_list argptr);
00367 XMLPUBFUN int XMLCALL
00368         xmlTextWriterWriteDTDInternalEntity(xmlTextWriterPtr writer,
00369                                          int pe,
00370                                          const xmlChar * name,
00371                                          const xmlChar * content);
00372 XMLPUBFUN int XMLCALL
00373         xmlTextWriterWriteDTDExternalEntity(xmlTextWriterPtr writer,
00374                                          int pe,
00375                                          const xmlChar * name,
00376                                          const xmlChar * pubid,
00377                                          const xmlChar * sysid,
00378                                          const xmlChar * ndataid);
00379 XMLPUBFUN int XMLCALL
00380         xmlTextWriterWriteDTDEntity     (xmlTextWriterPtr writer,
00381                                          int pe,
00382                                          const xmlChar * name,
00383                                          const xmlChar * pubid,
00384                                          const xmlChar * sysid,
00385                                          const xmlChar * ndataid,
00386                                          const xmlChar * content);
00387 
00388 /*
00389  * DTD notation definition
00390  */
00391 XMLPUBFUN int XMLCALL
00392         xmlTextWriterWriteDTDNotation   (xmlTextWriterPtr writer,
00393                                          const xmlChar * name,
00394                                          const xmlChar * pubid,
00395                                          const xmlChar * sysid);
00396 
00397 /*
00398  * misc
00399  */
00400 XMLPUBFUN int XMLCALL
00401         xmlTextWriterFlush              (xmlTextWriterPtr writer);
00402 
00403 #ifdef __cplusplus
00404 }
00405 #endif
00406 #endif                          /* __XML_XMLWRITER_H__ */
00407 

Generated on Wed Mar 16 00:10:27 2005 for Dibbler - a portable DHCPv6 by  doxygen 1.3.9.1