665fa3eb417aaf7957371c45bed29491e1dab6a1
[alexxy/gromacs.git] / src / python / sip / topology / pstringlistwrapper.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 // This class is needed to transparently map 'atomname' and similar fields of struct t_atoms.
37 // Avoids copying and mapping entire array to python.
38
39 %ModuleHeaderCode
40 class PStringListWrapper {
41 public:
42     PStringListWrapper(char ***stringList, size_t size);
43     const char* operator[] (size_t i);
44 private:
45     char ***stringList;
46     size_t size;
47 };
48 %End
49
50 %ModuleCode
51 PStringListWrapper::PStringListWrapper(char ***stringList, size_t size) :
52     stringList(stringList), size(size)
53     {}
54 const char* PStringListWrapper::operator[] (size_t i) {
55     if (i >= size)
56         return NULL;
57     return *stringList[i];
58 }
59 %End
60
61 class PStringListWrapper /NoDefaultCtors/ {
62 public:
63     const char* operator[] (int i);
64     %MethodCode
65         sipRes = (*sipCpp)[a0];
66
67         if (!sipRes) {
68             SIP_BLOCK_THREADS;
69             PyErr_SetString(PyExc_IndexError, "Index out of range");
70             SIP_UNBLOCK_THREADS;
71             sipIsErr = 1;
72         }
73     %End
74 };