Generates convenience include-redirect files (e.g. More...

Collaboration diagram for IncludeFolderCreator:

Public Member Functions
void	generateIncludeFile (const StringView class_name, const File &include_file)
	Generates a single include-redirect file for the given class name.
void	generateIncludeFiles ()
	Scans the entire source tree and generates all include-redirect files.
void	generateIncludeFiles (const File &header_folder, Buffer< String > &all_classes)
	Generates include files for all headers in a specific folder.
void	generateIncludeLibFile (const StringView lib_name, const Buffer< String > &include_file)
	Generates an include-redirect file for a library that includes multiple headers.
String	includeMacro (const File &dll_info)
	Returns the DLL export macro name parsed from a DLLInfo.h file.

Public Attributes
String	include_folder_name = String("Headers")
	The subdirectory name containing public headers.
LogPtr	log
	Log for status messages.
File	output_location
	The directory where generated include files are placed.
bool	override_existing = true
	Whether to overwrite existing generated files.
File	source_code_directory
	The root source code directory to scan.

Detailed Description

Generates convenience include-redirect files (e.g.

<NDEVR/ClassName>) for all public headers found in the source tree, enabling easy inclusion by class name.

Definition at line 10 of file IncludeFolderCreator.h.

Member Function Documentation

void IncludeFolderCreator::generateIncludeFile	(	const StringView	class_name,
		const File &	include_file )

Generates a single include-redirect file for the given class name.

Parameters

[in]	class_name	The class name for the redirect file.
[in]	include_file	The actual header file to redirect to.

void IncludeFolderCreator::generateIncludeFiles	(	const File &	header_folder,
		Buffer< String > &	all_classes )

Generates include files for all headers in a specific folder.

Parameters

[in]	header_folder	The folder containing header files.
[in]	all_classes	Accumulator buffer for all discovered class names.

void IncludeFolderCreator::generateIncludeLibFile	(	const StringView	lib_name,
		const Buffer< String > &	include_file )

Generates an include-redirect file for a library that includes multiple headers.

Parameters

[in]	lib_name	The library name for the redirect file.
[in]	include_file	The list of header paths to include.

String IncludeFolderCreator::includeMacro ( const File & dll_info )

Returns the DLL export macro name parsed from a DLLInfo.h file.

Parameters

[in] dll_info The DLLInfo.h file to parse.

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