mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
307 lines
9.2 KiB
C++
307 lines
9.2 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
License
|
|
This file is part of OpenFOAM.
|
|
|
|
OpenFOAM is free software: you can redistribute it and/or modify it
|
|
under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
Namespace
|
|
Foam::stringOps
|
|
|
|
Description
|
|
Collection of static functions to do various simple string-related
|
|
operations
|
|
|
|
SourceFiles
|
|
stringOps.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
#ifndef stringOps_H
|
|
#define stringOps_H
|
|
|
|
#include "string.H"
|
|
#include "dictionary.H"
|
|
#include "HashTable.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Namespace stringOps Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
namespace stringOps
|
|
{
|
|
//- Expand occurences of variables according to the mapping
|
|
// Expansion includes:
|
|
// -# variables
|
|
// - "$VAR", "${VAR}"
|
|
//
|
|
// Supports default values as per the Bourne/Korn shell.
|
|
// \code
|
|
// "${parameter:-defValue}"
|
|
// \endcode
|
|
// If parameter is unset or null, the \c defValue is substituted.
|
|
// Otherwise, the value of parameter is substituted.
|
|
//
|
|
// Supports alternative values as per the Bourne/Korn shell.
|
|
// \code
|
|
// "${parameter:+altValue}"
|
|
// \endcode
|
|
// If parameter is unset or null, nothing is substituted.
|
|
// Otherwise the \c altValue is substituted.
|
|
//
|
|
// Any unknown entries are removed silently.
|
|
//
|
|
// Malformed entries (eg, brace mismatch, sigil followed by bad character)
|
|
// are left as is.
|
|
//
|
|
// \note the leading sigil can be changed to avoid conflicts with other
|
|
// string expansions
|
|
string expand
|
|
(
|
|
const string&,
|
|
const HashTable<string, word, string::hash>& mapping,
|
|
const char sigil = '$'
|
|
);
|
|
|
|
|
|
//- Inplace expand occurences of variables according to the mapping
|
|
// Expansion includes:
|
|
// -# variables
|
|
// - "$VAR", "${VAR}"
|
|
//
|
|
// Supports default values as per the Bourne/Korn shell.
|
|
// \code
|
|
// "${parameter:-defValue}"
|
|
// \endcode
|
|
// If parameter is unset or null, the \c defValue is substituted.
|
|
// Otherwise, the value of parameter is substituted.
|
|
//
|
|
// Supports alternative values as per the Bourne/Korn shell.
|
|
// \code
|
|
// "${parameter:+altValue}"
|
|
// \endcode
|
|
// If parameter is unset or null, nothing is substituted.
|
|
// Otherwise the \c altValue is substituted.
|
|
//
|
|
// Any unknown entries are removed silently.
|
|
//
|
|
// Malformed entries (eg, brace mismatch, sigil followed by bad character)
|
|
// are left as is.
|
|
//
|
|
// \note the leading sigil can be changed to avoid conflicts with other
|
|
// string expansions
|
|
string& inplaceExpand
|
|
(
|
|
string&,
|
|
const HashTable<string, word, string::hash>& mapping,
|
|
const char sigil = '$'
|
|
);
|
|
|
|
//- Expand occurences of variables according to the dictionary
|
|
// Expansion includes:
|
|
// -# variables
|
|
// - "$VAR", "${VAR}"
|
|
//
|
|
// Any unknown entries are left as-is
|
|
//
|
|
// \note the leading sigil can be changed to avoid conflicts with other
|
|
// string expansions
|
|
string expand
|
|
(
|
|
const string&,
|
|
const dictionary& dict,
|
|
const char sigil = '$'
|
|
);
|
|
|
|
|
|
//- Get dictionary or (optionally) environment variable
|
|
string getVariable
|
|
(
|
|
const word& name,
|
|
const dictionary& dict,
|
|
const bool allowEnvVars,
|
|
const bool allowEmpty
|
|
);
|
|
|
|
|
|
//- Recursively expands (dictionary or environment) variable
|
|
// starting at index in string. Updates index.
|
|
string expand
|
|
(
|
|
const string& s,
|
|
string::size_type& index,
|
|
const dictionary& dict,
|
|
const bool allowEnvVars,
|
|
const bool allowEmpty
|
|
);
|
|
|
|
|
|
//- Inplace expand occurences of variables according to the dictionary
|
|
// and optionally environment variables
|
|
// Expansion includes:
|
|
// -# variables
|
|
// - "$VAR", "${VAR}"
|
|
//
|
|
// with the "${}" syntax doing a recursive substitution.
|
|
// Any unknown entries are left as-is
|
|
//
|
|
// \note the leading sigil can be changed to avoid conflicts with other
|
|
// string expansions
|
|
string& inplaceExpand
|
|
(
|
|
string& s,
|
|
const dictionary& dict,
|
|
const bool allowEnvVars,
|
|
const bool allowEmpty,
|
|
const char sigil = '$'
|
|
);
|
|
|
|
|
|
//- Inplace expand occurences of variables according to the dictionary
|
|
// Expansion includes:
|
|
// -# variables
|
|
// - "$VAR", "${VAR}"
|
|
//
|
|
// Any unknown entries are left as-is
|
|
//
|
|
// \note the leading sigil can be changed to avoid conflicts with other
|
|
// string expansions
|
|
string& inplaceExpand
|
|
(
|
|
string&,
|
|
const dictionary& dict,
|
|
const char sigil = '$'
|
|
);
|
|
|
|
|
|
//- Expand initial tildes and all occurences of environment variables
|
|
// Expansion includes:
|
|
// -# environment variables
|
|
// - "$VAR", "${VAR}"
|
|
// -# current directory
|
|
// - leading "./" : the current directory
|
|
// -# tilde expansion
|
|
// - leading "~/" : home directory
|
|
// - leading "~user" : home directory for specified user
|
|
// - leading "~OpenFOAM" : site/user OpenFOAM configuration directory
|
|
//
|
|
// Supports default values as per the Bourne/Korn shell.
|
|
// \code
|
|
// "${parameter:-defValue}"
|
|
// \endcode
|
|
// If parameter is unset or null, the \c defValue is substituted.
|
|
// Otherwise, the value of parameter is substituted.
|
|
//
|
|
// Supports alternative values as per the Bourne/Korn shell.
|
|
// \code
|
|
// "${parameter:+altValue}"
|
|
// \endcode
|
|
// If parameter is unset or null, nothing is substituted.
|
|
// Otherwise the \c altValue is substituted.
|
|
//
|
|
// Any unknown entries are removed silently, if allowEmpty is true.
|
|
//
|
|
// Malformed entries (eg, brace mismatch, sigil followed by bad character)
|
|
// are left as is.
|
|
//
|
|
// \sa
|
|
// Foam::findEtcFile
|
|
string expand
|
|
(
|
|
const string&,
|
|
const bool allowEmpty = false
|
|
);
|
|
|
|
|
|
//- Expand initial tildes and all occurences of environment variables
|
|
// Expansion includes:
|
|
// -# environment variables
|
|
// - "$VAR", "${VAR}"
|
|
// -# current directory
|
|
// - leading "./" : the current directory
|
|
// -# tilde expansion
|
|
// - leading "~/" : home directory
|
|
// - leading "~user" : home directory for specified user
|
|
// - leading "~OpenFOAM" : site/user OpenFOAM configuration directory
|
|
//
|
|
// Supports default values as per the Bourne/Korn shell.
|
|
// \code
|
|
// "${parameter:-defValue}"
|
|
// \endcode
|
|
// If parameter is unset or null, the \c defValue is substituted.
|
|
// Otherwise, the value of parameter is substituted.
|
|
//
|
|
// Supports alternative values as per the Bourne/Korn shell.
|
|
// \code
|
|
// "${parameter:+altValue}"
|
|
// \endcode
|
|
// If parameter is unset or null, nothing is substituted.
|
|
// Otherwise the \c altValue is substituted.
|
|
//
|
|
// Any unknown entries are removed silently, if allowEmpty is true.
|
|
//
|
|
// Malformed entries (eg, brace mismatch, sigil followed by bad character)
|
|
// are left as is.
|
|
//
|
|
// Any unknown entries are removed silently if allowEmpty is true.
|
|
// \sa
|
|
// Foam::findEtcFile
|
|
string& inplaceExpand
|
|
(
|
|
string&,
|
|
const bool allowEmpty = false
|
|
);
|
|
|
|
|
|
//- Return string trimmed of leading whitespace
|
|
string trimLeft(const string&);
|
|
|
|
//- Trim leading whitespace inplace
|
|
string& inplaceTrimLeft(string&);
|
|
|
|
//- Return string trimmed of trailing whitespace
|
|
string trimRight(const string&);
|
|
|
|
//- Trim trailing whitespace inplace
|
|
string& inplaceTrimRight(string&);
|
|
|
|
//- Return string trimmed of leading and trailing whitespace
|
|
string trim(const string&);
|
|
|
|
//- Trim leading and trailing whitespace inplace
|
|
string& inplaceTrim(string&);
|
|
|
|
|
|
} // End namespace stringOps
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|