/*****************************************************************************
*
* 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.
*
*****************************************************************************/

#ifndef AVT_PYTHON_FILTER_ENVIROMENT_H
#define AVT_PYTHON_FILTER_ENVIROMENT_H
#include <python_filters_exports.h>

#include <PythonInterpreter.h>
#include <avtPythonFilter.h>

#include <iostream>


// ****************************************************************************
//  Class:  avtPythonFilterEnvironment
//
//  Purpose:
//    Wraps shared logic for avt/python filter handshaking.
//
//  Programmer:  Cyrus Harrison
//  Creation:    Tue Feb  2 13:14:44 PST 2010
//
//  Modifications:
//   Cyrus Harrison, Fri Jul  9 10:31:03 PDT 2010
//   Use a singleton instance of the interpreter b/c python setup & teardown
//   does not work reliably w/ c modules that use static vars.
//
//   Cyrus Harrison,
//   Added pickle support.
//
// ****************************************************************************
class AVTPYTHON_FILTERS_API avtPythonFilterEnvironment
{
public:
                 avtPythonFilterEnvironment();
    virtual     ~avtPythonFilterEnvironment();

    bool         Initialize();
    bool         LoadFilter(const std::string &py_script);
    bool         FetchPythonError(std::string &msg_out);

    std::string  Pickle(PyObject *py_obj);
    PyObject    *Unpickle(const std::string &s);

    PyObject    *WrapVTKObject(void *obj,
                               const std::string &obj_type);

    void        *UnwrapVTKObject(PyObject *,
                                 const std::string &obj_type);

    PythonInterpreter  *Interpreter() { return pyi;}
    avtPythonFilter    *Filter() { return pyFilter;}

private:
    static void                PickleInit();

    static PythonInterpreter  *pyi;

    static bool                pickleReady;
    static PyObject           *pickleLoads;
    static PyObject           *pickleDumps;

    avtPythonFilter           *pyFilter;


};


#endif
