Compare commits
321 commits
Author | SHA1 | Date | |
---|---|---|---|
8bd0896415 | |||
20580fb80b | |||
a45f010196 | |||
69cf668c4d | |||
7560e150af | |||
b643735d0b | |||
d12206b925 | |||
dde8972feb | |||
6425442c25 | |||
d1d8e305ed | |||
a6a41f5cec | |||
7cf9a4f418 | |||
ea93d12151 | |||
c533a06148 | |||
4281f946be | |||
5021f2cc35 | |||
edd28bef2f | |||
7c0b7e1e90 | |||
0966a43d5e | |||
2730aa0f61 | |||
ed1c8b9d3e | |||
d3a01c2c66 | |||
a21ef1bc5f | |||
a619746e8d | |||
e42ac8a08e | |||
ffcf4604a4 | |||
6f8d190d6f | |||
c2028cfa33 | |||
40894bedba | |||
6d7701a7c3 | |||
665ea05041 | |||
37ac235662 | |||
01ea995177 | |||
294ec217ea | |||
4c9bfb3732 | |||
f6c99b66e8 | |||
643bda6c28 | |||
281e7db708 | |||
2d558f8482 | |||
0d5f19ee31 | |||
8456e92a52 | |||
d0a68b22d2 | |||
2cf769b599 | |||
25a944baf4 | |||
f4019455cc | |||
cdde093b31 | |||
8a52e991fd | |||
6cd38377b2 | |||
bed5811b70 | |||
1e6fa79716 | |||
cdd68833cb | |||
175b0248d9 | |||
b3ef38b6be | |||
10e3b26ac0 | |||
7a7da3729c | |||
2f0bc19e7c | |||
9d19dd8b57 | |||
bd05235af9 | |||
a0fdfd2722 | |||
a77794b105 | |||
3bd6a26e59 | |||
5e829771a7 | |||
9922c672f6 | |||
0075b465cd | |||
46b52173fd | |||
26294b3fa0 | |||
f81d27060a | |||
dd4ebcd88a | |||
02aa744098 | |||
a4224f9c51 | |||
b68a7855dc | |||
f1b3bb5b88 | |||
38d8deefa7 | |||
b26517958a | |||
b675a5ffb2 | |||
796eb9c8f9 | |||
a9125c9bea | |||
3d3f21e217 | |||
a00fdea6f5 | |||
0fed87328a | |||
0fbfe8f4e3 | |||
ebbc1778ae | |||
a9cfc8c810 | |||
45f02bdd5a | |||
a3ea583e41 | |||
c14e34cd81 | |||
c473c27298 | |||
54b7b9a695 | |||
5766072fd7 | |||
b49ff9a569 | |||
f342555b8a | |||
9be753b4df | |||
f96584ccd9 | |||
a870cbe11b | |||
dffd24d8bb | |||
e9e57a732a | |||
6696dc5700 | |||
6ee1dc8e12 | |||
104e378856 | |||
4bbc1fd683 | |||
770c9b5c6e | |||
c9bf6126a0 | |||
e21ea102c7 | |||
21973ffe6c | |||
390a5cd227 | |||
4f7a741088 | |||
ede254c7f4 | |||
2b9487f2a9 | |||
48b0126e5c | |||
9b97390a9c | |||
6c3c449416 | |||
9cd888299f | |||
07cbbb9bb3 | |||
8caafd6d01 | |||
0252776195 | |||
6785ec64d3 | |||
fbcb00c481 | |||
25c9f45817 | |||
d4c8494b34 | |||
889d106470 | |||
c33e3d3e27 | |||
dedcdad002 | |||
2529898e19 | |||
483afa1e45 | |||
cfb52106dc | |||
794f8bb471 | |||
f25dd19e98 | |||
07614d4519 | |||
db10965c69 | |||
f578360395 | |||
6e7d660d70 | |||
a3ca81498e | |||
0d4fa85c91 | |||
b974ce22b0 | |||
34be192d5b | |||
d1fa759d0a | |||
6a2a18095b | |||
b4f5829375 | |||
b3968d8469 | |||
d06f8a3dc3 | |||
f1fb21dbb1 | |||
5284dfe17b | |||
8ea4594e6f | |||
f880122add | |||
2fedc981af | |||
5718f33d88 | |||
98ff132d27 | |||
c90406dac9 | |||
ae790dbd18 | |||
701f316950 | |||
a550f0a16a | |||
ef613acc59 | |||
29ac99c478 | |||
ca3bf94a48 | |||
ad7b3568cf | |||
48c326ad71 | |||
fb82c9c4b0 | |||
971f81a626 | |||
70ff609b77 | |||
54cde09be3 | |||
43e038d3ec | |||
781f1c113c | |||
f828d31094 | |||
9ff4f96814 | |||
ed9c94f17c | |||
94fb91197a | |||
35cfc75a04 | |||
03d53fc997 | |||
eb108495ea | |||
736dbed1f3 | |||
b993124f41 | |||
db56c0538a | |||
99e0f77fd1 | |||
1405c12626 | |||
b7afa4bb5e | |||
d5b7c599a8 | |||
649a3d7479 | |||
57b2f000c7 | |||
f03563229b | |||
63a896874f | |||
e95f6c8e71 | |||
1bca312745 | |||
05b9644eba | |||
081ac106f4 | |||
72b40613b8 | |||
db52346168 | |||
e8ec0ed530 | |||
ae8010a271 | |||
58b9b268a1 | |||
468e206fab | |||
8f12e8b0c8 | |||
78b12dee67 | |||
1713c9c8a8 | |||
949655b020 | |||
747d08d354 | |||
34f61211d3 | |||
2fc0f53b5d | |||
669be13dfa | |||
30a32cad8c | |||
b2027c8d8e | |||
9db7f20c2e | |||
611d4b823e | |||
1a56f42287 | |||
c984974252 | |||
bd70b17236 | |||
f0c19010d9 | |||
a261d7914e | |||
d406fa0e3d | |||
02001103d6 | |||
8792813e34 | |||
5187b37e53 | |||
6a821145a6 | |||
f383261ed9 | |||
5be690fd38 | |||
9dc0f549d4 | |||
2d61b027b3 | |||
3c09713867 | |||
cbf434ed45 | |||
006283acff | |||
3503d10c44 | |||
d4c5b982df | |||
935bbaf7ce | |||
45307ab842 | |||
165e57083b | |||
9c48c3c756 | |||
7f324090c1 | |||
b529b7a7af | |||
4f9154f5fc | |||
e787680e8c | |||
e5f7b0e580 | |||
b9d4196b8b | |||
bbde2e9d2d | |||
0b4502c3ce | |||
6dc0566fed | |||
be144fb71b | |||
24e26e6a82 | |||
f5af9b34a0 | |||
eea7fce13c | |||
6c0244053b | |||
ef40c04877 | |||
ee40ac5826 | |||
b6a90eb795 | |||
2d8e896333 | |||
d49d54df3a | |||
81535ad701 | |||
5909a948b5 | |||
a07dc6db84 | |||
062b68a93b | |||
ae201f8729 | |||
86e85356ba | |||
2899ba2e8a | |||
ec3ecc0113 | |||
7b70cf8511 | |||
2f963e86ef | |||
805574f677 | |||
e754c2c248 | |||
48f910e78f | |||
e7e1abc510 | |||
90b6dbcd31 | |||
e695235277 | |||
42d0feb574 | |||
260464d727 | |||
a0a89d2f3c | |||
67909e9cc3 | |||
ce97838c12 | |||
071534eb1c | |||
bca45488d1 | |||
b277587ec8 | |||
fa8086f198 | |||
4dbbee4efa | |||
f3acca7456 | |||
e8b9642177 | |||
aaa81e2f87 | |||
9d3397888d | |||
8b09290c81 | |||
80478e6a69 | |||
2469e124bd | |||
350b18219b | |||
5cb8350a41 | |||
705f8a0623 | |||
c194cf2001 | |||
55091d3cd1 | |||
09b244ef74 | |||
b1a56ea6a4 | |||
051f3eaacc | |||
7962a15c12 | |||
311de39899 | |||
56743e9bf0 | |||
de0d5cb8a8 | |||
a3849f1813 | |||
00a3017c1e | |||
bf7a450be5 | |||
3964512979 | |||
9f638c486c | |||
85e6cd69de | |||
be74555064 | |||
bd6cc73a94 | |||
0c626cc995 | |||
0ce24d677f | |||
ccc6c31cc9 | |||
10abe1d3f0 | |||
d36e36a1d3 | |||
b17d354a9b | |||
4752dd6918 | |||
38c5f0e5b9 | |||
ca0274bbb1 | |||
4d2a78af2b | |||
050befbb73 | |||
97dcc5263b | |||
8470d37f37 | |||
bffe68c015 | |||
481ce80535 | |||
31b1a2d199 | |||
0c77f50609 | |||
85bff3b14d | |||
5697522641 | |||
97a0218bf6 | |||
dd7bc714b9 | |||
4a8d58d6cc | |||
e65c3e2662 | |||
6cfaf88bca |
384 changed files with 20909 additions and 10533 deletions
117
.forgejo/issue_template/bugreport.yml
Normal file
117
.forgejo/issue_template/bugreport.yml
Normal file
|
@ -0,0 +1,117 @@
|
||||||
|
name: "⚠️ Bug report"
|
||||||
|
about: "Report a bug in the engine."
|
||||||
|
title: "bug: "
|
||||||
|
labels:
|
||||||
|
- "Bug/New"
|
||||||
|
body:
|
||||||
|
- type: "markdown"
|
||||||
|
id: "text-introduction"
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Hey there! Thank you for taking the time to report a bug to us. \
|
||||||
|
This means a lot to us, as that's the only way to get better... and many people don't file bug reports. \
|
||||||
|
Anyway, please answer the following questions accurately, otherwise we may not be able to diagnose the issue. \
|
||||||
|
\
|
||||||
|
**Please check if the same bug report already exists. If so, participate in that one instead. If another issue is similar, make sure to mention the related issues.** \
|
||||||
|
**Please don't censor anything *except* sensitive information. You don't need to be embarrased about your username. You censor your bug report, we censor our answers.**
|
||||||
|
- type: "textarea"
|
||||||
|
id: "bug-description"
|
||||||
|
attributes:
|
||||||
|
label: "Bug description"
|
||||||
|
description: "Explain what the bug is about. Include as many details as possible."
|
||||||
|
placeholder: "My cat spontaneously explodes when I try to download from `https://yourdick.zip`."
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: "textarea"
|
||||||
|
id: "bug-log"
|
||||||
|
attributes:
|
||||||
|
label: "Bug log"
|
||||||
|
description: |
|
||||||
|
Please insert the ENTIRE log output here, so we can understand the problem at hand. \
|
||||||
|
You must give us `DIAGNOSTIC` level logs (pass `-Dsosengine.base.loggerLevel=diagnostic` to the JVM) with the default log template.
|
||||||
|
|
||||||
|
**This field can be left empty if the bug does not involve/require log output.**
|
||||||
|
placeholder: "Your log file here..."
|
||||||
|
value: |
|
||||||
|
```plain
|
||||||
|
Your log file here...
|
||||||
|
```
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: "textarea"
|
||||||
|
id: "bug-snippet"
|
||||||
|
attributes:
|
||||||
|
label: "Bug snippet"
|
||||||
|
description: |
|
||||||
|
Please insert a snippet of the (application and/or engine) code which you think is causing the issue.
|
||||||
|
|
||||||
|
**This field can be left empty if you intend on supplying a reproduction project.**
|
||||||
|
value: |
|
||||||
|
```java
|
||||||
|
Your code snippet here...
|
||||||
|
```
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: "textarea"
|
||||||
|
id: "bug-reproduce"
|
||||||
|
attributes:
|
||||||
|
label: "Bug reproduction guide"
|
||||||
|
description: |
|
||||||
|
Explain how we can reproduce this bug as easy as possible, step by step.
|
||||||
|
|
||||||
|
**This field can be left empty if the bug does not involve/require a reproduction guide.**
|
||||||
|
placeholder: |
|
||||||
|
1. Pass "-Dsosengine.base.optimizeLogging=false" to the JVM
|
||||||
|
2. Override logging implementation
|
||||||
|
2. Initialize engine
|
||||||
|
4. The nearest cat should explode in the next few seconds
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: "input"
|
||||||
|
id: "bug-reproduce-project"
|
||||||
|
attributes:
|
||||||
|
label: "Bug reproduction project"
|
||||||
|
description: |
|
||||||
|
Drop a link to some repository or zip file of an example project showcasing the bug.
|
||||||
|
|
||||||
|
**Only supply a repro project if the bug is a bit more advanced, needs specific timing, etc..** \
|
||||||
|
**Also please make sure that the bug actually occurs in the example project!**"
|
||||||
|
placeholder: "https://your.reproduction.project/download/url/here"
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: "input"
|
||||||
|
id: "engine-version"
|
||||||
|
attributes:
|
||||||
|
label: "Full engine version"
|
||||||
|
description: |
|
||||||
|
Input the full engine version here.
|
||||||
|
Simply copy the `Initialized sos!engine v<version> (commit <commit>-<branch>, dirty <dirty>) in <inittime>ms` message here.
|
||||||
|
placeholder: "Example: sos!engine v1-alpha4 (commit 05b9644eba5263809b6655dabb92669523a95805-develop, dirty true)"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: "dropdown"
|
||||||
|
id: "jvm-java"
|
||||||
|
attributes:
|
||||||
|
label: "Java version"
|
||||||
|
description: "Which Java version is your application compiled against?"
|
||||||
|
options:
|
||||||
|
- "20 and lower"
|
||||||
|
- "21"
|
||||||
|
- "22"
|
||||||
|
- "23"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: "input"
|
||||||
|
id: "os"
|
||||||
|
attributes:
|
||||||
|
label: "Operating system"
|
||||||
|
description: "Name the operating system, version (if applicable) and CPU architecture the error occurs on. This may be some Linux distribution, Android or Windoze on `amd64`/`aarch64`/`ppc64`/etc.."
|
||||||
|
placeholder: "Example: Debian trixie (amd64)"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: "markdown"
|
||||||
|
id: "text-tysm"
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thank you for filling out this bug report.
|
||||||
|
Please check your answers for *mistaeks* or sensitive information before sending this report.
|
5
.forgejo/issue_template/config.yml
Normal file
5
.forgejo/issue_template/config.yml
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
blank_issues_enabled: false
|
||||||
|
contact_links:
|
||||||
|
- name: "📚 Documentation"
|
||||||
|
about: "Visit the documentation. Maybe you just skipped something important or just haven't found the page you're looking for yet."
|
||||||
|
url: "https://engine.staropensource.de"
|
20
.forgejo/issue_template/empty.yml
Normal file
20
.forgejo/issue_template/empty.yml
Normal file
|
@ -0,0 +1,20 @@
|
||||||
|
name: "👾 Empty"
|
||||||
|
about: "A clean slate. Only use this one for specific, special cases."
|
||||||
|
title: "empty: "
|
||||||
|
labels:
|
||||||
|
- "Empty"
|
||||||
|
body:
|
||||||
|
- type: "markdown"
|
||||||
|
id: "introduction"
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
This issue template is meant for specific, special cases, where an empty issue template may be wanted.
|
||||||
|
You should *NOT* use this template to write bug reports, feature or help requests.
|
||||||
|
This issue template should ideally only be used by the repository maintainer.
|
||||||
|
- type: "textarea"
|
||||||
|
id: "content"
|
||||||
|
attributes:
|
||||||
|
label: "Issue content"
|
||||||
|
description: "Write your issue content here."
|
||||||
|
validations:
|
||||||
|
required: true
|
61
.forgejo/issue_template/featurerequest.yml
Normal file
61
.forgejo/issue_template/featurerequest.yml
Normal file
|
@ -0,0 +1,61 @@
|
||||||
|
name: "✨ Feature Request"
|
||||||
|
about: "Request a feature to be implemented in the engine."
|
||||||
|
title: "feat: "
|
||||||
|
labels:
|
||||||
|
- "FeatureRequest/New"
|
||||||
|
body:
|
||||||
|
- type: "markdown"
|
||||||
|
id: "text-introduction"
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Hey there! Thank you for taking the time to request a feature to us. \
|
||||||
|
Before filling any of this out, please think for one minute if the feature is really important and necessary enough to implement in the engine. If you're unsure, continue. \
|
||||||
|
Please answer the following questions accurately, or we may not be able to implement the feature as you requested it. \
|
||||||
|
\
|
||||||
|
**Please check if the same feature request already exists. If so, participate in that one instead. If another issue is similar, make sure to mention the related issues.** \
|
||||||
|
**Please don't censor anything *except* sensitive information. You don't need to be embarrased about your username. You censor your bug report, we censor our answers.** \
|
||||||
|
**Submitting a feature request will *not* gurantee it's inclusion into the engine. By submitting a feature request, you are at the grace of the community to pick up your suggestion.**
|
||||||
|
- type: "textarea"
|
||||||
|
id: "feature-description"
|
||||||
|
attributes:
|
||||||
|
label: "Feature description"
|
||||||
|
description: "Explain *what* you want added. Include as many details as possible."
|
||||||
|
placeholder: |
|
||||||
|
Example:
|
||||||
|
I want to do X in my project, which would simplify doing Y.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: "textarea"
|
||||||
|
id: "feature-implementation"
|
||||||
|
attributes:
|
||||||
|
label: "Feature implementation"
|
||||||
|
description: |
|
||||||
|
Explain *how* you want it added. Include as many details as possible.
|
||||||
|
Also explore alternative ways of implementing the feature in the engine (if possible).
|
||||||
|
placeholder: |
|
||||||
|
Example:
|
||||||
|
I would propose to <some description on how to implement your feature>.
|
||||||
|
I've also thought on simply <some other description on how to implement your feature>.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: "textarea"
|
||||||
|
id: "feature-alternatives"
|
||||||
|
attributes:
|
||||||
|
label: "Feature alternatives"
|
||||||
|
description: |
|
||||||
|
Explain how to implement the feature without building it into the engine directly. Include as many details as possible.
|
||||||
|
|
||||||
|
**Leave empty if it can't simply be solved by creating a subsystem.**
|
||||||
|
placeholder: |
|
||||||
|
Example:
|
||||||
|
I've considered writing a subsystem for this feature.
|
||||||
|
Otherwise it would be possible to use <link to some project> with some configuration.
|
||||||
|
I've also considered using the normal way of doing it by <how to do it using the normal way>.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: "markdown"
|
||||||
|
id: "text-tysm"
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thank you for filling out this feature request form.
|
||||||
|
Please check your answers for *mistaeks* before sending this report.
|
89
.forgejo/issue_template/helprequest.yml
Normal file
89
.forgejo/issue_template/helprequest.yml
Normal file
|
@ -0,0 +1,89 @@
|
||||||
|
name: "💬 Help"
|
||||||
|
about: "Request help."
|
||||||
|
title: "help: "
|
||||||
|
labels:
|
||||||
|
- "Help/Wanted"
|
||||||
|
body:
|
||||||
|
- type: "markdown"
|
||||||
|
id: "text-introduction"
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Hey there! Seems like you have some kind of issue with the StarOpenSource Engine. \
|
||||||
|
Please answer the following questions accurately, otherwise we may not be able to help you. \
|
||||||
|
\
|
||||||
|
**Please check if the same help request already exists. If so, participate in that one instead. If another issue is similar, make sure to mention the related issues.** \
|
||||||
|
**Please don't censor anything *except* sensitive information. You don't need to be embarrased about your username. You censor your stuff, we censor our answers.**
|
||||||
|
- type: "textarea"
|
||||||
|
id: "help-description"
|
||||||
|
attributes:
|
||||||
|
label: "Problem description"
|
||||||
|
description: "Explain what your problem is as detailed as possible."
|
||||||
|
placeholder: "How can I create a custom LoggerImplementation implementation?"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: "textarea"
|
||||||
|
id: "help-log"
|
||||||
|
attributes:
|
||||||
|
label: "Log"
|
||||||
|
description: |
|
||||||
|
Please insert the ENTIRE log output here, so we can understand the problem at hand. \
|
||||||
|
You must give us `DIAGNOSTIC` level logs (pass `-Dsosengine.base.loggerLevel=diagnostic` to the JVM) with the default log template.
|
||||||
|
|
||||||
|
*This field can be left empty if the problem you are faciing does not involve/require log output.**
|
||||||
|
placeholder: "Your log file here..."
|
||||||
|
value: |
|
||||||
|
```plain
|
||||||
|
Your log file here...
|
||||||
|
```
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: "textarea"
|
||||||
|
id: "help-snippet"
|
||||||
|
attributes:
|
||||||
|
label: "Code snippet"
|
||||||
|
description: |
|
||||||
|
Please insert a snippet of the application code which you think is causing the issue.
|
||||||
|
|
||||||
|
**This field can be left empty if the problem you are faciing does not involve/require code.**
|
||||||
|
value: |
|
||||||
|
```java
|
||||||
|
Your code snippet here...
|
||||||
|
```
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: "input"
|
||||||
|
id: "engine-version"
|
||||||
|
attributes:
|
||||||
|
label: "Full engine version"
|
||||||
|
description: |
|
||||||
|
Input the full engine version here.
|
||||||
|
Simply copy the `Initialized sos!engine v<version> (commit <commit>-<branch>, dirty <dirty>) in <inittime>ms` message here.
|
||||||
|
placeholder: "Example: sos!engine v1-alpha4 (commit 05b9644eba5263809b6655dabb92669523a95805-develop, dirty true)"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: "dropdown"
|
||||||
|
id: "jvm-java"
|
||||||
|
attributes:
|
||||||
|
label: "Java version"
|
||||||
|
description: "Which Java version is your application compiled against?"
|
||||||
|
options:
|
||||||
|
- "20 and lower"
|
||||||
|
- "21"
|
||||||
|
- "22"
|
||||||
|
- "23"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: "input"
|
||||||
|
id: "os"
|
||||||
|
attributes:
|
||||||
|
label: "Operating system"
|
||||||
|
description: "Name the operating system, version (if applicable) and CPU architecture the error occurs on. This may be some Linux distribution, Android or Windoze on `amd64`/`aarch64`/`ppc64`/etc.."
|
||||||
|
placeholder: "Example: Debian trixie (amd64)"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: "markdown"
|
||||||
|
id: "text-tysm"
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thank you for filling out this help form.
|
||||||
|
Please check your answers for *mistaeks* or sensitive information before sending this help request.
|
12
.forgejo/pull_request_template.md
Normal file
12
.forgejo/pull_request_template.md
Normal file
|
@ -0,0 +1,12 @@
|
||||||
|
---
|
||||||
|
name: 'Pull Request'
|
||||||
|
about: 'Submit a pull request.'
|
||||||
|
title: 'new: '
|
||||||
|
ref: 'develop'
|
||||||
|
labels:
|
||||||
|
- 'PRStatus/Open'
|
||||||
|
- 'PR/New'
|
||||||
|
---
|
||||||
|
<!--
|
||||||
|
Please list your changes here.
|
||||||
|
-->
|
125
.forgejo/workflows/commit.yml
Normal file
125
.forgejo/workflows/commit.yml
Normal file
|
@ -0,0 +1,125 @@
|
||||||
|
name: build-and-test
|
||||||
|
|
||||||
|
on:
|
||||||
|
- pull_request
|
||||||
|
- push
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: docker
|
||||||
|
container:
|
||||||
|
image: git.staropensource.de/staropensource/actions-docker:java
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: https://code.forgejo.org/actions/checkout@v4
|
||||||
|
- name: Restore Gradle cache
|
||||||
|
uses: actions/cache/restore@v4
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.gradle/caches
|
||||||
|
~/.gradle/wrapper
|
||||||
|
key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
|
||||||
|
restore-keys: |
|
||||||
|
gradle-${{ runner.os }}-
|
||||||
|
- name: Compile
|
||||||
|
run: ./gradlew --no-daemon jar javadocJar sourceJar
|
||||||
|
- name: Save Gradle cache
|
||||||
|
uses: actions/cache/save@v4
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.gradle/caches
|
||||||
|
~/.gradle/wrapper
|
||||||
|
key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
|
||||||
|
restore-keys: |
|
||||||
|
gradle-${{ runner.os }}-
|
||||||
|
- name: Upload library JARs
|
||||||
|
uses: https://code.forgejo.org/forgejo/upload-artifact@v4
|
||||||
|
with:
|
||||||
|
name: jars-libraries
|
||||||
|
path: |
|
||||||
|
**/build/libs/*.jar
|
||||||
|
!**/build/libs/*-javadoc.jar
|
||||||
|
!**/build/libs/*-sources.jar
|
||||||
|
if-no-files-found: error
|
||||||
|
- name: Upload API documentation JARs
|
||||||
|
uses: https://code.forgejo.org/forgejo/upload-artifact@v4
|
||||||
|
with:
|
||||||
|
name: jars-apidocs
|
||||||
|
path: |
|
||||||
|
**/build/libs/*-javadoc.jar
|
||||||
|
if-no-files-found: error
|
||||||
|
- name: Upload source JARs
|
||||||
|
uses: https://code.forgejo.org/forgejo/upload-artifact@v4
|
||||||
|
with:
|
||||||
|
name: jars-sources
|
||||||
|
path: |
|
||||||
|
**/build/libs/*-sources.jar
|
||||||
|
if-no-files-found: error
|
||||||
|
generate-javadoc:
|
||||||
|
runs-on: docker
|
||||||
|
container:
|
||||||
|
image: git.staropensource.de/staropensource/actions-docker:java
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: https://code.forgejo.org/actions/checkout@v4
|
||||||
|
- name: Restore Gradle cache
|
||||||
|
uses: actions/cache/restore@v4
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.gradle/caches
|
||||||
|
~/.gradle/wrapper
|
||||||
|
key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
|
||||||
|
restore-keys: |
|
||||||
|
gradle-${{ runner.os }}-
|
||||||
|
- name: Generate javadoc
|
||||||
|
run: ./gradlew --no-daemon javadoc javadocAll
|
||||||
|
- name: Save Gradle cache
|
||||||
|
uses: actions/cache/save@v4
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.gradle/caches
|
||||||
|
~/.gradle/wrapper
|
||||||
|
key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
|
||||||
|
restore-keys: |
|
||||||
|
gradle-${{ runner.os }}-
|
||||||
|
- name: Upload separate javadoc
|
||||||
|
uses: https://code.forgejo.org/forgejo/upload-artifact@v4
|
||||||
|
with:
|
||||||
|
name: javadoc-separate
|
||||||
|
path: |
|
||||||
|
**/build/docs/javadoc/*
|
||||||
|
if-no-files-found: error
|
||||||
|
- name: Upload combined javadoc
|
||||||
|
uses: https://code.forgejo.org/forgejo/upload-artifact@v4
|
||||||
|
with:
|
||||||
|
name: javadoc-combined
|
||||||
|
path: |
|
||||||
|
build/docs/javadoc/*
|
||||||
|
if-no-files-found: error
|
||||||
|
test:
|
||||||
|
runs-on: docker
|
||||||
|
container:
|
||||||
|
image: git.staropensource.de/staropensource/actions-docker:java
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: https://code.forgejo.org/actions/checkout@v4
|
||||||
|
- name: Restore Gradle cache
|
||||||
|
uses: actions/cache/restore@v4
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.gradle/caches
|
||||||
|
~/.gradle/wrapper
|
||||||
|
key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
|
||||||
|
restore-keys: |
|
||||||
|
gradle-${{ runner.os }}-
|
||||||
|
- name: Run tests
|
||||||
|
run: ./gradlew --no-daemon test
|
||||||
|
- name: Save Gradle cache
|
||||||
|
uses: actions/cache/save@v4
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.gradle/caches
|
||||||
|
~/.gradle/wrapper
|
||||||
|
key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
|
||||||
|
restore-keys: |
|
||||||
|
gradle-${{ runner.os }}-
|
60
.forgejo/workflows/pullrequest.yml
Normal file
60
.forgejo/workflows/pullrequest.yml
Normal file
|
@ -0,0 +1,60 @@
|
||||||
|
name: build-and-test
|
||||||
|
|
||||||
|
on:
|
||||||
|
- pull_request
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
generate-javadoc:
|
||||||
|
runs-on: docker
|
||||||
|
container:
|
||||||
|
image: git.staropensource.de/staropensource/actions-docker:java
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: https://code.forgejo.org/actions/checkout@v4
|
||||||
|
- name: Restore Gradle cache
|
||||||
|
uses: actions/cache/restore@v4
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.gradle/caches
|
||||||
|
~/.gradle/wrapper
|
||||||
|
key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
|
||||||
|
restore-keys: |
|
||||||
|
gradle-${{ runner.os }}-
|
||||||
|
- name: Generate javadoc
|
||||||
|
run: ./gradlew --no-daemon javadoc
|
||||||
|
- name: Save Gradle cache
|
||||||
|
uses: actions/cache/save@v4
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.gradle/caches
|
||||||
|
~/.gradle/wrapper
|
||||||
|
key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
|
||||||
|
restore-keys: |
|
||||||
|
gradle-${{ runner.os }}-
|
||||||
|
test:
|
||||||
|
runs-on: docker
|
||||||
|
container:
|
||||||
|
image: git.staropensource.de/staropensource/actions-docker:java
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: https://code.forgejo.org/actions/checkout@v4
|
||||||
|
- name: Restore Gradle cache
|
||||||
|
uses: actions/cache/restore@v4
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.gradle/caches
|
||||||
|
~/.gradle/wrapper
|
||||||
|
key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
|
||||||
|
restore-keys: |
|
||||||
|
gradle-${{ runner.os }}-
|
||||||
|
- name: Run tests
|
||||||
|
run: ./gradlew --no-daemon test
|
||||||
|
- name: Save Gradle cache
|
||||||
|
uses: actions/cache/save@v4
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.gradle/caches
|
||||||
|
~/.gradle/wrapper
|
||||||
|
key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
|
||||||
|
restore-keys: |
|
||||||
|
gradle-${{ runner.os }}-
|
15
.gitattributes
vendored
Normal file
15
.gitattributes
vendored
Normal file
|
@ -0,0 +1,15 @@
|
||||||
|
# Documentation
|
||||||
|
*.md linguist-documentation
|
||||||
|
docs/* linguist-documentation
|
||||||
|
|
||||||
|
# Licensing information
|
||||||
|
COPYING linguist-documentation
|
||||||
|
LICENSE linguist-documentation
|
||||||
|
|
||||||
|
# Javadoc
|
||||||
|
*.html linguist-documentation
|
||||||
|
*.css linguist-documentation
|
||||||
|
|
||||||
|
# Gradle configuration
|
||||||
|
*.properties linguist-configuration
|
||||||
|
*.gradle linguist-configuration
|
4
.gitignore
vendored
4
.gitignore
vendored
|
@ -1,6 +1,7 @@
|
||||||
### Gradle ###
|
### Gradle ###
|
||||||
.gradle
|
.gradle
|
||||||
build/
|
build/
|
||||||
|
run/
|
||||||
!gradle/wrapper/gradle-wrapper.jar
|
!gradle/wrapper/gradle-wrapper.jar
|
||||||
!**/src/main/**/build/
|
!**/src/main/**/build/
|
||||||
!**/src/test/**/build/
|
!**/src/test/**/build/
|
||||||
|
@ -41,3 +42,6 @@ bin/
|
||||||
|
|
||||||
### Mac OS ###
|
### Mac OS ###
|
||||||
.DS_Store
|
.DS_Store
|
||||||
|
|
||||||
|
### Java ###
|
||||||
|
hs_err_pid*.log
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
<component name="CopyrightManager">
|
<component name="CopyrightManager">
|
||||||
<copyright>
|
<copyright>
|
||||||
<option name="allowReplaceRegexp" value="Copyright .* The StarOpenSource Engine Contributors" />
|
<option name="allowReplaceRegexp" value="Copyright .* The StarOpenSource Engine Authors" />
|
||||||
<option name="notice" value="STAROPENSOURCE ENGINE SOURCE FILE Copyright (c) &#36;today.year The StarOpenSource Engine Contributors Licensed under the GNU Affero General Public License v3 This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with this program. If not, see <https://www.gnu.org/licenses/>." />
|
<option name="notice" value="STAROPENSOURCE ENGINE SOURCE FILE Copyright (c) &#36;today.year The StarOpenSource Engine Authors Licensed under the GNU Affero General Public License v3 This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with this program. If not, see <https://www.gnu.org/licenses/>." />
|
||||||
<option name="myName" value="sos!engine" />
|
<option name="myName" value="sos!engine" />
|
||||||
</copyright>
|
</copyright>
|
||||||
</component>
|
</component>
|
||||||
|
|
661
COPYING
661
COPYING
|
@ -1,661 +0,0 @@
|
||||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
|
||||||
Version 3, 19 November 2007
|
|
||||||
|
|
||||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
|
||||||
Everyone is permitted to copy and distribute verbatim copies
|
|
||||||
of this license document, but changing it is not allowed.
|
|
||||||
|
|
||||||
Preamble
|
|
||||||
|
|
||||||
The GNU Affero General Public License is a free, copyleft license for
|
|
||||||
software and other kinds of works, specifically designed to ensure
|
|
||||||
cooperation with the community in the case of network server software.
|
|
||||||
|
|
||||||
The licenses for most software and other practical works are designed
|
|
||||||
to take away your freedom to share and change the works. By contrast,
|
|
||||||
our General Public Licenses are intended to guarantee your freedom to
|
|
||||||
share and change all versions of a program--to make sure it remains free
|
|
||||||
software for all its users.
|
|
||||||
|
|
||||||
When we speak of free software, we are referring to freedom, not
|
|
||||||
price. Our General Public Licenses are designed to make sure that you
|
|
||||||
have the freedom to distribute copies of free software (and charge for
|
|
||||||
them if you wish), that you receive source code or can get it if you
|
|
||||||
want it, that you can change the software or use pieces of it in new
|
|
||||||
free programs, and that you know you can do these things.
|
|
||||||
|
|
||||||
Developers that use our General Public Licenses protect your rights
|
|
||||||
with two steps: (1) assert copyright on the software, and (2) offer
|
|
||||||
you this License which gives you legal permission to copy, distribute
|
|
||||||
and/or modify the software.
|
|
||||||
|
|
||||||
A secondary benefit of defending all users' freedom is that
|
|
||||||
improvements made in alternate versions of the program, if they
|
|
||||||
receive widespread use, become available for other developers to
|
|
||||||
incorporate. Many developers of free software are heartened and
|
|
||||||
encouraged by the resulting cooperation. However, in the case of
|
|
||||||
software used on network servers, this result may fail to come about.
|
|
||||||
The GNU General Public License permits making a modified version and
|
|
||||||
letting the public access it on a server without ever releasing its
|
|
||||||
source code to the public.
|
|
||||||
|
|
||||||
The GNU Affero General Public License is designed specifically to
|
|
||||||
ensure that, in such cases, the modified source code becomes available
|
|
||||||
to the community. It requires the operator of a network server to
|
|
||||||
provide the source code of the modified version running there to the
|
|
||||||
users of that server. Therefore, public use of a modified version, on
|
|
||||||
a publicly accessible server, gives the public access to the source
|
|
||||||
code of the modified version.
|
|
||||||
|
|
||||||
An older license, called the Affero General Public License and
|
|
||||||
published by Affero, was designed to accomplish similar goals. This is
|
|
||||||
a different license, not a version of the Affero GPL, but Affero has
|
|
||||||
released a new version of the Affero GPL which permits relicensing under
|
|
||||||
this license.
|
|
||||||
|
|
||||||
The precise terms and conditions for copying, distribution and
|
|
||||||
modification follow.
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
0. Definitions.
|
|
||||||
|
|
||||||
"This License" refers to version 3 of the GNU Affero General Public License.
|
|
||||||
|
|
||||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
|
||||||
works, such as semiconductor masks.
|
|
||||||
|
|
||||||
"The Program" refers to any copyrightable work licensed under this
|
|
||||||
License. Each licensee is addressed as "you". "Licensees" and
|
|
||||||
"recipients" may be individuals or organizations.
|
|
||||||
|
|
||||||
To "modify" a work means to copy from or adapt all or part of the work
|
|
||||||
in a fashion requiring copyright permission, other than the making of an
|
|
||||||
exact copy. The resulting work is called a "modified version" of the
|
|
||||||
earlier work or a work "based on" the earlier work.
|
|
||||||
|
|
||||||
A "covered work" means either the unmodified Program or a work based
|
|
||||||
on the Program.
|
|
||||||
|
|
||||||
To "propagate" a work means to do anything with it that, without
|
|
||||||
permission, would make you directly or secondarily liable for
|
|
||||||
infringement under applicable copyright law, except executing it on a
|
|
||||||
computer or modifying a private copy. Propagation includes copying,
|
|
||||||
distribution (with or without modification), making available to the
|
|
||||||
public, and in some countries other activities as well.
|
|
||||||
|
|
||||||
To "convey" a work means any kind of propagation that enables other
|
|
||||||
parties to make or receive copies. Mere interaction with a user through
|
|
||||||
a computer network, with no transfer of a copy, is not conveying.
|
|
||||||
|
|
||||||
An interactive user interface displays "Appropriate Legal Notices"
|
|
||||||
to the extent that it includes a convenient and prominently visible
|
|
||||||
feature that (1) displays an appropriate copyright notice, and (2)
|
|
||||||
tells the user that there is no warranty for the work (except to the
|
|
||||||
extent that warranties are provided), that licensees may convey the
|
|
||||||
work under this License, and how to view a copy of this License. If
|
|
||||||
the interface presents a list of user commands or options, such as a
|
|
||||||
menu, a prominent item in the list meets this criterion.
|
|
||||||
|
|
||||||
1. Source Code.
|
|
||||||
|
|
||||||
The "source code" for a work means the preferred form of the work
|
|
||||||
for making modifications to it. "Object code" means any non-source
|
|
||||||
form of a work.
|
|
||||||
|
|
||||||
A "Standard Interface" means an interface that either is an official
|
|
||||||
standard defined by a recognized standards body, or, in the case of
|
|
||||||
interfaces specified for a particular programming language, one that
|
|
||||||
is widely used among developers working in that language.
|
|
||||||
|
|
||||||
The "System Libraries" of an executable work include anything, other
|
|
||||||
than the work as a whole, that (a) is included in the normal form of
|
|
||||||
packaging a Major Component, but which is not part of that Major
|
|
||||||
Component, and (b) serves only to enable use of the work with that
|
|
||||||
Major Component, or to implement a Standard Interface for which an
|
|
||||||
implementation is available to the public in source code form. A
|
|
||||||
"Major Component", in this context, means a major essential component
|
|
||||||
(kernel, window system, and so on) of the specific operating system
|
|
||||||
(if any) on which the executable work runs, or a compiler used to
|
|
||||||
produce the work, or an object code interpreter used to run it.
|
|
||||||
|
|
||||||
The "Corresponding Source" for a work in object code form means all
|
|
||||||
the source code needed to generate, install, and (for an executable
|
|
||||||
work) run the object code and to modify the work, including scripts to
|
|
||||||
control those activities. However, it does not include the work's
|
|
||||||
System Libraries, or general-purpose tools or generally available free
|
|
||||||
programs which are used unmodified in performing those activities but
|
|
||||||
which are not part of the work. For example, Corresponding Source
|
|
||||||
includes interface definition files associated with source files for
|
|
||||||
the work, and the source code for shared libraries and dynamically
|
|
||||||
linked subprograms that the work is specifically designed to require,
|
|
||||||
such as by intimate data communication or control flow between those
|
|
||||||
subprograms and other parts of the work.
|
|
||||||
|
|
||||||
The Corresponding Source need not include anything that users
|
|
||||||
can regenerate automatically from other parts of the Corresponding
|
|
||||||
Source.
|
|
||||||
|
|
||||||
The Corresponding Source for a work in source code form is that
|
|
||||||
same work.
|
|
||||||
|
|
||||||
2. Basic Permissions.
|
|
||||||
|
|
||||||
All rights granted under this License are granted for the term of
|
|
||||||
copyright on the Program, and are irrevocable provided the stated
|
|
||||||
conditions are met. This License explicitly affirms your unlimited
|
|
||||||
permission to run the unmodified Program. The output from running a
|
|
||||||
covered work is covered by this License only if the output, given its
|
|
||||||
content, constitutes a covered work. This License acknowledges your
|
|
||||||
rights of fair use or other equivalent, as provided by copyright law.
|
|
||||||
|
|
||||||
You may make, run and propagate covered works that you do not
|
|
||||||
convey, without conditions so long as your license otherwise remains
|
|
||||||
in force. You may convey covered works to others for the sole purpose
|
|
||||||
of having them make modifications exclusively for you, or provide you
|
|
||||||
with facilities for running those works, provided that you comply with
|
|
||||||
the terms of this License in conveying all material for which you do
|
|
||||||
not control copyright. Those thus making or running the covered works
|
|
||||||
for you must do so exclusively on your behalf, under your direction
|
|
||||||
and control, on terms that prohibit them from making any copies of
|
|
||||||
your copyrighted material outside their relationship with you.
|
|
||||||
|
|
||||||
Conveying under any other circumstances is permitted solely under
|
|
||||||
the conditions stated below. Sublicensing is not allowed; section 10
|
|
||||||
makes it unnecessary.
|
|
||||||
|
|
||||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
|
||||||
|
|
||||||
No covered work shall be deemed part of an effective technological
|
|
||||||
measure under any applicable law fulfilling obligations under article
|
|
||||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
|
||||||
similar laws prohibiting or restricting circumvention of such
|
|
||||||
measures.
|
|
||||||
|
|
||||||
When you convey a covered work, you waive any legal power to forbid
|
|
||||||
circumvention of technological measures to the extent such circumvention
|
|
||||||
is effected by exercising rights under this License with respect to
|
|
||||||
the covered work, and you disclaim any intention to limit operation or
|
|
||||||
modification of the work as a means of enforcing, against the work's
|
|
||||||
users, your or third parties' legal rights to forbid circumvention of
|
|
||||||
technological measures.
|
|
||||||
|
|
||||||
4. Conveying Verbatim Copies.
|
|
||||||
|
|
||||||
You may convey verbatim copies of the Program's source code as you
|
|
||||||
receive it, in any medium, provided that you conspicuously and
|
|
||||||
appropriately publish on each copy an appropriate copyright notice;
|
|
||||||
keep intact all notices stating that this License and any
|
|
||||||
non-permissive terms added in accord with section 7 apply to the code;
|
|
||||||
keep intact all notices of the absence of any warranty; and give all
|
|
||||||
recipients a copy of this License along with the Program.
|
|
||||||
|
|
||||||
You may charge any price or no price for each copy that you convey,
|
|
||||||
and you may offer support or warranty protection for a fee.
|
|
||||||
|
|
||||||
5. Conveying Modified Source Versions.
|
|
||||||
|
|
||||||
You may convey a work based on the Program, or the modifications to
|
|
||||||
produce it from the Program, in the form of source code under the
|
|
||||||
terms of section 4, provided that you also meet all of these conditions:
|
|
||||||
|
|
||||||
a) The work must carry prominent notices stating that you modified
|
|
||||||
it, and giving a relevant date.
|
|
||||||
|
|
||||||
b) The work must carry prominent notices stating that it is
|
|
||||||
released under this License and any conditions added under section
|
|
||||||
7. This requirement modifies the requirement in section 4 to
|
|
||||||
"keep intact all notices".
|
|
||||||
|
|
||||||
c) You must license the entire work, as a whole, under this
|
|
||||||
License to anyone who comes into possession of a copy. This
|
|
||||||
License will therefore apply, along with any applicable section 7
|
|
||||||
additional terms, to the whole of the work, and all its parts,
|
|
||||||
regardless of how they are packaged. This License gives no
|
|
||||||
permission to license the work in any other way, but it does not
|
|
||||||
invalidate such permission if you have separately received it.
|
|
||||||
|
|
||||||
d) If the work has interactive user interfaces, each must display
|
|
||||||
Appropriate Legal Notices; however, if the Program has interactive
|
|
||||||
interfaces that do not display Appropriate Legal Notices, your
|
|
||||||
work need not make them do so.
|
|
||||||
|
|
||||||
A compilation of a covered work with other separate and independent
|
|
||||||
works, which are not by their nature extensions of the covered work,
|
|
||||||
and which are not combined with it such as to form a larger program,
|
|
||||||
in or on a volume of a storage or distribution medium, is called an
|
|
||||||
"aggregate" if the compilation and its resulting copyright are not
|
|
||||||
used to limit the access or legal rights of the compilation's users
|
|
||||||
beyond what the individual works permit. Inclusion of a covered work
|
|
||||||
in an aggregate does not cause this License to apply to the other
|
|
||||||
parts of the aggregate.
|
|
||||||
|
|
||||||
6. Conveying Non-Source Forms.
|
|
||||||
|
|
||||||
You may convey a covered work in object code form under the terms
|
|
||||||
of sections 4 and 5, provided that you also convey the
|
|
||||||
machine-readable Corresponding Source under the terms of this License,
|
|
||||||
in one of these ways:
|
|
||||||
|
|
||||||
a) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by the
|
|
||||||
Corresponding Source fixed on a durable physical medium
|
|
||||||
customarily used for software interchange.
|
|
||||||
|
|
||||||
b) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by a
|
|
||||||
written offer, valid for at least three years and valid for as
|
|
||||||
long as you offer spare parts or customer support for that product
|
|
||||||
model, to give anyone who possesses the object code either (1) a
|
|
||||||
copy of the Corresponding Source for all the software in the
|
|
||||||
product that is covered by this License, on a durable physical
|
|
||||||
medium customarily used for software interchange, for a price no
|
|
||||||
more than your reasonable cost of physically performing this
|
|
||||||
conveying of source, or (2) access to copy the
|
|
||||||
Corresponding Source from a network server at no charge.
|
|
||||||
|
|
||||||
c) Convey individual copies of the object code with a copy of the
|
|
||||||
written offer to provide the Corresponding Source. This
|
|
||||||
alternative is allowed only occasionally and noncommercially, and
|
|
||||||
only if you received the object code with such an offer, in accord
|
|
||||||
with subsection 6b.
|
|
||||||
|
|
||||||
d) Convey the object code by offering access from a designated
|
|
||||||
place (gratis or for a charge), and offer equivalent access to the
|
|
||||||
Corresponding Source in the same way through the same place at no
|
|
||||||
further charge. You need not require recipients to copy the
|
|
||||||
Corresponding Source along with the object code. If the place to
|
|
||||||
copy the object code is a network server, the Corresponding Source
|
|
||||||
may be on a different server (operated by you or a third party)
|
|
||||||
that supports equivalent copying facilities, provided you maintain
|
|
||||||
clear directions next to the object code saying where to find the
|
|
||||||
Corresponding Source. Regardless of what server hosts the
|
|
||||||
Corresponding Source, you remain obligated to ensure that it is
|
|
||||||
available for as long as needed to satisfy these requirements.
|
|
||||||
|
|
||||||
e) Convey the object code using peer-to-peer transmission, provided
|
|
||||||
you inform other peers where the object code and Corresponding
|
|
||||||
Source of the work are being offered to the general public at no
|
|
||||||
charge under subsection 6d.
|
|
||||||
|
|
||||||
A separable portion of the object code, whose source code is excluded
|
|
||||||
from the Corresponding Source as a System Library, need not be
|
|
||||||
included in conveying the object code work.
|
|
||||||
|
|
||||||
A "User Product" is either (1) a "consumer product", which means any
|
|
||||||
tangible personal property which is normally used for personal, family,
|
|
||||||
or household purposes, or (2) anything designed or sold for incorporation
|
|
||||||
into a dwelling. In determining whether a product is a consumer product,
|
|
||||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
|
||||||
product received by a particular user, "normally used" refers to a
|
|
||||||
typical or common use of that class of product, regardless of the status
|
|
||||||
of the particular user or of the way in which the particular user
|
|
||||||
actually uses, or expects or is expected to use, the product. A product
|
|
||||||
is a consumer product regardless of whether the product has substantial
|
|
||||||
commercial, industrial or non-consumer uses, unless such uses represent
|
|
||||||
the only significant mode of use of the product.
|
|
||||||
|
|
||||||
"Installation Information" for a User Product means any methods,
|
|
||||||
procedures, authorization keys, or other information required to install
|
|
||||||
and execute modified versions of a covered work in that User Product from
|
|
||||||
a modified version of its Corresponding Source. The information must
|
|
||||||
suffice to ensure that the continued functioning of the modified object
|
|
||||||
code is in no case prevented or interfered with solely because
|
|
||||||
modification has been made.
|
|
||||||
|
|
||||||
If you convey an object code work under this section in, or with, or
|
|
||||||
specifically for use in, a User Product, and the conveying occurs as
|
|
||||||
part of a transaction in which the right of possession and use of the
|
|
||||||
User Product is transferred to the recipient in perpetuity or for a
|
|
||||||
fixed term (regardless of how the transaction is characterized), the
|
|
||||||
Corresponding Source conveyed under this section must be accompanied
|
|
||||||
by the Installation Information. But this requirement does not apply
|
|
||||||
if neither you nor any third party retains the ability to install
|
|
||||||
modified object code on the User Product (for example, the work has
|
|
||||||
been installed in ROM).
|
|
||||||
|
|
||||||
The requirement to provide Installation Information does not include a
|
|
||||||
requirement to continue to provide support service, warranty, or updates
|
|
||||||
for a work that has been modified or installed by the recipient, or for
|
|
||||||
the User Product in which it has been modified or installed. Access to a
|
|
||||||
network may be denied when the modification itself materially and
|
|
||||||
adversely affects the operation of the network or violates the rules and
|
|
||||||
protocols for communication across the network.
|
|
||||||
|
|
||||||
Corresponding Source conveyed, and Installation Information provided,
|
|
||||||
in accord with this section must be in a format that is publicly
|
|
||||||
documented (and with an implementation available to the public in
|
|
||||||
source code form), and must require no special password or key for
|
|
||||||
unpacking, reading or copying.
|
|
||||||
|
|
||||||
7. Additional Terms.
|
|
||||||
|
|
||||||
"Additional permissions" are terms that supplement the terms of this
|
|
||||||
License by making exceptions from one or more of its conditions.
|
|
||||||
Additional permissions that are applicable to the entire Program shall
|
|
||||||
be treated as though they were included in this License, to the extent
|
|
||||||
that they are valid under applicable law. If additional permissions
|
|
||||||
apply only to part of the Program, that part may be used separately
|
|
||||||
under those permissions, but the entire Program remains governed by
|
|
||||||
this License without regard to the additional permissions.
|
|
||||||
|
|
||||||
When you convey a copy of a covered work, you may at your option
|
|
||||||
remove any additional permissions from that copy, or from any part of
|
|
||||||
it. (Additional permissions may be written to require their own
|
|
||||||
removal in certain cases when you modify the work.) You may place
|
|
||||||
additional permissions on material, added by you to a covered work,
|
|
||||||
for which you have or can give appropriate copyright permission.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, for material you
|
|
||||||
add to a covered work, you may (if authorized by the copyright holders of
|
|
||||||
that material) supplement the terms of this License with terms:
|
|
||||||
|
|
||||||
a) Disclaiming warranty or limiting liability differently from the
|
|
||||||
terms of sections 15 and 16 of this License; or
|
|
||||||
|
|
||||||
b) Requiring preservation of specified reasonable legal notices or
|
|
||||||
author attributions in that material or in the Appropriate Legal
|
|
||||||
Notices displayed by works containing it; or
|
|
||||||
|
|
||||||
c) Prohibiting misrepresentation of the origin of that material, or
|
|
||||||
requiring that modified versions of such material be marked in
|
|
||||||
reasonable ways as different from the original version; or
|
|
||||||
|
|
||||||
d) Limiting the use for publicity purposes of names of licensors or
|
|
||||||
authors of the material; or
|
|
||||||
|
|
||||||
e) Declining to grant rights under trademark law for use of some
|
|
||||||
trade names, trademarks, or service marks; or
|
|
||||||
|
|
||||||
f) Requiring indemnification of licensors and authors of that
|
|
||||||
material by anyone who conveys the material (or modified versions of
|
|
||||||
it) with contractual assumptions of liability to the recipient, for
|
|
||||||
any liability that these contractual assumptions directly impose on
|
|
||||||
those licensors and authors.
|
|
||||||
|
|
||||||
All other non-permissive additional terms are considered "further
|
|
||||||
restrictions" within the meaning of section 10. If the Program as you
|
|
||||||
received it, or any part of it, contains a notice stating that it is
|
|
||||||
governed by this License along with a term that is a further
|
|
||||||
restriction, you may remove that term. If a license document contains
|
|
||||||
a further restriction but permits relicensing or conveying under this
|
|
||||||
License, you may add to a covered work material governed by the terms
|
|
||||||
of that license document, provided that the further restriction does
|
|
||||||
not survive such relicensing or conveying.
|
|
||||||
|
|
||||||
If you add terms to a covered work in accord with this section, you
|
|
||||||
must place, in the relevant source files, a statement of the
|
|
||||||
additional terms that apply to those files, or a notice indicating
|
|
||||||
where to find the applicable terms.
|
|
||||||
|
|
||||||
Additional terms, permissive or non-permissive, may be stated in the
|
|
||||||
form of a separately written license, or stated as exceptions;
|
|
||||||
the above requirements apply either way.
|
|
||||||
|
|
||||||
8. Termination.
|
|
||||||
|
|
||||||
You may not propagate or modify a covered work except as expressly
|
|
||||||
provided under this License. Any attempt otherwise to propagate or
|
|
||||||
modify it is void, and will automatically terminate your rights under
|
|
||||||
this License (including any patent licenses granted under the third
|
|
||||||
paragraph of section 11).
|
|
||||||
|
|
||||||
However, if you cease all violation of this License, then your
|
|
||||||
license from a particular copyright holder is reinstated (a)
|
|
||||||
provisionally, unless and until the copyright holder explicitly and
|
|
||||||
finally terminates your license, and (b) permanently, if the copyright
|
|
||||||
holder fails to notify you of the violation by some reasonable means
|
|
||||||
prior to 60 days after the cessation.
|
|
||||||
|
|
||||||
Moreover, your license from a particular copyright holder is
|
|
||||||
reinstated permanently if the copyright holder notifies you of the
|
|
||||||
violation by some reasonable means, this is the first time you have
|
|
||||||
received notice of violation of this License (for any work) from that
|
|
||||||
copyright holder, and you cure the violation prior to 30 days after
|
|
||||||
your receipt of the notice.
|
|
||||||
|
|
||||||
Termination of your rights under this section does not terminate the
|
|
||||||
licenses of parties who have received copies or rights from you under
|
|
||||||
this License. If your rights have been terminated and not permanently
|
|
||||||
reinstated, you do not qualify to receive new licenses for the same
|
|
||||||
material under section 10.
|
|
||||||
|
|
||||||
9. Acceptance Not Required for Having Copies.
|
|
||||||
|
|
||||||
You are not required to accept this License in order to receive or
|
|
||||||
run a copy of the Program. Ancillary propagation of a covered work
|
|
||||||
occurring solely as a consequence of using peer-to-peer transmission
|
|
||||||
to receive a copy likewise does not require acceptance. However,
|
|
||||||
nothing other than this License grants you permission to propagate or
|
|
||||||
modify any covered work. These actions infringe copyright if you do
|
|
||||||
not accept this License. Therefore, by modifying or propagating a
|
|
||||||
covered work, you indicate your acceptance of this License to do so.
|
|
||||||
|
|
||||||
10. Automatic Licensing of Downstream Recipients.
|
|
||||||
|
|
||||||
Each time you convey a covered work, the recipient automatically
|
|
||||||
receives a license from the original licensors, to run, modify and
|
|
||||||
propagate that work, subject to this License. You are not responsible
|
|
||||||
for enforcing compliance by third parties with this License.
|
|
||||||
|
|
||||||
An "entity transaction" is a transaction transferring control of an
|
|
||||||
organization, or substantially all assets of one, or subdividing an
|
|
||||||
organization, or merging organizations. If propagation of a covered
|
|
||||||
work results from an entity transaction, each party to that
|
|
||||||
transaction who receives a copy of the work also receives whatever
|
|
||||||
licenses to the work the party's predecessor in interest had or could
|
|
||||||
give under the previous paragraph, plus a right to possession of the
|
|
||||||
Corresponding Source of the work from the predecessor in interest, if
|
|
||||||
the predecessor has it or can get it with reasonable efforts.
|
|
||||||
|
|
||||||
You may not impose any further restrictions on the exercise of the
|
|
||||||
rights granted or affirmed under this License. For example, you may
|
|
||||||
not impose a license fee, royalty, or other charge for exercise of
|
|
||||||
rights granted under this License, and you may not initiate litigation
|
|
||||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
|
||||||
any patent claim is infringed by making, using, selling, offering for
|
|
||||||
sale, or importing the Program or any portion of it.
|
|
||||||
|
|
||||||
11. Patents.
|
|
||||||
|
|
||||||
A "contributor" is a copyright holder who authorizes use under this
|
|
||||||
License of the Program or a work on which the Program is based. The
|
|
||||||
work thus licensed is called the contributor's "contributor version".
|
|
||||||
|
|
||||||
A contributor's "essential patent claims" are all patent claims
|
|
||||||
owned or controlled by the contributor, whether already acquired or
|
|
||||||
hereafter acquired, that would be infringed by some manner, permitted
|
|
||||||
by this License, of making, using, or selling its contributor version,
|
|
||||||
but do not include claims that would be infringed only as a
|
|
||||||
consequence of further modification of the contributor version. For
|
|
||||||
purposes of this definition, "control" includes the right to grant
|
|
||||||
patent sublicenses in a manner consistent with the requirements of
|
|
||||||
this License.
|
|
||||||
|
|
||||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
|
||||||
patent license under the contributor's essential patent claims, to
|
|
||||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
|
||||||
propagate the contents of its contributor version.
|
|
||||||
|
|
||||||
In the following three paragraphs, a "patent license" is any express
|
|
||||||
agreement or commitment, however denominated, not to enforce a patent
|
|
||||||
(such as an express permission to practice a patent or covenant not to
|
|
||||||
sue for patent infringement). To "grant" such a patent license to a
|
|
||||||
party means to make such an agreement or commitment not to enforce a
|
|
||||||
patent against the party.
|
|
||||||
|
|
||||||
If you convey a covered work, knowingly relying on a patent license,
|
|
||||||
and the Corresponding Source of the work is not available for anyone
|
|
||||||
to copy, free of charge and under the terms of this License, through a
|
|
||||||
publicly available network server or other readily accessible means,
|
|
||||||
then you must either (1) cause the Corresponding Source to be so
|
|
||||||
available, or (2) arrange to deprive yourself of the benefit of the
|
|
||||||
patent license for this particular work, or (3) arrange, in a manner
|
|
||||||
consistent with the requirements of this License, to extend the patent
|
|
||||||
license to downstream recipients. "Knowingly relying" means you have
|
|
||||||
actual knowledge that, but for the patent license, your conveying the
|
|
||||||
covered work in a country, or your recipient's use of the covered work
|
|
||||||
in a country, would infringe one or more identifiable patents in that
|
|
||||||
country that you have reason to believe are valid.
|
|
||||||
|
|
||||||
If, pursuant to or in connection with a single transaction or
|
|
||||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
|
||||||
covered work, and grant a patent license to some of the parties
|
|
||||||
receiving the covered work authorizing them to use, propagate, modify
|
|
||||||
or convey a specific copy of the covered work, then the patent license
|
|
||||||
you grant is automatically extended to all recipients of the covered
|
|
||||||
work and works based on it.
|
|
||||||
|
|
||||||
A patent license is "discriminatory" if it does not include within
|
|
||||||
the scope of its coverage, prohibits the exercise of, or is
|
|
||||||
conditioned on the non-exercise of one or more of the rights that are
|
|
||||||
specifically granted under this License. You may not convey a covered
|
|
||||||
work if you are a party to an arrangement with a third party that is
|
|
||||||
in the business of distributing software, under which you make payment
|
|
||||||
to the third party based on the extent of your activity of conveying
|
|
||||||
the work, and under which the third party grants, to any of the
|
|
||||||
parties who would receive the covered work from you, a discriminatory
|
|
||||||
patent license (a) in connection with copies of the covered work
|
|
||||||
conveyed by you (or copies made from those copies), or (b) primarily
|
|
||||||
for and in connection with specific products or compilations that
|
|
||||||
contain the covered work, unless you entered into that arrangement,
|
|
||||||
or that patent license was granted, prior to 28 March 2007.
|
|
||||||
|
|
||||||
Nothing in this License shall be construed as excluding or limiting
|
|
||||||
any implied license or other defenses to infringement that may
|
|
||||||
otherwise be available to you under applicable patent law.
|
|
||||||
|
|
||||||
12. No Surrender of Others' Freedom.
|
|
||||||
|
|
||||||
If conditions are imposed on you (whether by court order, agreement or
|
|
||||||
otherwise) that contradict the conditions of this License, they do not
|
|
||||||
excuse you from the conditions of this License. If you cannot convey a
|
|
||||||
covered work so as to satisfy simultaneously your obligations under this
|
|
||||||
License and any other pertinent obligations, then as a consequence you may
|
|
||||||
not convey it at all. For example, if you agree to terms that obligate you
|
|
||||||
to collect a royalty for further conveying from those to whom you convey
|
|
||||||
the Program, the only way you could satisfy both those terms and this
|
|
||||||
License would be to refrain entirely from conveying the Program.
|
|
||||||
|
|
||||||
13. Remote Network Interaction; Use with the GNU General Public License.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, if you modify the
|
|
||||||
Program, your modified version must prominently offer all users
|
|
||||||
interacting with it remotely through a computer network (if your version
|
|
||||||
supports such interaction) an opportunity to receive the Corresponding
|
|
||||||
Source of your version by providing access to the Corresponding Source
|
|
||||||
from a network server at no charge, through some standard or customary
|
|
||||||
means of facilitating copying of software. This Corresponding Source
|
|
||||||
shall include the Corresponding Source for any work covered by version 3
|
|
||||||
of the GNU General Public License that is incorporated pursuant to the
|
|
||||||
following paragraph.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, you have
|
|
||||||
permission to link or combine any covered work with a work licensed
|
|
||||||
under version 3 of the GNU General Public License into a single
|
|
||||||
combined work, and to convey the resulting work. The terms of this
|
|
||||||
License will continue to apply to the part which is the covered work,
|
|
||||||
but the work with which it is combined will remain governed by version
|
|
||||||
3 of the GNU General Public License.
|
|
||||||
|
|
||||||
14. Revised Versions of this License.
|
|
||||||
|
|
||||||
The Free Software Foundation may publish revised and/or new versions of
|
|
||||||
the GNU Affero General Public License from time to time. Such new versions
|
|
||||||
will be similar in spirit to the present version, but may differ in detail to
|
|
||||||
address new problems or concerns.
|
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the
|
|
||||||
Program specifies that a certain numbered version of the GNU Affero General
|
|
||||||
Public License "or any later version" applies to it, you have the
|
|
||||||
option of following the terms and conditions either of that numbered
|
|
||||||
version or of any later version published by the Free Software
|
|
||||||
Foundation. If the Program does not specify a version number of the
|
|
||||||
GNU Affero General Public License, you may choose any version ever published
|
|
||||||
by the Free Software Foundation.
|
|
||||||
|
|
||||||
If the Program specifies that a proxy can decide which future
|
|
||||||
versions of the GNU Affero General Public License can be used, that proxy's
|
|
||||||
public statement of acceptance of a version permanently authorizes you
|
|
||||||
to choose that version for the Program.
|
|
||||||
|
|
||||||
Later license versions may give you additional or different
|
|
||||||
permissions. However, no additional obligations are imposed on any
|
|
||||||
author or copyright holder as a result of your choosing to follow a
|
|
||||||
later version.
|
|
||||||
|
|
||||||
15. Disclaimer of Warranty.
|
|
||||||
|
|
||||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
|
||||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
|
||||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
|
||||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
|
||||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
||||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
|
||||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
|
||||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
|
||||||
|
|
||||||
16. Limitation of Liability.
|
|
||||||
|
|
||||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
||||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
|
||||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
|
||||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
|
||||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
|
||||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
|
||||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
|
||||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
|
||||||
SUCH DAMAGES.
|
|
||||||
|
|
||||||
17. Interpretation of Sections 15 and 16.
|
|
||||||
|
|
||||||
If the disclaimer of warranty and limitation of liability provided
|
|
||||||
above cannot be given local legal effect according to their terms,
|
|
||||||
reviewing courts shall apply local law that most closely approximates
|
|
||||||
an absolute waiver of all civil liability in connection with the
|
|
||||||
Program, unless a warranty or assumption of liability accompanies a
|
|
||||||
copy of the Program in return for a fee.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
How to Apply These Terms to Your New Programs
|
|
||||||
|
|
||||||
If you develop a new program, and you want it to be of the greatest
|
|
||||||
possible use to the public, the best way to achieve this is to make it
|
|
||||||
free software which everyone can redistribute and change under these terms.
|
|
||||||
|
|
||||||
To do so, attach the following notices to the program. It is safest
|
|
||||||
to attach them to the start of each source file to most effectively
|
|
||||||
state the exclusion of warranty; and each file should have at least
|
|
||||||
the "copyright" line and a pointer to where the full notice is found.
|
|
||||||
|
|
||||||
<one line to give the program's name and a brief idea of what it does.>
|
|
||||||
Copyright (C) <year> <name of author>
|
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
|
||||||
it under the terms of the GNU Affero General Public License as published by
|
|
||||||
the Free Software Foundation, either version 3 of the License, or
|
|
||||||
(at your option) any later version.
|
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
GNU Affero General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU Affero General Public License
|
|
||||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
Also add information on how to contact you by electronic and paper mail.
|
|
||||||
|
|
||||||
If your software can interact with users remotely through a computer
|
|
||||||
network, you should also make sure that it provides a way for users to
|
|
||||||
get its source. For example, if your program is a web application, its
|
|
||||||
interface could display a "Source" link that leads users to an archive
|
|
||||||
of the code. There are many ways you could offer source, and different
|
|
||||||
solutions will be better for different programs; see section 13 for the
|
|
||||||
specific requirements.
|
|
||||||
|
|
||||||
You should also get your employer (if you work as a programmer) or school,
|
|
||||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
|
||||||
For more information on this, and how to apply and follow the GNU AGPL, see
|
|
||||||
<https://www.gnu.org/licenses/>.
|
|
677
LICENSE
677
LICENSE
|
@ -1,24 +1,661 @@
|
||||||
The software in this package is distributed under the GNU Affero
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
General Public License (with a special exception described below).
|
Version 3, 19 November 2007
|
||||||
|
|
||||||
A copy of the GNU Affero General Public License (AGPL) is included in this distribution,
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
in the file COPYING. If you do not have the source code, it is available at:
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
https://git.staropensource.de/StarOpenSource/Engine
|
Preamble
|
||||||
|
|
||||||
Linking this library statically or dynamically with other modules is
|
The GNU Affero General Public License is a free, copyleft license for
|
||||||
making a combined work based on this library. Thus, the terms and
|
software and other kinds of works, specifically designed to ensure
|
||||||
conditions of the GNU Affero General Public License cover the whole
|
cooperation with the community in the case of network server software.
|
||||||
combination.
|
|
||||||
|
|
||||||
As a special exception, the copyright holders of this library give you
|
The licenses for most software and other practical works are designed
|
||||||
permission to link this library with independent modules to produce an
|
to take away your freedom to share and change the works. By contrast,
|
||||||
executable, regardless of the license terms of these independent
|
our General Public Licenses are intended to guarantee your freedom to
|
||||||
modules, and to copy and distribute the resulting executable under
|
share and change all versions of a program--to make sure it remains free
|
||||||
terms of your choice, provided that you also meet, for each linked
|
software for all its users.
|
||||||
independent module, the terms and conditions of the license of that
|
|
||||||
module. An independent module is a module which is not derived from
|
When we speak of free software, we are referring to freedom, not
|
||||||
or based on this library. If you modify this library, you may extend
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
this exception to your version of the library, but you are not
|
have the freedom to distribute copies of free software (and charge for
|
||||||
obligated to do so. If you do not wish to do so, delete this
|
them if you wish), that you receive source code or can get it if you
|
||||||
exception statement from your version.
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
Developers that use our General Public Licenses protect your rights
|
||||||
|
with two steps: (1) assert copyright on the software, and (2) offer
|
||||||
|
you this License which gives you legal permission to copy, distribute
|
||||||
|
and/or modify the software.
|
||||||
|
|
||||||
|
A secondary benefit of defending all users' freedom is that
|
||||||
|
improvements made in alternate versions of the program, if they
|
||||||
|
receive widespread use, become available for other developers to
|
||||||
|
incorporate. Many developers of free software are heartened and
|
||||||
|
encouraged by the resulting cooperation. However, in the case of
|
||||||
|
software used on network servers, this result may fail to come about.
|
||||||
|
The GNU General Public License permits making a modified version and
|
||||||
|
letting the public access it on a server without ever releasing its
|
||||||
|
source code to the public.
|
||||||
|
|
||||||
|
The GNU Affero General Public License is designed specifically to
|
||||||
|
ensure that, in such cases, the modified source code becomes available
|
||||||
|
to the community. It requires the operator of a network server to
|
||||||
|
provide the source code of the modified version running there to the
|
||||||
|
users of that server. Therefore, public use of a modified version, on
|
||||||
|
a publicly accessible server, gives the public access to the source
|
||||||
|
code of the modified version.
|
||||||
|
|
||||||
|
An older license, called the Affero General Public License and
|
||||||
|
published by Affero, was designed to accomplish similar goals. This is
|
||||||
|
a different license, not a version of the Affero GPL, but Affero has
|
||||||
|
released a new version of the Affero GPL which permits relicensing under
|
||||||
|
this license.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, if you modify the
|
||||||
|
Program, your modified version must prominently offer all users
|
||||||
|
interacting with it remotely through a computer network (if your version
|
||||||
|
supports such interaction) an opportunity to receive the Corresponding
|
||||||
|
Source of your version by providing access to the Corresponding Source
|
||||||
|
from a network server at no charge, through some standard or customary
|
||||||
|
means of facilitating copying of software. This Corresponding Source
|
||||||
|
shall include the Corresponding Source for any work covered by version 3
|
||||||
|
of the GNU General Public License that is incorporated pursuant to the
|
||||||
|
following paragraph.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the work with which it is combined will remain governed by version
|
||||||
|
3 of the GNU General Public License.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU Affero General Public License from time to time. Such new versions
|
||||||
|
will be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU Affero General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU Affero General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU Affero General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If your software can interact with users remotely through a computer
|
||||||
|
network, you should also make sure that it provides a way for users to
|
||||||
|
get its source. For example, if your program is a web application, its
|
||||||
|
interface could display a "Source" link that leads users to an archive
|
||||||
|
of the code. There are many ways you could offer source, and different
|
||||||
|
solutions will be better for different programs; see section 13 for the
|
||||||
|
specific requirements.
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
76
README.md
76
README.md
|
@ -1,35 +1,44 @@
|
||||||
# StarOpenSource Engine
|
# StarOpenSource Engine
|
||||||
The StarOpenSource Engine (or sos!engine for short) is a modular, extensible and easy to use Java game and application engine.
|
The StarOpenSource Engine (or sos!engine for short) is a modular, extensible and easy to use Java game and application engine.
|
||||||
|
|
||||||
|
## WARNING
|
||||||
|
The StarOpenSource Engine is under heavy development and is extremely unstable. Code will break often, prepare for potential major refactors when trying the engine out.
|
||||||
|
|
||||||
## Index
|
## Index
|
||||||
- [About](#about)
|
- [About](#about)
|
||||||
- [About the engine](#about-the-engine)
|
- [... the engine](#-the-engine)
|
||||||
- [About the repository](#about-the-repository)
|
- [... the repository](#-the-repository)
|
||||||
- [Priorities](#priorities)
|
- [Priorities](#priorities)
|
||||||
- [Documentation](#documentation)
|
- [Documentation](#documentation)
|
||||||
- [Contributing](#contributing)
|
- [Contributing](#contributing)
|
||||||
- [Requirements](#requirements)
|
- [Requirements](#requirements)
|
||||||
- [What IDE to use?](#what-ide-to-use)
|
- [What IDE to use?](#what-ide-to-use)
|
||||||
- [Code style](#code-style)
|
- [Code style](#code-style)
|
||||||
- [Read this before creating a pull request](#read-this-before-creating-a-pull-request)
|
- [Pull request guidelines](#pull-request-guidelines)
|
||||||
- [Making your first contribution](#making-your-first-contribution)
|
- [Making your first contribution](#making-your-first-contribution)
|
||||||
|
- [Gradle properties](#gradle-properties)
|
||||||
|
|
||||||
## About
|
## About
|
||||||
### About the engine
|
### ... the engine
|
||||||
The sos!engine is a modular and extensible framework for building applications and games, written in the Java programming language.
|
The StarOpenSource Engine is a modular and extensible framework for building applications and games written in [one of the multiple JVM programming languages](https://en.wikipedia.org/wiki/List_of_JVM_languages).
|
||||||
The engine consists of various subsystems, each separate and responsible for only one thing. The engine also houses various useful utilities and classes making development fun, and all that while being lightweight.
|
The engine consists of various subsystems, each separate and responsible for only a few closely-related tasks.
|
||||||
### About the repository
|
\
|
||||||
The sos!engine repository is a monorepo, consisting of [the core engine](https://git.staropensource.de/StarOpenSource/Engine/src/branch/develop/base), official subsystems and [their documentation](https://git.staropensource.de/StarOpenSource/Engine/src/branch/develop/docs).
|
Not only that. The engine also features various useful classes, interfaces and methods making development fun and simpler, while being lightweight.
|
||||||
|
### ... the repository
|
||||||
|
The sos!engine repository is a monorepo, consisting of [the core engine](https://git.staropensource.de/StarOpenSource/Engine/src/branch/develop/base), multiple official subsystems and [their documentation](https://git.staropensource.de/StarOpenSource/Engine/src/branch/develop/docs).
|
||||||
### Priorities
|
### Priorities
|
||||||
- modular
|
These are in no particular order.
|
||||||
- small & lightweight
|
|
||||||
- fast
|
- configurable
|
||||||
- [do one thing and do it well](https://en.wikipedia.org/wiki/Unix_philosophy) (subsystems concept)
|
- [do one thing and do it well](https://en.wikipedia.org/wiki/Unix_philosophy) (subsystems concept)
|
||||||
- have as few runtime dependencies as possible (note: we will cut down on some of them during development)
|
- fast
|
||||||
|
- few runtime dependencies (note: we will cut down on some of them during development)
|
||||||
|
- modular & extensible
|
||||||
|
- small & lightweight
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
The official documentation for the StarOpenSource Engine is not yet available, but is planned.
|
You can view the engine documentation at [engine.staropensource.de](https://engine.staropensource.de). It provides information, guides and tutorials about the core engine and subsystems.
|
||||||
You can however [visit the Javadocs](https://jd.engine.staropensource.de).
|
If you want the API reference, you can [visit the Javadoc](https://jd.engine.staropensource.de) for the engine and it's subsystems.
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
### Requirements
|
### Requirements
|
||||||
|
@ -37,15 +46,44 @@ You need the following things to be able to contribute code to the StarOpenSourc
|
||||||
- knowledge of Java
|
- knowledge of Java
|
||||||
- knowledge about the internals of engine
|
- knowledge about the internals of engine
|
||||||
### What IDE to use?
|
### What IDE to use?
|
||||||
We use and recommend using [IntelliJ IDEA Community Edition](https://github.com/JetBrains/intellij-community) for development because it is flexible, extendable, customizable, provides good completions and error detection. It's also open source.
|
We recommend and are using [IntelliJ IDEA Community Edition](https://github.com/JetBrains/intellij-community) for development because it is flexible, extendable, customizable, provides good completions and error detection. It's also open source.
|
||||||
### Code style
|
### Code style
|
||||||
We recommend looking at existing classes.
|
We recommend looking at existing classes and code for a good understanding on how we'd like code to be written.
|
||||||
### Read this before creating a pull request
|
Here's a quick rundown on the most important things:
|
||||||
Before creating a pull request, make sure you've
|
- Document EVERYTHING. Every single class, field and method, even if private.
|
||||||
- created tests for the functionality you added, changed or removed (if applicable),
|
- Make comments about your code, unless it's extremely simple and easy to understand.
|
||||||
|
- Make sure to add and update `@since` in javadoc comments (update if the javadoc changes a good amount).
|
||||||
|
- Keep stuff simple, no need to elaborate what a logger is. Though remember to not make it *too* simple.
|
||||||
|
- Make sure every field and method has a newline to separate it.
|
||||||
|
- Files must end with a newline or cats might get angry.
|
||||||
|
- Use your brain.
|
||||||
|
### Pull request guidelines
|
||||||
|
Before creating a pull request, make sure you've:
|
||||||
|
- created tests for the functionality you've added, changed or removed (if applicable),
|
||||||
- tested your changes,
|
- tested your changes,
|
||||||
- made sure that everything works,
|
- made sure that everything works,
|
||||||
- is compatible with other code in the monorepo, and
|
- is compatible with other code in the monorepo, and
|
||||||
- is compatible with other applications. If not, tell us in your pull request description.
|
- is compatible with other applications. If not, tell us in your pull request description.
|
||||||
### Making your first contribution
|
### Making your first contribution
|
||||||
TODO
|
TODO
|
||||||
|
### Gradle properties
|
||||||
|
Gradle's behaviour can be changed by changing gradle project properties.
|
||||||
|
To change them, simply append `-P<property>` or `-P<property>=<value>`, like this: `./gradlew -Pjobs=4 test`.
|
||||||
|
#### Parallelism
|
||||||
|
Use the `jobs` property to control how many jobs will get executed simultaneously.
|
||||||
|
On Linux, specify `-Pjobs=$(nproc)`. Defaults to `8`.
|
||||||
|
#### JVM Home
|
||||||
|
You can use the `graalHome` property to specify the `$JAVA_HOME` of your local GraalVM installation.
|
||||||
|
Only used in the `nativeImage` task. Useful if you aren't using GraalVM as your primary JDK.
|
||||||
|
#### Testing
|
||||||
|
You can use the following properties to modify the behaviour of the `test`-task:
|
||||||
|
- `test.control.mode` (default *empty*)
|
||||||
|
- `force-enable`: Disables all test classes except the ones specified
|
||||||
|
- `force-disable`: Enables all test classes except the ones specified
|
||||||
|
- *everything else*: Enables all test classes
|
||||||
|
- `test.control.classes` (default *empty*): A comma-separated, case-sensitive list of test classes
|
||||||
|
which (depending on `test.control.mode`'s value) enable or disable the specified classes.
|
||||||
|
Example: `-Ptest.control.mode=MiscellaneousTest,DependencyResolverTest,EngineConfigurationTest`
|
||||||
|
- `test.control.warning` (default `false`): If `true`, will emit a warning before a restricted test method exits
|
||||||
|
- `test.loggerLevel` (default `silent_warning`): Will set `UnitLogger`'s logger level.
|
||||||
|
Works like `-Dsosengine.base.loggerLevel`. See `UnitLogger#loggerLevel` for more information
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -21,11 +21,11 @@
|
||||||
plugins {
|
plugins {
|
||||||
id("java")
|
id("java")
|
||||||
id("io.freefair.lombok") version("${pluginLombok}")
|
id("io.freefair.lombok") version("${pluginLombok}")
|
||||||
|
id("maven-publish")
|
||||||
}
|
}
|
||||||
|
|
||||||
// Dependencies
|
// Dependencies
|
||||||
dependencies {
|
dependencies {
|
||||||
// -> Runtime <-
|
|
||||||
// Lombok
|
// Lombok
|
||||||
compileOnly("org.projectlombok:lombok:${dependencyLombok}")
|
compileOnly("org.projectlombok:lombok:${dependencyLombok}")
|
||||||
annotationProcessor("org.projectlombok:lombok:${dependencyLombok}")
|
annotationProcessor("org.projectlombok:lombok:${dependencyLombok}")
|
||||||
|
@ -33,21 +33,66 @@ dependencies {
|
||||||
// JetBrains Annotations
|
// JetBrains Annotations
|
||||||
compileOnly("org.jetbrains:annotations:${dependencyJetbrainsAnnotations}")
|
compileOnly("org.jetbrains:annotations:${dependencyJetbrainsAnnotations}")
|
||||||
|
|
||||||
// -> Testing <-
|
// Jansi
|
||||||
// Jetbrains Annotations
|
implementation("org.fusesource.jansi:jansi:${dependencyJansi}")
|
||||||
testCompileOnly("org.jetbrains:annotations:${dependencyJetbrainsAnnotations}")
|
|
||||||
|
|
||||||
// JUnit
|
// Project
|
||||||
testImplementation(platform("org.junit:junit-bom:${dependencyJunit}"))
|
|
||||||
testImplementation("org.junit.jupiter:junit-jupiter")
|
|
||||||
testRuntimeOnly("org.junit.platform:junit-platform-launcher")
|
|
||||||
|
|
||||||
// jOOR
|
|
||||||
testImplementation("org.jooq:joor:${dependencyJoor}")
|
|
||||||
|
|
||||||
// -> Project <-
|
|
||||||
implementation(project(":base"))
|
implementation(project(":base"))
|
||||||
implementation("org.fusesource.jansi:jansi:${dependencyJansi}") // for some reason required or the build fails don"t ask me why
|
}
|
||||||
|
|
||||||
|
// Javadoc configuration
|
||||||
|
javadoc {
|
||||||
|
outputs.upToDateWhen { false } // Force task execution
|
||||||
|
dependsOn(delombok) // Make sure the source is delomboked first
|
||||||
|
|
||||||
|
javadoc {
|
||||||
|
setClasspath(files(project.sourceSets.main.compileClasspath)) // Include dependencies
|
||||||
|
|
||||||
|
options {
|
||||||
|
if (new File(projectDir, "src/main/javadoc/theme.css").exists())
|
||||||
|
stylesheetFile = new File(projectDir, "src/main/javadoc/theme.css") // Theming is cool :3
|
||||||
|
setMemberLevel(JavadocMemberLevel.PUBLIC) // Only display public stuff
|
||||||
|
setOverview("src/main/javadoc/overview.html") // We want a custom overview page to greet the visitor
|
||||||
|
setLocale("en_US") // 你好
|
||||||
|
addStringOption("Xwerror", "-quiet") // Fail build on warning
|
||||||
|
|
||||||
|
setJFlags([
|
||||||
|
"-Duser.language=en_US" // See above
|
||||||
|
])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Include javadoc and source jar during publishing
|
||||||
|
java {
|
||||||
|
withJavadocJar()
|
||||||
|
withSourcesJar()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Build publishing configuration
|
||||||
|
// Note: You can safely ignore any errors or warnings thrown by your IDE here
|
||||||
|
publishing {
|
||||||
|
repositories {
|
||||||
|
maven {
|
||||||
|
name = "staropensource"
|
||||||
|
url = uri("https://mvn.staropensource.de/engine")
|
||||||
|
credentials(org.gradle.api.credentials.PasswordCredentials)
|
||||||
|
authentication {
|
||||||
|
//noinspection GroovyAssignabilityCheck
|
||||||
|
basic (BasicAuthentication)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
publications {
|
||||||
|
//noinspection GroovyAssignabilityCheck
|
||||||
|
maven (MavenPublication) {
|
||||||
|
groupId = group
|
||||||
|
artifactId = project.getName()
|
||||||
|
version = version
|
||||||
|
//noinspection GroovyAssignabilityCheck
|
||||||
|
from components.java
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Fix delombok task
|
// Fix delombok task
|
||||||
|
@ -65,33 +110,3 @@ delombok.doLast {
|
||||||
target.delete()
|
target.delete()
|
||||||
source.renameTo(target)
|
source.renameTo(target)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Javadoc configuration
|
|
||||||
javadoc {
|
|
||||||
outputs.upToDateWhen { false } // Force task execution
|
|
||||||
dependsOn(delombok) // Make sure the source is delomboked first
|
|
||||||
|
|
||||||
javadoc {
|
|
||||||
setClasspath(files(project.sourceSets.main.compileClasspath)) // Include dependencies
|
|
||||||
|
|
||||||
options {
|
|
||||||
if (new File(projectDir, "src/main/javadoc/theme.css").exists())
|
|
||||||
stylesheetFile = new File(projectDir, "src/main/javadoc/theme.css") // Theming is cool :3
|
|
||||||
setMemberLevel(JavadocMemberLevel.PUBLIC) // Only display public stuff
|
|
||||||
setOverview("src/main/javadoc/overview.html") // We want a custom overview page to greet the visitor
|
|
||||||
setLocale("en_US") // 你好
|
|
||||||
|
|
||||||
setJFlags([
|
|
||||||
"-Duser.language=en_US" // See above
|
|
||||||
])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Unit testing configuration
|
|
||||||
test {
|
|
||||||
useJUnitPlatform()
|
|
||||||
testLogging {
|
|
||||||
events("passed", "skipped", "failed")
|
|
||||||
}
|
|
||||||
}
|
|
0
graphics/gradlew → ansi/gradlew
vendored
0
graphics/gradlew → ansi/gradlew
vendored
0
graphics/gradlew.bat → ansi/gradlew.bat
vendored
0
graphics/gradlew.bat → ansi/gradlew.bat
vendored
|
@ -0,0 +1,61 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.ansi;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.EngineConfiguration;
|
||||||
|
import de.staropensource.engine.base.implementable.LoggingAdapter;
|
||||||
|
import de.staropensource.engine.base.logging.Logger;
|
||||||
|
import de.staropensource.engine.base.type.logging.LogLevel;
|
||||||
|
import org.fusesource.jansi.Ansi;
|
||||||
|
import org.fusesource.jansi.AnsiConsole;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Prints colored log output using the Jansi library.
|
||||||
|
*
|
||||||
|
* @see Logger
|
||||||
|
* @see LoggingAdapter
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public class AnsiLoggingAdapter implements LoggingAdapter {
|
||||||
|
/**
|
||||||
|
* Creates and initializes an instance of this class.
|
||||||
|
*
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public AnsiLoggingAdapter() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
@SuppressWarnings({ "resource" }) // Using try-with-resources will cause issues here
|
||||||
|
public void print(@NotNull LogLevel level, @NotNull StackTraceElement issuer, @NotNull String message, @NotNull String format) {
|
||||||
|
// Convert to Ansi
|
||||||
|
Ansi output = new AnsiShortcodeParser(format, true).getAnsi();
|
||||||
|
|
||||||
|
// Print message
|
||||||
|
if (level == LogLevel.ERROR || level == LogLevel.CRASH)
|
||||||
|
if (EngineConfiguration.getInstance().isLogForceStandardOutput())
|
||||||
|
AnsiConsole.out().println(output);
|
||||||
|
else
|
||||||
|
AnsiConsole.err().println(output);
|
||||||
|
else
|
||||||
|
AnsiConsole.out().println(output);
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,107 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.ansi;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.implementable.ShortcodeParser;
|
||||||
|
import de.staropensource.engine.base.exception.ParserException;
|
||||||
|
import org.fusesource.jansi.Ansi;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
import java.util.HashSet;
|
||||||
|
import java.util.Set;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implementation of the {@link ShortcodeParser} class
|
||||||
|
* with ANSI support using the Jansi library.
|
||||||
|
*
|
||||||
|
* @see ShortcodeParser
|
||||||
|
* @since v1-alpha8
|
||||||
|
*/
|
||||||
|
public final class AnsiShortcodeParser extends ShortcodeParser {
|
||||||
|
/**
|
||||||
|
* Creates and initializes an instance of this class.
|
||||||
|
*
|
||||||
|
* @param string string to convert
|
||||||
|
* @param ignoreInvalidEscapes will ignore invalid escapes and print treat them like regular text
|
||||||
|
* @throws ParserException when parsing failed
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public AnsiShortcodeParser(@NotNull String string, boolean ignoreInvalidEscapes) throws ParserException {
|
||||||
|
super(string, ignoreInvalidEscapes);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the parsed string as an {@link Ansi} sequence.
|
||||||
|
*
|
||||||
|
* @return {@link Ansi} sequence
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public @NotNull Ansi getAnsi() {
|
||||||
|
Ansi ansi = Ansi.ansi();
|
||||||
|
Set<@NotNull String> status = new HashSet<>();
|
||||||
|
|
||||||
|
for (String component : components)
|
||||||
|
if (component.equals("RESET")) {
|
||||||
|
ansi.a(Ansi.Attribute.RESET);
|
||||||
|
status.clear();
|
||||||
|
} else if (component.startsWith("TEXT:"))
|
||||||
|
ansi.a(component.substring(5));
|
||||||
|
else if (component.startsWith("COLOR:"))
|
||||||
|
if (component.startsWith("COLOR:FOREGROUND:"))
|
||||||
|
ansi.fg(Ansi.Color.valueOf(component.substring(17)));
|
||||||
|
else if (component.startsWith("COLOR:BACKGROUND:"))
|
||||||
|
ansi.bg(Ansi.Color.valueOf(component.substring(17)));
|
||||||
|
else if (component.startsWith("ATTRIBUTE:"))
|
||||||
|
if (component.startsWith("ATTRIBUTE:BLINK")) {
|
||||||
|
if (status.contains("ATTRIBUTE:BLINK"))
|
||||||
|
continue;
|
||||||
|
|
||||||
|
ansi.a(Ansi.Attribute.BLINK_SLOW);
|
||||||
|
status.add("ATTRIBUTE:BLINK");
|
||||||
|
} else if (component.startsWith("ATTRIBUTE:BOLD")) {
|
||||||
|
if (status.contains("ATTRIBUTE:BOLD"))
|
||||||
|
continue;
|
||||||
|
|
||||||
|
ansi.a(Ansi.Attribute.INTENSITY_BOLD);
|
||||||
|
status.add("ATTRIBUTE:BOLD");
|
||||||
|
} else if (component.startsWith("ATTRIBUTE:ITALIC")) {
|
||||||
|
if (status.contains("ATTRIBUTE:ITALIC"))
|
||||||
|
continue;
|
||||||
|
|
||||||
|
ansi.a(Ansi.Attribute.ITALIC);
|
||||||
|
status.add("ATTRIBUTE:ITALIC");
|
||||||
|
} else if (component.startsWith("ATTRIBUTE:STRIKETHROUGH")) {
|
||||||
|
if (status.contains("ATTRIBUTE:STRIKETHROUGH"))
|
||||||
|
continue;
|
||||||
|
|
||||||
|
ansi.a(Ansi.Attribute.STRIKETHROUGH_ON);
|
||||||
|
status.add("ATTRIBUTE:STRIKETHROUGH");
|
||||||
|
} else if (component.startsWith("ATTRIBUTE:UNDERLINE")) {
|
||||||
|
if (status.contains("ATTRIBUTE:UNDERLINE"))
|
||||||
|
continue;
|
||||||
|
|
||||||
|
ansi.a(Ansi.Attribute.UNDERLINE);
|
||||||
|
status.add("ATTRIBUTE:UNDERLINE");
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
return ansi;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,86 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.ansi;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.annotation.EngineSubsystem;
|
||||||
|
import de.staropensource.engine.base.implementable.SubsystemClass;
|
||||||
|
import de.staropensource.engine.base.utility.information.EngineInformation;
|
||||||
|
import de.staropensource.engine.base.implementation.versioning.StarOpenSourceVersioningSystem;
|
||||||
|
import de.staropensource.engine.base.logging.Logger;
|
||||||
|
import de.staropensource.engine.base.type.DependencyVector;
|
||||||
|
import lombok.Getter;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Main class of the ANSI Compatibility subsystem.
|
||||||
|
*
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
@EngineSubsystem
|
||||||
|
@SuppressWarnings({ "JavadocDeclaration" })
|
||||||
|
public final class AnsiSubsystem extends SubsystemClass {
|
||||||
|
/**
|
||||||
|
* Contains the class instance.
|
||||||
|
*
|
||||||
|
* @since v1-alpha2
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the class instance.
|
||||||
|
*
|
||||||
|
* @return class instance unless the subsystem is uninitialized
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static AnsiSubsystem instance = null;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Initializes this subsystem.
|
||||||
|
*
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public AnsiSubsystem() {
|
||||||
|
// Check if subsystem has already initialized
|
||||||
|
if (instance == null)
|
||||||
|
instance = this;
|
||||||
|
else
|
||||||
|
Logger.crash("Only one instance of this class is allowed, use getInstance() instead of creating a new instance");
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String getName() {
|
||||||
|
return "ansi";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public void initializeSubsystem() {
|
||||||
|
Logger.setLoggingAdapter(new AnsiLoggingAdapter());
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull DependencyVector getDependencyVector() {
|
||||||
|
return new DependencyVector.Builder()
|
||||||
|
.setIdentifier("ansi")
|
||||||
|
.setVersioningSystem(StarOpenSourceVersioningSystem.class)
|
||||||
|
.setVersion(EngineInformation.getVersioningString())
|
||||||
|
.build();
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,23 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the ANSI subsystem code.
|
||||||
|
*/
|
||||||
|
package de.staropensource.engine.ansi;
|
23
ansi/src/main/java/module-info.java
Normal file
23
ansi/src/main/java/module-info.java
Normal file
|
@ -0,0 +1,23 @@
|
||||||
|
/**
|
||||||
|
* The ANSI subsystem, allowing the engine to
|
||||||
|
* use ANSI escape codes using the Jansi library.
|
||||||
|
*
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
module sosengine.ansi {
|
||||||
|
// Dependencies
|
||||||
|
// -> Java
|
||||||
|
requires transitive java.management;
|
||||||
|
// -> Engine
|
||||||
|
requires transitive sosengine.base;
|
||||||
|
// -> Libraries
|
||||||
|
requires transitive static lombok;
|
||||||
|
requires transitive org.jetbrains.annotations;
|
||||||
|
requires org.fusesource.jansi;
|
||||||
|
|
||||||
|
// API access
|
||||||
|
exports de.staropensource.engine.ansi;
|
||||||
|
|
||||||
|
// Reflection access
|
||||||
|
opens de.staropensource.engine.ansi;
|
||||||
|
}
|
23
ansi/src/main/javadoc/overview.html
Normal file
23
ansi/src/main/javadoc/overview.html
Normal file
|
@ -0,0 +1,23 @@
|
||||||
|
<!--
|
||||||
|
~ STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
~ Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
~ Licensed under the GNU Affero General Public License v3
|
||||||
|
~
|
||||||
|
~ This program is free software: you can redistribute it and/or modify
|
||||||
|
~ it under the terms of the GNU Affero General Public License as
|
||||||
|
~ published by the Free Software Foundation, either version 3 of the
|
||||||
|
~ License, or (at your option) any later version.
|
||||||
|
~
|
||||||
|
~ This program is distributed in the hope that it will be useful,
|
||||||
|
~ but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
~ GNU Affero General Public License for more details.
|
||||||
|
~
|
||||||
|
~ You should have received a copy of the GNU Affero General Public License
|
||||||
|
~ along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
-->
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p>Welcome to the sos!engine API documentation!<br/>
|
||||||
|
You are currently in the documentation for the <b>ansi</b> subsystem, allowing ANSI escape sequences to be used using Jansi.</p>
|
||||||
|
</body>
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -18,9 +18,6 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import java.nio.file.Files
|
import java.nio.file.Files
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
// Plugins
|
// Plugins
|
||||||
plugins {
|
plugins {
|
||||||
id("java")
|
id("java")
|
||||||
|
@ -29,9 +26,9 @@ plugins {
|
||||||
id("maven-publish")
|
id("maven-publish")
|
||||||
}
|
}
|
||||||
|
|
||||||
// Project dependencies
|
// Dependencies
|
||||||
dependencies {
|
dependencies {
|
||||||
// -> Runtime <-
|
// -> Runtime
|
||||||
// Lombok
|
// Lombok
|
||||||
compileOnly("org.projectlombok:lombok:${dependencyLombok}")
|
compileOnly("org.projectlombok:lombok:${dependencyLombok}")
|
||||||
annotationProcessor("org.projectlombok:lombok:${dependencyLombok}")
|
annotationProcessor("org.projectlombok:lombok:${dependencyLombok}")
|
||||||
|
@ -39,13 +36,10 @@ dependencies {
|
||||||
// JetBrains Annotations
|
// JetBrains Annotations
|
||||||
compileOnly("org.jetbrains:annotations:${dependencyJetbrainsAnnotations}")
|
compileOnly("org.jetbrains:annotations:${dependencyJetbrainsAnnotations}")
|
||||||
|
|
||||||
// ANSI support
|
|
||||||
implementation("org.fusesource.jansi:jansi:${dependencyJansi}")
|
|
||||||
|
|
||||||
// Reflections
|
// Reflections
|
||||||
implementation("org.reflections:reflections:${dependencyReflections}")
|
implementation("org.reflections:reflections:${dependencyReflections}")
|
||||||
|
|
||||||
// -> Testing <-
|
// -> Testing
|
||||||
// Jetbrains Annotations
|
// Jetbrains Annotations
|
||||||
testCompileOnly("org.jetbrains:annotations:${dependencyJetbrainsAnnotations}")
|
testCompileOnly("org.jetbrains:annotations:${dependencyJetbrainsAnnotations}")
|
||||||
|
|
||||||
|
@ -54,31 +48,90 @@ dependencies {
|
||||||
testImplementation("org.junit.jupiter:junit-jupiter")
|
testImplementation("org.junit.jupiter:junit-jupiter")
|
||||||
testRuntimeOnly("org.junit.platform:junit-platform-launcher")
|
testRuntimeOnly("org.junit.platform:junit-platform-launcher")
|
||||||
|
|
||||||
// jOOR
|
// Project
|
||||||
testImplementation("org.jooq:joor:${dependencyJoor}")
|
testImplementation(project(":testing"))
|
||||||
}
|
}
|
||||||
|
|
||||||
// Fix delombok task
|
// Javadoc configuration
|
||||||
delombok.doFirst {
|
javadoc {
|
||||||
File target = file("${project.projectDir}/src/main/module-info.java")
|
outputs.upToDateWhen { false } // Force task execution
|
||||||
File source = file("${project.projectDir}/src/main/java/module-info.java")
|
dependsOn(delombok) // Make sure the source is delomboked first
|
||||||
|
|
||||||
target.delete()
|
javadoc {
|
||||||
source.renameTo(target)
|
setClasspath(files(project.sourceSets.main.compileClasspath)) // Include dependencies
|
||||||
|
|
||||||
|
options {
|
||||||
|
if (new File(projectDir, "src/main/javadoc/theme.css").exists())
|
||||||
|
stylesheetFile = new File(projectDir, "src/main/javadoc/theme.css") // Theming is cool :3
|
||||||
|
setMemberLevel(JavadocMemberLevel.PUBLIC) // Only display public stuff
|
||||||
|
setOverview("src/main/javadoc/overview.html") // We want a custom overview page to greet the visitor
|
||||||
|
setLocale("en_US") // 你好
|
||||||
|
addStringOption("Xwerror", "-quiet") // Fail build on warning
|
||||||
|
|
||||||
|
setJFlags([
|
||||||
|
"-Duser.language=en_US" // See above
|
||||||
|
])
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
delombok.doLast {
|
|
||||||
File target = file("${project.projectDir}/src/main/java/module-info.java")
|
|
||||||
File source = file("${project.projectDir}/src/main/module-info.java")
|
|
||||||
|
|
||||||
target.delete()
|
// Unit testing configuration
|
||||||
source.renameTo(target)
|
test {
|
||||||
|
useJUnitPlatform()
|
||||||
|
|
||||||
|
// Pass test configuration to test VMs
|
||||||
|
Map<String, String> testConfiguration = new HashMap<>();
|
||||||
|
for (String property : project.properties.keySet())
|
||||||
|
if (property.startsWith("test."))
|
||||||
|
testConfiguration.put(property, project.properties.get(property).toString())
|
||||||
|
systemProperties(testConfiguration)
|
||||||
|
|
||||||
|
setMaxParallelForks(project.hasProperty("jobs") ? Integer.parseInt((String) project.property("jobs")) : 8)
|
||||||
|
setForkEvery(1)
|
||||||
|
setFailFast(true)
|
||||||
|
|
||||||
|
testLogging {
|
||||||
|
events("passed", "skipped", "failed")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Include javadoc and source jar during publishing
|
||||||
|
java {
|
||||||
|
withJavadocJar()
|
||||||
|
withSourcesJar()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Build publishing configuration
|
||||||
|
// Note: You can safely ignore any errors or warnings thrown by your IDE here
|
||||||
|
publishing {
|
||||||
|
repositories {
|
||||||
|
maven {
|
||||||
|
name = "staropensource"
|
||||||
|
url = uri("https://mvn.staropensource.de/engine")
|
||||||
|
credentials(org.gradle.api.credentials.PasswordCredentials)
|
||||||
|
authentication {
|
||||||
|
//noinspection GroovyAssignabilityCheck
|
||||||
|
basic (BasicAuthentication)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
publications {
|
||||||
|
//noinspection GroovyAssignabilityCheck
|
||||||
|
maven (MavenPublication) {
|
||||||
|
groupId = group
|
||||||
|
artifactId = project.getName()
|
||||||
|
version = version
|
||||||
|
//noinspection GroovyAssignabilityCheck
|
||||||
|
from components.java
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Copy gradle.properties file
|
// Copy gradle.properties file
|
||||||
// for inclusion in final build
|
// for inclusion in final build
|
||||||
tasks.register("copyGradleProperties") {
|
tasks.register("copyGradleProperties") {
|
||||||
doFirst {
|
doFirst {
|
||||||
File target = file("${project.projectDir}/src/main/resources/gradle.properties")
|
File target = file("${project.projectDir}/src/main/resources/sosengine-gradle.properties")
|
||||||
File source = file(project(":").projectDir.getPath() + "/gradle.properties")
|
File source = file(project(":").projectDir.getPath() + "/gradle.properties")
|
||||||
target.delete()
|
target.delete()
|
||||||
Files.copy(source.toPath(), target.toPath())
|
Files.copy(source.toPath(), target.toPath())
|
||||||
|
@ -101,7 +154,7 @@ gitProperties {
|
||||||
|
|
||||||
tasks.register("writeGitProperties") { // This task's only purpose is to copy the git.properties from our git properties plugin to the resources directory so it's included in the final build
|
tasks.register("writeGitProperties") { // This task's only purpose is to copy the git.properties from our git properties plugin to the resources directory so it's included in the final build
|
||||||
doLast {
|
doLast {
|
||||||
File target = file("${project.projectDir}/src/main/resources/git.properties")
|
File target = file("${project.projectDir}/src/main/resources/sosengine-git.properties")
|
||||||
File source = file("${project.projectDir}/build/resources/main/git.properties")
|
File source = file("${project.projectDir}/build/resources/main/git.properties")
|
||||||
|
|
||||||
target.delete()
|
target.delete()
|
||||||
|
@ -113,58 +166,18 @@ tasks.register("writeGitProperties") { // This task's only purpose is to copy t
|
||||||
generateGitProperties.outputs.upToDateWhen({ false }) // Force task execution
|
generateGitProperties.outputs.upToDateWhen({ false }) // Force task execution
|
||||||
processResources.dependsOn(writeGitProperties) // Ensure git.properties file is present
|
processResources.dependsOn(writeGitProperties) // Ensure git.properties file is present
|
||||||
|
|
||||||
// Javadoc configuration
|
// Fix delombok task
|
||||||
javadoc {
|
delombok.doFirst {
|
||||||
outputs.upToDateWhen { false } // Force task execution
|
File target = file("${project.projectDir}/src/main/module-info.java")
|
||||||
dependsOn(delombok) // Make sure the source is delomboked first
|
File source = file("${project.projectDir}/src/main/java/module-info.java")
|
||||||
|
|
||||||
javadoc {
|
target.delete()
|
||||||
setClasspath(files(project.sourceSets.main.compileClasspath)) // Include dependencies
|
source.renameTo(target)
|
||||||
|
}
|
||||||
|
delombok.doLast {
|
||||||
|
File target = file("${project.projectDir}/src/main/java/module-info.java")
|
||||||
|
File source = file("${project.projectDir}/src/main/module-info.java")
|
||||||
|
|
||||||
options {
|
target.delete()
|
||||||
if (new File(projectDir, "src/main/javadoc/theme.css").exists())
|
source.renameTo(target)
|
||||||
stylesheetFile = new File(projectDir, "src/main/javadoc/theme.css") // Theming is cool :3
|
|
||||||
setMemberLevel(JavadocMemberLevel.PUBLIC) // Only display public stuff
|
|
||||||
setOverview("src/main/javadoc/overview.html") // We want a custom overview page to greet the visitor
|
|
||||||
setLocale("en_US") // 你好
|
|
||||||
|
|
||||||
setJFlags([
|
|
||||||
"-Duser.language=en_US" // See above
|
|
||||||
])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Unit testing configuration
|
|
||||||
test {
|
|
||||||
useJUnitPlatform()
|
|
||||||
testLogging {
|
|
||||||
events("passed", "skipped", "failed")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Build publishing configuration
|
|
||||||
// Note: You can safely ignore any errors or warnings thrown by your IDE here
|
|
||||||
publishing {
|
|
||||||
repositories {
|
|
||||||
maven {
|
|
||||||
name = "staropensource"
|
|
||||||
url = uri("https://mvn.staropensource.de/sosengine")
|
|
||||||
credentials(org.gradle.api.credentials.PasswordCredentials)
|
|
||||||
authentication {
|
|
||||||
//noinspection GroovyAssignabilityCheck
|
|
||||||
basic (BasicAuthentication)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
publications {
|
|
||||||
//noinspection GroovyAssignabilityCheck
|
|
||||||
maven (MavenPublication) {
|
|
||||||
groupId = group
|
|
||||||
artifactId = "base"
|
|
||||||
version = version
|
|
||||||
//noinspection GroovyAssignabilityCheck
|
|
||||||
from components.java
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
618
base/src/main/java/de/staropensource/engine/base/Engine.java
Normal file
618
base/src/main/java/de/staropensource/engine/base/Engine.java
Normal file
|
@ -0,0 +1,618 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.base;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.annotation.EngineSubsystem;
|
||||||
|
import de.staropensource.engine.base.event.*;
|
||||||
|
import de.staropensource.engine.base.exception.IllegalAccessException;
|
||||||
|
import de.staropensource.engine.base.exception.dependency.UnmetDependenciesException;
|
||||||
|
import de.staropensource.engine.base.implementable.ShutdownHandler;
|
||||||
|
import de.staropensource.engine.base.implementable.SubsystemClass;
|
||||||
|
import de.staropensource.engine.base.implementable.helper.EventHelper;
|
||||||
|
import de.staropensource.engine.base.implementation.versioning.StarOpenSourceVersioningSystem;
|
||||||
|
import de.staropensource.engine.base.event.InternalEngineShutdownEvent;
|
||||||
|
import de.staropensource.engine.base.internal.type.DependencySubsystemVector;
|
||||||
|
import de.staropensource.engine.base.logging.PrintStreamService;
|
||||||
|
import de.staropensource.engine.base.logging.*;
|
||||||
|
import de.staropensource.engine.base.logging.backend.async.LoggingQueue;
|
||||||
|
import de.staropensource.engine.base.logging.backend.async.LoggingThread;
|
||||||
|
import de.staropensource.engine.base.type.DependencyVector;
|
||||||
|
import de.staropensource.engine.base.type.EngineState;
|
||||||
|
import de.staropensource.engine.base.type.immutable.ImmutableLinkedList;
|
||||||
|
import de.staropensource.engine.base.utility.DependencyResolver;
|
||||||
|
import de.staropensource.engine.base.utility.FileAccess;
|
||||||
|
import de.staropensource.engine.base.utility.Miscellaneous;
|
||||||
|
import de.staropensource.engine.base.utility.PlaceholderEngine;
|
||||||
|
import de.staropensource.engine.base.utility.information.EngineInformation;
|
||||||
|
import de.staropensource.engine.base.utility.information.JvmInformation;
|
||||||
|
import lombok.AccessLevel;
|
||||||
|
import lombok.Getter;
|
||||||
|
import lombok.Setter;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
import org.jetbrains.annotations.Range;
|
||||||
|
import org.reflections.Reflections;
|
||||||
|
import org.reflections.scanners.Scanners;
|
||||||
|
import org.reflections.util.ClasspathHelper;
|
||||||
|
import org.reflections.util.ConfigurationBuilder;
|
||||||
|
|
||||||
|
import java.util.*;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Main class of the sos!engine.
|
||||||
|
*
|
||||||
|
* @see EngineConfiguration
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "JavadocDeclaration" })
|
||||||
|
public final class Engine extends SubsystemClass {
|
||||||
|
/**
|
||||||
|
* Contains the class instance.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the class instance.
|
||||||
|
*
|
||||||
|
* @return class instance unless {@link Engine} is uninitialized
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static Engine instance = null;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the thread group of the engine.
|
||||||
|
*
|
||||||
|
* @since v1-alpha2
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the thread group of the engine.
|
||||||
|
*
|
||||||
|
* @return engine thread group
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static final ThreadGroup threadGroup = new ThreadGroup("sos!engine");
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the engine state.
|
||||||
|
*
|
||||||
|
* @since v1-alpha2
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the engine state.
|
||||||
|
*
|
||||||
|
* @return shutdown state
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private @NotNull EngineState state;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains a list of all registered subsystems.
|
||||||
|
* The list is sorted after initialization order.
|
||||||
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns a list of all registered subsystems.
|
||||||
|
* The list is sorted after initialization order.
|
||||||
|
*
|
||||||
|
* @return subsystem list
|
||||||
|
* @since v1-alpha1
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private @NotNull ImmutableLinkedList<@NotNull DependencySubsystemVector> subsystems = new ImmutableLinkedList<>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the engine's shutdown handler.
|
||||||
|
* The shutdown handler is responsible for
|
||||||
|
* shutting down the JVM safely.
|
||||||
|
*
|
||||||
|
* @see ShutdownHandler
|
||||||
|
* @since v1-alpha2
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the engine's shutdown handler.
|
||||||
|
* The shutdown handler is responsible for
|
||||||
|
* shutting down the JVM safely.
|
||||||
|
*
|
||||||
|
* @return shutdown handler
|
||||||
|
* @see ShutdownHandler
|
||||||
|
* @since v1-alpha2
|
||||||
|
* -- SETTER --
|
||||||
|
* Sets the engine's shutdown handler.
|
||||||
|
* The shutdown handler is responsible for
|
||||||
|
* shutting down the JVM safely.
|
||||||
|
*
|
||||||
|
* @param shutdownHandler new shutdown handler
|
||||||
|
* @see ShutdownHandler
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
@Getter(value = AccessLevel.MODULE)
|
||||||
|
@Setter(value = AccessLevel.MODULE)
|
||||||
|
private @NotNull ShutdownHandler shutdownHandler = new Engine.JvmShutdownHandler();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the JVM shutdown hook thread,
|
||||||
|
* which ensures that the engine is fully shut
|
||||||
|
* down before the JVM exits.
|
||||||
|
*
|
||||||
|
* @see EngineInternals#installSafetyShutdownHook(boolean)
|
||||||
|
* @since v1-alpha4
|
||||||
|
*/
|
||||||
|
@Getter(AccessLevel.MODULE)
|
||||||
|
private final @NotNull Thread safetyShutdownHook = Thread.ofPlatform()
|
||||||
|
.name("Engine shutdown thread")
|
||||||
|
.group(getThreadGroup())
|
||||||
|
.unstarted(() -> {
|
||||||
|
// Check if already shutting down
|
||||||
|
switch (state) {
|
||||||
|
case UNKNOWN, SHUTDOWN, CRASHED -> {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Print warning about shutdown
|
||||||
|
Logger.warn("Trying to shut down engine using shutdown hook.\nThis approach to shutting down the engine and JVM is NOT RECOMMENDED, please use Engine#shutdown() instead.");
|
||||||
|
|
||||||
|
// Shutdown
|
||||||
|
Engine.getInstance().shutdown();
|
||||||
|
|
||||||
|
// Print last message
|
||||||
|
Logger.warn("Engine successfully shut down using shutdown hook. PLEASE USE Engine#shutdown() INSTEAD OF System#exit() or Runtime#exit()!");
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Initializes the StarOpenSource Engine.
|
||||||
|
*
|
||||||
|
* @throws RuntimeException for all exceptions thrown by this constructor
|
||||||
|
* @since v1-alpha8
|
||||||
|
*/
|
||||||
|
private Engine() throws RuntimeException {
|
||||||
|
try {
|
||||||
|
instance = this;
|
||||||
|
state = EngineState.EARLY_STARTUP;
|
||||||
|
|
||||||
|
// For measuring the initialization time
|
||||||
|
long initTimeEarly = System.currentTimeMillis();
|
||||||
|
long initTimeLate = initTimeEarly;
|
||||||
|
|
||||||
|
// Check for incompatible JVM implementations
|
||||||
|
checkJvmIncompatibilities();
|
||||||
|
|
||||||
|
// Display that the engine is initializing
|
||||||
|
Logger.verb("Initializing engine");
|
||||||
|
|
||||||
|
// Start the logging thread
|
||||||
|
Logger.diag("Starting logging infrastructure");
|
||||||
|
LoggingThread.startThread(false);
|
||||||
|
PrintStreamService.initializeStreams();
|
||||||
|
|
||||||
|
// Initialize EngineInternals
|
||||||
|
Logger.diag("Initializing EngineInternals class");
|
||||||
|
new EngineInternals();
|
||||||
|
|
||||||
|
// Load engine configuration
|
||||||
|
Logger.diag("Loading engine configuration");
|
||||||
|
new EngineConfiguration();
|
||||||
|
EngineConfiguration.getInstance().loadConfiguration();
|
||||||
|
|
||||||
|
// Load engine build information
|
||||||
|
Logger.diag("Loading engine build information");
|
||||||
|
EngineInformation.update();
|
||||||
|
|
||||||
|
// Check for reflective classpath scanning compatibility
|
||||||
|
checkReflectiveClasspathScanningCompatibility();
|
||||||
|
|
||||||
|
// Check for Java version incompatibilities
|
||||||
|
checkJavaVersion();
|
||||||
|
|
||||||
|
// Initialize PlaceholderEngine
|
||||||
|
Logger.diag("Initializing PlaceholderEngine");
|
||||||
|
PlaceholderEngine.initialize();
|
||||||
|
|
||||||
|
// Initialize static FileAccess instances
|
||||||
|
Logger.diag("Initializing static FileAccess instances");
|
||||||
|
FileAccess.initializeInstances();
|
||||||
|
|
||||||
|
// Install the safety shutdown hook
|
||||||
|
Logger.diag("Installing safety shutdown hook");
|
||||||
|
EngineInternals.getInstance().installSafetyShutdownHook(true);
|
||||||
|
|
||||||
|
// Cache events
|
||||||
|
Logger.diag("Caching event listeners");
|
||||||
|
cacheEvents();
|
||||||
|
|
||||||
|
// Complete early initialization stage
|
||||||
|
Logger.verb("Completing early initialization stage");
|
||||||
|
state = EngineState.STARTUP;
|
||||||
|
initTimeEarly = System.currentTimeMillis() - initTimeEarly;
|
||||||
|
|
||||||
|
// Perform automatic subsystem initialization
|
||||||
|
if (EngineConfiguration.getInstance().isInitialPerformSubsystemInitialization()) {
|
||||||
|
// Collect all subsystems
|
||||||
|
Logger.diag("Collecting subsystems");
|
||||||
|
collectSubsystems();
|
||||||
|
|
||||||
|
// Initialize subsystems
|
||||||
|
try {
|
||||||
|
initializeSubsystems();
|
||||||
|
} catch (Exception exception) {
|
||||||
|
Logger.error("Subsystem dependency resolution failed");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Complete late initialization stage
|
||||||
|
Logger.verb("Completing late initialization stage");
|
||||||
|
state = EngineState.RUNNING;
|
||||||
|
initTimeLate = System.currentTimeMillis() - initTimeLate;
|
||||||
|
|
||||||
|
// Print welcome message
|
||||||
|
Logger.info(
|
||||||
|
"""
|
||||||
|
Welcome to the StarOpenSource Engine "%engine_version_codename%" %engine_version%!
|
||||||
|
Running commit %engine_git_commit_id_long% (dirty %engine_git_dirty%).
|
||||||
|
Initialization took %init_time_total%ms (early %init_time_early%ms, late %init_time_late%ms).
|
||||||
|
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
Licensed under the GNU Affero General Public License v3"""
|
||||||
|
.replace("%init_time_total%", String.valueOf(initTimeEarly + initTimeLate))
|
||||||
|
.replace("%init_time_early%", String.valueOf(initTimeEarly))
|
||||||
|
.replace("%init_time_late%", String.valueOf(initTimeLate))
|
||||||
|
);
|
||||||
|
} catch (Exception exception) {
|
||||||
|
throw new RuntimeException(exception);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Initializes the StarOpenSource
|
||||||
|
* Engine, if it isn't already.
|
||||||
|
*
|
||||||
|
* @throws IllegalStateException when running in an incompatible environment
|
||||||
|
* @throws RuntimeException on engine initialization failure
|
||||||
|
* @since v1-alpha6
|
||||||
|
*/
|
||||||
|
public static void initialize() throws RuntimeException {
|
||||||
|
try {
|
||||||
|
if (instance == null)
|
||||||
|
new Engine();
|
||||||
|
} catch (RuntimeException exception) {
|
||||||
|
Logger.error("Engine initialization failed");
|
||||||
|
Logger.error(Miscellaneous.getStackTraceHeader(exception.getCause()));
|
||||||
|
for (String line : Miscellaneous.getStackTraceAsString(exception.getCause(), true).split("\n"))
|
||||||
|
Logger.error(line);
|
||||||
|
|
||||||
|
throw new RuntimeException("Engine initialization failed", exception.getCause());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Checks if the running JVM implementation is not supported by the engine.
|
||||||
|
*
|
||||||
|
* @since v1-alpha8
|
||||||
|
*/
|
||||||
|
private void checkJvmIncompatibilities() {
|
||||||
|
if (System.getProperties().getProperty("sosengine.base.allowUnsupportedJVMInitialization", "false").equals("true")) {
|
||||||
|
Logger.warn("Skipping JVM implementation incompatibilities check");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Substrate VM (GraalVM Community)
|
||||||
|
if (JvmInformation.getImplementationName().equals("Substrate VM") && JvmInformation.getImplementationVendor().equals("GraalVM Community")) {
|
||||||
|
Logger.error("##############################################################################################");
|
||||||
|
Logger.error("## Running in Substrate VM, which is the name of the JVM used by GraalVM native-image. ##");
|
||||||
|
Logger.error("## The StarOpenSource Engine does not support native-image as using reflection in a certain ##");
|
||||||
|
Logger.error("## way seems to cause the Substrate JVM to crash. Workarounds have failed. ##");
|
||||||
|
Logger.error("## This has already been noted in issue #3, which you can view here: ##");
|
||||||
|
Logger.error("## https://git.staropensource.de/StarOpenSource/Engine/issues/3 ##");
|
||||||
|
Logger.error("## ##");
|
||||||
|
Logger.error("## While this is sad, we unfortunately can't do anything against it unless we introduce ##");
|
||||||
|
Logger.error("## annoying and stupid changes into the engine, which we don't want to do. ##");
|
||||||
|
Logger.error("## ##");
|
||||||
|
Logger.error("## We're truly sorry for this inconvenience. The sos!engine will now terminate. ##");
|
||||||
|
Logger.error("##############################################################################################");
|
||||||
|
Runtime.getRuntime().exit(255);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Checks if reflective classpath scanning is supported.
|
||||||
|
*
|
||||||
|
* @since v1-alpha8
|
||||||
|
*/
|
||||||
|
private void checkReflectiveClasspathScanningCompatibility() {
|
||||||
|
// Check if reflective classpath scanning is supported
|
||||||
|
if (System.getProperties().getProperty("sosengine.base.considerEnvironmentUnfriendlyToClasspathScanning", "false").equals("true")) {
|
||||||
|
Logger.warn("Running in an classpath scanning-unfriendly environment, disabling classpath scanning support.");
|
||||||
|
Logger.warn("If shit doesn't work and is expected to be discovered by annotations, you'll need to");
|
||||||
|
Logger.warn("either register it first or have to update some engine configuration setting.");
|
||||||
|
Logger.warn("Please consult sos!engine's documentation for more information about this issue.");
|
||||||
|
EngineInternals.getInstance().overrideReflectiveClasspathScanning(false);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Checks and warns if the Java version of the
|
||||||
|
* running JVM is higher than the engine supports.
|
||||||
|
*
|
||||||
|
* @since v1-alpha8
|
||||||
|
*/
|
||||||
|
private void checkJavaVersion() {
|
||||||
|
if (JvmInformation.getJavaVersion() > EngineInformation.getJavaSource())
|
||||||
|
Logger.warn("The StarOpenSource Engine is running on an untested Java version.\nThings may not work as expected or features which can improve performance, stability, compatibility or ease of use may be missing.\nIf you encounter issues, try running a JVM implementing Java " + EngineInformation.getJavaSource());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Caches all base engine events.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
private void cacheEvents() {
|
||||||
|
EventHelper.cacheEvent(EngineCrashEvent.class);
|
||||||
|
EventHelper.cacheEvent(EngineShutdownEvent.class);
|
||||||
|
EventHelper.cacheEvent(EngineSoftCrashEvent.class);
|
||||||
|
EventHelper.cacheEvent(InternalEngineShutdownEvent.class);
|
||||||
|
EventHelper.cacheEvent(LogEvent.class);
|
||||||
|
EventHelper.cacheEvent(ThrowableCatchEvent.class);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Collects all subsystems by their {@link EngineSubsystem} annotation.
|
||||||
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
|
*/
|
||||||
|
private void collectSubsystems() {
|
||||||
|
ArrayList<@NotNull DependencySubsystemVector> subsystemsMutable = new ArrayList<>();
|
||||||
|
Object initializedClassRaw;
|
||||||
|
SubsystemClass initializedClass;
|
||||||
|
|
||||||
|
// Check and initialize all classes, get dependency vector and check version, then add to 'subsystemsMutable'
|
||||||
|
for (Class<?> clazz : getRawSubsystemClasses())
|
||||||
|
try {
|
||||||
|
// Create new instance
|
||||||
|
initializedClassRaw = clazz.getDeclaredConstructor().newInstance();
|
||||||
|
initializedClass = null;
|
||||||
|
|
||||||
|
// Check if class implements SubsystemMainClass
|
||||||
|
if (initializedClassRaw instanceof SubsystemClass)
|
||||||
|
initializedClass = (SubsystemClass) initializedClassRaw;
|
||||||
|
else
|
||||||
|
Logger.crash("Failed to initialize subsystem " + clazz.getName() + ": Does not implement " + SubsystemClass.class.getName());
|
||||||
|
|
||||||
|
//noinspection DataFlowIssue // the crash call will prevent a NullPointerException
|
||||||
|
subsystemsMutable.add(new DependencySubsystemVector(initializedClass.getDependencyVector(), initializedClass));
|
||||||
|
} catch (Exception exception) {
|
||||||
|
if (exception.getClass() == IllegalStateException.class && exception.getMessage().startsWith("The version string is invalid: "))
|
||||||
|
Logger.crash("Failed to initialize subsystem " + clazz.getName() + ": Invalid version string: " + exception.getMessage().replace("The version string is invalid: ", ""));
|
||||||
|
Logger.crash("Failed to initialize subsystem " + clazz.getName() + ": Method invocation error", exception);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Update 'subsystems'
|
||||||
|
subsystems = new ImmutableLinkedList<>(subsystemsMutable);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns a list of classes which are potentially
|
||||||
|
* eligible for subsystem initialization.
|
||||||
|
*
|
||||||
|
* @return potential subsystem classes
|
||||||
|
* @since v1-alpha5
|
||||||
|
*/
|
||||||
|
private Set<@NotNull Class<?>> getRawSubsystemClasses() {
|
||||||
|
Set<@NotNull Class<?>> classes = new HashSet<>();
|
||||||
|
|
||||||
|
if (EngineInternals.getInstance().getReflectiveClasspathScanning()) {
|
||||||
|
// Scan entire classpath using the Reflections library
|
||||||
|
Reflections reflections = new Reflections(
|
||||||
|
new ConfigurationBuilder()
|
||||||
|
.setUrls(ClasspathHelper.forJavaClassPath())
|
||||||
|
.setScanners(Scanners.TypesAnnotated)
|
||||||
|
);
|
||||||
|
|
||||||
|
// Get annotated methods
|
||||||
|
classes = reflections.getTypesAnnotatedWith(EngineSubsystem.class);
|
||||||
|
} else
|
||||||
|
for (String path : EngineConfiguration.getInstance().getInitialIncludeSubsystemClasses())
|
||||||
|
try {
|
||||||
|
Logger.diag("Resolving class " + path);
|
||||||
|
classes.add(Class.forName(path));
|
||||||
|
} catch (ClassNotFoundException exception) {
|
||||||
|
Logger.error("Failed loading subsystem class " + path + ": Class not found");
|
||||||
|
}
|
||||||
|
|
||||||
|
return classes;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Initializes all subsystems.
|
||||||
|
*
|
||||||
|
* @throws Exception exceptions thrown by the {@link DependencyResolver}
|
||||||
|
* @since v1-alpha1
|
||||||
|
*/
|
||||||
|
private void initializeSubsystems() throws Exception {
|
||||||
|
DependencyResolver resolver = new DependencyResolver();
|
||||||
|
LinkedList<DependencySubsystemVector> order = new LinkedList<>();
|
||||||
|
|
||||||
|
// Add vectors
|
||||||
|
resolver.addVector(getDependencyVector());
|
||||||
|
resolver.addVectors(subsystems);
|
||||||
|
|
||||||
|
// Resolve dependencies and get order
|
||||||
|
Logger.diag("Resolving subsystem dependencies");
|
||||||
|
try {
|
||||||
|
for (DependencyVector vector : resolver.resolve().getOrder()) // smol workaround
|
||||||
|
order.add((DependencySubsystemVector) vector);
|
||||||
|
} catch (Throwable throwable) {
|
||||||
|
if (throwable instanceof UnmetDependenciesException exception) {
|
||||||
|
List<@NotNull String> unmetDependencies = exception.getUnmetDependencies();
|
||||||
|
StringBuilder list = new StringBuilder();
|
||||||
|
|
||||||
|
for (String error : unmetDependencies)
|
||||||
|
list
|
||||||
|
.append("\n")
|
||||||
|
.append("- ")
|
||||||
|
.append(error);
|
||||||
|
|
||||||
|
Logger.crash("Found unresolved dependencies:" + list, throwable);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
Logger.crash("An error occurred trying to resolve subsystem dependencies: " + throwable.getClass().getName() + (throwable.getMessage() == null ? "" : ": " + throwable.getMessage()));
|
||||||
|
throw throwable;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Initialize subsystems
|
||||||
|
Logger.diag("Initializing engine subsystems");
|
||||||
|
long initTime;
|
||||||
|
for (DependencySubsystemVector vector : subsystems) {
|
||||||
|
Logger.diag("Initializing subsystem '" + vector.getSubsystemClass().getName() + "' (" + vector.getSubsystemClass().getClass().getName() + ")");
|
||||||
|
try {
|
||||||
|
initTime = Miscellaneous.measureExecutionTime(() -> vector.getSubsystemClass().initializeSubsystem());
|
||||||
|
} catch (Throwable throwable) {
|
||||||
|
Logger.crash("An error occurred trying to initialize subsystem " + vector.getSubsystemClass().getName() + " (" + vector.getSubsystemClass().getClass().getName() + "): " + throwable.getClass().getName() + (throwable.getMessage() == null ? "" : ": " + throwable.getMessage()));
|
||||||
|
throw throwable;
|
||||||
|
}
|
||||||
|
Logger.diag("Initialized subsystem '" + vector.getSubsystemClass().getName() + "' (" + vector.getSubsystemClass().getClass().getName() + ") in " + initTime + "ms");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Update 'subsystems'
|
||||||
|
subsystems = new ImmutableLinkedList<>(order);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Shuts the engine down.
|
||||||
|
*
|
||||||
|
* @param exitCode code to exit with, from 0-255
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
public synchronized void shutdown(@Range(from = 0, to = 255) int exitCode) {
|
||||||
|
if (state == EngineState.UNKNOWN || state == EngineState.SHUTDOWN)
|
||||||
|
return;
|
||||||
|
|
||||||
|
Logger.info("Shutting engine down");
|
||||||
|
if (state != EngineState.CRASHED)
|
||||||
|
state = EngineState.SHUTDOWN;
|
||||||
|
|
||||||
|
// Make engine single-threaded
|
||||||
|
Properties properties = new Properties();
|
||||||
|
properties.setProperty("sosengine.base.optimizeLogging", "false");
|
||||||
|
properties.setProperty("sosengine.base.optimizeEvents", "false");
|
||||||
|
EngineConfiguration.getInstance().loadConfiguration(properties);
|
||||||
|
|
||||||
|
// Flush log messages
|
||||||
|
LoggingQueue.flush();
|
||||||
|
|
||||||
|
// Disable safety shutdown hook
|
||||||
|
try {
|
||||||
|
Runtime.getRuntime().removeShutdownHook(safetyShutdownHook);
|
||||||
|
} catch (Exception ignored) {}
|
||||||
|
|
||||||
|
// Send events
|
||||||
|
Logger.verb("Notifying classes about shutdown");
|
||||||
|
new EngineShutdownEvent().callEvent();
|
||||||
|
|
||||||
|
Logger.verb("Notifying subsystems about shutdown");
|
||||||
|
new InternalEngineShutdownEvent().callEvent();
|
||||||
|
|
||||||
|
// Delete scheduled files
|
||||||
|
FileAccess.deleteScheduled();
|
||||||
|
|
||||||
|
// Invoke shutdown handler
|
||||||
|
Logger.verb("Invoking shutdown handler (code " + exitCode + ")");
|
||||||
|
shutdownHandler.shutdown((short) exitCode);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Shuts the engine down.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
public void shutdown() {
|
||||||
|
if (instance != null)
|
||||||
|
instance.shutdown(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String getName() {
|
||||||
|
return "base";
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method does nothing.
|
||||||
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
|
*/
|
||||||
|
@Override
|
||||||
|
public void initializeSubsystem() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull DependencyVector getDependencyVector() {
|
||||||
|
return new DependencyVector.Builder()
|
||||||
|
.setIdentifier("engine")
|
||||||
|
.setVersioningSystem(StarOpenSourceVersioningSystem.class)
|
||||||
|
.setVersion(EngineInformation.getVersioningString())
|
||||||
|
.build();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the engine state.
|
||||||
|
*
|
||||||
|
* @param state new state
|
||||||
|
* @throws IllegalAccessException if the caller class is unauthorized
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public void setState(@NotNull EngineState state) throws IllegalAccessException {
|
||||||
|
if (!Thread.currentThread().getStackTrace()[2].getClassName().startsWith("de.staropensource.engine.base."))
|
||||||
|
throw new IllegalAccessException("Only classes inside the \"de.staropensource.engine.base\" package are allowed to call this method.");
|
||||||
|
|
||||||
|
this.state = state;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The default shutdown handler, which causes the JVM to exit.
|
||||||
|
*
|
||||||
|
* @see ShutdownHandler
|
||||||
|
* @see System#exit(int)
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public static final class JvmShutdownHandler implements ShutdownHandler {
|
||||||
|
/**
|
||||||
|
* Constructs this class.
|
||||||
|
*
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public JvmShutdownHandler() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public void shutdown(short exitCode) {
|
||||||
|
// Check if already shutting down
|
||||||
|
try {
|
||||||
|
Thread thread = Thread.ofVirtual().unstarted(() -> {});
|
||||||
|
|
||||||
|
Runtime.getRuntime().addShutdownHook(thread);
|
||||||
|
Runtime.getRuntime().removeShutdownHook(thread);
|
||||||
|
} catch (IllegalStateException exception) {
|
||||||
|
Logger.warn("Terminating JVM: Already shutting down, skipping");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
Logger.warn("Terminating JVM");
|
||||||
|
Runtime.getRuntime().exit(exitCode);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,524 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.base;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.annotation.EngineSubsystem;
|
||||||
|
import de.staropensource.engine.base.event.LogEvent;
|
||||||
|
import de.staropensource.engine.base.implementable.Configuration;
|
||||||
|
import de.staropensource.engine.base.implementable.ShortcodeParser;
|
||||||
|
import de.staropensource.engine.base.implementable.SubsystemClass;
|
||||||
|
import de.staropensource.engine.base.logging.Logger;
|
||||||
|
import de.staropensource.engine.base.logging.backend.async.LoggingThread;
|
||||||
|
import de.staropensource.engine.base.type.EngineState;
|
||||||
|
import de.staropensource.engine.base.type.logging.LogLevel;
|
||||||
|
import de.staropensource.engine.base.type.vector.Vec2f;
|
||||||
|
import de.staropensource.engine.base.type.vector.Vec2i;
|
||||||
|
import de.staropensource.engine.base.utility.PropertiesReader;
|
||||||
|
import lombok.Getter;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
import org.jetbrains.annotations.Nullable;
|
||||||
|
|
||||||
|
import java.util.*;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provides the base engine configuration.
|
||||||
|
* <p>
|
||||||
|
* This class does not only provide engine settings but is also
|
||||||
|
* responsible for loading them into memory from {@link Properties} objects.
|
||||||
|
* <p>
|
||||||
|
* Now you might ask why we didn't go with the string-based approach.
|
||||||
|
* The answer is simple: It's a maintenance burden.
|
||||||
|
* Having various settings strings scattered across many classes will cause
|
||||||
|
* trouble at some point, which will cause some strings to be undocumented
|
||||||
|
* or have an inconsistent naming scheme. Containing settings as variables in
|
||||||
|
* one centralized place mitigates this.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
@SuppressWarnings({ "JavadocDeclaration" })
|
||||||
|
public final class EngineConfiguration extends Configuration {
|
||||||
|
/**
|
||||||
|
* Contains the class instance.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the class instance.
|
||||||
|
*
|
||||||
|
* @return class instance unless {@link Engine} is uninitialized
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static EngineConfiguration instance;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the configuration prefix.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the configuration prefix.
|
||||||
|
*
|
||||||
|
* @return property group
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
private final @NotNull String group = "sosengine.base.";
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains if debugging options should be allowed.
|
||||||
|
* All debugging options will be forcefully set to
|
||||||
|
* {@code false} if this option is set to {@code false}.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns if debugging options should be allowed.
|
||||||
|
* All debugging options will be forcefully set to
|
||||||
|
* {@code false} if this option is set to {@code false}.
|
||||||
|
*
|
||||||
|
* @return debugging enabled?
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
private boolean debug;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains whether or not to log
|
||||||
|
* events being emitted.
|
||||||
|
* <p>
|
||||||
|
* This will cause all events to
|
||||||
|
* be logged, with the exception
|
||||||
|
* of the {@link LogEvent}.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns whether or not to log
|
||||||
|
* events being emitted.
|
||||||
|
* <p>
|
||||||
|
* This will cause all events to
|
||||||
|
* be logged, with the exception
|
||||||
|
* of the {@link LogEvent}.
|
||||||
|
*
|
||||||
|
* @return detailed event logging enabled?
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
private boolean debugEvents;
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains whether or not to automatically discover
|
||||||
|
* and initialize any class extending {@link SubsystemClass}
|
||||||
|
* whilst being annotated with {@link EngineSubsystem}.
|
||||||
|
* <p>
|
||||||
|
* This mechanism may fail in certain situations, where
|
||||||
|
* manual subsystem initialization may be desired. Make
|
||||||
|
* sure to disable this setting before engine startup
|
||||||
|
* and then initialize all subsystems manually.
|
||||||
|
*
|
||||||
|
* @see Engine
|
||||||
|
* @since v1-alpha5
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns whether or not to automatically discover
|
||||||
|
* and initialize any class extending {@link SubsystemClass}
|
||||||
|
* whilst being annotated with {@link EngineSubsystem}.
|
||||||
|
* <p>
|
||||||
|
* This mechanism may fail in certain situations, where
|
||||||
|
* manual subsystem initialization may be desired. Make
|
||||||
|
* sure to disable this setting before engine startup
|
||||||
|
* and then initialize all subsystems manually.
|
||||||
|
*
|
||||||
|
* @return automatically discover and initialize subsystems?
|
||||||
|
* @since v1-alpha5
|
||||||
|
*/
|
||||||
|
private boolean initialPerformSubsystemInitialization;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains a set of class names to try to load
|
||||||
|
* and initialize as subsystems. Will only take effect
|
||||||
|
* if {@link #initialPerformSubsystemInitialization} is
|
||||||
|
* turned off.
|
||||||
|
*
|
||||||
|
* @since v1-alpha5
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns a set of class names to try to load
|
||||||
|
* and initialize as subsystems. Will only take effect
|
||||||
|
* if {@link #getInitialIncludeSubsystemClasses()} is
|
||||||
|
* turned off.
|
||||||
|
*
|
||||||
|
* @return set of class names to try and initialize as subsystems
|
||||||
|
* @since v1-alpha5
|
||||||
|
*/
|
||||||
|
private Set<@NotNull String> initialIncludeSubsystemClasses;
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains whether or not to complain about invalid
|
||||||
|
* shortcodes.
|
||||||
|
* <p>
|
||||||
|
* Requires the active log level to be set at least
|
||||||
|
* to {@link LogLevel#SILENT_WARNING} to have effect.
|
||||||
|
*
|
||||||
|
* @see #logLevel
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns whether or not to complain about invalid
|
||||||
|
* shortcodes.
|
||||||
|
* <p>
|
||||||
|
* Requires the active log level to be set at least
|
||||||
|
* to {@link LogLevel#SILENT_WARNING} to have effect.
|
||||||
|
*
|
||||||
|
* @return complain about invalid shortcodes?
|
||||||
|
* @see #getLogLevel()
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
private boolean errorShortcodeParser;
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains if to log asynchronously.
|
||||||
|
* <p>
|
||||||
|
* If enabled, will cause a logging thread
|
||||||
|
* to spawn. All log messages will be queued
|
||||||
|
* and printed after a set delay
|
||||||
|
* ({@link #logPollingSpeed}).
|
||||||
|
* Highly recommended to keep enabled, or
|
||||||
|
* the performance of your application will
|
||||||
|
* very likely suffer.
|
||||||
|
*
|
||||||
|
* @see #logPollingSpeed
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns if to log asynchronously.
|
||||||
|
* <p>
|
||||||
|
* If enabled, will cause a logging thread
|
||||||
|
* to spawn. All log messages will be queued
|
||||||
|
* and printed after a set delay
|
||||||
|
* ({@link #getLogPollingSpeed()}).
|
||||||
|
* Highly recommended to keep enabled, or
|
||||||
|
* the performance of your application will
|
||||||
|
* very likely suffer.
|
||||||
|
*
|
||||||
|
* @return log asynchronously?
|
||||||
|
* @see #getLogPollingSpeed()
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
private boolean optimizeLogging;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains whether or not to emit events
|
||||||
|
* asynchronously.
|
||||||
|
* <p>
|
||||||
|
* This will cause a
|
||||||
|
* <a href="https://openjdk.org/jeps/444">VirtualThread</a>
|
||||||
|
* to spawn every time an event is emitted.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Contains whether or not to emit events
|
||||||
|
* asynchronously.
|
||||||
|
* <p>
|
||||||
|
* This will cause a
|
||||||
|
* <a href="https://openjdk.org/jeps/444">VirtualThread</a>
|
||||||
|
* to spawn every time an event is emitted.
|
||||||
|
*
|
||||||
|
* @return emit events asynchronously?
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
private boolean optimizeEvents;
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the minimum allowed log level.
|
||||||
|
* <p>
|
||||||
|
* The priority list is as follows (from high to low priority):
|
||||||
|
* <ul>
|
||||||
|
* <li>{@link LogLevel#CRASH}</li>
|
||||||
|
* <li>{@link LogLevel#ERROR}</li>
|
||||||
|
* <li>{@link LogLevel#WARNING}</li>
|
||||||
|
* <li>{@link LogLevel#INFORMATIONAL}</li>
|
||||||
|
* <li>{@link LogLevel#SILENT_WARNING}</li>
|
||||||
|
* <li>{@link LogLevel#VERBOSE}</li>
|
||||||
|
* <li>{@link LogLevel#DIAGNOSTIC}</li>
|
||||||
|
* </ul>
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the minimum allowed log level.
|
||||||
|
* <p>
|
||||||
|
* The priority list is as follows (from high to low priority):
|
||||||
|
* <ul>
|
||||||
|
* <li>{@link LogLevel#CRASH}</li>
|
||||||
|
* <li>{@link LogLevel#ERROR}</li>
|
||||||
|
* <li>{@link LogLevel#WARNING}</li>
|
||||||
|
* <li>{@link LogLevel#INFORMATIONAL}</li>
|
||||||
|
* <li>{@link LogLevel#SILENT_WARNING}</li>
|
||||||
|
* <li>{@link LogLevel#VERBOSE}</li>
|
||||||
|
* <li>{@link LogLevel#DIAGNOSTIC}</li>
|
||||||
|
* </ul>
|
||||||
|
*
|
||||||
|
* @return minimum allowed log level
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
private LogLevel logLevel;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains a comma-separated list of optional
|
||||||
|
* features to add to the final log output.
|
||||||
|
* <p>
|
||||||
|
* Available features (in order of appearance):
|
||||||
|
* <ul>
|
||||||
|
* <li><code>formatting</code></li>
|
||||||
|
* <li><code>runtime</code></li>
|
||||||
|
* <li><code>date</code></li>
|
||||||
|
* <li><code>time</code></li>
|
||||||
|
* <li><code>shortIssuerClass</code></li>
|
||||||
|
* <li><code>moduleName</code></li>
|
||||||
|
* <li><code>moduleVersion</code> (requires <code>moduleName</code>)</li>
|
||||||
|
* <li><code>methodName</code></li>
|
||||||
|
* <li><code>lineNumber</code></li>
|
||||||
|
* </ul>
|
||||||
|
*
|
||||||
|
* @since v1-alpha8
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns a comma-separated list of optional
|
||||||
|
* features to add to the final log output.
|
||||||
|
* <p>
|
||||||
|
* Available features (in order of appearance):
|
||||||
|
* <ul>
|
||||||
|
* <li><code>formatting</code></li>
|
||||||
|
* <li><code>runtime</code></li>
|
||||||
|
* <li><code>date</code></li>
|
||||||
|
* <li><code>time</code></li>
|
||||||
|
* <li><code>shortIssuerClass</code></li>
|
||||||
|
* <li><code>moduleName</code></li>
|
||||||
|
* <li><code>moduleVersion</code> (requires <code>moduleName</code>)</li>
|
||||||
|
* <li><code>methodName</code></li>
|
||||||
|
* <li><code>lineNumber</code></li>
|
||||||
|
* </ul>
|
||||||
|
*
|
||||||
|
* @return optional features to enable
|
||||||
|
* @since v1-alpha8
|
||||||
|
*/
|
||||||
|
private Set<@NotNull String> logFeatures;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains how fast the logging thread will
|
||||||
|
* poll for queued messages in milliseconds.
|
||||||
|
* This also causes messages to be buffered.
|
||||||
|
* <p>
|
||||||
|
* Only applies if {@code optimizeLogging} is turned on.
|
||||||
|
* Values below {@code 1} will poll for queued messages
|
||||||
|
* as fast as it can. This however has pretty much no
|
||||||
|
* benefit. Leave it at {@code 5}, it works quite well.
|
||||||
|
*
|
||||||
|
* @see #optimizeLogging
|
||||||
|
* @since v1-alpha4
|
||||||
|
* -- GETTER --
|
||||||
|
* Contains how fast the logging thread will
|
||||||
|
* poll for queued messages, in milliseconds.
|
||||||
|
* This also causes messages to be buffered.
|
||||||
|
* <p>
|
||||||
|
* Only applies if {@code optimizeLogging} is turned on.
|
||||||
|
* Values below {@code 1} will poll for queued messages
|
||||||
|
* as fast as it can. This however has pretty much no
|
||||||
|
* benefit. Leave it at {@code 5}, it works quite well.
|
||||||
|
*
|
||||||
|
* @return logging thread polling speed in milliseconds
|
||||||
|
* @see #isOptimizeLogging()
|
||||||
|
* @since v1-alpha4
|
||||||
|
*/
|
||||||
|
private int logPollingSpeed;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains whether or not to forcefully write
|
||||||
|
* to the standard output instead of the
|
||||||
|
* standard error stream.
|
||||||
|
* <p>
|
||||||
|
* This only applies to the {@link LogLevel#ERROR} and
|
||||||
|
* {@link LogLevel#CRASH} log levels, as these use
|
||||||
|
* the standard error stream by default.
|
||||||
|
*
|
||||||
|
* @see <a href="https://man7.org/linux/man-pages/man3/stderr.3.html">man page about standard streams</a>
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Contains whether or not to forcefully write
|
||||||
|
* to the standard output instead of the
|
||||||
|
* standard error stream.
|
||||||
|
* <p>
|
||||||
|
* This only applies to the {@link LogLevel#ERROR} and
|
||||||
|
* {@link LogLevel#CRASH} log levels, as these use
|
||||||
|
* the standard error stream by default.
|
||||||
|
*
|
||||||
|
* @return force use stdout?
|
||||||
|
* @see <a href="https://man7.org/linux/man-pages/man3/stderr.3.html">man page about standard streams</a>
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
private boolean logForceStandardOutput;
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains if to truncate the full path
|
||||||
|
* of a class when invoking using their
|
||||||
|
* {@link #toString()} method.
|
||||||
|
* <p>
|
||||||
|
* Here's an example: Lets say that you have a
|
||||||
|
* {@link Vec2f} instance and want to convert
|
||||||
|
* it to a String. You can do that by using
|
||||||
|
* {@link Vec2f}'s {@link Vec2f#toString()}
|
||||||
|
* method. With this flag disabled it will
|
||||||
|
* return
|
||||||
|
* {@code de.staropensource.engine.base.types.vectors.}{@link Vec2i}{@code (x=64 y=64)}.
|
||||||
|
* With this flag enabled however the method will return
|
||||||
|
* {@link Vec2i}{@code (x=64 y=64)},
|
||||||
|
* which is much smaller.
|
||||||
|
*
|
||||||
|
* @since v1-alpha2
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns if to truncate the full path
|
||||||
|
* of a class when invoking using their
|
||||||
|
* {@link #toString()} method.
|
||||||
|
* <p>
|
||||||
|
* Here's an example: Lets say that you have a
|
||||||
|
* {@link Vec2f} instance and want to convert
|
||||||
|
* it to a String. You can do that by using
|
||||||
|
* {@link Vec2f}'s {@link Vec2f#toString()}
|
||||||
|
* method. With this flag disabled it will
|
||||||
|
* return
|
||||||
|
* {@code de.staropensource.engine.base.types.vectors.}{@link Vec2i}{@code (x=64 y=64)}.
|
||||||
|
* With this flag enabled however the method will return
|
||||||
|
* {@link Vec2i}{@code (x=64 y=64)},
|
||||||
|
* which is much smaller.
|
||||||
|
*
|
||||||
|
* @return truncate class paths?
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
private boolean hideFullTypePath;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructs this class.
|
||||||
|
*
|
||||||
|
* @see Engine
|
||||||
|
* @since v1-alpha6
|
||||||
|
*/
|
||||||
|
EngineConfiguration() {
|
||||||
|
super();
|
||||||
|
|
||||||
|
instance = this;
|
||||||
|
|
||||||
|
// Load default configuration
|
||||||
|
loadDefaultConfiguration();
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
protected void matchProperty(@NotNull PropertiesReader parser, @NotNull String property) {
|
||||||
|
try {
|
||||||
|
switch (property) {
|
||||||
|
case "debug" -> debug = parser.getBoolean(group + property);
|
||||||
|
case "debugEvents" -> debugEvents = parser.getBoolean(group + property);
|
||||||
|
|
||||||
|
case "initialPerformSubsystemInitialization" -> initialPerformSubsystemInitialization = parser.getBoolean(group + property);
|
||||||
|
case "initialIncludeSubsystemClasses" -> {
|
||||||
|
initialIncludeSubsystemClasses = new HashSet<>();
|
||||||
|
initialIncludeSubsystemClasses.addAll(Arrays.stream(parser.getString(group + property).split(",")).toList());
|
||||||
|
}
|
||||||
|
|
||||||
|
case "errorShortcodeParser" -> errorShortcodeParser = parser.getBoolean(group + property);
|
||||||
|
|
||||||
|
case "optimizeLogging" -> {
|
||||||
|
optimizeLogging = parser.getBoolean(group + property);
|
||||||
|
|
||||||
|
// Start logging thread automatically
|
||||||
|
if (optimizeLogging && Engine.getInstance().getState() == EngineState.RUNNING) {
|
||||||
|
LoggingThread.startThread(false);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
case "optimizeEvents" -> optimizeEvents = parser.getBoolean(group + property);
|
||||||
|
|
||||||
|
case "logLevel" -> {
|
||||||
|
try {
|
||||||
|
logLevel = LogLevel.valueOf(parser.getString(group + property).toUpperCase());
|
||||||
|
} catch (IllegalArgumentException ignored) {
|
||||||
|
Logger.error("The log level '" + parser.getString(group + property) + "' is not valid");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
case "logFeatures" -> logFeatures = Set.copyOf(Arrays.stream(parser.getString(group + property).split(",")).toList());
|
||||||
|
case "logPollingSpeed" -> logPollingSpeed = parser.getInteger(group + property, true);
|
||||||
|
case "logForceStandardOutput" -> logForceStandardOutput = parser.getBoolean(group + property);
|
||||||
|
|
||||||
|
case "hideFullTypePath" -> hideFullTypePath = parser.getBoolean(group + property);
|
||||||
|
}
|
||||||
|
} catch (NullPointerException ignored) {}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
protected void processSettings(@NotNull PropertiesReader parser) {
|
||||||
|
// Disable all debugging switches if 'debug' is disabled
|
||||||
|
if (!debug) {
|
||||||
|
debugEvents = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public void loadDefaultConfiguration() {
|
||||||
|
debug = false;
|
||||||
|
debugEvents = false;
|
||||||
|
|
||||||
|
initialPerformSubsystemInitialization = true;
|
||||||
|
initialIncludeSubsystemClasses = new HashSet<>();
|
||||||
|
|
||||||
|
errorShortcodeParser = true;
|
||||||
|
|
||||||
|
optimizeLogging = true;
|
||||||
|
optimizeEvents = true;
|
||||||
|
|
||||||
|
logLevel = LogLevel.INFORMATIONAL;
|
||||||
|
logFeatures = Set.of("formatting", "time", "methodName", "lineNumber");
|
||||||
|
logPollingSpeed = 5;
|
||||||
|
logForceStandardOutput = false;
|
||||||
|
|
||||||
|
hideFullTypePath = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @Nullable Object getSetting(@NotNull String setting) {
|
||||||
|
return switch (setting) {
|
||||||
|
case "debug" -> debug;
|
||||||
|
case "debugEvents" -> debugEvents;
|
||||||
|
|
||||||
|
case "initialPerformSubsystemInitialization" -> initialPerformSubsystemInitialization;
|
||||||
|
case "initialIncludeSubsystemClasses" -> initialIncludeSubsystemClasses;
|
||||||
|
|
||||||
|
case "errorShortcodeParser" -> errorShortcodeParser;
|
||||||
|
|
||||||
|
case "optimizeLogging" -> optimizeLogging;
|
||||||
|
case "optimizeEvents" -> optimizeEvents;
|
||||||
|
|
||||||
|
case "logLevel" -> logLevel;
|
||||||
|
case "logFeatures" -> logFeatures;
|
||||||
|
case "logPollingSpeed" -> logPollingSpeed;
|
||||||
|
case "logForceStandardOutput" -> logForceStandardOutput;
|
||||||
|
|
||||||
|
case "hideFullTypePath" -> hideFullTypePath;
|
||||||
|
default -> null;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,226 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.base;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.exception.IllegalAccessException;
|
||||||
|
import de.staropensource.engine.base.implementable.EventListenerCode;
|
||||||
|
import de.staropensource.engine.base.implementable.ShutdownHandler;
|
||||||
|
import de.staropensource.engine.base.implementable.helper.EventHelper;
|
||||||
|
import de.staropensource.engine.base.logging.Logger;
|
||||||
|
import de.staropensource.engine.base.type.EventPriority;
|
||||||
|
import de.staropensource.engine.base.type.InternalAccessArea;
|
||||||
|
import lombok.Getter;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.Arrays;
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Class which allows access to the internals
|
||||||
|
* and changing the behaviour of the engine.
|
||||||
|
*
|
||||||
|
* @since v1-alpha4
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "JavadocDeclaration" })
|
||||||
|
public final class EngineInternals {
|
||||||
|
/**
|
||||||
|
* Contains the class instance.
|
||||||
|
*
|
||||||
|
* @since v1-alpha4
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the class instance.
|
||||||
|
*
|
||||||
|
* @return class instance unless the engine is uninitialized
|
||||||
|
* @since v1-alpha4
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static EngineInternals instance;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains all disabled internal access areas.
|
||||||
|
*
|
||||||
|
* @since v1-alpha4
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns all disabled internal access areas.
|
||||||
|
*
|
||||||
|
* @return restricted areas
|
||||||
|
* @since v1-alpha4
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private final @NotNull List<@NotNull InternalAccessArea> restrictedAreas = new ArrayList<>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains whether the engine should reflectively
|
||||||
|
* search the classpath for events or other annotations.
|
||||||
|
* <p>
|
||||||
|
* If disabled, code will either have to manually call
|
||||||
|
* registration methods or certain classes have to
|
||||||
|
* be created in a certain package, depending on the
|
||||||
|
* use case and application.
|
||||||
|
*
|
||||||
|
* @see EventHelper#registerEvent(Class, EventListenerCode)
|
||||||
|
* @see EventHelper#registerEvent(Class, EventListenerCode, EventPriority)
|
||||||
|
* @since v1-alpha5
|
||||||
|
*/
|
||||||
|
private boolean reflectiveClasspathScanning = true;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates and initializes an instance of this class.
|
||||||
|
*
|
||||||
|
* @since v1-alpha6
|
||||||
|
*/
|
||||||
|
EngineInternals() {
|
||||||
|
// Only allow one instance
|
||||||
|
if (instance == null && Engine.getInstance() != null)
|
||||||
|
instance = this;
|
||||||
|
else
|
||||||
|
Logger.crash("Only one instance of this class is allowed, use getInstance() instead of creating a new instance");
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Determines whether access to the specified area is allowed.
|
||||||
|
*
|
||||||
|
* @param area internal access area to check
|
||||||
|
* @throws IllegalAccessException when restricted
|
||||||
|
* @since v1-alpha4
|
||||||
|
*/
|
||||||
|
private void isRestricted(@NotNull InternalAccessArea area) throws IllegalAccessException {
|
||||||
|
if (restrictedAreas.contains(area))
|
||||||
|
throw new IllegalAccessException("The internal access area " + area.name() + " has been restricted");
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Restricts access to certain areas of this class.
|
||||||
|
*
|
||||||
|
* @param area area to restrict
|
||||||
|
* @since v1-alpha4
|
||||||
|
*/
|
||||||
|
public void restrictAccess(@NotNull InternalAccessArea area) {
|
||||||
|
switch (area) {
|
||||||
|
case ALL -> {
|
||||||
|
List<@NotNull InternalAccessArea> areas = new ArrayList<>(List.of(InternalAccessArea.values()));
|
||||||
|
areas.remove(InternalAccessArea.ALL);
|
||||||
|
areas.remove(InternalAccessArea.ALL_READ);
|
||||||
|
areas.remove(InternalAccessArea.ALL_WRITE);
|
||||||
|
areas.remove(InternalAccessArea.ALL_READ_ESSENTIAL);
|
||||||
|
restrictedAreas.addAll(areas);
|
||||||
|
}
|
||||||
|
case ALL_WRITE -> restrictedAreas.addAll(Arrays.stream(InternalAccessArea.valuesWriteOnly()).toList());
|
||||||
|
case ALL_READ -> restrictedAreas.addAll(Arrays.stream(InternalAccessArea.valuesReadOnly()).toList());
|
||||||
|
case ALL_READ_ESSENTIAL -> restrictedAreas.addAll(Arrays.stream(InternalAccessArea.valuesEssentialReadOnly()).toList());
|
||||||
|
default -> restrictedAreas.add(area);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Installs or uninstalls the JVM shutdown
|
||||||
|
* hook, which prevents the JVM from exiting
|
||||||
|
* before the engine has fully shut down.
|
||||||
|
* Highly recommended to keep enabled.
|
||||||
|
*
|
||||||
|
* @param status {@code true} to install, {@code false} otherwise
|
||||||
|
* @throws IllegalAccessException when restricted ({@link InternalAccessArea#SAFETY_SHUTDOWN_HOOK_UPDATE})
|
||||||
|
* @since v1-alpha4
|
||||||
|
*/
|
||||||
|
public void installSafetyShutdownHook(boolean status) throws IllegalAccessException {
|
||||||
|
isRestricted(InternalAccessArea.SAFETY_SHUTDOWN_HOOK_UPDATE);
|
||||||
|
|
||||||
|
try {
|
||||||
|
if (status)
|
||||||
|
Runtime.getRuntime().addShutdownHook(Engine.getInstance().getSafetyShutdownHook());
|
||||||
|
else
|
||||||
|
Runtime.getRuntime().removeShutdownHook(Engine.getInstance().getSafetyShutdownHook());
|
||||||
|
} catch (IllegalArgumentException | IllegalStateException ignored) {}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the engine's shutdown handler.
|
||||||
|
* The shutdown handler is responsible for
|
||||||
|
* shutting down the JVM safely.
|
||||||
|
*
|
||||||
|
* @return shutdown handler
|
||||||
|
* @throws IllegalAccessException when restricted ({@link InternalAccessArea#SHUTDOWN_HANDLER_GET})
|
||||||
|
* @since v1-alpha4
|
||||||
|
*/
|
||||||
|
public @NotNull ShutdownHandler getShutdownHandler() throws IllegalAccessException {
|
||||||
|
isRestricted(InternalAccessArea.SHUTDOWN_HANDLER_GET);
|
||||||
|
return Engine.getInstance().getShutdownHandler();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the engine's shutdown handler.
|
||||||
|
* The shutdown handler is responsible for
|
||||||
|
* shutting down the JVM safely.
|
||||||
|
*
|
||||||
|
* @param shutdownHandler new shutdown handler
|
||||||
|
* @throws IllegalAccessException when restricted ({@link InternalAccessArea#SHUTDOWN_HANDLER_UPDATE})
|
||||||
|
* @since v1-alpha4
|
||||||
|
*/
|
||||||
|
public void setShutdownHandler(@NotNull ShutdownHandler shutdownHandler) throws IllegalAccessException {
|
||||||
|
isRestricted(InternalAccessArea.SHUTDOWN_HANDLER_UPDATE);
|
||||||
|
Engine.getInstance().setShutdownHandler(shutdownHandler);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns whether the engine should reflectively
|
||||||
|
* search the classpath for events or other annotations.
|
||||||
|
* <p>
|
||||||
|
* If disabled, code will either have to manually call
|
||||||
|
* registration methods or certain classes have to
|
||||||
|
* be created in a certain package, depending on the
|
||||||
|
* use case and application.
|
||||||
|
*
|
||||||
|
* @return reflective classpath scanning flag state
|
||||||
|
* @throws IllegalAccessException when restricted ({@link InternalAccessArea#REFLECTIVE_CLASSPATH_SCANNING_GET})
|
||||||
|
* @see EventHelper#registerEvent(Class, EventListenerCode)
|
||||||
|
* @see EventHelper#registerEvent(Class, EventListenerCode, EventPriority)
|
||||||
|
* @since v1-alpha5
|
||||||
|
*/
|
||||||
|
public boolean getReflectiveClasspathScanning() throws IllegalAccessException {
|
||||||
|
isRestricted(InternalAccessArea.REFLECTIVE_CLASSPATH_SCANNING_GET);
|
||||||
|
return reflectiveClasspathScanning;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Overrides whether the engine should reflectively
|
||||||
|
* search the classpath for events or other annotations.
|
||||||
|
* <p>
|
||||||
|
* If disabled, code will either have to manually call
|
||||||
|
* registration methods or certain classes have to
|
||||||
|
* be created in a certain package, depending on the
|
||||||
|
* use case and application.
|
||||||
|
* <p>
|
||||||
|
* Enabling reflective classpath scanning in an unsupported
|
||||||
|
* environment may cause minor to extreme side effects,
|
||||||
|
* including but not limited to <b>bugs, exceptions, engine
|
||||||
|
* or even whole JVM crashes</b>. <i>You have been warned!</i>
|
||||||
|
*
|
||||||
|
* @param reflectiveClasspathScanning new reflective classpath scanning
|
||||||
|
* @throws IllegalAccessException when restricted ({@link InternalAccessArea#REFLECTIVE_CLASSPATH_SCANNING_OVERRIDE})
|
||||||
|
* @see EventHelper#registerEvent(Class, EventListenerCode)
|
||||||
|
* @see EventHelper#registerEvent(Class, EventListenerCode, EventPriority)
|
||||||
|
* @since v1-alpha5
|
||||||
|
*/
|
||||||
|
public void overrideReflectiveClasspathScanning(boolean reflectiveClasspathScanning) throws IllegalAccessException {
|
||||||
|
isRestricted(InternalAccessArea.REFLECTIVE_CLASSPATH_SCANNING_OVERRIDE);
|
||||||
|
this.reflectiveClasspathScanning = reflectiveClasspathScanning;
|
||||||
|
}
|
||||||
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,16 +17,19 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.annotations;
|
package de.staropensource.engine.base.annotation;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.implementable.SubsystemClass;
|
||||||
|
|
||||||
import java.lang.annotation.*;
|
import java.lang.annotation.*;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This annotation marks a class as a subsystem main class.
|
* Marks a class as a subsystem main class.
|
||||||
|
* Make sure your subsystem implements {@link SubsystemClass}.
|
||||||
*
|
*
|
||||||
* @since 1-alpha1
|
* @see SubsystemClass
|
||||||
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings("unused")
|
|
||||||
@Retention(RetentionPolicy.RUNTIME)
|
@Retention(RetentionPolicy.RUNTIME)
|
||||||
@Target(ElementType.TYPE)
|
@Target(ElementType.TYPE)
|
||||||
@Documented
|
@Documented
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,37 +17,39 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.annotations;
|
package de.staropensource.engine.base.annotation;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.Event;
|
import de.staropensource.engine.base.implementable.Event;
|
||||||
import de.staropensource.sosengine.base.types.EventPriority;
|
import de.staropensource.engine.base.type.EventPriority;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
import java.lang.annotation.*;
|
import java.lang.annotation.*;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This annotation allows methods to listen on certain events.
|
* Marks a method as an event listener, allowing it
|
||||||
|
* to respond to an events when it is emitted.
|
||||||
*
|
*
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings("unused")
|
|
||||||
@Retention(RetentionPolicy.RUNTIME)
|
@Retention(RetentionPolicy.RUNTIME)
|
||||||
@Target(ElementType.METHOD)
|
@Target(ElementType.METHOD)
|
||||||
@Documented
|
@Documented
|
||||||
public @interface EventListener {
|
public @interface EventListener {
|
||||||
/**
|
/**
|
||||||
* The event to listen for.
|
* Specifies the event to listen for.
|
||||||
*
|
*
|
||||||
* @return the event the method listens for
|
* @return event to listen on
|
||||||
|
* @see Event
|
||||||
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
@NotNull
|
@NotNull Class<? extends Event> event();
|
||||||
Class<? extends Event> event();
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The priority of the event.
|
* Specifies the priority of the event.
|
||||||
*
|
*
|
||||||
* @return the event priority
|
* @return event priority
|
||||||
|
* @see EventPriority
|
||||||
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
@NotNull
|
@NotNull EventPriority priority() default EventPriority.DEFAULT;
|
||||||
EventPriority priority() default EventPriority.DEFAULT;
|
|
||||||
}
|
}
|
|
@ -0,0 +1,26 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Annotations used by the sos!engine to access
|
||||||
|
* classes and methods using reflection.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
package de.staropensource.engine.base.annotation;
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,20 +17,21 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.events;
|
package de.staropensource.engine.base.event;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.Event;
|
import de.staropensource.engine.base.implementable.Event;
|
||||||
import de.staropensource.sosengine.base.classes.helpers.EventHelper;
|
import de.staropensource.engine.base.implementable.helper.EventHelper;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Called in the event of an engine crash, just before the JVM exists.
|
* Called in the event of an engine crash.
|
||||||
*
|
*
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused" })
|
|
||||||
public final class EngineCrashEvent implements Event {
|
public final class EngineCrashEvent implements Event {
|
||||||
/**
|
/**
|
||||||
* Constructs this class.
|
* Creates and initializes an instance of this event.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
public EngineCrashEvent() {}
|
public EngineCrashEvent() {}
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,19 +17,21 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.events;
|
package de.staropensource.engine.base.event;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.Event;
|
import de.staropensource.engine.base.implementable.Event;
|
||||||
import de.staropensource.sosengine.base.classes.helpers.EventHelper;
|
import de.staropensource.engine.base.implementable.helper.EventHelper;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Called when the engine and JVM are about to shutdown.
|
* Called when the engine is about to shutdown.
|
||||||
*
|
*
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
public final class EngineShutdownEvent implements Event {
|
public final class EngineShutdownEvent implements Event {
|
||||||
/**
|
/**
|
||||||
* Constructs this class.
|
* Creates and initializes an instance of this event.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
public EngineShutdownEvent() {}
|
public EngineShutdownEvent() {}
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,21 +17,25 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.events;
|
package de.staropensource.engine.base.event;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.Event;
|
import de.staropensource.engine.base.implementable.Event;
|
||||||
import de.staropensource.sosengine.base.classes.helpers.EventHelper;
|
import de.staropensource.engine.base.implementable.helper.EventHelper;
|
||||||
|
import de.staropensource.engine.base.logging.Logger;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Called in the event of a soft engine crash
|
* Called in the event of a soft engine crash
|
||||||
* ie. a crash which was declared as handled.
|
* ie. when a crash report is thrown but marked
|
||||||
|
* as handled.
|
||||||
*
|
*
|
||||||
* @since 1-alpha0
|
* @see Logger#crash(Class, String, String, String, Throwable, boolean)
|
||||||
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused" })
|
|
||||||
public final class EngineSoftCrashEvent implements Event {
|
public final class EngineSoftCrashEvent implements Event {
|
||||||
/**
|
/**
|
||||||
* Constructs this class.
|
* Creates and initializes an instance of this event.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
public EngineSoftCrashEvent() {}
|
public EngineSoftCrashEvent() {}
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,23 +17,26 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.internal.events;
|
package de.staropensource.engine.base.event;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.Event;
|
import de.staropensource.engine.base.implementable.Event;
|
||||||
import de.staropensource.sosengine.base.classes.helpers.EventHelper;
|
import de.staropensource.engine.base.implementable.helper.EventHelper;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Called when the engine and JVM are about to shutdown, after {@link de.staropensource.sosengine.base.events.EngineShutdownEvent}.
|
* Called when the engine is about to shutdown, after {@link de.staropensource.engine.base.event.EngineShutdownEvent}.
|
||||||
|
* <p>
|
||||||
|
* Meant for subsystems to perform cleanup and shutdown routines, not for applications.
|
||||||
*
|
*
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
public class InternalEngineShutdownEvent implements Event {
|
public final class InternalEngineShutdownEvent implements Event {
|
||||||
/**
|
/**
|
||||||
* Constructs this class.
|
* Creates and initializes an instance of this event.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
public InternalEngineShutdownEvent() {}
|
public InternalEngineShutdownEvent() {}
|
||||||
|
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
/** {@inheritDoc} */
|
||||||
@Override
|
@Override
|
||||||
public void callEvent() {
|
public void callEvent() {
|
|
@ -0,0 +1,64 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.base.event;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.implementable.Event;
|
||||||
|
import de.staropensource.engine.base.implementable.helper.EventHelper;
|
||||||
|
import de.staropensource.engine.base.type.logging.LogLevel;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
import org.jetbrains.annotations.Nullable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Called before a new log message is printed.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
public final class LogEvent implements Event {
|
||||||
|
/**
|
||||||
|
* Creates and initializes an instance of this event.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
public LogEvent() {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@inheritDoc}
|
||||||
|
*
|
||||||
|
* @deprecated use the {@code callEvent} method with arguments
|
||||||
|
* @see #callEvent(LogLevel, Class, String, String, String)
|
||||||
|
*/
|
||||||
|
@Deprecated
|
||||||
|
@Override
|
||||||
|
public void callEvent() {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Emits the event and calls all event listeners.
|
||||||
|
*
|
||||||
|
* @param level level
|
||||||
|
* @param issuerClass issuer class
|
||||||
|
* @param issuerOrigin issuer origin
|
||||||
|
* @param issuerMetadata issuer metadata
|
||||||
|
* @param message message
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
public void callEvent(@NotNull LogLevel level, @NotNull Class<?> issuerClass, @NotNull String issuerOrigin, @Nullable String issuerMetadata, @NotNull String message) {
|
||||||
|
EventHelper.invokeAnnotatedMethods(getClass(), level, issuerClass, issuerOrigin, issuerMetadata, message);
|
||||||
|
}
|
||||||
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,31 +17,30 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.events;
|
package de.staropensource.engine.base.event;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.EngineConfiguration;
|
import de.staropensource.engine.base.implementable.Event;
|
||||||
import de.staropensource.sosengine.base.classes.Event;
|
import de.staropensource.engine.base.implementable.helper.EventHelper;
|
||||||
import de.staropensource.sosengine.base.classes.helpers.EventHelper;
|
import de.staropensource.engine.base.utility.Miscellaneous;
|
||||||
import de.staropensource.sosengine.base.utility.Miscellaneous;
|
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
import java.lang.reflect.InvocationTargetException;
|
|
||||||
import java.lang.reflect.Method;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Called when an exception is caught.
|
* Called when an exception is caught by {@link Miscellaneous#executeSafely(Runnable, String)}.
|
||||||
*
|
*
|
||||||
* @see Miscellaneous#executeSafely(Runnable, String)
|
* @see Miscellaneous#executeSafely(Runnable, String)
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
public final class ThrowableCatchEvent implements Event {
|
public final class ThrowableCatchEvent implements Event {
|
||||||
/**
|
/**
|
||||||
* Constructs this class.
|
* Creates and initializes an instance of this event.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
public ThrowableCatchEvent() {}
|
public ThrowableCatchEvent() {}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* {@inheritDoc}
|
* {@inheritDoc}
|
||||||
|
*
|
||||||
* @deprecated use the {@code callEvent} method with arguments
|
* @deprecated use the {@code callEvent} method with arguments
|
||||||
* @see ThrowableCatchEvent#callEvent(Throwable, String)
|
* @see ThrowableCatchEvent#callEvent(Throwable, String)
|
||||||
*/
|
*/
|
||||||
|
@ -50,26 +49,13 @@ public final class ThrowableCatchEvent implements Event {
|
||||||
public void callEvent() {}
|
public void callEvent() {}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Calls the event and notifies all annotated methods.
|
* Emits the event and calls all event listeners.
|
||||||
*
|
*
|
||||||
* @param throwable caught throwable
|
* @param throwable caught throwable
|
||||||
* @param identifier an identifier given to the runnable
|
* @param identifier an identifier given to the runnable
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
public void callEvent(@NotNull Throwable throwable, @NotNull String identifier) {
|
public void callEvent(@NotNull Throwable throwable, @NotNull String identifier) {
|
||||||
Runnable eventCode = Thread.ofVirtual().start(() -> {
|
EventHelper.invokeAnnotatedMethods(getClass(), throwable, identifier);
|
||||||
EventHelper.logCall(getClass(), throwable, identifier);
|
|
||||||
|
|
||||||
for (Method method : EventHelper.getAnnotatedMethods(getClass())) {
|
|
||||||
try {
|
|
||||||
method.invoke(null, throwable, identifier);
|
|
||||||
} catch (IllegalAccessException | IllegalArgumentException | InvocationTargetException | NullPointerException | ExceptionInInitializerError ignored) {}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
if (EngineConfiguration.getInstance().isOptimizeEvents())
|
|
||||||
Thread.ofVirtual().start(eventCode);
|
|
||||||
else
|
|
||||||
eventCode.run();
|
|
||||||
}
|
}
|
||||||
}
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -18,8 +18,8 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Contains logging-related data types.
|
* Events. There's nothing more to say.
|
||||||
*
|
*
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
package de.staropensource.sosengine.base.types.logging;
|
package de.staropensource.engine.base.event;
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,29 +17,30 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.graphics.vulkan;
|
package de.staropensource.engine.base.exception;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.types.vectors.Vec2i;
|
|
||||||
import de.staropensource.sosengine.graphics.classes.ApiManagementClass;
|
|
||||||
import de.staropensource.sosengine.graphics.classes.Window;
|
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The Vulkan API management class.
|
* Thrown the throwing method is not allowed to be called.
|
||||||
*
|
*
|
||||||
* @since 1-alpha0
|
* @since v1-alpha4
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused" })
|
public class IllegalAccessException extends RuntimeException {
|
||||||
public class VulkanManagement implements ApiManagementClass {
|
|
||||||
/**
|
/**
|
||||||
* Constructs this class.
|
* Creates and initializes an instance of this exception.
|
||||||
|
*
|
||||||
|
* @since v1-alpha2
|
||||||
*/
|
*/
|
||||||
public VulkanManagement() {}
|
public IllegalAccessException() {}
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
/**
|
||||||
@NotNull
|
* Creates and initializes an instance of this exception.
|
||||||
@Override
|
*
|
||||||
public Window createWindow(String title, Vec2i size) {
|
* @param message message
|
||||||
return null;
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public IllegalAccessException(@NotNull String message) {
|
||||||
|
super(message);
|
||||||
}
|
}
|
||||||
}
|
}
|
|
@ -0,0 +1,39 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.base.exception;
|
||||||
|
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Thrown when something fails to parse.
|
||||||
|
*
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public class ParserException extends RuntimeException {
|
||||||
|
/**
|
||||||
|
* Creates and initializes an instance of this exception.
|
||||||
|
*
|
||||||
|
* @param message parsing error
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public ParserException(@NotNull String message) {
|
||||||
|
super(message);
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,42 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.base.exception;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.type.Tristate;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Thrown when converting a {@link Tristate} into a {@link Boolean} fails.
|
||||||
|
* <p>
|
||||||
|
* This exception inherits {@link RuntimeException} on purpose,
|
||||||
|
* as sometimes you may sure/have already validated that the
|
||||||
|
* {@link Tristate} is not {@link Tristate#UNSET}.
|
||||||
|
*
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public class TristateConversionException extends RuntimeException {
|
||||||
|
/**
|
||||||
|
* Creates and initializes an instance of this exception.
|
||||||
|
*
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public TristateConversionException() {
|
||||||
|
super("Tristate.UNSET cannot be converted into a boolean");
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,48 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.base.exception;
|
||||||
|
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Thrown when a sequence of if checks or switch cases fail unexpectedly.
|
||||||
|
*
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public class UnexpectedCheckEndException extends RuntimeException {
|
||||||
|
/**
|
||||||
|
* Creates and initializes an instance of this exception.
|
||||||
|
*
|
||||||
|
* @param checkOccurrence the sequence of checks that failed
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public UnexpectedCheckEndException(@NotNull String checkOccurrence) {
|
||||||
|
super("A sequence of if checks or switch cases failed unexpectedly while " + checkOccurrence);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates and initializes an instance of this exception.
|
||||||
|
*
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public UnexpectedCheckEndException() {
|
||||||
|
super("A sequence of if checks or switch cases failed unexpectedly");
|
||||||
|
}
|
||||||
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,22 +17,22 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.exceptions;
|
package de.staropensource.engine.base.exception.dependency;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.utility.DependencyResolver;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Represents an exception caused by a dependency cycle.
|
* Thrown when the {@link DependencyResolver} detects a dependency cycle.
|
||||||
*
|
*
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused" })
|
public class DependencyCycleException extends RuntimeException {
|
||||||
public class DependencyCycleException extends Exception {
|
|
||||||
/**
|
/**
|
||||||
* Constructs this exception.
|
* Creates and initializes an instance of this exception.
|
||||||
*
|
*
|
||||||
* @param path cycle path
|
* @param path cycle path
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
public DependencyCycleException(@NotNull String path) {
|
public DependencyCycleException(@NotNull String path) {
|
||||||
super("Dependency cycle detected: " + path);
|
super("Dependency cycle detected: " + path);
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,50 +17,44 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.exceptions;
|
package de.staropensource.engine.base.exception.dependency;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.types.DependencyVector;
|
import de.staropensource.engine.base.type.DependencyVector;
|
||||||
|
import de.staropensource.engine.base.utility.DependencyResolver;
|
||||||
import lombok.Getter;
|
import lombok.Getter;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
import java.util.Map;
|
import java.util.List;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Represents an exception caused by unmet dependencies.
|
* Thrown when the {@link DependencyResolver} cannot resolve one
|
||||||
|
* or more {@link DependencyVector}s due to unmet dependencies.
|
||||||
*
|
*
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
|
|
||||||
@Getter
|
@Getter
|
||||||
|
@SuppressWarnings({ "JavadocDeclaration" })
|
||||||
public class UnmetDependenciesException extends Exception {
|
public class UnmetDependenciesException extends Exception {
|
||||||
/**
|
/**
|
||||||
* Contains the unmet dependencies list supplied to the constructor.
|
* Contains the unmet dependencies list supplied to the constructor.
|
||||||
* <p>
|
|
||||||
* The key contains the {@link DependencyVector} that has unmet dependencies,
|
|
||||||
* while the value contains the error string ie. which dependency is unmet and why.
|
|
||||||
*
|
|
||||||
* @since 1-alpha1
|
|
||||||
*
|
*
|
||||||
|
* @since v1-alpha4
|
||||||
* -- GETTER --
|
* -- GETTER --
|
||||||
* Returns the unmet dependencies list supplied to the constructor.
|
* Returns the unmet dependencies list supplied to the constructor.
|
||||||
* <p>
|
|
||||||
* The key contains the {@link DependencyVector} that has unmet dependencies,
|
|
||||||
* while the value contains the error string ie. which dependency is unmet and why.
|
|
||||||
*
|
*
|
||||||
* @return unmet dependencies list
|
* @return unmet dependencies list
|
||||||
* @since 1-alpha1
|
* @since v1-alpha4
|
||||||
*/
|
*/
|
||||||
@NotNull
|
private final @NotNull List<@NotNull String> unmetDependencies;
|
||||||
private final Map<@NotNull DependencyVector, @NotNull String> unmetDependencies;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Constructs this exception.
|
* Creates and initializes an instance of this event.
|
||||||
*
|
*
|
||||||
* @param unmetDependencies map of unmet dependencies
|
* @param unmetDependencies map of all unmet dependencies
|
||||||
* @since 1-alpha1
|
* @see #unmetDependencies
|
||||||
* @see UnmetDependenciesException#unmetDependencies
|
* @since v1-alpha4
|
||||||
*/
|
*/
|
||||||
public UnmetDependenciesException(@NotNull Map<@NotNull DependencyVector, @NotNull String> unmetDependencies) {
|
public UnmetDependenciesException(@NotNull List<@NotNull String> unmetDependencies) {
|
||||||
this.unmetDependencies = unmetDependencies;
|
this.unmetDependencies = unmetDependencies;
|
||||||
}
|
}
|
||||||
}
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -18,9 +18,9 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Contains a set of built-in logger implementations
|
* Exceptions related to dependency resolving.
|
||||||
* that all print log output a bit differently.
|
|
||||||
*
|
*
|
||||||
* @since 1-alpha1
|
* @see de.staropensource.engine.base.utility.DependencyResolver
|
||||||
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
package de.staropensource.sosengine.base.logging.implementation;
|
package de.staropensource.engine.base.exception.dependency;
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -18,8 +18,8 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Contains engine-internal stuff, not part of the API.
|
* Exceptions thrown by the engine, subsystems and applications.
|
||||||
*
|
*
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
package de.staropensource.sosengine.base.internal;
|
package de.staropensource.engine.base.exception;
|
|
@ -0,0 +1,53 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.base.exception.reflection;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.type.reflection.ClassType;
|
||||||
|
import de.staropensource.engine.base.utility.ListFormatter;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Thrown when the invoked method does not apply to the type of the class.
|
||||||
|
*
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public class IncompatibleTypeException extends RuntimeException {
|
||||||
|
/**
|
||||||
|
* Creates and initializes an instance of this exception.
|
||||||
|
*
|
||||||
|
* @param methodName name of the method that failed
|
||||||
|
* @param requiredClassType class type received by the method
|
||||||
|
* @param compatibleTypes class types the method is compatible with
|
||||||
|
*/
|
||||||
|
public IncompatibleTypeException(@NotNull String methodName, @NotNull ClassType requiredClassType, @NotNull ClassType @NotNull [] compatibleTypes) {
|
||||||
|
super("The method ReflectionClass#" + methodName + " only applies to type(s) " + ListFormatter.formatArray(compatibleTypes) + ", not " + requiredClassType.name());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates and initializes an instance of this exception.
|
||||||
|
*
|
||||||
|
* @param methodName name of the method that failed
|
||||||
|
* @param requiredClassType class type received by the method
|
||||||
|
* @param compatibleType class type the method is compatible with
|
||||||
|
*/
|
||||||
|
public IncompatibleTypeException(@NotNull String methodName, @NotNull ClassType requiredClassType, @NotNull ClassType compatibleType) {
|
||||||
|
super("The method ReflectionClass#" + methodName + " only applies to type(s) " + ListFormatter.formatArray(new ClassType[]{ compatibleType }) + ", not " + requiredClassType.name());
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,39 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.base.exception.reflection;
|
||||||
|
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Thrown when trying to call an instance (non-static) method from a static context.
|
||||||
|
*
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public class InstanceMethodFromStaticContextException extends Exception {
|
||||||
|
/**
|
||||||
|
* Creates and initializes an instance of this exception.
|
||||||
|
*
|
||||||
|
* @param methodName name of the method
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public InstanceMethodFromStaticContextException(@NotNull String methodName) {
|
||||||
|
super("Method " + methodName + " could not be called as the method is non-static and was called from a static context");
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,40 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.base.exception.reflection;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.reflection.ReflectionClass;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Thrown when a field could not be found.
|
||||||
|
*
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public class InvalidFieldException extends Exception {
|
||||||
|
/**
|
||||||
|
* Creates and initializes an instance of this exception.
|
||||||
|
*
|
||||||
|
* @param clazz caller {@link ReflectionClass}
|
||||||
|
* @param fieldName name of the invalid field
|
||||||
|
*/
|
||||||
|
public InvalidFieldException(@NotNull ReflectionClass clazz, @NotNull String fieldName) {
|
||||||
|
super("Invalid field name \"" + fieldName + "\" in class " + clazz.getPath());
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,40 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.base.exception.reflection;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.reflection.ReflectionClass;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Thrown when a method could not be found.
|
||||||
|
*
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public class InvalidMethodException extends Exception {
|
||||||
|
/**
|
||||||
|
* Creates and initializes an instance of this exception.
|
||||||
|
*
|
||||||
|
* @param clazz caller {@link ReflectionClass}
|
||||||
|
* @param fieldName name of the invalid method
|
||||||
|
*/
|
||||||
|
public InvalidMethodException(@NotNull ReflectionClass clazz, @NotNull String fieldName) {
|
||||||
|
super("Invalid method name \"" + fieldName + "\" in class " + clazz.getPath());
|
||||||
|
}
|
||||||
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,26 +17,23 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.graphics.classes;
|
package de.staropensource.engine.base.exception.reflection;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.types.vectors.Vec2i;
|
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The interface for Graphics API management classes.
|
* Thrown when a method could not be found due to an invalid method signature.
|
||||||
*
|
*
|
||||||
* @since 1-alpha0
|
* @since v1-alpha5
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused" })
|
public class InvalidMethodSignatureException extends Exception {
|
||||||
public interface ApiManagementClass {
|
|
||||||
/**
|
/**
|
||||||
* Creates a new {@link Window}.
|
* Creates and initializes an instance of this exception.
|
||||||
*
|
*
|
||||||
* @param title initial window title
|
* @param methodName method name
|
||||||
* @param size initial window size
|
* @since v1-alpha5
|
||||||
* @return new window
|
|
||||||
* @since 1-alpha0
|
|
||||||
*/
|
*/
|
||||||
@NotNull
|
public InvalidMethodSignatureException(@NotNull String methodName) {
|
||||||
Window createWindow(String title, Vec2i size);
|
super("Method " + methodName + " has a different method signature");
|
||||||
|
}
|
||||||
}
|
}
|
|
@ -0,0 +1,40 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.base.exception.reflection;
|
||||||
|
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Thrown if access to some class, method or field has been denied.
|
||||||
|
*
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public class NoAccessException extends Exception {
|
||||||
|
/**
|
||||||
|
* Creates and initializes an instance of this exception.
|
||||||
|
*
|
||||||
|
* @param type {@code class}, {@code method} or {@code field}
|
||||||
|
* @param name class, method or field name
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public NoAccessException(@NotNull String type, @NotNull String name) {
|
||||||
|
super("Access to " + type + " " + name + " has been denied");
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,54 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.base.exception.reflection;
|
||||||
|
|
||||||
|
import lombok.Getter;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Thrown when an exception is thrown by a static initializer.
|
||||||
|
*
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
@SuppressWarnings({ "JavadocDeclaration" })
|
||||||
|
public class StaticInitializerException extends Exception {
|
||||||
|
/**
|
||||||
|
* Contains the throwable thrown by the static initializer.
|
||||||
|
*
|
||||||
|
* @since v1-alpha2
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the throwable thrown by the static initializer.
|
||||||
|
*
|
||||||
|
* @return throwable thrown by the static initializer
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
private final @NotNull Throwable throwable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates and initializes an instance of this exception.
|
||||||
|
*
|
||||||
|
* @param throwable throwable thrown by the static initializer
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public StaticInitializerException(@NotNull Throwable throwable) {
|
||||||
|
this.throwable = throwable;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,26 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exceptions related to reflection.
|
||||||
|
*
|
||||||
|
* @see de.staropensource.engine.base.reflection
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
package de.staropensource.engine.base.exception.reflection;
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,23 +17,23 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.exceptions;
|
package de.staropensource.engine.base.exception.versioning;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.VersioningSystem;
|
import de.staropensource.engine.base.implementable.VersioningSystem;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Represents an exception caused by supplying an invalid or unexpected versioning system.
|
* Thrown when trying to compare a {@link VersioningSystem} against another
|
||||||
|
* {@link VersioningSystem}, which it does not support.
|
||||||
*
|
*
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused" })
|
public class IncompatibleVersioningSystemException extends RuntimeException {
|
||||||
public class IncompatibleVersioningSystemException extends Exception {
|
|
||||||
/**
|
/**
|
||||||
* Constructs this exception.
|
* Creates and initializes an instance of this exception.
|
||||||
*
|
*
|
||||||
* @param required required versioning system ie. the versioning system throwing this error
|
* @param required required versioning system ie. the versioning system throwing this error
|
||||||
* @param found found versioning system ie. the incompatible one
|
* @param found found versioning system ie. the incompatible one
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
public IncompatibleVersioningSystemException(VersioningSystem required, VersioningSystem found) {
|
public IncompatibleVersioningSystemException(VersioningSystem required, VersioningSystem found) {
|
||||||
super("The versioning system " + required + " is incompatible with " + found);
|
super("The versioning system " + required + " is incompatible with " + found);
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,44 +17,47 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.exceptions;
|
package de.staropensource.engine.base.exception.versioning;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.VersioningSystem;
|
import de.staropensource.engine.base.implementable.VersioningSystem;
|
||||||
import lombok.Getter;
|
import lombok.Getter;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
import org.jetbrains.annotations.Nullable;
|
import org.jetbrains.annotations.Nullable;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Represents an exception caused by an invalid version string.
|
* Thrown when an invalid version string is supplied
|
||||||
|
* to an implementation of {@link VersioningSystem}.
|
||||||
*
|
*
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
@Getter
|
@Getter
|
||||||
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
|
@SuppressWarnings({ "JavadocDeclaration" })
|
||||||
public class InvalidVersionStringException extends Exception {
|
public class InvalidVersionStringException extends Exception {
|
||||||
/**
|
/**
|
||||||
* Contains the throwable supplied to the constructor.
|
* Contains the throwable supplied to the constructor.
|
||||||
*
|
*
|
||||||
* @since 1-alpha1
|
* @see #InvalidVersionStringException(VersioningSystem, String, Throwable)
|
||||||
*
|
* @see #InvalidVersionStringException(VersioningSystem, String, String, Throwable)
|
||||||
|
* @since v1-alpha1
|
||||||
* -- GETTER --
|
* -- GETTER --
|
||||||
* Returns the throwable supplied by the constructor.
|
* Returns the throwable supplied by the constructor.
|
||||||
*
|
*
|
||||||
* @return throwable
|
* @return throwable
|
||||||
* @since 1-alpha1
|
* @see #InvalidVersionStringException(VersioningSystem, String, Throwable)
|
||||||
|
* @see #InvalidVersionStringException(VersioningSystem, String, String, Throwable)
|
||||||
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
@Nullable
|
private final @Nullable Throwable throwable;
|
||||||
private final Throwable throwable;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Constructs this exception.
|
* Creates and initializes an instance of this exception.
|
||||||
*
|
*
|
||||||
* @param versioningSystem versioning system that is unable to parse version strings
|
* @param versioningSystem versioning system that is unable to parse version strings
|
||||||
* @param versionString version string {@code a}
|
* @param versionString version string {@code a}
|
||||||
* @param message some error message
|
* @param message some error message
|
||||||
* @param throwable throwable that caused the parsing error
|
* @param throwable throwable that caused the parsing error
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
public InvalidVersionStringException(@NotNull VersioningSystem versioningSystem, @NotNull String versionString, @NotNull String message, @NotNull Throwable throwable) {
|
public InvalidVersionStringException(@NotNull VersioningSystem versioningSystem, @NotNull String versionString, @NotNull String message, @NotNull Throwable throwable) {
|
||||||
super("Versioning system " + versioningSystem.getName() + " can't parse version string \"" + versionString + "\": " + message);
|
super("Versioning system " + versioningSystem.getName() + " can't parse version string \"" + versionString + "\": " + message);
|
||||||
|
@ -62,12 +65,12 @@ public class InvalidVersionStringException extends Exception {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Constructs this exception.
|
* Creates and initializes an instance of this exception.
|
||||||
*
|
*
|
||||||
* @param versioningSystem versioning system that is unable to parse version strings
|
* @param versioningSystem versioning system that is unable to parse version strings
|
||||||
* @param versionString version string {@code a}
|
* @param versionString version string {@code a}
|
||||||
* @param message some error message
|
* @param message some error message
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
public InvalidVersionStringException(@NotNull VersioningSystem versioningSystem, @NotNull String versionString, @NotNull String message) {
|
public InvalidVersionStringException(@NotNull VersioningSystem versioningSystem, @NotNull String versionString, @NotNull String message) {
|
||||||
super("Versioning system " + versioningSystem.getName() + " can't parse version string \"" + versionString + "\": " + message);
|
super("Versioning system " + versioningSystem.getName() + " can't parse version string \"" + versionString + "\": " + message);
|
||||||
|
@ -75,12 +78,12 @@ public class InvalidVersionStringException extends Exception {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Constructs this exception.
|
* Creates and initializes an instance of this exception.
|
||||||
*
|
*
|
||||||
* @param versioningSystem versioning system that is unable to parse version strings
|
* @param versioningSystem versioning system that is unable to parse version strings
|
||||||
* @param versionString version string {@code a}
|
* @param versionString version string {@code a}
|
||||||
* @param throwable throwable that caused the parsing error
|
* @param throwable throwable that caused the parsing error
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
public InvalidVersionStringException(@NotNull VersioningSystem versioningSystem, @NotNull String versionString, @NotNull Throwable throwable) {
|
public InvalidVersionStringException(@NotNull VersioningSystem versioningSystem, @NotNull String versionString, @NotNull Throwable throwable) {
|
||||||
super("Versioning system " + versioningSystem.getName() + " can't parse version string \"" + versionString + "\"");
|
super("Versioning system " + versioningSystem.getName() + " can't parse version string \"" + versionString + "\"");
|
||||||
|
@ -88,11 +91,11 @@ public class InvalidVersionStringException extends Exception {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Constructs this exception.
|
* Creates and initializes an instance of this exception.
|
||||||
*
|
*
|
||||||
* @param versioningSystem versioning system that is unable to parse version strings
|
* @param versioningSystem versioning system that is unable to parse version strings
|
||||||
* @param versionString version string {@code a}
|
* @param versionString version string {@code a}
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
public InvalidVersionStringException(@NotNull VersioningSystem versioningSystem, @NotNull String versionString) {
|
public InvalidVersionStringException(@NotNull VersioningSystem versioningSystem, @NotNull String versionString) {
|
||||||
super("Versioning system " + versioningSystem.getName() + " can't parse version string \"" + versionString + "\"");
|
super("Versioning system " + versioningSystem.getName() + " can't parse version string \"" + versionString + "\"");
|
|
@ -0,0 +1,26 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exceptions thrown by implementations of {@link de.staropensource.engine.base.implementable.VersioningSystem}s.
|
||||||
|
*
|
||||||
|
* @see de.staropensource.engine.base.implementable.VersioningSystem
|
||||||
|
* @since v1-alpha1
|
||||||
|
*/
|
||||||
|
package de.staropensource.engine.base.exception.versioning;
|
|
@ -0,0 +1,132 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.base.implementable;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.utility.PropertiesReader;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
import org.jetbrains.annotations.Nullable;
|
||||||
|
|
||||||
|
import java.util.Properties;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Interface for implementing configuration classes.
|
||||||
|
* <p>
|
||||||
|
* Configuration classes use {@link Properties} objects to modify
|
||||||
|
* their settings as they can be supplied to the JVM's arguments
|
||||||
|
* and can be written to and read from during runtime.
|
||||||
|
*
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public abstract class Configuration {
|
||||||
|
/**
|
||||||
|
* Creates and initializes an instance of this abstract class.
|
||||||
|
*
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
protected Configuration() {
|
||||||
|
// Load default configuration
|
||||||
|
loadDefaultConfiguration();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Loads all settings from the specified {@link Properties} object.
|
||||||
|
* Unless you want to override settings, consider invoking {@link #loadDefaultConfiguration()} first.
|
||||||
|
*
|
||||||
|
* @param properties {@link Properties} to read from
|
||||||
|
* @see #loadDefaultConfiguration()
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public void loadConfiguration(@NotNull Properties properties) {
|
||||||
|
PropertiesReader parser = new PropertiesReader(properties);
|
||||||
|
|
||||||
|
// Loop through all properties
|
||||||
|
for (String property : properties.stringPropertyNames()) {
|
||||||
|
// Check if property name starts with group
|
||||||
|
if (!property.startsWith(getGroup()))
|
||||||
|
continue;
|
||||||
|
|
||||||
|
// Remove group
|
||||||
|
property = property.substring(getGroup().length());
|
||||||
|
|
||||||
|
// Overwrite matching settings
|
||||||
|
try {
|
||||||
|
matchProperty(parser, property);
|
||||||
|
} catch (NullPointerException ignored) {}
|
||||||
|
}
|
||||||
|
|
||||||
|
processSettings(parser);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Loads all settings from the system properties.
|
||||||
|
* Useful if you want to allow the user to modify settings at startup.
|
||||||
|
*
|
||||||
|
* @see #loadConfiguration(Properties)
|
||||||
|
* @see System#getProperties()
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public void loadConfiguration() {
|
||||||
|
loadConfiguration(System.getProperties());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns prefix properties must begin with.
|
||||||
|
*
|
||||||
|
* @return property group
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public abstract @NotNull String getGroup();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Loads the default subsystem configuration.
|
||||||
|
*
|
||||||
|
* @see #loadConfiguration()
|
||||||
|
* @see #loadConfiguration(Properties)
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
public abstract void loadDefaultConfiguration();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches the given {@code property} against all settings.
|
||||||
|
* If a match has been found, the setting will be overwritten with the property's value.
|
||||||
|
*
|
||||||
|
* @param parser matching {@link PropertiesReader}
|
||||||
|
* @param property property to match
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
protected abstract void matchProperty(@NotNull PropertiesReader parser, @NotNull String property);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Allows the implementor to process all settings and potentially
|
||||||
|
* modify them before {@link #loadConfiguration(Properties)} returns.
|
||||||
|
*
|
||||||
|
* @param parser matching {@link PropertiesReader}
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
protected abstract void processSettings(@NotNull PropertiesReader parser);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns a configuration setting.
|
||||||
|
*
|
||||||
|
* @param setting setting name
|
||||||
|
* @return setting's value or {@code null} if not found
|
||||||
|
*/
|
||||||
|
public abstract @Nullable Object getSetting(@NotNull String setting);
|
||||||
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,17 +17,21 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.classes;
|
package de.staropensource.engine.base.implementable;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.implementable.helper.EventHelper;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Represents an event.
|
* Represents an event.
|
||||||
*
|
*
|
||||||
* @since 1-alpha0
|
* @see EventHelper
|
||||||
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused" })
|
|
||||||
public interface Event {
|
public interface Event {
|
||||||
/**
|
/**
|
||||||
* Calls the event and notifies all annotated methods.
|
* Emits the event and calls all event listeners.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
void callEvent();
|
void callEvent();
|
||||||
}
|
}
|
|
@ -0,0 +1,59 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.base.implementable;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.implementable.helper.EventHelper;
|
||||||
|
import de.staropensource.engine.base.type.EventPriority;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Used by {@link EventHelper} to execute event listeners.
|
||||||
|
*
|
||||||
|
* @see Runnable
|
||||||
|
* @since v1-alpha5
|
||||||
|
*/
|
||||||
|
public abstract class EventListenerCode {
|
||||||
|
/**
|
||||||
|
* Contains the priority of this
|
||||||
|
* event listener.
|
||||||
|
* <p>
|
||||||
|
* Set automatically by {@link EventHelper},
|
||||||
|
* do not change this manually.
|
||||||
|
*
|
||||||
|
* @since v1-alpha5
|
||||||
|
*/
|
||||||
|
public @NotNull EventPriority priority = EventPriority.DEFAULT;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates and initializes an instance of this abstract class.
|
||||||
|
*
|
||||||
|
* @since v1-alpha5
|
||||||
|
*/
|
||||||
|
protected EventListenerCode() {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Invokes the event listener.
|
||||||
|
*
|
||||||
|
* @param arguments arguments passed along by the event
|
||||||
|
* @throws Exception exceptions thrown
|
||||||
|
* @since v1-alpha5
|
||||||
|
*/
|
||||||
|
public abstract void run(Object... arguments) throws Exception;
|
||||||
|
}
|
|
@ -0,0 +1,43 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.base.implementable;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.logging.Logger;
|
||||||
|
import de.staropensource.engine.base.type.logging.LogLevel;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Interface for implementing custom logger implementations.
|
||||||
|
*
|
||||||
|
* @see Logger#setLoggingAdapter(LoggingAdapter)
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
public interface LoggingAdapter {
|
||||||
|
/**
|
||||||
|
* Prints a log message.
|
||||||
|
*
|
||||||
|
* @param level level of the log call
|
||||||
|
* @param issuer {@link StackTraceElement} of the issuer
|
||||||
|
* @param message raw message
|
||||||
|
* @param format processed log call output (print this!)
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
void print(@NotNull LogLevel level, @NotNull StackTraceElement issuer, @NotNull String message, @NotNull String format);
|
||||||
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,35 +17,24 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.classes;
|
package de.staropensource.engine.base.implementable;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.utility.PlaceholderEngine;
|
import de.staropensource.engine.base.utility.PlaceholderEngine;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Interface for implementing placeholders.
|
* Interface for implementing placeholders.
|
||||||
*
|
*
|
||||||
* @see PlaceholderEngine
|
* @see PlaceholderEngine
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused" })
|
|
||||||
public interface Placeholder {
|
public interface Placeholder {
|
||||||
/**
|
/**
|
||||||
* Returns the placeholder's name.
|
* Replaces the placeholder with content.
|
||||||
*
|
|
||||||
* @return the placeholder name
|
|
||||||
* @since 1-alpha0
|
|
||||||
*/
|
|
||||||
@NotNull
|
|
||||||
String getName();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Replaces the placeholder with it's appropriate content.
|
|
||||||
*
|
*
|
||||||
* @param text text to process
|
* @param text text to process
|
||||||
* @return the processed text
|
* @return processed text
|
||||||
* @since 1-alpha0
|
* @since v1-alpha2
|
||||||
*/
|
*/
|
||||||
@NotNull
|
@NotNull String replace(@NotNull String text);
|
||||||
String replace(@NotNull String text);
|
|
||||||
}
|
}
|
|
@ -0,0 +1,218 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.base.implementable;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.EngineConfiguration;
|
||||||
|
import de.staropensource.engine.base.exception.ParserException;
|
||||||
|
import de.staropensource.engine.base.logging.Logger;
|
||||||
|
import lombok.Getter;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
import java.util.LinkedList;
|
||||||
|
import java.util.Locale;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Base class for implementing a shortcode parser.
|
||||||
|
* <p>
|
||||||
|
* This class parses a string and converts it into a list of
|
||||||
|
* components, which can then be in turn be converted to something
|
||||||
|
* else, for example, ANSI escape codes.
|
||||||
|
* <p>
|
||||||
|
* The following shortcodes are available and can be used:
|
||||||
|
* <ul>
|
||||||
|
* <li>reset</li>
|
||||||
|
* <li>fg:[black,red,green,yellow,blue,magenta,cyan,white]</li>
|
||||||
|
* <li>bg:[black,red,green,yellow,blue,magenta,cyan,white]</li>
|
||||||
|
* <li>bold</li>
|
||||||
|
* <li>italic</li>
|
||||||
|
* <li>strikethrough</li>
|
||||||
|
* <li>underline</li>
|
||||||
|
* </ul>
|
||||||
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
@SuppressWarnings({ "JavadocDeclaration" })
|
||||||
|
public abstract class ShortcodeParser {
|
||||||
|
/**
|
||||||
|
* Contains a list of components the parsed text is made out of.
|
||||||
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns a list of components the parsed text is made out of.
|
||||||
|
*
|
||||||
|
* @return component list
|
||||||
|
* @since v1-alpha1
|
||||||
|
*/
|
||||||
|
protected final @NotNull LinkedList<String> components;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates and initializes an instance of this abstract class.
|
||||||
|
*
|
||||||
|
* @param string string to parse
|
||||||
|
* @param ignoreInvalidEscapes if {@code true}, will ignore and treat invalid escapes as text
|
||||||
|
* @throws ParserException on error
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
protected ShortcodeParser(@NotNull String string, boolean ignoreInvalidEscapes) throws ParserException {
|
||||||
|
components = parse(string, ignoreInvalidEscapes);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parses the input string and returns a list
|
||||||
|
* of components the text is made out of.
|
||||||
|
*
|
||||||
|
* @param string string to parse
|
||||||
|
* @param ignoreInvalidEscapes if {@code true}, will ignore and treat invalid escapes as text
|
||||||
|
* @return list of components
|
||||||
|
* @throws ParserException on error
|
||||||
|
* @see EngineConfiguration#errorShortcodeParser
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
protected @NotNull LinkedList<@NotNull String> parse(@NotNull String string, boolean ignoreInvalidEscapes) throws ParserException {
|
||||||
|
LinkedList<String> components = new LinkedList<>(); // List of components
|
||||||
|
boolean tagActive = false; // Indicates that a tag is being parsed
|
||||||
|
boolean escape = false; // Indicates whether the last character was a \ character
|
||||||
|
StringBuilder part = new StringBuilder(); // Temporary string. May be a tag, may be regular text
|
||||||
|
|
||||||
|
// Iterate through every character
|
||||||
|
for (char character : string.toCharArray()) {
|
||||||
|
// Escaping
|
||||||
|
if (escape) {
|
||||||
|
if (character == '\\' || character == '<')
|
||||||
|
part.append(character);
|
||||||
|
else if (!(character == 'r' || character == 'n'))
|
||||||
|
if (ignoreInvalidEscapes)
|
||||||
|
part.append("\\").append(character);
|
||||||
|
else
|
||||||
|
throw new ParserException("Invalid escape \\" + character);
|
||||||
|
|
||||||
|
escape = false;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if (character == '\\') {
|
||||||
|
escape = true;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (tagActive) {
|
||||||
|
// A tag is being parsed
|
||||||
|
if (character == '>') {
|
||||||
|
// Tag is ending, disable tag parsing
|
||||||
|
tagActive = false;
|
||||||
|
|
||||||
|
// fg:*
|
||||||
|
if (part.toString().startsWith("fg:"))
|
||||||
|
if (isValidColor(part.substring(3).toUpperCase()))
|
||||||
|
components.add("COLOR:FOREGROUND:" + part.substring(3).toUpperCase());
|
||||||
|
else {
|
||||||
|
// Complain about invalid shortcode
|
||||||
|
if (EngineConfiguration.getInstance() != null && EngineConfiguration.getInstance().isErrorShortcodeParser())
|
||||||
|
Logger.sarn("Invalid shortcode: " + part);
|
||||||
|
|
||||||
|
// Convert tag regular text
|
||||||
|
components.add("TEXT:" + "<" + part + ">");
|
||||||
|
}
|
||||||
|
// bg:*
|
||||||
|
else if (part.toString().startsWith("bg:"))
|
||||||
|
if (isValidColor(part.substring(3).toUpperCase()))
|
||||||
|
components.add("COLOR:BACKGROUND:" + part.substring(3).toUpperCase());
|
||||||
|
else {
|
||||||
|
// Complain about invalid shortcode
|
||||||
|
if (EngineConfiguration.getInstance() != null && EngineConfiguration.getInstance().isErrorShortcodeParser())
|
||||||
|
Logger.sarn("Invalid shortcode: " + part);
|
||||||
|
|
||||||
|
// Convert tag regular text
|
||||||
|
components.add("TEXT:" + "<" + part + ">");
|
||||||
|
}
|
||||||
|
// bold
|
||||||
|
else if (part.toString().equals("bold"))
|
||||||
|
components.add("ATTRIBUTE:BOLD");
|
||||||
|
// italic
|
||||||
|
else if (part.toString().equals("italic"))
|
||||||
|
components.add("ATTRIBUTE:ITALIC");
|
||||||
|
// strikethrough
|
||||||
|
else if (part.toString().equals("strikethrough"))
|
||||||
|
components.add("ATTRIBUTE:STRIKETHROUGH");
|
||||||
|
// underline
|
||||||
|
else if (part.toString().equals("underline"))
|
||||||
|
components.add("ATTRIBUTE:UNDERLINE");
|
||||||
|
// blink
|
||||||
|
else if (part.toString().equals("blink"))
|
||||||
|
components.add("ATTRIBUTE:BLINK");
|
||||||
|
// reset
|
||||||
|
else if (part.toString().equals("reset"))
|
||||||
|
components.add("RESET");
|
||||||
|
|
||||||
|
// error case
|
||||||
|
else {
|
||||||
|
// Complain about invalid shortcode
|
||||||
|
if (EngineConfiguration.getInstance() != null && EngineConfiguration.getInstance().isErrorShortcodeParser())
|
||||||
|
Logger.sarn("Invalid shortcode: " + part);
|
||||||
|
|
||||||
|
// Convert tag regular text
|
||||||
|
components.add("TEXT:" + "<" + part + ">");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Empty 'part'
|
||||||
|
part = new StringBuilder();
|
||||||
|
} else
|
||||||
|
// Tag has not ended yet, add character to 'part'
|
||||||
|
// It bloats the code to do it with StringBuilder
|
||||||
|
part.append(character);
|
||||||
|
} else {
|
||||||
|
// Regular text is being parsed
|
||||||
|
if (character == '<') {
|
||||||
|
if (!part.isEmpty()) {
|
||||||
|
// Tag is starting, insert previous text
|
||||||
|
components.add("TEXT:" + part);
|
||||||
|
part = new StringBuilder();
|
||||||
|
}
|
||||||
|
|
||||||
|
tagActive = true; // Enable tag processing
|
||||||
|
} else
|
||||||
|
// Regular text, add character to 'part'
|
||||||
|
// It bloats the code to do it with StringBuilder
|
||||||
|
part.append(character);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Processing ended, insert leftover text
|
||||||
|
if (!part.isEmpty())
|
||||||
|
components.add("TEXT:" + part);
|
||||||
|
|
||||||
|
return components;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns if the specified color is valid
|
||||||
|
*
|
||||||
|
* @return {@code true} if valid, {@code false} otherwise
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
private boolean isValidColor(@NotNull String color) {
|
||||||
|
return switch (color.toLowerCase(Locale.ROOT)) {
|
||||||
|
case "black", "white", "red",
|
||||||
|
"green", "blue", "yellow",
|
||||||
|
"magenta", "cyan" -> true;
|
||||||
|
default -> false;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,42 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.base.implementable;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.Engine;
|
||||||
|
import org.jetbrains.annotations.Range;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Interface for custom shutdown handlers.
|
||||||
|
* <p>
|
||||||
|
* Shutdown handlers are responsible for shutting down
|
||||||
|
* the platform safely after the engine has shut down.
|
||||||
|
*
|
||||||
|
* @see Engine#setShutdownHandler(ShutdownHandler)
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public interface ShutdownHandler {
|
||||||
|
/**
|
||||||
|
* Executes the shutdown handler.
|
||||||
|
*
|
||||||
|
* @param exitCode exit code
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
void shutdown(@Range(from = 0, to = 255) short exitCode);
|
||||||
|
}
|
|
@ -0,0 +1,79 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.base.implementable;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.Engine;
|
||||||
|
import de.staropensource.engine.base.annotation.EngineSubsystem;
|
||||||
|
import de.staropensource.engine.base.annotation.EventListener;
|
||||||
|
import de.staropensource.engine.base.event.InternalEngineShutdownEvent;
|
||||||
|
import de.staropensource.engine.base.type.DependencyVector;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Abstract class for building subsystem main classes.
|
||||||
|
*
|
||||||
|
* @see EngineSubsystem
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
public abstract class SubsystemClass {
|
||||||
|
/**
|
||||||
|
* Creates and initializes an instance of this abstract class.
|
||||||
|
*
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
protected SubsystemClass() {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the name of the subsystem.
|
||||||
|
*
|
||||||
|
* @return subsystem name
|
||||||
|
* @since v1-alpha2
|
||||||
|
*/
|
||||||
|
public abstract @NotNull String getName();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Initializes the subsystem.
|
||||||
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
|
*/
|
||||||
|
public abstract void initializeSubsystem();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns a matching {@link DependencyVector}.
|
||||||
|
* Used for dependency resolution during startup.
|
||||||
|
*
|
||||||
|
* @return matching {@link DependencyVector} for the subsystem
|
||||||
|
* @throws IllegalStateException when building the DependencyVector fails, see {@link DependencyVector.Builder#build()}
|
||||||
|
* @see DependencyVector
|
||||||
|
* @since v1-alpha4
|
||||||
|
*/
|
||||||
|
public abstract @NotNull DependencyVector getDependencyVector() throws IllegalStateException;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Called on engine shutdown.
|
||||||
|
*
|
||||||
|
* @see Engine#shutdown()
|
||||||
|
* @see Engine#shutdown(int)
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@EventListener(event = InternalEngineShutdownEvent.class)
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
protected static void shutdownSubsystem() {}
|
||||||
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,35 +17,33 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.classes;
|
package de.staropensource.engine.base.implementable;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.exceptions.IncompatibleVersioningSystemException;
|
import de.staropensource.engine.base.exception.versioning.IncompatibleVersioningSystemException;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
import org.jetbrains.annotations.Range;
|
import org.jetbrains.annotations.Range;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* An interface used for implementing different versioning systems.
|
* Interface for building a versioning system (parser).
|
||||||
*
|
*
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused" })
|
|
||||||
public interface VersioningSystem {
|
public interface VersioningSystem {
|
||||||
/**
|
/**
|
||||||
* Returns the name of this versioning system.
|
* Returns the name of the versioning system.
|
||||||
*
|
*
|
||||||
* @return name of this versioning system
|
* @return versioning system name
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
@NotNull
|
@NotNull String getName();
|
||||||
String getName();
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Compares a version with another version.
|
* Compares a {@link VersioningSystem} with another.
|
||||||
*
|
*
|
||||||
* @param version the version to compare against
|
* @param version {@link VersioningSystem} to compare against
|
||||||
* @return smaller = {@code 0}, equal = {@code 1}, bigger = {@code 2}
|
* @return {@code 0} if the supplied version is bigger, {@code 1} if equal and {@code 2} if smaller
|
||||||
* @throws IncompatibleVersioningSystemException when this versioning system does not support comparing with another versioning system
|
* @throws IncompatibleVersioningSystemException incompatible with the supplied versioning system
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
@Range(from = 0, to = 2)
|
@Range(from = 0, to = 2)
|
||||||
int compare(@NotNull VersioningSystem version) throws IncompatibleVersioningSystemException;
|
int compare(@NotNull VersioningSystem version) throws IncompatibleVersioningSystemException;
|
|
@ -0,0 +1,257 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.base.implementable.helper;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.EngineConfiguration;
|
||||||
|
import de.staropensource.engine.base.EngineInternals;
|
||||||
|
import de.staropensource.engine.base.annotation.EventListener;
|
||||||
|
import de.staropensource.engine.base.event.LogEvent;
|
||||||
|
import de.staropensource.engine.base.exception.reflection.InstanceMethodFromStaticContextException;
|
||||||
|
import de.staropensource.engine.base.exception.reflection.InvalidMethodSignatureException;
|
||||||
|
import de.staropensource.engine.base.exception.reflection.NoAccessException;
|
||||||
|
import de.staropensource.engine.base.exception.reflection.StaticInitializerException;
|
||||||
|
import de.staropensource.engine.base.implementable.Event;
|
||||||
|
import de.staropensource.engine.base.implementable.EventListenerCode;
|
||||||
|
import de.staropensource.engine.base.internal.implementation.EventListenerMethod;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.logging.Logger;
|
||||||
|
import de.staropensource.engine.base.type.EventPriority;
|
||||||
|
import de.staropensource.engine.base.utility.ListFormatter;
|
||||||
|
import lombok.Getter;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
import org.jetbrains.annotations.Nullable;
|
||||||
|
import org.reflections.Reflections;
|
||||||
|
import org.reflections.scanners.Scanners;
|
||||||
|
import org.reflections.util.ClasspathHelper;
|
||||||
|
import org.reflections.util.ConfigurationBuilder;
|
||||||
|
|
||||||
|
import java.lang.reflect.InvocationTargetException;
|
||||||
|
import java.lang.reflect.Method;
|
||||||
|
import java.util.*;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Simplifies event logging and calling.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
public final class EventHelper {
|
||||||
|
/**
|
||||||
|
* Holds all cached events.
|
||||||
|
*
|
||||||
|
* @since v1-alpha5
|
||||||
|
*/
|
||||||
|
private static final @NotNull Map<@NotNull Class<? extends Event>, LinkedList<@NotNull EventListenerCode>> cachedEventListeners = new HashMap<>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates and initializes an instance of this class.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
private EventHelper() {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a new {@link Event}.
|
||||||
|
* <p>
|
||||||
|
* This method does nothing if classpath searching is disabled.
|
||||||
|
*
|
||||||
|
* @param event {@link Event} to register for
|
||||||
|
* @param eventListener {@link EventListenerCode} to register
|
||||||
|
* @param priority priority of the listener
|
||||||
|
* @see EngineInternals#getReflectiveClasspathScanning()
|
||||||
|
* @since v1-alpha5
|
||||||
|
*/
|
||||||
|
public static synchronized void registerEvent(@NotNull Class<? extends Event> event, @NotNull EventListenerCode eventListener, @NotNull EventPriority priority) {
|
||||||
|
if (EngineInternals.getInstance().getReflectiveClasspathScanning())
|
||||||
|
return;
|
||||||
|
|
||||||
|
// Update 'eventListener' priority
|
||||||
|
eventListener.priority = priority;
|
||||||
|
|
||||||
|
// Check if event already exists in map
|
||||||
|
// If not, create entry with a LinkedList
|
||||||
|
if (cachedEventListeners.containsKey(event))
|
||||||
|
if (cachedEventListeners.get(event).contains(eventListener))
|
||||||
|
return;
|
||||||
|
else
|
||||||
|
cachedEventListeners.get(event).add(eventListener);
|
||||||
|
else {
|
||||||
|
LinkedList<@NotNull EventListenerCode> list = new LinkedList<>();
|
||||||
|
list.add(eventListener);
|
||||||
|
cachedEventListeners.put(event, list);
|
||||||
|
}
|
||||||
|
|
||||||
|
Logger.diag("Registered event listener " + eventListener + " for event " + event + " with priority " + priority.name());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a new {@link Event}.
|
||||||
|
* <p>
|
||||||
|
* This method does nothing if classpath searching is disabled.
|
||||||
|
*
|
||||||
|
* @param event {@link Event} to register for
|
||||||
|
* @param eventListener {@link EventListenerCode} to register
|
||||||
|
* @see EngineInternals#getReflectiveClasspathScanning()
|
||||||
|
* @since v1-alpha5
|
||||||
|
*/
|
||||||
|
public static void registerEvent(@NotNull Class<? extends Event> event, @NotNull EventListenerCode eventListener) {
|
||||||
|
registerEvent(event, eventListener, EventPriority.DEFAULT);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* (Re-)Caches all event listeners for some {@link Event}.
|
||||||
|
* <p>
|
||||||
|
* This method does nothing if classpath searching is enabled.
|
||||||
|
*
|
||||||
|
* @param event event to (re-)cache. Set to {@code null} to recompute all cached events
|
||||||
|
* @see EngineInternals#getReflectiveClasspathScanning()
|
||||||
|
* @since v1-alpha5
|
||||||
|
*/
|
||||||
|
public static synchronized void cacheEvent(@Nullable Class<? extends Event> event) {
|
||||||
|
if (!EngineInternals.getInstance().getReflectiveClasspathScanning())
|
||||||
|
return;
|
||||||
|
|
||||||
|
if (event == null)
|
||||||
|
for (Class<? extends Event> cachedEvent : cachedEventListeners.keySet())
|
||||||
|
cacheEvent(cachedEvent);
|
||||||
|
else {
|
||||||
|
LinkedList<@NotNull EventListenerCode> annotatedMethods = getAnnotatedMethods(event);
|
||||||
|
|
||||||
|
if (cachedEventListeners.containsKey(event))
|
||||||
|
cachedEventListeners.replace(event, annotatedMethods);
|
||||||
|
else
|
||||||
|
cachedEventListeners.put(event, annotatedMethods);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes an event from the event listener cache.
|
||||||
|
* <p>
|
||||||
|
* This method does nothing if classpath searching is enabled.
|
||||||
|
*
|
||||||
|
* @param event event to uncache. Set to {@code null} to clear the entire cache
|
||||||
|
* @see EngineInternals#getReflectiveClasspathScanning()
|
||||||
|
* @since v1-alpha5
|
||||||
|
*/
|
||||||
|
public static synchronized void uncacheEvent(@Nullable Class<? extends Event> event) {
|
||||||
|
if (!EngineInternals.getInstance().getReflectiveClasspathScanning())
|
||||||
|
return;
|
||||||
|
|
||||||
|
if (event == null)
|
||||||
|
cachedEventListeners.clear();
|
||||||
|
else
|
||||||
|
cachedEventListeners.remove(event);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Invokes all event listeners.
|
||||||
|
*
|
||||||
|
* @param event event class
|
||||||
|
* @param arguments arguments to pass to event listeners
|
||||||
|
* @since v1-alpha5
|
||||||
|
*/
|
||||||
|
public static void invokeAnnotatedMethods(@NotNull Class<? extends Event> event, Object... arguments) {
|
||||||
|
if (event != LogEvent.class && EngineConfiguration.getInstance().isDebugEvents())
|
||||||
|
if (arguments.length == 0)
|
||||||
|
Logger.diag("Event " + event.getName() + " was emitted");
|
||||||
|
else
|
||||||
|
Logger.diag("Event " + event.getName() + " was emitted, passing arguments " + ListFormatter.formatArray(arguments));
|
||||||
|
|
||||||
|
Runnable eventCode = () -> {
|
||||||
|
for (EventListenerCode eventListener : getAnnotatedMethods(event)) {
|
||||||
|
try {
|
||||||
|
eventListener.run(arguments);
|
||||||
|
} catch (NoAccessException exception) {
|
||||||
|
Logger.warn("Event listener " + eventListener + " could not be called as the method could not be accessed");
|
||||||
|
} catch (InvalidMethodSignatureException exception) {
|
||||||
|
Logger.warn("Event listener " + eventListener + " has an invalid method signature");
|
||||||
|
} catch (InvocationTargetException exception) {
|
||||||
|
Logger.crash("Event listener " + eventListener + " threw a throwable", exception.getTargetException(), true);
|
||||||
|
} catch (InstanceMethodFromStaticContextException exception) {
|
||||||
|
Logger.warn("Event listener " + eventListener + " is not static. Event listener methods must be static for them to be called.");
|
||||||
|
} catch (StaticInitializerException exception) {
|
||||||
|
Logger.crash("Event listener " + eventListener + " could not be called as the static initializer failed", exception.getThrowable(), true);
|
||||||
|
} catch (Exception exception) {
|
||||||
|
Logger.crash("Event listener " + eventListener + " could not be called as an error occurred during reflection", exception, true);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
if (EngineConfiguration.getInstance().isOptimizeEvents())
|
||||||
|
Thread
|
||||||
|
.ofVirtual()
|
||||||
|
.name("Event " + event.getName())
|
||||||
|
.start(eventCode);
|
||||||
|
else
|
||||||
|
eventCode.run();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns all {@link EventListener}s listening on some event.
|
||||||
|
* The classpath will be scanned for listeners, unless cached results exist and {@code !forceScanning}.
|
||||||
|
*
|
||||||
|
* @param event event class
|
||||||
|
* @param forceScanning forces scanning the classpath for listeners. not recommended due to a huge performance penalty
|
||||||
|
* @return list of event listeners
|
||||||
|
* @see #cacheEvent(Class)
|
||||||
|
* @since v1-alpha5
|
||||||
|
*/
|
||||||
|
public static @NotNull LinkedList<EventListenerCode> getAnnotatedMethods(@NotNull Class<? extends Event> event, boolean forceScanning) {
|
||||||
|
LinkedList<EventListenerCode> eventListeners = new LinkedList<>();
|
||||||
|
|
||||||
|
if (!EngineInternals.getInstance().getReflectiveClasspathScanning())
|
||||||
|
return Objects.requireNonNullElse(cachedEventListeners.get(event), eventListeners);
|
||||||
|
|
||||||
|
if (forceScanning || !cachedEventListeners.containsKey(event)) {
|
||||||
|
Reflections reflections = new Reflections(
|
||||||
|
new ConfigurationBuilder()
|
||||||
|
.setUrls(ClasspathHelper.forJavaClassPath())
|
||||||
|
.setScanners(Scanners.MethodsAnnotated)
|
||||||
|
);
|
||||||
|
|
||||||
|
// Get annotated methods
|
||||||
|
Set<@NotNull Method> annotatedMethods = reflections.getMethodsAnnotatedWith(EventListener.class);
|
||||||
|
|
||||||
|
// Sort event listeners not listening for the specified event out
|
||||||
|
for (Method method : annotatedMethods)
|
||||||
|
if (method.getAnnotation(EventListener.class).event() == event)
|
||||||
|
eventListeners.add(new EventListenerMethod(method));
|
||||||
|
|
||||||
|
// Sort list after event priority
|
||||||
|
eventListeners.sort(Comparator.comparing(method -> Objects.requireNonNull(((EventListenerMethod) method).getAnnotation(EventListener.class)).priority()));
|
||||||
|
} else
|
||||||
|
// Event listeners are cached and !forceScanning, return cached results
|
||||||
|
eventListeners = cachedEventListeners.get(event);
|
||||||
|
|
||||||
|
return eventListeners;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns all {@link EventListener}s listening on some event.
|
||||||
|
* The classpath will be scanned for listeners, unless cached results exist.
|
||||||
|
*
|
||||||
|
* @param event event class
|
||||||
|
* @return list of event listeners
|
||||||
|
* @since v1-alpha5
|
||||||
|
*/
|
||||||
|
public static @NotNull LinkedList<EventListenerCode> getAnnotatedMethods(@NotNull Class<? extends Event> event) {
|
||||||
|
return getAnnotatedMethods(event, false);
|
||||||
|
}
|
||||||
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -21,6 +21,6 @@
|
||||||
* Not necessarily interfaces or extendable classes. Rather, they
|
* Not necessarily interfaces or extendable classes. Rather, they
|
||||||
* support implementing classes by providing useful or complex code.
|
* support implementing classes by providing useful or complex code.
|
||||||
*
|
*
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
package de.staropensource.sosengine.base.classes.helpers;
|
package de.staropensource.engine.base.implementable.helper;
|
|
@ -0,0 +1,25 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Interfaces and abstract classes which can be used for implementing classes.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
package de.staropensource.engine.base.implementable;
|
|
@ -0,0 +1,56 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.base.implementation.logging;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.EngineConfiguration;
|
||||||
|
import de.staropensource.engine.base.implementable.LoggingAdapter;
|
||||||
|
import de.staropensource.engine.base.logging.Logger;
|
||||||
|
import de.staropensource.engine.base.type.logging.LogLevel;
|
||||||
|
import de.staropensource.engine.base.implementation.shortcode.EmptyShortcodeParser;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Prints log messages to the console, without any fancy colors or formatting.
|
||||||
|
*
|
||||||
|
* @see Logger
|
||||||
|
* @see LoggingAdapter
|
||||||
|
* @since v1-alpha1
|
||||||
|
*/
|
||||||
|
public class PlainLoggingAdapter implements LoggingAdapter {
|
||||||
|
/**
|
||||||
|
* Creates and initializes an instance of this class.
|
||||||
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
|
*/
|
||||||
|
public PlainLoggingAdapter() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public void print(@NotNull LogLevel level, @NotNull StackTraceElement issuer, @NotNull String message, @NotNull String format) {
|
||||||
|
format = new EmptyShortcodeParser(format, true).getClean();
|
||||||
|
if (level == LogLevel.ERROR || level == LogLevel.CRASH)
|
||||||
|
if (EngineConfiguration.getInstance() != null && EngineConfiguration.getInstance().isLogForceStandardOutput())
|
||||||
|
System.out.println(format);
|
||||||
|
else
|
||||||
|
System.err.println(format);
|
||||||
|
else
|
||||||
|
System.out.println(format);
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,44 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.base.implementation.logging;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.implementable.LoggingAdapter;
|
||||||
|
import de.staropensource.engine.base.type.logging.LogLevel;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
import org.jetbrains.annotations.Nullable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An implementation of {@link LoggingAdapter}, which does nothing.
|
||||||
|
* Useful if you want to silence engine startup messages.
|
||||||
|
*
|
||||||
|
* @since v1-alpha4
|
||||||
|
*/
|
||||||
|
public class QuietLoggingAdapter implements LoggingAdapter {
|
||||||
|
/**
|
||||||
|
* Creates and initializes an instance of this class.
|
||||||
|
*
|
||||||
|
* @since v1-alpha4
|
||||||
|
*/
|
||||||
|
public QuietLoggingAdapter() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public void print(@NotNull LogLevel level, @NotNull StackTraceElement issuer, @NotNull String message, @NotNull String format) {}
|
||||||
|
}
|
|
@ -0,0 +1,56 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.base.implementation.logging;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.EngineConfiguration;
|
||||||
|
import de.staropensource.engine.base.implementable.LoggingAdapter;
|
||||||
|
import de.staropensource.engine.base.logging.Logger;
|
||||||
|
import de.staropensource.engine.base.type.logging.LogLevel;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
import org.jetbrains.annotations.Nullable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Prints log messages to the console, without performing any message changes.
|
||||||
|
* Will reveal shortcodes as they will not be replaced.
|
||||||
|
*
|
||||||
|
* @see Logger
|
||||||
|
* @see LoggingAdapter
|
||||||
|
* @since v1-alpha1
|
||||||
|
*/
|
||||||
|
public class RawLoggingAdapter implements LoggingAdapter {
|
||||||
|
/**
|
||||||
|
* Creates and initializes an instance of this class.
|
||||||
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
|
*/
|
||||||
|
public RawLoggingAdapter() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public void print(@NotNull LogLevel level, @NotNull StackTraceElement issuer, @NotNull String message, @NotNull String format) {
|
||||||
|
if (level == LogLevel.ERROR || level == LogLevel.CRASH)
|
||||||
|
if (EngineConfiguration.getInstance().isLogForceStandardOutput())
|
||||||
|
System.out.println(format);
|
||||||
|
else
|
||||||
|
System.err.println(format);
|
||||||
|
else
|
||||||
|
System.out.println(format);
|
||||||
|
}
|
||||||
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -18,8 +18,8 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Provides various classes that can be used to retrieve information about the engine or JVM.
|
* A set of built-in {@link de.staropensource.engine.base.implementable.LoggingAdapter}s.
|
||||||
*
|
*
|
||||||
* @since 1-alpha0
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
package de.staropensource.sosengine.base.data.info;
|
package de.staropensource.engine.base.implementation.logging;
|
|
@ -0,0 +1,25 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implementations for various interfaces and abstract classes.
|
||||||
|
*
|
||||||
|
* @since v1-alpha6
|
||||||
|
*/
|
||||||
|
package de.staropensource.engine.base.implementation;
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,37 +17,38 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.utility.converter;
|
package de.staropensource.engine.base.implementation.shortcode;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.ShortcodeParserSkeleton;
|
import de.staropensource.engine.base.implementable.ShortcodeParser;
|
||||||
|
import de.staropensource.engine.base.exception.ParserException;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Cleans the string of any tags.
|
* Cleans the string of any tags.
|
||||||
*
|
*
|
||||||
* @see ShortcodeParserSkeleton
|
* @see ShortcodeParser
|
||||||
* @since 1-alpha1
|
* @since v1-alpha8
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused" })
|
public final class EmptyShortcodeParser extends ShortcodeParser {
|
||||||
public final class EmptyShortcodeConverter extends ShortcodeParserSkeleton {
|
|
||||||
/**
|
/**
|
||||||
* Constructs this class.
|
* Creates and initializes an instance of this class.
|
||||||
*
|
*
|
||||||
* @param string string to convert
|
* @param string string to parse
|
||||||
* @since 1-alpha1
|
* @param ignoreInvalidEscapes if {@code true}, will ignore and treat invalid escapes as text
|
||||||
|
* @throws ParserException on error
|
||||||
|
* @since v1-alpha8
|
||||||
*/
|
*/
|
||||||
public EmptyShortcodeConverter(@NotNull String string) {
|
public EmptyShortcodeParser(@NotNull String string, boolean ignoreInvalidEscapes) throws ParserException {
|
||||||
super(string);
|
super(string, ignoreInvalidEscapes);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the parsed string without any tags.
|
* Returns the parsed string without any tags.
|
||||||
*
|
*
|
||||||
* @return cleaned input string
|
* @return cleaned input string
|
||||||
* @since 1-alpha1
|
* @since v1-alpha8
|
||||||
*/
|
*/
|
||||||
@NotNull
|
public @NotNull String getClean() {
|
||||||
public String getClean() {
|
|
||||||
StringBuilder output = new StringBuilder();
|
StringBuilder output = new StringBuilder();
|
||||||
|
|
||||||
for (String component : components)
|
for (String component : components)
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -18,8 +18,8 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Contains events. There's nothing more to say.
|
* Classes which convert data.
|
||||||
*
|
*
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
package de.staropensource.sosengine.base.events;
|
package de.staropensource.engine.base.implementation.shortcode;
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,12 +17,12 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.data.versioning;
|
package de.staropensource.engine.base.implementation.versioning;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.VersioningSystem;
|
import de.staropensource.engine.base.implementable.VersioningSystem;
|
||||||
import de.staropensource.sosengine.base.exceptions.IncompatibleVersioningSystemException;
|
import de.staropensource.engine.base.exception.versioning.IncompatibleVersioningSystemException;
|
||||||
import de.staropensource.sosengine.base.exceptions.InvalidVersionStringException;
|
import de.staropensource.engine.base.exception.versioning.InvalidVersionStringException;
|
||||||
import de.staropensource.sosengine.base.utility.Miscellaneous;
|
import de.staropensource.engine.base.utility.Miscellaneous;
|
||||||
import lombok.Getter;
|
import lombok.Getter;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
import org.jetbrains.annotations.Range;
|
import org.jetbrains.annotations.Range;
|
||||||
|
@ -30,72 +30,68 @@ import org.jetbrains.annotations.Range;
|
||||||
/**
|
/**
|
||||||
* Represents a four-numbered versioning system, where an application or work is versioning by four arbitrary numbers.
|
* Represents a four-numbered versioning system, where an application or work is versioning by four arbitrary numbers.
|
||||||
*
|
*
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
|
|
||||||
@Getter
|
@Getter
|
||||||
|
@SuppressWarnings({ "JavadocDeclaration" })
|
||||||
public final class FourNumberVersioningSystem implements VersioningSystem {
|
public final class FourNumberVersioningSystem implements VersioningSystem {
|
||||||
/**
|
/**
|
||||||
* Contains the 1. number vector.
|
* Contains the first number vector.
|
||||||
*
|
|
||||||
* @since 1-alpha1
|
|
||||||
*
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
* -- GETTER --
|
* -- GETTER --
|
||||||
* Returns the 1. number vector.
|
* Returns the first number vector.
|
||||||
*
|
*
|
||||||
* @return 1. number vector
|
* @return first number vector
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
private final int number1;
|
private final int number1;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Contains the 2. number vector.
|
* Contains the second number vector.
|
||||||
*
|
|
||||||
* @since 1-alpha1
|
|
||||||
*
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
* -- GETTER --
|
* -- GETTER --
|
||||||
* Returns the 2. number vector.
|
* Returns the second number vector.
|
||||||
*
|
*
|
||||||
* @return 2. number vector
|
* @return second number vector
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
private final int number2;
|
private final int number2;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Contains the 3. number vector.
|
* Contains the third number vector.
|
||||||
*
|
|
||||||
* @since 1-alpha1
|
|
||||||
*
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
* -- GETTER --
|
* -- GETTER --
|
||||||
* Returns the 3. number vector.
|
* Returns the third number vector.
|
||||||
*
|
*
|
||||||
* @return 3. number vector
|
* @return third number vector
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
private final int number3;
|
private final int number3;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Contains the 4. number vector.
|
* Contains the fourth number vector.
|
||||||
*
|
|
||||||
* @since 1-alpha1
|
|
||||||
*
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
* -- GETTER --
|
* -- GETTER --
|
||||||
* Returns the 4. number vector.
|
* Returns the fourth number vector.
|
||||||
*
|
*
|
||||||
* @return 4. number vector
|
* @return fourth number vector
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
private final int number4;
|
private final int number4;
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
/** {@inheritDoc} */
|
||||||
@NotNull
|
|
||||||
@Override
|
@Override
|
||||||
public String getName() {
|
public @NotNull String getName() {
|
||||||
return "n4";
|
return "n4";
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Parses a four number-based version string.
|
* Tries to parse the specified version string
|
||||||
|
* and if successful, return a new instance.
|
||||||
*
|
*
|
||||||
* @param versionString version string to parse
|
* @param versionString version string to parse
|
||||||
* @throws InvalidVersionStringException if the version string is invalid
|
* @throws InvalidVersionStringException if the version string is invalid
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,45 +17,44 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.data.versioning;
|
package de.staropensource.engine.base.implementation.versioning;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.VersioningSystem;
|
import de.staropensource.engine.base.implementable.VersioningSystem;
|
||||||
import de.staropensource.sosengine.base.exceptions.IncompatibleVersioningSystemException;
|
import de.staropensource.engine.base.exception.versioning.IncompatibleVersioningSystemException;
|
||||||
import de.staropensource.sosengine.base.exceptions.InvalidVersionStringException;
|
import de.staropensource.engine.base.exception.versioning.InvalidVersionStringException;
|
||||||
import lombok.Getter;
|
import lombok.Getter;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
import org.jetbrains.annotations.Range;
|
import org.jetbrains.annotations.Range;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Represents a two-numbered versioning system, where an application or work is versioning by two arbitrary numbers.
|
* Represents a one-numbered versioning system, where an application or work is versioned by one arbitrary number.
|
||||||
*
|
*
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
|
|
||||||
@Getter
|
@Getter
|
||||||
|
@SuppressWarnings({ "JavadocDeclaration" })
|
||||||
public final class OneNumberVersioningSystem implements VersioningSystem {
|
public final class OneNumberVersioningSystem implements VersioningSystem {
|
||||||
/**
|
/**
|
||||||
* Contains the number vector.
|
* Contains the number vector.
|
||||||
*
|
*
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*
|
|
||||||
* -- GETTER --
|
* -- GETTER --
|
||||||
* Returns the number vector.
|
* Returns the number vector.
|
||||||
*
|
*
|
||||||
* @return number vector
|
* @return number vector
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
private final int number;
|
private final int number;
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
/** {@inheritDoc} */
|
||||||
@NotNull
|
|
||||||
@Override
|
@Override
|
||||||
public String getName() {
|
public @NotNull String getName() {
|
||||||
return "n1";
|
return "n1";
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Parses a one number-based version string.
|
* Tries to parse the specified version string
|
||||||
|
* and if successful, return a new instance.
|
||||||
*
|
*
|
||||||
* @param versionString version string to parse
|
* @param versionString version string to parse
|
||||||
* @throws InvalidVersionStringException if the version string is invalid
|
* @throws InvalidVersionStringException if the version string is invalid
|
||||||
|
@ -80,7 +79,6 @@ public final class OneNumberVersioningSystem implements VersioningSystem {
|
||||||
return 2;
|
return 2;
|
||||||
|
|
||||||
return 1;
|
return 1;
|
||||||
|
|
||||||
} else
|
} else
|
||||||
throw new IncompatibleVersioningSystemException(this, versionInterface);
|
throw new IncompatibleVersioningSystemException(this, versionInterface);
|
||||||
}
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,12 +17,12 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.data.versioning;
|
package de.staropensource.engine.base.implementation.versioning;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.VersioningSystem;
|
import de.staropensource.engine.base.implementable.VersioningSystem;
|
||||||
import de.staropensource.sosengine.base.exceptions.IncompatibleVersioningSystemException;
|
import de.staropensource.engine.base.exception.versioning.IncompatibleVersioningSystemException;
|
||||||
import de.staropensource.sosengine.base.exceptions.InvalidVersionStringException;
|
import de.staropensource.engine.base.exception.versioning.InvalidVersionStringException;
|
||||||
import de.staropensource.sosengine.base.utility.Miscellaneous;
|
import de.staropensource.engine.base.utility.Miscellaneous;
|
||||||
import lombok.Getter;
|
import lombok.Getter;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
import org.jetbrains.annotations.Nullable;
|
import org.jetbrains.annotations.Nullable;
|
||||||
|
@ -33,88 +33,84 @@ import java.util.Arrays;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Represents the semantic versioning system (version 2.0.0), where an application or work is versioning by a MAJOR version, a MINOR version, a PATCH version and optionally, a pre-release vector and a build number.
|
* Represents the semantic versioning system (version 2.0.0), where an application
|
||||||
|
* or work is versioning by a {@code MAJOR} version, {@code MINOR} version,
|
||||||
|
* {@code PATCH} version and optionally, a pre-release vector and a build number.
|
||||||
*
|
*
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
|
|
||||||
@Getter
|
@Getter
|
||||||
|
@SuppressWarnings({ "JavadocDeclaration" })
|
||||||
public final class SemanticVersioningSystem implements VersioningSystem {
|
public final class SemanticVersioningSystem implements VersioningSystem {
|
||||||
/**
|
/**
|
||||||
* Contains the MAJOR vector.
|
* Contains the {@code MAJOR} vector.
|
||||||
*
|
|
||||||
* @since 1-alpha1
|
|
||||||
*
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
* -- GETTER --
|
* -- GETTER --
|
||||||
* Returns the MAJOR vector.
|
* Returns the {@code MAJOR} vector.
|
||||||
*
|
*
|
||||||
* @return MAJOR vector
|
* @return {@code MAJOR} vector
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
private final int major;
|
private final int major;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Contains the MINOR vector.
|
* Contains the {@code MINOR} vector.
|
||||||
*
|
|
||||||
* @since 1-alpha1
|
|
||||||
*
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
* -- GETTER --
|
* -- GETTER --
|
||||||
* Returns the MINOR vector.
|
* Returns the {@code MINOR} vector.
|
||||||
*
|
*
|
||||||
* @return MINOR vector
|
* @return {@code MINOR} vector
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
private final int minor;
|
private final int minor;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Contains the PATCH vector.
|
* Contains the {@code PATCH} vector.
|
||||||
*
|
|
||||||
* @since 1-alpha1
|
|
||||||
*
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
* -- GETTER --
|
* -- GETTER --
|
||||||
* Returns the PATCH vector.
|
* Returns the {@code PATCH} vector.
|
||||||
*
|
*
|
||||||
* @return PATCH vector
|
* @return {@code PATCH} vector
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
private final int patch;
|
private final int patch;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Contains the PRERELEASE vector.
|
* Contains the {@code PRERELEASE} vector.
|
||||||
*
|
|
||||||
* @since 1-alpha1
|
|
||||||
*
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
* -- GETTER --
|
* -- GETTER --
|
||||||
* Returns the PRERELEASE vector.
|
* Returns the {@code PRERELEASE} vector.
|
||||||
*
|
*
|
||||||
* @return PRERELEASE vector
|
* @return {@code PRERELEASE} vector
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
@Nullable
|
private final @Nullable String prerelease;
|
||||||
private final String prerelease;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Contains the BUILD vector.
|
* Contains the {@code BUILD} vector.
|
||||||
*
|
|
||||||
* @since 1-alpha1
|
|
||||||
*
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
* -- GETTER --
|
* -- GETTER --
|
||||||
* Returns the BUILD vector.
|
* Returns the {@code BUILD} vector.
|
||||||
*
|
*
|
||||||
* @return BUILD vector
|
* @return {@code BUILD} vector
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
private final int build;
|
private final int build;
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
/** {@inheritDoc} */
|
||||||
@NotNull
|
|
||||||
@Override
|
@Override
|
||||||
public String getName() {
|
public @NotNull String getName() {
|
||||||
return "Semantic";
|
return "Semantic";
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Parses a semantic versioning string.
|
* Tries to parse the specified version string
|
||||||
|
* and if successful, return a new instance.
|
||||||
*
|
*
|
||||||
* @param versionString version string to parse
|
* @param versionString version string to parse
|
||||||
* @throws InvalidVersionStringException if the version string is invalid
|
* @throws InvalidVersionStringException if the version string is invalid
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,12 +17,12 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.data.versioning;
|
package de.staropensource.engine.base.implementation.versioning;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.VersioningSystem;
|
import de.staropensource.engine.base.implementable.VersioningSystem;
|
||||||
import de.staropensource.sosengine.base.exceptions.IncompatibleVersioningSystemException;
|
import de.staropensource.engine.base.exception.versioning.IncompatibleVersioningSystemException;
|
||||||
import de.staropensource.sosengine.base.exceptions.InvalidVersionStringException;
|
import de.staropensource.engine.base.exception.versioning.InvalidVersionStringException;
|
||||||
import de.staropensource.sosengine.base.types.VersionType;
|
import de.staropensource.engine.base.type.VersionType;
|
||||||
import lombok.Getter;
|
import lombok.Getter;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
import org.jetbrains.annotations.Nullable;
|
import org.jetbrains.annotations.Nullable;
|
||||||
|
@ -33,88 +33,85 @@ import java.util.List;
|
||||||
import java.util.Locale;
|
import java.util.Locale;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Represents the StarOpenSource versioning system (version 2), where an application or work is versioning by a VERSION vector, a TYPE version type, a TYPERELEASE vector and optionally, a fork vector and a companion vector.
|
* Represents the StarOpenSource versioning system (version 2), where an application
|
||||||
|
* or work is versioning by a {@code VERSION} vector, {@code TYPE} version type,
|
||||||
|
* {@code TYPERELEASE} vector and optionally, a {@code FORK} vector and
|
||||||
|
* {@code COMPANION} vector.
|
||||||
*
|
*
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
|
|
||||||
@Getter
|
@Getter
|
||||||
|
@SuppressWarnings({ "JavadocDeclaration" })
|
||||||
public final class StarOpenSourceVersioningSystem implements VersioningSystem {
|
public final class StarOpenSourceVersioningSystem implements VersioningSystem {
|
||||||
/**
|
/**
|
||||||
* Contains the VERSION vector.
|
* Contains the {@code VERSION} vector.
|
||||||
*
|
|
||||||
* @since 1-alpha1
|
|
||||||
*
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
* -- GETTER --
|
* -- GETTER --
|
||||||
* Returns the VERSION vector.
|
* Returns the {@code VERSION} vector.
|
||||||
*
|
*
|
||||||
* @return VERSION vector
|
* @return {@code VERSION} vector
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
private final int version;
|
private final int version;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Contains the TYPE vector.
|
* Contains the {@code TYPE} vector.
|
||||||
*
|
|
||||||
* @since 1-alpha1
|
|
||||||
*
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
* -- GETTER --
|
* -- GETTER --
|
||||||
* Returns the TYPE vector.
|
* Returns the {@code TYPE} vector.
|
||||||
*
|
*
|
||||||
* @return TYPE vector
|
* @return {@code TYPE} vector
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
private final VersionType type;
|
private final VersionType type;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Contains the TYPERELEASE vector.
|
* Contains the {@code TYPERELEASE} vector.
|
||||||
*
|
|
||||||
* @since 1-alpha1
|
|
||||||
*
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
* -- GETTER --
|
* -- GETTER --
|
||||||
* Returns the TYPERELEASE vector.
|
* Returns the {@code TYPERELEASE}- vector.
|
||||||
*
|
*
|
||||||
* @return TYPERELEASE vector
|
* @return {@code TYPERELEASE} vector
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
private final int typerelease;
|
private final int typerelease;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Contains the COMPANION vector.
|
* Contains the {@code COMPANION} vector.
|
||||||
*
|
|
||||||
* @since 1-alpha1
|
|
||||||
*
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
* -- GETTER --
|
* -- GETTER --
|
||||||
* Returns the COMPANION vector.
|
* Returns the {@code COMPANION} vector.
|
||||||
*
|
*
|
||||||
* @return COMPANION vector
|
* @return {@code COMPANION} vector
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
@Nullable
|
private final @Nullable String companion;
|
||||||
private final String companion;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Contains the FORK vector.
|
* Contains the FORK vector.
|
||||||
*
|
*
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*
|
|
||||||
* -- GETTER --
|
* -- GETTER --
|
||||||
* Returns the FORK vector.
|
* Returns the FORK vector.
|
||||||
*
|
*
|
||||||
* @return FORK vector
|
* @return FORK vector
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
private final String fork;
|
private final String fork;
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
/** {@inheritDoc} */
|
||||||
@NotNull
|
|
||||||
@Override
|
@Override
|
||||||
public String getName() {
|
public @NotNull String getName() {
|
||||||
return "StarOpenSource";
|
return "StarOpenSource";
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Parses a StarOpenSource versioning string.
|
* Tries to parse the specified version string
|
||||||
|
* and if successful, return a new instance.
|
||||||
*
|
*
|
||||||
* @param versionString version string to parse
|
* @param versionString version string to parse
|
||||||
* @throws InvalidVersionStringException if the version string is invalid
|
* @throws InvalidVersionStringException if the version string is invalid
|
||||||
|
@ -135,7 +132,7 @@ public final class StarOpenSourceVersioningSystem implements VersioningSystem {
|
||||||
String companion = null;
|
String companion = null;
|
||||||
String fork = null;
|
String fork = null;
|
||||||
|
|
||||||
// Iterate through all chraracters
|
// Iterate through all characters
|
||||||
for (Character character : versionString.toCharArray()) {
|
for (Character character : versionString.toCharArray()) {
|
||||||
switch (parsingId) {
|
switch (parsingId) {
|
||||||
case 0 -> { // 'v' character
|
case 0 -> { // 'v' character
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,12 +17,12 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.data.versioning;
|
package de.staropensource.engine.base.implementation.versioning;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.VersioningSystem;
|
import de.staropensource.engine.base.implementable.VersioningSystem;
|
||||||
import de.staropensource.sosengine.base.exceptions.IncompatibleVersioningSystemException;
|
import de.staropensource.engine.base.exception.versioning.IncompatibleVersioningSystemException;
|
||||||
import de.staropensource.sosengine.base.exceptions.InvalidVersionStringException;
|
import de.staropensource.engine.base.exception.versioning.InvalidVersionStringException;
|
||||||
import de.staropensource.sosengine.base.utility.Miscellaneous;
|
import de.staropensource.engine.base.utility.Miscellaneous;
|
||||||
import lombok.Getter;
|
import lombok.Getter;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
import org.jetbrains.annotations.Range;
|
import org.jetbrains.annotations.Range;
|
||||||
|
@ -30,59 +30,56 @@ import org.jetbrains.annotations.Range;
|
||||||
/**
|
/**
|
||||||
* Represents a three-numbered versioning system, where an application or work is versioning by three arbitrary numbers.
|
* Represents a three-numbered versioning system, where an application or work is versioning by three arbitrary numbers.
|
||||||
*
|
*
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
|
|
||||||
@Getter
|
@Getter
|
||||||
|
@SuppressWarnings({ "JavadocDeclaration" })
|
||||||
public final class ThreeNumberVersioningSystem implements VersioningSystem {
|
public final class ThreeNumberVersioningSystem implements VersioningSystem {
|
||||||
/**
|
/**
|
||||||
* Contains the 1. number vector.
|
* Contains the first number vector.
|
||||||
*
|
|
||||||
* @since 1-alpha1
|
|
||||||
*
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
* -- GETTER --
|
* -- GETTER --
|
||||||
* Returns the 1. number vector.
|
* Returns the first number vector.
|
||||||
*
|
*
|
||||||
* @return 1. number vector
|
* @return first number vector
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
private final int number1;
|
private final int number1;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Contains the 2. number vector.
|
* Contains the second number vector.
|
||||||
*
|
|
||||||
* @since 1-alpha1
|
|
||||||
*
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
* -- GETTER --
|
* -- GETTER --
|
||||||
* Returns the 2. number vector.
|
* Returns the second number vector.
|
||||||
*
|
*
|
||||||
* @return 2. number vector
|
* @return second number vector
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
private final int number2;
|
private final int number2;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Contains the 3. number vector.
|
* Contains the third number vector.
|
||||||
*
|
|
||||||
* @since 1-alpha1
|
|
||||||
*
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
* -- GETTER --
|
* -- GETTER --
|
||||||
* Returns the 3. number vector.
|
* Returns the third number vector.
|
||||||
*
|
*
|
||||||
* @return 3. number vector
|
* @return third number vector
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
private final int number3;
|
private final int number3;
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
/** {@inheritDoc} */
|
||||||
@NotNull
|
|
||||||
@Override
|
@Override
|
||||||
public String getName() {
|
public @NotNull String getName() {
|
||||||
return "n3";
|
return "n3";
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Parses a three number-based version string.
|
* Tries to parse the specified version string
|
||||||
|
* and if successful, return a new instance.
|
||||||
*
|
*
|
||||||
* @param versionString version string to parse
|
* @param versionString version string to parse
|
||||||
* @throws InvalidVersionStringException if the version string is invalid
|
* @throws InvalidVersionStringException if the version string is invalid
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,12 +17,12 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.data.versioning;
|
package de.staropensource.engine.base.implementation.versioning;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.VersioningSystem;
|
import de.staropensource.engine.base.implementable.VersioningSystem;
|
||||||
import de.staropensource.sosengine.base.exceptions.IncompatibleVersioningSystemException;
|
import de.staropensource.engine.base.exception.versioning.IncompatibleVersioningSystemException;
|
||||||
import de.staropensource.sosengine.base.exceptions.InvalidVersionStringException;
|
import de.staropensource.engine.base.exception.versioning.InvalidVersionStringException;
|
||||||
import de.staropensource.sosengine.base.utility.Miscellaneous;
|
import de.staropensource.engine.base.utility.Miscellaneous;
|
||||||
import lombok.Getter;
|
import lombok.Getter;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
import org.jetbrains.annotations.Range;
|
import org.jetbrains.annotations.Range;
|
||||||
|
@ -30,46 +30,44 @@ import org.jetbrains.annotations.Range;
|
||||||
/**
|
/**
|
||||||
* Represents a two-numbered versioning system, where an application or work is versioning by two arbitrary numbers.
|
* Represents a two-numbered versioning system, where an application or work is versioning by two arbitrary numbers.
|
||||||
*
|
*
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
|
|
||||||
@Getter
|
@Getter
|
||||||
|
@SuppressWarnings({ "JavadocDeclaration" })
|
||||||
public final class TwoNumberVersioningSystem implements VersioningSystem {
|
public final class TwoNumberVersioningSystem implements VersioningSystem {
|
||||||
/**
|
/**
|
||||||
* Contains the 1. number vector.
|
* Contains the first number vector.
|
||||||
*
|
|
||||||
* @since 1-alpha1
|
|
||||||
*
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
* -- GETTER --
|
* -- GETTER --
|
||||||
* Returns the 1. number vector.
|
* Returns the first number vector.
|
||||||
*
|
*
|
||||||
* @return 1. number vector
|
* @return first number vector
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
private final int number1;
|
private final int number1;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Contains the 2. number vector.
|
* Contains the second number vector.
|
||||||
*
|
|
||||||
* @since 1-alpha1
|
|
||||||
*
|
*
|
||||||
|
* @since v1-alpha1
|
||||||
* -- GETTER --
|
* -- GETTER --
|
||||||
* Returns the 2. number vector.
|
* Returns the second number vector.
|
||||||
*
|
*
|
||||||
* @return 2. number vector
|
* @return second number vector
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
private final int number2;
|
private final int number2;
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
/** {@inheritDoc} */
|
||||||
@NotNull
|
|
||||||
@Override
|
@Override
|
||||||
public String getName() {
|
public @NotNull String getName() {
|
||||||
return "n2";
|
return "n2";
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Parses a two number-based version string.
|
* Tries to parse the specified version string
|
||||||
|
* and if successful, return a new instance.
|
||||||
*
|
*
|
||||||
* @param versionString version string to parse
|
* @param versionString version string to parse
|
||||||
* @throws InvalidVersionStringException if the version string is invalid
|
* @throws InvalidVersionStringException if the version string is invalid
|
||||||
|
@ -81,7 +79,7 @@ public final class TwoNumberVersioningSystem implements VersioningSystem {
|
||||||
// Escape separator or throw error if invalid
|
// Escape separator or throw error if invalid
|
||||||
switch (separator) {
|
switch (separator) {
|
||||||
case "." -> separator = "\\.";
|
case "." -> separator = "\\.";
|
||||||
case null -> throw new InvalidVersionStringException(this, versionString, "No matching separator could be found. Required are either one dot ('.') or hyphen ('-').");
|
case null -> throw new InvalidVersionStringException(this, versionString, "No matching separator could be found. Required are either one dot ('.') or hyphen ('-')");
|
||||||
default -> {}
|
default -> {}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -93,7 +91,7 @@ public final class TwoNumberVersioningSystem implements VersioningSystem {
|
||||||
this.number1 = Integer.parseUnsignedInt(versionStringSplit[0]);
|
this.number1 = Integer.parseUnsignedInt(versionStringSplit[0]);
|
||||||
this.number2 = Integer.parseUnsignedInt(versionStringSplit[1]);
|
this.number2 = Integer.parseUnsignedInt(versionStringSplit[1]);
|
||||||
} catch (NumberFormatException exception) {
|
} catch (NumberFormatException exception) {
|
||||||
throw new InvalidVersionStringException(this, versionString, "Failed converting one of the vectors to an integer.", exception);
|
throw new InvalidVersionStringException(this, versionString, "Failed converting one of the vectors to an integer", exception);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -18,9 +18,9 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Contains built-in versioning systems that
|
* Built-in versioning systems which
|
||||||
* can be used to represent versions of some work.
|
* can be used to represent versions of some work.
|
||||||
*
|
*
|
||||||
* @since 1-alpha1
|
* @since v1-alpha1
|
||||||
*/
|
*/
|
||||||
package de.staropensource.sosengine.base.data.versioning;
|
package de.staropensource.engine.base.implementation.versioning;
|
|
@ -0,0 +1,83 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.engine.base.internal.implementation;
|
||||||
|
|
||||||
|
import de.staropensource.engine.base.implementable.EventListenerCode;
|
||||||
|
import de.staropensource.engine.base.reflection.Reflect;
|
||||||
|
import de.staropensource.engine.base.reflection.ReflectionMethod;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
import org.jetbrains.annotations.Nullable;
|
||||||
|
|
||||||
|
import java.lang.annotation.Annotation;
|
||||||
|
import java.lang.reflect.Method;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Interface specifically for executing event listener methods.
|
||||||
|
*
|
||||||
|
* @since v1-alpha5
|
||||||
|
*/
|
||||||
|
public final class EventListenerMethod extends EventListenerCode {
|
||||||
|
/**
|
||||||
|
* Contains the method to call and get.
|
||||||
|
*
|
||||||
|
* @since v1-alpha5
|
||||||
|
*/
|
||||||
|
private final @NotNull ReflectionMethod method;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates and initializes an instance of this class.
|
||||||
|
*
|
||||||
|
* @param method method to execute
|
||||||
|
* @since v1-alpha5
|
||||||
|
*/
|
||||||
|
public EventListenerMethod(@NotNull Method method) {
|
||||||
|
this.method = Reflect.reflectOn(method);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public void run(@Nullable Object @NotNull [] arguments) throws Exception {
|
||||||
|
method.invoke(arguments);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Forwards {@link ReflectionMethod#getAnnotation(Class)}
|
||||||
|
* to the internal {@link ReflectionMethod} instance.
|
||||||
|
*
|
||||||
|
* @param <T> annotation
|
||||||
|
* @param annotation annotation to get
|
||||||
|
* @return annotation or {@code null} on error
|
||||||
|
* @see ReflectionMethod#getAnnotation(Class)
|
||||||
|
* @since v1-alpha5
|
||||||
|
*/
|
||||||
|
public <T extends Annotation> @Nullable T getAnnotation(@NotNull Class<T> annotation) {
|
||||||
|
try {
|
||||||
|
return method.getAnnotation(annotation);
|
||||||
|
} catch (NullPointerException exception) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public String toString() {
|
||||||
|
return "method " + method.getMethod().getDeclaringClass().getName() + "#" + method.getName();
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,25 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Interfaces and abstract classes which can be used for implementing classes.
|
||||||
|
*
|
||||||
|
* @since v1-alpha5
|
||||||
|
*/
|
||||||
|
package de.staropensource.engine.base.internal.implementation;
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,10 +17,10 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.internal.placeholders;
|
package de.staropensource.engine.base.internal.implementation.placeholder;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.Placeholder;
|
import de.staropensource.engine.base.implementable.Placeholder;
|
||||||
import de.staropensource.sosengine.base.utility.Miscellaneous;
|
import de.staropensource.engine.base.utility.Math;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
import java.util.Calendar;
|
import java.util.Calendar;
|
||||||
|
@ -29,27 +29,20 @@ import java.util.Calendar;
|
||||||
* Implements the {@code date_day} placeholder.
|
* Implements the {@code date_day} placeholder.
|
||||||
*
|
*
|
||||||
* @see Placeholder
|
* @see Placeholder
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused" })
|
@SuppressWarnings({ "unused" })
|
||||||
public final class DateDay implements Placeholder {
|
public final class DateDay implements Placeholder {
|
||||||
/**
|
/**
|
||||||
* Constructs this class.
|
* Creates and initializes an instance of this event.
|
||||||
*
|
*
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
public DateDay() {}
|
public DateDay() {}
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
/** {@inheritDoc} */
|
||||||
@NotNull
|
|
||||||
public String getName() {
|
|
||||||
return "date_day";
|
|
||||||
}
|
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
|
||||||
@NotNull
|
|
||||||
@Override
|
@Override
|
||||||
public String replace(@NotNull String text) {
|
public @NotNull String replace(@NotNull String text) {
|
||||||
return text.replace("%" + getName() + "%", Miscellaneous.padNumbers(Calendar.getInstance().get(Calendar.DAY_OF_MONTH), 2));
|
return text.replace("%date_day%", Math.padNumbers(Calendar.getInstance().get(Calendar.DAY_OF_MONTH), 2));
|
||||||
}
|
}
|
||||||
}
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,10 +17,10 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.internal.placeholders;
|
package de.staropensource.engine.base.internal.implementation.placeholder;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.Placeholder;
|
import de.staropensource.engine.base.implementable.Placeholder;
|
||||||
import de.staropensource.sosengine.base.utility.Miscellaneous;
|
import de.staropensource.engine.base.utility.Math;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
import java.util.Calendar;
|
import java.util.Calendar;
|
||||||
|
@ -29,27 +29,20 @@ import java.util.Calendar;
|
||||||
* Implements the {@code date_month} placeholder.
|
* Implements the {@code date_month} placeholder.
|
||||||
*
|
*
|
||||||
* @see Placeholder
|
* @see Placeholder
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused" })
|
@SuppressWarnings({ "unused" })
|
||||||
public final class DateMonth implements Placeholder {
|
public final class DateMonth implements Placeholder {
|
||||||
/**
|
/**
|
||||||
* Constructs this class.
|
* Creates and initializes an instance of this event.
|
||||||
*
|
*
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
public DateMonth() {}
|
public DateMonth() {}
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
/** {@inheritDoc} */
|
||||||
@NotNull
|
|
||||||
public String getName() {
|
|
||||||
return "date_month";
|
|
||||||
}
|
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
|
||||||
@NotNull
|
|
||||||
@Override
|
@Override
|
||||||
public String replace(@NotNull String text) {
|
public @NotNull String replace(@NotNull String text) {
|
||||||
return text.replace("%" + getName() + "%", Miscellaneous.padNumbers(Calendar.getInstance().get(Calendar.MONTH), 2));
|
return text.replace("%date_month%", Math.padNumbers(Calendar.getInstance().get(Calendar.MONTH), 2));
|
||||||
}
|
}
|
||||||
}
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,10 +17,10 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.internal.placeholders;
|
package de.staropensource.engine.base.internal.implementation.placeholder;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.Placeholder;
|
import de.staropensource.engine.base.implementable.Placeholder;
|
||||||
import de.staropensource.sosengine.base.utility.Miscellaneous;
|
import de.staropensource.engine.base.utility.Math;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
import java.util.Calendar;
|
import java.util.Calendar;
|
||||||
|
@ -29,27 +29,20 @@ import java.util.Calendar;
|
||||||
* Implements the {@code date_year} placeholder.
|
* Implements the {@code date_year} placeholder.
|
||||||
*
|
*
|
||||||
* @see Placeholder
|
* @see Placeholder
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused" })
|
@SuppressWarnings({ "unused" })
|
||||||
public final class DateYear implements Placeholder {
|
public final class DateYear implements Placeholder {
|
||||||
/**
|
/**
|
||||||
* Constructs this class.
|
* Creates and initializes an instance of this event.
|
||||||
*
|
*
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
public DateYear() {}
|
public DateYear() {}
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
/** {@inheritDoc} */
|
||||||
@NotNull
|
|
||||||
public String getName() {
|
|
||||||
return "date_year";
|
|
||||||
}
|
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
|
||||||
@NotNull
|
|
||||||
@Override
|
@Override
|
||||||
public String replace(@NotNull String text) {
|
public @NotNull String replace(@NotNull String text) {
|
||||||
return text.replace("%" + getName() + "%", Miscellaneous.padNumbers(Calendar.getInstance().get(Calendar.YEAR), 4));
|
return text.replace("%date_year%", Math.padNumbers(Calendar.getInstance().get(Calendar.YEAR), 4));
|
||||||
}
|
}
|
||||||
}
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,37 +17,30 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.internal.placeholders;
|
package de.staropensource.engine.base.internal.implementation.placeholder;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.Placeholder;
|
import de.staropensource.engine.base.implementable.Placeholder;
|
||||||
import de.staropensource.sosengine.base.data.info.EngineInformation;
|
import de.staropensource.engine.base.utility.information.EngineInformation;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Implements the {@code engine_dependency_jansi} placeholder.
|
* Implements the {@code engine_dependency_jansi} placeholder.
|
||||||
*
|
*
|
||||||
* @see Placeholder
|
* @see Placeholder
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused" })
|
@SuppressWarnings({ "unused" })
|
||||||
public final class EngineDependencyJansi implements Placeholder {
|
public final class EngineDependencyJansi implements Placeholder {
|
||||||
/**
|
/**
|
||||||
* Constructs this class.
|
* Creates and initializes an instance of this event.
|
||||||
*
|
*
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
public EngineDependencyJansi() {}
|
public EngineDependencyJansi() {}
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
/** {@inheritDoc} */
|
||||||
@NotNull
|
|
||||||
public String getName() {
|
|
||||||
return "engine_dependency_jansi";
|
|
||||||
}
|
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
|
||||||
@NotNull
|
|
||||||
@Override
|
@Override
|
||||||
public String replace(@NotNull String text) {
|
public @NotNull String replace(@NotNull String text) {
|
||||||
return text.replace("%" + getName() + "%", EngineInformation.getDependencyJansi());
|
return text.replace("%engine_dependency_jansi%", EngineInformation.getDependencyJansi());
|
||||||
}
|
}
|
||||||
}
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,37 +17,30 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.internal.placeholders;
|
package de.staropensource.engine.base.internal.implementation.placeholder;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.Placeholder;
|
import de.staropensource.engine.base.implementable.Placeholder;
|
||||||
import de.staropensource.sosengine.base.data.info.EngineInformation;
|
import de.staropensource.engine.base.utility.information.EngineInformation;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Implements the {@code engine_dependency_lwjgl} placeholder.
|
* Implements the {@code engine_dependency_lwjgl} placeholder.
|
||||||
*
|
*
|
||||||
* @see Placeholder
|
* @see Placeholder
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused" })
|
@SuppressWarnings({ "unused" })
|
||||||
public final class EngineDependencyLwjgl implements Placeholder {
|
public final class EngineDependencyLwjgl implements Placeholder {
|
||||||
/**
|
/**
|
||||||
* Constructs this class.
|
* Creates and initializes an instance of this event.
|
||||||
*
|
*
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
public EngineDependencyLwjgl() {}
|
public EngineDependencyLwjgl() {}
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
/** {@inheritDoc} */
|
||||||
@NotNull
|
|
||||||
public String getName() {
|
|
||||||
return "engine_dependency_lwjgl";
|
|
||||||
}
|
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
|
||||||
@NotNull
|
|
||||||
@Override
|
@Override
|
||||||
public String replace(@NotNull String text) {
|
public @NotNull String replace(@NotNull String text) {
|
||||||
return text.replace("%" + getName() + "%", EngineInformation.getDependencyLwjgl());
|
return text.replace("%engine_dependency_lwjgl%", EngineInformation.getDependencyLwjgl());
|
||||||
}
|
}
|
||||||
}
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,37 +17,30 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.internal.placeholders;
|
package de.staropensource.engine.base.internal.implementation.placeholder;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.Placeholder;
|
import de.staropensource.engine.base.implementable.Placeholder;
|
||||||
import de.staropensource.sosengine.base.data.info.EngineInformation;
|
import de.staropensource.engine.base.utility.information.EngineInformation;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Implements the {@code engine_dependency_reflections} placeholder.
|
* Implements the {@code engine_dependency_reflections} placeholder.
|
||||||
*
|
*
|
||||||
* @see Placeholder
|
* @see Placeholder
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused" })
|
@SuppressWarnings({ "unused" })
|
||||||
public final class EngineDependencyReflections implements Placeholder {
|
public final class EngineDependencyReflections implements Placeholder {
|
||||||
/**
|
/**
|
||||||
* Constructs this class.
|
* Creates and initializes an instance of this event.
|
||||||
*
|
*
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
public EngineDependencyReflections() {}
|
public EngineDependencyReflections() {}
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
/** {@inheritDoc} */
|
||||||
@NotNull
|
|
||||||
public String getName() {
|
|
||||||
return "engine_dependency_reflections";
|
|
||||||
}
|
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
|
||||||
@NotNull
|
|
||||||
@Override
|
@Override
|
||||||
public String replace(@NotNull String text) {
|
public @NotNull String replace(@NotNull String text) {
|
||||||
return text.replace("%" + getName() + "%", EngineInformation.getDependencyReflections());
|
return text.replace("%engine_dependency_reflections%", EngineInformation.getDependencyReflections());
|
||||||
}
|
}
|
||||||
}
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,37 +17,30 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.internal.placeholders;
|
package de.staropensource.engine.base.internal.implementation.placeholder;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.Placeholder;
|
import de.staropensource.engine.base.implementable.Placeholder;
|
||||||
import de.staropensource.sosengine.base.data.info.EngineInformation;
|
import de.staropensource.engine.base.utility.information.EngineInformation;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Implements the {@code engine_dependency_slf4j} placeholder.
|
* Implements the {@code engine_dependency_slf4j} placeholder.
|
||||||
*
|
*
|
||||||
* @see Placeholder
|
* @see Placeholder
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused" })
|
@SuppressWarnings({ "unused" })
|
||||||
public final class EngineDependencySlf4j implements Placeholder {
|
public final class EngineDependencySlf4j implements Placeholder {
|
||||||
/**
|
/**
|
||||||
* Constructs this class.
|
* Creates and initializes an instance of this event.
|
||||||
*
|
*
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
public EngineDependencySlf4j() {}
|
public EngineDependencySlf4j() {}
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
/** {@inheritDoc} */
|
||||||
@NotNull
|
|
||||||
public String getName() {
|
|
||||||
return "engine_dependency_slf4j";
|
|
||||||
}
|
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
|
||||||
@NotNull
|
|
||||||
@Override
|
@Override
|
||||||
public String replace(@NotNull String text) {
|
public @NotNull String replace(@NotNull String text) {
|
||||||
return text.replace("%" + getName() + "%", EngineInformation.getDependencySlf4j());
|
return text.replace("%engine_dependency_slf4j%", EngineInformation.getDependencySlf4j());
|
||||||
}
|
}
|
||||||
}
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,37 +17,30 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.internal.placeholders;
|
package de.staropensource.engine.base.internal.implementation.placeholder;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.Placeholder;
|
import de.staropensource.engine.base.implementable.Placeholder;
|
||||||
import de.staropensource.sosengine.base.data.info.EngineInformation;
|
import de.staropensource.engine.base.utility.information.EngineInformation;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Implements the {@code engine_git_branch} placeholder.
|
* Implements the {@code engine_git_branch} placeholder.
|
||||||
*
|
*
|
||||||
* @see Placeholder
|
* @see Placeholder
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused" })
|
@SuppressWarnings({ "unused" })
|
||||||
public final class EngineGitBranch implements Placeholder {
|
public final class EngineGitBranch implements Placeholder {
|
||||||
/**
|
/**
|
||||||
* Constructs this class.
|
* Creates and initializes an instance of this event.
|
||||||
*
|
*
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
public EngineGitBranch() {}
|
public EngineGitBranch() {}
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
/** {@inheritDoc} */
|
||||||
@NotNull
|
|
||||||
public String getName() {
|
|
||||||
return "engine_git_branch";
|
|
||||||
}
|
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
|
||||||
@NotNull
|
|
||||||
@Override
|
@Override
|
||||||
public String replace(@NotNull String text) {
|
public @NotNull String replace(@NotNull String text) {
|
||||||
return text.replace("%" + getName() + "%", EngineInformation.getGitBranch());
|
return text.replace("%engine_git_branch%", EngineInformation.getGitBranch());
|
||||||
}
|
}
|
||||||
}
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,37 +17,30 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.internal.placeholders;
|
package de.staropensource.engine.base.internal.implementation.placeholder;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.Placeholder;
|
import de.staropensource.engine.base.implementable.Placeholder;
|
||||||
import de.staropensource.sosengine.base.data.info.EngineInformation;
|
import de.staropensource.engine.base.utility.information.EngineInformation;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Implements the {@code engine_git_commit_header} placeholder.
|
* Implements the {@code engine_git_commit_header} placeholder.
|
||||||
*
|
*
|
||||||
* @see Placeholder
|
* @see Placeholder
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused" })
|
@SuppressWarnings({ "unused" })
|
||||||
public final class EngineGitCommitHeader implements Placeholder {
|
public final class EngineGitCommitHeader implements Placeholder {
|
||||||
/**
|
/**
|
||||||
* Constructs this class.
|
* Creates and initializes an instance of this event.
|
||||||
*
|
*
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
public EngineGitCommitHeader() {}
|
public EngineGitCommitHeader() {}
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
/** {@inheritDoc} */
|
||||||
@NotNull
|
|
||||||
public String getName() {
|
|
||||||
return "engine_git_commit_header";
|
|
||||||
}
|
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
|
||||||
@NotNull
|
|
||||||
@Override
|
@Override
|
||||||
public String replace(@NotNull String text) {
|
public @NotNull String replace(@NotNull String text) {
|
||||||
return text.replace("%" + getName() + "%", EngineInformation.getGitCommitHeader());
|
return text.replace("%engine_git_commit_header%", EngineInformation.getGitCommitHeader());
|
||||||
}
|
}
|
||||||
}
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,37 +17,30 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.internal.placeholders;
|
package de.staropensource.engine.base.internal.implementation.placeholder;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.Placeholder;
|
import de.staropensource.engine.base.implementable.Placeholder;
|
||||||
import de.staropensource.sosengine.base.data.info.EngineInformation;
|
import de.staropensource.engine.base.utility.information.EngineInformation;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Implements the {@code engine_git_commit_id_long} placeholder.
|
* Implements the {@code engine_git_commit_id_long} placeholder.
|
||||||
*
|
*
|
||||||
* @see Placeholder
|
* @see Placeholder
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused" })
|
@SuppressWarnings({ "unused" })
|
||||||
public final class EngineGitCommitIdLong implements Placeholder {
|
public final class EngineGitCommitIdLong implements Placeholder {
|
||||||
/**
|
/**
|
||||||
* Constructs this class.
|
* Creates and initializes an instance of this event.
|
||||||
*
|
*
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
public EngineGitCommitIdLong() {}
|
public EngineGitCommitIdLong() {}
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
/** {@inheritDoc} */
|
||||||
@NotNull
|
|
||||||
public String getName() {
|
|
||||||
return "engine_git_commit_id_long";
|
|
||||||
}
|
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
|
||||||
@NotNull
|
|
||||||
@Override
|
@Override
|
||||||
public String replace(@NotNull String text) {
|
public @NotNull String replace(@NotNull String text) {
|
||||||
return text.replace("%" + getName() + "%", EngineInformation.getGitCommitIdentifierLong());
|
return text.replace("%engine_git_commit_id_long%", EngineInformation.getGitCommitIdentifierLong());
|
||||||
}
|
}
|
||||||
}
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,37 +17,30 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.internal.placeholders;
|
package de.staropensource.engine.base.internal.implementation.placeholder;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.Placeholder;
|
import de.staropensource.engine.base.implementable.Placeholder;
|
||||||
import de.staropensource.sosengine.base.data.info.EngineInformation;
|
import de.staropensource.engine.base.utility.information.EngineInformation;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Implements the {@code engine_git_commit_id_short} placeholder.
|
* Implements the {@code engine_git_commit_id_short} placeholder.
|
||||||
*
|
*
|
||||||
* @see Placeholder
|
* @see Placeholder
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused" })
|
@SuppressWarnings({ "unused" })
|
||||||
public final class EngineGitCommitIdShort implements Placeholder {
|
public final class EngineGitCommitIdShort implements Placeholder {
|
||||||
/**
|
/**
|
||||||
* Constructs this class.
|
* Creates and initializes an instance of this event.
|
||||||
*
|
*
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
public EngineGitCommitIdShort() {}
|
public EngineGitCommitIdShort() {}
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
/** {@inheritDoc} */
|
||||||
@NotNull
|
|
||||||
public String getName() {
|
|
||||||
return "engine_git_commit_id_short";
|
|
||||||
}
|
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
|
||||||
@NotNull
|
|
||||||
@Override
|
@Override
|
||||||
public String replace(@NotNull String text) {
|
public @NotNull String replace(@NotNull String text) {
|
||||||
return text.replace("%" + getName() + "%", EngineInformation.getGitCommitIdentifierShort());
|
return text.replace("%engine_git_commit_id_short%", EngineInformation.getGitCommitIdentifierShort());
|
||||||
}
|
}
|
||||||
}
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,37 +17,30 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.internal.placeholders;
|
package de.staropensource.engine.base.internal.implementation.placeholder;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.Placeholder;
|
import de.staropensource.engine.base.implementable.Placeholder;
|
||||||
import de.staropensource.sosengine.base.data.info.EngineInformation;
|
import de.staropensource.engine.base.utility.information.EngineInformation;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Implements the {@code engine_git_commit_time_day} placeholder.
|
* Implements the {@code engine_git_commit_time_day} placeholder.
|
||||||
*
|
*
|
||||||
* @see Placeholder
|
* @see Placeholder
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused" })
|
@SuppressWarnings({ "unused" })
|
||||||
public final class EngineGitCommitTimeDay implements Placeholder {
|
public final class EngineGitCommitTimeDay implements Placeholder {
|
||||||
/**
|
/**
|
||||||
* Constructs this class.
|
* Creates and initializes an instance of this event.
|
||||||
*
|
*
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
public EngineGitCommitTimeDay() {}
|
public EngineGitCommitTimeDay() {}
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
/** {@inheritDoc} */
|
||||||
@NotNull
|
|
||||||
public String getName() {
|
|
||||||
return "engine_git_commit_time_day";
|
|
||||||
}
|
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
|
||||||
@NotNull
|
|
||||||
@Override
|
@Override
|
||||||
public String replace(@NotNull String text) {
|
public @NotNull String replace(@NotNull String text) {
|
||||||
return text.replace("%" + getName() + "%", String.valueOf(EngineInformation.getGitCommitTime().getDayOfMonth()));
|
return text.replace("%engine_git_commit_time_day%", String.valueOf(EngineInformation.getGitCommitTime().getDayOfMonth()));
|
||||||
}
|
}
|
||||||
}
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,37 +17,30 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.internal.placeholders;
|
package de.staropensource.engine.base.internal.implementation.placeholder;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.Placeholder;
|
import de.staropensource.engine.base.implementable.Placeholder;
|
||||||
import de.staropensource.sosengine.base.data.info.EngineInformation;
|
import de.staropensource.engine.base.utility.information.EngineInformation;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Implements the {@code engine_git_commit_time_hour} placeholder.
|
* Implements the {@code engine_git_commit_time_hour} placeholder.
|
||||||
*
|
*
|
||||||
* @see Placeholder
|
* @see Placeholder
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused" })
|
@SuppressWarnings({ "unused" })
|
||||||
public final class EngineGitCommitTimeHour implements Placeholder {
|
public final class EngineGitCommitTimeHour implements Placeholder {
|
||||||
/**
|
/**
|
||||||
* Constructs this class.
|
* Creates and initializes an instance of this event.
|
||||||
*
|
*
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
public EngineGitCommitTimeHour() {}
|
public EngineGitCommitTimeHour() {}
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
/** {@inheritDoc} */
|
||||||
@NotNull
|
|
||||||
public String getName() {
|
|
||||||
return "engine_git_commit_time_hour";
|
|
||||||
}
|
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
|
||||||
@NotNull
|
|
||||||
@Override
|
@Override
|
||||||
public String replace(@NotNull String text) {
|
public @NotNull String replace(@NotNull String text) {
|
||||||
return text.replace("%" + getName() + "%", String.valueOf(EngineInformation.getGitCommitTime().getHour()));
|
return text.replace("%engine_git_commit_time_hour%", String.valueOf(EngineInformation.getGitCommitTime().getHour()));
|
||||||
}
|
}
|
||||||
}
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
/*
|
/*
|
||||||
* STAROPENSOURCE ENGINE SOURCE FILE
|
* STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
* Copyright (c) 2024 The StarOpenSource Engine Contributors
|
* Copyright (c) 2024 The StarOpenSource Engine Authors
|
||||||
* Licensed under the GNU Affero General Public License v3
|
* Licensed under the GNU Affero General Public License v3
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
@ -17,37 +17,30 @@
|
||||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package de.staropensource.sosengine.base.internal.placeholders;
|
package de.staropensource.engine.base.internal.implementation.placeholder;
|
||||||
|
|
||||||
import de.staropensource.sosengine.base.classes.Placeholder;
|
import de.staropensource.engine.base.implementable.Placeholder;
|
||||||
import de.staropensource.sosengine.base.data.info.EngineInformation;
|
import de.staropensource.engine.base.utility.information.EngineInformation;
|
||||||
import org.jetbrains.annotations.NotNull;
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Implements the {@code engine_git_commit_time_minute} placeholder.
|
* Implements the {@code engine_git_commit_time_minute} placeholder.
|
||||||
*
|
*
|
||||||
* @see Placeholder
|
* @see Placeholder
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings({ "unused" })
|
@SuppressWarnings({ "unused" })
|
||||||
public final class EngineGitCommitTimeMinute implements Placeholder {
|
public final class EngineGitCommitTimeMinute implements Placeholder {
|
||||||
/**
|
/**
|
||||||
* Constructs this class.
|
* Creates and initializes an instance of this event.
|
||||||
*
|
*
|
||||||
* @since 1-alpha0
|
* @since v1-alpha0
|
||||||
*/
|
*/
|
||||||
public EngineGitCommitTimeMinute() {}
|
public EngineGitCommitTimeMinute() {}
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
/** {@inheritDoc} */
|
||||||
@NotNull
|
|
||||||
public String getName() {
|
|
||||||
return "engine_git_commit_time_minute";
|
|
||||||
}
|
|
||||||
|
|
||||||
/** {@inheritDoc} */
|
|
||||||
@NotNull
|
|
||||||
@Override
|
@Override
|
||||||
public String replace(@NotNull String text) {
|
public @NotNull String replace(@NotNull String text) {
|
||||||
return text.replace("%" + getName() + "%", String.valueOf(EngineInformation.getGitCommitTime().getMinute()));
|
return text.replace("%engine_git_commit_time_minute%", String.valueOf(EngineInformation.getGitCommitTime().getMinute()));
|
||||||
}
|
}
|
||||||
}
|
}
|
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue