VMlib::Preprocessor Class Reference

Класс, позволяющий выполнять предварительную обработку файлов More...

#include <Preprocessor.h>

Collaboration diagram for VMlib::Preprocessor:

Public Member Functions
	Preprocessor (const std::string &fileName)
	Конструктор, принимающий на вход имя обрабатываемого файла More...
	~Preprocessor ()
	Деструктор More...

Public Attributes
std::string	initialInput
	Строка, содержащая исходный файл в первоначальном виде More...
std::string	intermediateOutput
	Строка, содержащая результат промежуточной обработки файла More...
std::string	resultString
	Строка, содержащая окончательный результат обработки файла More...
std::stringstream	resultStream

Private Member Functions
void	normalParser (char ch, std::string &str)
	Обработчик символа в режиме обычного состояния парcера More...
void	inStringParser (char ch, std::string &str)
	Обработчик символа в режиме парсера строки (внутри двойных кавычек) More...
void	inCharParser (char ch, std::string &str)
	Обработчик символа в режиме парсера символа (внутри одинарных кавычек) More...
void	afterSlashParser (char ch, std::string &str)
	Обработчик символа в режиме парсера выражения после слэша More...
void	inInlineCommentParser (char ch, std::string &str)
	Обработчик символа в режиме парсера однострочного комментария (после //) More...
void	inMultilineCommentParser (char ch, std::string &str)
	Обработчик символа в режиме парсера многострочного комментария More...
char	processSymbol (char ch)
	Базовая функция обработки символа В зависимости от входого символа возвращает на выход: More...

Private Attributes
bool	inStringLastEscape
	Признак встречи слэша внутри строки (внутри двойных кавычек) More...
bool	inCharLastEscape
	Признак встречи слэша внутри символа (внутри одинарных кавычек) More...
bool	inInlineLastEscape
	Признак встречи слэша внутри однострочного комментария (после //) More...
bool	inMultilineLastStar
	Признак встречи звездочки внутри многострочного комментария (после '/*') More...
void(Preprocessor::*	currentParser )(char ch, std::string &str)
	Опредедение currentParser как указателя на функцию-члена класса More...

Detailed Description

Класс, позволяющий выполнять предварительную обработку файлов

Выполняет следующие действия:

• Исключает из файла однострочные и многостройчные комментарии в стиле С/С++
• Разрывы строк заменяет на пробелы
• Точки с запятой заменяет на разрывы строк

Author

Марчевский Илья Константинович 1.12

Date

14 января 2024 г.

Definition at line 59 of file Preprocessor.h.

Constructor & Destructor Documentation

Preprocessor::Preprocessor

(

const std::string &

fileName

)

Конструктор, принимающий на вход имя обрабатываемого файла

После посимвольной обработки формирует промежуточный вывод intermediateOutput
Затем убирает из вывода пробелы и знаки табуляции и формирует окончательный поток вывода resultStream

Parameters

[in]

fileName

константная ссылка на строку — имя обрабатываемого файла

Definition at line 44 of file Preprocessor.cpp.

    :
    inStringLastEscape(false),
    inCharLastEscape(false),
    inInlineLastEscape(false),
    inMultilineLastStar(false),
    currentParser(&Preprocessor::normalParser)
{
#pragma warning (push)
#pragma warning (disable: 4996)
    FILE * inputFile = fopen(fileName.c_str(), "r");
#pragma warning (pop)

    int symbol;

    while ((symbol = fgetc(inputFile)) != EOF)
    {
        initialInput.push_back(symbol);
        (this->*currentParser)(symbol, intermediateOutput);
    }

    fclose(inputFile);

    std::stringstream ss(intermediateOutput);

    std::string readline;

    while (ss.good())
    {
        getline(ss, readline);

        readline.erase(std::remove(readline.begin(), readline.end(), ' '), readline.end());
        readline.erase(std::remove(readline.begin(), readline.end(), '\t'), readline.end());
        
#if defined(_WIN32)     
#else
        readline.erase(std::remove(readline.begin(), readline.end(), 0x0D), readline.end());
#endif

        resultStream << readline << std::endl;
    }

    resultString = resultStream.str();
}//Preprocessor(...)

VMlib::Preprocessor::~Preprocessor ( )

inline

Деструктор

Definition at line 159 of file Preprocessor.h.

{ };

Member Function Documentation

void Preprocessor::afterSlashParser ( char  ch, std::string &  str  )

private

Обработчик символа в режиме парсера выражения после слэша

При появлении символов / или * переключает парсер в режим обработки однострочного или многострочного комментария
Отальные символы выводит в поток после его предварительной обработки фукцией Preprocessor::processSymbol

Parameters

[in]	ch	обрабатываемый символ
[out]	str	ссылка на строку, в которую сохряняется результат

Definition at line 149 of file Preprocessor.cpp.

{
    switch (ch)
    {
    case '/':
        currentParser = &Preprocessor::inInlineCommentParser;
        return;

    case '*':
        currentParser = &Preprocessor::inMultilineCommentParser;
        return;

    default:
        str.push_back(processSymbol(ch));
    }
}//afterSlashParser(...)

Here is the call graph for this function:

Here is the caller graph for this function:

void Preprocessor::inCharParser ( char  ch, std::string &  str  )

private

Обработчик символа в режиме парсера символа (внутри одинарных кавычек)

При появлении парного апострофа переводит парсер в обычный режим, обрабатываемый символ в неизменном виде передается в поток

Parameters

[in]	ch	обрабатываемый символ
[out]	str	ссылка на строку, в которую сохряняется результат

Definition at line 139 of file Preprocessor.cpp.

{
    str.push_back(ch);
    if (ch == '\'' && !inCharLastEscape)
        currentParser = &Preprocessor::normalParser;
    inCharLastEscape = (ch == '\\') && !inCharLastEscape;
}//inCharParser(...)

Here is the call graph for this function:

Here is the caller graph for this function:

void Preprocessor::inInlineCommentParser ( char  ch, std::string &  str  )

private

Обработчик символа в режиме парсера однострочного комментария (после //)

Игнорирует все симводы до появления конца строки.
При появлении конца строки переключает парсер в обычный режим и выводит конец строки в результирующую строчку

Parameters

[in]	ch	обрабатываемый символ
[out]	str	ссылка на строку, в которую сохряняется результат

Definition at line 168 of file Preprocessor.cpp.

{
    if (ch == '\n' && !inInlineLastEscape)
    {
        str.push_back(processSymbol(ch));
        currentParser = &Preprocessor::normalParser;
    }
    inInlineLastEscape = (ch == '\\') && !inInlineLastEscape;
}//inInlineCommentParser(...)

Here is the call graph for this function:

Here is the caller graph for this function:

void Preprocessor::inMultilineCommentParser ( char  ch, std::string &  str  )

private

Обработчик символа в режиме парсера многострочного комментария

Игнорирует все симводы до появления сочетания, соответствующего окончанию комментария.

При появлении символов окончания комментария выводит в результирующую строку пробел и переключает парсер в обычный режим

Parameters

[in]	ch	обрабатываемый символ
[out]	str	ссылка на строку, в которую сохряняется результат

Definition at line 180 of file Preprocessor.cpp.

{
    if (ch == '/' && inMultilineLastStar)
    {
        str.push_back(' ');
        currentParser = &Preprocessor::normalParser;
    }
    inMultilineLastStar = (ch == '*');
}

void Preprocessor::inStringParser ( char  ch, std::string &  str  )

private

Обработчик символа в режиме парсера строки (внутри двойных кавычек)

При появлении парной кавычки переводит парсер в обычный режим, обрабатываемый символ в неизменном виде передается в поток

Parameters

[in]	ch	обрабатываемый символ
[out]	str	ссылка на строку, в которую сохряняется результат

Definition at line 129 of file Preprocessor.cpp.

{
    str.push_back(ch);
    if (ch == '\"' && !inStringLastEscape)
        currentParser = &Preprocessor::normalParser;
    inStringLastEscape = (ch == '\\') && !inStringLastEscape;
}//inStringParser(...)

Here is the call graph for this function:

Here is the caller graph for this function:

void Preprocessor::normalParser ( char  ch, std::string &  str  )

private

Обработчик символа в режиме обычного состояния парcера

При появлении символов ", ', / переключает парсер в соответствующий режим Выводит обрабатываемый символ в поток (кроме слэша, который игнорируется) после его предварительной обработки фукцией Preprocessor::processSymbol

Parameters

[in]	ch	обрабатываемый символ
[out]	str	ссылка на строку, в которую сохряняется результат

Definition at line 108 of file Preprocessor.cpp.

{
    switch (ch)
    {
    case '\"':
        currentParser = &Preprocessor::inStringParser;
        break;

    case '\'':
        currentParser = &Preprocessor::inCharParser;
        break;

    case '/':
        currentParser = &Preprocessor::afterSlashParser;
        return;
    }
    str.push_back(processSymbol(ch));
}//normalParser(...)

Here is the call graph for this function:

Here is the caller graph for this function:

char Preprocessor::processSymbol ( char  ch )

private

Базовая функция обработки символа В зависимости от входого символа возвращает на выход:

• 
  (конец строки) — пробел
• ; (точка с зарятой) — конец строки
• исходный символ в остальных случаях

Parameters

[in]

ch

обрабатываемый символ return символ, который отправляется в обработанный файл

Definition at line 91 of file Preprocessor.cpp.

{
    switch (ch)
    {
    case '\n':
        return ' ';

    case ';':
        return '\n';

    default:
        return ch;
    }
}//processSymbol(...)

Here is the caller graph for this function:

Member Data Documentation

void(Preprocessor::* VMlib::Preprocessor::currentParser) (char ch, std::string &str)

private

Опредедение currentParser как указателя на функцию-члена класса

Definition at line 75 of file Preprocessor.h.

bool VMlib::Preprocessor::inCharLastEscape

private

Признак встречи слэша внутри символа (внутри одинарных кавычек)

Definition at line 66 of file Preprocessor.h.

bool VMlib::Preprocessor::inInlineLastEscape

private

Признак встречи слэша внутри однострочного комментария (после //)

Definition at line 69 of file Preprocessor.h.

std::string VMlib::Preprocessor::initialInput

Строка, содержащая исходный файл в первоначальном виде

Definition at line 143 of file Preprocessor.h.

bool VMlib::Preprocessor::inMultilineLastStar

private

Признак встречи звездочки внутри многострочного комментария (после '/*')

Definition at line 72 of file Preprocessor.h.

bool VMlib::Preprocessor::inStringLastEscape

private

Признак встречи слэша внутри строки (внутри двойных кавычек)

Definition at line 63 of file Preprocessor.h.

std::string VMlib::Preprocessor::intermediateOutput

Строка, содержащая результат промежуточной обработки файла

Definition at line 146 of file Preprocessor.h.

std::stringstream VMlib::Preprocessor::resultStream

Definition at line 163 of file Preprocessor.h.

std::string VMlib::Preprocessor::resultString

Строка, содержащая окончательный результат обработки файла

Definition at line 159 of file Preprocessor.h.

---

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

• VMlib/Preprocessor/Preprocessor.h
• VMlib/Preprocessor/Preprocessor.cpp