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 by the GROMACS development team.
   5  * Copyright (c) 2017,2018,2019,2020, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \internal \file
  37  * \brief
  38  * Declares gmx::FileNameOptionStorage.
  39  *
  40  * \author Teemu Murtola <teemu.murtola@gmail.com>
  41  * \ingroup module_options
  42  */
  43 #ifndef GMX_OPTIONS_FILENAMEOPTIONSTORAGE_H
  44 #define GMX_OPTIONS_FILENAMEOPTIONSTORAGE_H
  45
  46 #include <string>
  47 #include <vector>
  48
  49 #include "gromacs/options/filenameoption.h"
  50 #include "gromacs/options/optionfiletype.h"
  51 #include "gromacs/options/optionstoragetemplate.h"
  52
  53 namespace gmx
  54 {
  55
  56 class FileNameOption;
  57 class FileNameOptionManager;
  58
  59 /*! \internal \brief
  60  * Converts, validates, and stores file names.
  61  */
  62 class FileNameOptionStorage : public OptionStorageTemplateSimple<std::string>
  63 {
  64 public:
  65     /*! \brief
  66      * Initializes the storage from option settings.
  67      *
  68      * \param[in] settings   Storage settings.
  69      * \param     manager    Manager for this object (can be NULL).
  70      */
  71     FileNameOptionStorage(const FileNameOption& settings, 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