directory_replace_placeholder.cpp File Reference

#include <fstream>
#include <set>
#include "directory_replace_placeholder.h"

Include dependency graph for directory_replace_placeholder.cpp:

Go to the source code of this file.

Functions
bool	directory_replace_copyBinaryFile (const PPath &inputFile, const PPath &outputFile)
	Copy a file byte for byte, with no text processing of any kind (safe for binary content).
bool	directory_replace_isBinaryAsset (const PPath &file)
bool	directory_replace_placeholder (const PPath &outputDir, const PPath &inputConfigDir, const PMapString &mapReplacePlaceholder)
	Replace placeholder in a directory and its content by respect to the given map of value for all place holder.
bool	directory_replace_placeholderFile (const PPath &outputDir, const PPath &inputConfigDir, const PMapString &mapReplacePlaceholder)
	Replace placeholder in a directory and its content by respect to the given map of value for all place holder (file only).

Function Documentation

directory_replace_copyBinaryFile()

bool directory_replace_copyBinaryFile	(	const PPath &	inputFile,
		const PPath &	outputFile )

Copy a file byte for byte, with no text processing of any kind (safe for binary content).

Parameters

inputFile	: source file
outputFile	: destination file

Returns

true on success, false otherwise

Definition at line 44 of file directory_replace_placeholder.cpp.

                                                                                        {
        std::ifstream in(inputFile.c_str(), std::ios::binary);
        if(!in.is_open()){return false;}
        std::ofstream out(outputFile.c_str(), std::ios::binary);
        if(!out.is_open()){return false;}
        out << in.rdbuf();
        return static_cast<bool>(out);
}

Referenced by directory_replace_placeholderFile().

Here is the caller graph for this function:

directory_replace_isBinaryAsset()

bool directory_replace_isBinaryAsset

(

const PPath &

file

)

Extensions of binary/image assets that must never go through text placeholder substitution : it is meaningless on such content (no XXXPlaceholderXXX token to substitute), unsafe (PPath::saveFileContent writes through a NUL-terminated C string, so binary content gets truncated at the first embedded '\0'), and prohibitively slow on large files (PString concatenation is not amortised, so replace() on a multi-megabyte blob is effectively quadratic).

Parameters

file	: file to be checked

Returns

true if the file extension is a known binary/image asset

Definition at line 21 of file directory_replace_placeholder.cpp.

                                                        {
        static const std::set<PString> setBinaryExtension{
                //images
                "png", "jpg", "jpeg", "gif", "bmp", "ico", "svg", "webp", "tiff", "tif",
                //fonts
                "woff", "woff2", "ttf", "otf", "eot",
                //archives
                "zip", "gz", "tar", "7z", "bz2", "xz",
                //documents
                "pdf",
                //audio/video
                "mp3", "mp4", "wav", "ogg", "avi", "mov",
                //compiled/binary artefacts
                "so", "dll", "dylib", "a", "o", "exe", "class", "pyc"
        };
        return setBinaryExtension.find(file.getExtension().toLower()) != setBinaryExtension.end();
}

Referenced by directory_replace_placeholderFile().

Here is the caller graph for this function:

directory_replace_placeholder()

bool directory_replace_placeholder	(	const PPath &	outputDir,
		const PPath &	inputConfigDir,
		const PMapString &	mapReplacePlaceholder )

Replace placeholder in a directory and its content by respect to the given map of value for all place holder.

Parameters

outputDir	: output directory
inputConfigDir	: input configuration directory
mapReplacePlaceholder	: map of placeholders and values to be replaced with

Returns

true on success, false otherwise

Definition at line 85 of file directory_replace_placeholder.cpp.

                                                                                                                                   {
        if(!outputDir.createDirectory()){
                std::cerr << "directory_replace_placeholder : cannot create dir '"<<outputDir<<"'" << std::endl;
                return false;
        }
        //Let's get content of inputConfigDir
        PVecPath vecDirInputDir = inputConfigDir.getAllDirectoryInDir();
        bool b(true);
        for(PVecPath::iterator itDir(vecDirInputDir.begin()); itDir != vecDirInputDir.end(); ++itDir){
                PPath relativeDir = itDir->replace(mapReplacePlaceholder);
                PPath fullInputDir = inputConfigDir / *itDir;
                PPath fullOutputDir = outputDir / relativeDir;
                b &= fullOutputDir.createDirectory();
                
                b &= directory_replace_placeholderFile(fullOutputDir, fullInputDir, mapReplacePlaceholder);
                b &= directory_replace_placeholder(fullOutputDir, fullInputDir, mapReplacePlaceholder);
        }
        b &= directory_replace_placeholderFile(outputDir, inputConfigDir, mapReplacePlaceholder);
        if(!b){
                std::cerr << "directory_replace_placeholder : cannot create output directories architecture" << std::endl;
                std::cerr << "\tinputConfigDir = '"<<inputConfigDir<<"'" << std::endl;
                std::cerr << "\toutputDir = '"<<outputDir<<"'" << std::endl;
                return false;
        }
        return b;
}

References directory_replace_placeholder(), and directory_replace_placeholderFile().

Referenced by directory_replace_placeholder().

Here is the call graph for this function:

Here is the caller graph for this function:

directory_replace_placeholderFile()

bool directory_replace_placeholderFile	(	const PPath &	outputDir,
		const PPath &	inputConfigDir,
		const PMapString &	mapReplacePlaceholder )

Replace placeholder in a directory and its content by respect to the given map of value for all place holder (file only).

Parameters

outputDir	: output directory
inputConfigDir	: input configuration directory
mapReplacePlaceholder	: map of placeholders and values to be replaced with

Returns

true on success, false otherwise

Definition at line 59 of file directory_replace_placeholder.cpp.

                                                                                                                                       {
        bool b(true);
        PVecPath vecFileInputDir = inputConfigDir.getAllFileInDir();
        for(PVecPath::iterator it(vecFileInputDir.begin()); it != vecFileInputDir.end(); ++it){
                PPath relativeFile = it->replace(mapReplacePlaceholder);
                PPath fullFile = inputConfigDir / *it;
                PPath outputFile = outputDir / relativeFile;
                if(directory_replace_isBinaryAsset(fullFile)){
                        //Binary/image assets are copied verbatim, the file name/path may still use placeholders, but the content must not be touched
                        b &= directory_replace_copyBinaryFile(fullFile, outputFile);
                        continue;
                }
                PString fileContent = fullFile.loadFileContent();
                //TODO : this could be optimised with the dico_replace_var algorithm, but this is enough for now
                PString replacedContent = fileContent.replace(mapReplacePlaceholder);
                b &= outputFile.saveFileContent(replacedContent);
        }
        return b;
}

References directory_replace_copyBinaryFile(), and directory_replace_isBinaryAsset().

Referenced by directory_replace_placeholder().

Here is the call graph for this function:

Here is the caller graph for this function: