/*****************************************************************************
*
* Copyright (c) 2000 - 2017, Lawrence Livermore National Security, LLC
* Produced at the Lawrence Livermore National Laboratory
* LLNL-CODE-442911
* All rights reserved.
*
* This file is  part of VisIt. For  details, see https://visit.llnl.gov/.  The
* full copyright notice is contained in the file COPYRIGHT located at the root
* of the VisIt distribution or at http://www.llnl.gov/visit/copyright.html.
*
* 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 disclaimer below.
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this  list of  conditions  and  the  disclaimer (as noted below)  in  the
*    documentation and/or other materials provided with the distribution.
*  - Neither the name of  the LLNS/LLNL 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 LAWRENCE  LIVERMORE NATIONAL  SECURITY,
* LLC, THE  U.S.  DEPARTMENT OF  ENERGY  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.
*
*****************************************************************************/

// ************************************************************************* //
//                                XDMFParser.h                               //
// ************************************************************************* //

#ifndef XDMF_PARSER_H
#define XDMF_PARSER_H

#include <stdio.h>

// ****************************************************************************
//  Class: avtXDMFFileFormat
//
//  Purpose:
//      Reads in XDMF files as a plugin to VisIt.
//
//  Programmer: Eric Brugger
//  Creation:   Wed Nov 14 11:28:35 PDT 2007
//
//  Modifications:
//    Eric Brugger, Fri Apr 24 08:18:22 PDT 2009
//    I added the method GetAttributeValueAsUpper.
//
// ****************************************************************************

class XDMFParser
{
  public:
                       XDMFParser();
    virtual           ~XDMFParser();

    enum               ElementType {TYPE_PI, TYPE_COMMENT, TYPE_SPECIAL,
                                    TYPE_START_TAG, TYPE_END_TAG, TYPE_CDATA,
                                    TYPE_EOF, TYPE_ERROR};

    void               SetInputFileName(const char *);

    ElementType        GetNextElement();
    const char        *GetElementName() const;
    void               SkipToEndTag();

    bool               GetNextAttribute();
    const char        *GetAttributeName() const;
    const char        *GetAttributeValue() const;
    const char        *GetAttributeValueAsUpper();

    int                GetCDataOffset() const;
    int                GetCDataLength() const;
    const char        *GetCDataValue() const;

    void               PrintFile();

  private:
    void               UnGetChar();
    void               UnGetChar(const char &);
    char              *GetChar();

    char              *fname;

    FILE              *file;

    char               nullChar[8];

    int                offset;
    int                ibuf;
    int                lbuf;
    bool               endOfFile;
    char              *buffer;

    // Return value for GetElementName.
    char               elementName[1024];

    // Return values for GetAttributeName and GetAttributeValue.
    char               attributeName[1024];
    char               attributeValue[1024];

    // Return values for GetCDataOffset, GetCDataLength, and GetCDataValue.
    int                cdataOffset;
    int                cdataLength;
    char               cdataValue[1024];
};

#endif
