IFJ Projekt 2018

Překladač jazyka IFJ18 - Projekt do IFJ 2018, první varianta zadání

Hodnocení projektu

Implementace

Bodů celkem: 73,54
Komentář k hodnocení: OK

Lexikální analýza (detekce chyb): 100% (200/200)
Syntaktická analýza (detekce chyb): 86% (173/200)
Sémantická analýza (detekce chyb): 83% (115/138)
Běhové chyby (detekce): 87% (54/62)
Interpretace přeloženého kódu: 98% (933/951)
BOOLOP 95% (100/105)
BASE 100% (50/50)
CYCLES 0% (0/100)
DEFINED 0% (0/50)
FUNEXP 0% (0/150)
IFTHEN 0% (0/100)
Celkem bez rozšíření: 95% (1475/1551)

Dokumentace

Bodů celkem: 5
Komentář k hodnocení: typ., strukt., stylistika

Prémiové body

Bodů celkem: 2.5
2. místo v rychlostní soutěži

Struktura repozitáře

.vscode - Konfigurační soubory VS Code (debugování, doporučené pluginy, nastavení workspace)
doc - Dokumentace projektu
src - Zdrojový kód překladače
tests - Složka s ifj18 kódy pro testování

Pravidla pro zápis kódu

Struktura souboru
- Kódování UTF-8
- Na typu odřádkování nezáleží, může být \n i \r\n
- Na začátku každého souboru umístit hlavičku doxygen zápisem se stručným popisem obsahu souboru
Struktura kódu
- Odsazení TABem (ve VS Code automaticky)
  - Odsazuje se každý blok kódu (uvnitř složených závorek)
  - Odsazuje se příkaz následující ihned za podmínkou nebo cyklem, pokud není uvnitř složených závorek
- Složené závorky přilepit na předchozí kód př. if(true){...}else{...} nebo void foo(){...}
- Prvky ve výrazech (mimo závorky) a znak = (přiřazení) oddělit mezerou, př. (1 + i) * bar / 1.2 nebo int foo = 2;
- Pokud se má vykonat jen jeden příkaz (v podmínce, v cyklu, ...), je povoleno vynechat složené závorky
Pojmenování funkcí, proměnných, atd.
- Psát anglicky
- Funkce a proměnné ve stylu camelCase - začít malým písmenem, př. nextLine
- Definice struct ve stylu CamelCase - začít velkým písmenem, př. struct StringList
- Konstanty (ať už zadefinovaná pomocí #define nebo const <type>) VELKÝMI_PÍSMENY, př. #define STR_LEN
Komentáře a dokumentace
- Psát česky
- Pro dokumentaci použít doxygen zápis. Pro ty co používají VS Code je doporučený plugin Doxygen Documentation Generator. S pluginem stačí napsat \** ↵ např. před definici funkce a vytvoří se odpovídající šablona.

Příklad dokumentace funkce (plugin automaticky generuje)

/**
 * Převede celé číslo ze stringu na integer
 * 
 * @param str Vstupní string
 * @param success Uloží true pokud operace proběhla úspěšně
 * @return int Převedené číslo
 */
int strToNum(char *str, bool *success);

Příklad dokumentace proměnné na stejném řádku

pToken nextToken = NULL //<! Další token v pořadí

Příklad hlavičky souboru (plugin automaticky generuje)

/**
 * @file main.c
 *
 * Hlavní část překladače
 *
 * IFJ Projekt 2018, Tým 13
 *
 * @author <xforma14> Klára Formánková
 * @author <xlanco00> Jan Láncoš
 * @author <xsebel04> Vít Šebela
 * @author <xchalo16> Jan Chaloupka
 */

Kompilace

Součástí repozitáře je Makefile, který automaticky zkompiluje všechny zdrojové soubory ve složce /src. Pokud dojde k úpravě závislostí v souborech (např. změnou #inculde), je nutné před kompilací zavolat make dep, aby make zkompiloval soubory ve správném pořadí (toto aktualizuje soubor dep.list, kde jsou závislosti uloženy).

Součástí je i příkaz make clean, který vymaže přeložené soubory.

Debugování ve VS Code

Ve Windows

Nainstalovaný Cygwin - Stažení 64 bit verze
- Při instalaci v oknu Select Packages jsou důležité balíčky
  - gdb
  - gcc-core
  - make
Po instalaci je potřeba přidat cestu k cygwin binárkám do proměnné PATH
Funkcionalitu make lze ověřit funkcionalitu spuštěním příkazu v termínálu VS Code (zkratka pro otevření terminálu Ctrl + ;)
- Pokud kompilace proběhla bez chyb, měl by se v kořenu projektu objevit soubor compiler.exe
VS Code podporuje breakpointy které lze umístit kliknutím před číslo řádku
Debugování programu se spustí klávesou F5 nebo výběrem položky debug v levém sloupci
- Debugování lze ovládat panelem, který se objeví nahoře

Spustěním debugování se program nepřeloží, před každým debugováním je tedy potřeba program přeložit

V Linuxu

Stačí mít nainstalovaný make, gcc a gdb

janchaloupka/IFJ-Projekt