src/gromacs/utility/stringcompare.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016, 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 /*! \libinternal \file
  36  * \brief
  37  * Declares utility functionst for string comparison.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_utility
  42  */
  43 #ifndef GMX_UTILITY_STRINGCOMPARE_H
  44 #define GMX_UTILITY_STRINGCOMPARE_H
  45
  46 #include <string>
  47
  48 #include "gromacs/utility/cstringutil.h"
  49
  50 namespace gmx
  51 {
  52
  53 //! \cond libapi
  54 /*! \brief
  55  * Specifies how strings should be compared in various contexts.
  56  *
  57  * \ingroup module_utility
  58  */
  59 enum class StringCompareType
  60 {
  61     //! Only exact matches are accepted.
  62     Exact,
  63     //! Case-insensitive comparison.
  64     CaseInsensitive,
  65     //! Case-insensitive comparison that also ignores '-' and '_'.
  66     CaseAndDashInsensitive
  67 };
  68 //! \endcond
  69
  70 /*! \libinternal \brief
  71  * Compare object for std::string STL containers and algorithms that supports
  72  * run-time decision on how to compare.
  73  *
  74  * \inlibraryapi
  75  * \ingroup module_utility
  76  */
  77 class StringCompare
  78 {
  79     public:
  80         /*! \brief
  81          * Creates a comparer with the given type
  82          *
  83          * This is not explicit, which allows passing \ref StringCompareType
  84          * directly to, e.g., `std::map` constructors.
  85          */
  86         StringCompare(StringCompareType type = StringCompareType::Exact)
  87             : type_(type) {}
  88
  89         //! The comparison operation.
  90         bool operator()(const std::string &a, const std::string &b) const
  91         {
  92             switch (type_)
  93             {
  94                 case StringCompareType::Exact:
  95                     return a < b;
  96                 case StringCompareType::CaseInsensitive:
  97                     return gmx_strcasecmp(a.c_str(), b.c_str()) < 0;
  98                 case StringCompareType::CaseAndDashInsensitive:
  99                     return gmx_strcasecmp_min(a.c_str(), b.c_str()) < 0;
 100             }
 101             return a < b;
 102         }
 103
 104     private:
 105         StringCompareType type_;
 106 };
 107
 108 } // namespace gmx
 109
 110 #endif