├── .gitignore ├── .travis.yml ├── Cargo.toml ├── LICENSE-MPL2 ├── Makefile ├── README.md ├── lib ├── Cargo.toml ├── mod.rs └── src │ └── lib.rs └── src └── bin.rs /.gitignore: -------------------------------------------------------------------------------- 1 | target 2 | Cargo.lock 3 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: rust 2 | cache: 3 | - cargo 4 | rust: 5 | - stable 6 | - 1.15.0 7 | - beta 8 | - nightly 9 | 10 | script: 11 | - make all 12 | - make travistest 13 | - if [ "$TRAVIS_RUST_VERSION" == "nightly" ]; then make bench ; fi 14 | - if [ "$TRAVIS_RUST_VERSION" == "nightly" ]; then cargo build --no-default-features; cargo test --no-default-features; fi 15 | 16 | env: 17 | global: 18 | - RUST_BACKTRACE=1 19 | matrix: 20 | - 21 | - RELEASE=true 22 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "text-minimap" 3 | description = "Generate text minimap/preview using Braille Patterns" 4 | version = "0.1.0" 5 | authors = ["Dawid Ciężarkiewicz "] 6 | keywords = ["text", "terminal", "tool", "hierarchical"] 7 | categories = ["command-line-utilities", "text-processing"] 8 | license = "MPL-2.0" 9 | documentation = "https://docs.rs/text-minimap" 10 | homepage = "https://github.com/dpc/text-minimap" 11 | repository = "https://github.com/dpc/text-minimap" 12 | readme = "README.md" 13 | 14 | 15 | [[bin]] 16 | path = "src/bin.rs" 17 | name = "text-minimap" 18 | doc = false 19 | 20 | [lib] 21 | path = "lib/mod.rs" 22 | name = "text_minimap" 23 | 24 | [dependencies] 25 | clap = "2.23" 26 | itertools = "0.6.0" 27 | unicode-segmentation = "1.1.0" 28 | -------------------------------------------------------------------------------- /LICENSE-MPL2: -------------------------------------------------------------------------------- 1 | Mozilla Public License Version 2.0 2 | ================================== 3 | 4 | 1. Definitions 5 | -------------- 6 | 7 | 1.1. "Contributor" 8 | means each individual or legal entity that creates, contributes to 9 | the creation of, or owns Covered Software. 10 | 11 | 1.2. "Contributor Version" 12 | means the combination of the Contributions of others (if any) used 13 | by a Contributor and that particular Contributor's Contribution. 14 | 15 | 1.3. "Contribution" 16 | means Covered Software of a particular Contributor. 17 | 18 | 1.4. "Covered Software" 19 | means Source Code Form to which the initial Contributor has attached 20 | the notice in Exhibit A, the Executable Form of such Source Code 21 | Form, and Modifications of such Source Code Form, in each case 22 | including portions thereof. 23 | 24 | 1.5. "Incompatible With Secondary Licenses" 25 | means 26 | 27 | (a) that the initial Contributor has attached the notice described 28 | in Exhibit B to the Covered Software; or 29 | 30 | (b) that the Covered Software was made available under the terms of 31 | version 1.1 or earlier of the License, but not also under the 32 | terms of a Secondary License. 33 | 34 | 1.6. "Executable Form" 35 | means any form of the work other than Source Code Form. 36 | 37 | 1.7. "Larger Work" 38 | means a work that combines Covered Software with other material, in 39 | a separate file or files, that is not Covered Software. 40 | 41 | 1.8. "License" 42 | means this document. 43 | 44 | 1.9. "Licensable" 45 | means having the right to grant, to the maximum extent possible, 46 | whether at the time of the initial grant or subsequently, any and 47 | all of the rights conveyed by this License. 48 | 49 | 1.10. "Modifications" 50 | means any of the following: 51 | 52 | (a) any file in Source Code Form that results from an addition to, 53 | deletion from, or modification of the contents of Covered 54 | Software; or 55 | 56 | (b) any new file in Source Code Form that contains any Covered 57 | Software. 58 | 59 | 1.11. "Patent Claims" of a Contributor 60 | means any patent claim(s), including without limitation, method, 61 | process, and apparatus claims, in any patent Licensable by such 62 | Contributor that would be infringed, but for the grant of the 63 | License, by the making, using, selling, offering for sale, having 64 | made, import, or transfer of either its Contributions or its 65 | Contributor Version. 66 | 67 | 1.12. "Secondary License" 68 | means either the GNU General Public License, Version 2.0, the GNU 69 | Lesser General Public License, Version 2.1, the GNU Affero General 70 | Public License, Version 3.0, or any later versions of those 71 | licenses. 72 | 73 | 1.13. "Source Code Form" 74 | means the form of the work preferred for making modifications. 75 | 76 | 1.14. "You" (or "Your") 77 | means an individual or a legal entity exercising rights under this 78 | License. For legal entities, "You" includes any entity that 79 | controls, is controlled by, or is under common control with You. For 80 | purposes of this definition, "control" means (a) the power, direct 81 | or indirect, to cause the direction or management of such entity, 82 | whether by contract or otherwise, or (b) ownership of more than 83 | fifty percent (50%) of the outstanding shares or beneficial 84 | ownership of such entity. 85 | 86 | 2. License Grants and Conditions 87 | -------------------------------- 88 | 89 | 2.1. Grants 90 | 91 | Each Contributor hereby grants You a world-wide, royalty-free, 92 | non-exclusive license: 93 | 94 | (a) under intellectual property rights (other than patent or trademark) 95 | Licensable by such Contributor to use, reproduce, make available, 96 | modify, display, perform, distribute, and otherwise exploit its 97 | Contributions, either on an unmodified basis, with Modifications, or 98 | as part of a Larger Work; and 99 | 100 | (b) under Patent Claims of such Contributor to make, use, sell, offer 101 | for sale, have made, import, and otherwise transfer either its 102 | Contributions or its Contributor Version. 103 | 104 | 2.2. Effective Date 105 | 106 | The licenses granted in Section 2.1 with respect to any Contribution 107 | become effective for each Contribution on the date the Contributor first 108 | distributes such Contribution. 109 | 110 | 2.3. Limitations on Grant Scope 111 | 112 | The licenses granted in this Section 2 are the only rights granted under 113 | this License. No additional rights or licenses will be implied from the 114 | distribution or licensing of Covered Software under this License. 115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a 116 | Contributor: 117 | 118 | (a) for any code that a Contributor has removed from Covered Software; 119 | or 120 | 121 | (b) for infringements caused by: (i) Your and any other third party's 122 | modifications of Covered Software, or (ii) the combination of its 123 | Contributions with other software (except as part of its Contributor 124 | Version); or 125 | 126 | (c) under Patent Claims infringed by Covered Software in the absence of 127 | its Contributions. 128 | 129 | This License does not grant any rights in the trademarks, service marks, 130 | or logos of any Contributor (except as may be necessary to comply with 131 | the notice requirements in Section 3.4). 132 | 133 | 2.4. Subsequent Licenses 134 | 135 | No Contributor makes additional grants as a result of Your choice to 136 | distribute the Covered Software under a subsequent version of this 137 | License (see Section 10.2) or under the terms of a Secondary License (if 138 | permitted under the terms of Section 3.3). 139 | 140 | 2.5. Representation 141 | 142 | Each Contributor represents that the Contributor believes its 143 | Contributions are its original creation(s) or it has sufficient rights 144 | to grant the rights to its Contributions conveyed by this License. 145 | 146 | 2.6. Fair Use 147 | 148 | This License is not intended to limit any rights You have under 149 | applicable copyright doctrines of fair use, fair dealing, or other 150 | equivalents. 151 | 152 | 2.7. Conditions 153 | 154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted 155 | in Section 2.1. 156 | 157 | 3. Responsibilities 158 | ------------------- 159 | 160 | 3.1. Distribution of Source Form 161 | 162 | All distribution of Covered Software in Source Code Form, including any 163 | Modifications that You create or to which You contribute, must be under 164 | the terms of this License. You must inform recipients that the Source 165 | Code Form of the Covered Software is governed by the terms of this 166 | License, and how they can obtain a copy of this License. You may not 167 | attempt to alter or restrict the recipients' rights in the Source Code 168 | Form. 169 | 170 | 3.2. Distribution of Executable Form 171 | 172 | If You distribute Covered Software in Executable Form then: 173 | 174 | (a) such Covered Software must also be made available in Source Code 175 | Form, as described in Section 3.1, and You must inform recipients of 176 | the Executable Form how they can obtain a copy of such Source Code 177 | Form by reasonable means in a timely manner, at a charge no more 178 | than the cost of distribution to the recipient; and 179 | 180 | (b) You may distribute such Executable Form under the terms of this 181 | License, or sublicense it under different terms, provided that the 182 | license for the Executable Form does not attempt to limit or alter 183 | the recipients' rights in the Source Code Form under this License. 184 | 185 | 3.3. Distribution of a Larger Work 186 | 187 | You may create and distribute a Larger Work under terms of Your choice, 188 | provided that You also comply with the requirements of this License for 189 | the Covered Software. If the Larger Work is a combination of Covered 190 | Software with a work governed by one or more Secondary Licenses, and the 191 | Covered Software is not Incompatible With Secondary Licenses, this 192 | License permits You to additionally distribute such Covered Software 193 | under the terms of such Secondary License(s), so that the recipient of 194 | the Larger Work may, at their option, further distribute the Covered 195 | Software under the terms of either this License or such Secondary 196 | License(s). 197 | 198 | 3.4. Notices 199 | 200 | You may not remove or alter the substance of any license notices 201 | (including copyright notices, patent notices, disclaimers of warranty, 202 | or limitations of liability) contained within the Source Code Form of 203 | the Covered Software, except that You may alter any license notices to 204 | the extent required to remedy known factual inaccuracies. 205 | 206 | 3.5. Application of Additional Terms 207 | 208 | You may choose to offer, and to charge a fee for, warranty, support, 209 | indemnity or liability obligations to one or more recipients of Covered 210 | Software. However, You may do so only on Your own behalf, and not on 211 | behalf of any Contributor. You must make it absolutely clear that any 212 | such warranty, support, indemnity, or liability obligation is offered by 213 | You alone, and You hereby agree to indemnify every Contributor for any 214 | liability incurred by such Contributor as a result of warranty, support, 215 | indemnity or liability terms You offer. You may include additional 216 | disclaimers of warranty and limitations of liability specific to any 217 | jurisdiction. 218 | 219 | 4. Inability to Comply Due to Statute or Regulation 220 | --------------------------------------------------- 221 | 222 | If it is impossible for You to comply with any of the terms of this 223 | License with respect to some or all of the Covered Software due to 224 | statute, judicial order, or regulation then You must: (a) comply with 225 | the terms of this License to the maximum extent possible; and (b) 226 | describe the limitations and the code they affect. Such description must 227 | be placed in a text file included with all distributions of the Covered 228 | Software under this License. Except to the extent prohibited by statute 229 | or regulation, such description must be sufficiently detailed for a 230 | recipient of ordinary skill to be able to understand it. 231 | 232 | 5. Termination 233 | -------------- 234 | 235 | 5.1. The rights granted under this License will terminate automatically 236 | if You fail to comply with any of its terms. However, if You become 237 | compliant, then the rights granted under this License from a particular 238 | Contributor are reinstated (a) provisionally, unless and until such 239 | Contributor explicitly and finally terminates Your grants, and (b) on an 240 | ongoing basis, if such Contributor fails to notify You of the 241 | non-compliance by some reasonable means prior to 60 days after You have 242 | come back into compliance. Moreover, Your grants from a particular 243 | Contributor are reinstated on an ongoing basis if such Contributor 244 | notifies You of the non-compliance by some reasonable means, this is the 245 | first time You have received notice of non-compliance with this License 246 | from such Contributor, and You become compliant prior to 30 days after 247 | Your receipt of the notice. 248 | 249 | 5.2. If You initiate litigation against any entity by asserting a patent 250 | infringement claim (excluding declaratory judgment actions, 251 | counter-claims, and cross-claims) alleging that a Contributor Version 252 | directly or indirectly infringes any patent, then the rights granted to 253 | You by any and all Contributors for the Covered Software under Section 254 | 2.1 of this License shall terminate. 255 | 256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all 257 | end user license agreements (excluding distributors and resellers) which 258 | have been validly granted by You or Your distributors under this License 259 | prior to termination shall survive termination. 260 | 261 | ************************************************************************ 262 | * * 263 | * 6. Disclaimer of Warranty * 264 | * ------------------------- * 265 | * * 266 | * Covered Software is provided under this License on an "as is" * 267 | * basis, without warranty of any kind, either expressed, implied, or * 268 | * statutory, including, without limitation, warranties that the * 269 | * Covered Software is free of defects, merchantable, fit for a * 270 | * particular purpose or non-infringing. The entire risk as to the * 271 | * quality and performance of the Covered Software is with You. * 272 | * Should any Covered Software prove defective in any respect, You * 273 | * (not any Contributor) assume the cost of any necessary servicing, * 274 | * repair, or correction. This disclaimer of warranty constitutes an * 275 | * essential part of this License. No use of any Covered Software is * 276 | * authorized under this License except under this disclaimer. * 277 | * * 278 | ************************************************************************ 279 | 280 | ************************************************************************ 281 | * * 282 | * 7. Limitation of Liability * 283 | * -------------------------- * 284 | * * 285 | * Under no circumstances and under no legal theory, whether tort * 286 | * (including negligence), contract, or otherwise, shall any * 287 | * Contributor, or anyone who distributes Covered Software as * 288 | * permitted above, be liable to You for any direct, indirect, * 289 | * special, incidental, or consequential damages of any character * 290 | * including, without limitation, damages for lost profits, loss of * 291 | * goodwill, work stoppage, computer failure or malfunction, or any * 292 | * and all other commercial damages or losses, even if such party * 293 | * shall have been informed of the possibility of such damages. This * 294 | * limitation of liability shall not apply to liability for death or * 295 | * personal injury resulting from such party's negligence to the * 296 | * extent applicable law prohibits such limitation. Some * 297 | * jurisdictions do not allow the exclusion or limitation of * 298 | * incidental or consequential damages, so this exclusion and * 299 | * limitation may not apply to You. * 300 | * * 301 | ************************************************************************ 302 | 303 | 8. Litigation 304 | ------------- 305 | 306 | Any litigation relating to this License may be brought only in the 307 | courts of a jurisdiction where the defendant maintains its principal 308 | place of business and such litigation shall be governed by laws of that 309 | jurisdiction, without reference to its conflict-of-law provisions. 310 | Nothing in this Section shall prevent a party's ability to bring 311 | cross-claims or counter-claims. 312 | 313 | 9. Miscellaneous 314 | ---------------- 315 | 316 | This License represents the complete agreement concerning the subject 317 | matter hereof. If any provision of this License is held to be 318 | unenforceable, such provision shall be reformed only to the extent 319 | necessary to make it enforceable. Any law or regulation which provides 320 | that the language of a contract shall be construed against the drafter 321 | shall not be used to construe this License against a Contributor. 322 | 323 | 10. Versions of the License 324 | --------------------------- 325 | 326 | 10.1. New Versions 327 | 328 | Mozilla Foundation is the license steward. Except as provided in Section 329 | 10.3, no one other than the license steward has the right to modify or 330 | publish new versions of this License. Each version will be given a 331 | distinguishing version number. 332 | 333 | 10.2. Effect of New Versions 334 | 335 | You may distribute the Covered Software under the terms of the version 336 | of the License under which You originally received the Covered Software, 337 | or under the terms of any subsequent version published by the license 338 | steward. 339 | 340 | 10.3. Modified Versions 341 | 342 | If you create software not governed by this License, and you want to 343 | create a new license for such software, you may create and use a 344 | modified version of this License if you rename the license and remove 345 | any references to the name of the license steward (except to note that 346 | such modified license differs from this License). 347 | 348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary 349 | Licenses 350 | 351 | If You choose to distribute Source Code Form that is Incompatible With 352 | Secondary Licenses under the terms of this version of the License, the 353 | notice described in Exhibit B of this License must be attached. 354 | 355 | Exhibit A - Source Code Form License Notice 356 | ------------------------------------------- 357 | 358 | This Source Code Form is subject to the terms of the Mozilla Public 359 | License, v. 2.0. If a copy of the MPL was not distributed with this 360 | file, You can obtain one at http://mozilla.org/MPL/2.0/. 361 | 362 | If it is not possible or desirable to put the notice in a particular 363 | file, then You may include the notice in a location (such as a LICENSE 364 | file in a relevant directory) where a recipient would be likely to look 365 | for such a notice. 366 | 367 | You may add additional accurate notices of copyright ownership. 368 | 369 | Exhibit B - "Incompatible With Secondary Licenses" Notice 370 | --------------------------------------------------------- 371 | 372 | This Source Code Form is "Incompatible With Secondary Licenses", as 373 | defined by the Mozilla Public License, v. 2.0. 374 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | PKG_NAME=$(shell grep name Cargo.toml | head -n 1 | awk -F \" '{print $$2}') 2 | DOCS_DEFAULT_MODULE=$(subst -,_,$(PKG_NAME)) 3 | ifeq (, $(shell which cargo-check 2> /dev/null)) 4 | DEFAULT_TARGET=build 5 | else 6 | DEFAULT_TARGET=build 7 | endif 8 | 9 | default: $(DEFAULT_TARGET) 10 | 11 | CARGO_FLAGS += -v 12 | 13 | ALL_TARGETS += build $(EXAMPLES) test doc 14 | ifneq ($(RELEASE),) 15 | $(info RELEASE BUILD: $(PKG_NAME)) 16 | CARGO_FLAGS += --release 17 | else 18 | $(info DEBUG BUILD: $(PKG_NAME); use `RELEASE=true make [args]` for release build) 19 | endif 20 | 21 | EXAMPLES = $(shell cd examples 2>/dev/null && ls *.rs 2>/dev/null | sed -e 's/.rs$$//g' ) 22 | 23 | all: $(ALL_TARGETS) 24 | 25 | 26 | .PHONY: run test build doc clean clippy 27 | run test build clean: 28 | cargo $@ $(CARGO_FLAGS) 29 | 30 | check: 31 | $(info Running check; use `make build` to actually build) 32 | cargo $@ $(CARGO_FLAGS) 33 | 34 | clippy: 35 | cargo build --features clippy 36 | 37 | .PHONY: bench 38 | bench: 39 | cargo $@ $(filter-out --release,$(CARGO_FLAGS)) 40 | 41 | .PHONY: travistest 42 | travistest: test 43 | 44 | .PHONY: longtest 45 | longtest: 46 | @echo "Running longtest. Press Ctrl+C to stop at any time" 47 | @sleep 2 48 | @i=0; while i=$$((i + 1)) && echo "Iteration $$i" && make test ; do :; done 49 | 50 | .PHONY: $(EXAMPLES) 51 | $(EXAMPLES): 52 | cargo build --example $@ $(CARGO_FLAGS) 53 | 54 | .PHONY: doc 55 | doc: FORCE 56 | cargo doc 57 | 58 | .PHONY: publishdoc 59 | publishdoc: 60 | rm -rf target/doc 61 | make doc 62 | echo '' > target/doc/index.html 63 | ghp-import -n target/doc 64 | git push -f origin gh-pages 65 | 66 | .PHONY: docview 67 | docview: doc 68 | xdg-open target/doc/$(PKG_NAME)/index.html 69 | 70 | .PHONY: FORCE 71 | FORCE: 72 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | 3 | Travis CI Build Status 4 | 5 | 6 | 7 | text-minimap on crates.io 8 | 9 | 10 | 11 | text-minimap documentation on docs.rs 12 | 13 |

14 | 15 | # text-minimap - Generate text minimap/preview using Braille Patterns 16 | 17 | Library and command-line utility to efficiently generate minimap/preview 18 | of a given text. 19 | 20 | 21 | ![text-minimap example](http://i.imgur.com/JcR6rwS.png) 22 | 23 | ## Status 24 | 25 | * [x] Efficient io and streaming 26 | * [x] Multiple scaling settings 27 | * [ ] Tab (`\t`) width support 28 | * [ ] Soft-wrapping on text-width support 29 | * [ ] C API 30 | 31 | ## Alternatives 32 | 33 | * [wfxr/code-minimap](https://github.com/wfxr/code-minimap) - seems also written in Rust and with more effort put into it, so you probably should prefer it over this project; probably - I had no time to check the details myself; 34 | 35 | ## Installing 36 | 37 | If you don't have rust compiler and cargo installed follow instructions on 38 | https://www.rustup.rs/ . 39 | 40 | Afterwards: 41 | 42 | ``` 43 | cargo install text-minimap 44 | ``` 45 | 46 | ## Using 47 | 48 | Check `text-minimap --help` output. 49 | 50 | ## Verification Recommendation 51 | 52 | To help with the maintaince, the ownership of this crate is potentially shared between multiple developers. 53 | It is recommend to always use [cargo-crev](https://github.com/crev-dev/cargo-crev/tree/master/cargo-crev) 54 | to verify trustworthiness of each of your dependencies, including this one. 55 | -------------------------------------------------------------------------------- /lib/Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "lib" 3 | version = "0.1.0" 4 | authors = ["Dawid Ciężarkiewicz "] 5 | 6 | [dependencies] 7 | -------------------------------------------------------------------------------- /lib/mod.rs: -------------------------------------------------------------------------------- 1 | extern crate itertools; 2 | extern crate unicode_segmentation; 3 | 4 | use std::io::BufReader; 5 | use std::{io}; 6 | 7 | use itertools::Itertools; 8 | use std::io::BufRead; 9 | use unicode_segmentation::UnicodeSegmentation; 10 | 11 | const LOOKUP_TABLE : [char; 256] = 12 | [ 13 | '⠀', '⠁', '⠂', '⠃', '⠄', '⠅', '⠆', '⠇', '⡀', '⡁', '⡂', '⡃', '⡄', '⡅', '⡆', '⡇', 14 | '⠈', '⠉', '⠊', '⠋', '⠌', '⠍', '⠎', '⠏', '⡈', '⡉', '⡊', '⡋', '⡌', '⡍', '⡎', '⡏', 15 | '⠐', '⠑', '⠒', '⠓', '⠔', '⠕', '⠖', '⠗', '⡐', '⡑', '⡒', '⡓', '⡔', '⡕', '⡖', '⡗', 16 | '⠘', '⠙', '⠚', '⠛', '⠜', '⠝', '⠞', '⠟', '⡘', '⡙', '⡚', '⡛', '⡜', '⡝', '⡞', '⡟', 17 | '⠠', '⠡', '⠢', '⠣', '⠤', '⠥', '⠦', '⠧', '⡠', '⡡', '⡢', '⡣', '⡤', '⡥', '⡦', '⡧', 18 | '⠨', '⠩', '⠪', '⠫', '⠬', '⠭', '⠮', '⠯', '⡨', '⡩', '⡪', '⡫', '⡬', '⡭', '⡮', '⡯', 19 | '⠰', '⠱', '⠲', '⠳', '⠴', '⠵', '⠶', '⠷', '⡰', '⡱', '⡲', '⡳', '⡴', '⡵', '⡶', '⡷', 20 | '⠸', '⠹', '⠺', '⠻', '⠼', '⠽', '⠾', '⠿', '⡸', '⡹', '⡺', '⡻', '⡼', '⡽', '⡾', '⡿', 21 | '⢀', '⢁', '⢂', '⢃', '⢄', '⢅', '⢆', '⢇', '⣀', '⣁', '⣂', '⣃', '⣄', '⣅', '⣆', '⣇', 22 | '⢈', '⢉', '⢊', '⢋', '⢌', '⢍', '⢎', '⢏', '⣈', '⣉', '⣊', '⣋', '⣌', '⣍', '⣎', '⣏', 23 | '⢐', '⢑', '⢒', '⢓', '⢔', '⢕', '⢖', '⢗', '⣐', '⣑', '⣒', '⣓', '⣔', '⣕', '⣖', '⣗', 24 | '⢘', '⢙', '⢚', '⢛', '⢜', '⢝', '⢞', '⢟', '⣘', '⣙', '⣚', '⣛', '⣜', '⣝', '⣞', '⣟', 25 | '⢠', '⢡', '⢢', '⢣', '⢤', '⢥', '⢦', '⢧', '⣠', '⣡', '⣢', '⣣', '⣤', '⣥', '⣦', '⣧', 26 | '⢨', '⢩', '⢪', '⢫', '⢬', '⢭', '⢮', '⢯', '⣨', '⣩', '⣪', '⣫', '⣬', '⣭', '⣮', '⣯', 27 | '⢰', '⢱', '⢲', '⢳', '⢴', '⢵', '⢶', '⢷', '⣰', '⣱', '⣲', '⣳', '⣴', '⣵', '⣶', '⣷', 28 | '⢸', '⢹', '⢺', '⢻', '⢼', '⢽', '⢾', '⢿', '⣸', '⣹', '⣺', '⣻', '⣼', '⣽', '⣾', '⣿', 29 | ]; 30 | 31 | /// Convert simple binary representation that this crate 32 | /// uses to unicode character, by calculating the right unicode 33 | /// 34 | /// Unicode offset format 35 | /// 36 | /// ```norust 37 | /// 03 38 | /// 14 39 | /// 25 40 | /// 67 41 | /// ``` 42 | /// 43 | /// This crate format: 44 | /// ```norust 45 | /// 04 46 | /// 15 47 | /// 26 48 | /// 37 49 | /// ``` 50 | fn byte_to_braillechar(nb : u8) -> char { 51 | 52 | let nb = nb as u32; 53 | let mut ub = 0u32; 54 | ub |= ((nb >> 0) & 0x7) << 0; 55 | ub |= ((nb >> 4) & 0x7) << 3; 56 | ub |= ((nb >> 3) & 0x1) << 6; 57 | ub |= ((nb >> 7) & 0x1) << 7; 58 | 59 | 60 | 61 | std::char::from_u32(0x2800u32 + ub).unwrap() 62 | } 63 | 64 | #[allow(unused)] 65 | /// This is the script that generated `LOOKUP_TABLE` 66 | fn generate_lookup_table() { 67 | for bin2 in 0..16 { 68 | println!( 69 | "'{}', '{}', '{}', '{}', '{}', '{}', '{}', '{}', '{}', '{}', '{}', '{}', '{}', '{}', '{}', '{}',", 70 | byte_to_braillechar(bin2 * 16 + 0), 71 | byte_to_braillechar(bin2 * 16 + 1), 72 | byte_to_braillechar(bin2 * 16 + 2), 73 | byte_to_braillechar(bin2 * 16 + 3), 74 | byte_to_braillechar(bin2 * 16 + 4), 75 | byte_to_braillechar(bin2 * 16 + 5), 76 | byte_to_braillechar(bin2 * 16 + 6), 77 | byte_to_braillechar(bin2 * 16 + 7), 78 | byte_to_braillechar(bin2 * 16 + 8), 79 | byte_to_braillechar(bin2 * 16 + 9), 80 | byte_to_braillechar(bin2 * 16 + 10), 81 | byte_to_braillechar(bin2 * 16 + 11), 82 | byte_to_braillechar(bin2 * 16 + 12), 83 | byte_to_braillechar(bin2 * 16 + 13), 84 | byte_to_braillechar(bin2 * 16 + 14), 85 | byte_to_braillechar(bin2 * 16 + 15), 86 | ) 87 | } 88 | } 89 | 90 | const BRAILLE_Y :usize = 4; 91 | #[allow(unused)] 92 | const BRAILLE_X :usize = 2; 93 | 94 | /// Generate minimap/preview for the text read from `reader`j 95 | pub fn to_minimap<'a, R>(reader: R, settings: Settings) -> Box + 'a> 96 | where R: io::Read + 'a 97 | { 98 | 99 | let i = to_minimap_bool(reader, settings) 100 | .batching(move |i| { 101 | let mut group : Vec> = Vec::new(); 102 | for _ in 0..BRAILLE_Y { 103 | if let Some(line) = i.next() { 104 | group.push(line); 105 | } else { 106 | break; 107 | } 108 | } 109 | if group.is_empty() { 110 | None 111 | } else { 112 | Some(group) 113 | } 114 | }) 115 | // map to binary representations of 4 bits in every column 116 | .map(move |group| { 117 | let mut line_iters : Vec<_> = group 118 | .iter() 119 | .map(|line| line.iter()).collect(); 120 | 121 | let mut binary_column : Vec = Vec::new(); 122 | 123 | 124 | loop { 125 | // reset to false if anything was found 126 | let mut finished = true; 127 | 128 | let mut binary = 0; 129 | 130 | for (row_i, mut line_iter) in line_iters.iter_mut().enumerate() { 131 | if let Some(&printable) = line_iter.next() { 132 | finished = false; 133 | if printable { 134 | binary |= 1 << row_i; 135 | } 136 | } 137 | } 138 | 139 | if finished { 140 | break; 141 | } 142 | 143 | binary_column.push(binary) 144 | } 145 | 146 | binary_column 147 | }) 148 | .map(|line| { 149 | let mut s = String::new(); 150 | 151 | let mut iter = line.iter(); 152 | loop { 153 | let bin1 = iter.next(); 154 | let bin2 = iter.next(); 155 | 156 | if bin1.is_none() && bin2.is_none() { 157 | break; 158 | } 159 | 160 | let bin1 : u8 = *bin1.unwrap_or(&0); 161 | let bin2 : u8 = *bin2.unwrap_or(&0); 162 | 163 | debug_assert!(bin1 < 16); 164 | debug_assert!(bin2 < 16); 165 | 166 | let ch = LOOKUP_TABLE[(bin2 * 16 + bin1) as usize]; 167 | debug_assert_eq!(ch, byte_to_braillechar((bin2 * 16 + bin1))); 168 | s.push(ch) 169 | } 170 | 171 | s 172 | }); 173 | 174 | Box::new(i) 175 | } 176 | 177 | #[allow(unused)] 178 | fn to_minimap_stars<'a, R>(reader: R, settings: Settings) -> Box + 'a> 179 | where R: io::Read + 'a 180 | { 181 | 182 | let i = to_minimap_bool(reader, settings) 183 | .map(|dots| { 184 | let v : Vec<_> = dots.iter().map(|&b| if b { "*" } else { " " }).collect(); 185 | let line : String = v.join(""); 186 | line 187 | }); 188 | 189 | Box::new(i) 190 | } 191 | 192 | fn to_minimap_bool<'a, R>(reader: R, 193 | settings: Settings) 194 | -> Box> + 'a> 195 | where R: io::Read + 'a 196 | { 197 | 198 | let buf_reader = BufReader::new(reader); 199 | 200 | let xscale = settings.xscale; 201 | let yscale = settings.yscale; 202 | 203 | let i = buf_reader 204 | .lines() 205 | .take_while(|b| b.is_ok()) 206 | .map(|b| b.unwrap()) 207 | // iterate over groups of n lines 208 | .batching(move |i| { 209 | let mut group : Vec = Vec::new(); 210 | for _ in 0..yscale { 211 | if let Some(line) = i.next() { 212 | group.push(line); 213 | } else { 214 | break; 215 | } 216 | } 217 | if group.is_empty() { 218 | None 219 | } else { 220 | Some(group) 221 | } 222 | }) 223 | .map(move |group| { 224 | let mut line_iters : Vec<_> = group 225 | .iter() 226 | .map(|line| UnicodeSegmentation::graphemes(line.as_str(), true)).collect(); 227 | 228 | let mut dots : Vec = Vec::new(); 229 | loop { 230 | let mut in_this_column : Vec = Vec::new(); 231 | for line_iter in &mut line_iters { 232 | let mut contains_nonwhite = None; 233 | 234 | for _ in 0..xscale { 235 | if let Some(glyph) = line_iter.next() { 236 | if contains_nonwhite != Some(true) { 237 | if glyph.chars().any(|ch| !ch.is_whitespace()) { 238 | contains_nonwhite = Some(true); 239 | } else { 240 | contains_nonwhite = Some(false); 241 | } 242 | } 243 | } 244 | } 245 | 246 | if let Some(nw) = contains_nonwhite { 247 | in_this_column.push(nw) 248 | } 249 | } 250 | 251 | if in_this_column.is_empty() { 252 | break; 253 | } 254 | 255 | dots.push(in_this_column.iter().any(|&g| g )) 256 | } 257 | dots 258 | }); 259 | 260 | Box::new(i) 261 | } 262 | 263 | #[derive(Clone)] 264 | pub struct Settings { 265 | pub xscale: usize, 266 | pub yscale: usize, 267 | } 268 | 269 | impl Settings { 270 | pub fn new() -> Self { 271 | Settings { 272 | xscale: 1, 273 | yscale: 1, 274 | } 275 | } 276 | } 277 | 278 | -------------------------------------------------------------------------------- /lib/src/lib.rs: -------------------------------------------------------------------------------- 1 | #[cfg(test)] 2 | mod tests { 3 | #[test] 4 | fn it_works() { 5 | } 6 | } 7 | -------------------------------------------------------------------------------- /src/bin.rs: -------------------------------------------------------------------------------- 1 | extern crate text_minimap; 2 | extern crate clap; 3 | 4 | use std::{fs, io}; 5 | 6 | use text_minimap::*; 7 | 8 | use clap::{Arg, App}; 9 | 10 | fn main() { 11 | let arguments = App::new("text-minimap") 12 | .version(env!("CARGO_PKG_VERSION")) 13 | .author("Dawid Ciężarkiewicz ") 14 | .about("Convert text to a minimap consisting of Unicode braille characters") 15 | .arg(Arg::with_name("FILE") 16 | .short("f") 17 | .long("file") 18 | .takes_value(true) 19 | .help("File to read input from, instead of stdin")) 20 | .arg(Arg::with_name("OUT_FILE") 21 | .short("o") 22 | .long("output") 23 | .takes_value(true) 24 | .help("File to write output to, instead of stdout")) 25 | .arg(Arg::with_name("XSCALE") 26 | .short("x") 27 | .long("xscale") 28 | .takes_value(true) 29 | .help("Number of characters width-wise to represent as a single dot")) 30 | .arg(Arg::with_name("YSCALE") 31 | .short("y") 32 | .long("yscale") 33 | .takes_value(true) 34 | .help("Number of characters height-wise to represent as a single dot")) 35 | .get_matches(); 36 | 37 | let mut settings = Settings::new(); 38 | 39 | settings.xscale = arguments 40 | .value_of("XSCALE") 41 | .unwrap_or("1") 42 | .parse::() 43 | .unwrap(); 44 | 45 | settings.yscale = arguments 46 | .value_of("YSCALE") 47 | .unwrap_or("1") 48 | .parse::() 49 | .unwrap(); 50 | 51 | let stdin = std::io::stdin(); 52 | let input: Box = if let Some(in_path) = arguments.value_of("FILE") { 53 | let file = fs::File::open(in_path).unwrap(); 54 | 55 | Box::new(file) 56 | } else { 57 | let stdin = stdin.lock(); 58 | 59 | Box::new(stdin) 60 | }; 61 | 62 | let mut output: Box = if let Some(out_path) = arguments.value_of("OUT_FILE") { 63 | let file = fs::OpenOptions::new() 64 | .create(true) 65 | .append(true) 66 | .open(out_path) 67 | .unwrap(); 68 | Box::new(file) 69 | } else { 70 | let stdout = std::io::stdout(); 71 | Box::new(stdout) 72 | }; 73 | 74 | for line in to_minimap(input, settings) { 75 | writeln!(output, "{}", line).unwrap(); 76 | } 77 | } 78 | --------------------------------------------------------------------------------