Sort all includes in src/gromacs
[alexxy/gromacs.git] / src / gromacs / options / abstractoption.cpp
index a4d8685bcfee2f2625ffd91fd72a042be64f1893..a71ed24353a6867c35c2aceee5935a32e7c19c49 100644 (file)
@@ -1,45 +1,50 @@
 /*
+ * 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
  * Implements classes in abstractoption.h and abstractoptionstorage.h.
  *
- * \author Teemu Murtola <teemu.murtola@cbr.su.se>
+ * \author Teemu Murtola <teemu.murtola@gmail.com>
  * \ingroup module_options
  */
-#include "gromacs/options/abstractoption.h"
+#include "gmxpre.h"
+
+#include "abstractoption.h"
 
 #include "gromacs/options/abstractoptionstorage.h"
 #include "gromacs/options/optionflags.h"
-#include "gromacs/options/optioninfo.h"
 #include "gromacs/utility/exceptions.h"
 #include "gromacs/utility/gmxassert.h"
 
@@ -53,7 +58,7 @@ namespace gmx
  */
 
 AbstractOptionStorage::AbstractOptionStorage(const AbstractOption &settings,
-                                             OptionFlags staticFlags)
+                                             OptionFlags           staticFlags)
     : flags_(settings.flags_ | staticFlags),
       minValueCount_(settings.minValueCount_),
       maxValueCount_(settings.maxValueCount_),
@@ -69,7 +74,10 @@ AbstractOptionStorage::AbstractOptionStorage(const AbstractOption &settings,
     {
         name_  = settings.name_;
     }
-    descr_ = settings.createDescription();
+    if (settings.descr_ != NULL)
+    {
+        descr_ = settings.descr_;
+    }
     setFlag(efOption_ClearOnNextSet);
 }
 
@@ -99,7 +107,7 @@ void AbstractOptionStorage::startSet()
         GMX_THROW(InvalidInputError("Option specified multiple times"));
     }
     clearSet();
-    bInSet_ = true;
+    bInSet_              = true;
     bSetValuesHadErrors_ = false;
 }
 
@@ -142,7 +150,7 @@ void AbstractOptionStorage::finish()
 {
     GMX_RELEASE_ASSERT(!bInSet_, "finishSet() not called");
     processAll();
-    if (isRequired() && !isSet())
+    if (isRequired() && !(isSet() || hasFlag(efOption_ExplicitDefaultValue)))
     {
         GMX_THROW(InvalidInputError("Option is required, but not set"));
     }
@@ -203,19 +211,44 @@ bool OptionInfo::isRequired() const
     return option().isRequired();
 }
 
+int OptionInfo::minValueCount() const
+{
+    if (option().defaultValueIfSetExists())
+    {
+        return 0;
+    }
+    return option().minValueCount();
+}
+
+int OptionInfo::maxValueCount() const
+{
+    return option().maxValueCount();
+}
+
 const std::string &OptionInfo::name() const
 {
     return option().name();
 }
 
-const std::string &OptionInfo::description() const
+std::string OptionInfo::type() const
 {
-    return option().description();
+    return option().typeString();
 }
 
-const char *OptionInfo::type() const
+std::string OptionInfo::formatDescription() const
 {
-    return option().typeString();
+    std::string description(option().description());
+    std::string extraDescription(option().formatExtraDescription());
+    if (!extraDescription.empty())
+    {
+        description.append(extraDescription);
+    }
+    return description;
+}
+
+std::string OptionInfo::formatDefaultValueIfSet() const
+{
+    return option().formatDefaultValueIfSet();
 }
 
 int OptionInfo::valueCount() const
@@ -228,9 +261,4 @@ std::string OptionInfo::formatValue(int i) const
     return option().formatValue(i);
 }
 
-std::string OptionInfo::formatDefaultValueIfSet() const
-{
-    return option().formatDefaultValueIfSet();
-}
-
 } // namespace gmx