/*****************************************************************************
*
* Copyright (c) 2000 - 2018, 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.
*
*****************************************************************************/

// ************************************************************************* //
//                            avtADIOSFileFormat.C                           //
// ************************************************************************* //

#include <avtFileFormatInterface.h>
#include <DebugStream.h>
#include <VisItException.h>
#include <ADIOSFileObject.h>

#include "avtADIOSBasicFileFormat.h"
#include "avtXGCFileFormat.h"
//#include "avtPixieFileFormat.h"
#include "avtSpecFEMFileFormat.h"
#include "avtPIConGPUFileFormat.h"
#include "avtADIOSSchemaFileFormat.h"
//#include "avtLAMMPSFileFormat.h"
//#include "avtStagingFileFormat.h"

// ****************************************************************************
// Method: ADIOS_CreateFileFormatInterface
//
// Purpose:
//   Opens the first ADIOS file in the list and attempts to use the various
//   file formats to create a file format interface.
//
// Arguments:
//   list   : The list of filenames.
//   nList  : The number of filenames in the list.
//   nBlock : The number of files in a timestep.
//
// Returns:    A file format interface or 0 if no file format interface
//             was created.
//
// Programmer: Dave Pugmire
// Creation:   Wed Feb  3 13:10:35 EST 2010
//
// Modifications:
//
//  Dave Pugmire, Tue Mar  9 12:40:15 EST 2010
//  Added XGC reader.
//
//   Dave Pugmire, Wed Apr  9 13:39:04 EDT 2014
//   Added specFM and schema readers.
//
//   Dave Pugmire, Thu Oct 30 11:59:40 EDT 2014
//   Added a LAMMPS reader. Modified the flavor flag to an enum for clarity.
//
// ****************************************************************************

avtFileFormatInterface *
ADIOS_CreateFileFormatInterface(const char * const *list, int nList, int nBlock)
{
    avtFileFormatInterface *ffi = NULL;
    enum Flavor {XGC, PIXIE, SPECFEM, SCHEMA, BASIC, LAMMPS, STAGING, PICONGPU, FAIL};
    
    Flavor flavor = FAIL;
    if (list != NULL || nList > 0)
    {
        // Determine the type of reader that we want to use.
        TRY
        {
            /*
            if (avtStagingFileFormat::Identify(list[0]))
            {
                debug5<<"Database is avtStagingFileFormat"<<endl;
                cout<<"Database is avtStagingFileFormat"<<endl;
                flavor = STAGING;
            }
            */
            if (avtXGCFileFormat::Identify(list[0]))
            {
                debug5<<"Database is avtXGCFileFormat"<<endl;
                flavor = XGC;
            }
            /*
            else if (avtPixieFileFormat::Identify(list[0]))
            {
                debug5<<"Database is avtPixieFileFormat"<<endl;
                flavor = PIXIE;
            }
            */
            else if (avtSpecFEMFileFormat::Identify(list[0]))
            {
                debug5<<"Database is avtSpecFEMFileFormat"<<endl;
                flavor = SPECFEM;
            }
            else if (avtPIConGPUFileFormat::Identify(list[0]))
            {
                debug5<<"Database is avtPIConGPUFileFormat"<<endl;
                flavor = PICONGPU;
            }
            else if (avtADIOSSchemaFileFormat::Identify(list[0]))
            {
                debug5<<"Database is avtADIOSSchemaFileFormat"<<endl;
                flavor = SCHEMA;
            }
            /*
            else if (avtLAMMPSFileFormat::Identify(list[0]))
            {
                debug5<<"Database is avtLAMMPSFileFormat"<<endl;
                flavor = LAMMPS;
            }
            */
            else if (avtADIOSBasicFileFormat::Identify(list[0]))
            {
                debug5<<"Database is avtADIOSBasicFileFormat"<<endl;
                flavor = BASIC;
            }
        }
        CATCH(VisItException)
        {
            RETHROW;
        }
        ENDTRY
        
        switch(flavor)
        {

          case XGC:
            ffi = avtXGCFileFormat::CreateInterface(list, nList, nBlock);
            break;
            /*
          case PIXIE:
            ffi = avtPixieFileFormat::CreateInterface(list, nList, nBlock);
            break;
            */
          case SPECFEM:
            ffi = avtSpecFEMFileFormat::CreateInterface(list, nList, nBlock);
            break;
          case PICONGPU:
            ffi = avtPIConGPUFileFormat::CreateInterface(list, nList, nBlock);
            break;
          case SCHEMA:
            ffi = avtADIOSSchemaFileFormat::CreateInterface(list, nList, nBlock);
            break;
            /*
          case LAMMPS:
            ffi = avtLAMMPSFileFormat::CreateInterface(list, nList, nBlock);
            break;
            */
            /*
          case STAGING:
            ffi = avtStagingFileFormat::CreateInterface(list, nList, nBlock);
            break;
            */
          case BASIC:
            ffi = avtADIOSBasicFileFormat::CreateInterface(list, nList, nBlock);
            break;
          default:
            return NULL;
        }
            
    }

    return ffi;
}
