kcenia4010 / unn-c-style-checker

Авторы

Анатолий Таламанов, Елизавета Шуланкина.

Установка окружения

Windows 10

Вам потребуется установить WSL. Для этого нужно следовать инструкции.
Обратите внимание что нужно выбрать версию Ubuntu18 или Ubuntu20.
После установки запускаем Ubuntu 20.04 LTS или Ubuntu 18.04 LTS. У вас должен появиться терминал.

Ubuntu20/Ubuntu18

Пользователям linux можно приступать к следующему шагу.

Сборка LLVM & CLang

Находясь в терминале, установите следующие зависимости:

sudo apt install git cmake 

Создайте папку для работы с курсом и перейдите в нее:

mkdir ~/compiler-course && cd ~/compiler-course

Далее собираем LLVM вместе с Clang из исходников:

git clone https://github.com/llvm/llvm-project
cd llvm-project/llvm/
mkdir build && cd build
cmake ../ -DCMAKE_BUILD_TYPE=Release \
          -DLLVM_LINK_LLVM_DYLIB=ON \
          -DCMAKE_INSTALL_PREFIX=install \
          -DLLVM_TARGETS_TO_BUILD=X86 \
          -DLLVM_ENABLE_PROJECTS=clang
make -j<n>
make install

Сборка может занять длительное время.

Prebuilt LLVM & Clang

Вы также можете использовать уже собранный llvm & clang, для того что бы получить последнюю версию:

1. Перейдите в папку с задачей.
2. Запустите: source download-and-install-llvm.sh Скрипт скачает последний релиз и положит его в папку /tmp/, также выставит переменную LLVM_DIR, поэтому вам больше не нужно ее выставлять во время запуска.
3. Перейдите в папку с билдом и запустите:

• cmake ../
• make -j<n>

Обратите внимание, что сборка LLVM из исходников потребуется для сдачи дальнейших задач в курсе. Данный workraround поможет сдать только текущую задачу.

Задача

После успешного построения LLVM & Clang можно приступать к выполнению задания.

Вернитесь в корневую папку курса:

cd ~/compiler-course

Для начала сделайте Fork текущего репозитория к себе в профиль. После этого копия репозитория появится у вас в профиле.

Склонируйте и перейдите в локальную копию:

git clone <fork-repo-url>
cd UNN-C-Style-Checker/

Создайте отдельную ветку для работы с репозиторием, которая будет содержать имя, фамилию и направление. Пример:

git checkout -b vasya-pupkin-fiit

Собираем проект с заданием:

mkdir build && cd build
cmake ../ -DLLVM_DIR=~/compiler-course/llvm-project/llvm/build/install/lib/cmake/llvm
make -j<n>

В задаче нужно реализовать с помощью интерфейса clang, tool, который будет находить в исходном коде программы все приведения типов в стиле си и заменять их на соответсвующий аналог из с++. Пример:

double d = 4.5;
int i = (int)d; // int i = static_cast<int>(d);

Для замены исходного кода программы будем пользоваться классом Rewriter.

Вам нужно будет дописать код в класс CastCallBack, отвечающий за действие, которое нужно совершить при нахождении узла cStyleCastExpr в AST.
В данном случае мы хотим понять тип преобразования и заменить исходный код с помощью Rewriter.

class CastCallBack : public MatchFinder::MatchCallback {
public:
	CastCallBack(Rewriter& rewriter) {
		// Your code goes here
	}

	void run(const MatchFinder::MatchResult &Result) override {
		// Your code goes here
	}
};

После того как вы реализуете CastCallBack, пересоберите проект и запустите.

./c-style-cast-checker ../test/test.cpp --extra-arg=-I/home/<your-root-name>/compiler-course/llvm-project/llvm/build/lib/clang/<version>/include/

Если вы все реализовали правильно, то вы увидите на экране:

#include <iostream>
int main() {
	float f;
	int i = static_cast<int>(f);
	return 0;
}

Отправка решения

После того, как вы сделали заданиe:

1. Сделайте коммит:

   git add -u
   git commit -m 'Complete c-style-cast-checker task'
   

2. Отправьте ветку с вашим решением на сервер:

   git push origin HEAD
   

3. Перейдите на github и откройте pull request из вашей ветки в master главного репозитория.

Если необходимо что-то исправить после создания pull request, нужно внести требуемые изменения и повторить шаги 1 и 2. Не нужно открывать новый pull request.

Дополнительно

1. Дописать код для сохранения результата модификации исходного кода. Залить изменения в свою ветку.
2. Вывести AST для версий входного файла до и после модификации. Сохранить версии в отдельный текстовый файл, указать на измененный участок. Залить файл в свою ветку.
3. Написать вариант реализации задачи с использованием RefactoringTool класса для замены исходного кода. Залить изменения в свою ветку.
4. Описать преимущества использования RefactoringTool над Rewriter (можно комментарием к коду, либо в отдельном файле).

Полезные ссылки

• Понимание Clang AST
• Руководство по созданию инструментов с использованием LibTooling и LibASTMatchers
• Усложненная реализация данной задачи
• Матчеры которые есть в clang
• Сборка LLVM