trinitrix
/
trixy
Archived
5
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
This repository has been archived on 2024-05-26. You can view files and clone it, but cannot push or open issues or pull requests.
trixy/docs/generate_docs.sh

27 lines
1015 B
Bash
Raw Permalink Normal View History

chore(treewide): Add or update license header
2024-03-26 18:56:20 +00:00
#! /usr/bin/env sh
chore(treewide): Add the new license header
2024-02-19 15:13:06 +00:00
# Copyright (C) 2023 - 2024:
# The Trinitrix Project <soispha@vhack.eu, antifallobst@systemausfall.org>
chore(treewide): Add or update license header
2024-03-26 18:56:20 +00:00
# SPDX-License-Identifier: LGPL-3.0-or-later
#
chore(treewide): Add the new license header
2024-02-19 15:13:06 +00:00
# This file is part of the Trixy crate for Trinitrix.
#
# Trixy is free software: you can redistribute it and/or modify
# it under the terms of the Lesser GNU 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# and the Lesser GNU General Public License along with this program.
# If not, see <https://www.gnu.org/licenses/>.
chore(treewide): Add license headers
2023-12-23 17:57:10 +00:00
fix(docs/generate_docs): Cd into the correct directory to make ebnf2pdf work
2024-03-27 09:21:50 +00:00
cd "$(dirname "$0")" || exit 1
refactor(treewide): Rework file structure in `src/macros` This might be a big diff, but I _hope_ that it does not change much functionally (hopefully it changes nothing generation specific). What has changed? ----------------- - I had to merge the three crates into one, to allow `macros` to impl functions on Types defined in `parser`. - As mentioned in the point above, the conversion function are now inherent to the type they convert (i. e. `r#type.to_rust()` instead of `type_to_rust(r#type)`). - The conversion function have been sorted, by what they convert to: - `to_rust()` converts a type to be used in rust *host* code. - `to_c()` converts a type to be used in c *host* code. - `to_auxiliary_c()` converts a type to be used in c *auxiliary* code. - The top-most `generate` method of `TrixyConfig` now returns a `FileTree` instead of writing the files directly. The `FileTree` can still be materialize with the `materialize` method. But this change facilitates moving non-generation focused code out of the `generate` method. What is the difference between _host_ and _auxiliary_ code? ----------------------------------------------------------- Auxiliary code is always written in the language it is generated for. So auxiliary code for c would be written in c (or at least in a subset of c), as it represents c header files. Host code is always written in rust. This is the code that is responsible for implementing the actual ffi stuff. In our case these are the `extern "C"` functions and the types, defined in trixy. The rust host code is generating the native rust representations of these types.
2024-03-26 09:38:14 +00:00
ebnf2pdf make "./grammar.ebnf"
mv grammar.ebnf.pdf ./grammar.pdf
chore: Initial commit This not the "real" first commit, the others are in the trinitrix/core repository, made before the split-up took place
2023-12-23 15:07:17 +00:00
# vim: ft=sh