├── rust-toolchain.toml
├── .gitignore
├── tests
├── node.rs
├── status.rs
├── convert.rs
├── quick.rs
├── meta.rs
└── ast.rs
├── examples
├── html.rs
├── markdown.rs
├── ast.rs
├── ast_to_gemtext.rs
├── convert.html
├── convert.md
├── meta.rs
├── request_blocking.rs
├── request.rs
└── request_blocking_to_gemtext_from_ast.rs
├── justfile
├── rustfmt.toml
├── .github
└── workflows
│ └── check.yaml
├── src
├── ast.rs
├── request.rs
├── ast
│ ├── macros.rs
│ ├── node.rs
│ └── container.rs
├── request
│ ├── verifier.rs
│ ├── blocking.rs
│ ├── non_blocking.rs
│ ├── response.rs
│ └── status.rs
├── convert
│ ├── macros.rs
│ ├── markdown.rs
│ └── html.rs
├── quick.rs
├── convert.rs
├── lib.rs
└── meta.rs
├── Cargo.toml
├── README.md
└── LICENSE
/rust-toolchain.toml:
--------------------------------------------------------------------------------
1 | [toolchain]
2 | channel = "stable"
3 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Rust
2 | target
3 | Cargo.lock
4 |
5 | # CLion
6 | .idea
7 |
8 | # Visual Studio Code
9 | .vscode
10 |
11 | # Fuwn/justfiles
12 | *.just
13 |
--------------------------------------------------------------------------------
/tests/node.rs:
--------------------------------------------------------------------------------
1 | #[cfg(test)]
2 | mod test {
3 | #[test]
4 | fn node_to_gemtext() {
5 | assert_eq!(
6 | germ::ast::Node::Link {
7 | to: "/faq".to_string(),
8 | text: Some("FAQ".to_string()),
9 | }
10 | .to_gemtext(),
11 | "=> /faq FAQ",
12 | );
13 | }
14 | }
15 |
--------------------------------------------------------------------------------
/examples/html.rs:
--------------------------------------------------------------------------------
1 | //! This example demonstrates Germ's capabilities for converting Gemtext to
2 | //! HTML.
3 |
4 | fn main() {
5 | // Convert the Gemtext to HTML
6 | let html = germ::convert::from_string(
7 | germ::EXAMPLE_GEMTEXT,
8 | &germ::convert::Target::HTML,
9 | );
10 |
11 | // Write the HTML to a file
12 | std::fs::write("examples/convert.html", html)
13 | .expect("could not write to file");
14 | }
15 |
--------------------------------------------------------------------------------
/examples/markdown.rs:
--------------------------------------------------------------------------------
1 | //! This example demonstrates Germ's capabilities for converting Gemtext to
2 | //! Markdown.
3 |
4 | fn main() {
5 | // Convert the Gemtext to Markdown
6 | let html = germ::convert::from_string(
7 | germ::EXAMPLE_GEMTEXT,
8 | &germ::convert::Target::Markdown,
9 | );
10 |
11 | // Write the Markdown to a file
12 | std::fs::write("examples/convert.md", html).expect("could not write to file");
13 | }
14 |
--------------------------------------------------------------------------------
/examples/ast.rs:
--------------------------------------------------------------------------------
1 | //! This example demonstrates Germ's capabilities for parsing Gemtext into an
2 | //! abstract syntax tree.
3 |
4 | fn main() {
5 | // Parse `EXAMPLE_GEMTEXT` into an abstract syntax tree
6 | let ast = germ::ast::Ast::from_string(germ::EXAMPLE_GEMTEXT);
7 | // Get the nodes of the abstract syntax tree
8 | let ast_nodes = ast.inner();
9 |
10 | // Print the abstract syntax tree nodes, one-by-one
11 | for node in ast_nodes {
12 | println!("{:?}", node);
13 | }
14 | }
15 |
--------------------------------------------------------------------------------
/examples/ast_to_gemtext.rs:
--------------------------------------------------------------------------------
1 | //! This example converts Gemtext into an abstract syntax tree and then back
2 | //! into Gemtext, demonstrating both Germ's parsing and generation capabilities.
3 |
4 | fn main() {
5 | // Parse `EXAMPLE_GEMTEXT` into an abstract syntax tree
6 | let ast = germ::ast::Ast::from_string(germ::EXAMPLE_GEMTEXT);
7 | // Convert the abstract syntax tree back to Gemtext
8 | let gemtext = ast.to_gemtext();
9 |
10 | // Print the Gemtext, identical to `EXAMPLE_GEMTEXT`
11 | println!("{gemtext}");
12 | }
13 |
--------------------------------------------------------------------------------
/justfile:
--------------------------------------------------------------------------------
1 | import? 'cargo.just'
2 |
3 | set allow-duplicate-recipes := true
4 |
5 | default:
6 | @just --list
7 |
8 | fetch:
9 | curl https://raw.githubusercontent.com/Fuwn/justfiles/a6ca8a1b0475966ad10b68c44311ba3cb8b72a31/cargo.just > cargo.just
10 |
11 | fmt:
12 | cargo +nightly fmt
13 |
14 | test:
15 | cargo test --all-features
16 |
17 | docs:
18 | cargo +nightly doc --open --no-deps
19 |
20 | example example:
21 | cargo run --example {{ example }} --all-features
22 |
23 | diff url="gemini://fuwn.me/":
24 | cargo run --example request_blocking_to_gemtext_from_ast --all-features -- {{ url }}
25 |
--------------------------------------------------------------------------------
/examples/convert.html:
--------------------------------------------------------------------------------
1 | Here goes the pre-formatted text.
2 |
3 | This continues the pre-formatted text on a new line after a blank line.
4 |
This is a heading
This is some text.
This is more text after a blank line.
- This is a single list item.
5 | - This is the next list item.
- This is a new list.
6 | - This is the next item on the new list.
This is a sub-heading
This is a blockquote.
This is a sub-sub-heading.
This is a link to GemRest
/somewhere
That was a link without text.
--------------------------------------------------------------------------------
/examples/convert.md:
--------------------------------------------------------------------------------
1 | ```This is alt-text
2 | Here goes the pre-formatted text.
3 |
4 | This continues the pre-formatted text on a new line after a blank line.
5 | ```
6 |
7 | # This is a heading
8 |
9 | This is some text.
10 |
11 | This is more text after a blank line.
12 |
13 | - This is a single list item.
14 | - This is the next list item.
15 |
16 | - This is a new list.
17 | - This is the next item on the new list.
18 |
19 | ## This is a sub-heading
20 |
21 | > This is a blockquote.
22 |
23 | ### This is a sub-sub-heading.
24 |
25 | [This is a link to GemRest](gemini://gem.rest/)
26 |
27 |
28 | That was a link without text.
29 |
--------------------------------------------------------------------------------
/examples/meta.rs:
--------------------------------------------------------------------------------
1 | //! This example demonstrates Germ's capabilities for parsing Gemini meta
2 | //! sections.
3 |
4 | fn main() {
5 | // Parse Gemini meta section into a structured meta representation
6 | let meta = germ::meta::Meta::from_string("text/gemini; hi=2; hi2=string=2");
7 |
8 | // Debug view of the structured meta representation
9 | println!("{:?}", meta);
10 |
11 | // Convert the structured meta representation back to a string, identical to
12 | // the original meta section
13 | println!("{}", meta);
14 |
15 | // The MIME type of the meta section
16 | println!("{}", meta.mime());
17 |
18 | // A debug view of the parameters of the meta section
19 | println!("{:?}", meta.parameters());
20 | }
21 |
--------------------------------------------------------------------------------
/rustfmt.toml:
--------------------------------------------------------------------------------
1 | edition = "2021"
2 | enum_discrim_align_threshold = 40
3 | # error_on_line_overflow = true
4 | # error_on_unformatted = true
5 | fn_single_line = true
6 | format_code_in_doc_comments = true
7 | format_macro_matchers = true
8 | format_strings = true
9 | inline_attribute_width = 80
10 | match_arm_blocks = false
11 | max_width = 80
12 | imports_granularity = "One"
13 | newline_style = "Unix"
14 | normalize_doc_attributes = true
15 | overflow_delimited_expr = true
16 | reorder_impl_items = true
17 | group_imports = "StdExternalCrate"
18 | struct_field_align_threshold = 40
19 | tab_spaces = 2
20 | use_field_init_shorthand = true
21 | use_small_heuristics = "Max"
22 | use_try_shorthand = true
23 | style_edition = "2024"
24 | wrap_comments = true
25 |
--------------------------------------------------------------------------------
/.github/workflows/check.yaml:
--------------------------------------------------------------------------------
1 | name: Check ✅
2 | on:
3 | workflow_dispatch:
4 | push:
5 | paths:
6 | - "*"
7 | pull_request:
8 | paths:
9 | - "*"
10 | env:
11 | CARGO_TERM_COLOR: always
12 | jobs:
13 | check:
14 | runs-on: ubuntu-latest
15 | steps:
16 | - name: Checkout 🛒
17 | uses: actions/checkout@v3
18 | - name: Toolchain 🧰
19 | uses: actions-rs/toolchain@v1
20 | with:
21 | profile: minimal
22 | toolchain: stable
23 | components: rustfmt, clippy
24 | override: true
25 | - name: Check ✅
26 | uses: actions-rs/cargo@v1
27 | continue-on-error: false
28 | with:
29 | command: check
30 | args: --verbose
31 |
--------------------------------------------------------------------------------
/src/ast.rs:
--------------------------------------------------------------------------------
1 | // This file is part of Germ .
2 | // Copyright (C) 2022-2025 Fuwn
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, version 3.
7 | //
8 | // This program is distributed in the hope that it will be useful, but
9 | // WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 | // General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 | //
16 | // Copyright (C) 2022-2025 Fuwn
17 | // SPDX-License-Identifier: GPL-3.0-only
18 |
19 | //! Build AST trees from Gemtext
20 |
21 | mod container;
22 | mod node;
23 |
24 | #[cfg(feature = "macros")] mod macros;
25 |
26 | pub use {container::Ast, node::Node};
27 |
--------------------------------------------------------------------------------
/examples/request_blocking.rs:
--------------------------------------------------------------------------------
1 | //! This example demonstrates Germ's capabilities for performing a blocking
2 | //! request to a Gemini capsule.
3 |
4 | fn main() {
5 | // Form a valid URL to a Gemini capsule
6 | let url = url::Url::parse("gemini://fuwn.me").unwrap();
7 | // Perform a blocking request to the Gemini capsule
8 | let request = germ::request::blocking::request(&url);
9 |
10 | match request {
11 | // If the request was successful, print a debug view of the response
12 | Ok(response) => {
13 | // Print the status of the response
14 | println!("{:?}", response.status());
15 |
16 | // Print the meta string of the response
17 | //
18 | // More detailed meta usage can be found in the `meta` example
19 | println!("{}", response.meta());
20 |
21 | // Print the content of the response, if present
22 | println!("{:?}", response.content());
23 |
24 | // Print the size of the response
25 | println!("{:?}", response.size());
26 |
27 | // Print a debug view of the SSL suite used
28 | println!("{:?}", response.suite());
29 | }
30 | // If the request was unsuccessful, do nothing
31 | Err(_) => {}
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/examples/request.rs:
--------------------------------------------------------------------------------
1 | //! This example demonstrates Germ's capabilities for performing a non-blocking
2 | //! request to a Gemini capsule.
3 |
4 | #[tokio::main]
5 | async fn main() {
6 | // Form a valid URL to a Gemini capsule
7 | let url = url::Url::parse("gemini://fuwn.me").unwrap();
8 | // Perform a non-blocking request to the Gemini capsule
9 | let request = germ::request::request(&url).await;
10 |
11 | match request {
12 | // If the request was successful, print a debug view of the response
13 | Ok(response) => {
14 | // Print the status of the response
15 | println!("{:?}", response.status());
16 |
17 | // Print the meta string of the response
18 | //
19 | // More detailed meta usage can be found in the `meta` example
20 | println!("{}", response.meta());
21 |
22 | // Print the content of the response, if present
23 | println!("{:?}", response.content());
24 |
25 | // Print the size of the response
26 | println!("{:?}", response.size());
27 |
28 | // Print a debug view of the SSL suite used
29 | println!("{:?}", response.suite());
30 | }
31 | // If the request was unsuccessful, do nothing
32 | Err(_) => {}
33 | }
34 | }
35 |
--------------------------------------------------------------------------------
/src/request.rs:
--------------------------------------------------------------------------------
1 | // This file is part of Germ .
2 | // Copyright (C) 2022-2025 Fuwn
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, version 3.
7 | //
8 | // This program is distributed in the hope that it will be useful, but
9 | // WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 | // General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 | //
16 | // Copyright (C) 2022-2025 Fuwn
17 | // SPDX-License-Identifier: GPL-3.0-only
18 |
19 | //! Make Gemini requests and get sane, structured results
20 |
21 | mod response;
22 | mod status;
23 | mod verifier;
24 |
25 | #[cfg(feature = "blocking")] pub mod blocking;
26 |
27 | #[cfg(feature = "request")] pub mod non_blocking;
28 |
29 | #[cfg(feature = "request")] pub use non_blocking::request;
30 | pub(crate) use verifier::GermVerifier;
31 | pub use {response::Response, status::Status};
32 |
--------------------------------------------------------------------------------
/src/ast/macros.rs:
--------------------------------------------------------------------------------
1 | // This file is part of Germ .
2 | // Copyright (C) 2022-2025 Fuwn
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, version 3.
7 | //
8 | // This program is distributed in the hope that it will be useful, but
9 | // WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 | // General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 | //
16 | // Copyright (C) 2022-2025 Fuwn
17 | // SPDX-License-Identifier: GPL-3.0-only
18 |
19 | /// Convert Gemtext an `Ast`
20 | ///
21 | /// # Examples
22 | ///
23 | /// ```rust
24 | /// // Using a value
25 | /// assert_eq!(
26 | /// germ::gemini_to_ast!("=> / A link!").to_gemtext(),
27 | /// // `to_gemtext` appends a newline to all responses, so let's make sure we
28 | /// // account for that.
29 | /// "=> / A link!",
30 | /// );
31 | #[macro_export]
32 | macro_rules! gemini_to_ast {
33 | ($gemini:expr) => {
34 | $crate::ast::Ast::from_string($gemini)
35 | };
36 | }
37 |
--------------------------------------------------------------------------------
/Cargo.toml:
--------------------------------------------------------------------------------
1 | # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
2 |
3 | [package]
4 | name = "germ"
5 | version = "0.4.8"
6 | authors = ["Fuwn "]
7 | edition = "2021"
8 | description = "The Ultimate Gemini Toolkit."
9 | documentation = "https://docs.rs/germ"
10 | readme = "README.md"
11 | homepage = "https://github.com/gemrest/germ"
12 | repository = "https://github.com/gemrest/germ"
13 | license = "GPL-3.0-only"
14 | keywords = ["gemini", "parser", "lexer", "markdown", "converter"]
15 | categories = ["encoding"]
16 | rust-version = "1.83.0"
17 |
18 | [features]
19 | ast = []
20 | blocking = ["rustls", "url", "anyhow"]
21 | convert = ["ast"]
22 | default = ["ast", "convert", "meta", "request"]
23 | macros = ["ast", "convert"]
24 | meta = []
25 | request = ["rustls", "url", "anyhow", "tokio", "tokio-rustls"]
26 | quick = []
27 | example-gemtext = []
28 |
29 | [dependencies]
30 | anyhow = { version = "1.0.98", optional = true } # `Result`
31 | rustls = { version = "0.21.12", features = [
32 | "dangerous_configuration",
33 | ], optional = true } # TLS
34 | tokio-rustls = { version = "0.24.1", optional = true } # Non-blocking TLS
35 | tokio = { version = "1.45.1", optional = true, default-features = false, features = [
36 | "net",
37 | "io-util",
38 | "rt-multi-thread",
39 | "macros",
40 | ] } # Non-blocking I/O
41 | url = { version = "2.5.4", optional = true } # URL Validation
42 |
--------------------------------------------------------------------------------
/tests/status.rs:
--------------------------------------------------------------------------------
1 | // This file is part of Germ .
2 | // Copyright (C) 2022-2025 Fuwn
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, version 3.
7 | //
8 | // This program is distributed in the hope that it will be useful, but
9 | // WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 | // General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 | //
16 | // Copyright (C) 2022-2025 Fuwn
17 | // SPDX-License-Identifier: GPL-3.0-only
18 |
19 | #[cfg(test)]
20 | mod test {
21 | use germ::request::Status;
22 |
23 | #[test]
24 | fn status_from_i32() {
25 | assert_eq!(Status::from(10), Status::Input);
26 | }
27 |
28 | #[test]
29 | fn i32_from_status() {
30 | assert_eq!(i32::from(Status::Input), 10);
31 | }
32 |
33 | #[cfg(feature = "blocking")]
34 | #[test]
35 | fn invalid_url_handling() {
36 | use url::Url;
37 |
38 | let invalid_url = Url::parse("gemini://").unwrap();
39 | let result = germ::request::blocking::request(&invalid_url);
40 |
41 | assert!(result.is_err());
42 | assert!(result.unwrap_err().to_string().contains("missing domain"));
43 | }
44 | }
45 |
--------------------------------------------------------------------------------
/src/request/verifier.rs:
--------------------------------------------------------------------------------
1 | // This file is part of Germ .
2 | // Copyright (C) 2022-2025 Fuwn
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, version 3.
7 | //
8 | // This program is distributed in the hope that it will be useful, but
9 | // WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 | // General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 | //
16 | // Copyright (C) 2022-2025 Fuwn
17 | // SPDX-License-Identifier: GPL-3.0-only
18 |
19 | use {
20 | rustls::{
21 | Certificate,
22 | client::{self, ServerCertVerified},
23 | },
24 | std::time::SystemTime,
25 | };
26 |
27 | #[allow(clippy::module_name_repetitions)]
28 | pub struct GermVerifier;
29 |
30 | impl GermVerifier {
31 | pub const fn new() -> Self { Self {} }
32 | }
33 |
34 | impl client::ServerCertVerifier for GermVerifier {
35 | fn verify_server_cert(
36 | &self,
37 | _end_entity: &Certificate,
38 | _intermediates: &[Certificate],
39 | _server_name: &client::ServerName,
40 | _scts: &mut dyn Iterator- ,
41 | _ocsp_response: &[u8],
42 | _now: SystemTime,
43 | ) -> Result {
44 | Ok(ServerCertVerified::assertion())
45 | }
46 | }
47 |
--------------------------------------------------------------------------------
/src/convert/macros.rs:
--------------------------------------------------------------------------------
1 | // This file is part of Germ .
2 | // Copyright (C) 2022-2025 Fuwn
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, version 3.
7 | //
8 | // This program is distributed in the hope that it will be useful, but
9 | // WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 | // General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 | //
16 | // Copyright (C) 2022-2025 Fuwn
17 | // SPDX-License-Identifier: GPL-3.0-only
18 |
19 | /// Convert Gemtext into HTML
20 | ///
21 | /// # Examples
22 | ///
23 | /// ```rust
24 | /// // Using a value
25 | /// assert_eq!(
26 | /// germ::gemini_to_html!("=> /to hello !"),
27 | /// "hello !
",
28 | /// );
29 | #[macro_export]
30 | macro_rules! gemini_to_html {
31 | ($gemini:expr) => {
32 | $crate::convert::from_ast(
33 | &$crate::gemini_to_ast!($gemini),
34 | &$crate::convert::Target::HTML,
35 | )
36 | };
37 | ($($gemini:tt)*) => {
38 | $crate::convert::from_ast(
39 | &$crate::gemini_to_ast!{ $($gemini)* },
40 | &$crate::convert::Target::HTML,
41 | )
42 | };
43 | }
44 |
45 | /// Convert Gemtext into Markdown
46 | ///
47 | /// # Examples
48 | ///
49 | /// ```rust
50 | /// assert_eq!(
51 | /// // Using a value
52 | /// germ::gemini_to_md!("=> /to hello !"),
53 | /// "[hello !](/to)\n",
54 | /// );
55 | #[macro_export]
56 | macro_rules! gemini_to_md {
57 | ($gemini:expr) => {
58 | $crate::convert::from_ast(
59 | &$crate::gemini_to_ast!($gemini),
60 | &$crate::convert::Target::Markdown,
61 | )
62 | };
63 | ($($gemini:tt)*) => {
64 | $crate::convert::from_ast(
65 | &$crate::gemini_to_ast!{ $($gemini)* },
66 | &$crate::convert::Target::Markdown,
67 | )
68 | };
69 | }
70 |
--------------------------------------------------------------------------------
/tests/convert.rs:
--------------------------------------------------------------------------------
1 | // This file is part of Germ .
2 | // Copyright (C) 2022-2025 Fuwn
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, version 3.
7 | //
8 | // This program is distributed in the hope that it will be useful, but
9 | // WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 | // General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 | //
16 | // Copyright (C) 2022-2025 Fuwn
17 | // SPDX-License-Identifier: GPL-3.0-only
18 |
19 | #[cfg(test)]
20 | mod test {
21 | use germ::{
22 | convert::{Target, from_string},
23 | gemini_to_html, gemini_to_md,
24 | };
25 |
26 | #[test]
27 | fn convert_from_string_to_html_single_line() {
28 | assert_eq!(from_string("hi", &Target::HTML), "hi
",);
29 | }
30 |
31 | #[test]
32 | fn convert_from_string_to_html_multi_line() {
33 | assert_eq!(from_string("hi\n# hi", &Target::HTML), "hi
hi
",);
34 | }
35 |
36 | #[test]
37 | fn convert_from_string_to_html_single_link_macro_expression() {
38 | assert_eq!(
39 | gemini_to_html!("=> /to hello !"),
40 | "hello !
",
41 | );
42 | }
43 |
44 | #[test]
45 | fn convert_from_string_to_markdown_single_line() {
46 | assert_eq!(from_string("hi", &Target::Markdown), "hi\n",);
47 | }
48 |
49 | #[test]
50 | fn convert_from_string_to_markdown_multi_line() {
51 | assert_eq!(from_string("hi\n# hi", &Target::Markdown), "hi\n# hi\n",);
52 | }
53 |
54 | #[test]
55 | fn convert_from_string_to_markdown_single_link() {
56 | assert_eq!(
57 | from_string("=> /to hello !", &Target::Markdown),
58 | "[hello !](/to)\n",
59 | );
60 | }
61 |
62 | #[test]
63 | fn convert_from_string_to_markdown_single_macro_expression() {
64 | assert_eq!(gemini_to_md!("=> /to hello !"), "[hello !](/to)\n",);
65 | }
66 | }
67 |
--------------------------------------------------------------------------------
/src/quick.rs:
--------------------------------------------------------------------------------
1 | // This file is part of Germ .
2 | // Copyright (C) 2022-2025 Fuwn
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, version 3.
7 | //
8 | // This program is distributed in the hope that it will be useful, but
9 | // WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 | // General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 | //
16 | // Copyright (C) 2022-2025 Fuwn
17 | // SPDX-License-Identifier: GPL-3.0-only
18 |
19 | pub enum HeadingLevel {
20 | One,
21 | Two,
22 | Three,
23 | }
24 |
25 | #[must_use]
26 | pub fn heading(
27 | text: &(impl ToString + ?Sized),
28 | level: &HeadingLevel,
29 | ) -> String {
30 | format!(
31 | "{} {}",
32 | match level {
33 | HeadingLevel::One => "#",
34 | HeadingLevel::Two => "##",
35 | HeadingLevel::Three => "###",
36 | },
37 | text.to_string()
38 | )
39 | }
40 |
41 | #[must_use]
42 | pub fn list_item(text: &(impl ToString + ?Sized)) -> String {
43 | format!("* {}", text.to_string())
44 | }
45 |
46 | #[must_use]
47 | pub fn list_items(items: &[&(impl ToString + ?Sized)]) -> String {
48 | items
49 | .iter()
50 | .map(|item| list_item(&item.to_string()))
51 | .collect::>()
52 | .join("\n")
53 | }
54 |
55 | #[must_use]
56 | pub fn link(text: &(impl ToString + ?Sized), location: Option<&str>) -> String {
57 | format!(
58 | "=> {}{}",
59 | text.to_string(),
60 | location.map_or_else(String::new, |l| format!(" {l}"))
61 | )
62 | }
63 |
64 | #[must_use]
65 | pub fn block_quote(text: &(impl ToString + ?Sized)) -> String {
66 | format!("> {}", text.to_string())
67 | }
68 |
69 | #[must_use]
70 | pub fn preformatted_text(
71 | text: &(impl ToString + ?Sized),
72 | alt_text: Option<&str>,
73 | ) -> String {
74 | format!("```{}\n{}\n```", alt_text.unwrap_or(""), text.to_string())
75 | }
76 |
--------------------------------------------------------------------------------
/tests/quick.rs:
--------------------------------------------------------------------------------
1 | // This file is part of Germ .
2 | // Copyright (C) 2022-2025 Fuwn
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, version 3.
7 | //
8 | // This program is distributed in the hope that it will be useful, but
9 | // WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 | // General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 | //
16 | // Copyright (C) 2022-2025 Fuwn
17 | // SPDX-License-Identifier: GPL-3.0-only
18 |
19 | #[cfg(test)]
20 | mod test {
21 | use germ::quick::{self, heading};
22 |
23 | #[test]
24 | fn all_heading_levels() {
25 | assert_eq!(heading("Soup", &germ::quick::HeadingLevel::One), "# Soup");
26 | assert_eq!(
27 | heading("Vegetables", &germ::quick::HeadingLevel::Two),
28 | "## Vegetables"
29 | );
30 | assert_eq!(
31 | heading("Fruits", &germ::quick::HeadingLevel::Three),
32 | "### Fruits"
33 | );
34 | }
35 |
36 | #[test]
37 | fn list_item() {
38 | assert_eq!(quick::list_item("Soup"), "* Soup");
39 | }
40 |
41 | #[test]
42 | fn list_items() {
43 | assert_eq!(
44 | quick::list_items(&["Soup", "Vegetables", "Fruits"]),
45 | "* Soup\n* Vegetables\n* Fruits"
46 | );
47 | }
48 |
49 | #[test]
50 | fn link_variants() {
51 | assert_eq!(quick::link("Soup", None), "=> Soup");
52 | assert_eq!(
53 | quick::link("Soup", Some("gemini://soup.com")),
54 | "=> Soup gemini://soup.com"
55 | );
56 | }
57 |
58 | #[test]
59 | fn block_quote() {
60 | assert_eq!(quick::block_quote("Soup"), "> Soup");
61 | }
62 |
63 | #[test]
64 | fn preformatted_text_variants() {
65 | assert_eq!(quick::preformatted_text("Soup", None), "```\nSoup\n```");
66 | assert_eq!(
67 | quick::preformatted_text("Vegetables", Some("Fruits")),
68 | "```Fruits\nVegetables\n```"
69 | );
70 | }
71 | }
72 |
--------------------------------------------------------------------------------
/src/convert.rs:
--------------------------------------------------------------------------------
1 | // This file is part of Germ .
2 | // Copyright (C) 2022-2025 Fuwn
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, version 3.
7 | //
8 | // This program is distributed in the hope that it will be useful, but
9 | // WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 | // General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 | //
16 | // Copyright (C) 2022-2025 Fuwn
17 | // SPDX-License-Identifier: GPL-3.0-only
18 |
19 | //! Convert Gemtext into many types of markup.
20 |
21 | use crate::ast::Ast;
22 |
23 | mod html;
24 | mod markdown;
25 |
26 | #[cfg(feature = "macros")] mod macros;
27 |
28 | /// Different targets to convert Gemtext to
29 | #[derive(Debug, Copy, Clone, PartialEq, Eq)]
30 | pub enum Target {
31 | /// Convert Gemtext to HTML
32 | HTML,
33 | /// Convert Gemtext to Markdown
34 | Markdown,
35 | }
36 |
37 | /// Convert AST'd Gemtext into an alternative markup format.
38 | ///
39 | /// # Example
40 | ///
41 | /// ```rust
42 | /// use germ::convert;
43 | ///
44 | /// let _ = convert::from_ast(
45 | /// &germ::ast::Ast::from_string(r#"=> gemini://gem.rest/ GemRest"#),
46 | /// &convert::Target::HTML,
47 | /// );
48 | /// ```
49 | #[must_use]
50 | pub fn from_ast(source: &Ast, target: &Target) -> String {
51 | match target {
52 | Target::Markdown => markdown::convert(source.inner()),
53 | Target::HTML => html::convert(source.inner()),
54 | }
55 | }
56 |
57 | /// Convert raw Gemtext into an alternative markup format.
58 | ///
59 | /// # Example
60 | ///
61 | /// ```rust
62 | /// use germ::convert;
63 | ///
64 | /// let _ = convert::from_string(
65 | /// r#"=> gemini://gem.rest/ GemRest"#,
66 | /// &convert::Target::HTML,
67 | /// );
68 | /// ```
69 | #[must_use]
70 | pub fn from_string(
71 | source: &(impl ToString + ?Sized),
72 | target: &Target,
73 | ) -> String {
74 | from_ast(&Ast::from_owned(&source.to_string()), target)
75 | }
76 |
--------------------------------------------------------------------------------
/src/lib.rs:
--------------------------------------------------------------------------------
1 | // This file is part of Germ .
2 | // Copyright (C) 2022-2025 Fuwn
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, version 3.
7 | //
8 | // This program is distributed in the hope that it will be useful, but
9 | // WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 | // General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 | //
16 | // Copyright (C) 2022-2025 Fuwn
17 | // SPDX-License-Identifier: GPL-3.0-only
18 |
19 | #![deny(
20 | warnings,
21 | nonstandard_style,
22 | unused,
23 | future_incompatible,
24 | rust_2018_idioms,
25 | unsafe_code,
26 | clippy::all,
27 | clippy::nursery,
28 | clippy::pedantic
29 | )]
30 | #![recursion_limit = "128"]
31 |
32 | #[cfg(feature = "ast")] pub mod ast;
33 |
34 | #[cfg(feature = "convert")] pub mod convert;
35 |
36 | #[cfg(feature = "request")] pub mod request;
37 |
38 | #[cfg(feature = "meta")] pub mod meta;
39 |
40 | #[cfg(feature = "quick")] pub mod quick;
41 |
42 | #[cfg(feature = "example-gemtext")]
43 | pub const EXAMPLE_GEMTEXT: &str = r"```This is alt-text
44 | Here goes the pre-formatted text.
45 |
46 | This continues the pre-formatted text on a new line after a blank line.
47 | ```
48 |
49 | # This is a heading
50 |
51 | This is some text.
52 |
53 | This is more text after a blank line.
54 |
55 | * This is a single list item.
56 | * This is the next list item.
57 |
58 | * This is a new list.
59 | * This is the next item on the new list.
60 |
61 | ## This is a sub-heading
62 |
63 | > This is a blockquote.
64 |
65 | ### This is a sub-sub-heading.
66 |
67 | => gemini://gem.rest/ This is a link to GemRest
68 | => /somewhere
69 |
70 | ```This is a preformatted block containing inner Gemtext.
71 | => gemini://fuwn.me/ This is a link.
72 |
73 | * This is a list item.
74 |
75 | > This is a blockquote.
76 |
77 | # This is a heading.
78 |
79 | ## This is a sub-heading.
80 |
81 | ### This is a sub-sub-heading.
82 | ```
83 |
84 | That was a link without text.";
85 |
--------------------------------------------------------------------------------
/src/convert/markdown.rs:
--------------------------------------------------------------------------------
1 | // This file is part of Germ .
2 | // Copyright (C) 2022-2025 Fuwn
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, version 3.
7 | //
8 | // This program is distributed in the hope that it will be useful, but
9 | // WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 | // General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 | //
16 | // Copyright (C) 2022-2025 Fuwn
17 | // SPDX-License-Identifier: GPL-3.0-only
18 |
19 | use {crate::ast::Node, std::fmt::Write};
20 |
21 | pub fn convert(source: &[Node]) -> String {
22 | let mut markdown = String::new();
23 |
24 | // Since we have an AST tree of the Gemtext, it is very easy to convert from
25 | // this AST tree to an alternative markup format.
26 | for node in source {
27 | match node {
28 | Node::Text(text) => {
29 | let _ = writeln!(&mut markdown, "{text}");
30 | }
31 | Node::Link { to, text } => markdown.push_str(&text.clone().map_or_else(
32 | || format!("<{to}>\n"),
33 | |text| format!("[{text}]({to})\n"),
34 | )),
35 | Node::Heading { level, text } => {
36 | let _ = writeln!(
37 | &mut markdown,
38 | "{} {}",
39 | match level {
40 | 1 => "#",
41 | 2 => "##",
42 | 3 => "###",
43 | _ => "",
44 | },
45 | text
46 | );
47 | }
48 | Node::List(items) =>
49 | for item in items {
50 | let _ = writeln!(&mut markdown, "- {item}");
51 | },
52 | Node::Blockquote(text) => {
53 | let _ = writeln!(&mut markdown, "> {text}");
54 | }
55 | Node::PreformattedText { alt_text, text } => {
56 | let _ = writeln!(
57 | &mut markdown,
58 | "```{}\n{}```",
59 | alt_text.clone().unwrap_or_default(),
60 | text
61 | );
62 | }
63 | Node::Whitespace => markdown.push('\n'),
64 | }
65 | }
66 |
67 | markdown
68 | }
69 |
--------------------------------------------------------------------------------
/src/convert/html.rs:
--------------------------------------------------------------------------------
1 | // This file is part of Germ .
2 | // Copyright (C) 2022-2025 Fuwn
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, version 3.
7 | //
8 | // This program is distributed in the hope that it will be useful, but
9 | // WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 | // General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 | //
16 | // Copyright (C) 2022-2025 Fuwn
17 | // SPDX-License-Identifier: GPL-3.0-only
18 |
19 | use {crate::ast::Node, std::fmt::Write};
20 |
21 | pub fn convert(source: &[Node]) -> String {
22 | let mut html = String::new();
23 |
24 | // Since we have an AST tree of the Gemtext, it is very easy to convert from
25 | // this AST tree to an alternative markup format.
26 | for node in source {
27 | match node {
28 | Node::Text(text) => {
29 | let _ = write!(&mut html, "{text}
");
30 | }
31 | Node::Link { to, text } => {
32 | let _ = write!(
33 | &mut html,
34 | "{}
",
35 | to,
36 | text.clone().unwrap_or_else(|| to.clone())
37 | );
38 | }
39 | Node::Heading { level, text } => {
40 | let _ = write!(
41 | &mut html,
42 | "<{}>{}",
43 | match level {
44 | 1 => "h1",
45 | 2 => "h2",
46 | 3 => "h3",
47 | _ => "p",
48 | },
49 | text
50 | );
51 | }
52 | Node::List(items) => {
53 | let _ = write!(&mut html, "");
54 |
55 | for item in items {
56 | let _ = write!(&mut html, "- {item}
");
57 | }
58 |
59 | let _ = write!(&mut html, "
");
60 | }
61 | Node::Blockquote(text) => {
62 | let _ = write!(&mut html, "{text}
");
63 | }
64 | Node::PreformattedText { text, .. } => {
65 | let _ = write!(&mut html, "{text}");
66 | }
67 | Node::Whitespace => {}
68 | }
69 | }
70 |
71 | html
72 | }
73 |
--------------------------------------------------------------------------------
/src/request/blocking.rs:
--------------------------------------------------------------------------------
1 | // This file is part of Germ .
2 | // Copyright (C) 2022-2025 Fuwn
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, version 3.
7 | //
8 | // This program is distributed in the hope that it will be useful, but
9 | // WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 | // General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 | //
16 | // Copyright (C) 2022-2025 Fuwn
17 | // SPDX-License-Identifier: GPL-3.0-only
18 |
19 | use {
20 | crate::request::{GermVerifier, Response},
21 | std::io::{Read, Write},
22 | };
23 |
24 | /// Make a request to a Gemini server. The `url` **should** be prefixed with a
25 | /// scheme (e.g. "gemini://").
26 | ///
27 | /// # Example
28 | ///
29 | /// ```rust
30 | /// match germ::request::blocking::request(
31 | /// &url::Url::parse("gemini://fuwn.me").unwrap(),
32 | /// ) {
33 | /// Ok(response) => println!("{:?}", response),
34 | /// Err(_) => {}
35 | /// }
36 | /// ```
37 | ///
38 | /// # Errors
39 | /// - May error if the URL is invalid
40 | /// - May error if the TLS write fails
41 | /// - May error if the TLS read fails
42 | pub fn request(url: &url::Url) -> anyhow::Result {
43 | let config = rustls::ClientConfig::builder()
44 | .with_safe_defaults()
45 | .with_custom_certificate_verifier(std::sync::Arc::new(GermVerifier::new()))
46 | .with_no_client_auth();
47 | let domain = url
48 | .domain()
49 | .ok_or_else(|| anyhow::anyhow!("Invalid URL: missing domain"))?;
50 | let mut connection = rustls::ClientConnection::new(
51 | std::sync::Arc::new(config),
52 | domain.try_into()?,
53 | )?;
54 | let mut stream = std::net::TcpStream::connect(format!(
55 | "{}:{}",
56 | domain,
57 | url.port().unwrap_or(1965)
58 | ))?;
59 | let mut tls = rustls::Stream::new(&mut connection, &mut stream);
60 |
61 | tls.write_all(format!("{url}\r\n").as_bytes())?;
62 |
63 | let mut plain_text = Vec::new();
64 |
65 | tls.read_to_end(&mut plain_text)?;
66 |
67 | Ok(Response::new(&plain_text, tls.conn.negotiated_cipher_suite()))
68 | }
69 |
--------------------------------------------------------------------------------
/src/request/non_blocking.rs:
--------------------------------------------------------------------------------
1 | // This file is part of Germ .
2 | // Copyright (C) 2022-2025 Fuwn
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, version 3.
7 | //
8 | // This program is distributed in the hope that it will be useful, but
9 | // WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 | // General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 | //
16 | // Copyright (C) 2022-2025 Fuwn
17 | // SPDX-License-Identifier: GPL-3.0-only
18 |
19 | use {
20 | crate::request::Response,
21 | tokio::io::{AsyncReadExt, AsyncWriteExt},
22 | };
23 |
24 | /// Make a request to a Gemini server
25 | ///
26 | /// The `url` **should** be prefixed with a scheme (e.g. "gemini://").
27 | ///
28 | /// # Example
29 | ///
30 | /// ```rust
31 | /// #[tokio::main]
32 | /// async fn main() {
33 | /// match germ::request::request(&url::Url::parse("gemini://fuwn.me").unwrap())
34 | /// .await
35 | /// {
36 | /// Ok(response) => println!("{:?}", response),
37 | /// Err(_) => {}
38 | /// }
39 | /// }
40 | /// ```
41 | ///
42 | /// # Errors
43 | ///
44 | /// - May error if the URL is invalid
45 | /// - May error if the server is unreachable
46 | /// - May error if the TLS write fails
47 | /// - May error if the TLS read fails
48 | pub async fn request(url: &url::Url) -> anyhow::Result {
49 | let mut tls = tokio_rustls::TlsConnector::from(std::sync::Arc::new(
50 | rustls::ClientConfig::builder()
51 | .with_safe_defaults()
52 | .with_custom_certificate_verifier(std::sync::Arc::new(
53 | crate::request::GermVerifier::new(),
54 | ))
55 | .with_no_client_auth(),
56 | ))
57 | .connect(
58 | rustls::ServerName::try_from(
59 | url
60 | .domain()
61 | .ok_or_else(|| anyhow::anyhow!("Invalid URL: missing domain"))?,
62 | )?,
63 | tokio::net::TcpStream::connect(format!(
64 | "{}:{}",
65 | url
66 | .domain()
67 | .ok_or_else(|| anyhow::anyhow!("Invalid URL: missing domain"))?,
68 | url.port().unwrap_or(1965)
69 | ))
70 | .await?,
71 | )
72 | .await?;
73 | let cipher_suite = tls.get_mut().1.negotiated_cipher_suite();
74 |
75 | tls.write_all(format!("{url}\r\n").as_bytes()).await?;
76 |
77 | Ok(Response::new(
78 | &{
79 | let mut plain_text = Vec::new();
80 |
81 | tls.read_to_end(&mut plain_text).await?;
82 |
83 | plain_text
84 | },
85 | cipher_suite,
86 | ))
87 | }
88 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Germ
2 |
3 | [](https://crates.io/crates/germ)
4 | [](https://docs.rs/germ)
5 | [](https://github.com/gemrest/germ/actions/workflows/check.yaml)
6 |
7 | The Ultimate Gemini Toolkit
8 |
9 | Germ is a toolkit for the Gemini protocol which aims to have a little something
10 | for everyone. At the moment, Germ has **ZERO** dependencies (unless you use the
11 | `request` feature), and Germ will continue to try its hardest to have as few
12 | dependencies as possible.
13 |
14 | ## Features
15 |
16 | - AST builder to easily construct and manipulate AST trees from raw Gemtext
17 | - Converters to easily convert from Gemtext to markup formats such as HTML or
18 | Markdown
19 | - Blocking and non-blocking request suite
20 | - Structured meta section manipulation
21 | - And more!
22 |
23 | Check out the rest of the features in the Features section under Usage
24 |
25 | ## Usage
26 |
27 | Current version:
28 | [](https://crates.io/crates/germ)
29 |
30 | ```toml
31 | # Cargo.toml
32 |
33 | [dependencies]
34 | # To enable only the base (default) features: ast, convert, meta, request
35 | # germ = "*" # Use current version show above!
36 |
37 | # To enable only certain features
38 | [dependencies.germ]
39 | version = "*" # Use current version show above!
40 | default-features = false
41 | features = ["ast"] # Enable the features you would like to use!
42 | ```
43 |
44 | ### Features
45 |
46 | | Feature | Description |
47 | | ---------- | --------------------------------------------------------------------- |
48 | | `default` | `ast`, `convert`, `meta`, `request` |
49 | | `ast` | Construct AST trees from raw Gemtext |
50 | | `blocking` | Blocking equivalent of `request` |
51 | | `convert` | Convert Gemtext to markup formats such as HTML or Markdown |
52 | | `request` | Make Gemini requests, get sane, structured results |
53 | | `meta` | Structure-ise a Gemini response's meta section |
54 | | `macros` | Macros to aid with various Germ-related functionalities |
55 | | `quick` | Tiny functions to create valid Gemtext elements from structured input |
56 |
57 | ### Examples
58 |
59 | Thoroughly commented examples can be found within the
60 | [`examples/`](https://github.com/gemrest/germ/tree/main/examples) directory.
61 |
62 | Examples can be run by name using the example just task.
63 | (e.g., `just example ast_to_gemtext`)
64 |
65 | ## License
66 |
67 | This project is licensed with the
68 | [GNU General Public License v3.0](https://github.com/gemrest/germ/blob/main/LICENSE).
69 |
--------------------------------------------------------------------------------
/src/request/response.rs:
--------------------------------------------------------------------------------
1 | // This file is part of Germ .
2 | // Copyright (C) 2022-2025 Fuwn
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, version 3.
7 | //
8 | // This program is distributed in the hope that it will be useful, but
9 | // WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 | // General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 | //
16 | // Copyright (C) 2022-2025 Fuwn
17 | // SPDX-License-Identifier: GPL-3.0-only
18 |
19 | use {crate::request::Status, rustls::SupportedCipherSuite, std::borrow::Cow};
20 |
21 | #[derive(Debug, Clone, PartialEq)]
22 | pub struct Response {
23 | status: Status,
24 | meta: String,
25 | content: Option>,
26 | size: usize,
27 | suite: Option,
28 | }
29 |
30 | impl Response {
31 | pub(crate) fn new(data: &[u8], suite: Option) -> Self {
32 | let delimiter = b"\r\n";
33 | let header_end = data
34 | .windows(delimiter.len())
35 | .position(|window| window == delimiter)
36 | .map_or(data.len(), |pos| pos + delimiter.len());
37 | let header_bytes = &data[..header_end];
38 | let header_cow = String::from_utf8_lossy(header_bytes);
39 | let header_trimmed = header_cow.trim_end();
40 | let content_bytes = if header_end < data.len() {
41 | Some(data[header_end..].to_vec())
42 | } else {
43 | None
44 | };
45 | let (status_string, meta_string) = if header_trimmed.len() >= 2 {
46 | header_trimmed.split_at(2)
47 | } else {
48 | (header_trimmed, "")
49 | };
50 | let status_code = status_string.parse::().unwrap_or(0);
51 |
52 | Self {
53 | status: Status::from(status_code),
54 | meta: meta_string.trim_start().to_string(),
55 | content: content_bytes,
56 | size: data.len(),
57 | suite,
58 | }
59 | }
60 |
61 | #[must_use]
62 | pub const fn status(&self) -> &Status { &self.status }
63 |
64 | #[allow(clippy::missing_const_for_fn)]
65 | #[must_use]
66 | pub fn meta(&self) -> Cow<'_, str> { Cow::Borrowed(&self.meta) }
67 |
68 | /// This associated function assumes that the content is valid UTF-8.
69 | ///
70 | /// If you want to handle data bytes directly, use
71 | /// [`Response::content_bytes`].
72 | #[must_use]
73 | pub fn content(&self) -> Option {
74 | self
75 | .content
76 | .as_ref()
77 | .map(|content| String::from_utf8_lossy(content).to_string())
78 | }
79 |
80 | #[must_use]
81 | pub fn content_bytes(&self) -> Option<&[u8]> { self.content.as_deref() }
82 |
83 | #[must_use]
84 | pub const fn size(&self) -> &usize { &self.size }
85 |
86 | #[must_use]
87 | pub const fn suite(&self) -> &Option { &self.suite }
88 | }
89 |
--------------------------------------------------------------------------------
/tests/meta.rs:
--------------------------------------------------------------------------------
1 | // This file is part of Germ .
2 | // Copyright (C) 2022-2025 Fuwn
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, version 3.
7 | //
8 | // This program is distributed in the hope that it will be useful, but
9 | // WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 | // General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 | //
16 | // Copyright (C) 2022-2025 Fuwn
17 | // SPDX-License-Identifier: GPL-3.0-only
18 |
19 | #[cfg(test)]
20 | mod test {
21 | use germ::meta::Meta;
22 |
23 | #[test]
24 | fn construct_meta_with_mime() {
25 | let mut meta = Meta::new();
26 |
27 | *meta.mime_mut() = "text/gemini".to_string();
28 |
29 | assert_eq!(meta.to_string(), "text/gemini");
30 | }
31 |
32 | #[test]
33 | fn construct_meta_with_mime_and_parameters() {
34 | let mut meta = Meta::new();
35 | let mut parameters = std::collections::HashMap::new();
36 |
37 | parameters.insert("hi".to_string(), "2".to_string());
38 | parameters.insert("hi2".to_string(), "string=2".to_string());
39 |
40 | *meta.mime_mut() = "text/gemini".to_string();
41 | *meta.parameters_mut() = parameters;
42 |
43 | assert_eq!(meta.to_string(), "text/gemini; hi=2; hi2=string=2");
44 | }
45 |
46 | #[test]
47 | fn meta_to_string_without_parameters() {
48 | let original_string = "text/gemini";
49 |
50 | assert_eq!(Meta::from_string(original_string).to_string(), original_string);
51 | }
52 |
53 | #[test]
54 | fn meta_to_string_with_parameters() {
55 | let original_string = "text/gemini; hi=2; hi2=string=2";
56 |
57 | assert_eq!(Meta::from_string(original_string).to_string(), original_string);
58 | }
59 |
60 | #[test]
61 | fn meta_to_mime_without_parameters() {
62 | let meta = Meta::from_string("text/gemini");
63 |
64 | assert_eq!(meta.mime(), "text/gemini");
65 | assert_eq!(meta.parameters().len(), 0);
66 | }
67 |
68 | #[test]
69 | fn meta_to_map_mime() {
70 | assert_eq!(
71 | Meta::from_string("text/gemini; hi=2; hi2=string=2").mime(),
72 | "text/gemini",
73 | );
74 | }
75 |
76 | #[test]
77 | fn meta_to_map_with_parameters() {
78 | assert_eq!(
79 | Meta::from_string("text/gemini; hi=2; hi2=string=2")
80 | .parameters()
81 | .get("hi2"),
82 | Some(&"string=2".to_string()),
83 | );
84 | }
85 |
86 | #[test]
87 | fn meta_to_map_length() {
88 | assert_eq!(
89 | Meta::from_string("text/gemini; hi=2; hi2=string=2").parameters().len(),
90 | 2,
91 | );
92 | }
93 |
94 | #[test]
95 | fn meta_handles_malformed_parameters() {
96 | let meta =
97 | Meta::from_string("text/gemini; valid=value; malformed; another=test");
98 |
99 | assert_eq!(meta.mime(), "text/gemini");
100 | assert_eq!(meta.parameters().len(), 2);
101 | assert_eq!(meta.parameters().get("valid"), Some(&"value".to_string()));
102 | assert_eq!(meta.parameters().get("another"), Some(&"test".to_string()));
103 | assert_eq!(meta.parameters().get("malformed"), None);
104 | }
105 | }
106 |
--------------------------------------------------------------------------------
/src/request/status.rs:
--------------------------------------------------------------------------------
1 | // This file is part of Germ .
2 | // Copyright (C) 2022-2025 Fuwn
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, version 3.
7 | //
8 | // This program is distributed in the hope that it will be useful, but
9 | // WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 | // General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 | //
16 | // Copyright (C) 2022-2025 Fuwn
17 | // SPDX-License-Identifier: GPL-3.0-only
18 |
19 | use std::{fmt, fmt::Formatter};
20 |
21 | /// Simple Gemini status reporting
22 | ///
23 | /// # Examples
24 | ///
25 | /// ```rust
26 | /// use germ::request::Status;
27 | ///
28 | /// assert_eq!(Status::from(10), Status::Input);
29 | /// assert_eq!(i32::from(Status::Input), 10);
30 | /// ```
31 | #[derive(Debug, Copy, Clone, PartialEq, Eq)]
32 | pub enum Status {
33 | Input,
34 | SensitiveInput,
35 | Success,
36 | TemporaryRedirect,
37 | PermanentRedirect,
38 | TemporaryFailure,
39 | ServerUnavailable,
40 | CGIError,
41 | ProxyError,
42 | SlowDown,
43 | PermanentFailure,
44 | NotFound,
45 | Gone,
46 | ProxyRefused,
47 | BadRequest,
48 | ClientCertificateRequired,
49 | CertificateNotAuthorised,
50 | CertificateNotValid,
51 | Unsupported,
52 | }
53 |
54 | impl Default for Status {
55 | fn default() -> Self { Self::Success }
56 | }
57 |
58 | impl From for i32 {
59 | fn from(n: Status) -> Self {
60 | match n {
61 | Status::Input => 10,
62 | Status::SensitiveInput => 11,
63 | Status::Success => 20,
64 | Status::TemporaryRedirect => 30,
65 | Status::PermanentRedirect => 31,
66 | Status::TemporaryFailure => 40,
67 | Status::ServerUnavailable => 41,
68 | Status::CGIError => 42,
69 | Status::ProxyError => 43,
70 | Status::SlowDown => 44,
71 | Status::PermanentFailure => 50,
72 | Status::NotFound => 51,
73 | Status::Gone => 52,
74 | Status::ProxyRefused => 53,
75 | Status::BadRequest => 59,
76 | Status::ClientCertificateRequired => 60,
77 | Status::CertificateNotAuthorised => 61,
78 | Status::CertificateNotValid => 62,
79 | Status::Unsupported => 0,
80 | }
81 | }
82 | }
83 |
84 | impl From for Status {
85 | fn from(n: i32) -> Self {
86 | match n {
87 | 10 => Self::Input,
88 | 11 => Self::SensitiveInput,
89 | 20 => Self::Success,
90 | 30 => Self::TemporaryRedirect,
91 | 31 => Self::PermanentRedirect,
92 | 40 => Self::TemporaryFailure,
93 | 41 => Self::ServerUnavailable,
94 | 42 => Self::CGIError,
95 | 43 => Self::ProxyError,
96 | 44 => Self::SlowDown,
97 | 50 => Self::PermanentFailure,
98 | 51 => Self::NotFound,
99 | 52 => Self::Gone,
100 | 53 => Self::ProxyRefused,
101 | 59 => Self::BadRequest,
102 | 60 => Self::ClientCertificateRequired,
103 | 61 => Self::CertificateNotAuthorised,
104 | 62 => Self::CertificateNotValid,
105 | _ => Self::Unsupported,
106 | }
107 | }
108 | }
109 |
110 | impl fmt::Display for Status {
111 | fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { write!(f, "{self:?}") }
112 | }
113 |
--------------------------------------------------------------------------------
/examples/request_blocking_to_gemtext_from_ast.rs:
--------------------------------------------------------------------------------
1 | //! This example demonstrates a chain of Germ's capabilities by fetching a
2 | //! Gemini capsule, parsing the response content into an abstract syntax tree,
3 | //! and converting the abstract syntax tree back to Gemtext, identical to the
4 | //! Gemini response content.
5 |
6 | use std::env;
7 |
8 | fn main() {
9 | // Try to obtain a URL from the command line arguments or use the default one
10 | let url_string =
11 | env::args().nth(1).unwrap_or_else(|| "gemini://fuwn.me/".to_string());
12 | // Form a valid URL to a Gemini capsule
13 | let url = match url::Url::parse(&url_string) {
14 | Ok(url) => url,
15 | Err(error) => {
16 | eprintln!("Error parsing URL '{}': {}", url_string, error);
17 | std::process::exit(1);
18 | }
19 | };
20 |
21 | // Perform a blocking request to the Gemini capsule
22 | let request = germ::request::blocking::request(&url);
23 |
24 | match request {
25 | // If the request was successful:
26 | Ok(response) => {
27 | // Obtain the content of the Gemini response
28 | let response_content =
29 | &*response.content().clone().unwrap_or_else(|| "".to_string());
30 | // Parse the Gemini response content into an abstract syntax tree
31 | let ast = germ::ast::Ast::from_string(response_content);
32 | // Convert the abstract syntax tree back to Gemtext, identical to the
33 | // Gemini response content, constructed from the parsed abstract syntax
34 | // tree
35 | let gemtext = ast.to_gemtext();
36 |
37 | // Print the Gemtext
38 | println!("{}", gemtext);
39 |
40 | // Check if the response content and reconstruction are identical
41 | if response_content == gemtext {
42 | println!(
43 | "\nValidation: Response content and reconstruction are identical"
44 | );
45 | } else {
46 | println!("\nValidation: Response content and reconstruction differ");
47 | print_diff(response_content, &gemtext);
48 | }
49 | }
50 | // If the request was unsuccessful, print an error message and exit
51 | Err(error) => {
52 | eprintln!("Error fetching '{}': {}", url_string, error);
53 | std::process::exit(1);
54 | }
55 | }
56 | }
57 |
58 | fn print_diff(original: &str, reconstructed: &str) {
59 | use std::io::{self, Write};
60 |
61 | let mut stdout = io::stdout();
62 | let original_lines = original.lines().collect::>();
63 | let reconstructed_lines = reconstructed.lines().collect::>();
64 | let max_lines = original_lines.len().max(reconstructed_lines.len());
65 | let mut has_printed_diff = false;
66 |
67 | for i in 0..max_lines {
68 | let original_line = original_lines.get(i).unwrap_or(&"");
69 | let reconstructed_line = reconstructed_lines.get(i).unwrap_or(&"");
70 |
71 | if original_line != reconstructed_line {
72 | if has_printed_diff {
73 | let _ = writeln!(stdout);
74 | }
75 |
76 | let _ = writeln!(stdout, "Line {}:", i + 1);
77 | let _ = writeln!(stdout, " Original: '{}'", original_line);
78 | let _ = writeln!(stdout, " Reconstructed: '{}'", reconstructed_line);
79 |
80 | has_printed_diff = true;
81 | }
82 | }
83 |
84 | if original_lines.len() != reconstructed_lines.len() {
85 | if has_printed_diff {
86 | let _ = writeln!(stdout);
87 | }
88 |
89 | let _ = writeln!(stdout, "Length difference:");
90 | let _ = writeln!(stdout, " Original: {} lines", original_lines.len());
91 | let _ =
92 | writeln!(stdout, " Reconstructed: {} lines", reconstructed_lines.len());
93 | }
94 | }
95 |
--------------------------------------------------------------------------------
/tests/ast.rs:
--------------------------------------------------------------------------------
1 | // This file is part of Germ .
2 | // Copyright (C) 2022-2025 Fuwn
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, version 3.
7 | //
8 | // This program is distributed in the hope that it will be useful, but
9 | // WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 | // General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 | //
16 | // Copyright (C) 2022-2025 Fuwn
17 | // SPDX-License-Identifier: GPL-3.0-only
18 |
19 | #[cfg(test)]
20 | mod test {
21 | use germ::{
22 | EXAMPLE_GEMTEXT,
23 | ast::{Ast, Node},
24 | };
25 |
26 | #[test]
27 | fn build_multi_line_list_with_text() {
28 | assert_eq!(*Ast::from_string("* item1\n* 2\nhi text").inner(), vec![
29 | Node::List(vec!["item1".to_string(), "2".to_string()]),
30 | Node::Text("hi text".to_string()),
31 | ],);
32 | }
33 |
34 | #[test]
35 | fn build_multi_line_vec() {
36 | assert_eq!(*Ast::from_string("=> /test hi\nhi there\n> hi").inner(), vec![
37 | Node::Link { to: "/test".to_string(), text: Some("hi".to_string()) },
38 | Node::Text("hi there".to_string()),
39 | Node::Blockquote("hi".to_string()),
40 | ],);
41 | }
42 |
43 | #[test]
44 | fn build_single_0th_from_vec() {
45 | assert_eq!(Ast::from_string("=> /test hi").inner(), &vec![Node::Link {
46 | to: "/test".to_string(),
47 | text: Some("hi".to_string()),
48 | }],);
49 | }
50 |
51 | #[test]
52 | fn build_single_element() {
53 | assert_eq!(
54 | Ast::from_string("=> /test hi").inner().first().unwrap(),
55 | &Node::Link { to: "/test".to_string(), text: Some("hi".to_string()) },
56 | );
57 | }
58 |
59 | #[test]
60 | fn gemtext_to_ast_then_ast_to_gemtext() {
61 | assert_eq!(
62 | Ast::from_string(EXAMPLE_GEMTEXT).to_gemtext(),
63 | // `to_gemtext` appends a newline to all responses, so let's make sure we
64 | // account for that.
65 | EXAMPLE_GEMTEXT
66 | );
67 | }
68 |
69 | #[test]
70 | fn gemtext_to_ast_then_ast_to_gemtext_macro_expression() {
71 | assert_eq!(
72 | germ::gemini_to_ast!(EXAMPLE_GEMTEXT).to_gemtext(),
73 | // `to_gemtext` appends a newline to all responses, so let's make sure we
74 | // account for that.
75 | EXAMPLE_GEMTEXT
76 | );
77 | }
78 |
79 | #[test]
80 | fn gemtext_to_ast_then_node_to_ast_to_gemtext() {
81 | assert_eq!(
82 | Ast::from_nodes(germ::gemini_to_ast!("=> / Home").inner().to_vec())
83 | .to_gemtext(),
84 | "=> / Home"
85 | );
86 | }
87 |
88 | #[test]
89 | fn build_malformed_link_without_url() {
90 | let ast = Ast::from_string("=>");
91 |
92 | assert_eq!(ast.inner().len(), 1);
93 |
94 | if let Node::Link { to, text } = ast.inner().first().unwrap() {
95 | assert_eq!(to, "");
96 | assert_eq!(text, &None);
97 | } else {
98 | panic!("Expected link node");
99 | }
100 | }
101 |
102 | #[test]
103 | fn build_heading_with_unicode_and_edge_cases() {
104 | // Unicode characters
105 | let ast = Ast::from_string("# Hello, 世界!");
106 |
107 | assert_eq!(ast.inner().len(), 1);
108 |
109 | if let Node::Heading { level, text } = ast.inner().first().unwrap() {
110 | assert_eq!(level, &1);
111 | assert_eq!(text, "Hello, 世界!");
112 | } else {
113 | panic!("Expected heading node");
114 | }
115 |
116 | // Only hashes
117 | let ast = Ast::from_string("###");
118 |
119 | assert_eq!(ast.inner().len(), 1);
120 |
121 | if let Node::Heading { level, text } = ast.inner().first().unwrap() {
122 | assert_eq!(level, &3);
123 | assert_eq!(text, "");
124 | } else {
125 | panic!("Expected heading node");
126 | }
127 |
128 | // Many hashes
129 | let ast = Ast::from_string("########## Very Deep Heading");
130 |
131 | assert_eq!(ast.inner().len(), 1);
132 |
133 | if let Node::Heading { level, text } = ast.inner().first().unwrap() {
134 | assert_eq!(level, &10);
135 | assert_eq!(text, "Very Deep Heading");
136 | } else {
137 | panic!("Expected heading node");
138 | }
139 | }
140 | }
141 |
--------------------------------------------------------------------------------
/src/meta.rs:
--------------------------------------------------------------------------------
1 | // This file is part of Germ .
2 | // Copyright (C) 2022-2025 Fuwn
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, version 3.
7 | //
8 | // This program is distributed in the hope that it will be useful, but
9 | // WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 | // General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 | //
16 | // Copyright (C) 2022-2025 Fuwn
17 | // SPDX-License-Identifier: GPL-3.0-only
18 |
19 | use std::{borrow::Cow, collections::HashMap, fmt::Display};
20 |
21 | /// Structure-ize a Gemini response's meta section into it's mime type and it's
22 | /// parameters.
23 | #[derive(Debug, Default, Clone, PartialEq, Eq)]
24 | pub struct Meta {
25 | /// The mime type of a Gemini response
26 | mime: String,
27 | /// The parameters of a Gemini response
28 | parameters: HashMap,
29 | }
30 |
31 | impl Display for Meta {
32 | fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
33 | write!(f, "{}", self.mime)?;
34 |
35 | if !self.parameters.is_empty() {
36 | write!(f, "; ")?;
37 |
38 | let mut parameters: Vec<_> = self.parameters.iter().collect();
39 |
40 | parameters.sort_by(|a, b| a.0.cmp(b.0));
41 |
42 | for (i, (key, value)) in parameters.iter().enumerate() {
43 | if i > 0 {
44 | write!(f, "; ")?;
45 | }
46 |
47 | write!(f, "{key}={value}")?;
48 | }
49 | }
50 |
51 | Ok(())
52 | }
53 | }
54 |
55 | impl Meta {
56 | /// Create a new `Meta`
57 | ///
58 | /// # Example
59 | ///
60 | /// ```rust
61 | /// let mut meta = germ::meta::Meta::new();
62 | /// ```
63 | #[must_use]
64 | pub fn new() -> Self { Self::default() }
65 |
66 | /// Create a `Meta` from a string
67 | ///
68 | /// # Example
69 | ///
70 | /// ```rust
71 | /// assert_eq!(
72 | /// germ::meta::Meta::from_string("text/gemini; hi=2; hi2=string=2").mime(),
73 | /// "text/gemini",
74 | /// );
75 | /// ```
76 | #[must_use]
77 | pub fn from_string<'a>(meta: impl Into>) -> Self {
78 | let meta = meta.into().to_string();
79 | let mut metas = meta.split(';');
80 | let mime = metas.next().unwrap_or("").to_string();
81 | let mut parameters = HashMap::new();
82 |
83 | for parameter in metas {
84 | let trimmed = parameter.trim_start();
85 |
86 | // Only parse parameters containing '=' as those without are malformed
87 | // according to RFC 2045
88 | if let Some(equal_pos) = trimmed.find('=') {
89 | let (key, value) = trimmed.split_at(equal_pos);
90 |
91 | parameters.insert(key.to_string(), value[1..].to_string());
92 | }
93 | }
94 |
95 | Self { mime, parameters }
96 | }
97 |
98 | /// Obtain non-mutable access to the mime of the `Meta`
99 | ///
100 | /// # Example
101 | ///
102 | /// ```rust
103 | /// assert_eq!(
104 | /// germ::meta::Meta::from_string("text/gemini; hi=2; hi2=string=2").mime(),
105 | /// "text/gemini",
106 | /// );
107 | /// ```
108 | #[allow(clippy::missing_const_for_fn)]
109 | #[must_use]
110 | pub fn mime(&self) -> Cow<'_, str> { Cow::Borrowed(&self.mime) }
111 |
112 | /// Obtain mutable access to the mime of the `Meta`
113 | ///
114 | /// # Example
115 | ///
116 | /// ```rust
117 | /// let mut meta = germ::meta::Meta::new();
118 | ///
119 | /// *meta.mime_mut() = "text/gemini".to_string();
120 | /// ```
121 | pub const fn mime_mut(&mut self) -> &mut String { &mut self.mime }
122 |
123 | /// Obtain non-mutable access to the parameters of the `Meta`
124 | ///
125 | /// # Example
126 | ///
127 | /// ```rust
128 | /// assert_eq!(
129 | /// germ::meta::Meta::from_string("text/gemini; hi=2; hi2=string=2")
130 | /// .parameters()
131 | /// .get("hi2"),
132 | /// Some(&"string=2".to_string()),
133 | /// );
134 | /// ```
135 | #[must_use]
136 | pub const fn parameters(&self) -> &HashMap {
137 | &self.parameters
138 | }
139 |
140 | /// Obtain mutable access to the parameters of the `Meta`
141 | ///
142 | /// # Example
143 | ///
144 | /// ```rust
145 | /// let mut meta = germ::meta::Meta::new();
146 | /// let mut parameters = std::collections::HashMap::new();
147 | ///
148 | /// parameters.insert("hi".to_string(), "2".to_string());
149 | /// parameters.insert("hi2".to_string(), "string=2".to_string());
150 | ///
151 | /// *meta.parameters_mut() = parameters;
152 | /// ```
153 | pub const fn parameters_mut(&mut self) -> &mut HashMap {
154 | &mut self.parameters
155 | }
156 | }
157 |
--------------------------------------------------------------------------------
/src/ast/node.rs:
--------------------------------------------------------------------------------
1 | // This file is part of Germ .
2 | // Copyright (C) 2022-2025 Fuwn
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, version 3.
7 | //
8 | // This program is distributed in the hope that it will be useful, but
9 | // WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 | // General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 | //
16 | // Copyright (C) 2022-2025 Fuwn
17 | // SPDX-License-Identifier: GPL-3.0-only
18 |
19 | /// A Gemtext AST node.
20 | ///
21 | /// Each Gemtext line is a `Node`, and some lines can even be grouped together,
22 | /// such as the `Node::List` `Node`!
23 | ///
24 | /// # Gemtext Resources
25 | ///
26 | /// - [Gemtext Documentation](https://gemini.circumlunar.space/docs/gemtext.gmi)
27 | /// - [Gemtext Cheatsheet](https://gemini.circumlunar.space/docs/cheatsheet.gmi).
28 | /// - [Gemini Specification](https://gemini.circumlunar.space/docs/specification.gmi).
29 | #[derive(Debug, PartialEq, Clone, Eq)]
30 | pub enum Node {
31 | /// A text line
32 | ///
33 | /// # Example
34 | ///
35 | /// ```gemini
36 | /// This is a text line
37 | /// ```
38 | Text(String),
39 | /// A link line
40 | ///
41 | /// # Examples
42 | ///
43 | /// ```gemini
44 | /// => /this-is-the-to This is the text
45 | ///
46 | /// => gemini://to.somewhere.link
47 | /// ```
48 | Link {
49 | /// The location that a link line is pointing to
50 | ///
51 | /// # Examples
52 | ///
53 | /// ```gemini
54 | /// => /this-is-the-to This is the text
55 | ///
56 | /// => gemini://to.somewhere.link
57 | /// ```
58 | to: String,
59 | /// The text a link line *may* have
60 | ///
61 | /// # Examples
62 | ///
63 | /// ```gemini
64 | /// => /this-is-the-to This line has text, unlike the next one.
65 | ///
66 | /// => gemini://to.somewhere.link
67 | /// ```
68 | text: Option,
69 | },
70 | /// A heading line
71 | ///
72 | /// # Examples
73 | ///
74 | /// ```gemini
75 | /// # This is a heading
76 | ///
77 | /// ## This is a sub-heading
78 | ///
79 | /// ### This is a sub-sub-heading
80 | /// ```
81 | Heading {
82 | /// The level of a heading
83 | ///
84 | /// # Examples
85 | ///
86 | /// ```gemini
87 | /// # This is a level 1 heading
88 | ///
89 | /// ## This is a level 2 sub-heading
90 | ///
91 | /// ### This is a level 3 sub-sub-heading
92 | /// ```
93 | level: usize,
94 | /// The text of a heading
95 | ///
96 | /// # Examples
97 | ///
98 | /// ```gemini
99 | /// # This is the headings text
100 | ///
101 | /// # This is also the headings text
102 | /// ```
103 | text: String,
104 | },
105 | /// A collection of sequential list item lines
106 | ///
107 | /// # Examples
108 | ///
109 | /// ```gemini
110 | /// * These are
111 | /// * sequential list
112 | /// * items.
113 | /// ```
114 | List(Vec),
115 | /// A blockquote line
116 | ///
117 | /// # Examples
118 | ///
119 | /// ```gemini
120 | /// > This is a blockquote line
121 | ///
122 | /// > This is also a blockquote line
123 | /// ```
124 | Blockquote(String),
125 | /// A preformatted block
126 | ///
127 | /// # Examples
128 | ///
129 | /// Try to ignore the leading backslash in-front of the triple backticks,
130 | /// they are there to not confuse the Markdown engine.
131 | ///
132 | /// ```gemini
133 | /// \```This is the alt-text
134 | /// This is the preformatted block
135 | ///
136 | /// This is the rest of the preformatted block
137 | /// \```
138 | /// ```
139 | PreformattedText {
140 | /// A preformatted blocks alt-text
141 | ///
142 | /// # Examples
143 | ///
144 | /// Try to ignore the leading backslash in-front of the triple backticks,
145 | /// they are there to not confuse the Markdown engine.
146 | ///
147 | /// ```gemini
148 | /// \```This is the alt-text
149 | /// This is the preformatted block
150 | ///
151 | /// This is the rest of the preformatted block
152 | /// \```
153 | /// ```
154 | alt_text: Option,
155 | /// A preformatted blocks content
156 | ///
157 | /// # Examples
158 | ///
159 | /// Try to ignore the leading backslash in-front of the triple backticks,
160 | /// they are there to not confuse the Markdown engine.
161 | ///
162 | /// ```gemini
163 | /// \```This is the alt-text
164 | /// This is the preformatted blocks content
165 | ///
166 | /// This is the rest of the preformatted blocks content
167 | /// \```
168 | /// ```
169 | text: String,
170 | },
171 | /// A whitespace line, a line which contains nothing but whitespace.
172 | Whitespace,
173 | }
174 |
175 | impl Node {
176 | /// Convert a single [`Node`] of any node type to a Gemtext [`String`]
177 | #[must_use]
178 | pub fn to_gemtext(&self) -> String {
179 | super::Ast::from_nodes(vec![self.to_owned()]).to_gemtext()
180 | }
181 | }
182 |
--------------------------------------------------------------------------------
/src/ast/container.rs:
--------------------------------------------------------------------------------
1 | // This file is part of Germ .
2 | // Copyright (C) 2022-2025 Fuwn
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, version 3.
7 | //
8 | // This program is distributed in the hope that it will be useful, but
9 | // WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 | // General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 | //
16 | // Copyright (C) 2022-2025 Fuwn
17 | // SPDX-License-Identifier: GPL-3.0-only
18 |
19 | use {super::Node, std::fmt::Write};
20 |
21 | /// An AST structure which contains an AST tree
22 | ///
23 | /// # Example
24 | ///
25 | /// ```rust
26 | /// let _ = germ::ast::Ast::from_string(r#"=> gemini://gem.rest/ GemRest"#);
27 | /// ```
28 | #[derive(Debug, Clone, PartialEq, Eq)]
29 | pub struct Ast {
30 | inner: Vec,
31 | }
32 |
33 | impl Ast {
34 | /// Build an AST tree from Gemtext
35 | ///
36 | /// # Example
37 | ///
38 | /// ```rust
39 | /// let _ = germ::ast::Ast::from_string(r#"=> gemini://gem.rest/ GemRest"#);
40 | /// ```
41 | #[must_use]
42 | pub fn from_owned(value: &(impl AsRef + ?Sized)) -> Self {
43 | Self::from_value(value.as_ref())
44 | }
45 |
46 | /// Build an AST tree from Gemtext
47 | ///
48 | /// # Example
49 | ///
50 | /// ```rust
51 | /// let _ = germ::ast::Ast::from_string(r#"=> gemini://gem.rest/ GemRest"#);
52 | /// ```
53 | #[must_use]
54 | #[allow(clippy::needless_pass_by_value)]
55 | pub fn from_string(value: impl Into) -> Self {
56 | Self::from_value(&value.into())
57 | }
58 |
59 | /// Build an AST tree from a value
60 | ///
61 | /// # Example
62 | ///
63 | /// ```rust
64 | /// let _ = germ::ast::Ast::from_value(r#"=> gemini://gem.rest/ GemRest"#);
65 | /// ```
66 | #[must_use]
67 | pub fn from_value(value: &(impl ToString + ?Sized)) -> Self {
68 | let mut ast = vec![];
69 | let mut in_preformatted = false;
70 | let mut in_list = false;
71 | let source = value.to_string();
72 | let mut lines = source.lines();
73 |
74 | // Iterate over all lines in the Gemtext `source`
75 | while let Some(line) = lines.next() {
76 | // Evaluate the Gemtext line and append its AST node to the `ast` tree
77 | ast.append(&mut Self::evaluate(
78 | line,
79 | &mut lines,
80 | &mut in_preformatted,
81 | &mut in_list,
82 | ));
83 | }
84 |
85 | if source.ends_with('\n') {
86 | if let Some(last) = ast.last() {
87 | if !matches!(last, Node::Whitespace) {
88 | ast.push(Node::Whitespace);
89 | }
90 | }
91 | }
92 |
93 | Self { inner: ast }
94 | }
95 |
96 | /// Build an AST tree from a [`Vec`] of [`Node`]s
97 | ///
98 | /// # Example
99 | ///
100 | /// ```rust
101 | /// // This assertion converts the Gemtext "=> / Home\n" to an AST tree of one
102 | /// // node, then converts the AST tree back to Gemtext, and compares it against
103 | /// // the original Gemtext.
104 | /// assert_eq!(
105 | /// germ::ast::Ast::from_nodes(
106 | /// germ::gemini_to_ast!("=> / Home").inner().to_vec()
107 | /// )
108 | /// .to_gemtext(),
109 | /// "=> / Home"
110 | /// );
111 | /// ```
112 | #[must_use]
113 | pub const fn from_nodes(nodes: Vec) -> Self { Self { inner: nodes } }
114 |
115 | #[must_use]
116 | pub fn to_gemtext(&self) -> String {
117 | let mut gemtext = String::new();
118 |
119 | for node in &self.inner {
120 | match node {
121 | Node::Text(text) => {
122 | let _ = writeln!(&mut gemtext, "{text}");
123 | }
124 | Node::Link { to, text } => {
125 | let _ = writeln!(
126 | &mut gemtext,
127 | "=> {}{}",
128 | to,
129 | text.clone().map_or_else(String::new, |text| format!(" {text}")),
130 | );
131 | }
132 | Node::Heading { level, text } => {
133 | let _ = writeln!(&mut gemtext, "{} {}", "#".repeat(*level), text);
134 | }
135 | Node::List(items) => {
136 | let _ = writeln!(
137 | &mut gemtext,
138 | "{}",
139 | items
140 | .iter()
141 | .map(|i| format!("* {i}"))
142 | .collect::>()
143 | .join("\n"),
144 | );
145 | }
146 | Node::Blockquote(text) => {
147 | let _ = writeln!(&mut gemtext, "> {text}");
148 | }
149 | Node::PreformattedText { alt_text, text } => {
150 | let _ = writeln!(
151 | &mut gemtext,
152 | "```{}\n{}```",
153 | alt_text.clone().unwrap_or_default(),
154 | text
155 | );
156 | }
157 | Node::Whitespace => gemtext.push('\n'),
158 | }
159 | }
160 |
161 | if gemtext.ends_with('\n') {
162 | gemtext.pop();
163 | }
164 |
165 | gemtext
166 | }
167 |
168 | /// The actual AST of `Ast`
169 | ///
170 | /// # Example
171 | ///
172 | /// ```rust
173 | /// let _ =
174 | /// germ::ast::Ast::from_string(r#"=> gemini://gem.rest/ GemRest"#).inner();
175 | /// ```
176 | #[must_use]
177 | pub const fn inner(&self) -> &Vec { &self.inner }
178 |
179 | #[allow(clippy::too_many_lines)]
180 | fn evaluate(
181 | line: &str,
182 | lines: &mut std::str::Lines<'_>,
183 | in_preformatted: &mut bool,
184 | in_list: &mut bool,
185 | ) -> Vec {
186 | let mut preformatted = String::new();
187 | let mut alt_text = String::new();
188 | let mut nodes = vec![];
189 | let mut line = line;
190 | let mut list_items = vec![];
191 |
192 | // Enter a not-so-infinite loop as sometimes, we may need to stay in an
193 | // evaluation loop, e.g., multiline contexts: preformatted text, lists, etc.
194 | loop {
195 | // Match the first character of the Gemtext line to understand the line
196 | // type
197 | match line.get(0..1).unwrap_or("") {
198 | "=" if !*in_preformatted => {
199 | // If the Gemtext line starts with an "=" ("=>"), it is a link line,
200 | // so splitting it up should be easy enough.
201 | let line = line.get(2..).unwrap_or("");
202 | let mut split = line.split_whitespace();
203 |
204 | nodes.push(Node::Link {
205 | to: split.next().unwrap_or_default().to_string(),
206 | text: {
207 | let rest: Vec<&str> = split.collect();
208 |
209 | if rest.is_empty() { None } else { Some(rest.join(" ")) }
210 | },
211 | });
212 |
213 | break;
214 | }
215 | "#" if !*in_preformatted => {
216 | // If the Gemtext line starts with an "#", it is a heading, so let's
217 | // find out how deep it goes.
218 | let level =
219 | line.trim_start().chars().take_while(|&c| c == '#').count();
220 |
221 | nodes.push(Node::Heading {
222 | level,
223 | // Here, the text after the heading markers is safely extracted.
224 | // `chars().skip()` is used to safely handle UTF-8 boundaries.
225 | text: line
226 | .chars()
227 | .skip(level)
228 | .collect::()
229 | .trim_start()
230 | .to_string(),
231 | });
232 |
233 | break;
234 | }
235 | "*" if !*in_preformatted => {
236 | // If the Gemtext line starts with an asterisk, it is a list item, so
237 | // let's enter a list context.
238 | if !*in_list {
239 | *in_list = true;
240 | }
241 |
242 | list_items.push(line.get(1..).unwrap_or("").trim_start().to_string());
243 |
244 | if let Some(next_line) = lines.next() {
245 | line = next_line;
246 | } else {
247 | break;
248 | }
249 | }
250 | ">" if !*in_preformatted => {
251 | // If the Gemtext line starts with an ">", it is a blockquote, so
252 | // let's just clip off the line identifier.
253 | nodes.push(Node::Blockquote(
254 | line.get(1..).unwrap_or("").trim_start().to_string(),
255 | ));
256 |
257 | break;
258 | }
259 | "`" => {
260 | // If the Gemtext line starts with a backtick, it's a preformatted
261 | // toggle, so let's enter a preformatted text context.
262 | *in_preformatted = !*in_preformatted;
263 |
264 | if *in_preformatted {
265 | alt_text = line.get(3..).unwrap_or("").to_string();
266 |
267 | if let Some(next_line) = lines.next() {
268 | line = next_line;
269 | } else {
270 | break;
271 | }
272 | } else {
273 | nodes.push(Node::PreformattedText {
274 | alt_text: if alt_text.is_empty() { None } else { Some(alt_text) },
275 | text: preformatted,
276 | });
277 |
278 | break;
279 | }
280 | }
281 | "" if !*in_preformatted => {
282 | if line.is_empty() {
283 | // If the line has nothing on it, it is a whitespace line, as long
284 | // as we aren't in a preformatted line context.
285 | nodes.push(Node::Whitespace);
286 | } else {
287 | nodes.push(Node::Text(line.to_string()));
288 | }
289 |
290 | break;
291 | }
292 | // This as a catchall. It does a number of things.
293 | _ => {
294 | if *in_preformatted {
295 | // If we are in a preformatted line context, add the line to the
296 | // preformatted blocks content and increment the line.
297 | let _ = writeln!(&mut preformatted, "{line}");
298 |
299 | if let Some(next_line) = lines.next() {
300 | line = next_line;
301 | } else {
302 | break;
303 | }
304 | } else {
305 | // If we are in a list item and hit a catchall, that must mean that
306 | // we encountered a line which is not a list line, so
307 | // let's stop adding items to the list context.
308 | if *in_list {
309 | *in_list = false;
310 |
311 | nodes.push(Node::Text(line.to_string()));
312 |
313 | break;
314 | }
315 |
316 | nodes.push(Node::Text(line.to_string()));
317 |
318 | break;
319 | }
320 | }
321 | }
322 | }
323 |
324 | if !list_items.is_empty() {
325 | nodes.reverse();
326 | nodes.push(Node::List(list_items));
327 | nodes.reverse();
328 | }
329 |
330 | nodes
331 | }
332 | }
333 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------