mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-12-28 03:37:59 +00:00
107 lines
3.4 KiB
C++
107 lines
3.4 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2016 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/>.
|
|
|
|
InNamespace
|
|
Foam
|
|
|
|
Description
|
|
Functions to search 'etc' directories for configuration files etc.
|
|
|
|
SourceFiles
|
|
etcFiles.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef etcFiles_H
|
|
#define etcFiles_H
|
|
|
|
#include "fileNameList.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
//- Search for directories from user/group/other directories.
|
|
//
|
|
// \note Uses search hierarchy as per findEtcFiles().
|
|
//
|
|
// \return The list of full paths of all the matching directories or
|
|
// an empty list if the name cannot be found.
|
|
// Optionally stop search after the first directory has been found.
|
|
fileNameList findEtcDirs
|
|
(
|
|
const fileName& name = fileName::null,
|
|
const bool findFirst = false
|
|
);
|
|
|
|
|
|
//- Search for files from user/group/other directories.
|
|
//
|
|
// \note
|
|
// The following search hierarchy is also used by the foamEtcFile shell
|
|
// script, which allows for version-specific and version-independent files:
|
|
// - \b user settings:
|
|
// - ~/.OpenFOAM/\<VERSION\>
|
|
// - ~/.OpenFOAM/
|
|
// - \b group settings (when $WM_PROJECT_SITE is set):
|
|
// - $WM_PROJECT_SITE/\<VERSION\>
|
|
// - $WM_PROJECT_SITE
|
|
// - \b group settings (when $WM_PROJECT_SITE is not set):
|
|
// - $WM_PROJECT_INST_DIR/site/\<VERSION\>
|
|
// - $WM_PROJECT_INST_DIR/site/
|
|
// - \b other (shipped) settings:
|
|
// - $WM_PROJECT_DIR/etc/
|
|
//
|
|
// \return The list of full paths of all the matching files or
|
|
// an empty list if the name cannot be found.
|
|
// Optionally abort if the file cannot be found.
|
|
// Optionally stop search after the first file has been found.
|
|
fileNameList findEtcFiles
|
|
(
|
|
const fileName& name,
|
|
const bool mandatory = false,
|
|
const bool findFirst = false
|
|
);
|
|
|
|
|
|
//- Search for a single file using findEtcFiles().
|
|
//
|
|
// \return The full path name of the first file found in the
|
|
// search hierarchy or an empty fileName if the name cannot be found.
|
|
// Optionally abort if the file cannot be found but is mandatory.
|
|
fileName findEtcFile(const fileName& name, const bool mandatory=false);
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|