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. More...

Public Member Functions
	CStringList (const CStringList &)=delete
	No copy construct. More...

void	operator= (const CStringList &)=delete
	No copy assignment. More...

constexpr	CStringList () noexcept
	Default construct, adding content later (via reset). More...

	CStringList (std::initializer_list< const char *const > input)
	Copy construct from a list of C-strings. More...

template<class StringType >
	CStringList (const UList< StringType > &input)
	Copy construct from a list of strings. More...

	CStringList (const UList< std::string_view > &input)
	Copy construct from a list of string_views. More...

	CStringList (const std::vector< std::string_view > &input)
	Copy construct from a list of string_views. More...

	CStringList (const SubStrings &input)
	Copy construct from a list of sub-string references. More...

	~CStringList ()
	Destructor. Invokes clear() to free memory. More...

bool	empty () const noexcept
	True if the size (ie, argc) is zero. More...

int	size () const noexcept
	Return the number of C-strings (ie, argc) More...

std::string_view	view () const
	The flattened character content, with interspersed nul-chars. More...

const char *	cdata_bytes () const noexcept
	The flattened character content, with interspersed nul-chars. More...

size_t	size_bytes () const noexcept
	Overall length of the flattened character (data) content including interspersed nul-chars but not the trailing nul-char. More...

const char *	data () const noexcept
	Same as cdata_bytes() More...

size_t	length () const noexcept
	Same as size_bytes() More...

const char *	get (int i) const
	Return string element at the given index. No bounds checking. More...

char **	strings () const noexcept
	Return the list of C-strings (ie, argv) More...

char **	strings (int start) const
	Return the sublist of C-strings (ie, argv) starting at the specified offset. More...

void	clear ()
	Clear contents and free memory. More...

int	reset (std::initializer_list< const char *const > input)
	Copy the input list of C-strings. More...

template<class StringType >
int	reset (const UList< StringType > &input)
	Copy the input list of strings. More...

int	reset (const SubStrings &input)
	Copy the input list of strings. More...

const char *	operator[] (int i) const
	Return element at the given index. No bounds checking. More...

Static Public Member Functions
static int	count (const char *const argv[])
	Count the number of parameters until the first nullptr. More...

template<class StringType = std::string>
static List< StringType >	asList (int argc, const char *const argv[])
	Create a list from argc/argv parameters. More...

template<class StringType = std::string>
static List< StringType >	asList (const char *const argv[])
	Create a list from a nullptr-terminated list of argv parameters. More...

Detailed 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:

wordList myStrings;  ...
CStringList cstr(myStrings);
// pass as argc, argv:
someMain(cstr.size(), cstr.strings());
// access the raw characters:
os.write(cstr.data(), cstr.length());

Definition at line 67 of file CStringList.H.

Constructor & Destructor Documentation

◆ CStringList() [1/7]

CStringList ( const CStringList & )

delete

No copy construct.

◆ CStringList() [2/7]

constexpr CStringList ( )

inlinenoexcept

Default construct, adding content later (via reset).

Definition at line 65 of file CStringListI.H.

◆ CStringList() [3/7]

CStringList ( std::initializer_list< const char *const > input )

inlineexplicit

Copy construct from a list of C-strings.

Copies the input characters.

Definition at line 75 of file CStringListI.H.

References reset().

Here is the call graph for this function:

◆ CStringList() [4/7]

CStringList ( const UList< StringType > & input )

inlineexplicit

Copy construct from a list of strings.

Copies the input characters.

Definition at line 86 of file CStringListI.H.

◆ CStringList() [5/7]

CStringList ( const UList< std::string_view > & input )

inlineexplicit

Copy construct from a list of string_views.

Copies the input characters.

Definition at line 94 of file CStringListI.H.

◆ CStringList() [6/7]

CStringList ( const std::vector< std::string_view > & input )

inlineexplicit

Copy construct from a list of string_views.

Copies the input characters.

Definition at line 103 of file CStringListI.H.

◆ CStringList() [7/7]

CStringList ( const SubStrings & input )

inlineexplicit

Copy construct from a list of sub-string references.

Copies the input characters.

Definition at line 113 of file CStringListI.H.

◆ ~CStringList()

~CStringList ( )

inline

Destructor. Invokes clear() to free memory.

Definition at line 123 of file CStringListI.H.

References clear().

Here is the call graph for this function:

Member Function Documentation

◆ operator=()

void operator= ( const CStringList & )

delete

No copy assignment.

◆ count()

int count ( const char *const argv[] )

inlinestatic

Count the number of parameters until the first nullptr.

Return 0 if argv is nullptr.

Definition at line 49 of file CStringListI.H.

References n.

◆ empty()

bool empty ( ) const

inlinenoexcept

True if the size (ie, argc) is zero.

Definition at line 213 of file CStringList.H.

Referenced by Foam::system().

Here is the caller graph for this function:

◆ size()

int size ( ) const

inlinenoexcept

Return the number of C-strings (ie, argc)

Definition at line 218 of file CStringList.H.

◆ view()

std::string_view view ( ) const

inline

The flattened character content, with interspersed nul-chars.

Definition at line 131 of file CStringListI.H.

◆ cdata_bytes()

const char* cdata_bytes ( ) const

inlinenoexcept

The flattened character content, with interspersed nul-chars.

Definition at line 228 of file CStringList.H.

◆ size_bytes()

size_t size_bytes ( ) const

inlinenoexcept

Overall length of the flattened character (data) content including interspersed nul-chars but not the trailing nul-char.

Definition at line 234 of file CStringList.H.

◆ data()

const char* data ( ) const

inlinenoexcept

Same as cdata_bytes()

Definition at line 239 of file CStringList.H.

◆ length()

size_t length ( ) const

inlinenoexcept

Same as size_bytes()

Definition at line 244 of file CStringList.H.

◆ get()

const char* get ( int i ) const

inline

Return string element at the given index. No bounds checking.

Definition at line 249 of file CStringList.H.

◆ strings() [1/2]

char** strings ( ) const

inlinenoexcept

Return the list of C-strings (ie, argv)

The position at argc is a nullptr

Definition at line 256 of file CStringList.H.

Referenced by Foam::system().

Here is the caller graph for this function:

◆ strings() [2/2]

char ** strings ( int start ) const

inline

Return the sublist of C-strings (ie, argv) starting at the specified offset.

Parameters

start the offset, must be less than argc

Definition at line 155 of file CStringListI.H.

◆ clear()

void clear ( )

inline

Clear contents and free memory.

Definition at line 137 of file CStringListI.H.

◆ reset() [1/3]

int reset ( std::initializer_list< const char *const > input )

Copy the input list of C-strings.

Returns: number of arguments (argc)

◆ reset() [2/3]

int reset ( const UList< StringType > & input )

inline

Copy the input list of strings.

Returns: number of arguments (argc)

Definition at line 287 of file CStringList.H.

◆ reset() [3/3]

int reset ( const SubStrings & input )

inline

Copy the input list of strings.

Returns: number of arguments (argc)

Definition at line 297 of file CStringList.H.

◆ asList() [1/2]

static List<StringType> asList	(	int	argc,
		const char *const	argv[]
	)

static

Create a list from argc/argv parameters.

A null pointer for argv is permissible when argc is zero.

◆ asList() [2/2]

static List<StringType> asList ( const char *const argv[] )

inlinestatic

Create a list from a nullptr-terminated list of argv parameters.

Using a nullptr for argv is permissible.

◆ operator[]()

const char* operator[] ( int i ) const

inline

Return element at the given index. No bounds checking.

Definition at line 327 of file CStringList.H.

The documentation for this class was generated from the following files:

src/OpenFOAM/primitives/strings/lists/CStringList.H
src/OpenFOAM/primitives/strings/lists/CStringListI.H

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CStringList() [1/7]

◆ CStringList() [2/7]

◆ CStringList() [3/7]

◆ CStringList() [4/7]

◆ CStringList() [5/7]

◆ CStringList() [6/7]

◆ CStringList() [7/7]

◆ ~CStringList()

Member Function Documentation

◆ operator=()

◆ count()

◆ empty()

◆ size()

◆ view()

◆ cdata_bytes()

◆ size_bytes()

◆ data()

◆ length()

◆ get()

◆ strings() [1/2]

◆ strings() [2/2]

◆ clear()

◆ reset() [1/3]

◆ reset() [2/3]

◆ reset() [3/3]

◆ asList() [1/2]

◆ asList() [2/2]

◆ operator[]()