Skip to content

Commit be30382

Browse files
jarroddavis68jarroddavis68
committed
Repo Update
Initial commit
1 parent 743abf7 commit be30382

File tree

13 files changed

+7796
-2
lines changed

13 files changed

+7796
-2
lines changed

‎.github/workflows/changelog.yml‎

Lines changed: 218 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,218 @@
1+
name: Update Changelog
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
- master
8+
workflow_dispatch:
9+
10+
jobs:
11+
update-changelog:
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- name: Checkout Repository
16+
uses: actions/checkout@v4
17+
with:
18+
fetch-depth: 0
19+
token: ${{ secrets.GITHUB_TOKEN }}
20+
21+
- name: Setup Python
22+
uses: actions/setup-python@v4
23+
with:
24+
python-version: '3.x'
25+
26+
- name: Generate Changelog
27+
run: |
28+
python3 << 'EOF'
29+
import subprocess
30+
import sys
31+
from datetime import datetime
32+
from collections import defaultdict
33+
34+
def run_git_log(args):
35+
try:
36+
result = subprocess.run(['git'] + args, capture_output=True, text=True, check=True)
37+
# FIX #1: Split by a null character instead of a newline to handle multi-line bodies.
38+
return result.stdout.strip().split('\x00') if result.stdout.strip() else []
39+
except subprocess.CalledProcessError as e:
40+
print(f"Error running git: {e}")
41+
sys.exit(1)
42+
43+
def get_commits_by_tag():
44+
try:
45+
latest_tag = subprocess.run(
46+
['git', 'describe', '--tags', '--abbrev=0'],
47+
capture_output=True, text=True, check=True
48+
).stdout.strip()
49+
50+
tag_date = subprocess.run(
51+
['git', 'log', '-1', '--format=%ad', '--date=short', latest_tag],
52+
capture_output=True, text=True, check=True
53+
).stdout.strip()
54+
55+
tagged = run_git_log([
56+
'log', latest_tag,
57+
# FIX #2: Add the %x00 null character as a safe delimiter for commits.
58+
'--pretty=format:%s|||%b|||%an|||%ad|||%H%x00',
59+
'--date=short',
60+
'--invert-grep',
61+
'--grep=docs: update changelog',
62+
'--grep=changelog.yml',
63+
'--grep=\\[skip ci\\]'
64+
])
65+
66+
unreleased = run_git_log([
67+
'log', f'{latest_tag}..HEAD',
68+
# FIX #3: Add the delimiter here as well.
69+
'--pretty=format:%s|||%b|||%an|||%ad|||%H%x00',
70+
'--date=short',
71+
'--invert-grep',
72+
'--grep=docs: update changelog',
73+
'--grep=changelog.yml',
74+
'--grep=\\[skip ci\\]'
75+
])
76+
77+
return {
78+
'tagged': {latest_tag: {'commits': tagged, 'date': tag_date}},
79+
'unreleased': unreleased
80+
}
81+
82+
except subprocess.CalledProcessError:
83+
all_commits = run_git_log([
84+
'log',
85+
# FIX #4: And add the delimiter here for the fallback case.
86+
'--pretty=format:%s|||%b|||%an|||%ad|||%H%x00',
87+
'--date=short',
88+
'--invert-grep',
89+
'--grep=docs: update changelog',
90+
'--grep=changelog.yml',
91+
'--grep=\\[skip ci\\]'
92+
])
93+
return {
94+
'tagged': {},
95+
'unreleased': all_commits
96+
}
97+
98+
def categorize_commit(subject, body):
99+
text = (subject + ' ' + body).lower()
100+
if any(x in text for x in ['security', 'vulnerability', 'cve', 'exploit']):
101+
return 'security'
102+
if any(x in text for x in ['breaking change', 'breaking:', 'break:']):
103+
return 'breaking'
104+
if any(x in text for x in ['deprecat', 'obsolete', 'phase out']):
105+
return 'deprecated'
106+
if any(x in text for x in ['remove', 'delete', 'drop', 'eliminate']):
107+
return 'removed'
108+
# Correction: Check for 'added' keywords before 'fixed' keywords.
109+
if any(x in text for x in ['add', 'new', 'create', 'implement', 'feat', 'feature']):
110+
return 'added'
111+
if any(x in text for x in ['fix', 'resolve', 'correct', 'patch', 'bug', 'issue']):
112+
return 'fixed'
113+
return 'changed'
114+
115+
def format_commit_entry(commit):
116+
entry = f"- **{commit['subject']}** ({commit['date']} – {commit['author']})"
117+
body = commit['body'].replace('\\n', '\n')
118+
if body.strip():
119+
lines = [line.strip() for line in body.splitlines() if line.strip()]
120+
for line in lines:
121+
entry += f"\n {line}"
122+
return entry + "\n"
123+
124+
def parse_commits(lines):
125+
commits = []
126+
for line in lines:
127+
if not line: continue
128+
parts = line.split('|||')
129+
if len(parts) >= 5:
130+
subject, body, author, date, hash_id = map(str.strip, parts)
131+
commits.append({
132+
'subject': subject,
133+
'body': body,
134+
'author': author,
135+
'date': date,
136+
'hash': hash_id[:7]
137+
})
138+
return commits
139+
140+
def build_changelog(commits_by_version):
141+
sections = [
142+
('security', 'Security'),
143+
('breaking', 'Breaking Changes'),
144+
('deprecated', 'Deprecated'),
145+
('added', 'Added'),
146+
('changed', 'Changed'),
147+
('fixed', 'Fixed'),
148+
('removed', 'Removed')
149+
]
150+
151+
lines = [
152+
"# Changelog",
153+
"",
154+
"All notable changes to this project will be documented in this file.",
155+
"",
156+
"The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),",
157+
"and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).",
158+
""
159+
]
160+
161+
unreleased = parse_commits(commits_by_version['unreleased'])
162+
if unreleased:
163+
lines.append("## [Unreleased]")
164+
lines.append("")
165+
categorized = defaultdict(list)
166+
for commit in unreleased:
167+
cat = categorize_commit(commit['subject'], commit['body'])
168+
categorized[cat].append(commit)
169+
170+
for key, label in sections:
171+
if categorized[key]:
172+
lines.append(f"### {label}")
173+
for commit in categorized[key]:
174+
lines.append(format_commit_entry(commit))
175+
lines.append("")
176+
else:
177+
lines.append("## [Unreleased]\n")
178+
lines.append("_No unreleased changes._\n")
179+
180+
for tag, info in commits_by_version['tagged'].items():
181+
commits = parse_commits(info['commits'])
182+
lines.append(f"## [{tag}] - {info['date']}\n")
183+
categorized = defaultdict(list)
184+
for commit in commits:
185+
cat = categorize_commit(commit['subject'], commit['body'])
186+
categorized[cat].append(commit)
187+
188+
for key, label in sections:
189+
if categorized[key]:
190+
lines.append(f"### {label}")
191+
for commit in categorized[key]:
192+
lines.append(format_commit_entry(commit))
193+
lines.append("")
194+
195+
return "\n".join(lines)
196+
197+
try:
198+
commit_data = get_commits_by_tag()
199+
changelog = build_changelog(commit_data)
200+
with open("CHANGELOG.md", "w", encoding="utf-8") as f:
201+
f.write(changelog)
202+
print("Changelog generated.")
203+
except Exception as e:
204+
print(f"Error generating changelog: {e}")
205+
sys.exit(1)
206+
EOF
207+
208+
- name: Commit Updated Changelog
209+
run: |
210+
git config --local user.email "[email protected]"
211+
git config --local user.name "GitHub Action"
212+
git add CHANGELOG.md
213+
if git diff --staged --quiet; then
214+
echo "No changes to commit"
215+
else
216+
git commit -m "docs: update changelog [skip ci]"
217+
git push
218+
fi

‎.gitignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,3 +80,9 @@ __recovery/
8080

8181
# Boss dependency manager vendor folder https://github.com/HashLoad/boss
8282
modules/
83+
_checkpoint.cmd
84+
bin/output/HelloWorld.ll
85+
bin/output/HelloWorld.obj
86+
changes-diff.cmd
87+
changes.diff
88+
zip_latest_commit.cmd

‎README.md‎

Lines changed: 153 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,153 @@
1-
# libLLVM
2-
LLVM Compiler Infrastructure for Delphi
1+
![libLLVM](media/libllvm.png)
2+
[![Chat on Discord](https://img.shields.io/discord/754884471324672040?style=for-the-badge)](https://discord.gg/tinyBigGAMES) [![Follow on Bluesky](https://img.shields.io/badge/Bluesky-tinyBigGAMES-blue?style=for-the-badge&logo=bluesky)](https://bsky.app/profile/tinybiggames.com)
3+
> 🚧 **libLLVM is Work in Progress**
4+
>
5+
> libLLVM is currently under active development and evolving quickly. Some features described in this documentation may be incomplete, experimental, or subject to significant changes as the project matures.
6+
>
7+
> We welcome your feedback, ideas, and issue reports – your input will directly influence the direction and quality of libLLVM as we strive to build the ultimate LLVM integration for Delphi.
8+
9+
## LLVM Power, Delphi Simplicity
10+
11+
libLLVM brings the full power of **LLVM's compilation infrastructure directly to Delphi**, providing native bindings for code generation, optimization, and linking with clean, Pascal-style integration.
12+
13+
### Why libLLVM?
14+
15+
- **🚀 Native LLVM Integration** - Direct access to LLVM's world-class compilation and optimization engine
16+
- **🔗 Built-in LLD Support** - Integrated linking with LLVM's modern linker for all target platforms
17+
- **📖 Delphi-Native Design** - Clean Pascal syntax with proper resource management and UTF-8 handling
18+
- **⚡ Zero-Copy Interop** - Efficient string marshalling and memory management for high-performance compilation
19+
- **🔧 Production Ready** - Robust error handling, proper cleanup, and battle-tested integration patterns
20+
21+
## Quick Example
22+
23+
```pascal
24+
procedure CompileAndLink();
25+
var
26+
LArgs: TArray<string>;
27+
LRC: Integer;
28+
LCanRunAgain: Boolean;
29+
begin
30+
// Generate LLVM IR and compile to object file
31+
GenerateIRAndCompile('HelloWorld.ll', 'HelloWorld.obj');
32+
33+
// Link with LLD
34+
LArgs := [
35+
'lld-link',
36+
'/nologo',
37+
'/subsystem:console',
38+
'/entry:main',
39+
'/out:HelloWorld.exe',
40+
'HelloWorld.obj',
41+
'kernel32.lib',
42+
'msvcrt.lib',
43+
'legacy_stdio_definitions.lib'
44+
];
45+
46+
LRC := LLDLink(LArgs, 'coff', LCanRunAgain);
47+
48+
if LRC = 0 then
49+
Writeln('✅ Compilation successful!')
50+
else
51+
Writeln('❌ Compilation failed with code: ', LRC);
52+
end;
53+
```
54+
55+
## Key Features
56+
57+
### 🎯 **Complete LLVM Bindings**
58+
- Full LLVM-C API coverage for contexts, modules, and IR generation
59+
- Target machine support for all LLVM-supported architectures
60+
- Memory buffer management with automatic cleanup
61+
- Comprehensive error handling with proper Pascal exceptions
62+
63+
### 🔗 **Integrated LLD Linking**
64+
```pascal
65+
function LLDLink(const AArgs: array of string; const AFlavor: string;
66+
out ACanRunAgain: Boolean): Integer;
67+
var
68+
LUTF8Args: TArray<UTF8String>;
69+
LArgv: TArray<PUTF8Char>;
70+
begin
71+
// Robust UTF-8 string handling
72+
SetLength(LUTF8Args, Length(AArgs));
73+
SetLength(LArgv, Length(AArgs) + 1);
74+
75+
// Convert and null-terminate for C interop
76+
for LIdx := 0 to High(AArgs) do
77+
begin
78+
LUTF8Args[LIdx] := UTF8String(AArgs[LIdx]);
79+
LArgv[LIdx] := PUTF8Char(LUTF8Args[LIdx]);
80+
end;
81+
LArgv[High(LArgv)] := nil;
82+
83+
Result := LLD_Link(Length(LUTF8Args), @LArgv[0],
84+
PUTF8Char(UTF8String(AFlavor)), @LCan);
85+
end;
86+
```
87+
88+
### ⚙️ **Resource Management**
89+
```pascal
90+
// Automatic cleanup with proper try/finally blocks
91+
LCtx := LLVMContextCreate();
92+
LMod := nil;
93+
LTM := nil;
94+
try
95+
// LLVM operations...
96+
LMod := LLVMModuleCreateWithNameInContext(AsUTF8('hello'), LCtx);
97+
LTM := LLVMCreateTargetMachine(/* ... */);
98+
99+
// Code generation...
100+
101+
finally
102+
if LTM <> nil then LLVMDisposeTargetMachine(LTM);
103+
if LMod <> nil then LLVMDisposeModule(LMod);
104+
if LCtx <> nil then LLVMContextDispose(LCtx);
105+
end;
106+
```
107+
108+
### 🏗️ **Modern Architecture Support**
109+
```pascal
110+
// Multi-target compilation
111+
LLVMInitializeX86TargetInfo(); // x86/x64
112+
LLVMInitializeARMTargetInfo(); // ARM/ARM64
113+
LLVMInitializeWebAssemblyTarget(); // WebAssembly
114+
115+
// Flexible target specification
116+
LTripleStr := 'x86_64-pc-windows-msvc'; // Windows
117+
LTripleStr := 'x86_64-unknown-linux-gnu'; // Linux
118+
LTripleStr := 'aarch64-apple-darwin'; // macOS ARM64
119+
```
120+
121+
### 📦 **Cross-Platform Linking**
122+
```pascal
123+
// Windows COFF linking
124+
LRC := LLDLink(LWindowsArgs, 'coff', LCanRunAgain);
125+
126+
// Linux ELF linking
127+
LRC := LLDLink(LLinuxArgs, 'elf', LCanRunAgain);
128+
129+
// macOS Mach-O linking
130+
LRC := LLDLink(LMacArgs, 'darwin', LCanRunAgain);
131+
132+
// WebAssembly linking
133+
LRC := LLDLink(LWasmArgs, 'wasm', LCanRunAgain);
134+
```
135+
136+
## Getting Started
137+
138+
1. **Include the LLVM headers** in your Delphi project
139+
2. **Initialize target architectures** you plan to support
140+
3. **Create LLVM contexts and modules** for your compilation units
141+
4. **Generate IR or parse existing LLVM IR** files
142+
5. **Compile to object files** using target machines
143+
6. **Link with LLD** for final executable generation
144+
145+
---
146+
147+
<div align="center">
148+
149+
**Built with ❤️ by [tinyBigGAMES](https://tinybiggames.com)**
150+
151+
*"Where LLVM meets Pascal"*
152+
153+
</div>

0 commit comments

Comments
 (0)