TC is a simple compiler project created for the purpose of learning the principles of compilers. It includes a basic lexer, a parser, and is designed with an extensible structure.

Before you begin, ensure that gcc is installed in your development environment. You can check this by running the following command in your terminal or command prompt:

gcc --version

If it is not installed, please install it according to your operating system.

• This project is primarily developed using the C17 (GNU17) standard.
• I do not have a macOS device, so it has not been tested on macOS. It has also not yet been tested in a Linux environment.

This project is compiled using gcc.

In a Windows environment, you can build the project by directly running the build.bat batch file located in the tools folder:

.\tools\build.bat

Upon successful compilation, an executable file named program.exe will be generated in the build folder.

On Linux or macOS, please execute the build.sh script found in the tools folder:

./tools/build.sh

Similarly, a successful compilation will produce an executable file named program in the build folder.

The test folder contains several test cases. You can automatically run all tests by executing the run.bat script located in the root directory.

.\test\run.bat

This script will first build the project and then use the compiled program to execute the various test cases in the test folder, comparing the output against expected results.

You can run the compiled program directly, specifying the source code file you wish to compile.

Usage: <executable_file> <source_file> [output_path] [options]

Parameters:

• <executable_file>: The compiled executable (build/program.exe or build/program).
• <source_file>: The TC source file you want to compile (e.g., test/test1/test1.tc).
• [output_path]: (Optional) The directory where output files will be saved. If not specified, it defaults to the current directory.
• [options]: (Optional) Compilation flags.

Available Options:

• -o: Output the compiled result (not yet implemented).
• -a: Output the Abstract Syntax Tree (AST) to output_path/file_name.ast.
• -l: Output the lexer result to output_path/file_name.lex.
• -s: Output the symbol table to output_path/file_name.sym.
• -h: Display this help information.

Example:

# Perform lexical analysis and save the output to the test/test1/ directory
./build/program.exe ./test/test1/test1.tc ./test/test1/ -l

tc/
├── build/              # Build output directory
|   └── program.exe     # Compiled executable
├── include/            # Header files
├── src/                # Source code
|   └── lib.c        # Global data and standard library
├── test/               # Test cases
├── tools/
|   ├── build.sh        # Build script for Linux/macOS
|   └── build.bat       # Build script for Windows
├── .gitignore          # Git ignore file
├── grammar.ebnf        # Grammar file in EBNF format
└── README.md           # This file

TC 是一個為了學習編譯器原理而建立的簡易編譯器專案。它包含了一個基本的詞法分析器、語法分析器，並設計了可擴充的結構。

在開始之前，請確保您的開發環境中已安裝 gcc。您可以透過在終端機或命令提示字元中執行以下指令來檢查：

gcc --version

如果未安裝，請根據您的作業系統進行安裝。

• 本專案主要使用 C17 (GNU17) 標準進行開發。
• 我沒有 macOS 設備，所以沒有測試過它是否能在 macOS 上運作。目前也尚未在 Linux 環境下進行測試。

本專案使用 gcc 進行編譯。

在 Windows 環境下，您可以直接執行 tools 資料夾中的 build.bat 批次檔來建置專案：

.\tools\build.bat

編譯成功後，會在 build 資料夾下產生 program.exe 執行檔。

在 Linux 或 macOS 環境下，請執行 tools 資料夾中的 build.sh 指令碼：

./tools/build.sh

同樣地，編譯成功後會在 build 資料夾下產生 program 執行檔。

專案的 test 資料夾中包含了一些測試案例。您可以透過執行根目錄下的 run.bat 來自動執行所有測試。

.\test\run.bat

此指令碼會先自動建置專案，然後用編譯好的程式去執行 test 資料夾中的各個測試案例，並比對輸出結果。

您可以直接執行編譯好的程式，並指定要編譯的原始碼檔案。

Usage: <executable_file> <source_file> [output_path] [options]

參數說明:

• <executable_file>: 編譯後產生的執行檔 (build/program.exe 或 build/program)。
• <source_file>: 您要編譯的 TC 原始碼檔案 (例如 test/test1/test1.tc)。
• [output_path]: (可選) 指定輸出檔案的存放路徑。如果未指定，預設為當前目錄。
• [options]: (可選) 編譯選項。

可用選項:

• -o: 輸出編譯結果 (目前未實作)。
• -a: 將 AST (抽象語法樹) 輸出到 output_path/file_name.ast。
• -l: 將詞法分析結果輸出到 output_path/file_name.lex。
• -s: 將符號表輸出到 output_path/file_name.sym。
• -h: 顯示說明資訊。

範例:

# 執行詞法分析並將結果輸出到 test/test1/ 資料夾
./build/program.exe ./test/test1/test1.tc ./test/test1/ -l

tc/
├── build/              # 建置輸出目錄
|   └── program.exe     # 編譯後的執行檔
├── include/            # 標頭檔
├── src/                # 原始碼
|   └── lib.c        # 全域資料與標準函式庫
├── test/               # 測試案例
├── tools/
|   ├── build.sh        # Linux/macOS 建置腳本
|   └── build.bat       # Windows 建置腳本
├── .gitignore          # Git 忽略檔案
├── grammar.ebnf        # EBNF 格式的文法檔案
└── README.md           # 本檔案