├── .gitignore ├── .img └── hV3BeXWDTmREm8ujOkR3v6903.png ├── Cargo.lock ├── Cargo.toml ├── LICENSE ├── README.md └── src └── main.rs /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | -------------------------------------------------------------------------------- /.img/hV3BeXWDTmREm8ujOkR3v6903.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/JojiiOfficial/jisho-cli/9b2e51fee318fc9dddadeb37c1b317de2c321f8a/.img/hV3BeXWDTmREm8ujOkR3v6903.png -------------------------------------------------------------------------------- /Cargo.lock: -------------------------------------------------------------------------------- 1 | # This file is automatically @generated by Cargo. 2 | # It is not intended for manual editing. 3 | version = 3 4 | 5 | [[package]] 6 | name = "ansi_term" 7 | version = "0.12.1" 8 | source = "registry+https://github.com/rust-lang/crates.io-index" 9 | checksum = "d52a9bb7ec0cf484c551830a7ce27bd20d67eac647e1befb56b0be4ee39a55d2" 10 | dependencies = [ 11 | "winapi", 12 | ] 13 | 14 | [[package]] 15 | name = "argparse" 16 | version = "0.2.2" 17 | source = "registry+https://github.com/rust-lang/crates.io-index" 18 | checksum = "3f8ebf5827e4ac4fd5946560e6a99776ea73b596d80898f357007317a7141e47" 19 | 20 | [[package]] 21 | name = "atty" 22 | version = "0.2.14" 23 | source = "registry+https://github.com/rust-lang/crates.io-index" 24 | checksum = "d9b39be18770d11421cdb1b9947a45dd3f37e93092cbf377614828a319d5fee8" 25 | dependencies = [ 26 | "hermit-abi", 27 | "libc", 28 | "winapi", 29 | ] 30 | 31 | [[package]] 32 | name = "base64" 33 | version = "0.13.0" 34 | source = "registry+https://github.com/rust-lang/crates.io-index" 35 | checksum = "904dfeac50f3cdaba28fc6f57fdcddb75f49ed61346676a78c4ffe55877802fd" 36 | 37 | [[package]] 38 | name = "bumpalo" 39 | version = "3.6.1" 40 | source = "registry+https://github.com/rust-lang/crates.io-index" 41 | checksum = "63396b8a4b9de3f4fdfb320ab6080762242f66a8ef174c49d8e19b674db4cdbe" 42 | 43 | [[package]] 44 | name = "cc" 45 | version = "1.0.67" 46 | source = "registry+https://github.com/rust-lang/crates.io-index" 47 | checksum = "e3c69b077ad434294d3ce9f1f6143a2a4b89a8a2d54ef813d85003a4fd1137fd" 48 | 49 | [[package]] 50 | name = "cfg-if" 51 | version = "1.0.0" 52 | source = "registry+https://github.com/rust-lang/crates.io-index" 53 | checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" 54 | 55 | [[package]] 56 | name = "chunked_transfer" 57 | version = "1.4.0" 58 | source = "registry+https://github.com/rust-lang/crates.io-index" 59 | checksum = "fff857943da45f546682664a79488be82e69e43c1a7a2307679ab9afb3a66d2e" 60 | 61 | [[package]] 62 | name = "colored" 63 | version = "2.0.0" 64 | source = "registry+https://github.com/rust-lang/crates.io-index" 65 | checksum = "b3616f750b84d8f0de8a58bda93e08e2a81ad3f523089b05f1dffecab48c6cbd" 66 | dependencies = [ 67 | "atty", 68 | "lazy_static", 69 | "winapi", 70 | ] 71 | 72 | [[package]] 73 | name = "form_urlencoded" 74 | version = "1.0.1" 75 | source = "registry+https://github.com/rust-lang/crates.io-index" 76 | checksum = "5fc25a87fa4fd2094bffb06925852034d90a17f0d1e05197d4956d3555752191" 77 | dependencies = [ 78 | "matches", 79 | "percent-encoding", 80 | ] 81 | 82 | [[package]] 83 | name = "hermit-abi" 84 | version = "0.1.18" 85 | source = "registry+https://github.com/rust-lang/crates.io-index" 86 | checksum = "322f4de77956e22ed0e5032c359a0f1273f1f7f0d79bfa3b8ffbc730d7fbcc5c" 87 | dependencies = [ 88 | "libc", 89 | ] 90 | 91 | [[package]] 92 | name = "idna" 93 | version = "0.2.2" 94 | source = "registry+https://github.com/rust-lang/crates.io-index" 95 | checksum = "89829a5d69c23d348314a7ac337fe39173b61149a9864deabd260983aed48c21" 96 | dependencies = [ 97 | "matches", 98 | "unicode-bidi", 99 | "unicode-normalization", 100 | ] 101 | 102 | [[package]] 103 | name = "itoa" 104 | version = "0.4.7" 105 | source = "registry+https://github.com/rust-lang/crates.io-index" 106 | checksum = "dd25036021b0de88a0aff6b850051563c6516d0bf53f8638938edbb9de732736" 107 | 108 | [[package]] 109 | name = "jisho-cli" 110 | version = "0.1.4" 111 | dependencies = [ 112 | "ansi_term", 113 | "argparse", 114 | "atty", 115 | "colored", 116 | "libc", 117 | "serde_json", 118 | "ureq", 119 | "webbrowser", 120 | "windows-sys", 121 | ] 122 | 123 | [[package]] 124 | name = "js-sys" 125 | version = "0.3.50" 126 | source = "registry+https://github.com/rust-lang/crates.io-index" 127 | checksum = "2d99f9e3e84b8f67f846ef5b4cbbc3b1c29f6c759fcbce6f01aa0e73d932a24c" 128 | dependencies = [ 129 | "wasm-bindgen", 130 | ] 131 | 132 | [[package]] 133 | name = "lazy_static" 134 | version = "1.4.0" 135 | source = "registry+https://github.com/rust-lang/crates.io-index" 136 | checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646" 137 | 138 | [[package]] 139 | name = "libc" 140 | version = "0.2.139" 141 | source = "registry+https://github.com/rust-lang/crates.io-index" 142 | checksum = "201de327520df007757c1f0adce6e827fe8562fbc28bfd9c15571c66ca1f5f79" 143 | 144 | [[package]] 145 | name = "log" 146 | version = "0.4.14" 147 | source = "registry+https://github.com/rust-lang/crates.io-index" 148 | checksum = "51b9bbe6c47d51fc3e1a9b945965946b4c44142ab8792c50835a980d362c2710" 149 | dependencies = [ 150 | "cfg-if", 151 | ] 152 | 153 | [[package]] 154 | name = "matches" 155 | version = "0.1.8" 156 | source = "registry+https://github.com/rust-lang/crates.io-index" 157 | checksum = "7ffc5c5338469d4d3ea17d269fa8ea3512ad247247c30bd2df69e68309ed0a08" 158 | 159 | [[package]] 160 | name = "once_cell" 161 | version = "1.7.2" 162 | source = "registry+https://github.com/rust-lang/crates.io-index" 163 | checksum = "af8b08b04175473088b46763e51ee54da5f9a164bc162f615b91bc179dbf15a3" 164 | 165 | [[package]] 166 | name = "percent-encoding" 167 | version = "2.1.0" 168 | source = "registry+https://github.com/rust-lang/crates.io-index" 169 | checksum = "d4fd5641d01c8f18a23da7b6fe29298ff4b55afcccdf78973b24cf3175fee32e" 170 | 171 | [[package]] 172 | name = "proc-macro2" 173 | version = "1.0.26" 174 | source = "registry+https://github.com/rust-lang/crates.io-index" 175 | checksum = "a152013215dca273577e18d2bf00fa862b89b24169fb78c4c95aeb07992c9cec" 176 | dependencies = [ 177 | "unicode-xid", 178 | ] 179 | 180 | [[package]] 181 | name = "quote" 182 | version = "1.0.9" 183 | source = "registry+https://github.com/rust-lang/crates.io-index" 184 | checksum = "c3d0b9745dc2debf507c8422de05d7226cc1f0644216dfdfead988f9b1ab32a7" 185 | dependencies = [ 186 | "proc-macro2", 187 | ] 188 | 189 | [[package]] 190 | name = "ring" 191 | version = "0.16.20" 192 | source = "registry+https://github.com/rust-lang/crates.io-index" 193 | checksum = "3053cf52e236a3ed746dfc745aa9cacf1b791d846bdaf412f60a8d7d6e17c8fc" 194 | dependencies = [ 195 | "cc", 196 | "libc", 197 | "once_cell", 198 | "spin", 199 | "untrusted", 200 | "web-sys", 201 | "winapi", 202 | ] 203 | 204 | [[package]] 205 | name = "rustls" 206 | version = "0.19.0" 207 | source = "registry+https://github.com/rust-lang/crates.io-index" 208 | checksum = "064fd21ff87c6e87ed4506e68beb42459caa4a0e2eb144932e6776768556980b" 209 | dependencies = [ 210 | "base64", 211 | "log", 212 | "ring", 213 | "sct", 214 | "webpki", 215 | ] 216 | 217 | [[package]] 218 | name = "ryu" 219 | version = "1.0.5" 220 | source = "registry+https://github.com/rust-lang/crates.io-index" 221 | checksum = "71d301d4193d031abdd79ff7e3dd721168a9572ef3fe51a1517aba235bd8f86e" 222 | 223 | [[package]] 224 | name = "sct" 225 | version = "0.6.0" 226 | source = "registry+https://github.com/rust-lang/crates.io-index" 227 | checksum = "e3042af939fca8c3453b7af0f1c66e533a15a86169e39de2657310ade8f98d3c" 228 | dependencies = [ 229 | "ring", 230 | "untrusted", 231 | ] 232 | 233 | [[package]] 234 | name = "serde" 235 | version = "1.0.125" 236 | source = "registry+https://github.com/rust-lang/crates.io-index" 237 | checksum = "558dc50e1a5a5fa7112ca2ce4effcb321b0300c0d4ccf0776a9f60cd89031171" 238 | 239 | [[package]] 240 | name = "serde_json" 241 | version = "1.0.64" 242 | source = "registry+https://github.com/rust-lang/crates.io-index" 243 | checksum = "799e97dc9fdae36a5c8b8f2cae9ce2ee9fdce2058c57a93e6099d919fd982f79" 244 | dependencies = [ 245 | "itoa", 246 | "ryu", 247 | "serde", 248 | ] 249 | 250 | [[package]] 251 | name = "spin" 252 | version = "0.5.2" 253 | source = "registry+https://github.com/rust-lang/crates.io-index" 254 | checksum = "6e63cff320ae2c57904679ba7cb63280a3dc4613885beafb148ee7bf9aa9042d" 255 | 256 | [[package]] 257 | name = "syn" 258 | version = "1.0.68" 259 | source = "registry+https://github.com/rust-lang/crates.io-index" 260 | checksum = "3ce15dd3ed8aa2f8eeac4716d6ef5ab58b6b9256db41d7e1a0224c2788e8fd87" 261 | dependencies = [ 262 | "proc-macro2", 263 | "quote", 264 | "unicode-xid", 265 | ] 266 | 267 | [[package]] 268 | name = "tinyvec" 269 | version = "1.2.0" 270 | source = "registry+https://github.com/rust-lang/crates.io-index" 271 | checksum = "5b5220f05bb7de7f3f53c7c065e1199b3172696fe2db9f9c4d8ad9b4ee74c342" 272 | dependencies = [ 273 | "tinyvec_macros", 274 | ] 275 | 276 | [[package]] 277 | name = "tinyvec_macros" 278 | version = "0.1.0" 279 | source = "registry+https://github.com/rust-lang/crates.io-index" 280 | checksum = "cda74da7e1a664f795bb1f8a87ec406fb89a02522cf6e50620d016add6dbbf5c" 281 | 282 | [[package]] 283 | name = "unicode-bidi" 284 | version = "0.3.5" 285 | source = "registry+https://github.com/rust-lang/crates.io-index" 286 | checksum = "eeb8be209bb1c96b7c177c7420d26e04eccacb0eeae6b980e35fcb74678107e0" 287 | dependencies = [ 288 | "matches", 289 | ] 290 | 291 | [[package]] 292 | name = "unicode-normalization" 293 | version = "0.1.17" 294 | source = "registry+https://github.com/rust-lang/crates.io-index" 295 | checksum = "07fbfce1c8a97d547e8b5334978438d9d6ec8c20e38f56d4a4374d181493eaef" 296 | dependencies = [ 297 | "tinyvec", 298 | ] 299 | 300 | [[package]] 301 | name = "unicode-xid" 302 | version = "0.2.1" 303 | source = "registry+https://github.com/rust-lang/crates.io-index" 304 | checksum = "f7fe0bb3479651439c9112f72b6c505038574c9fbb575ed1bf3b797fa39dd564" 305 | 306 | [[package]] 307 | name = "untrusted" 308 | version = "0.7.1" 309 | source = "registry+https://github.com/rust-lang/crates.io-index" 310 | checksum = "a156c684c91ea7d62626509bce3cb4e1d9ed5c4d978f7b4352658f96a4c26b4a" 311 | 312 | [[package]] 313 | name = "ureq" 314 | version = "2.1.0" 315 | source = "registry+https://github.com/rust-lang/crates.io-index" 316 | checksum = "6fbeb1aabb07378cf0e084971a74f24241273304653184f54cdce113c0d7df1b" 317 | dependencies = [ 318 | "base64", 319 | "chunked_transfer", 320 | "log", 321 | "once_cell", 322 | "rustls", 323 | "serde", 324 | "serde_json", 325 | "url", 326 | "webpki", 327 | "webpki-roots", 328 | ] 329 | 330 | [[package]] 331 | name = "url" 332 | version = "2.2.1" 333 | source = "registry+https://github.com/rust-lang/crates.io-index" 334 | checksum = "9ccd964113622c8e9322cfac19eb1004a07e636c545f325da085d5cdde6f1f8b" 335 | dependencies = [ 336 | "form_urlencoded", 337 | "idna", 338 | "matches", 339 | "percent-encoding", 340 | ] 341 | 342 | [[package]] 343 | name = "wasm-bindgen" 344 | version = "0.2.73" 345 | source = "registry+https://github.com/rust-lang/crates.io-index" 346 | checksum = "83240549659d187488f91f33c0f8547cbfef0b2088bc470c116d1d260ef623d9" 347 | dependencies = [ 348 | "cfg-if", 349 | "wasm-bindgen-macro", 350 | ] 351 | 352 | [[package]] 353 | name = "wasm-bindgen-backend" 354 | version = "0.2.73" 355 | source = "registry+https://github.com/rust-lang/crates.io-index" 356 | checksum = "ae70622411ca953215ca6d06d3ebeb1e915f0f6613e3b495122878d7ebec7dae" 357 | dependencies = [ 358 | "bumpalo", 359 | "lazy_static", 360 | "log", 361 | "proc-macro2", 362 | "quote", 363 | "syn", 364 | "wasm-bindgen-shared", 365 | ] 366 | 367 | [[package]] 368 | name = "wasm-bindgen-macro" 369 | version = "0.2.73" 370 | source = "registry+https://github.com/rust-lang/crates.io-index" 371 | checksum = "3e734d91443f177bfdb41969de821e15c516931c3c3db3d318fa1b68975d0f6f" 372 | dependencies = [ 373 | "quote", 374 | "wasm-bindgen-macro-support", 375 | ] 376 | 377 | [[package]] 378 | name = "wasm-bindgen-macro-support" 379 | version = "0.2.73" 380 | source = "registry+https://github.com/rust-lang/crates.io-index" 381 | checksum = "d53739ff08c8a68b0fdbcd54c372b8ab800b1449ab3c9d706503bc7dd1621b2c" 382 | dependencies = [ 383 | "proc-macro2", 384 | "quote", 385 | "syn", 386 | "wasm-bindgen-backend", 387 | "wasm-bindgen-shared", 388 | ] 389 | 390 | [[package]] 391 | name = "wasm-bindgen-shared" 392 | version = "0.2.73" 393 | source = "registry+https://github.com/rust-lang/crates.io-index" 394 | checksum = "d9a543ae66aa233d14bb765ed9af4a33e81b8b58d1584cf1b47ff8cd0b9e4489" 395 | 396 | [[package]] 397 | name = "web-sys" 398 | version = "0.3.50" 399 | source = "registry+https://github.com/rust-lang/crates.io-index" 400 | checksum = "a905d57e488fec8861446d3393670fb50d27a262344013181c2cdf9fff5481be" 401 | dependencies = [ 402 | "js-sys", 403 | "wasm-bindgen", 404 | ] 405 | 406 | [[package]] 407 | name = "webbrowser" 408 | version = "0.5.5" 409 | source = "registry+https://github.com/rust-lang/crates.io-index" 410 | checksum = "ecad156490d6b620308ed411cfee90d280b3cbd13e189ea0d3fada8acc89158a" 411 | dependencies = [ 412 | "web-sys", 413 | "widestring", 414 | "winapi", 415 | ] 416 | 417 | [[package]] 418 | name = "webpki" 419 | version = "0.21.4" 420 | source = "registry+https://github.com/rust-lang/crates.io-index" 421 | checksum = "b8e38c0608262c46d4a56202ebabdeb094cef7e560ca7a226c6bf055188aa4ea" 422 | dependencies = [ 423 | "ring", 424 | "untrusted", 425 | ] 426 | 427 | [[package]] 428 | name = "webpki-roots" 429 | version = "0.21.1" 430 | source = "registry+https://github.com/rust-lang/crates.io-index" 431 | checksum = "aabe153544e473b775453675851ecc86863d2a81d786d741f6b76778f2a48940" 432 | dependencies = [ 433 | "webpki", 434 | ] 435 | 436 | [[package]] 437 | name = "widestring" 438 | version = "0.4.3" 439 | source = "registry+https://github.com/rust-lang/crates.io-index" 440 | checksum = "c168940144dd21fd8046987c16a46a33d5fc84eec29ef9dcddc2ac9e31526b7c" 441 | 442 | [[package]] 443 | name = "winapi" 444 | version = "0.3.9" 445 | source = "registry+https://github.com/rust-lang/crates.io-index" 446 | checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419" 447 | dependencies = [ 448 | "winapi-i686-pc-windows-gnu", 449 | "winapi-x86_64-pc-windows-gnu", 450 | ] 451 | 452 | [[package]] 453 | name = "winapi-i686-pc-windows-gnu" 454 | version = "0.4.0" 455 | source = "registry+https://github.com/rust-lang/crates.io-index" 456 | checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" 457 | 458 | [[package]] 459 | name = "winapi-x86_64-pc-windows-gnu" 460 | version = "0.4.0" 461 | source = "registry+https://github.com/rust-lang/crates.io-index" 462 | checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" 463 | 464 | [[package]] 465 | name = "windows-sys" 466 | version = "0.45.0" 467 | source = "registry+https://github.com/rust-lang/crates.io-index" 468 | checksum = "75283be5efb2831d37ea142365f009c02ec203cd29a3ebecbc093d52315b66d0" 469 | dependencies = [ 470 | "windows-targets", 471 | ] 472 | 473 | [[package]] 474 | name = "windows-targets" 475 | version = "0.42.1" 476 | source = "registry+https://github.com/rust-lang/crates.io-index" 477 | checksum = "8e2522491fbfcd58cc84d47aeb2958948c4b8982e9a2d8a2a35bbaed431390e7" 478 | dependencies = [ 479 | "windows_aarch64_gnullvm", 480 | "windows_aarch64_msvc", 481 | "windows_i686_gnu", 482 | "windows_i686_msvc", 483 | "windows_x86_64_gnu", 484 | "windows_x86_64_gnullvm", 485 | "windows_x86_64_msvc", 486 | ] 487 | 488 | [[package]] 489 | name = "windows_aarch64_gnullvm" 490 | version = "0.42.1" 491 | source = "registry+https://github.com/rust-lang/crates.io-index" 492 | checksum = "8c9864e83243fdec7fc9c5444389dcbbfd258f745e7853198f365e3c4968a608" 493 | 494 | [[package]] 495 | name = "windows_aarch64_msvc" 496 | version = "0.42.1" 497 | source = "registry+https://github.com/rust-lang/crates.io-index" 498 | checksum = "4c8b1b673ffc16c47a9ff48570a9d85e25d265735c503681332589af6253c6c7" 499 | 500 | [[package]] 501 | name = "windows_i686_gnu" 502 | version = "0.42.1" 503 | source = "registry+https://github.com/rust-lang/crates.io-index" 504 | checksum = "de3887528ad530ba7bdbb1faa8275ec7a1155a45ffa57c37993960277145d640" 505 | 506 | [[package]] 507 | name = "windows_i686_msvc" 508 | version = "0.42.1" 509 | source = "registry+https://github.com/rust-lang/crates.io-index" 510 | checksum = "bf4d1122317eddd6ff351aa852118a2418ad4214e6613a50e0191f7004372605" 511 | 512 | [[package]] 513 | name = "windows_x86_64_gnu" 514 | version = "0.42.1" 515 | source = "registry+https://github.com/rust-lang/crates.io-index" 516 | checksum = "c1040f221285e17ebccbc2591ffdc2d44ee1f9186324dd3e84e99ac68d699c45" 517 | 518 | [[package]] 519 | name = "windows_x86_64_gnullvm" 520 | version = "0.42.1" 521 | source = "registry+https://github.com/rust-lang/crates.io-index" 522 | checksum = "628bfdf232daa22b0d64fdb62b09fcc36bb01f05a3939e20ab73aaf9470d0463" 523 | 524 | [[package]] 525 | name = "windows_x86_64_msvc" 526 | version = "0.42.1" 527 | source = "registry+https://github.com/rust-lang/crates.io-index" 528 | checksum = "447660ad36a13288b1db4d4248e857b510e8c3a225c822ba4fb748c0aafecffd" 529 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "jisho-cli" 3 | description = "A very simple cli tool to lookup Japanese words using jisho.org" 4 | version = "0.1.4" 5 | authors = ["jojii "] 6 | readme = "README.md" 7 | repository = "https://github.com/JojiiOfficial/jisho-cli" 8 | license = "GPL-3.0" 9 | edition = "2018" 10 | 11 | [target.'cfg(windows)'.dependencies] 12 | windows-sys = { version = "0.45.0", features = ["Win32_Foundation", "Win32_System_Console"] } 13 | 14 | [dependencies] 15 | ureq = { version = "2.1.0", features = ["json"] } 16 | libc = "0.2.139" 17 | serde_json = "1.0.64" 18 | ansi_term = "0.12.1" 19 | colored = "2.0.0" 20 | argparse = "0.2.2" 21 | webbrowser = "0.5.5" 22 | atty = "0.2" 23 | 24 | [features] 25 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Jisho (cli) 2 | A very simple cli tool to look up Japanese words using jisho.org's API 3 | 4 |
5 | 6 | 7 | # Installation 8 | 9 | From [Release tab](https://github.com/JojiiOfficial/jisho-cli/releases) 10 |
11 | > Simply download the binary 12 |
13 | 14 | From my [Arch repository](https://repo.jojii.de) 15 | ``` 16 | sudo pacman -S jisho 17 | ``` 18 | 19 | From crates.io: 20 | ``` 21 | cargo install jisho-cli 22 | ``` 23 | 24 | From AUR: 25 | ``` 26 | yay -S jisho 27 | ``` 28 | 29 |
30 | 31 | # Usage 32 | ``` 33 | jisho [] 34 | ``` 35 | 36 | > Note: The binary from crates.io is called `jisho-cli`, not `jisho`
37 | > Note: You can use spaces 38 | -------------------------------------------------------------------------------- /src/main.rs: -------------------------------------------------------------------------------- 1 | use std::{ 2 | io::{stdin, stdout, Write}, 3 | process::{Command, Stdio}, 4 | thread::{self, JoinHandle}, 5 | env, 6 | }; 7 | 8 | use argparse::{ArgumentParser, List, Print, Store, StoreTrue}; 9 | use colored::*; 10 | use serde_json::Value; 11 | use atty::Stream; 12 | 13 | macro_rules! JISHO_URL { 14 | () => { 15 | "https://jisho.org/api/v1/search/words?keyword={}" 16 | }; 17 | } 18 | 19 | #[derive(Debug, Clone)] 20 | struct Options { 21 | limit: usize, 22 | query: String, 23 | kanji: bool, // Sadly not (yet) supported by jisho.org's API 24 | interactive: bool, 25 | } 26 | 27 | impl Default for Options { 28 | fn default() -> Self { 29 | Self { 30 | limit: 0, 31 | query: String::default(), 32 | kanji: false, 33 | interactive: false, 34 | } 35 | } 36 | } 37 | 38 | fn main() -> Result<(), ureq::Error> { 39 | let term_size; 40 | 41 | if atty::is(Stream::Stdout) { 42 | term_size = terminal_size().unwrap_or(0); 43 | } else { 44 | term_size = 0; 45 | } 46 | 47 | let options = parse_args(); 48 | 49 | let mut query = { 50 | if options.interactive { 51 | let mut o = String::new(); 52 | while o.trim().is_empty() { 53 | print!("=> "); 54 | stdout().flush().unwrap(); 55 | stdin().read_line(&mut o).expect("Can't read from stdin"); 56 | } 57 | o 58 | } else { 59 | options.query.clone() 60 | } 61 | }; 62 | 63 | loop { 64 | let mut lines_output = 0; 65 | let mut output = String::new(); 66 | 67 | if options.kanji { 68 | // Open kanji page here 69 | let threads = query 70 | .chars() 71 | .into_iter() 72 | .map(|kanji| { 73 | let kanji = kanji.clone(); 74 | thread::spawn(move || { 75 | webbrowser::open(&format!("https://jisho.org/search/{}%23kanji", kanji)) 76 | .expect("Couldn't open browser"); 77 | }) 78 | }) 79 | .collect::>>(); 80 | 81 | for thread in threads { 82 | thread.join().unwrap(); 83 | } 84 | } else { 85 | // Do API request 86 | let body: Value = ureq::get(&format!(JISHO_URL!(), query)) 87 | .call()? 88 | .into_json()?; 89 | 90 | // Try to get the data json-object 91 | let body = value_to_arr({ 92 | let body = body.get("data"); 93 | 94 | if body.is_none() { 95 | eprintln!("Error! Invalid response"); 96 | return Ok(()); 97 | } 98 | 99 | body.unwrap() 100 | }); 101 | 102 | if options.interactive { 103 | println!(); 104 | } 105 | 106 | // Iterate over meanings and print them 107 | for (i, entry) in body.iter().enumerate() { 108 | if i >= options.limit && options.limit != 0 { 109 | break; 110 | } 111 | match print_item(&query, entry, &mut output) { 112 | Some(r) => lines_output += r, 113 | None => continue, 114 | } 115 | 116 | output.push('\n'); 117 | lines_output += 1; 118 | } 119 | output.pop(); 120 | if lines_output > 0 { 121 | lines_output -= 1; 122 | } 123 | 124 | } 125 | 126 | if lines_output >= term_size - 1 && term_size != 0 { 127 | // Output is a different process that is not a tty (i.e. less), but we want to keep colour 128 | env::set_var("CLICOLOR_FORCE", "1"); 129 | pipe_to_less(output); 130 | } else { 131 | print!("{}", output); 132 | } 133 | 134 | if !options.interactive { 135 | break; 136 | } 137 | 138 | query.clear(); 139 | while query.trim().is_empty() { 140 | print!("=> "); 141 | stdout().flush().unwrap(); 142 | stdin() 143 | .read_line(&mut query) 144 | .expect("Can't read from stdin"); 145 | } 146 | } 147 | 148 | Ok(()) 149 | } 150 | 151 | fn print_item(query: &str, value: &Value, output: &mut String) -> Option { 152 | let japanese = value_to_arr(value.get("japanese")?).get(0)?.to_owned(); 153 | 154 | let reading = japanese 155 | .get("reading") 156 | .map(|i| value_to_str(i)) 157 | .unwrap_or(query); 158 | 159 | let word = value_to_str(japanese.get("word").unwrap_or(japanese.get("reading")?)); 160 | 161 | let mut aux = format!("{}[{}] {}\n", word, reading, format_result_tags(value)); 162 | *output += &aux; 163 | 164 | // Print senses 165 | let senses = value_to_arr(value.get("senses")?); 166 | for (i, sense) in senses.iter().enumerate() { 167 | let sense_str = format_sense(&sense, i); 168 | if sense_str.is_empty() { 169 | continue; 170 | } 171 | 172 | aux = format!(" {}\n", sense_str); 173 | *output += &aux; 174 | } 175 | 176 | Some(senses.iter().count() + 1) 177 | } 178 | 179 | fn format_sense(value: &Value, index: usize) -> String { 180 | let english_definitons = value.get("english_definitions"); 181 | let parts_of_speech = value.get("parts_of_speech"); 182 | if english_definitons.is_none() { 183 | return "".to_owned(); 184 | } 185 | 186 | let english_definiton = value_to_arr(english_definitons.unwrap()); 187 | 188 | let parts_of_speech = if let Some(parts_of_speech) = parts_of_speech { 189 | let parts = value_to_arr(parts_of_speech) 190 | .to_owned() 191 | .iter() 192 | .map(|i| { 193 | let s = value_to_str(i); 194 | match s { 195 | "Suru verb - irregular" => "Irregular verb", 196 | "Ichidan verb" => "iru/eru verb", 197 | _ => { 198 | if s.contains("Godan verb") { 199 | "Godan verb" 200 | } else { 201 | s 202 | } 203 | } 204 | } 205 | }) 206 | .collect::>() 207 | .join(", "); 208 | 209 | if parts.is_empty() { 210 | String::new() 211 | } else { 212 | format!("[{}]", parts.bright_blue()) 213 | } 214 | } else { 215 | String::new() 216 | }; 217 | 218 | let tags = format_sense_tags(value); 219 | 220 | format!( 221 | "{}. {} {} {}", 222 | index + 1, 223 | english_definiton 224 | .iter() 225 | .map(|i| value_to_str(i)) 226 | .collect::>() 227 | .join(", "), 228 | tags, 229 | parts_of_speech 230 | ) 231 | } 232 | 233 | /// Format tags from a whole meaning 234 | fn format_result_tags(value: &Value) -> String { 235 | let mut builder = String::new(); 236 | 237 | let is_common_val = value.get("is_common"); 238 | if is_common_val.is_some() && value_to_bool(is_common_val.unwrap()) { 239 | builder.push_str(&"(common) ".bright_green().to_string()); 240 | } 241 | 242 | if let Some(jlpt) = value.get("jlpt") { 243 | let jlpt = value_to_arr(&jlpt); 244 | if !jlpt.is_empty() { 245 | let jlpt = value_to_str(jlpt.get(0).unwrap()) 246 | .replace("jlpt-", "") 247 | .to_uppercase(); 248 | builder.push_str(&format!("({}) ", jlpt.bright_blue().to_string())); 249 | } 250 | } 251 | 252 | builder 253 | } 254 | 255 | /// Format tags from a single sense entry 256 | fn format_sense_tags(value: &Value) -> String { 257 | let mut builder = String::new(); 258 | 259 | if let Some(tags) = value.get("tags") { 260 | let tags = value_to_arr(tags); 261 | 262 | for tag in tags { 263 | let t = format_sense_tag(value_to_str(tag)); 264 | builder.push_str(t.as_str()) 265 | } 266 | } 267 | 268 | builder 269 | } 270 | 271 | fn format_sense_tag(tag: &str) -> String { 272 | match tag { 273 | "Usually written using kana alone" => "(UK)".to_string(), 274 | s => format!("({})", s), 275 | } 276 | } 277 | 278 | // 279 | // --- Value helper 280 | // 281 | 282 | fn value_to_bool(value: &Value) -> bool { 283 | match value { 284 | Value::Bool(b) => *b, 285 | _ => unreachable!(), 286 | } 287 | } 288 | 289 | fn value_to_str(value: &Value) -> &str { 290 | match value { 291 | Value::String(s) => s, 292 | _ => unreachable!(), 293 | } 294 | } 295 | 296 | fn value_to_arr(value: &Value) -> &Vec { 297 | match value { 298 | Value::Array(a) => a, 299 | _ => unreachable!(), 300 | } 301 | } 302 | 303 | fn parse_args() -> Options { 304 | let mut options = Options::default(); 305 | let mut query_vec: Vec = Vec::new(); 306 | { 307 | let mut ap = ArgumentParser::new(); 308 | ap.set_description("Use jisho.org from cli"); 309 | ap.add_option( 310 | &["-V", "--version"], 311 | Print(env!("CARGO_PKG_VERSION").to_string()), 312 | "Show version", 313 | ); 314 | ap.refer(&mut options.limit).add_option( 315 | &["-n", "--limit"], 316 | Store, 317 | "Limit the amount of results", 318 | ); 319 | ap.refer(&mut query_vec) 320 | .add_argument("Query", List, "The query to search for"); 321 | 322 | ap.refer(&mut options.interactive).add_option( 323 | &["-i", "--interactive"], 324 | StoreTrue, 325 | "Don't exit after running a query", 326 | ); 327 | 328 | /* Uncomment when supported by jisho.org */ 329 | ap.refer(&mut options.kanji).add_option( 330 | &["--kanji", "-k"], 331 | StoreTrue, 332 | "Look up a certain kanji", 333 | ); 334 | 335 | ap.parse_args_or_exit(); 336 | } 337 | 338 | options.query = query_vec.join(" "); 339 | options 340 | } 341 | 342 | fn pipe_to_less(output: String) { 343 | 344 | let command = Command::new("less") 345 | .arg("-R") 346 | .stdin(Stdio::piped()) 347 | .spawn(); 348 | 349 | match command { 350 | Ok(mut process) => { 351 | if let Err(e) = process.stdin.as_ref().unwrap().write_all(output.as_bytes()) { 352 | panic!("couldn't pipe to less: {}", e); 353 | } 354 | 355 | // We don't care about the return value, only whether wait failed or not 356 | if process.wait().is_err() { 357 | panic!("wait() was called on non-existent child process\ 358 | - this should not be possible"); 359 | } 360 | } 361 | 362 | // less not found in PATH; print normally 363 | Err(_e) => print!("{}", output) 364 | }; 365 | } 366 | 367 | #[cfg(unix)] 368 | fn terminal_size() -> Result { 369 | use libc::{c_ushort, ioctl, STDOUT_FILENO, TIOCGWINSZ}; 370 | 371 | unsafe { 372 | let mut size: c_ushort = 0; 373 | if ioctl(STDOUT_FILENO, TIOCGWINSZ.into(), &mut size as *mut _) != 0 { 374 | Err(-1) 375 | } else { 376 | Ok(size as usize) 377 | } 378 | } 379 | } 380 | 381 | #[cfg(windows)] 382 | fn terminal_size() -> Result { 383 | use windows_sys::Win32::System::Console::*; 384 | 385 | unsafe { 386 | let handle = GetStdHandle(STD_OUTPUT_HANDLE) as windows_sys::Win32::Foundation::HANDLE; 387 | 388 | // Unlike the linux function, rust will complain if only part of the struct is sent 389 | let mut window = CONSOLE_SCREEN_BUFFER_INFO { 390 | dwSize: COORD { X: 0, Y: 0}, 391 | dwCursorPosition: COORD { X: 0, Y: 0}, 392 | wAttributes: 0, 393 | dwMaximumWindowSize: COORD {X: 0, Y: 0}, 394 | srWindow: SMALL_RECT { 395 | Top: 0, 396 | Bottom: 0, 397 | Left: 0, 398 | Right: 0 399 | } 400 | }; 401 | if GetConsoleScreenBufferInfo(handle, &mut window) == 0 { 402 | Err(0) 403 | } else { 404 | Ok((window.srWindow.Bottom - window.srWindow.Top) as usize) 405 | } 406 | } 407 | } 408 | --------------------------------------------------------------------------------