Commit 13f04876 authored by Mark Olesen's avatar Mark Olesen
Browse files

ENH: improve input stringency for argList options

Previously:

  - bad command-line input such as -label 1234xyz would parse as a
    label (with value 1234) and the trailing junk would be silently
    ignored. This may or may not be appropriate. If the trailing junk
    looked like this '100E' or '1000E-' (ie, forgot to type the
    exponent), the incorrectly parsed values can be quite bad:

        label  = 32684
        scalar = 6.93556e-310

Now:

  - use the updated readLabel/readScalar routines that trigger a
    FatalIOError on bad input:

        --> FOAM FATAL IO ERROR:
        Trailing content found parsing '1234xyz'

        --> FOAM FATAL IO ERROR:
        Trailing content found parsing '100E'

   This traps erroneous command-line input immediately.
parent 1c649817
Test-argList.C
EXE = $(FOAM_USER_APPBIN)/Test-argList
/* EXE_INC = -I$(LIB_SRC)/cfdTools/include */
/* EXE_LIBS = -lfiniteVolume */
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2017 OpenCFD Ltd.
\\/ 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/>.
Description
\*---------------------------------------------------------------------------*/
#include "argList.H"
#include "IOstreams.H"
#include "StringStream.H"
using namespace Foam;
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Main program:
int main(int argc, char *argv[])
{
argList::noBanner();
argList::noParallel();
argList::noFunctionObjects();
argList::removeOption("case");
argList::addOption("label", "value", "Test parsing of label");
argList::addOption("scalar", "value", "Test parsing of scalar");
argList args(argc, argv);
label ival;
scalar sval;
Info<< nl;
Info<< "-label = " << flush;
if (args.optionReadIfPresent("label", ival))
{
Info<< ival << endl;
}
else
{
Info<< "not specified" << endl;
}
Info<< "-scalar = " << flush;
if (args.optionReadIfPresent("scalar", sval))
{
Info<< sval << endl;
}
else
{
Info<< "not specified" << endl;
}
Info<< "\nEnd\n" << endl;
return 0;
}
// ************************************************************************* //
......@@ -93,8 +93,8 @@ int main(int argc, char *argv[])
const scalar scaleFactor = args.optionLookupOrDefault("scale", 1.0);
bool readBlank = !args.optionFound("noBlank");
bool singleBlock = args.optionFound("singleBlock");
const bool readBlank = !args.optionFound("noBlank");
const bool singleBlock = args.optionFound("singleBlock");
scalar twoDThickness = -1;
if (args.optionReadIfPresent("2D", twoDThickness))
{
......
......@@ -281,10 +281,10 @@ public:
inline T argRead(const label index) const;
//- Return options
inline const Foam::HashTable<string>& options() const;
inline const HashTable<string>& options() const;
//- Return non-const access to options
inline Foam::HashTable<string>& options();
inline HashTable<string>& options();
//- Return the argument string associated with the named option
inline const string& option(const word& opt) const;
......@@ -302,7 +302,7 @@ public:
//- Read a value from the named option if present.
// Return true if the named option was found.
template<class T>
inline bool optionReadIfPresent(const word& opt, T&) const;
inline bool optionReadIfPresent(const word& opt, T& val) const;
//- Read a value from the named option if present.
// Return true if the named option was found, otherwise
......@@ -311,7 +311,7 @@ public:
inline bool optionReadIfPresent
(
const word& opt,
T&,
T& val,
const T& deflt
) const;
......@@ -328,7 +328,7 @@ public:
template<class T>
List<T> optionReadList(const word& opt) const
{
return readList<T>(optionLookup(opt)());
return Foam::readList<T>(optionLookup(opt)());
}
......@@ -369,7 +369,7 @@ public:
//- Add extra notes for the usage information
// This string is used "as-is" without additional formatting
static void addNote(const string&);
static void addNote(const string& note);
//- Remove option from validOptions and from optionUsage
static void removeOption(const word& opt);
......
......@@ -127,53 +127,84 @@ inline Foam::IStringStream Foam::argList::optionLookup(const word& opt) const
namespace Foam
{
// Template specialization for string
//
// Specializations for argRead
//
template<>
inline Foam::string
Foam::argList::argRead<Foam::string>(const label index) const
argList::argRead<Foam::string>(const label index) const
{
return args_[index];
}
// Template specialization for word
template<>
inline Foam::word
Foam::argList::argRead<Foam::word>(const label index) const
argList::argRead<Foam::word>(const label index) const
{
return args_[index];
}
// Template specialization for fileName
template<>
inline Foam::fileName
Foam::argList::argRead<Foam::fileName>(const label index) const
argList::argRead<Foam::fileName>(const label index) const
{
return args_[index];
}
// Template specialization for string
template<>
inline Foam::label
argList::argRead<Foam::label>(const label index) const
{
return Foam::readLabel(args_[index]);
}
template<>
inline Foam::scalar
argList::argRead<Foam::scalar>(const label index) const
{
return Foam::readScalar(args_[index]);
}
//
// Specializations for optionRead
//
template<>
inline Foam::string
Foam::argList::optionRead<Foam::string>(const word& opt) const
argList::optionRead<Foam::string>(const word& opt) const
{
return options_[opt];
}
// Template specialization for word
template<>
inline Foam::word
Foam::argList::optionRead<Foam::word>(const word& opt) const
argList::optionRead<Foam::word>(const word& opt) const
{
return options_[opt];
}
// Template specialization for fileName
template<>
inline Foam::fileName
Foam::argList::optionRead<Foam::fileName>(const word& opt) const
argList::optionRead<Foam::fileName>(const word& opt) const
{
return options_[opt];
}
template<>
inline Foam::label
argList::optionRead<Foam::label>(const word& opt) const
{
return Foam::readLabel(options_[opt]);
}
template<>
inline Foam::scalar
argList::optionRead<Foam::scalar>(const word& opt) const
{
return Foam::readScalar(options_[opt]);
}
}
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment