CPGen
C++ project generator
Loading...
Searching...
No Matches
Public Member Functions | List of all members
ScaffoldEmitter Class Reference

Generates starter source files for a new C++ project. More...

#include <ScaffoldEmitter.hpp>

Inheritance diagram for ScaffoldEmitter:
Inheritance graph
[legend]
Collaboration diagram for ScaffoldEmitter:
Collaboration graph
[legend]

Public Member Functions

 ScaffoldEmitter (std::filesystem::path template_root)
 Construct with a path to the templates root directory.
 
std::vector< OutputFileemit (const ResolvedProject &project) override
 Produce output files from a resolved project.
 
- Public Member Functions inherited from Emitter
 Emitter ()=default
 
virtual ~Emitter ()=default
 
 Emitter (const Emitter &)=default
 
Emitteroperator= (const Emitter &)=default
 
 Emitter (Emitter &&)=default
 
Emitteroperator= (Emitter &&)=default
 

Detailed Description

Generates starter source files for a new C++ project.

Produces:

Constructor & Destructor Documentation

◆ ScaffoldEmitter()

ScaffoldEmitter::ScaffoldEmitter ( std::filesystem::path  template_root)
explicit

Construct with a path to the templates root directory.

Parameters
template_rootAbsolute path to the templates/ directory (used for module example files such as gtest/example.cpp).

Member Function Documentation

◆ emit()

std::vector< OutputFile > ScaffoldEmitter::emit ( const ResolvedProject project)
overridevirtual

Produce output files from a resolved project.

Parameters
projectThe fully resolved project description.
Returns
A vector of files to write to the project directory.

Implements Emitter.


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