helpTypeNew.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2012-2015 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "helpType.H"
29 
30 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
31 
33 (
34  const word& helpTypeName
35 )
36 {
37  auto cstrIter = dictionaryConstructorTablePtr_->cfind(helpTypeName);
38 
39  if (!cstrIter.found())
40  {
41  // special treatment for -help
42  // exit without stack trace
43  if (helpTypeName.starts_with("-help"))
44  {
46  << "Valid helpType selections:" << nl
47  << " "
48  << flatOutput(dictionaryConstructorTablePtr_->sortedToc()) << nl
49  << exit(FatalError);
50  }
51  else
52  {
54  << "Unknown helpType type '" << helpTypeName << "'" << nl << nl
55  << "Valid helpType selections:" << nl
56  << " "
57  << flatOutput(dictionaryConstructorTablePtr_->sortedToc()) << nl
58  << abort(FatalError);
59  }
60  }
61 
62  Info<< "Selecting helpType '" << helpTypeName << "'" << endl;
63 
64  return autoPtr<helpType>(cstrIter()());
65 }
66 
67 
68 // ************************************************************************* //
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:350
helpType.H
Foam::Info
messageStream Info
Information stream (uses stdout - output is on the master only)
Foam::helpType::New
static autoPtr< helpType > New(const word &helpTypeName)
Selector.
Foam::FatalError
error FatalError
Foam::abort
errorManip< error > abort(error &err)
Definition: errorManip.H:137
Foam::exit
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:130
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
FatalErrorInFunction
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:372
Foam::nl
constexpr char nl
Definition: Ostream.H:385
Foam::flatOutput
FlatOutput< Container > flatOutput(const Container &obj, label len=0)
Global flatOutput function.
Definition: FlatOutput.H:85