src/OpenFOAM/primitives/Lists/wordReListMatcher.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::wordReListMatcher
  27
  28 Description
  29     A wrapper for matching a List of wordRe.
  30
  31 Note
  32     The constructor should remain non-explicit. This allows automatic
  33     conversion from UList\<wordRe\> to wordReListMatcher in search
  34     functions.
  35
  36 SourceFiles
  37     wordReListMatcherI.H
  38
  39 \*---------------------------------------------------------------------------*/
  40
  41 #ifndef wordReListMatcher_H
  42 #define wordReListMatcher_H
  43
  44 #include "wordReList.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                       Class wordReListMatcher Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class wordReListMatcher
  56 {
  57     // Private data
  58
  59         //- Reference to underlying list
  60         const UList<wordRe>& reList_;
  61
  62 public:
  63
  64     // Constructors
  65
  66         //- Construct from a List of wordRe
  67         inline wordReListMatcher(const UList<wordRe>&);
  68
  69
  70     // Member Functions
  71
  72         // Access
  73
  74             inline label size() const;
  75             inline bool  empty() const;
  76
  77             //- Return underlying list of wordRe
  78             inline const UList<wordRe>& operator()() const;
  79
  80
  81     // Searching
  82
  83             //- Return true if string matches any of the regular expressions
  84             //  Smart match as regular expression or as a string.
  85             //  Optionally specify a literal match only.
  86             inline bool match(const string&, bool literalMatch=false) const;
  87
  88 };
  89
  90
  91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  92
  93 } // End namespace Foam
  94
  95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  96
  97 #include "wordReListMatcherI.H"
  98
  99 #endif
 100
 101 // ************************************************************************* //