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/options/filenameoption.h"
  40 #include "gromacs/selection/selectionoption.h"
  41 #include <map>
  42 #include <string>
  43
  44 class PyOptionsHolder {
  45 public:
  46     class DuplicateOption : public std::exception {
  47     public:
  48         virtual const char* what() const noexcept;
  49     };
  50     gmx::DoubleOption doubleOption(const char*, double = 0);
  51     gmx::IntegerOption integerOption(const char*, int = 0);
  52     gmx::StringOption stringOption(const char*, const char* = 0);
  53     gmx::BooleanOption booleanOption(const char*, bool = 0);
  54     gmx::SelectionOption selectionOption(const char*);
  55     gmx::FileNameOption fileNameOption(const char*, const char* = 0);
  56     PyObject* get_value(const char*);
  57     ~PyOptionsHolder();
  58     // TODO: support for vector options
  59 private:
  60     struct option_value {
  61         void *value;
  62         const char *type;
  63     };
  64     std::map<std::string, option_value> storage;
  65 };
  66 %End
  67
  68 %ModuleCode
  69 #include "gromacs/utility/gmxassert.h"
  70
  71 const char* PyOptionsHolder::DuplicateOption::what() const noexcept {
  72     return "This option is already defined";
  73 }
  74
  75 gmx::DoubleOption PyOptionsHolder::doubleOption(const char *name, double def) {
  76     if (storage.count(name))
  77         throw DuplicateOption();
  78
  79     double *store = new double;
  80     *store = def;
  81     gmx::DoubleOption option(name);
  82     option.store(store);
  83     storage[name] = {store, "d"};
  84
  85     return option;
  86 }
  87
  88 gmx::IntegerOption PyOptionsHolder::integerOption(const char *name, int def) {
  89     if (storage.count(name))
  90         throw DuplicateOption();
  91
  92     int *store = new int;
  93     *store = def;
  94     gmx::IntegerOption option(name);
  95     option.store(store);
  96     storage[name] = {store, "i"};
  97
  98     return option;
  99 }
 100
 101 gmx::StringOption PyOptionsHolder::stringOption(const char *name, const char* def) {
 102     if (storage.count(name))
 103         throw DuplicateOption();
 104
 105     std::string *store = new std::string;
 106     *store = def;
 107     gmx::StringOption option(name);
 108     option.store(store);
 109     storage[name] = {store, "s"};
 110
 111     return option;
 112 }
 113
 114 gmx::BooleanOption PyOptionsHolder::booleanOption(const char *name, bool def) {
 115     if (storage.count(name))
 116         throw DuplicateOption();
 117
 118     bool *store = new bool;
 119     *store = def;
 120     gmx::BooleanOption option(name);
 121     option.store(store);
 122     storage[name] = {store, "b"};
 123
 124     return option;
 125 }
 126
 127 gmx::SelectionOption PyOptionsHolder::selectionOption(const char *name) {
 128     if (storage.count(name))
 129         throw DuplicateOption();
 130
 131     gmx::Selection *store = new gmx::Selection;
 132     gmx::SelectionOption option(name);
 133     option.store(store);
 134
 135     storage[name] = {store, "S"};
 136
 137     return option;
 138 }
 139
 140 gmx::FileNameOption PyOptionsHolder::fileNameOption(const char *name, const char* def) {
 141     if (storage.count(name))
 142         throw DuplicateOption();
 143
 144     std::string *store = new std::string;
 145     gmx::FileNameOption option(name);
 146     option.store(store);
 147     option.defaultBasename(def); // Docs say to set default value like this
 148     storage[name] = {store, "f"};
 149
 150     return option;
 151 }
 152
 153 PyObject* PyOptionsHolder::get_value(const char *name) {
 154     if (!storage.count(name))
 155         return NULL;
 156
 157     option_value v = storage[name];
 158     switch (*v.type) {
 159     case 'd': // double
 160         return sipBuildResult(NULL, v.type, *((double*) v.value));
 161         break;
 162     case 'i': // int
 163         return sipBuildResult(NULL, v.type, *((int*) v.value));
 164         break;
 165     case 's': // std::string
 166         return sipBuildResult(NULL, v.type, ((std::string*) v.value)->data());
 167         break;
 168     case 'b': // bool
 169         return sipBuildResult(NULL, v.type, *((bool*) v.value));
 170         break;
 171     case 'S': // Selection
 172         return sipConvertFromType((gmx::Selection*) v.value, sipType_Selection, NULL);
 173         break;
 174     case 'f': // FileNameOption
 175         return sipBuildResult(NULL, "A", ((std::string*) v.value)->data());
 176         break;
 177     }
 178
 179     GMX_ASSERT(false, "Some type is not handled in PyOptionsHolder.get_value");
 180     return NULL;
 181 }
 182
 183 PyOptionsHolder::~PyOptionsHolder() {
 184     for (auto e : storage)
 185         switch (*e.second.type) {
 186             case 'd': // double
 187                 delete (double*) e.second.value;
 188                 break;
 189             case 'i': // int
 190                 delete (int*) e.second.value;
 191                 break;
 192             case 's': // std::string
 193             case 'f': // FileNameOption (the storage type is still std::string)
 194                 delete (std::string*) e.second.value;
 195                 break;
 196             case 'b': // bool
 197                 delete (bool*) e.second.value;
 198                 break;
 199             case 'S': // Selection
 200                 delete (gmx::Selection*) e.second.value;
 201                 break;
 202         }
 203 }
 204 %End
 205
 206 %Exception PyOptionsHolder::DuplicateOption {
 207 %RaiseCode
 208         SIP_BLOCK_THREADS;
 209         PyErr_SetString(PyExc_ValueError, sipExceptionRef.what());
 210         SIP_UNBLOCK_THREADS;
 211 %End
 212 };
 213
 214 class PyOptionsHolder {
 215 %TypeHeaderCode
 216 #include "gromacs/options/basicoptions.h"
 217 %End
 218
 219 public:
 220     DoubleOption doubleOption(const char *name, double def = 0) throw (PyOptionsHolder::DuplicateOption);
 221     IntegerOption integerOption(const char *name, int def = 0) throw (PyOptionsHolder::DuplicateOption);
 222     StringOption stringOption(const char *name, const char *def = 0) throw (PyOptionsHolder::DuplicateOption);
 223     BooleanOption booleanOption(const char *name, bool def = 0) throw (PyOptionsHolder::DuplicateOption);
 224     SelectionOption selectionOption(const char *name) throw (PyOptionsHolder::DuplicateOption);
 225     FileNameOption fileNameOption(const char *name, const char *def = 0) throw (PyOptionsHolder::DuplicateOption);
 226     SIP_PYOBJECT __getitem__(const char *name);
 227     %MethodCode
 228         sipRes = sipCpp->get_value(a0);
 229
 230         if (!sipRes) {
 231             SIP_BLOCK_THREADS;
 232             PyErr_SetString(PyExc_KeyError, "Invalid option name");
 233             SIP_UNBLOCK_THREADS;
 234             sipIsErr = 1;
 235         }
 236     %End
 237 };