src/python/sip/options/pyoptionsholder.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 %ModuleHeaderCode
  37 #include <exception>
  38 #include "gromacs/options/basicoptions.h"
  39 #include "gromacs/selection/selectionoption.h"
  40 #include <map>
  41 #include <string>
  42
  43 class PyOptionsHolder {
  44 public:
  45     class DuplicateOption : public std::exception {
  46     public:
  47         virtual const char* what() const noexcept;
  48     };
  49     gmx::DoubleOption doubleOption(const char*, double = 0);
  50     gmx::IntegerOption integerOption(const char*, int = 0);
  51     gmx::StringOption stringOption(const char*, const char* = 0);
  52     gmx::BooleanOption booleanOption(const char*, bool = 0);
  53     gmx::SelectionOption selectionOption(const char*);
  54     PyObject* get_value(const char*);
  55     // TODO: destructor (need to handle each type separately)
  56     // TODO: support for vector options
  57 private:
  58     struct option_value {
  59         void *value;
  60         const char *type;
  61     };
  62     std::map<std::string, option_value> storage;
  63 };
  64 %End
  65
  66 %ModuleCode
  67 #include "gromacs/utility/gmxassert.h"
  68
  69 const char* PyOptionsHolder::DuplicateOption::what() const noexcept {
  70     return "This option is already defined";
  71 }
  72
  73 gmx::DoubleOption PyOptionsHolder::doubleOption(const char *name, double def) {
  74     if (storage.count(name))
  75         throw DuplicateOption();
  76
  77     double *store = new double;
  78     *store = def;
  79     gmx::DoubleOption option(name);
  80     option.store(store);
  81     storage[name] = {store, "d"};
  82
  83     return option;
  84 }
  85
  86 gmx::IntegerOption PyOptionsHolder::integerOption(const char *name, int def) {
  87     if (storage.count(name))
  88         throw DuplicateOption();
  89
  90     int *store = new int;
  91     *store = def;
  92     gmx::IntegerOption option(name);
  93     option.store(store);
  94     storage[name] = {store, "i"};
  95
  96     return option;
  97 }
  98
  99 gmx::StringOption PyOptionsHolder::stringOption(const char *name, const char* def) {
 100     if (storage.count(name))
 101         throw DuplicateOption();
 102
 103     std::string *store = new std::string;
 104     *store = def;
 105     gmx::StringOption option(name);
 106     option.store(store);
 107     storage[name] = {store, "s"};
 108
 109     return option;
 110 }
 111
 112 gmx::BooleanOption PyOptionsHolder::booleanOption(const char *name, bool def) {
 113     if (storage.count(name))
 114         throw DuplicateOption();
 115
 116     bool *store = new bool;
 117     *store = def;
 118     gmx::BooleanOption option(name);
 119     option.store(store);
 120     storage[name] = {store, "b"};
 121
 122     return option;
 123 }
 124
 125 gmx::SelectionOption PyOptionsHolder::selectionOption(const char *name) {
 126     if (storage.count(name))
 127         throw DuplicateOption();
 128
 129     gmx::Selection *store = new gmx::Selection;
 130     gmx::SelectionOption option(name);
 131     option.store(store);
 132
 133     storage[name] = {store, "S"};
 134
 135     return option;
 136 }
 137
 138 PyObject* PyOptionsHolder::get_value(const char *name) {
 139     if (!storage.count(name))
 140         return NULL;
 141
 142     option_value v = storage[name];
 143     switch (*v.type) {
 144     case 'd': // double
 145         return sipBuildResult(NULL, v.type, *((double*) v.value));
 146         break;
 147     case 'i': // int
 148         return sipBuildResult(NULL, v.type, *((int*) v.value));
 149         break;
 150     case 's': // std::string
 151         return sipBuildResult(NULL, v.type, ((std::string*) v.value)->data());
 152         break;
 153     case 'b': // bool
 154         return sipBuildResult(NULL, v.type, *((bool*) v.value));
 155         break;
 156     case 'S': // Selection
 157         return sipConvertFromType((gmx::Selection*) v.value, sipType_Selection, NULL);
 158         break;
 159     }
 160
 161     GMX_ASSERT(false, "Some type is not handled in PyOptionsHolder.get_value");
 162     return NULL;
 163 }
 164 %End
 165
 166 %Exception PyOptionsHolder::DuplicateOption {
 167 %RaiseCode
 168         SIP_BLOCK_THREADS;
 169         PyErr_SetString(PyExc_ValueError, sipExceptionRef.what());
 170         SIP_UNBLOCK_THREADS;
 171 %End
 172 };
 173
 174 class PyOptionsHolder {
 175 %TypeHeaderCode
 176 #include "gromacs/options/basicoptions.h"
 177 %End
 178
 179 public:
 180     DoubleOption doubleOption(const char *name, double def = 0) throw (PyOptionsHolder::DuplicateOption);
 181     IntegerOption integerOption(const char *name, int def = 0) throw (PyOptionsHolder::DuplicateOption);
 182     StringOption stringOption(const char *name, const char *def = 0) throw (PyOptionsHolder::DuplicateOption);
 183     BooleanOption booleanOption(const char *name, bool def = 0) throw (PyOptionsHolder::DuplicateOption);
 184     SelectionOption selectionOption(const char *name) throw (PyOptionsHolder::DuplicateOption);
 185     SIP_PYOBJECT __getitem__(const char *name);
 186     %MethodCode
 187         sipRes = sipCpp->get_value(a0);
 188
 189         if (!sipRes) {
 190             SIP_BLOCK_THREADS;
 191             PyErr_SetString(PyExc_KeyError, "Invalid option name");
 192             SIP_UNBLOCK_THREADS;
 193             sipIsErr = 1;
 194         }
 195     %End
 196 };