CaIiguIa/Kompilatory2023-Translator-Bash-na-Windows-PowerShell

Transpiler z Bash na WindowsPowerShell

---

Spis treści:

1. Opis projektu
   • Cel
   • Technologie
2. Instrukcje użycia
   • Linia komend
   • GUI
3. Instalacja
   • .jar
4. Dokumentacja
   • Uwagi
   • Błędy
5. Autorzy

Opis:

Cel projektu:

Stworzyć translator skryptów napisanych w Bash-u (plik .bs) na ich ekwiwalenty napisane w Windows Power Shell (plik .ps1).

Zastosowane technologie:

1. Java 17 - Link do strony kompilartora którego użyliśmy.
2. Maven - jako narzędzie do budowy projektu.
3. ANTLR4 - generator lexerów i perserów, w implementacji użyliśmy Listener -a.
4. Openjfx - GUI projektu.
5. SceneBuilder - Aplikacja pomagająca w tworzeniu interfejsów graficznych
6. Junit - do testów aplikacji.
7. Inne pomniejsze dependencies np. do parsowania plików .json lub .csv.

Instrukcje użycia:

Aplikację można użytkować na dwa sposoby:

• Jako zwykły program do szybkiej translacji z wiersza poleceń.
• Jako pełny edytor skryptów z bierzącą translacją.

Głównym determinantem, który z tyrybów będziemy użytkować jest to, czy został podany argument odpowiedzialny za start GUI programu.

Funckjonalności lini komend

Nie podano [-g | -G | --GUI] jako argument aplikacji.

Lista dostępnych argumentów do podania w lini komend:

1. [-i | -I | --Input] <Dane>
   • Dane to ścieżka do pliku - tylko ten jeden skrypt zostanie przetworzony.
   • Dane to ścieżka do folderu- wówczas wszystkie pliki w nim zostaną potraktowane jako pliki do translacji.
   • W obu przypadkach pliki nie muszą mieć rozszerzenia .bs.
2. [-o | -O | --Output] <Dane>
   • Dane to ścieżka do folderu - w danym folderze zostaną utworzone pliki o adekwatnej nazwie i rozszerzeniu .ps1.
3. [--NoComments]
   • Flaga ta spowoduje, że komentarze z pliku wejściowego nie są umieszczane w pliku wynikowym.
4. [--NoWarnings]
   • Flaga ta powoduje nie wyświetlanie się ostrzeżeń translatora o niedokładnościach translacji.
5. [--CustomSuffix]
   • Dane to string - Jest to sufix nazwy wygenerowanego pliku umieszczany: <Nazwa pliku wejściowego bez rozszerzenia><Sufix pliku>.ps1
   • Domyślna wartość to _out.
6. [-g | -G | --GUI]
   • Flaga ta sprawia włączenie się GUI oraz neguje wszystekie funckje aplikacji dotyczące lini poleceń.
7. [-h | -H | --Help]
   • Wypisuje informacje o wszystkich możliwych argumentach programu.
8. [-v | -V | --Version]
   • Wypisuje informacje o wersji prograu prosto z pliku .pom mavena.

Uwagi:

• Flagi i argumenty oczywiście podajemy bez nawiasów kwadratowych.
• Kolejność podanych argumentów nie ma znaczenia, jeżeli tylko dane do poszczególnych argumentów są prawidłowo ułożone.

Funckjonalności GUI

Podano [-g | -G | --GUI] jako argument aplikacji.

1. W tym oknie wyświetla się wybrany skrypt w Bashu (.sh)

2. W tym oknie pojawi się skrypt przetłumaczony do Powershell (.ps1)

3. To pole tekstowe przeznaczone jest na ścieżkę do skryptu Basha, który chcesz przetłumaczyć. Można ją wpisać ręcznie, albo wcisnąć przycisk "Choose", wtedy pojawi się okno wyboru pliku

4. Tutaj należy podać katalog wyjściowy w którym znaleźć ma się tłumaczenie. Można go podać ręcznie, albo wcisnąć przycisk "Choose", wtedy pojawi się okno wyboru katalogu

5. W tym polu tekstowym znajduje się suffix doklejany do nazwy pliku wejściowego, aby utworzyć nazwę pliku wyjściowego

6. Jeżeli to pole wyboru zostanie zaznaczone, translator pominie tłumaczenie/przepisywanie komentarzy z pliku wejściowego

7. Jeśli naciśnie się ten przycisk, to plik wejściowy zostanie przetłumaczony, a w dużym polu tekstowym pop prawej (2.) pojawi się przytłumaczony kod

Instalacja:

Wymagania:

• Potrzebana jest wspomniana wcześniej JAVA 17 z linku na początku pliku.

Z pliku .jar:

1. Wejdź w sekcję Releases w repozytorium projektu.
2. Pobierz plik .jar z dostępnych asetów.
3. Zmień katalog na ten, gdzie pobrałeś plik.
4. Użyj komendy:

   java -jar .\Kompilatory2023-Translator-Bash-na-Windows-PowerShell.jar

   
5. Wszystkie wyrazy oddzielone spacjami są traktowane jako kolejne argumenty z lini poleceń dla programu.

Dokumentacja:

Ogólne uwagi

• Całość dokumentacji znajduje się w: [Link]
• Gramatyka w oparciu o którą wygenerowano parser i lexer: [Link]
• Zbiór tokenów w oparciu o który wygenerowano parser i lexer: [Link]
• Przykładowe pliki wyjściowe wygenerowane przez program znajdują się w: [Link]
• Przykładowe skrypty w bashu w oparciu o które stworzono powyżej zamieszczone pliki: [Link]

Zgłaszanie błędów

Jeżeli wykryłeś jakikolwiek błąd, nieprawidłowość w działaniu programu lub też nieścisłość w dokumentacji stwórz Github Issue i przypisz jednego z autorów podanych poniżej.

Autorzy

1. Dominik Breksa - dominikbreksa@student.agh.edu.pl - [Link do githuba]
2. Szymon Jurecki - sdjurecki@student.agh.edu.pl - [Link do githuba]