removeEntry.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
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
13  the Free Software Foundation, either version 3 of the License, or
14  (at your 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, see <http://www.gnu.org/licenses/>.
23 
24 \*---------------------------------------------------------------------------*/
25 
26 #include "removeEntry.H"
27 #include "dictionary.H"
28 #include "stringListOps.H"
29 #include "IStringStream.H"
30 #include "OStringStream.H"
32 
33 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34 
35 const Foam::word Foam::functionEntries::removeEntry::typeName
36 (
37  Foam::functionEntries::removeEntry::typeName_()
38 );
39 
40 // Don't lookup the debug switch here as the debug switch dictionary
41 // might include removeEntry
42 int Foam::functionEntries::removeEntry::debug(0);
43 
44 namespace Foam
45 {
46 namespace functionEntries
47 {
49  (
50  functionEntry,
51  removeEntry,
52  execute,
53  dictionaryIstream
54  );
55 }
56 }
57 
58 
59 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
60 
62 (
63  dictionary& parentDict,
64  Istream& is
65 )
66 {
67  wordList dictKeys = parentDict.toc();
68  wordReList patterns = readList<wordRe>(is);
69 
70  labelList indices = findStrings(patterns, dictKeys);
71 
72  forAll(indices, indexI)
73  {
74  parentDict.remove(dictKeys[indices[indexI]]);
75  }
76 
77  return true;
78 }
79 
80 // ************************************************************************* //
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:428
bool remove(const word &)
Remove an entry specified by keyword.
Definition: dictionary.C:966
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
Operations on lists of strings.
addToMemberFunctionSelectionTable(functionEntry, calcEntry, execute, dictionaryIstream)
wordList toc() const
Return the table of contents.
Definition: dictionary.C:776
static bool execute(dictionary &parentDict, Istream &)
Execute the functionEntry in a sub-dict context.
Definition: removeEntry.C:62
bool findStrings(const wordReListMatcher &matcher, const std::string &str)
Return true if string matches one of the regular expressions.
Definition: stringListOps.H:52
A class for handling words, derived from string.
Definition: word.H:59
Macros for easy insertion into member function selection tables.
Namespace for OpenFOAM.