CMMLParser.h

Go to the documentation of this file.

//===========================================================================
//Copyright (C) 2004-2005 Zentaro Kavanagh
//
//Copyright (C) 2005 Commonwealth Scientific and Industrial Research
//   Organisation (CSIRO) Australia
//
//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 Zentaro Kavanagh nor the names of 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 ORGANISATION 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.
//===========================================================================

#pragma once


#include <libCMMLTags/libCMMLTags.h>
#include <libCMMLParse/libCMMLParse.h>
#include <libCMMLParse/xtag.h>
#include <libilliCore/StringHelper.h>

#include <fstream>
#include <string>

using namespace std;

// DLB. 21/9/2005. Allow parse error information to be sent back to caller
class LIBCMMLPARSE_API C_CMMLError
{
public:
        C_CMMLError()
        {
                // DLB. 20/9/2005. Clear the return ERROR info to start with
                this->LineNumber = 0;
        }

        void SetLineNumber(int lLineNumber)
        {
                LineNumber = lLineNumber;
        }

        int GetLineNumber()
        {
                return LineNumber;
        }

private:
        int   LineNumber;
};

class LIBCMMLPARSE_API CMMLParser
{
public:
        CMMLParser(void);
        ~CMMLParser(void);

        bool parseClipTag(wstring inClipText, C_ClipTag* outClip);

        bool parseHeadTag(wstring inHeadText, C_HeadTag* outHead);

        bool parseCMMLRootTag(wstring inCMMLRootText, C_CMMLRootTag* outCMMLRoot, C_CMMLError* outCMMLError=NULL);

        bool parseDocFromFile(wstring inFilename, C_CMMLDoc* outCMMLDoc, C_CMMLError* outCMMLError=NULL);

        bool parseDocFromBuffer(wstring inBuffer, C_CMMLDoc* outCMMLDoc, C_CMMLError* outCMMLError=NULL);

protected:
        bool parseRootTag(XTag* inCMMLRootParser, C_CMMLRootTag* outCMMLRoot);

        bool parseStreamTag(XTag* inStreamParser, C_StreamTag* outStream);

        bool parseHeadTag(XTag* inHeadParser, C_HeadTag* outHead);

        bool parseClipTag(XTag* inClipParser, C_ClipTag* outClip);

        bool parseImportTag(XTag* inImportParser, C_ImportTag* outImport);

        bool parseBaseTag(XTag* inBaseParser, C_BaseTag* outBase);

        bool parseTitleTag(XTag* inTitleParser, C_TitleTag* outTitle);

        bool parseMetaTag(XTag* inMetaParser, C_MetaTag* outMeta);

        bool parseAnchorTag(XTag* inAnchorParser, C_AnchorTag* outAnchor);

        bool parseImageTag(XTag* inImageParser, C_ImageTag* outImage);

        bool parseDescTag(XTag* inDescParser, C_DescTag* outDesc);

        bool parseParamTag(XTag* inParamParser, C_ParamTag* outParam);

};

---