PyParser.cpp

Go to the documentation of this file.

//
// Python API for Parser
//
// Copyright (c) 2023, Chris Rogers, STFC Rutherford Appleton Laboratory, Didcot, UK
//
// This file is part of OPAL.
//
// OPAL is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// You should have received a copy of the GNU General Public License
// along with OPAL.  If not, see <https://www.gnu.org/licenses/>.
//

#include <sstream>
#include <string>
#include <boost/python.hpp>

#include "AbstractObjects/OpalData.h"
#include "PyOpal/PyCore/ExceptionTranslation.h"
// this define statement tells Main not to define the global gmsg and ippl
// objects; they should be defined in Globals
#define DONT_DEFINE_IPPL_GMSG 1
#include "PyOpal/PyCore/Globals.h"
#include "Main.cpp"

namespace PyOpal {
namespace PyParser {

std::string initialise_from_opal_file_docstring = 
"Initialise from opal file\n"
"- file_name: string corresponding to the file name of the OPAL\n"
"  file.\n"
"Note that if file_name is not valid, OPAL may terminate the python script\n"
"execution abnormally (without the usual python exit semantics).\n"
"\n"
"Returns an integer; 0 for successful execution or non-zero if an error\n"
"occurred.\n";

int initialise_from_opal_file(std::string file_name) {
    std::string exe("parser");
    char* argvr[3];
    // argv must be nullptr terminated array
    argvr[0] = exe.data();
    argvr[1] = file_name.data();
    argvr[2] = nullptr;
    int error_code = opalMain(2, argvr);
    return error_code;
}

std::string list_objects_docstring = 
"List the objects that are known by the Opal parser, either through calls to\n"
"initialise_from_opal_file or through calls directly to the python API\n"
"\n"
"Returns a list of strings, each one corresponding to the name of a\n"
"particular object\n";

boost::python::list list_objects() {
    std::vector<std::string> names = OpalData::getInstance()->getAllNames();
    boost::python::list pynames;
    for (size_t i = 0; i < names.size(); ++i) {
        pynames.append(names[i]);
    } 
    return pynames;
}


std::string module_docstring =
"The parser module is used to load an OPAL input file from within python";

BOOST_PYTHON_MODULE(parser) {
    PyOpal::ExceptionTranslation::registerExceptions();
    PyOpal::Globals::Initialise();
    boost::python::scope().attr("__doc__") = module_docstring.c_str();
    boost::python::def("initialise_from_opal_file",
            initialise_from_opal_file,
            boost::python::args("file_name"),
            initialise_from_opal_file_docstring.c_str()
    );
    boost::python::def("list_objects",
            list_objects,
            list_objects_docstring.c_str()
    );
}

} // namespace PyParser
} // namespace PyOpal