More consistent default handling for StringOption
[alexxy/gromacs.git] / src / gromacs / options / basicoptionstorage.h
index 43ed4d512e40ae04e9434e5bffa98e5e938bbd77..823ec97beb3e4ddca7ab0a5301c82c80c01a7b20 100644 (file)
@@ -1,38 +1,42 @@
 /*
+ * This file is part of the GROMACS molecular simulation package.
  *
- *                This source code is part of
+ * Copyright (c) 2010,2011,2012,2013,2014, by the GROMACS development team, led by
+ * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
+ * and including many others, as listed in the AUTHORS file in the
+ * top-level source directory and at http://www.gromacs.org.
  *
- *                 G   R   O   M   A   C   S
+ * GROMACS is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 2.1
+ * of the License, or (at your option) any later version.
  *
- *          GROningen MAchine for Chemical Simulations
+ * GROMACS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
  *
- * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
- * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
- * Copyright (c) 2001-2009, The GROMACS development team,
- * check out http://www.gromacs.org for more information.
-
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with GROMACS; if not, see
+ * http://www.gnu.org/licenses, or write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  *
- * If you want to redistribute modifications, please consider that
- * scientific software is very special. Version control is crucial -
- * bugs must be traceable. We will be happy to consider code for
- * inclusion in the official distribution, but derived work must not
- * be called official GROMACS. Details are found in the README & COPYING
- * files - if they are missing, get the official version at www.gromacs.org.
+ * If you want to redistribute modifications to GROMACS, please
+ * consider that scientific software is very special. Version
+ * control is crucial - bugs must be traceable. We will be happy to
+ * consider code for inclusion in the official distribution, but
+ * derived work must not be called official GROMACS. Details are found
+ * in the README & COPYING files - if they are missing, get the
+ * official version at http://www.gromacs.org.
  *
  * To help us fund GROMACS development, we humbly ask that you cite
- * the papers on the package - you can find them in the top README file.
- *
- * For more info, check our website at http://www.gromacs.org
+ * the research papers on the package. Check out http://www.gromacs.org.
  */
 /*! \internal \file
  * \brief
  * Declares storage classes for basic option types.
  *
- * \author Teemu Murtola <teemu.murtola@cbr.su.se>
+ * \author Teemu Murtola <teemu.murtola@gmail.com>
  * \ingroup module_options
  */
 #ifndef GMX_OPTIONS_BASICOPTIONSTORAGE_H
 #include <vector>
 
 #include "basicoptions.h"
-#include "basicoptioninfo.h"
-#include "optionfiletype.h"
 #include "optionstoragetemplate.h"
 
 namespace gmx
 {
 
-class BooleanOption;
-class IntegerOption;
-class DoubleOption;
-class StringOption;
-class FileNameOption;
-
 /*! \addtogroup module_options
  * \{
  */
@@ -76,8 +72,11 @@ class BooleanOptionStorage : public OptionStorageTemplate<bool>
         }
 
         virtual OptionInfo &optionInfo() { return info_; }
-        virtual const char *typeString() const { return "bool"; }
-        virtual std::string formatValue(int i) const;
+        virtual std::string typeString() const { return "bool"; }
+        virtual std::string formatSingleValue(const bool &value) const;
+
+        //! \copydoc BooleanOptionInfo::defaultValue()
+        bool defaultValue() const { return valueCount() > 0 && values()[0]; }
 
     private:
         virtual void convertValue(const std::string &value);
@@ -98,9 +97,9 @@ class IntegerOptionStorage : public OptionStorageTemplate<int>
         }
 
         virtual OptionInfo &optionInfo() { return info_; }
-        virtual const char *typeString() const
-        { return hasFlag(efVector) ? "vector" : "int"; }
-        virtual std::string formatValue(int i) const;
+        virtual std::string typeString() const
+        { return isVector() ? "vector" : "int"; }
+        virtual std::string formatSingleValue(const int &value) const;
 
     private:
         virtual void convertValue(const std::string &value);
@@ -109,6 +108,28 @@ class IntegerOptionStorage : public OptionStorageTemplate<int>
         IntegerOptionInfo       info_;
 };
 
+/*! \internal \brief
+ * Converts, validates, and stores integer values.
+ */
+class Int64OptionStorage : public OptionStorageTemplate<gmx_int64_t>
+{
+    public:
+        //! \copydoc BooleanOptionStorage::BooleanOptionStorage()
+        explicit Int64OptionStorage(const Int64Option &settings)
+            : MyBase(settings), info_(this)
+        {
+        }
+
+        virtual OptionInfo &optionInfo() { return info_; }
+        virtual std::string typeString() const { return "int"; }
+        virtual std::string formatSingleValue(const gmx_int64_t &value) const;
+
+    private:
+        virtual void convertValue(const std::string &value);
+
+        Int64OptionInfo       info_;
+};
+
 /*! \internal \brief
  * Converts, validates, and stores floating-point (double) values.
  */
@@ -119,8 +140,8 @@ class DoubleOptionStorage : public OptionStorageTemplate<double>
         explicit DoubleOptionStorage(const DoubleOption &settings);
 
         virtual OptionInfo &optionInfo() { return info_; }
-        virtual const char *typeString() const;
-        virtual std::string formatValue(int i) const;
+        virtual std::string typeString() const;
+        virtual std::string formatSingleValue(const double &value) const;
 
         //! \copydoc DoubleOptionInfo::isTime()
         bool isTime() const { return bTime_; }
@@ -130,7 +151,6 @@ class DoubleOptionStorage : public OptionStorageTemplate<double>
     private:
         virtual void convertValue(const std::string &value);
         virtual void processSetValues(ValueList *values);
-        virtual void processAll();
 
         DoubleOptionInfo        info_;
         bool                    bTime_;
@@ -138,57 +158,59 @@ class DoubleOptionStorage : public OptionStorageTemplate<double>
 };
 
 /*! \internal \brief
- * Converts, validates, and stores string values.
+ * Converts, validates, and stores floating-point (float) values.
  */
-class StringOptionStorage : public OptionStorageTemplate<std::string>
+class FloatOptionStorage : public OptionStorageTemplate<float>
 {
     public:
-        //! \copydoc DoubleOptionStorage::DoubleOptionStorage()
-        explicit StringOptionStorage(const StringOption &settings);
+        //! \copydoc IntegerOptionStorage::IntegerOptionStorage()
+        explicit FloatOptionStorage(const FloatOption &settings);
 
-        virtual OptionInfo &optionInfo() { return _info; }
-        virtual const char *typeString() const { return _allowed.empty() ? "string" : "enum"; }
-        virtual std::string formatValue(int i) const;
+        virtual OptionInfo &optionInfo() { return info_; }
+        virtual std::string typeString() const;
+        virtual std::string formatSingleValue(const float &value) const;
+
+        //! \copydoc DoubleOptionStorage::isTime()
+        bool isTime() const { return bTime_; }
+        //! \copydoc DoubleOptionStorage::setScaleFactor()
+        void setScaleFactor(double factor);
 
     private:
         virtual void convertValue(const std::string &value);
-        virtual void refreshValues();
+        virtual void processSetValues(ValueList *values);
 
-        StringOptionInfo        _info;
-        ValueList               _allowed;
-        int                    *_enumIndexStore;
+        FloatOptionInfo         info_;
+        bool                    bTime_;
+        double                  factor_;
 };
 
 /*! \internal \brief
- * Converts, validates, and stores file names.
+ * Converts, validates, and stores string values.
  */
-class FileNameOptionStorage : public OptionStorageTemplate<std::string>
+class StringOptionStorage : public OptionStorageTemplate<std::string>
 {
     public:
-        //! \copydoc StringOptionStorage::StringOptionStorage()
-        explicit FileNameOptionStorage(const FileNameOption &settings);
+        //! \copydoc DoubleOptionStorage::DoubleOptionStorage()
+        explicit StringOptionStorage(const StringOption &settings);
 
         virtual OptionInfo &optionInfo() { return info_; }
-        virtual const char *typeString() const { return "file"; }
-        virtual std::string formatValue(int i) const;
-
-        //! \copydoc FileNameOptionInfo::isInputFile()
-        bool isInputFile() const { return bRead_ && !bWrite_; }
-        //! \copydoc FileNameOptionInfo::isOutputFile()
-        bool isOutputFile() const { return !bRead_ && bWrite_; }
-        //! \copydoc FileNameOptionInfo::isInputOutputFile()
-        bool isInputOutputFile() const { return bRead_ && bWrite_; }
-        //! \copydoc FileNameOptionInfo::isLibraryFile()
-        bool isLibraryFile() const { return bLibrary_; }
+        virtual std::string typeString() const
+        { return allowed_.empty() ? "string" : "enum"; }
+        virtual std::string formatExtraDescription() const;
+        virtual std::string formatSingleValue(const std::string &value) const;
+
+        //! \copydoc StringOptionInfo::allowedValues()
+        const ValueList &allowedValues() const { return allowed_; }
 
     private:
         virtual void convertValue(const std::string &value);
+        virtual void refreshValues();
+
+        void refreshEnumIndexStore();
 
-        FileNameOptionInfo      info_;
-        OptionFileType          filetype_;
-        bool                    bRead_;
-        bool                    bWrite_;
-        bool                    bLibrary_;
+        StringOptionInfo        info_;
+        ValueList               allowed_;
+        int                    *enumIndexStore_;
 };
 
 /*!\}*/