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 <map>
  40 #include <string>
  41
  42 class PyOptionsHolder {
  43 public:
  44     class DuplicateOption : public std::exception {
  45     public:
  46         virtual const char* what() const noexcept;
  47     };
  48     gmx::DoubleOption doubleOption(const char*, double = 0);
  49     PyObject* get_value(const char*);
  50     // TODO: destructor (need to handle each type separately)
  51     // TODO: support for vector options
  52 private:
  53     struct option_value {
  54         void *value;
  55         const char *type;
  56     };
  57     std::map<std::string, option_value> storage;
  58 };
  59 %End
  60
  61 %ModuleCode
  62 #include "gromacs/utility/gmxassert.h"
  63
  64 const char* PyOptionsHolder::DuplicateOption::what() const noexcept {
  65     return "This option is already defined";
  66 }
  67
  68 gmx::DoubleOption PyOptionsHolder::doubleOption(const char *name, double def) {
  69     if (storage.count(name))
  70         throw DuplicateOption();
  71
  72     double *store = new double;
  73     *store = def;
  74     gmx::DoubleOption option(name);
  75     option.store(store);
  76     storage[name] = {store, "d"};
  77
  78     return option;
  79 }
  80
  81 PyObject* PyOptionsHolder::get_value(const char *name) {
  82     if (!storage.count(name))
  83         return NULL;
  84
  85     option_value v = storage[name];
  86     switch (*v.type) {
  87     case 'd':
  88         return sipBuildResult(NULL, v.type, *((double*) v.value));
  89         break;
  90     }
  91
  92     GMX_ASSERT(false, "Some type is not handled in PyOptionsHolder.get_value");
  93     return NULL;
  94 }
  95 %End
  96
  97 %Exception PyOptionsHolder::DuplicateOption {
  98 %RaiseCode
  99         SIP_BLOCK_THREADS;
 100         PyErr_SetString(PyExc_ValueError, sipExceptionRef.what());
 101         SIP_UNBLOCK_THREADS;
 102 %End
 103 };
 104
 105 class PyOptionsHolder {
 106 %TypeHeaderCode
 107 #include "gromacs/options/basicoptions.h"
 108 %End
 109
 110 public:
 111     DoubleOption doubleOption(const char *name, double def = 0) throw (PyOptionsHolder::DuplicateOption);
 112     SIP_PYOBJECT __getitem__(const char *name);
 113     %MethodCode
 114         sipRes = sipCpp->get_value(a0);
 115
 116         if (!sipRes) {
 117             SIP_BLOCK_THREADS;
 118             PyErr_SetString(PyExc_KeyError, "Invalid option name");
 119             SIP_UNBLOCK_THREADS;
 120             sipIsErr = 1;
 121         }
 122     %End
 123 };