libopc/mce/textwriter.c

/*
 Copyright (c) 2010, Florian Reuter
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without 
 modification, are permitted provided that the following conditions 
 are met:
 
 * Redistributions of source code must retain the above copyright 
 notice, this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright 
 notice, this list of conditions and the following disclaimer in 
 the documentation and/or other materials provided with the 
 distribution.
 * Neither the name of Florian Reuter nor the names of its contributors 
 may be used to endorse or promote products derived from this 
 software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
 FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
 COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
 OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#include <mce/textwriter.h>

struct MCE_TEXTWRITER_STRUCT {
    xmlTextWriterPtr writer;
    puint32_t level;
    mceQNameLevelSet_t registered_set;
    mceQNameLevelSet_t processcontent_set;
    const xmlChar *ns_mce;
};


mceTextWriter *mceTextWriterCreateIO(xmlOutputWriteCallback iowrite, xmlOutputCloseCallback  ioclose, void *ioctx, xmlCharEncodingHandlerPtr encoder) {
    mceTextWriter *w=(mceTextWriter*)xmlMalloc(sizeof(mceTextWriter));
    if (NULL!=w) {
        memset(w, 0, sizeof(*w));
        xmlOutputBufferPtr out=xmlOutputBufferCreateIO(iowrite, ioclose, ioctx, encoder);
        w->writer=xmlNewTextWriter(out);
        if (NULL==w->writer) {
            // creation failed
            xmlOutputBufferClose(out);
            xmlFree(w);
            w=NULL;
        } else {
            // creation OK
            w->ns_mce=mceTextWriterRegisterNamespace(w, _X("http://schemas.openxmlformats.org/markup-compatibility/2006"), _X("mce"), 0);
            mceTextWriterRegisterNamespace(w, _X("http://www.w3.org/XML/1998/namespace"), _X("xml"), 0);
        }
    }
    return w;
}

int mceTextWriterFree(mceTextWriter *w) {
    int ret=0;
    if (NULL!=w) {
        xmlFreeTextWriter(w->writer);
        if (NULL!=w->registered_set.list_array) xmlFree(w->registered_set.list_array);
        if (NULL!=w->processcontent_set.list_array) xmlFree(w->processcontent_set.list_array);
        xmlFree(w);
        ret=1;
    }
    return ret;
}

int mceTextWriterStartDocument(mceTextWriter *w) {
    int ret=0;
    ret=xmlTextWriterStartDocument(w->writer, NULL, NULL, NULL);
    PASSERT(0==w->level);
    return ret;
}

int mceTextWriterEndDocument(mceTextWriter *w) {
    int ret=0;
    PASSERT(0==w->level);
    mceQNameLevelCleanup(&w->registered_set, w->level);
    ret=xmlTextWriterEndDocument(w->writer);
    return ret;
}

int mceTextWriterStartElement(mceTextWriter *w, const xmlChar *ns, const xmlChar *ln) {
    int ret=0;
    PASSERT(w->level>=w->registered_set.max_level);
    mceQNameLevel_t* qName=mceQNameLevelLookup(&w->registered_set, ns, NULL, PTRUE);
    if (NULL!=qName) {
        if (NULL==qName->ln) {
            ret=xmlTextWriterStartElement(w->writer, ln);
        } else {
            ret=xmlTextWriterStartElementNS(w->writer, qName->ln, ln, (w->level==w->registered_set.max_level?ns:NULL));
        }
        if (w->level==w->registered_set.max_level) {
            // register new namespaces
            puint32_t ignorables=0;
            for(puint32_t i=0;i<w->registered_set.list_items;i++) {
                if (w->registered_set.list_array[i].level==w->level) {
                    if ((w->registered_set.list_array[i].flag&MCE_IGNORABLE)==MCE_IGNORABLE) {
                        ignorables++;
                    }
                    if (w->registered_set.list_array[i].ns!=qName->ns) {
                        if (!(w->registered_set.list_array[i].ln[0]=='x' 
                           && w->registered_set.list_array[i].ln[1]=='m' 
                           && w->registered_set.list_array[i].ln[2]=='l' 
                           && w->registered_set.list_array[i].ln[3]==0)) {
                            xmlTextWriterWriteAttributeNS(w->writer, 
                                                          _X("xmlns"), 
                                                          w->registered_set.list_array[i].ln, 
                                                          NULL, 
                                                          w->registered_set.list_array[i].ns);
                        }
                    }
                }
            }
            if (ignorables>0) {
                mceQNameLevel_t* mceQName=mceQNameLevelLookup(&w->registered_set, w->ns_mce, NULL, PTRUE);
                PASSERT(NULL!=mceQName);
                if (NULL!=mceQName) {
                    xmlTextWriterStartAttributeNS(w->writer,
                                                  mceQName->ln,
                                                  _X("Ignorable"),
                                                  NULL);
                    puint32_t j=0;
                    for(puint32_t i=0;i<w->registered_set.list_items;i++) {
                        if (w->registered_set.list_array[i].level==w->level && MCE_IGNORABLE==(w->registered_set.list_array[i].flag&MCE_IGNORABLE)) {
                            xmlTextWriterWriteString(w->writer, w->registered_set.list_array[i].ln);
                            if (++j<ignorables) {
                                xmlTextWriterWriteString(w->writer, _X(" "));
                            }
                        }
                    }
                    PASSERT(j==ignorables);
                    xmlTextWriterEndAttribute(w->writer);
                }
            }
        }
        if (w->level==w->processcontent_set.max_level) {
            // write process content attribute
            puint32_t v_len=0;
            xmlChar *v=NULL;
            for(puint32_t i=0;i<w->processcontent_set.list_items;i++) {
                if (w->processcontent_set.list_array[i].level==w->level) {
                    mceQNameLevel_t* qName=mceQNameLevelLookup(&w->registered_set, w->processcontent_set.list_array[i].ns, NULL, PTRUE);
                    PASSERT(NULL!=qName); // namespace not registered?
                    if (NULL!=qName) {
                        puint32_t len=(v_len>0?xmlStrlen(_X(" ")):0)+xmlStrlen(qName->ln)+xmlStrlen(_X(":"))+xmlStrlen(w->processcontent_set.list_array[i].ln)+1;
                        v=(xmlChar *)xmlRealloc(v, v_len+len);
                        if (v_len>0) { v[v_len++]=' '; len--; }
                        int l=xmlStrPrintf(v+v_len, len, _X("%s:%s"), qName->ln, w->processcontent_set.list_array[i].ln);
                        PASSERT(1+l==len); // cause by terminating "0"
                        v_len+=l;
                    }
                }
            }
            if (NULL!=v) {
                mceQNameLevel_t* mceQName=mceQNameLevelLookup(&w->registered_set, w->ns_mce, NULL, PTRUE);
                PASSERT(NULL!=mceQName);
                if (NULL!=mceQName) {
                    xmlTextWriterWriteAttributeNS(w->writer, mceQName->ln, _X("ProcessContent"), NULL, v);
                }
                xmlFree(v); v=NULL;
            }
        }
    } else {
        // namespace not registered => not good!
        PASSERT(0==ret);
    }
    w->level++;
    return ret;
}

int mceTextWriterEndElement(mceTextWriter *w, const xmlChar *ns, const xmlChar *ln) {
    int ret=0;
    ret=xmlTextWriterEndElement(w->writer);
    mceQNameLevelCleanup(&w->registered_set, w->level);
    mceQNameLevelCleanup(&w->processcontent_set, w->level);
    PASSERT(w->level>0);
    w->level--;
    return ret;
}

int mceTextWriterWriteString(mceTextWriter *w, const xmlChar *content) {
    int ret=0;
    ret=xmlTextWriterWriteString(w->writer, content);
    return ret;
}

const xmlChar *mceTextWriterRegisterNamespace(mceTextWriter *w, const xmlChar *ns, const xmlChar *prefix, int flags) {
    mceQNameLevelAdd(&w->registered_set, ns, prefix, w->level);
    mceQNameLevel_t *ret=mceQNameLevelLookup(&w->registered_set, ns, prefix, PFALSE);
    PASSERT(NULL!=ret); // not inserted? why?
    if (NULL!=ret) {
        ret->flag=flags;
        return ret->ns;
    } else {
        return NULL;
    }
}

int mceTextWriterProcessContent(mceTextWriter *w, const xmlChar *ns, const xmlChar *ln) {
    return mceQNameLevelAdd(&w->processcontent_set, ns, ln, w->level)?0:-1;
}

int mceTextWriterAttributeF(mceTextWriter *w, const xmlChar *ns, const xmlChar *ln, const char *value, ...) {
    va_list args;
    int ret=0;
    va_start(args, value); 
    PASSERT(w->level>=w->registered_set.max_level);
    mceQNameLevel_t* qName=mceQNameLevelLookup(&w->registered_set, ns, NULL, PTRUE);
    if (NULL!=qName) {
        if (NULL==qName->ln) {
            ret=xmlTextWriterWriteVFormatAttribute(w->writer, ln, value, args);
        } else {
            ret=xmlTextWriterWriteVFormatAttributeNS(w->writer, qName->ln, ln, NULL, value, args);
        }
    } else {
        PASSERT(0); // hmm namespace not registered?
    }
    va_end(args);
    return ret;
}

int mceTextWriterStartAlternateContent(mceTextWriter *w) {
    return xmlTextWriterStartElementNS(w->writer, _X("mce"), _X("AlternateContent"), NULL);
}

int mceTextWriterEndAlternateContent(mceTextWriter *w) {
    return xmlTextWriterEndElement(w->writer);
}

int mceTextWriterStartChoice(mceTextWriter *w, const xmlChar *ns) {
    int ret=xmlTextWriterStartElementNS(w->writer, _X("mce"), _X("Choice"), NULL);
    if (-1!=ret) {
        mceQNameLevel_t* qName=mceQNameLevelLookup(&w->registered_set, ns, NULL, PTRUE);
        if (NULL!=qName) {
            xmlTextWriterWriteAttribute(w->writer, _X("Requires"), qName->ln);
        } else {
            PASSERT(0); // namespace not registered
            ret=-1;
        }
    }
    return ret;
}

int mceTextWriterEndChoice(mceTextWriter *w) {
    return xmlTextWriterEndElement(w->writer);
}

int mceTextWriterStartFallback(mceTextWriter *w) {
    return xmlTextWriterStartElementNS(w->writer, _X("mce"), _X("AlternateContent"), NULL);
}

int mceTextWriterEndFallback(mceTextWriter *w) {
    return xmlTextWriterEndElement(w->writer);
}


static int  xmlOutputWrite(void * context, const char * buffer, int len) {
    FILE *out=(FILE*)context;
    return fwrite(buffer, sizeof(char), len, out);
}

static int xmlOutputClose(void * context) {
    return 0;
}

xmlTextWriterPtr xmlNewTextWriterFile(FILE *file) {
    xmlTextWriter *writer=NULL;
    if (NULL!=file) {
        xmlOutputBuffer *out=xmlOutputBufferCreateIO(xmlOutputWrite, xmlOutputClose, file, NULL);
        if (NULL!=out) {
            writer=xmlNewTextWriter(out);
        }
    } else {
        xmlOutputBuffer *out=xmlOutputBufferCreateIO(xmlOutputWrite, xmlOutputClose, stdout, NULL);
        if (NULL!=out) {
            writer=xmlNewTextWriter(out);
        }
    }
    return writer;
}

mceTextWriter *mceNewTextWriterFile(FILE *file) {
    return mceTextWriterCreateIO(xmlOutputWrite, xmlOutputClose, file, NULL);
}

xmlTextWriterPtr mceTextWriterIntern(mceTextWriter *w) {
    return w->writer;
}