src/gromacs/options/filenameoptionstorage.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2016,2017,2018, 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 /*! \internal \file
  36  * \brief
  37  * Declares gmx::FileNameOptionStorage.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_options
  41  */
  42 #ifndef GMX_OPTIONS_FILENAMEOPTIONSTORAGE_H
  43 #define GMX_OPTIONS_FILENAMEOPTIONSTORAGE_H
  44
  45 #include <string>
  46 #include <vector>
  47
  48 #include "gromacs/options/filenameoption.h"
  49 #include "gromacs/options/optionfiletype.h"
  50 #include "gromacs/options/optionstoragetemplate.h"
  51
  52 namespace gmx
  53 {
  54
  55 class FileNameOption;
  56 class FileNameOptionManager;
  57
  58 /*! \internal \brief
  59  * Converts, validates, and stores file names.
  60  */
  61 class FileNameOptionStorage : public OptionStorageTemplateSimple<std::string>
  62 {
  63     public:
  64         /*! \brief
  65          * Initializes the storage from option settings.
  66          *
  67          * \param[in] settings   Storage settings.
  68          * \param     manager    Manager for this object (can be NULL).
  69          */
  70         FileNameOptionStorage(const FileNameOption  &settings,
  71                               FileNameOptionManager *manager);
  72
  73         OptionInfo &optionInfo() override { return info_; }
  74         std::string typeString() const override;
  75         std::string formatExtraDescription() const override;
  76         std::string formatSingleValue(const std::string &value) const override;
  77
  78         //! \copydoc FileNameOptionInfo::isInputFile()
  79         bool isInputFile() const { return bRead_ && !bWrite_; }
  80         //! \copydoc FileNameOptionInfo::isOutputFile()
  81         bool isOutputFile() const { return !bRead_ && bWrite_; }
  82         //! \copydoc FileNameOptionInfo::isInputOutputFile()
  83         bool isInputOutputFile() const { return bRead_ && bWrite_; }
  84         //! \copydoc FileNameOptionInfo::isLibraryFile()
  85         bool isLibraryFile() const { return bLibrary_; }
  86         //! \copydoc FileNameOptionInfo::allowMissing()
  87         bool allowMissing() const { return bAllowMissing_; }
  88
  89         //! \copydoc FileNameOptionInfo::isDirectoryOption()
  90         bool isDirectoryOption() const;
  91         //! \copydoc FileNameOptionInfo::isTrajectoryOption()
  92         bool isTrajectoryOption() const;
  93         //! \copydoc FileNameOptionInfo::defaultExtension()
  94         const char *defaultExtension() const;
  95         //! \copydoc FileNameOptionInfo::extensions()
  96         std::vector<const char *> extensions() const;
  97         //! \copydoc FileNameOptionInfo::isValidType()
  98         bool isValidType(int fileType) const;
  99         //! \copydoc FileNameOptionInfo::fileTypes()
 100         ArrayRef<const int> fileTypes() const;
 101
 102     private:
 103         void initConverter(ConverterType *converter) override;
 104         std::string processValue(const std::string &value) const override;
 105         void processAll() override;
 106
 107         FileNameOptionInfo      info_;
 108         FileNameOptionManager  *manager_;
 109         int                     fileType_;
 110         const char             *defaultExtension_;
 111         bool                    bRead_;
 112         bool                    bWrite_;
 113         bool                    bLibrary_;
 114         bool                    bAllowMissing_;
 115 };
 116
 117 } // namespace gmx
 118
 119 #endif