Merge branch 'master' into pygromacs
[alexxy/gromacs.git] / src / python / sip / trajectoryanalysis / TrajectoryAnalysis.sip
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2014, by the GROMACS development team, led by
5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6  * and including many others, as listed in the AUTHORS file in the
7  * top-level source directory and at http://www.gromacs.org.
8  *
9  * GROMACS is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public License
11  * as published by the Free Software Foundation; either version 2.1
12  * of the License, or (at your option) any later version.
13  *
14  * GROMACS is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with GROMACS; if not, see
21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
23  *
24  * If you want to redistribute modifications to GROMACS, please
25  * consider that scientific software is very special. Version
26  * control is crucial - bugs must be traceable. We will be happy to
27  * consider code for inclusion in the official distribution, but
28  * derived work must not be called official GROMACS. Details are found
29  * in the README & COPYING files - if they are missing, get the
30  * official version at http://www.gromacs.org.
31  *
32  * To help us fund GROMACS development, we humbly ask that you cite
33  * the research papers on the package. Check out http://www.gromacs.org.
34  */
35
36 %Module gromacs.TrajectoryAnalysis
37
38 %DefaultEncoding "UTF-8"
39
40 %Import options/Options.sip
41 %Import topology/Topology.sip
42
43 %Include definitions.sip
44
45 %Include analysissettings.sip
46 %Include analysismodule.sip
47
48 %ModuleCode
49 #include "gromacs/trajectoryanalysis/analysismodule.h"
50 #include "gromacs/trajectoryanalysis/cmdlinerunner.h"
51 #include "gromacs/utility/exceptions.h"
52
53 class PyFactory : public gmx::TrajectoryAnalysisCommandLineRunner::ModuleFactoryFunctor {
54 public:
55     PyFactory(PyObject *mod) : mod(mod) {} ;
56     gmx::TrajectoryAnalysisModulePointer operator () () {
57         int iserr = 0;
58         int can = sipCanConvertToType(mod, sipType_TrajectoryAnalysisModule, 0);
59         // TODO: throw if can't
60         gmx::TrajectoryAnalysisModule *module = (gmx::TrajectoryAnalysisModule*) sipConvertToType(
61             mod, sipType_TrajectoryAnalysisModule, NULL, 0, NULL, &iserr);
62         return TrajectoryAnalysisModulePointer(module);
63     }
64 private:
65     PyObject *mod;
66 };
67
68 void runAsMain(PyObject *mod, PyObject *py_argv) {
69     int argc = PyList_GET_SIZE(py_argv);
70
71     char **argv = new char *[argc + 1];
72     bool to_free[argc];
73     std::fill(to_free, to_free+argc, false);
74
75     // Convert the list.
76     // TODO: Use something better than AsLatin1String to avoid unicode errors
77     for (int a = 0; a < argc; ++a)
78     {
79         PyObject *arg_obj = PyList_GET_ITEM(py_argv, a);
80         const char *arg = sipString_AsLatin1String(&arg_obj);
81
82         if (arg)
83         {
84             arg = strdup(arg);
85             Py_DECREF(arg_obj);
86             to_free[a] = true;
87         }
88         else
89         {
90             arg = "unknown";
91         }
92
93         argv[a] = const_cast<char *>(arg);
94     }
95
96     argv[argc] = NULL;
97
98     PyFactory factory(mod);
99     TrajectoryAnalysisCommandLineRunner::runAsMain(argc, argv, &factory);
100
101     for (int i = 0; i < argc; i++)
102         if (to_free[i])
103             free(argv[i]);
104     delete[] argv;
105 }
106
107 %End
108
109 void runAsMain(SIP_PYOBJECT mod, SIP_PYLIST argv);