commit 6d41d6350848c8764cea90b469b5e744db5ff93e Author: mxhagen Date: Thu Sep 12 23:13:41 2024 +0200 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ea8c4bf --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/target diff --git a/Cargo.lock b/Cargo.lock new file mode 100644 index 0000000..bcf3383 --- /dev/null +++ b/Cargo.lock @@ -0,0 +1,648 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +version = 3 + +[[package]] +name = "android-tzdata" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e999941b234f3131b00bc13c22d06e8c5ff726d1b6318ac7eb276997bbb4fef0" + +[[package]] +name = "android_system_properties" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "819e7219dbd41043ac279b19830f2efc897156490d7fd6ea916720117ee66311" +dependencies = [ + "libc", +] + +[[package]] +name = "anstream" +version = "0.6.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "418c75fa768af9c03be99d17643f93f79bbba589895012a80e3452a19ddda15b" +dependencies = [ + "anstyle", + "anstyle-parse", + "anstyle-query", + "anstyle-wincon", + "colorchoice", + "is_terminal_polyfill", + "utf8parse", +] + +[[package]] +name = "anstyle" +version = "1.0.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "038dfcf04a5feb68e9c60b21c9625a54c2c0616e79b72b0fd87075a056ae1d1b" + +[[package]] +name = "anstyle-parse" +version = "0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c03a11a9034d92058ceb6ee011ce58af4a9bf61491aa7e1e59ecd24bd40d22d4" +dependencies = [ + "utf8parse", +] + +[[package]] +name = "anstyle-query" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ad186efb764318d35165f1758e7dcef3b10628e26d41a44bc5550652e6804391" +dependencies = [ + "windows-sys 0.52.0", +] + +[[package]] +name = "anstyle-wincon" +version = "3.0.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "61a38449feb7068f52bb06c12759005cf459ee52bb4adc1d5a7c4322d716fb19" +dependencies = [ + "anstyle", + "windows-sys 0.52.0", +] + +[[package]] +name = "anyhow" +version = "1.0.86" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b3d1d046238990b9cf5bcde22a3fb3584ee5cf65fb2765f454ed428c7a0063da" + +[[package]] +name = "autocfg" +version = "1.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0c4b4d0bd25bd0b74681c0ad21497610ce1b7c91b1022cd21c80c6fbdd9476b0" + +[[package]] +name = "bitflags" +version = "2.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b048fb63fd8b5923fc5aa7b340d8e156aec7ec02f0c78fa8a6ddc2613f6f71de" + +[[package]] +name = "bumpalo" +version = "3.16.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "79296716171880943b8470b5f8d03aa55eb2e645a4874bdbb28adb49162e012c" + +[[package]] +name = "cc" +version = "1.0.99" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "96c51067fd44124faa7f870b4b1c969379ad32b2ba805aa959430ceaa384f695" + +[[package]] +name = "cfg-if" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" + +[[package]] +name = "chrono" +version = "0.4.38" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a21f936df1771bf62b77f047b726c4625ff2e8aa607c01ec06e5a05bd8463401" +dependencies = [ + "android-tzdata", + "iana-time-zone", + "js-sys", + "num-traits", + "wasm-bindgen", + "windows-targets 0.52.5", +] + +[[package]] +name = "clap" +version = "4.5.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "84b3edb18336f4df585bc9aa31dd99c036dfa5dc5e9a2939a722a188f3a8970d" +dependencies = [ + "clap_builder", +] + +[[package]] +name = "clap_builder" +version = "4.5.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c1c09dd5ada6c6c78075d6fd0da3f90d8080651e2d6cc8eb2f1aaa4034ced708" +dependencies = [ + "anstream", + "anstyle", + "clap_lex", + "strsim", +] + +[[package]] +name = "clap_lex" +version = "0.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4b82cf0babdbd58558212896d1a4272303a57bdb245c2bf1147185fb45640e70" + +[[package]] +name = "colorchoice" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0b6a852b24ab71dffc585bcb46eaf7959d175cb865a7152e35b348d1b2960422" + +[[package]] +name = "core-foundation-sys" +version = "0.8.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "06ea2b9bc92be3c2baa9334a323ebca2d6f074ff852cd1d7b11064035cd3868f" + +[[package]] +name = "crossterm" +version = "0.27.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f476fe445d41c9e991fd07515a6f463074b782242ccf4a5b7b1d1012e70824df" +dependencies = [ + "bitflags", + "crossterm_winapi", + "libc", + "mio", + "parking_lot", + "signal-hook", + "signal-hook-mio", + "winapi", +] + +[[package]] +name = "crossterm_winapi" +version = "0.9.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "acdd7c62a3665c7f6830a51635d9ac9b23ed385797f70a83bb8bafe9c572ab2b" +dependencies = [ + "winapi", +] + +[[package]] +name = "iana-time-zone" +version = "0.1.60" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e7ffbb5a1b541ea2561f8c41c087286cc091e21e556a4f09a8f6cbf17b69b141" +dependencies = [ + "android_system_properties", + "core-foundation-sys", + "iana-time-zone-haiku", + "js-sys", + "wasm-bindgen", + "windows-core", +] + +[[package]] +name = "iana-time-zone-haiku" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f31827a206f56af32e590ba56d5d2d085f558508192593743f16b2306495269f" +dependencies = [ + "cc", +] + +[[package]] +name = "is_terminal_polyfill" +version = "1.70.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f8478577c03552c21db0e2724ffb8986a5ce7af88107e6be5d2ee6e158c12800" + +[[package]] +name = "js-sys" +version = "0.3.69" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "29c15563dc2726973df627357ce0c9ddddbea194836909d655df6a75d2cf296d" +dependencies = [ + "wasm-bindgen", +] + +[[package]] +name = "libc" +version = "0.2.155" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "97b3888a4aecf77e811145cadf6eef5901f4782c53886191b2f693f24761847c" + +[[package]] +name = "lock_api" +version = "0.4.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "07af8b9cdd281b7915f413fa73f29ebd5d55d0d3f0155584dade1ff18cea1b17" +dependencies = [ + "autocfg", + "scopeguard", +] + +[[package]] +name = "log" +version = "0.4.22" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a7a70ba024b9dc04c27ea2f0c0548feb474ec5c54bba33a7f72f873a39d07b24" + +[[package]] +name = "mio" +version = "0.8.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a4a650543ca06a924e8b371db273b2756685faae30f8487da1b56505a8f78b0c" +dependencies = [ + "libc", + "log", + "wasi", + "windows-sys 0.48.0", +] + +[[package]] +name = "num-traits" +version = "0.2.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "071dfc062690e90b734c0b2273ce72ad0ffa95f0c74596bc250dcfd960262841" +dependencies = [ + "autocfg", +] + +[[package]] +name = "once_cell" +version = "1.19.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3fdb12b2476b595f9358c5161aa467c2438859caa136dec86c26fdd2efe17b92" + +[[package]] +name = "parking_lot" +version = "0.12.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f1bf18183cf54e8d6059647fc3063646a1801cf30896933ec2311622cc4b9a27" +dependencies = [ + "lock_api", + "parking_lot_core", +] + +[[package]] +name = "parking_lot_core" +version = "0.9.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1e401f977ab385c9e4e3ab30627d6f26d00e2c73eef317493c4ec6d468726cf8" +dependencies = [ + "cfg-if", + "libc", + "redox_syscall", + "smallvec", + "windows-targets 0.52.5", +] + +[[package]] +name = "proc-macro2" +version = "1.0.85" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "22244ce15aa966053a896d1accb3a6e68469b97c7f33f284b99f0d576879fc23" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "quote" +version = "1.0.36" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0fa76aaf39101c457836aec0ce2316dbdc3ab723cdda1c6bd4e6ad4208acaca7" +dependencies = [ + "proc-macro2", +] + +[[package]] +name = "redox_syscall" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c82cf8cff14456045f55ec4241383baeff27af886adb72ffb2162f99911de0fd" +dependencies = [ + "bitflags", +] + +[[package]] +name = "scopeguard" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49" + +[[package]] +name = "signal-hook" +version = "0.3.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8621587d4798caf8eb44879d42e56b9a93ea5dcd315a6487c357130095b62801" +dependencies = [ + "libc", + "signal-hook-registry", +] + +[[package]] +name = "signal-hook-mio" +version = "0.2.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "29ad2e15f37ec9a6cc544097b78a1ec90001e9f71b81338ca39f430adaca99af" +dependencies = [ + "libc", + "mio", + "signal-hook", +] + +[[package]] +name = "signal-hook-registry" +version = "1.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a9e9e0b4211b72e7b8b6e85c807d36c212bdb33ea8587f7569562a84df5465b1" +dependencies = [ + "libc", +] + +[[package]] +name = "smallvec" +version = "1.13.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3c5e1a9a646d36c3599cd173a41282daf47c44583ad367b8e6837255952e5c67" + +[[package]] +name = "strsim" +version = "0.11.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f" + +[[package]] +name = "syn" +version = "2.0.66" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c42f3f41a2de00b01c0aaad383c5a45241efc8b2d1eda5661812fda5f3cdcff5" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "termcolor" +version = "1.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "06794f8f6c5c898b3275aebefa6b8a1cb24cd2c6c79397ab15774837a0bc5755" +dependencies = [ + "winapi-util", +] + +[[package]] +name = "todue" +version = "0.1.0" +dependencies = [ + "anyhow", + "chrono", + "clap", + "crossterm", + "termcolor", +] + +[[package]] +name = "unicode-ident" +version = "1.0.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b" + +[[package]] +name = "utf8parse" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821" + +[[package]] +name = "wasi" +version = "0.11.0+wasi-snapshot-preview1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9c8d87e72b64a3b4db28d11ce29237c246188f4f51057d65a7eab63b7987e423" + +[[package]] +name = "wasm-bindgen" +version = "0.2.92" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4be2531df63900aeb2bca0daaaddec08491ee64ceecbee5076636a3b026795a8" +dependencies = [ + "cfg-if", + "wasm-bindgen-macro", +] + +[[package]] +name = "wasm-bindgen-backend" +version = "0.2.92" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "614d787b966d3989fa7bb98a654e369c762374fd3213d212cfc0251257e747da" +dependencies = [ + "bumpalo", + "log", + "once_cell", + "proc-macro2", + "quote", + "syn", + "wasm-bindgen-shared", +] + +[[package]] +name = "wasm-bindgen-macro" +version = "0.2.92" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a1f8823de937b71b9460c0c34e25f3da88250760bec0ebac694b49997550d726" +dependencies = [ + "quote", + "wasm-bindgen-macro-support", +] + +[[package]] +name = "wasm-bindgen-macro-support" +version = "0.2.92" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e94f17b526d0a461a191c78ea52bbce64071ed5c04c9ffe424dcb38f74171bb7" +dependencies = [ + "proc-macro2", + "quote", + "syn", + "wasm-bindgen-backend", + "wasm-bindgen-shared", +] + +[[package]] +name = "wasm-bindgen-shared" +version = "0.2.92" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "af190c94f2773fdb3729c55b007a722abb5384da03bc0986df4c289bf5567e96" + +[[package]] +name = "winapi" +version = "0.3.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419" +dependencies = [ + "winapi-i686-pc-windows-gnu", + "winapi-x86_64-pc-windows-gnu", +] + +[[package]] +name = "winapi-i686-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" + +[[package]] +name = "winapi-util" +version = "0.1.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4d4cc384e1e73b93bafa6fb4f1df8c41695c8a91cf9c4c64358067d15a7b6c6b" +dependencies = [ + "windows-sys 0.52.0", +] + +[[package]] +name = "winapi-x86_64-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" + +[[package]] +name = "windows-core" +version = "0.52.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "33ab640c8d7e35bf8ba19b884ba838ceb4fba93a4e8c65a9059d08afcfc683d9" +dependencies = [ + "windows-targets 0.52.5", +] + +[[package]] +name = "windows-sys" +version = "0.48.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "677d2418bec65e3338edb076e806bc1ec15693c5d0104683f2efe857f61056a9" +dependencies = [ + "windows-targets 0.48.5", +] + +[[package]] +name = "windows-sys" +version = "0.52.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "282be5f36a8ce781fad8c8ae18fa3f9beff57ec1b52cb3de0789201425d9a33d" +dependencies = [ + "windows-targets 0.52.5", +] + +[[package]] +name = "windows-targets" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9a2fa6e2155d7247be68c096456083145c183cbbbc2764150dda45a87197940c" +dependencies = [ + "windows_aarch64_gnullvm 0.48.5", + "windows_aarch64_msvc 0.48.5", + "windows_i686_gnu 0.48.5", + "windows_i686_msvc 0.48.5", + "windows_x86_64_gnu 0.48.5", + "windows_x86_64_gnullvm 0.48.5", + "windows_x86_64_msvc 0.48.5", +] + +[[package]] +name = "windows-targets" +version = "0.52.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6f0713a46559409d202e70e28227288446bf7841d3211583a4b53e3f6d96e7eb" +dependencies = [ + "windows_aarch64_gnullvm 0.52.5", + "windows_aarch64_msvc 0.52.5", + "windows_i686_gnu 0.52.5", + "windows_i686_gnullvm", + "windows_i686_msvc 0.52.5", + "windows_x86_64_gnu 0.52.5", + "windows_x86_64_gnullvm 0.52.5", + "windows_x86_64_msvc 0.52.5", +] + +[[package]] +name = "windows_aarch64_gnullvm" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2b38e32f0abccf9987a4e3079dfb67dcd799fb61361e53e2882c3cbaf0d905d8" + +[[package]] +name = "windows_aarch64_gnullvm" +version = "0.52.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7088eed71e8b8dda258ecc8bac5fb1153c5cffaf2578fc8ff5d61e23578d3263" + +[[package]] +name = "windows_aarch64_msvc" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dc35310971f3b2dbbf3f0690a219f40e2d9afcf64f9ab7cc1be722937c26b4bc" + +[[package]] +name = "windows_aarch64_msvc" +version = "0.52.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9985fd1504e250c615ca5f281c3f7a6da76213ebd5ccc9561496568a2752afb6" + +[[package]] +name = "windows_i686_gnu" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a75915e7def60c94dcef72200b9a8e58e5091744960da64ec734a6c6e9b3743e" + +[[package]] +name = "windows_i686_gnu" +version = "0.52.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "88ba073cf16d5372720ec942a8ccbf61626074c6d4dd2e745299726ce8b89670" + +[[package]] +name = "windows_i686_gnullvm" +version = "0.52.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "87f4261229030a858f36b459e748ae97545d6f1ec60e5e0d6a3d32e0dc232ee9" + +[[package]] +name = "windows_i686_msvc" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8f55c233f70c4b27f66c523580f78f1004e8b5a8b659e05a4eb49d4166cca406" + +[[package]] +name = "windows_i686_msvc" +version = "0.52.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "db3c2bf3d13d5b658be73463284eaf12830ac9a26a90c717b7f771dfe97487bf" + +[[package]] +name = "windows_x86_64_gnu" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "53d40abd2583d23e4718fddf1ebec84dbff8381c07cae67ff7768bbf19c6718e" + +[[package]] +name = "windows_x86_64_gnu" +version = "0.52.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4e4246f76bdeff09eb48875a0fd3e2af6aada79d409d33011886d3e1581517d9" + +[[package]] +name = "windows_x86_64_gnullvm" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0b7b52767868a23d5bab768e390dc5f5c55825b6d30b86c844ff2dc7414044cc" + +[[package]] +name = "windows_x86_64_gnullvm" +version = "0.52.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "852298e482cd67c356ddd9570386e2862b5673c85bd5f88df9ab6802b334c596" + +[[package]] +name = "windows_x86_64_msvc" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ed94fce61571a4006852b7389a063ab983c02eb1bb37b47f8272ce92d06d9538" + +[[package]] +name = "windows_x86_64_msvc" +version = "0.52.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bec47e5bfd1bff0eeaf6d8b485cc1074891a197ab4225d504cb7a1ab88b02bf0" diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..d588b6a --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,13 @@ +[package] +name = "todue" +version = "0.1.0" +edition = "2021" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[dependencies] +anyhow = "1.0.86" +chrono = "0.4.38" +clap = { version = "4.5.8", features = ["cargo"] } +crossterm = "0.27.0" +termcolor = "1.4.1" diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..bb05669 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ + +# ☑️ todue + +Keep track of TODOs and deadlines using an interactive markdown TUI. + +--- + +### Layout preview + +This is roughly what the UI looks like in the terminal + +```md + Chores +- [x] Get groceries (2024-06-20; 16:00) +- [ ] Do the dishes (2024-06-20; 20:00) +- [ ] Take out the trash (2024-06-20; 21:00) +``` + diff --git a/example_todo.md b/example_todo.md new file mode 100644 index 0000000..1870df4 --- /dev/null +++ b/example_todo.md @@ -0,0 +1,70 @@ +- [ ] ((2024-06-20 21:00)) Take out the trash +- [x] ((2024-06-20 16:00)) Get groceries +- [ ] ((2024-06-20 20:00)) Do the dishes +- [x] This is an extremely long todo entry without a date and yet it has already been completed. there is no way it will all fit in one line, right? i sure hope that doesn't cause any trouble for the end user. +- [ ] didnt +- [ ] you +- [ ] know +- [ ] you +- [ ] were +- [ ] freaky +- [ ] like +- [ ] that +- [ ] can +- [ ] i +- [ ] pay +- [ ] with +- [ ] mousepay +- [ ] here +- [ ] man +- [ ] tiktok +- [ ] is +- [ ] actually +- [ ] hilarious +- [ ] though +- [ ] there +- [ ] is +- [ ] also +- [ ] some +- [ ] baddies +- [ ] with +- [ ] fat +- [ ] honkers +- [ ] on +- [ ] there +- [ ] that +- [ ] have +- [ ] nice +- [ ] smiles +- [ ] and +- [ ] sometimes +- [ ] personalities +- [ ] oh +- [ ] yeeah +- [ ] baby +- [ ] they +- [ ] are +- [ ] real +- [ ] hot +- [ ] babes +- [ ] i +- [ ] hope +- [ ] to +- [ ] see +- [ ] such +- [ ] nice +- [ ] melons +- [ ] in +- [ ] person +- [ ] one +- [ ] day +- [ ] but +- [ ] for +- [ ] that +- [ ] i +- [ ] would +- [ ] probably +- [ ] need +- [ ] to +- [ ] go +- [ ] outside diff --git a/src/cli.rs b/src/cli.rs new file mode 100644 index 0000000..c729b46 --- /dev/null +++ b/src/cli.rs @@ -0,0 +1,14 @@ +use clap::{command, value_parser, Arg, ArgAction, Command, ValueHint}; + +pub fn new() -> Command { + command!() + .about("Manage todo lists through a tui/cli via markdown-files!") + .arg( + Arg::new("file") + .help("Markdown file to use") + .action(ArgAction::Set) + .value_name("FILE") + .value_parser(value_parser!(String)) + .value_hint(ValueHint::FilePath), + ) +} diff --git a/src/log.rs b/src/log.rs new file mode 100644 index 0000000..5198ae5 --- /dev/null +++ b/src/log.rs @@ -0,0 +1,90 @@ +use std::{ + io::{self, Write}, + sync::Mutex, +}; + +pub struct Log {} +pub struct DropGuard +where + F: Fn(), +{ + pub exec_on_drop: F, +} + +static LOG_BUFFER: Mutex = Mutex::new(String::new()); + +impl Log { + pub fn log(label: S1, message: S2, label_ansi_style_code: S3) + where + S1: ToString, + S2: ToString, + S3: ToString, + { + let mut log_entry = String::new(); + log_entry += &label_ansi_style_code.to_string(); // set style + log_entry += &label.to_string(); + log_entry += "\x1b[0m"; // reset style + log_entry += &message.to_string(); + log_entry += "\r\n"; + + *LOG_BUFFER.lock().unwrap() += &log_entry; + } + + pub fn error_exit_with(error_code: I, error_msg: S) + where + S: ToString, + I: Into, + { + Self::error(error_msg); + Self::flush(); + std::process::exit(error_code.into()); + } + + pub fn error(error_msg: S) + where + S: ToString, + { + Self::log("error: ", error_msg, "\x1b[1;31m"); // red and bold label style + } + + pub fn info(info_msg: S) + where + S: ToString, + { + Self::log("info: ", info_msg, "\x1b[1;34m"); // blue and bold label style + } + + pub fn warn(warning_msg: S) + where + S: ToString, + { + Self::log("warning: ", warning_msg, "\x1b[1;33m"); // blue and bold label style + } + + pub fn flush() { + let _ = write!(&mut io::stderr(), "{}", *LOG_BUFFER.lock().unwrap()); + io::stderr().flush().unwrap(); + } +} + +// unused variants here are ok -> hide warning in debug builds +#[cfg_attr(debug_assertions, allow(dead_code))] +pub enum ErrorCode { + App = 1, + IO = 2, +} + +impl From for i32 { + fn from(value: ErrorCode) -> Self { + value as Self + } +} + +impl Drop for DropGuard +where + F: Fn(), +{ + fn drop(&mut self) { + (self.exec_on_drop)() + } +} diff --git a/src/main.rs b/src/main.rs new file mode 100644 index 0000000..424a4ab --- /dev/null +++ b/src/main.rs @@ -0,0 +1,93 @@ +use std::{ + fs, + io::{self, Write}, + path, process, time, +}; + +use crossterm::event::{poll, read, Event::*, KeyCode::Char}; + +mod md; +use md::*; + +mod ui; +use ui::*; + +mod cli; + +mod log; +pub use log::*; + +mod tests; + +fn main() -> anyhow::Result<()> { + let command = cli::new(); + let args = command.clone().get_matches(); + + let md_file = match args.get_one::("file") { + Some(path) => path, + _ => { + Log::warn("No filename specified -- falling back to `todo.md`"); + &"todo.md".to_string() + } + }; + + if !path::Path::new(md_file).exists() { + Log::error_exit_with( + ErrorCode::IO, + format!("Markdown file `{md_file}` not found. Exiting..."), + ); + } + + let md = fs::read_to_string(md_file).unwrap(); + let document = Document::from_md(md)?; + + let mut ui = Ui::init(io::stdout(), document); + let _guard = DropGuard { + exec_on_drop: || { + { + let _ = Ui::init(&mut io::stdout(), Document::default()).deinit(); + } + .into() + }, + }; + + loop { + ui.draw()?; + if poll(time::Duration::from_millis(250)).unwrap_or(false) { + if let Ok(Key(k)) = read() { + match k.code { + Char('q') => break, + Char('j') => ui.move_selection(Down)?, + Char('k') => ui.move_selection(Up)?, + Char('J') => ui.move_selected_entry(Down), + Char('K') => ui.move_selected_entry(Up), + Char('G') => ui.move_selection_to_bottom(), + Char('g') => ui.move_selection_to_top(), + Char(' ') => ui.toggle_active_entry(), + Char('s') => ui.cycle_sort_mode(), + Char('Q') => { ui.dont_save_on_quit(); break; }, + _ => {} + } + } + } + } + + if ui.save_on_quit { + Log::info(format!( + "Writing updated markdown to file `{md_file}` and exiting..." + )); + let file = fs::File::create(md_file); + if file.is_err() { + Log::error(format!("Failed to open file for writing: `{md_file}`")); + process::exit(ErrorCode::IO.into()); + } + write!(file.unwrap(), "{}", ui.document.to_md()).unwrap_or_else(|e| { + Log::error(format!("Failed to write to file: `{md_file}`: {e}")); + process::exit(ErrorCode::IO.into()); + }); + } + + ui.deinit()?; + Log::flush(); + Ok(()) +} diff --git a/src/md.rs b/src/md.rs new file mode 100644 index 0000000..0f40768 --- /dev/null +++ b/src/md.rs @@ -0,0 +1,145 @@ +use anyhow::anyhow; +use chrono::NaiveDateTime; + +/// a todo-list entry; can be thought of as an abstract representation of a line +/// of markdown in one of the following formats: +/// - without deadline: `"- [ ] Do something"` +/// - with deadline: `"- [ ] (2024-06-20 20:00) Do another thing"` +#[derive(Debug, Default, Clone, PartialEq, Eq)] +pub struct Entry { + pub done: bool, + pub text: String, + pub deadline: Option, +} + +/// a todo-document; can be thought of as an abstract representation of an entire +/// document consisting of `title`, and all of the documents `entries` +#[derive(Debug, Default, Clone, PartialEq, Eq)] +pub struct Document { + pub title: Option, + pub entries: Vec, +} + +pub trait Markdown { + fn to_md(&self) -> String; + fn from_md(md: String) -> anyhow::Result + where + Self: Sized; +} + +impl Markdown for Entry { + fn to_md(&self) -> String { + let mut md = format!("- [{}] ", if self.done { "x" } else { " " }); + if let Some(deadline) = self.deadline { + md += &format!("({}) ", deadline.format("(%Y-%m-%d %H:%M)")); + } + md += &self.text; + md + } + + fn from_md(md: String) -> anyhow::Result { + let mut entry = Entry::default(); + + #[derive(PartialEq, Eq)] + enum ParseState { + Nothing, + Dash, + BrackOpen, + BrackClose, + Text, + } + use ParseState::*; + + let mut state = Nothing; + let mut i = 0; + let mut text = String::new(); + + while i < md.len() { + match state { + Nothing if &md[i..=i] == "-" => state = Dash, + + Dash if &md[i..=i] == "[" => state = BrackOpen, + + BrackOpen if &md[i..=i] == "x" => entry.done = true, + + BrackOpen if &md[i..=i] == "]" => state = BrackClose, + + BrackOpen + if !&md[i..=i] + .chars() + .next() + .unwrap_or(' ') + .is_ascii_whitespace() => + { + return Err(anyhow!("Invalid character in presumed checkbox. Expected whitespace or 'x', found '{}'", &md[i..=i])); + } + + BrackClose if md.len() - i >= "(YYYY-mm-dd HH:MM)".len() => { + let maybe_date = &md[i..i + "(YYYY-mm-dd HH:MM)".len()]; + let deadline = NaiveDateTime::parse_from_str(maybe_date, "(%Y-%m-%d %H:%M)"); + if maybe_date.chars().any(|c| c.is_alphabetic()) { + state = Text; // if there is any letters, stop trying to parse date + } else { + match deadline { + Ok(deadline) => { + entry.deadline = Some(deadline); + state = Text; + i += "(YYYY-mm-dd HH:MM)".len(); + text = String::new(); + } + _ => text += &md[i..=i], + } + } + } + + Text | BrackClose + if !&md[i..].chars().next().unwrap_or(' ').is_ascii_whitespace() => + { + text += &md[i..=i]; + state = Text; + } + + Text if !["\r", "\n"].contains(&&md[i..=i]) => text += &md[i..=i], + + _ => {} + } + i += 1; + } + + match state { + Text => { + entry.text = text.trim_start().to_string(); + Ok(entry) + } + _ => Err(anyhow!("Invalid entry")), + } + } +} + +impl Markdown for Document { + fn to_md(&self) -> String { + let mut md = match &self.title { + None => String::new(), + Some(title) => format!("# {}\n", title), + }; + + if !self.entries.is_empty() { + md += "\n"; + for entry in &self.entries { + md += &(entry.to_md() + "\n"); + } + } + + md + } + + fn from_md(md: String) -> anyhow::Result { + let mut document = Document::default(); + for line in md.lines() { + if let Ok(entry) = Entry::from_md(line.to_string()) { + document.entries.push(entry); + } + } + Ok(document) + } +} diff --git a/src/tests/md.rs b/src/tests/md.rs new file mode 100644 index 0000000..40ec4b0 --- /dev/null +++ b/src/tests/md.rs @@ -0,0 +1,42 @@ +use crate::*; + +/// test case: valid markdown, entry not done, not actually a date, date-like entry text +#[test] +fn test_valid_fake_date_not_done_dateless() { + let entry = Entry::from_md("- [ ] (2024-06-what) this should work, kind of".to_string()); + dbg!(&entry); + assert_eq!( + entry.unwrap(), + Entry { + done: false, + deadline: None, + text: "(2024-06-what) this should work, kind of".to_string(), + } + ); +} + +/// test case: valid, weirdly spaced, done with date +#[test] +fn test_valid_weirdly_spaced_done_dated() { + let entry = + Entry::from_md(" - [ x] (2024-06-20 20:30) weirdly spaced but ok".to_string()); + assert_eq!( + entry.unwrap(), + Entry { + done: true, + deadline: Some( + chrono::NaiveDateTime::parse_from_str("(2024-06-20 20:30)", "(%Y-%m-%d %H:%M)") + .unwrap() + ), + text: "weirdly spaced but ok".to_string(), + } + ); +} + +// test case: invalid, undefined checkbox fill character 'a' +#[test] +fn test_invalid_bad_checkbox_fill() { + let entry = Entry::from_md("- [a] this shouldn't work".to_string()); + dbg!(&entry); + assert!(entry.is_err()); +} diff --git a/src/tests/mod.rs b/src/tests/mod.rs new file mode 100644 index 0000000..eaa4db7 --- /dev/null +++ b/src/tests/mod.rs @@ -0,0 +1,2 @@ +#[cfg(test)] +mod md; diff --git a/src/ui.rs b/src/ui.rs new file mode 100644 index 0000000..d2fcc93 --- /dev/null +++ b/src/ui.rs @@ -0,0 +1,319 @@ +#![allow(dead_code, unused)] // todo +use crate::*; + +use std::cmp::Ordering::*; +use std::io; + +use anyhow::{anyhow, Result}; + +use crossterm::{ + cursor::{self, MoveTo, RestorePosition, SavePosition}, + execute, queue, + style::{Color, SetBackgroundColor, SetForegroundColor, Stylize}, + terminal::{ + disable_raw_mode, enable_raw_mode, size, Clear, ClearType::All, EnterAlternateScreen, + LeaveAlternateScreen, + }, +}; + +/// state of the user interface +pub struct Ui +where + T: io::Write, +{ + pub active_color_pair: (Color, Color), + pub inactive_color_pair: (Color, Color), + pub inactive_done_color_pair: (Color, Color), + pub header_color_pair: (Color, Color), + pub ostream: T, + pub scrolloff: usize, + pub current_sort_mode: SortMode, + pub document: Document, + pub original_document: Document, + pub width: usize, + pub save_on_quit: bool, + pub height: usize, + pub active_entry_idx: usize, + pub current_scroll_offset: usize, + queue_sort_update: bool +} + +impl Ui +where + T: io::Write, +{ + /// returns a new `Ui` using `ostream` as its' output stream + /// and sets up terminal state. + pub fn init(ostream: T, document: Document) -> Self { + let (width, height) = size().unwrap(); + let (width, height) = (width as usize, height as usize); + + let active_color_pair = (Color::Black, Color::Yellow); + let inactive_color_pair = (Color::Reset, Color::Reset); + let inactive_done_color_pair = (Color::DarkGrey, Color::Reset); + let header_color_pair = (Color::Yellow, Color::Reset); + + let mut ui = Ui { + active_color_pair, + save_on_quit: true, + inactive_color_pair, + inactive_done_color_pair, + header_color_pair, + current_sort_mode: Default, + active_entry_idx: 0, + scrolloff: 8, + current_scroll_offset: 0, + original_document: document.clone(), + document, + ostream, + width, + height, + queue_sort_update: false, + }; + + queue!( + ui.ostream, + SavePosition, + EnterAlternateScreen, + Clear(All), + cursor::Hide + ); + + enable_raw_mode().unwrap_or_else(|e| { + Log::error(format!("IO-error when enabling raw-mode: `{}`", e)); + process::exit(ErrorCode::IO.into()); + }); + ui + } + + /// resets terminal state that `Ui::init()` sets + pub fn deinit(&mut self) -> Result<()> { + disable_raw_mode()?; + execute!( + self.ostream, + LeaveAlternateScreen, + RestorePosition, + cursor::Show + )?; + Ok(()) + } + + /// updates `self.width` and `self.height`. + /// errs if the new dimensions are too small + pub fn update_dimensions(&mut self) -> Result<()> { + let (width, height) = size()?; + self.width = width as usize; + self.height = height as usize; + + if height < 4 || width < 45 { + Err(anyhow!( + "ui::update_dimensions: Terminal size too small to display UI" + )) + } else { + Ok(()) + } + } + + pub fn clear(&mut self) -> Result<()> { + queue!(self.ostream, Clear(All), MoveTo(0, 0))?; + Ok(()) + } + + /// draws the entire ui including unchanged parts + pub fn draw(&mut self) -> Result<()> { + self.update_dimensions()?; + self.update_scroll_offset(); + self.clear().unwrap(); + + self.apply_sort_mode(); + + self.draw_header(); + for (i, entry) in self + .document + .entries + .iter() + .skip(self.current_scroll_offset) + .enumerate() + { + if i >= self.inner_height() { + break; + } + let mut bold = false; + let (fg, bg) = match i == self.active_entry_idx - self.current_scroll_offset { + true => { + bold = true; + self.active_color_pair + } + false if entry.done => self.inactive_done_color_pair, + false => self.inactive_color_pair, + }; + + queue!(self.ostream, SetForegroundColor(fg), SetBackgroundColor(bg)); + let mut line = String::with_capacity(self.width); + if entry.done { + line += " [x] "; + } else { + line += " [ ] "; + } + + if let Some(deadline) = entry.deadline { + line += &format!("{}", deadline.format("(%Y-%m-%d %H:%M)")); + } else { + line += &" ".repeat("(YYYY-mm-dd HH:MM)".len()); + } + line += " "; + + let space = self.width - line.len() - 1; + let mut text = entry.text.clone(); + if text.chars().count() > space { + text = text[0..space - 3].to_string() + "... "; + } + line += &text; + let space = self.width - line.len(); + line += &" ".repeat(space); + + match bold { + true => write!(self.ostream, "{}\r\n", line.bold()), + false => write!(self.ostream, "{}\r\n", line), + }; + queue!( + self.ostream, + SetBackgroundColor(Color::Reset), + SetForegroundColor(Color::Reset) + ); + } + + self.ostream.flush()?; + Ok(()) + } + + pub fn draw_header(&mut self) { + let (fg, bg) = self.header_color_pair; + queue!(self.ostream, SetForegroundColor(fg), SetBackgroundColor(bg)); + + let mut line = String::with_capacity(self.width); + line += " [todue] "; + line += &" ".repeat(" [x] (YYYY-mm-dd HH:MM) ".len() - line.len()); + line += &self.document.title.clone().unwrap_or("TODO".into()); + let space = self.width - line.len(); + line += &" ".repeat(space); + write!(self.ostream, "{}\r\n", line); + write!(self.ostream, "{}\r\n", "—".repeat(self.width)); + queue!( + self.ostream, + SetForegroundColor(Color::Reset), + SetBackgroundColor(Color::Reset) + ); + } + + /// update the index of the first *shown* entry using `self.scrolloff` + pub fn update_scroll_offset(&mut self) { + if self.current_scroll_offset + self.scrolloff >= self.active_entry_idx { + let diff = (self.current_scroll_offset + self.scrolloff).abs_diff(self.active_entry_idx); + self.current_scroll_offset = self.current_scroll_offset.saturating_sub(diff); + + } else if (self.current_scroll_offset + self.inner_height()).saturating_sub(self.scrolloff) <= self.active_entry_idx { + let diff = (self.current_scroll_offset + self.inner_height()).saturating_sub(self.scrolloff).abs_diff(self.active_entry_idx); + self.current_scroll_offset = (self.current_scroll_offset + diff).min( + self.document + .entries + .len() + .saturating_sub(self.inner_height()), + ); + } + } + + /// get height in characters excluding header/title + pub fn inner_height(&self) -> usize { + self.height - 3 + } + + pub fn move_selection(&mut self, dir: MoveDirection) -> Result<()> { + match dir { + Down => { + self.active_entry_idx = (self.active_entry_idx + 1) % self.document.entries.len() + } + Up => { + self.active_entry_idx = ((self.active_entry_idx as isize - 1) + .rem_euclid(self.document.entries.len() as isize)) + as usize + } + } + Ok(()) + } + + pub fn move_selection_to_bottom(&mut self) { + self.active_entry_idx = self.document.entries.len() - 1; + } + + pub fn move_selection_to_top(&mut self) { + self.active_entry_idx = 0; + } + + pub fn move_selected_entry(&mut self, dir: MoveDirection) { + let swap_idx = match dir { + Down => (self.active_entry_idx + 1) % self.document.entries.len(), + Up => { + ((self.active_entry_idx as isize - 1) + .rem_euclid(self.document.entries.len() as isize)) as usize + } + }; + self.document.entries.swap(self.active_entry_idx, swap_idx); + self.move_selection(dir); + } + + pub fn toggle_active_entry(&mut self) { + let state = self.document.entries[self.active_entry_idx].done; + self.document.entries[self.active_entry_idx].done = !state; + } + + pub fn cycle_sort_mode(&mut self) { + self.current_sort_mode = match self.current_sort_mode { + Default => ByDeadlineDescending, + ByDeadlineDescending => ByDeadlineAscending, + ByDeadlineAscending => ByTextAscending, + ByTextAscending => ByTextDescending, + ByTextDescending => Default, + }; + self.queue_sort_update = true; + } + + pub fn apply_sort_mode(&mut self) { + if self.queue_sort_update { + match self.current_sort_mode { + Default => self.document = self.original_document.clone(), + ByDeadlineDescending => { + self.document.entries.sort_by_key(|entry| entry.deadline); + self.document.entries.reverse(); + }, + ByDeadlineAscending => self.document.entries.sort_by_key(|entry| entry.deadline), + ByTextAscending => self.document.entries.sort_by_key(|entry| entry.text.to_lowercase()), + ByTextDescending => { + self.document.entries.sort_by_key(|entry| entry.text.to_lowercase()); + self.document.entries.reverse(); + }, + } + self.queue_sort_update = false; + } + } + + pub fn dont_save_on_quit(&mut self) { + self.save_on_quit = false; + Log::info("Quitting without saving file..."); + } +} + +pub enum MoveDirection { + Down, + Up, +} +pub use MoveDirection::*; + +pub enum SortMode { + Default, + ByDeadlineDescending, + ByDeadlineAscending, + ByTextAscending, + ByTextDescending, +} +pub use SortMode::*;