e9fcd75ec4
- makes fileHandler calling resemble Time more closely ENH: provide natural_sort less/greater functions - more succinct than (compare < 0) or (compare > 0). The corresponding wrappers for UList renamed as list_less, etc but they were only used in unit tests ENH: handle (-allRegions | -all-regions, ..) directly when retrieving args - makes handling independent of aliasing order STYLE: include <string_view> when including <string> - the standard does not guarantee which headers (if any) actually include string_view
273 lines
8.5 KiB
C++
273 lines
8.5 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | www.openfoam.com
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
Copyright (C) 2016-2025 OpenCFD Ltd.
|
|
-------------------------------------------------------------------------------
|
|
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/>.
|
|
|
|
Class
|
|
Foam::CStringList
|
|
|
|
Description
|
|
An adapter for copying a list of C++ strings into a list of C-style
|
|
strings for passing to C code that expects argc/argv parameters.
|
|
|
|
In addition to providing a C-compatible list of C-strings,
|
|
the string lists are flattened into a single string of data that can be
|
|
also be passed en mass.
|
|
|
|
Example use:
|
|
\code
|
|
wordList myStrings; ...
|
|
CStringList cstr(myStrings);
|
|
|
|
// pass as argc, argv:
|
|
someMain(cstr.size(), cstr.strings());
|
|
|
|
// access the raw characters:
|
|
os.write(cstr.data(), cstr.length());
|
|
\endcode
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef Foam_CStringList_H
|
|
#define Foam_CStringList_H
|
|
|
|
#include "fileNameList.H"
|
|
#include "stringList.H"
|
|
#include "wordList.H"
|
|
#include "SubStrings.H"
|
|
|
|
#include <algorithm> // std::copy
|
|
#include <utility> // std::initializer_list
|
|
#include <vector>
|
|
#include <string_view>
|
|
#include <string>
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class CStringList Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class CStringList
|
|
{
|
|
// Private Data
|
|
|
|
//- Number of strings
|
|
int argc_;
|
|
|
|
//- Overall length of the raw content
|
|
// Does not include the final nul-character
|
|
size_t nbytes_;
|
|
|
|
//- List of strings, including trailing nullptr
|
|
char** argv_;
|
|
|
|
//- Flattened content with interspersed nul-characters
|
|
char* data_;
|
|
|
|
|
|
// Private Member Functions
|
|
|
|
//- Copy characters into dest as NUL-terminated string.
|
|
//
|
|
// \return location one-past end of dest (ie, the next destination)
|
|
static inline char* stringCopy(char* dest, const char* src);
|
|
|
|
//- Copy string characters into dest as NUL-terminated string.
|
|
//
|
|
// \return location one-past end of dest (ie, the next destination)
|
|
static inline char* stringCopy(char *dest, std::string_view src);
|
|
|
|
//- Copy string characters into dest as NUL-terminated string.
|
|
// Forces conversion of std::sub_match to string form
|
|
//
|
|
// \return location one-past end of dest (ie, the next destination)
|
|
static inline char* stringCopy(char *dest, const std::string& src);
|
|
|
|
//- Copy the input list of strings.
|
|
// \return number of arguments (argc)
|
|
template<class ListType>
|
|
int resetContent(const ListType& input);
|
|
|
|
|
|
public:
|
|
|
|
// Generated Methods
|
|
|
|
//- No copy construct
|
|
CStringList(const CStringList&) = delete;
|
|
|
|
//- No copy assignment
|
|
void operator=(const CStringList&) = delete;
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Default construct, adding content later (via reset).
|
|
inline constexpr CStringList() noexcept;
|
|
|
|
//- Copy construct from a list of C-strings
|
|
// Copies the input characters.
|
|
inline explicit CStringList
|
|
(
|
|
std::initializer_list<const char* const> input
|
|
);
|
|
|
|
//- Copy construct from a list of strings
|
|
// Copies the input characters.
|
|
template<class StringType>
|
|
inline explicit CStringList(const UList<StringType>& input);
|
|
|
|
//- Copy construct from a list of string_views
|
|
// Copies the input characters.
|
|
inline explicit CStringList(const UList<std::string_view>& input);
|
|
|
|
//- Copy construct from a list of string_views
|
|
// Copies the input characters.
|
|
inline explicit CStringList(const std::vector<std::string_view>& input);
|
|
|
|
//- Copy construct from a list of sub-string references
|
|
// Copies the input characters.
|
|
inline explicit CStringList(const SubStrings& input);
|
|
|
|
|
|
//- Destructor. Invokes clear() to free memory.
|
|
inline ~CStringList();
|
|
|
|
|
|
// Public Members
|
|
|
|
//- Count the number of parameters until the first nullptr
|
|
// Return 0 if argv is nullptr.
|
|
static inline int count(const char * const argv[]);
|
|
|
|
|
|
// Access
|
|
|
|
//- True if the size (ie, argc) is zero.
|
|
bool empty() const noexcept { return !argc_; }
|
|
|
|
//- Return the number of C-strings (ie, argc)
|
|
int size() const noexcept { return argc_; }
|
|
|
|
//- The flattened character content, with interspersed nul-chars
|
|
inline std::string_view view() const;
|
|
|
|
//- The flattened character content, with interspersed nul-chars
|
|
const char* cdata_bytes() const noexcept { return data_; }
|
|
|
|
//- Overall length of the flattened character (data) content
|
|
//- including interspersed nul-chars but not the trailing nul-char
|
|
size_t size_bytes() const noexcept { return nbytes_; }
|
|
|
|
//- Same as cdata_bytes()
|
|
const char* data() const noexcept { return data_; }
|
|
|
|
//- Same as size_bytes()
|
|
size_t length() const noexcept { return nbytes_; }
|
|
|
|
//- Return string element at the given index. No bounds checking.
|
|
const char* get(int i) const { return argv_[i]; }
|
|
|
|
//- Return the list of C-strings (ie, argv)
|
|
// The position at argc is a nullptr
|
|
char** strings() const noexcept { return argv_; }
|
|
|
|
//- Return the sublist of C-strings (ie, argv) starting at the
|
|
//- specified offset.
|
|
// \param start the offset, must be less than argc
|
|
inline char** strings(int start) const;
|
|
|
|
|
|
// Edit
|
|
|
|
//- Clear contents and free memory
|
|
inline void clear();
|
|
|
|
//- Copy the input list of C-strings
|
|
// \return number of arguments (argc)
|
|
int reset(std::initializer_list<const char* const> input);
|
|
|
|
//- Copy the input list of strings.
|
|
// \return number of arguments (argc)
|
|
template<class StringType>
|
|
int reset(const UList<StringType>& input)
|
|
{
|
|
return resetContent(input);
|
|
}
|
|
|
|
//- Copy the input list of strings.
|
|
// \return number of arguments (argc)
|
|
int reset(const SubStrings& input)
|
|
{
|
|
return resetContent(input);
|
|
}
|
|
|
|
|
|
// Other
|
|
|
|
//- Create a list from argc/argv parameters.
|
|
// A null pointer for argv is permissible when argc is zero.
|
|
template<class StringType = std::string>
|
|
static List<StringType> asList(int argc, const char * const argv[]);
|
|
|
|
//- Create a list from a nullptr-terminated list of argv parameters.
|
|
// Using a nullptr for argv is permissible.
|
|
template<class StringType = std::string>
|
|
static inline List<StringType> asList(const char * const argv[]);
|
|
|
|
|
|
// Member Operators
|
|
|
|
//- Return element at the given index. No bounds checking.
|
|
const char* operator[](int i) const { return argv_[i]; }
|
|
};
|
|
|
|
|
|
// IOstream Operators
|
|
|
|
//- Output space-separated list
|
|
Ostream& operator<<(Ostream& os, const CStringList& list);
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#include "CStringListI.H"
|
|
|
|
#ifdef NoRepository
|
|
# include "CStringList.txx"
|
|
#endif
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|