├── .github ├── FUNDING.yml └── workflows │ └── tests.yml ├── .gitignore ├── CODE_OF_CONDUCT.md ├── Cargo.toml ├── Justfile ├── LICENSE-APACHE ├── LICENSE-MIT ├── README.md ├── examples ├── fixture │ ├── src │ │ └── main.ara │ └── vendor │ │ ├── bar │ │ └── bar.d.ara │ │ └── foo │ │ └── write_line.d.ara └── simple.rs └── src ├── error.rs ├── lib.rs ├── loader.rs └── source.rs /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | open_collective: php-standard-library 2 | -------------------------------------------------------------------------------- /.github/workflows/tests.yml: -------------------------------------------------------------------------------- 1 | name: ci 2 | 3 | on: 4 | push: 5 | branches: [main] 6 | pull_request: 7 | 8 | jobs: 9 | ci: 10 | name: ci 11 | runs-on: ${{ matrix.os }} 12 | strategy: 13 | fail-fast: false 14 | matrix: 15 | rust: 16 | - 'stable' 17 | - 'nightly' 18 | os: 19 | - 'ubuntu-latest' 20 | 21 | steps: 22 | - name: checkout 23 | uses: actions/checkout@v3 24 | 25 | - name: install rust 26 | uses: actions-rs/toolchain@v1 27 | with: 28 | toolchain: ${{ matrix.rust }} 29 | override: true 30 | components: rustfmt, clippy 31 | 32 | - name: cache 33 | id: cache 34 | uses: actions/cache@v3 35 | with: 36 | path: | 37 | ~/.cargo/bin/ 38 | ~/.cargo/registry/index/ 39 | ~/.cargo/registry/cache/ 40 | ~/.cargo/git/db/ 41 | target/ 42 | key: rust-${{ inputs.rust }}-os-${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }} 43 | 44 | - name: check 45 | uses: actions-rs/cargo@v1 46 | with: 47 | command: check 48 | 49 | - name: fmt 50 | if: matrix.rust == 'stable' 51 | uses: actions-rs/cargo@v1 52 | with: 53 | command: fmt 54 | args: --all --check 55 | 56 | - name: clippy 57 | if: matrix.rust == 'stable' 58 | uses: actions-rs/cargo@v1 59 | with: 60 | command: clippy 61 | 62 | - name: test 63 | uses: actions-rs/cargo@v1 64 | with: 65 | command: test 66 | args: -r --all 67 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | /Cargo.lock 3 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, sex characteristics, gender identity and expression, 9 | level of experience, education, socio-economic status, nationality, personal 10 | appearance, race, religion, or sexual identity and orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at azjezz@protonmail.com. All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html) 72 | 73 | [homepage]: [https://www.contributor-covenant.org](https://www.contributor-covenant.org) 74 | 75 | For answers to common questions about this code of conduct, see 76 | [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq) 77 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "ara_source" 3 | version = "0.2.0" 4 | edition = "2021" 5 | description = "A Source library for Ara Programming Language 🗃" 6 | readme = "README.md" 7 | repository = "https://github.com/ara-lang/source" 8 | documentation = "https://docs.rs/ara_source" 9 | homepage = "https://github.com/ara-lang/source" 10 | exclude = ["/.github/*"] 11 | authors = ["Saif Eddin Gmati "] 12 | license = "MIT OR Apache-2.0" 13 | keywords = ["ara", "file-source", "source-map"] 14 | 15 | # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html 16 | 17 | [dependencies] 18 | -------------------------------------------------------------------------------- /Justfile: -------------------------------------------------------------------------------- 1 | default: 2 | @just --list 3 | 4 | # build the library 5 | build: 6 | cargo build 7 | 8 | # detect linting problems. 9 | lint: 10 | cargo fmt --all -- --check 11 | cargo clippy 12 | 13 | # fix linting problems. 14 | fix: 15 | cargo fmt 16 | cargo clippy --fix --allow-dirty --allow-staged 17 | 18 | test: 19 | cargo test --all 20 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2022 Saif Eddin Gmati 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Ara Source 2 | 3 | [![Actions Status](https://github.com/ara-lang/source/workflows/ci/badge.svg)](https://github.com/ara-lang/source/actions) 4 | [![Crates.io](https://img.shields.io/crates/v/ara_source.svg)](https://crates.io/crates/ara_source) 5 | [![Docs](https://docs.rs/ara_source/badge.svg)](https://docs.rs/ara_source/latest/ara_source/) 6 | 7 | A Source library for Ara Programming Language 🗃 8 | 9 | ## Usage 10 | 11 | Add `ara_source` to your `Cargo.toml`, and you're good to go! 12 | 13 | ```toml 14 | [dependencies] 15 | ara_source = "0.2.0" 16 | ``` 17 | 18 | ## Example 19 | 20 | ```rust 21 | use ara_source::loader; 22 | 23 | fn main() { 24 | let root = format!( 25 | "{}/examples/fixture/", 26 | std::env::var("CARGO_MANIFEST_DIR").unwrap() 27 | ); 28 | 29 | let result = loader::load_directories(root, vec!["src", "vendor/foo", "vendor/bar"])?; 30 | 31 | println!("{:#?}", map); 32 | } 33 | ``` 34 | 35 | see [examples](examples) directory for more examples. 36 | 37 | ## License 38 | 39 | Licensed under either of 40 | 41 | * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) 42 | * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) 43 | 44 | at your option. 45 | 46 | ## Contribution 47 | 48 | Unless you explicitly state otherwise, any contribution intentionally submitted 49 | for inclusion in the work by you, as defined in the Apache-2.0 license, shall be 50 | dual licensed as above, without any additional terms or conditions. 51 | 52 | ## Credits 53 | 54 | * [Saif Eddin Gmati](https://github.com/azjezz) 55 | * [All contributors](https://github.com/ara-lang/source/graphs/contributors) 56 | -------------------------------------------------------------------------------- /examples/fixture/src/main.ara: -------------------------------------------------------------------------------- 1 | use Psl\IO\write_line; 2 | 3 | function main(): void { 4 | write_line('Hello, World!'); 5 | } 6 | -------------------------------------------------------------------------------- /examples/fixture/vendor/bar/bar.d.ara: -------------------------------------------------------------------------------- 1 | namespace Container; 2 | 3 | interface Container<+T as object> { 4 | public function get(): T; 5 | } 6 | -------------------------------------------------------------------------------- /examples/fixture/vendor/foo/write_line.d.ara: -------------------------------------------------------------------------------- 1 | namespace Psl\IO; 2 | 3 | function write_line(string $line, mixed ...$args): void {} 4 | -------------------------------------------------------------------------------- /examples/simple.rs: -------------------------------------------------------------------------------- 1 | use ara_source::loader; 2 | 3 | fn main() { 4 | let root = format!( 5 | "{}/examples/fixture/", 6 | std::env::var("CARGO_MANIFEST_DIR").unwrap() 7 | ); 8 | 9 | let map = loader::load_directories( 10 | root.clone(), 11 | vec![ 12 | format!("{root}src"), 13 | format!("{root}vendor/foo"), 14 | format!("{root}vendor/bar"), 15 | ], 16 | ) 17 | .unwrap(); 18 | 19 | println!("{map:#?}"); 20 | } 21 | -------------------------------------------------------------------------------- /src/error.rs: -------------------------------------------------------------------------------- 1 | #[derive(Debug)] 2 | pub enum Error { 3 | SourceNotFound(String), 4 | InvalidSource(String), 5 | IoError(std::io::Error), 6 | } 7 | 8 | impl From for Error { 9 | fn from(error: std::io::Error) -> Self { 10 | Error::IoError(error) 11 | } 12 | } 13 | 14 | impl std::fmt::Display for Error { 15 | fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { 16 | match self { 17 | Error::SourceNotFound(name) => write!(f, "source `{name}` not found."), 18 | Error::InvalidSource(message) => write!(f, "invalid source: {message}"), 19 | Error::IoError(error) => write!(f, "io error: {error}"), 20 | } 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | use crate::error::Error; 2 | use crate::source::Source; 3 | 4 | pub mod error; 5 | pub mod loader; 6 | pub mod source; 7 | 8 | #[derive(Debug)] 9 | pub struct SourceMap { 10 | pub sources: Vec, 11 | } 12 | 13 | impl SourceMap { 14 | pub fn new(sources: Vec) -> SourceMap { 15 | SourceMap { sources } 16 | } 17 | 18 | pub fn add(&mut self, source: Source) { 19 | self.sources.push(source); 20 | } 21 | 22 | /// Get a source by its index. 23 | /// 24 | /// If the source is not found, `Error::SourceNotFound` is returned. 25 | pub fn get(&self, index: usize) -> Result<&Source, Error> { 26 | self.sources 27 | .get(index - 1) 28 | .ok_or_else(|| Error::SourceNotFound(index.to_string())) 29 | } 30 | 31 | /// Find a source by its origin. 32 | /// 33 | /// If the source is not found, `Error::SourceNotFound` is returned. 34 | pub fn named>(&self, name: T) -> Result<&Source, Error> { 35 | let name = name.into(); 36 | 37 | self.sources 38 | .iter() 39 | .find(|source| source.origin == Some(name.clone())) 40 | .ok_or(Error::SourceNotFound(name)) 41 | } 42 | 43 | /// Merge two source maps. 44 | /// 45 | /// The sources of the other source map are appended to the current source map. 46 | /// 47 | /// The other source map is emptied. 48 | pub fn merge(&mut self, other: &mut SourceMap) { 49 | self.sources.append(&mut other.sources); 50 | } 51 | } 52 | 53 | #[cfg(test)] 54 | mod tests { 55 | use super::*; 56 | 57 | use crate::source::SourceKind; 58 | 59 | #[test] 60 | fn test_source_map() { 61 | let mut map = SourceMap::new(vec![]); 62 | 63 | map.add(Source::new( 64 | SourceKind::Script, 65 | "foo.ara", 66 | "function foo(): void {}", 67 | )); 68 | map.add(Source::new( 69 | SourceKind::Script, 70 | "bar.ara", 71 | "function bar(): void {}", 72 | )); 73 | 74 | assert_eq!(map.get(1).unwrap().origin, Some("foo.ara".to_string())); 75 | assert_eq!(map.get(2).unwrap().origin, Some("bar.ara".to_string())); 76 | assert!(map.get(3).is_err()); 77 | 78 | assert_eq!( 79 | map.named("foo.ara").unwrap().origin, 80 | Some("foo.ara".to_string()) 81 | ); 82 | assert_eq!( 83 | map.named("bar.ara").unwrap().origin, 84 | Some("bar.ara".to_string()) 85 | ); 86 | assert!(map.named("baz.ara").is_err()); 87 | 88 | let mut other = SourceMap::new(vec![]); 89 | 90 | other.add(Source::new( 91 | SourceKind::Script, 92 | "baz.ara", 93 | "function baz(): void {}", 94 | )); 95 | 96 | map.merge(&mut other); 97 | 98 | assert_eq!(map.get(1).unwrap().origin, Some("foo.ara".to_string())); 99 | assert_eq!(map.get(2).unwrap().origin, Some("bar.ara".to_string())); 100 | assert_eq!(map.get(3).unwrap().origin, Some("baz.ara".to_string())); 101 | 102 | assert!(other.get(1).is_err()); 103 | } 104 | } 105 | -------------------------------------------------------------------------------- /src/loader.rs: -------------------------------------------------------------------------------- 1 | use std::path::Path; 2 | use std::path::PathBuf; 3 | 4 | use crate::error::Error; 5 | use crate::source::Source; 6 | use crate::source::SourceKind; 7 | use crate::SourceMap; 8 | 9 | pub const ARA_SCRIPT_EXTENSION: &str = "ara"; 10 | pub const ARA_DEFINTION_EXTENSION: &str = "d.ara"; 11 | 12 | /// Load a source map from the given directories. 13 | pub fn load_directories, C: AsRef>( 14 | root: T, 15 | directories: Vec, 16 | ) -> Result { 17 | let mut map = SourceMap::new(vec![]); 18 | 19 | let loader = DirectorySourceLoader::new(&root); 20 | 21 | for directory in directories { 22 | loader.load_into(&directory, &mut map)?; 23 | } 24 | 25 | Ok(map) 26 | } 27 | 28 | pub trait SourceLoader: std::fmt::Debug { 29 | /// Check if the given name is supported by this loader. 30 | /// 31 | /// If `true` is returned, `load` *MUST NOT* return `Error::InvalidSource`. 32 | fn supports>(&self, name: &T) -> bool; 33 | 34 | /// Load a source map from the given name. 35 | /// 36 | /// The source name can contain a path, directory, or any other information. 37 | /// 38 | /// If the source name is not valid, `Error::InvalidSource` is returned. 39 | fn load>(&self, name: &T) -> Result; 40 | 41 | /// Load a source from the given name and merge it into the given source map. 42 | fn load_into>(&self, name: &T, map: &mut SourceMap) -> Result<(), Error> { 43 | let mut source = self.load(name)?; 44 | 45 | map.merge(&mut source); 46 | 47 | Ok(()) 48 | } 49 | } 50 | 51 | #[derive(Debug)] 52 | pub struct FileSourceLoader { 53 | pub root: PathBuf, 54 | } 55 | 56 | impl FileSourceLoader { 57 | pub fn new>(root: &T) -> FileSourceLoader { 58 | FileSourceLoader { 59 | root: root.as_ref().to_path_buf(), 60 | } 61 | } 62 | } 63 | 64 | impl SourceLoader for FileSourceLoader { 65 | fn supports>(&self, file: &T) -> bool { 66 | let file = file.as_ref(); 67 | let file = if file.is_relative() { 68 | self.root.join(file) 69 | } else { 70 | file.to_path_buf() 71 | }; 72 | 73 | if !file.is_file() { 74 | return false; 75 | } 76 | 77 | match file.extension() { 78 | Some(extension) => { 79 | let extension = match extension.to_str() { 80 | Some(extension) => extension, 81 | None => { 82 | return false; 83 | } 84 | }; 85 | 86 | if extension == ARA_SCRIPT_EXTENSION { 87 | return true; 88 | } 89 | 90 | false 91 | } 92 | None => false, 93 | } 94 | } 95 | 96 | fn load>(&self, file: &T) -> Result { 97 | let file = file.as_ref(); 98 | 99 | if !self.supports(&file) { 100 | return Err(Error::InvalidSource(format!( 101 | "source `{}` is not supported.", 102 | file.to_string_lossy() 103 | ))); 104 | } 105 | 106 | let file = if file.is_relative() { 107 | self.root.join(file) 108 | } else { 109 | file.to_path_buf() 110 | }; 111 | 112 | let content = std::fs::read_to_string(&file)?; 113 | let origin = file 114 | .strip_prefix(&self.root) 115 | .map(|path| path.to_string_lossy()) 116 | .unwrap(); 117 | let kind = if origin.ends_with(ARA_DEFINTION_EXTENSION) { 118 | SourceKind::Definition 119 | } else { 120 | SourceKind::Script 121 | }; 122 | 123 | Ok(SourceMap::new(vec![Source::new(kind, origin, content)])) 124 | } 125 | } 126 | 127 | #[derive(Debug)] 128 | pub struct DirectorySourceLoader { 129 | pub root: PathBuf, 130 | 131 | loader: FileSourceLoader, 132 | } 133 | 134 | impl DirectorySourceLoader { 135 | pub fn new>(root: &T) -> DirectorySourceLoader { 136 | DirectorySourceLoader { 137 | root: root.as_ref().to_path_buf(), 138 | loader: FileSourceLoader::new(root), 139 | } 140 | } 141 | } 142 | 143 | impl SourceLoader for DirectorySourceLoader { 144 | fn supports>(&self, directory: &T) -> bool { 145 | let directory = directory.as_ref(); 146 | let directory = if directory.is_relative() { 147 | self.root.join(directory) 148 | } else { 149 | directory.to_path_buf() 150 | }; 151 | 152 | if !directory.starts_with(&self.root) { 153 | return false; 154 | } 155 | 156 | if !directory.is_dir() { 157 | return false; 158 | } 159 | 160 | true 161 | } 162 | 163 | fn load>(&self, directory: &T) -> Result { 164 | let directory = directory.as_ref(); 165 | if !self.supports(&directory) { 166 | return Err(Error::InvalidSource(format!( 167 | "source `{}` is not supported.", 168 | directory.to_string_lossy() 169 | ))); 170 | } 171 | 172 | let directory = if directory.is_relative() { 173 | self.root.join(directory) 174 | } else { 175 | directory.to_path_buf() 176 | }; 177 | 178 | let mut map = SourceMap::new(vec![]); 179 | 180 | let entries = std::fs::read_dir(directory)?; 181 | 182 | for entry in entries { 183 | let entry = entry.unwrap(); 184 | let path = entry.path(); 185 | 186 | if path.is_dir() { 187 | self.load_into(&path, &mut map)?; 188 | } else if self.loader.supports(&path) { 189 | self.loader.load_into(&path, &mut map)?; 190 | } 191 | } 192 | 193 | Ok(map) 194 | } 195 | } 196 | 197 | #[cfg(test)] 198 | mod tests { 199 | use super::*; 200 | 201 | #[test] 202 | fn test_directory() { 203 | let root = format!( 204 | "{}/examples/fixture/", 205 | std::env::var("CARGO_MANIFEST_DIR").unwrap() 206 | ); 207 | 208 | let result = load_directories(root, vec!["src", "vendor/foo", "vendor/bar"]); 209 | 210 | let map = result.unwrap(); 211 | 212 | assert_eq!(map.sources.len(), 3); 213 | 214 | assert_eq!(map.named("src/main.ara").unwrap().kind, SourceKind::Script); 215 | assert_eq!( 216 | map.named("vendor/foo/write_line.d.ara").unwrap().kind, 217 | SourceKind::Definition 218 | ); 219 | assert_eq!( 220 | map.named("vendor/bar/bar.d.ara").unwrap().kind, 221 | SourceKind::Definition 222 | ); 223 | } 224 | } 225 | -------------------------------------------------------------------------------- /src/source.rs: -------------------------------------------------------------------------------- 1 | pub const DEFAULT_NAME: &str = ""; 2 | 3 | #[derive(Debug, PartialEq, Eq, Clone, Copy)] 4 | pub enum SourceKind { 5 | /// A definition is a piece of code that is not executed, but can be used 6 | /// to define foriegn symbols ( e.g from PHP ). 7 | Definition, 8 | 9 | /// A script is a piece of code that is executed. 10 | Script, 11 | } 12 | 13 | #[derive(Debug, PartialEq, Eq, Clone)] 14 | pub struct Source { 15 | pub kind: SourceKind, 16 | pub origin: Option, 17 | pub content: String, 18 | } 19 | 20 | /// A source. 21 | /// 22 | /// A source is a reference to a piece of code. 23 | /// 24 | /// Example: 25 | /// 26 | /// ```rust 27 | /// use ara_source::source::Source; 28 | /// use ara_source::source::SourceKind; 29 | /// 30 | /// let source = Source::new(SourceKind::Script, "main.ara", "function main(): void {}"); 31 | /// 32 | /// assert_eq!(source.kind, SourceKind::Script); 33 | /// assert_eq!(source.origin, Some("main.ara".to_string())); 34 | /// assert_eq!(source.content, "function main(): void {}"); 35 | /// 36 | /// assert_eq!(source.name(), "main.ara"); 37 | /// ``` 38 | impl Source { 39 | /// Create a new source with the given content. 40 | /// 41 | /// Example: 42 | /// 43 | /// ```rust 44 | /// use ara_source::source::Source; 45 | /// use ara_source::source::SourceKind; 46 | /// 47 | /// let source = Source::inline(SourceKind::Definition, "function main(): void {}"); 48 | /// 49 | /// assert_eq!(source.kind, SourceKind::Definition); 50 | /// assert_eq!(source.origin, None); 51 | /// assert_eq!(source.content, "function main(): void {}"); 52 | /// 53 | /// assert_eq!(source.name(), ""); 54 | /// ``` 55 | pub fn new, C: Into>( 56 | kind: SourceKind, 57 | origin: O, 58 | content: C, 59 | ) -> Source { 60 | Source { 61 | kind, 62 | origin: Some(origin.into()), 63 | content: content.into(), 64 | } 65 | } 66 | 67 | /// Create a new source with the given content. 68 | /// 69 | /// Example: 70 | /// 71 | /// ```rust 72 | /// use ara_source::source::Source; 73 | /// use ara_source::source::SourceKind; 74 | /// 75 | /// let source = Source::inline(SourceKind::Definition, "function main(): void {}"); 76 | /// 77 | /// assert_eq!(source.kind, SourceKind::Definition); 78 | /// assert_eq!(source.origin, None); 79 | /// assert_eq!(source.content, "function main(): void {}"); 80 | /// ``` 81 | pub fn inline>(kind: SourceKind, content: C) -> Source { 82 | Source { 83 | kind, 84 | origin: None, 85 | content: content.into(), 86 | } 87 | } 88 | 89 | /// Get the name of the source. 90 | /// 91 | /// If the source has an origin, the origin is returned. 92 | /// Otherwise, the default name is returned. 93 | /// 94 | /// Example: 95 | /// 96 | /// ```rust 97 | /// use ara_source::source::Source; 98 | /// use ara_source::source::SourceKind; 99 | /// 100 | /// let source = Source::new(SourceKind::Definition, "main.ara", "function main(): void {}"); 101 | /// assert_eq!(source.name(), "main.ara"); 102 | /// 103 | /// let source = Source::inline(SourceKind::Definition, "function main(): void {}"); 104 | /// assert_eq!(source.name(), ""); 105 | /// ``` 106 | pub fn name(&self) -> &str { 107 | match self.origin { 108 | Some(ref origin) => origin, 109 | None => DEFAULT_NAME, 110 | } 111 | } 112 | } 113 | --------------------------------------------------------------------------------