gvdb-macros-0.1.12/.cargo_vcs_info.json0000644000000001510000000000100133160ustar { "git": { "sha1": "b65df7ea99782c021ca7b36418b0824f7d0db344" }, "path_in_vcs": "gvdb-macros" }gvdb-macros-0.1.12/Cargo.toml0000644000000020540000000000100113200ustar # THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g., crates.io) dependencies. # # If you are reading this file be aware that the original Cargo.toml # will likely look very different (and much more reasonable). # See Cargo.toml.orig for the original contents. [package] edition = "2021" rust-version = "1.75" name = "gvdb-macros" version = "0.1.12" description = "Convenience macros for gvdb" readme = "README.md" keywords = [ "gvdb", "glib", "gresource", "compile-resources", ] categories = [ "gui", "data-structures", "encoding", ] license = "MIT" repository = "https://github.com/felinira/gvdb-rs" [lib] proc-macro = true [dependencies.gvdb] version = "0.6" features = ["gresource"] default-features = false [dependencies.litrs] version = "0.4" [dependencies.proc-macro2] version = "1.0" [dependencies.quote] version = "1.0" gvdb-macros-0.1.12/Cargo.toml.orig000064400000000000000000000007731046102023000150070ustar 00000000000000[package] name = "gvdb-macros" version = "0.1.12" edition = "2021" description = "Convenience macros for gvdb" repository = "https://github.com/felinira/gvdb-rs" license = "MIT" keywords = ["gvdb", "glib", "gresource", "compile-resources"] categories = ["gui", "data-structures", "encoding"] rust-version = "1.75" [lib] proc-macro = true [dependencies] gvdb = { version = "0.6", default-features = false, features = [ "gresource", ], path = "../gvdb" } proc-macro2 = "1.0" litrs = "0.4" quote = "1.0" gvdb-macros-0.1.12/LICENSE.Icons.md000064400000000000000000000154671046102023000146040ustar 00000000000000## creative commons # CC0 1.0 Universal CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER. ### Statement of Purpose The laws of most jurisdictions throughout the world automatically confer exclusive Copyright and Related Rights (defined below) upon the creator and subsequent owner(s) (each and all, an "owner") of an original work of authorship and/or a database (each, a "Work"). Certain owners wish to permanently relinquish those rights to a Work for the purpose of contributing to a commons of creative, cultural and scientific works ("Commons") that the public can reliably and without fear of later claims of infringement build upon, modify, incorporate in other works, reuse and redistribute as freely as possible in any form whatsoever and for any purposes, including without limitation commercial purposes. These owners may contribute to the Commons to promote the ideal of a free culture and the further production of creative, cultural and scientific works, or to gain reputation or greater distribution for their Work in part through the use and efforts of others. For these and/or other purposes and motivations, and without any expectation of additional consideration or compensation, the person associating CC0 with a Work (the "Affirmer"), to the extent that he or she is an owner of Copyright and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and publicly distribute the Work under its terms, with knowledge of his or her Copyright and Related Rights in the Work and the meaning and intended legal effect of CC0 on those rights. 1. __Copyright and Related Rights.__ A Work made available under CC0 may be protected by copyright and related or neighboring rights ("Copyright and Related Rights"). Copyright and Related Rights include, but are not limited to, the following: i. the right to reproduce, adapt, distribute, perform, display, communicate, and translate a Work; ii. moral rights retained by the original author(s) and/or performer(s); iii. publicity and privacy rights pertaining to a person's image or likeness depicted in a Work; iv. rights protecting against unfair competition in regards to a Work, subject to the limitations in paragraph 4(a), below; v. rights protecting the extraction, dissemination, use and reuse of data in a Work; vi. database rights (such as those arising under Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, and under any national implementation thereof, including any amended or successor version of such directive); and vii. other similar, equivalent or corresponding rights throughout the world based on applicable law or treaty, and any national implementations thereof. 2. __Waiver.__ To the greatest extent permitted by, but not in contravention of, applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and unconditionally waives, abandons, and surrenders all of Affirmer's Copyright and Related Rights and associated claims and causes of action, whether now known or unknown (including existing as well as future claims and causes of action), in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each member of the public at large and to the detriment of Affirmer's heirs and successors, fully intending that such Waiver shall not be subject to revocation, rescission, cancellation, termination, or any other legal or equitable action to disrupt the quiet enjoyment of the Work by the public as contemplated by Affirmer's express Statement of Purpose. 3. __Public License Fallback.__ Should any part of the Waiver for any reason be judged legally invalid or ineffective under applicable law, then the Waiver shall be preserved to the maximum extent permitted taking into account Affirmer's express Statement of Purpose. In addition, to the extent the Waiver is so judged Affirmer hereby grants to each affected person a royalty-free, non transferable, non sublicensable, non exclusive, irrevocable and unconditional license to exercise Affirmer's Copyright and Related Rights in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "License"). The License shall be deemed effective as of the date CC0 was applied by Affirmer to the Work. Should any part of the License for any reason be judged legally invalid or ineffective under applicable law, such partial invalidity or ineffectiveness shall not invalidate the remainder of the License, and in such case Affirmer hereby affirms that he or she will not (i) exercise any of his or her remaining Copyright and Related Rights in the Work or (ii) assert any associated claims and causes of action with respect to the Work, in either case contrary to Affirmer's express Statement of Purpose. 4. __Limitations and Disclaimers.__ a. No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, licensed or otherwise affected by this document. b. Affirmer offers the Work as-is and makes no representations or warranties of any kind concerning the Work, express, implied, statutory or otherwise, including without limitation warranties of title, merchantability, fitness for a particular purpose, non infringement, or the absence of latent or other defects, accuracy, or the present or absence of errors, whether or not discoverable, all to the greatest extent permissible under applicable law. c. Affirmer disclaims responsibility for clearing rights of other persons that may apply to the Work or any use thereof, including without limitation any person's Copyright and Related Rights in the Work. Further, Affirmer disclaims responsibility for obtaining any necessary consents, permissions or other rights required for any use of the Work. d. Affirmer understands and acknowledges that Creative Commons is not a party to this document and has no duty or obligation with respect to this CC0 or use of the Work. gvdb-macros-0.1.12/LICENSE.md000064400000000000000000000017771046102023000135310ustar 00000000000000Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. gvdb-macros-0.1.12/README.md000064400000000000000000000022211046102023000133650ustar 00000000000000# About this crate This crate offers convenience macros for [gvdb](https://crates.io/crates/gvdb). The macros are `include_gresource_from_xml!()` and `include_gresource_from_dir!()` [![Crates.io](https://img.shields.io/crates/v/gvdb-macros)](https://crates.io/crates/gvdb-macros) ## Examples Compile a GResource XML file and include the bytes in the file. ```rust use gvdb_macros::include_gresource_from_xml; static GRESOURCE_BYTES: &[u8] = include_gresource_from_xml!("test-data/gresource/test3.gresource.xml"); ``` Scan a directory and create a GResource file with all the contents of the directory. ```rust use gvdb_macros::include_gresource_from_dir; static GRESOURCE_BYTES: &[u8] = include_gresource_from_dir!("/gvdb/rs/test", "test-data/gresource/"); ``` ## License `gvdb` and `gvdb-macros` are available under the MIT license. See the [LICENSE.md](./LICENSE.md) file for more info. SVG icon files included in `test-data/gresource/icons/` are available under the CC0 license and redistributed from [Icon Development Kit](https://gitlab.gnome.org/Teams/Design/icon-development-kit). See the [LICENSE.Icons.md](./LICENSE.Icons.md) and file for more info. gvdb-macros-0.1.12/src/lib.rs000064400000000000000000000162371046102023000140250ustar 00000000000000//! This crate offers convenience macros for [gvdb](https://!github.com/felinira/gvdb-rs). //! The macros are [`include_gresource_from_xml!()`] and //! [`include_gresource_from_dir!()`] //! //! ## Examples //! //! Compile a GResource XML file and include the bytes in the file. //! //! ``` //! use gvdb_macros::include_gresource_from_xml; //! static GRESOURCE_BYTES: &[u8] = include_gresource_from_xml!("test-data/gresource/test3.gresource.xml"); //! ``` //! //! Scan a directory and create a GResource file with all the contents of the directory. //! //! ``` //! use gvdb_macros::include_gresource_from_dir; //! static GRESOURCE_BYTES: &[u8] = include_gresource_from_dir!("/gvdb/rs/test", "test-data/gresource"); //! ``` #![warn(missing_docs)] #![doc = include_str!("../README.md")] extern crate proc_macro; use litrs::{Literal, StringLit}; use proc_macro2::TokenTree; use quote::quote; use std::path::PathBuf; fn quote_bytes(bytes: &[u8]) -> proc_macro2::TokenStream { let bytes_lit = proc_macro2::Literal::byte_string(bytes); quote! { {{ #[repr(align(16))] #[doc(hidden)] struct __GvdbAligned(T); #[doc(hidden)] static __GVDB_DATA: &'static __GvdbAligned<[u8]> = &__GvdbAligned(*#bytes_lit); &__GVDB_DATA.0 }} } } fn include_gresource_from_xml_with_filename(filename: &str) -> proc_macro2::TokenStream { let path = PathBuf::from(filename); let xml = gvdb::gresource::GResourceXMLDocument::from_file(&path).unwrap(); let builder = gvdb::gresource::GResourceBuilder::from_xml(xml).unwrap(); let data = builder.build().unwrap(); quote_bytes(&data) } fn include_gresource_from_xml_inner(input: proc_macro2::TokenStream) -> proc_macro2::TokenStream { let mut iter = input.into_iter(); let first = iter .next() .expect("Expected exactly one string literal argument (gresource file location)"); let second = iter.next(); if let Some(second) = second { panic!("Unexpected token '{}', expected exactly one string literal argument (gresource file location)", second) } match Literal::try_from(first) { Err(e) => proc_macro2::TokenStream::from(e.to_compile_error()), Ok(Literal::String(str)) => { include_gresource_from_xml_with_filename(str.value()) } Ok(other) => panic!("Unexpected token '{:?}', expected exactly one string literal argument (gresource file location)", other) } } /// Compile a GResource XML file to its binary representation and include it in the source file. /// /// ``` /// use gvdb_macros::include_gresource_from_xml; /// static GRESOURCE_BYTES: &[u8] = include_gresource_from_xml!("test-data/gresource/test3.gresource.xml"); /// ``` #[proc_macro] pub fn include_gresource_from_xml(input: proc_macro::TokenStream) -> proc_macro::TokenStream { let input = proc_macro2::TokenStream::from(input); let output = include_gresource_from_xml_inner(input); proc_macro::TokenStream::from(output) } fn include_gresource_from_dir_str(prefix: &str, directory: &str) -> proc_macro2::TokenStream { let path = PathBuf::from(directory); let builder = gvdb::gresource::GResourceBuilder::from_directory(prefix, &path, true, true).unwrap(); let data = builder.build().unwrap(); quote_bytes(&data) } fn include_gresource_from_dir_inner(input: proc_macro2::TokenStream) -> proc_macro2::TokenStream { let err_msg = "expected exactly two string literal arguments (prefix, gresource directory)"; let (prefix, directory) = match &*input.into_iter().collect::>() { [TokenTree::Literal(str1), TokenTree::Punct(comma), TokenTree::Literal(str2)] => { if comma.as_char() != ',' { panic!("{}", err_msg); } ( StringLit::try_from(str1).expect(err_msg), StringLit::try_from(str2).expect(err_msg), ) } _ => panic!("{}", err_msg), }; include_gresource_from_dir_str(prefix.value(), directory.value()) } /// Scan a directory and create a GResource file with all the contents of the directory. /// /// This will ignore any files that end with gresource.xml and meson.build, as /// those are most likely not needed inside the GResource. /// /// This is equivalent to the following XML: /// /// ```xml /// /// /// /// /// /// ``` /// /// The first argument to this macro is the prefix for the GResource file. The second argument is /// the path to the folder containing the files to include in the file. /// /// This acts as if every xml file uses the option `xml-stripblanks` in the GResource XML and every /// JSON file uses `json-stripblanks`. /// /// JSON files are all files with the extension '.json'. /// XML files are all files with the extensions '.xml', '.ui', '.svg' /// /// All files that end with `.ui` and `.css` are compressed. /// ``` /// use gvdb_macros::include_gresource_from_dir; /// static GRESOURCE_BYTES: &[u8] = include_gresource_from_dir!("/gvdb/rs/tests/data", "test-data/gresource"); /// ``` #[proc_macro] pub fn include_gresource_from_dir(input: proc_macro::TokenStream) -> proc_macro::TokenStream { let input = proc_macro2::TokenStream::from(input); let output = include_gresource_from_dir_inner(input); proc_macro::TokenStream::from(output) } #[cfg(test)] mod tests { use super::*; use quote::quote; #[test] fn include_gresource_from_xml() { let tokens = include_gresource_from_xml_inner(quote! {"test-data/gresource/test3.gresource.xml"}); assert!(tokens.to_string().contains(r#"b"GVariant"#)); } #[test] #[should_panic] fn include_gresource_from_xml_panic() { include_gresource_from_xml_inner(quote! {4}); } #[test] #[should_panic] fn include_gresource_from_xml_panic2() { include_gresource_from_xml_inner(quote! { "test", 4 }); } #[test] #[should_panic] fn include_gresource_from_xml_panic3() { include_gresource_from_xml_inner(quote! { test }); } #[test] fn include_gresource_from_dir() { let tokens = include_gresource_from_dir_inner(quote! {"/gvdb/rs/test", "test-data/gresource"}); assert!(tokens.to_string().contains(r#"b"GVariant"#)); } #[test] #[should_panic] fn include_gresource_from_dir_panic1() { include_gresource_from_dir_inner(quote! {"/gvdb/rs/test",}); } #[test] #[should_panic] fn include_gresource_from_dir_panic2() { include_gresource_from_dir_inner(quote! {"/gvdb/rs/test"}); } #[test] #[should_panic] fn include_gresource_from_dir_panic3() { include_gresource_from_dir_inner(quote! {"/gvdb/rs/test","bla","bla"}); } #[test] #[should_panic] fn include_gresource_from_dir_panic4() { include_gresource_from_dir_inner(quote! {"/gvdb/rs/test","INVALID_DIRECTORY"}); } #[test] #[should_panic] fn include_gresource_from_dir_panic5() { include_gresource_from_dir_inner(quote! {"/gvdb/rs/test"."test-data/gresource"}); } } gvdb-macros-0.1.12/test-data/gresource/icons/scalable/actions/online-symbolic.svg000064400000000000000000000025561046102023000261520ustar 00000000000000 gvdb-macros-0.1.12/test-data/gresource/icons/scalable/actions/send-symbolic.svg000064400000000000000000000005311046102023000256060ustar 00000000000000 gvdb-macros-0.1.12/test-data/gresource/json/test.json000064400000000000000000000000631046102023000206170ustar 00000000000000[ "test_string", 42, { "bool": true } ]gvdb-macros-0.1.12/test-data/gresource/test.css000064400000000000000000000000471046102023000174670ustar 00000000000000.test { background-color: black; } gvdb-macros-0.1.12/test-data/gresource/test3.gresource.xml000064400000000000000000000010021046102023000215470ustar 00000000000000 icons/scalable/actions/online-symbolic.svg icons/scalable/actions/send-symbolic.svg json/test.json test.css gvdb-macros-0.1.12/test-data/test1.gvdb000064400000000000000000000001501046102023000156770ustar 00000000000000GVariant<(ÑÚÿÿÿÿ<vHhroot_keyÒÍTEST_STRING_VALUE(uus)gvdb-macros-0.1.12/test-data/test2.gvdb000064400000000000000000000002461046102023000157060ustar 00000000000000raVGtnaiX(ü¯“ÿÿÿÿXv`núhÿÿÿÿnHt˜stringtest stringstable(0€ˆ ÿÿÿÿ˜v ¦int*ugvdb-macros-0.1.12/test-data/test3.gresource000064400000000000000000000044161046102023000167660ustar 00000000000000GVariantp(  `ØÊÔpvx³‘)ó7³vÈÕ©ˆ~³ÕLÜìÒuÊaìLôø:†áÎø v9ZëÏ 9L<@ºý"í@LHLúD  L LX\Ôµÿÿÿÿ\L`dTˆ¢—dLlp&Á }pLx|ŠUè|v test.css'xÚÓ+I-.Q¨æR‚¤Ääìô¢üÒ¼Ýäüœü"+…¤ 5W-û½ £(uuay)send-symbolic.svgYxÚ-Ûj…0EßýŠ!}vÌýr0èC¿ ý€Òc5à£é×w´…@BØk {êû1°·Ï5ÍSd9ƒvúšiê"ûx+=»7EQ¯{ÖÈúm[nU•sƬp~v•äœW”`з©ë7Ùå`°§6¿ÎGd8K‡AN­ÿ4@½|n=<"AôA%@Â%†n¥sJkØÁ ’Z Oÿ½ôB(%jg½ ŽÖraìùræÒ °.ØTN„Ó¾C©«À/Dp$–4•·N„ ¨NµCë/‹Æ¿Y Åþ‘*Ѳ¾Ó0Dö"[¥µ«š¢>7ÑüÊT_(uuay)test/  json/test.json!["test_string",42,{"bool":true}] (uuay)rs/actions/scalable// icons/gvdb/online-symbolic.svgn (uuay)gvdb-macros-0.1.12/tests/test.rs000064400000000000000000000007701046102023000146040ustar 00000000000000use gvdb_macros::{include_gresource_from_dir, include_gresource_from_xml}; #[test] fn macros() { let _data = include_gresource_from_dir!("test", "test-data/gresource"); let _data2 = include_gresource_from_xml!("test-data/gresource/test3.gresource.xml"); } #[test] fn align() { for _ in 0..100 { let data = include_gresource_from_dir!("test", "test-data/gresource"); let _u8 = 8u8; let ptr_addr = data.as_ptr() as usize; assert_eq!(0, ptr_addr % 16); } }