zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

ENH: prevent conversion of string to regExp in stringListOps (closes #739)

Browse Source 
* For most cases, this conversion would be largely unintentional
  and also less efficient. If the regex is desirable, the caller
  should invoke it explicitly.
  For example,

      findStrings(regExp(str), listOfStrings);

  Or use one of the keyType, wordRe, wordRes variants instead.
  If string is to be used as a plain (non-regex) matcher,
  this can be directly invoked

      findMatchingStrings(str, listOfStrings);

  or using the ListOps instead:

      findIndices(listOfStrings, str);

* provide function interfaces for keyType.
This commit is contained in:
Mark Olesen
2018-02-22 09:28:03 +01:00
parent f959927910
commit ec38e7a408
16 changed files with 264 additions and 226 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
applications/test/stringList/Test-stringList.C
View File

@ -53,7 +53,7 @@ int main(int argc, char *argv[])
Info<< "stringList " << strLst << nl;
labelList matches = findStrings(".*ee.*", strLst);
labelList matches = findStrings(regExp(".*ee.*"), strLst);
Info<< "matches found for regexp .*ee.* :" << nl << matches << nl;
forAll(matches, i)
@ -71,7 +71,7 @@ int main(int argc, char *argv[])
}
Info<< endl;
stringList subLst = subsetStrings(".*ee.*", strLst);
stringList subLst = subsetStrings(regExp(".*ee.*"), strLst);
Info<< "subset stringList: " << subLst << nl;
subLst = subsetStrings(reLst, strLst);
@ -80,7 +80,7 @@ int main(int argc, char *argv[])
inplaceSubsetStrings(reLst, strLst);
Info<< "subsetted stringList: " << strLst << nl;
inplaceSubsetStrings(".*l.*", strLst);
inplaceSubsetStrings(regExp(".*l.*"), strLst);
Info<< "subsetted stringList: " << strLst << nl;
Info<< "\nEnd\n" << endl;

9
applications/utilities/preProcessing/changeDictionary/changeDictionary.C
View File

@ -178,7 +178,6 @@ bool addEntry
}
// List of indices into thisKeys
labelList findMatches
(
@ -194,19 +193,19 @@ labelList findMatches
{
// Wildcard match
matches = findStrings(key, thisKeys);
}
else if (shortcuts.size())
{
// See if patchGroups expand to valid thisKeys
labelList indices = findStrings(key, shortcutNames);
forAll(indices, i)
for (const label idx : indices)
{
const word& name = shortcutNames[indices[i]];
const word& name = shortcutNames[idx];
const wordList& keys = shortcuts[name];
forAll(keys, j)
{
label index = thisKeys.find(keys[j]);
const label index = thisKeys.find(keys[j]);
if (index != -1)
{
matches.append(index);

1
applications/utilities/surface/surfacePatch/surfacePatch.C
View File

@ -137,6 +137,7 @@ int main(int argc, char *argv[])
labelList regionIDs =
findStrings(regionName, surf.regions());
if (modifier().modify(regionIDs, surf))
{
changed = true;

113
src/OpenFOAM/meshes/polyMesh/polyBoundaryMesh/polyBoundaryMesh.C
View File

@ -576,63 +576,65 @@ Foam::labelList Foam::polyBoundaryMesh::findIndices
{
DynamicList<label> indices;
if (!key.empty())
if (key.empty())
{
if (key.isPattern())
// no-op
}
else if (key.isPattern())
{
const regExp keyRe(key);
indices = findStrings(keyRe, this->names());
if (usePatchGroups && groupPatchIDs().size())
{
indices = findStrings(key, this->names());
labelHashSet indexSet(indices);
if (usePatchGroups && groupPatchIDs().size())
const wordList allGroupNames = groupPatchIDs().toc();
labelList groupIDs = findStrings(keyRe, allGroupNames);
forAll(groupIDs, i)
{
labelHashSet indexSet(indices);
const wordList allGroupNames = groupPatchIDs().toc();
labelList groupIDs = findStrings(key, allGroupNames);
forAll(groupIDs, i)
const word& grpName = allGroupNames[groupIDs[i]];
const labelList& patchIDs = groupPatchIDs()[grpName];
forAll(patchIDs, j)
{
const word& grpName = allGroupNames[groupIDs[i]];
const labelList& patchIDs = groupPatchIDs()[grpName];
forAll(patchIDs, j)
if (indexSet.insert(patchIDs[j]))
{
if (indexSet.insert(patchIDs[j]))
{
indices.append(patchIDs[j]);
}
indices.append(patchIDs[j]);
}
}
}
}
else
}
else
{
// Literal string. Special version of above to avoid
// unnecessary memory allocations
indices.setCapacity(1);
forAll(*this, i)
{
// Literal string. Special version of above to avoid
// unnecessary memory allocations
indices.setCapacity(1);
forAll(*this, i)
if (key == operator[](i).name())
{
if (key == operator[](i).name())
{
indices.append(i);
break;
}
indices.append(i);
break;
}
}
if (usePatchGroups && groupPatchIDs().size())
if (usePatchGroups && groupPatchIDs().size())
{
const auto iter = groupPatchIDs().cfind(key);
if (iter.found())
{
const HashTable<labelList>::const_iterator iter =
groupPatchIDs().find(key);
labelHashSet indexSet(indices);
if (iter.found())
const labelList& patchIDs = iter();
forAll(patchIDs, j)
{
labelHashSet indexSet(indices);
const labelList& patchIDs = iter();
forAll(patchIDs, j)
if (indexSet.insert(patchIDs[j]))
{
if (indexSet.insert(patchIDs[j]))
{
indices.append(patchIDs[j]);
}
indices.append(patchIDs[j]);
}
}
}
@ -645,26 +647,27 @@ Foam::labelList Foam::polyBoundaryMesh::findIndices
Foam::label Foam::polyBoundaryMesh::findIndex(const keyType& key) const
{
if (!key.empty())
if (key.empty())
{
if (key.isPattern())
{
labelList indices = this->findIndices(key);
// no-op
}
else if (key.isPattern())
{
labelList indices = this->findIndices(key);
// return first element
if (!indices.empty())
{
return indices[0];
}
}
else
// return first element
if (!indices.empty())
{
forAll(*this, i)
return indices[0];
}
}
else
{
forAll(*this, i)
{
if (key == operator[](i).name())
{
if (key == operator[](i).name())
{
return i;
}
return i;
}
}
}

63
src/OpenFOAM/meshes/polyMesh/zones/ZoneMesh/ZoneMesh.C
View File

@ -342,25 +342,26 @@ Foam::labelList Foam::ZoneMesh<ZoneType, MeshType>::findIndices
{
labelList indices;
if (!key.empty())
if (key.empty())
{
if (key.isPattern())
// no-op
}
else if (key.isPattern())
{
indices = findStrings(key, this->names());
}
else
{
indices.setSize(this->size());
label count = 0;
forAll(*this, i)
{
indices = findStrings(key, this->names());
}
else
{
indices.setSize(this->size());
label count = 0;
forAll(*this, i)
if (key == operator[](i).name())
{
if (key == operator[](i).name())
{
indices[count++] = i;
}
indices[count++] = i;
}
indices.setSize(count);
}
indices.setSize(count);
}
return indices;
@ -373,26 +374,26 @@ Foam::label Foam::ZoneMesh<ZoneType, MeshType>::findIndex
const keyType& key
) const
{
if (!key.empty())
if (key.empty())
{
if (key.isPattern())
{
labelList indices = this->findIndices(key);
// no-op
}
else if (key.isPattern())
{
labelList indices = this->findIndices(key);
// return first element
if (!indices.empty())
{
return indices[0];
}
}
else
if (!indices.empty())
{
forAll(*this, i)
return indices.first(); // first match
}
}
else
{
forAll(*this, i)
{
if (key == operator[](i).name())
{
if (key == operator[](i).name())
{
return i;
}
return i;
}
}
}
@ -412,7 +413,7 @@ Foam::label Foam::ZoneMesh<ZoneType, MeshType>::findZoneID
forAll(zones, zonei)
{
if (zones[zonei].name() == zoneName)
if (zoneName == zones[zonei].name())
{
return zonei;
}

146
src/OpenFOAM/primitives/strings/lists/stringListOps.H
View File

@ -43,7 +43,7 @@ SourceFiles
namespace Foam
{
//- Extract list indices
//- Extract list indices for all matches.
// The unary match predicate has the following signature:
// \code
// bool operator()(const std::string& text);
@ -78,26 +78,17 @@ namespace Foam
template<class StringType>
labelList findStrings
(
const char* re,
const keyType& matcher,
const UList<StringType>& input,
const bool invert=false
)
{
return findMatchingStrings(regExp(re), input, invert);
}
//- Return list indices for strings matching the regular expression
// Template partial specialization of findMatchingStrings
template<class StringType>
labelList findStrings
(
const std::string& re,
const UList<StringType>& input,
const bool invert=false
)
{
return findMatchingStrings(regExp(re), input, invert);
return
(
matcher.isPattern()
? findMatchingStrings(regExp(matcher), input, invert)
: findMatchingStrings(matcher, input, invert)
);
}
@ -178,25 +169,17 @@ namespace Foam
template<class StringListType>
StringListType subsetStrings
(
const char* re,
const keyType& matcher,
const StringListType& input,
const bool invert=false
)
{
return subsetMatchingStrings(regExp(re), input, invert);
}
//- Extract elements of StringList when regular expression matches
// Template partial specialization of subsetMatchingStrings
template<class StringListType>
StringListType subsetStrings
(
const std::string& re,
const StringListType& input,
const bool invert=false
)
{
return subsetMatchingStrings(regExp(re), input, invert);
return
(
matcher.isPattern()
? subsetMatchingStrings(regExp(matcher), input, invert)
: subsetMatchingStrings(matcher, input, invert)
);
}
//- Extract elements of StringList when regular expression matches
@ -265,30 +248,22 @@ namespace Foam
inplaceSubsetMatchingStrings(matcher, input, invert);
}
//- Inplace extract elements of StringList when regular expression matches
// Template partial specialization of inplaceSubsetMatchingStrings
//- Extract elements of StringList when regular expression matches
// Template partial specialization of subsetMatchingStrings
template<class StringListType>
void inplaceSubsetStrings
(
const char* re,
const keyType& matcher,
StringListType& input,
const bool invert=false
)
{
inplaceSubsetMatchingStrings(regExp(re), input, invert);
}
//- Inplace extract elements of StringList when regular expression matches
// Template partial specialization of inplaceSubsetMatchingStrings
template<class StringListType>
void inplaceSubsetStrings
(
const std::string& re,
StringListType& input,
const bool invert=false
)
{
inplaceSubsetMatchingStrings(regExp(re), input, invert);
return
(
matcher.isPattern()
? inplaceSubsetMatchingStrings(regExp(matcher), input, invert)
: inplaceSubsetMatchingStrings(matcher, input, invert)
);
}
//- Inplace extract elements of StringList when regular expression matches
@ -330,6 +305,79 @@ namespace Foam
inplaceSubsetMatchingStrings(wordRes::matcher(regexs), input, invert);
}
//- Find using C-string as a regex
// \deprecated (FEB-2018) Treating string as regex may be inefficient
// and lead to unintended results.
// Use regExp, keyType, wordRe instead, or findMatchingStrings()
template<class StringType>
labelList findStrings
(
const char* disallowed,
const UList<StringType>& input,
const bool invert=false
) = delete;
//- Find using string as a regex
// \deprecated (FEB-2018) Treating string as regex may be inefficient
// and lead to unintended results.
// Use regExp, keyType, wordRe instead, or findMatchingStrings()
template<class StringType>
labelList findStrings
(
const std::string& disallowed,
const UList<StringType>& input,
const bool invert=false
) = delete;
//- Subset using C-string as a regex
// \deprecated (FEB-2018) Treating string as regex may be inefficient
// and lead to unintended results.
// Use regExp, keyType, wordRe instead, or subsetMatchingStrings()
template<class StringListType>
StringListType subsetStrings
(
const char* disallowed,
const StringListType& input,
const bool invert=false
) = delete;
//- Subset using string as a regex
// \deprecated (FEB-2018) Treating string as regex may be inefficient
// and lead to unintended results.
// Use regExp, keyType, wordRe instead, or subsetMatchingStrings()
template<class StringListType>
StringListType subsetStrings
(
const std::string& disallowed,
const StringListType& input,
const bool invert=false
) = delete;
//- Subset using C-string as a regex
// \deprecated (FEB-2018) Treating string as regex may be inefficient
// and lead to unintended results.
// Use regExp, keyType, wordRe instead, or inplaceSubsetMatchingStrings()
template<class StringListType>
void inplaceSubsetStrings
(
const char* disallowed,
StringListType& input,
const bool invert=false
) = delete;
//- Subset using string as a regex
// \deprecated (FEB-2018) Treating string as regex may be inefficient
// and lead to unintended results.
// Use keyType, wordRe instead, or inplaceSubsetMatchingStrings()
template<class StringListType>
void inplaceSubsetStrings
(
const std::string& disallowed,
StringListType& input,
const bool invert=false
) = delete;
}

12
src/conversion/ensight/mesh/ensightMesh.C
View File

@ -149,11 +149,7 @@ void Foam::ensightMesh::correct()
if (!matcher.empty())
{
useAll = false;
matched = findMatchingStrings
(
matcher,
patchNames
);
matched = findStrings(matcher, patchNames);
}
}
@ -248,11 +244,7 @@ void Foam::ensightMesh::correct()
const wordRes& matcher = option().faceZoneSelection();
wordList selectZones = mesh_.faceZones().names();
inplaceSubsetMatchingStrings
(
matcher,
selectZones
);
subsetMatchingStrings(matcher, selectZones);
// have same order as later with sortedToc()
Foam::sort(selectZones);

33
src/finiteArea/faMesh/faBoundaryMesh/faBoundaryMesh.C
View File

@ -194,25 +194,26 @@ Foam::labelList Foam::faBoundaryMesh::findIndices
{
DynamicList<label> indices;
if (!key.empty())
if (key.empty())
{
if (key.isPattern())
{
indices = findStrings(key, this->names());
}
else
{
// Literal string. Special version of above to avoid
// unnecessary memory allocations
// no-op
}
else if (key.isPattern())
{
indices = findStrings(key, this->names());
}
else
{
// Literal string. Special version of above to avoid
// unnecessary memory allocations
indices.setCapacity(1);
forAll(*this, i)
indices.setCapacity(1);
forAll(*this, i)
{
if (key == operator[](i).name())
{
if (key == operator[](i).name())
{
indices.append(i);
break;
}
indices.append(i);
break;
}
}
}

27
src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleErosion/ParticleErosion.C
View File

@ -77,27 +77,27 @@ Foam::ParticleErosion<CloudType>::ParticleErosion
psi_(this->coeffDict().template lookupOrDefault<scalar>("psi", 2.0)),
K_(this->coeffDict().template lookupOrDefault<scalar>("K", 2.0))
{
const wordList allPatchNames = owner.mesh().boundaryMesh().names();
wordList patchName(this->coeffDict().lookup("patches"));
const wordList allPatchNames(owner.mesh().boundaryMesh().names());
const wordReList patchNames(this->coeffDict().lookup("patches"));
labelHashSet uniquePatchIDs;
forAllReverse(patchName, i)
labelHashSet uniqIds;
for (const wordRe& re : patchNames)
{
labelList patchIDs = findStrings(patchName[i], allPatchNames);
labelList ids = findStrings(re, allPatchNames);
if (patchIDs.empty())
if (ids.empty())
{
WarningInFunction
<< "Cannot find any patch names matching " << patchName[i]
<< "Cannot find any patch names matching " << re
<< endl;
}
uniquePatchIDs.insert(patchIDs);
uniqIds.insert(ids);
}
patchIDs_ = uniquePatchIDs.toc();
patchIDs_ = uniqIds.sortedToc();
// trigger ther creation of the Q field
// trigger creation of the Q field
preEvolve();
}
@ -117,13 +117,6 @@ Foam::ParticleErosion<CloudType>::ParticleErosion
{}
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
template<class CloudType>
Foam::ParticleErosion<CloudType>::~ParticleErosion()
{}
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
template<class CloudType>

2
src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleErosion/ParticleErosion.H
View File

@ -120,7 +120,7 @@ public:
//- Destructor
virtual ~ParticleErosion();
virtual ~ParticleErosion() = default;
// Member Functions

32
src/lagrangian/intermediate/submodels/CloudFunctionObjects/PatchPostProcessing/PatchPostProcessing.C
View File

@ -134,33 +134,32 @@ Foam::PatchPostProcessing<CloudType>::PatchPostProcessing
times_(),
patchData_()
{
const wordList allPatchNames = owner.mesh().boundaryMesh().names();
wordList patchName(this->coeffDict().lookup("patches"));
const wordList allPatchNames(owner.mesh().boundaryMesh().names());
const wordReList patchNames(this->coeffDict().lookup("patches"));
labelHashSet uniquePatchIDs;
forAllReverse(patchName, i)
labelHashSet uniqIds;
for (const wordRe& re : patchNames)
{
labelList patchIDs = findStrings(patchName[i], allPatchNames);
labelList ids = findStrings(re, allPatchNames);
if (patchIDs.empty())
if (ids.empty())
{
WarningInFunction
<< "Cannot find any patch names matching " << patchName[i]
<< "Cannot find any patch names matching " << re
<< endl;
}
uniquePatchIDs.insert(patchIDs);
uniqIds.insert(ids);
}
patchIDs_ = uniquePatchIDs.toc();
patchIDs_ = uniqIds.sortedToc();
if (debug)
{
forAll(patchIDs_, i)
for (const label patchi : patchIDs_)
{
const label patchi = patchIDs_[i];
const word& patchName = owner.mesh().boundaryMesh()[patchi].name();
Info<< "Post-process patch " << patchName << endl;
Info<< "Post-process patch "
<< owner.mesh().boundaryMesh()[patchi].name() << endl;
}
}
@ -183,13 +182,6 @@ Foam::PatchPostProcessing<CloudType>::PatchPostProcessing
{}
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
template<class CloudType>
Foam::PatchPostProcessing<CloudType>::~PatchPostProcessing()
{}
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
template<class CloudType>

2
src/lagrangian/intermediate/submodels/CloudFunctionObjects/PatchPostProcessing/PatchPostProcessing.H
View File

@ -115,7 +115,7 @@ public:
//- Destructor
virtual ~PatchPostProcessing();
virtual ~PatchPostProcessing() = default;
// Member Functions

8
src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/LocalInteraction/patchInteractionDataList.C
View File

@ -46,22 +46,22 @@ Foam::patchInteractionDataList::patchInteractionDataList
patchGroupIDs_(this->size())
{
const polyBoundaryMesh& bMesh = mesh.boundaryMesh();
const wordList allPatchNames = bMesh.names();
const wordList allPatchNames(bMesh.names());
const List<patchInteractionData>& items = *this;
forAllReverse(items, i)
{
const word& patchName = items[i].patchName();
labelList patchIDs = findStrings(patchName, allPatchNames);
labelList ids = findIndices(allPatchNames, patchName);
if (patchIDs.empty())
if (ids.empty())
{
WarningInFunction
<< "Cannot find any patch names matching " << patchName
<< endl;
}
patchGroupIDs_[i].transfer(patchIDs);
patchGroupIDs_[i].transfer(ids);
}
// Check that all patches are specified

26
src/meshTools/coordinateSystems/coordinateSystems.C
View File

@ -101,22 +101,26 @@ const Foam::coordinateSystems& Foam::coordinateSystems::New
Foam::labelList Foam::coordinateSystems::findIndices(const keyType& key) const
{
labelList indices;
if (key.isPattern())
if (key.empty())
{
indices = findStrings(key, toc());
// no-op
}
else if (key.isPattern())
{
indices = findStrings(key, this->toc());
}
else
{
indices.setSize(size());
label nFound = 0;
indices.setSize(this->size());
label count = 0;
forAll(*this, i)
{
if (key == operator[](i).name())
{
indices[nFound++] = i;
indices[count++] = i;
}
}
indices.setSize(nFound);
indices.setSize(count);
}
return indices;
@ -125,13 +129,16 @@ Foam::labelList Foam::coordinateSystems::findIndices(const keyType& key) const
Foam::label Foam::coordinateSystems::findIndex(const keyType& key) const
{
if (key.isPattern())
if (key.empty())
{
// no-op
}
else if (key.isPattern())
{
labelList indices = findIndices(key);
// return first element
if (!indices.empty())
{
return indices[0];
return indices.first(); // first match
}
}
else
@ -145,6 +152,7 @@ Foam::label Foam::coordinateSystems::findIndex(const keyType& key) const
}
}
// Not found
return -1;
}

8
src/meshTools/triSurface/triSurfaceLoader/triSurfaceLoader.C
View File

@ -120,12 +120,12 @@ Foam::label Foam::triSurfaceLoader::select(const wordRe& mat)
if (mat.isPattern())
{
foundIds = findMatchingStrings(mat, available_);
foundIds = findStrings(mat, available_);
sort(foundIds);
}
else
{
const word& plain = static_cast<const word&>(mat);
const word& plain = mat;
if (available_.found(plain))
{
foundIds.append(available_[plain]);
@ -164,7 +164,7 @@ Foam::label Foam::triSurfaceLoader::select(const UList<wordRe>& matcher)
{
if (mat.isPattern())
{
labelList indices = findMatchingStrings(mat, available_);
labelList indices = findStrings(mat, available_);
sort(indices);
for (const label idx : indices)
@ -177,7 +177,7 @@ Foam::label Foam::triSurfaceLoader::select(const UList<wordRe>& matcher)
}
else
{
const word& plain = static_cast<const word&>(mat);
const word& plain = mat;
if (available_.found(plain))
{
const label idx = available_[plain];

2
src/regionModels/surfaceFilmModels/submodels/kinematic/injectionModel/curvatureSeparation/curvatureSeparation.C
View File

@ -249,7 +249,7 @@ curvatureSeparation::curvatureSeparation
forAllReverse(prIn, i)
{
labelList patchIDs = findStrings(prIn[i].first(), allPatchNames);
labelList patchIDs = findIndices(allPatchNames, prIn[i].first());
forAll(patchIDs, j)
{
const label patchi = patchIDs[j];