src/gromacs/selection/selparam.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \file
  32  * \brief API for handling parameters used in selections.
  33  *
  34  * There should be no need to use the data structures or call the
  35  * functions in this file directly unless implementing a custom selection
  36  * method.
  37  *
  38  * More details can be found on the page discussing
  39  * \ref page_module_selection_custom "custom selection methods".
  40  *
  41  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  42  * \ingroup module_selection
  43  */
  44 #ifndef GMX_SELECTION_SELPARAM_H
  45 #define GMX_SELECTION_SELPARAM_H
  46
  47 #include "indexutil.h"
  48 #include "selvalue.h"
  49
  50 /*! \name Parameter flags
  51  * \anchor selparam_flags
  52  */
  53 /*@{*/
  54 /*! \brief
  55  * This flag is set if the user has provided the parameter.
  56  *
  57  * This flag is set automatically, and should not be set by the user.
  58  */
  59 #define SPAR_SET      1
  60 /*! \brief
  61  * If not set, an error is reported if the parameter is not specified by the
  62  * user.
  63  */
  64 #define SPAR_OPTIONAL 2
  65 /*! \brief
  66  * If set, the parameter value can be dynamic, i.e., be different for
  67  * different frames.
  68  *
  69  * If set, the parameter value should only be accessed in the update function
  70  * of \c gmx_ana_selmethod_t.
  71  * The flag is cleared before sel_initfunc() if the value provided is actually
  72  * static.
  73  */
  74 #define SPAR_DYNAMIC  4
  75 /*! \brief
  76  * If set, the parameter value is parsed into sorted ranges.
  77  *
  78  * Can only be specified for integer parameters.
  79  * If specified, the value of the parameter (\c gmx_ana_selparam_t::val)
  80  * consists of sets of two integers, each specifying a range.
  81  * The values give the endpoints of the ranges (inclusive).
  82  * The ranges are sorted and overlapping/continuous ranges are merged into
  83  * a single range to minimize the number of ranges.
  84  *
  85  * If this flag is specified, \c gmx_ana_selparam_t::nval gives the number of
  86  * ranges. \p gmx_ana_selparam_t::nval should be 1 or \ref SPAR_VARNUM should be
  87  * specified; other values would lead to unpredictable behavior.
  88  */
  89 #define SPAR_RANGES   8
  90 /*! \brief
  91  * If set, the parameter can have any number of values.
  92  *
  93  * If specified, the data pointer in \c gmx_ana_selparam_t::val should be NULL;
  94  * the memory is allocated by the parameter parser.
  95  * The implementation of the method should ensure that the pointer to the
  96  * allocated memory is stored somewhere in sel_initfunc();
  97  * otherwise, the memory is lost.
  98  *
  99  * The initial value of \c gmx_ana_selparam_t::nval is not used with this flag.
 100  * Instead, it will give the number of actual values provided by the user
 101  * after the parameters have been parsed.
 102  * For consistency, it should be initialized to -1.
 103  *
 104  * Cannot be combined with \ref GROUP_VALUE parameters.
 105  */
 106 #define SPAR_VARNUM   16
 107 /*! \brief
 108  * If set, the parameter can have a separate value for each atom.
 109  *
 110  * The flag is cleared before sel_initfunc() if the value provided is actually
 111  * a single value.
 112  *
 113  * Cannot be combined with \ref POS_VALUE or \ref GROUP_VALUE parameters.
 114  */
 115 #define SPAR_ATOMVAL  32
 116 /*! \brief
 117  * If set, the parameter takes one of a set of predefined strings.
 118  *
 119  * Can only be specified for a \ref STR_VALUE parameter that takes a single
 120  * string.
 121  * The data pointer in \c gmx_ana_selparam_t::val should be initialized into an
 122  * array of strings such that the first and last elements are NULL, and the
 123  * rest give the possible values. For optional values, the second element in
 124  * the array should give the default value. The string given by the user is
 125  * matched against the beginnings of the given strings, and if a unique match
 126  * is found, the first pointer in the array will be initialized to point to
 127  * the matching string.
 128  * The data pointer can be initialized as a static array; duplication of the
 129  * array for multiple instances of the same method is automatically taken care
 130  * of.
 131  */
 132 #define SPAR_ENUMVAL  128
 133 /*@}*/
 134
 135 /*! \brief
 136  * Describes a single parameter for a selection method.
 137  */
 138 typedef struct gmx_ana_selparam_t
 139 {
 140     /** Name of the parameter. */
 141     const char         *name;
 142     /*! \brief
 143      * The parameter value.
 144      *
 145      * Type \ref NO_VALUE can be used to define a boolean parameter.
 146      * The number of values should be 0 for boolean parameters.
 147      *
 148      * The value pointer be initialized to NULL in the definition of a
 149      * \c gmx_ana_selmethod_t and initialized in the
 150      * \c gmx_ana_selmethod_t::init_data call
 151      * (see sel_datafunc()).
 152      * However, if \ref SPAR_VARNUM is provided and the parameter is not
 153      * \ref POS_VALUE, this field should not be initialized. Instead,
 154      * sufficient memory is allocated automatically and the pointer should be
 155      * stored in \c gmx_ana_selmethod_t::init
 156      * (see sel_initfunc()).
 157      *
 158      * The values cannot be accessed outside these two functions: the compiler
 159      * makes a copy of the parameter structure for each instance of the
 160      * method, and the original parameter array is not changed.
 161      */
 162     gmx_ana_selvalue_t  val;
 163     /*! \brief
 164      * Pointer to store the number of values.
 165      *
 166      * If not NULL, the number of values for the parameter is stored in the
 167      * pointed value.
 168      * Should be specified if \ref SPAR_VARNUM and \ref SPAR_DYNAMIC are both
 169      * set.
 170      *
 171      * Should be initialized to NULL in the definition a \c gmx_ana_selmethod_t
 172      * and initialized in sel_datafunc().
 173      */
 174     int                *nvalptr;
 175     /*! \brief
 176      * Flags that alter the way the parameter is parsed/handled.
 177      *
 178      * See \ref selparam_flags for allowed values.
 179      */
 180     int                 flags;
 181 } gmx_ana_selparam_t;
 182
 183 /** Finds a parameter from an array by name. */
 184 gmx_ana_selparam_t *
 185 gmx_ana_selparam_find(const char *name, int nparam, gmx_ana_selparam_t *param);
 186
 187 #endif