Sort all includes in src/gromacs
[alexxy/gromacs.git] / src / gromacs / options / options-impl.h
index d3e12521d9d1b5ed50da9a945446f062dbb5eb86..3fba6da02ad8efc80378ae11bceb42d12fa4fd30 100644 (file)
@@ -1,56 +1,62 @@
 /*
+ * 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 private implementation class for gmx::Options.
  *
- * \author Teemu Murtola <teemu.murtola@cbr.su.se>
+ * \author Teemu Murtola <teemu.murtola@gmail.com>
  * \ingroup module_options
  */
 #ifndef GMX_OPTIONS_OPTIONS_IMPL_H
 #define GMX_OPTIONS_OPTIONS_IMPL_H
 
-#include <memory>
 #include <string>
 #include <vector>
 
-#include "options.h"
+#include "gromacs/options/abstractoption.h"
+#include "gromacs/options/optionmanagercontainer.h"
+#include "gromacs/options/options.h"
+#include "gromacs/utility/uniqueptr.h"
 
 namespace gmx
 {
 
 class AbstractOptionStorage;
-class OptionsGlobalProperties;
 
-/*! \internal \brief
+/*! \internal
+ * \brief
  * Private implementation class for Options.
  *
  * Note that in addition to Options, the OptionsAssigner and OptionsIterator
@@ -61,10 +67,13 @@ class OptionsGlobalProperties;
 class Options::Impl
 {
     public:
+        //! Smart pointer for managing an AbstractOptionStorage object.
+        typedef gmx_unique_ptr<AbstractOptionStorage>::type
+            AbstractOptionStoragePointer;
         //! Convenience type for list of sections.
         typedef std::vector<Options *> SubSectionList;
         //! Convenience type for list of options.
-        typedef std::vector<AbstractOptionStorage *> OptionList;
+        typedef std::vector<AbstractOptionStoragePointer> OptionList;
 
         //! Sets the name and title.
         Impl(const char *name, const char *title);
@@ -98,36 +107,33 @@ class Options::Impl
         void startSource();
 
         //! Name for the Options object.
-        std::string             _name;
+        std::string             name_;
         //! Description title for the Options object.
-        std::string             _title;
+        std::string             title_;
         //! Full description for the Options object.
-        std::string             _description;
+        std::string             description_;
+        /*! \brief
+         * Option managers set for this collection.
+         *
+         * This is non-empty only for the top-level Options object.
+         */
+        OptionManagerContainer  managers_;
         /*! \brief
          * List of subsections, in insertion order.
          *
          * This container contains only references to external objects; memory
          * management is performed elsewhere.
          */
-        SubSectionList          _subSections;
+        SubSectionList          subSections_;
         /*! \brief
          * List of options, in insertion order.
          *
          * All objects in this container are owned by this object, and are
          * freed in the destructor.
          */
-        OptionList              _options;
+        OptionList              options_;
         //! Options object that contains this object as a subsection, or NULL.
-        Options                *_parent;
-        /*! \brief
-         * Object that contains global properties, or NULL if \a _parent != NULL.
-         *
-         * This object is always owned by the Options object.
-         * For subsections, the global properties are kept in the parent, and
-         * this pointer is NULL.
-         */
-        // Could be scoped_ptr
-        std::auto_ptr<OptionsGlobalProperties>  _globalProperties;
+        Options                *parent_;
 };
 
 } // namespace gmx