├── .gitignore ├── Cargo.lock ├── Cargo.toml ├── LICENSE ├── README.md └── src ├── converter.rs └── main.rs /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | test.norg 3 | -------------------------------------------------------------------------------- /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 = "ahash" 7 | version = "0.8.11" 8 | source = "registry+https://github.com/rust-lang/crates.io-index" 9 | checksum = "e89da841a80418a9b391ebaea17f5c112ffaaa96f621d2c285b5174da76b9011" 10 | dependencies = [ 11 | "cfg-if", 12 | "once_cell", 13 | "version_check", 14 | "zerocopy", 15 | ] 16 | 17 | [[package]] 18 | name = "aho-corasick" 19 | version = "1.1.2" 20 | source = "registry+https://github.com/rust-lang/crates.io-index" 21 | checksum = "b2969dcb958b36655471fc61f7e416fa76033bdd4bfed0678d8fee1e2d07a1f0" 22 | dependencies = [ 23 | "memchr", 24 | ] 25 | 26 | [[package]] 27 | name = "allocator-api2" 28 | version = "0.2.18" 29 | source = "registry+https://github.com/rust-lang/crates.io-index" 30 | checksum = "5c6cb57a04249c6480766f7f7cef5467412af1490f8d1e243141daddada3264f" 31 | 32 | [[package]] 33 | name = "anstream" 34 | version = "0.6.11" 35 | source = "registry+https://github.com/rust-lang/crates.io-index" 36 | checksum = "6e2e1ebcb11de5c03c67de28a7df593d32191b44939c482e97702baaaa6ab6a5" 37 | dependencies = [ 38 | "anstyle", 39 | "anstyle-parse", 40 | "anstyle-query", 41 | "anstyle-wincon", 42 | "colorchoice", 43 | "utf8parse", 44 | ] 45 | 46 | [[package]] 47 | name = "anstyle" 48 | version = "1.0.5" 49 | source = "registry+https://github.com/rust-lang/crates.io-index" 50 | checksum = "2faccea4cc4ab4a667ce676a30e8ec13922a692c99bb8f5b11f1502c72e04220" 51 | 52 | [[package]] 53 | name = "anstyle-parse" 54 | version = "0.2.3" 55 | source = "registry+https://github.com/rust-lang/crates.io-index" 56 | checksum = "c75ac65da39e5fe5ab759307499ddad880d724eed2f6ce5b5e8a26f4f387928c" 57 | dependencies = [ 58 | "utf8parse", 59 | ] 60 | 61 | [[package]] 62 | name = "anstyle-query" 63 | version = "1.0.2" 64 | source = "registry+https://github.com/rust-lang/crates.io-index" 65 | checksum = "e28923312444cdd728e4738b3f9c9cac739500909bb3d3c94b43551b16517648" 66 | dependencies = [ 67 | "windows-sys", 68 | ] 69 | 70 | [[package]] 71 | name = "anstyle-wincon" 72 | version = "3.0.2" 73 | source = "registry+https://github.com/rust-lang/crates.io-index" 74 | checksum = "1cd54b81ec8d6180e24654d0b371ad22fc3dd083b6ff8ba325b72e00c87660a7" 75 | dependencies = [ 76 | "anstyle", 77 | "windows-sys", 78 | ] 79 | 80 | [[package]] 81 | name = "ariadne" 82 | version = "0.4.1" 83 | source = "registry+https://github.com/rust-lang/crates.io-index" 84 | checksum = "44055e597c674aef7cb903b2b9f6e4cba1277ed0d2d61dae7cd52d7ffa81f8e2" 85 | dependencies = [ 86 | "unicode-width", 87 | "yansi", 88 | ] 89 | 90 | [[package]] 91 | name = "cc" 92 | version = "1.1.11" 93 | source = "registry+https://github.com/rust-lang/crates.io-index" 94 | checksum = "5fb8dd288a69fc53a1996d7ecfbf4a20d59065bff137ce7e56bbd620de191189" 95 | dependencies = [ 96 | "shlex", 97 | ] 98 | 99 | [[package]] 100 | name = "cfg-if" 101 | version = "1.0.0" 102 | source = "registry+https://github.com/rust-lang/crates.io-index" 103 | checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" 104 | 105 | [[package]] 106 | name = "chumsky" 107 | version = "0.9.3" 108 | source = "registry+https://github.com/rust-lang/crates.io-index" 109 | checksum = "8eebd66744a15ded14960ab4ccdbfb51ad3b81f51f3f04a80adac98c985396c9" 110 | dependencies = [ 111 | "hashbrown", 112 | "stacker", 113 | ] 114 | 115 | [[package]] 116 | name = "clap" 117 | version = "4.4.18" 118 | source = "registry+https://github.com/rust-lang/crates.io-index" 119 | checksum = "1e578d6ec4194633722ccf9544794b71b1385c3c027efe0c55db226fc880865c" 120 | dependencies = [ 121 | "clap_builder", 122 | "clap_derive", 123 | ] 124 | 125 | [[package]] 126 | name = "clap_builder" 127 | version = "4.4.18" 128 | source = "registry+https://github.com/rust-lang/crates.io-index" 129 | checksum = "4df4df40ec50c46000231c914968278b1eb05098cf8f1b3a518a95030e71d1c7" 130 | dependencies = [ 131 | "anstream", 132 | "anstyle", 133 | "clap_lex", 134 | "strsim", 135 | ] 136 | 137 | [[package]] 138 | name = "clap_derive" 139 | version = "4.4.7" 140 | source = "registry+https://github.com/rust-lang/crates.io-index" 141 | checksum = "cf9804afaaf59a91e75b022a30fb7229a7901f60c755489cc61c9b423b836442" 142 | dependencies = [ 143 | "heck", 144 | "proc-macro2", 145 | "quote", 146 | "syn", 147 | ] 148 | 149 | [[package]] 150 | name = "clap_lex" 151 | version = "0.6.0" 152 | source = "registry+https://github.com/rust-lang/crates.io-index" 153 | checksum = "702fc72eb24e5a1e48ce58027a675bc24edd52096d5397d4aea7c6dd9eca0bd1" 154 | 155 | [[package]] 156 | name = "colorchoice" 157 | version = "1.0.0" 158 | source = "registry+https://github.com/rust-lang/crates.io-index" 159 | checksum = "acbf1af155f9b9ef647e42cdc158db4b64a1b61f743629225fde6f3e0be2a7c7" 160 | 161 | [[package]] 162 | name = "either" 163 | version = "1.9.0" 164 | source = "registry+https://github.com/rust-lang/crates.io-index" 165 | checksum = "a26ae43d7bcc3b814de94796a5e736d4029efb0ee900c12e2d54c993ad1a1e07" 166 | 167 | [[package]] 168 | name = "eyre" 169 | version = "0.6.12" 170 | source = "registry+https://github.com/rust-lang/crates.io-index" 171 | checksum = "7cd915d99f24784cdc19fd37ef22b97e3ff0ae756c7e492e9fbfe897d61e2aec" 172 | dependencies = [ 173 | "indenter", 174 | "once_cell", 175 | ] 176 | 177 | [[package]] 178 | name = "hashbrown" 179 | version = "0.14.5" 180 | source = "registry+https://github.com/rust-lang/crates.io-index" 181 | checksum = "e5274423e17b7c9fc20b6e7e208532f9b19825d82dfd615708b70edd83df41f1" 182 | dependencies = [ 183 | "ahash", 184 | "allocator-api2", 185 | ] 186 | 187 | [[package]] 188 | name = "heck" 189 | version = "0.4.1" 190 | source = "registry+https://github.com/rust-lang/crates.io-index" 191 | checksum = "95505c38b4572b2d910cecb0281560f54b440a19336cbbcb27bf6ce6adc6f5a8" 192 | 193 | [[package]] 194 | name = "indenter" 195 | version = "0.3.3" 196 | source = "registry+https://github.com/rust-lang/crates.io-index" 197 | checksum = "ce23b50ad8242c51a442f3ff322d56b02f08852c77e4c0b4d3fd684abc89c683" 198 | 199 | [[package]] 200 | name = "itertools" 201 | version = "0.12.1" 202 | source = "registry+https://github.com/rust-lang/crates.io-index" 203 | checksum = "ba291022dbbd398a455acf126c1e341954079855bc60dfdda641363bd6922569" 204 | dependencies = [ 205 | "either", 206 | ] 207 | 208 | [[package]] 209 | name = "itertools" 210 | version = "0.13.0" 211 | source = "registry+https://github.com/rust-lang/crates.io-index" 212 | checksum = "413ee7dfc52ee1a4949ceeb7dbc8a33f2d6c088194d9f922fb8318faf1f01186" 213 | dependencies = [ 214 | "either", 215 | ] 216 | 217 | [[package]] 218 | name = "libc" 219 | version = "0.2.155" 220 | source = "registry+https://github.com/rust-lang/crates.io-index" 221 | checksum = "97b3888a4aecf77e811145cadf6eef5901f4782c53886191b2f693f24761847c" 222 | 223 | [[package]] 224 | name = "memchr" 225 | version = "2.7.1" 226 | source = "registry+https://github.com/rust-lang/crates.io-index" 227 | checksum = "523dc4f511e55ab87b694dc30d0f820d60906ef06413f93d4d7a1385599cc149" 228 | 229 | [[package]] 230 | name = "norg-fmt" 231 | version = "0.1.0" 232 | dependencies = [ 233 | "ariadne", 234 | "chumsky", 235 | "clap", 236 | "eyre", 237 | "itertools 0.12.1", 238 | "regex", 239 | "rust-norg", 240 | "serde", 241 | ] 242 | 243 | [[package]] 244 | name = "once_cell" 245 | version = "1.19.0" 246 | source = "registry+https://github.com/rust-lang/crates.io-index" 247 | checksum = "3fdb12b2476b595f9358c5161aa467c2438859caa136dec86c26fdd2efe17b92" 248 | 249 | [[package]] 250 | name = "proc-macro2" 251 | version = "1.0.78" 252 | source = "registry+https://github.com/rust-lang/crates.io-index" 253 | checksum = "e2422ad645d89c99f8f3e6b88a9fdeca7fabeac836b1002371c4367c8f984aae" 254 | dependencies = [ 255 | "unicode-ident", 256 | ] 257 | 258 | [[package]] 259 | name = "psm" 260 | version = "0.1.21" 261 | source = "registry+https://github.com/rust-lang/crates.io-index" 262 | checksum = "5787f7cda34e3033a72192c018bc5883100330f362ef279a8cbccfce8bb4e874" 263 | dependencies = [ 264 | "cc", 265 | ] 266 | 267 | [[package]] 268 | name = "quote" 269 | version = "1.0.35" 270 | source = "registry+https://github.com/rust-lang/crates.io-index" 271 | checksum = "291ec9ab5efd934aaf503a6466c5d5251535d108ee747472c3977cc5acc868ef" 272 | dependencies = [ 273 | "proc-macro2", 274 | ] 275 | 276 | [[package]] 277 | name = "regex" 278 | version = "1.10.3" 279 | source = "registry+https://github.com/rust-lang/crates.io-index" 280 | checksum = "b62dbe01f0b06f9d8dc7d49e05a0785f153b00b2c227856282f671e0318c9b15" 281 | dependencies = [ 282 | "aho-corasick", 283 | "memchr", 284 | "regex-automata", 285 | "regex-syntax", 286 | ] 287 | 288 | [[package]] 289 | name = "regex-automata" 290 | version = "0.4.5" 291 | source = "registry+https://github.com/rust-lang/crates.io-index" 292 | checksum = "5bb987efffd3c6d0d8f5f89510bb458559eab11e4f869acb20bf845e016259cd" 293 | dependencies = [ 294 | "aho-corasick", 295 | "memchr", 296 | "regex-syntax", 297 | ] 298 | 299 | [[package]] 300 | name = "regex-syntax" 301 | version = "0.8.2" 302 | source = "registry+https://github.com/rust-lang/crates.io-index" 303 | checksum = "c08c74e62047bb2de4ff487b251e4a92e24f48745648451635cec7d591162d9f" 304 | 305 | [[package]] 306 | name = "rust-norg" 307 | version = "0.1.0" 308 | source = "git+https://github.com/nvim-neorg/rust-norg#7a34faf3d601f686c5ba3bbfab237f03e6564714" 309 | dependencies = [ 310 | "chumsky", 311 | "itertools 0.13.0", 312 | "serde", 313 | "unicode_categories", 314 | ] 315 | 316 | [[package]] 317 | name = "serde" 318 | version = "1.0.207" 319 | source = "registry+https://github.com/rust-lang/crates.io-index" 320 | checksum = "5665e14a49a4ea1b91029ba7d3bca9f299e1f7cfa194388ccc20f14743e784f2" 321 | dependencies = [ 322 | "serde_derive", 323 | ] 324 | 325 | [[package]] 326 | name = "serde_derive" 327 | version = "1.0.207" 328 | source = "registry+https://github.com/rust-lang/crates.io-index" 329 | checksum = "6aea2634c86b0e8ef2cfdc0c340baede54ec27b1e46febd7f80dffb2aa44a00e" 330 | dependencies = [ 331 | "proc-macro2", 332 | "quote", 333 | "syn", 334 | ] 335 | 336 | [[package]] 337 | name = "shlex" 338 | version = "1.3.0" 339 | source = "registry+https://github.com/rust-lang/crates.io-index" 340 | checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64" 341 | 342 | [[package]] 343 | name = "stacker" 344 | version = "0.1.15" 345 | source = "registry+https://github.com/rust-lang/crates.io-index" 346 | checksum = "c886bd4480155fd3ef527d45e9ac8dd7118a898a46530b7b94c3e21866259fce" 347 | dependencies = [ 348 | "cc", 349 | "cfg-if", 350 | "libc", 351 | "psm", 352 | "winapi", 353 | ] 354 | 355 | [[package]] 356 | name = "strsim" 357 | version = "0.10.0" 358 | source = "registry+https://github.com/rust-lang/crates.io-index" 359 | checksum = "73473c0e59e6d5812c5dfe2a064a6444949f089e20eec9a2e5506596494e4623" 360 | 361 | [[package]] 362 | name = "syn" 363 | version = "2.0.48" 364 | source = "registry+https://github.com/rust-lang/crates.io-index" 365 | checksum = "0f3531638e407dfc0814761abb7c00a5b54992b849452a0646b7f65c9f770f3f" 366 | dependencies = [ 367 | "proc-macro2", 368 | "quote", 369 | "unicode-ident", 370 | ] 371 | 372 | [[package]] 373 | name = "unicode-ident" 374 | version = "1.0.12" 375 | source = "registry+https://github.com/rust-lang/crates.io-index" 376 | checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b" 377 | 378 | [[package]] 379 | name = "unicode-width" 380 | version = "0.1.13" 381 | source = "registry+https://github.com/rust-lang/crates.io-index" 382 | checksum = "0336d538f7abc86d282a4189614dfaa90810dfc2c6f6427eaf88e16311dd225d" 383 | 384 | [[package]] 385 | name = "unicode_categories" 386 | version = "0.1.1" 387 | source = "registry+https://github.com/rust-lang/crates.io-index" 388 | checksum = "39ec24b3121d976906ece63c9daad25b85969647682eee313cb5779fdd69e14e" 389 | 390 | [[package]] 391 | name = "utf8parse" 392 | version = "0.2.1" 393 | source = "registry+https://github.com/rust-lang/crates.io-index" 394 | checksum = "711b9620af191e0cdc7468a8d14e709c3dcdb115b36f838e601583af800a370a" 395 | 396 | [[package]] 397 | name = "version_check" 398 | version = "0.9.5" 399 | source = "registry+https://github.com/rust-lang/crates.io-index" 400 | checksum = "0b928f33d975fc6ad9f86c8f283853ad26bdd5b10b7f1542aa2fa15e2289105a" 401 | 402 | [[package]] 403 | name = "winapi" 404 | version = "0.3.9" 405 | source = "registry+https://github.com/rust-lang/crates.io-index" 406 | checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419" 407 | dependencies = [ 408 | "winapi-i686-pc-windows-gnu", 409 | "winapi-x86_64-pc-windows-gnu", 410 | ] 411 | 412 | [[package]] 413 | name = "winapi-i686-pc-windows-gnu" 414 | version = "0.4.0" 415 | source = "registry+https://github.com/rust-lang/crates.io-index" 416 | checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" 417 | 418 | [[package]] 419 | name = "winapi-x86_64-pc-windows-gnu" 420 | version = "0.4.0" 421 | source = "registry+https://github.com/rust-lang/crates.io-index" 422 | checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" 423 | 424 | [[package]] 425 | name = "windows-sys" 426 | version = "0.52.0" 427 | source = "registry+https://github.com/rust-lang/crates.io-index" 428 | checksum = "282be5f36a8ce781fad8c8ae18fa3f9beff57ec1b52cb3de0789201425d9a33d" 429 | dependencies = [ 430 | "windows-targets", 431 | ] 432 | 433 | [[package]] 434 | name = "windows-targets" 435 | version = "0.52.0" 436 | source = "registry+https://github.com/rust-lang/crates.io-index" 437 | checksum = "8a18201040b24831fbb9e4eb208f8892e1f50a37feb53cc7ff887feb8f50e7cd" 438 | dependencies = [ 439 | "windows_aarch64_gnullvm", 440 | "windows_aarch64_msvc", 441 | "windows_i686_gnu", 442 | "windows_i686_msvc", 443 | "windows_x86_64_gnu", 444 | "windows_x86_64_gnullvm", 445 | "windows_x86_64_msvc", 446 | ] 447 | 448 | [[package]] 449 | name = "windows_aarch64_gnullvm" 450 | version = "0.52.0" 451 | source = "registry+https://github.com/rust-lang/crates.io-index" 452 | checksum = "cb7764e35d4db8a7921e09562a0304bf2f93e0a51bfccee0bd0bb0b666b015ea" 453 | 454 | [[package]] 455 | name = "windows_aarch64_msvc" 456 | version = "0.52.0" 457 | source = "registry+https://github.com/rust-lang/crates.io-index" 458 | checksum = "bbaa0368d4f1d2aaefc55b6fcfee13f41544ddf36801e793edbbfd7d7df075ef" 459 | 460 | [[package]] 461 | name = "windows_i686_gnu" 462 | version = "0.52.0" 463 | source = "registry+https://github.com/rust-lang/crates.io-index" 464 | checksum = "a28637cb1fa3560a16915793afb20081aba2c92ee8af57b4d5f28e4b3e7df313" 465 | 466 | [[package]] 467 | name = "windows_i686_msvc" 468 | version = "0.52.0" 469 | source = "registry+https://github.com/rust-lang/crates.io-index" 470 | checksum = "ffe5e8e31046ce6230cc7215707b816e339ff4d4d67c65dffa206fd0f7aa7b9a" 471 | 472 | [[package]] 473 | name = "windows_x86_64_gnu" 474 | version = "0.52.0" 475 | source = "registry+https://github.com/rust-lang/crates.io-index" 476 | checksum = "3d6fa32db2bc4a2f5abeacf2b69f7992cd09dca97498da74a151a3132c26befd" 477 | 478 | [[package]] 479 | name = "windows_x86_64_gnullvm" 480 | version = "0.52.0" 481 | source = "registry+https://github.com/rust-lang/crates.io-index" 482 | checksum = "1a657e1e9d3f514745a572a6846d3c7aa7dbe1658c056ed9c3344c4109a6949e" 483 | 484 | [[package]] 485 | name = "windows_x86_64_msvc" 486 | version = "0.52.0" 487 | source = "registry+https://github.com/rust-lang/crates.io-index" 488 | checksum = "dff9641d1cd4be8d1a070daf9e3773c5f67e78b4d9d42263020c057706765c04" 489 | 490 | [[package]] 491 | name = "yansi" 492 | version = "1.0.1" 493 | source = "registry+https://github.com/rust-lang/crates.io-index" 494 | checksum = "cfe53a6657fd280eaa890a3bc59152892ffa3e30101319d168b781ed6529b049" 495 | 496 | [[package]] 497 | name = "zerocopy" 498 | version = "0.7.35" 499 | source = "registry+https://github.com/rust-lang/crates.io-index" 500 | checksum = "1b9b4fd18abc82b8136838da5d50bae7bdea537c574d8dc1a34ed098d6c166f0" 501 | dependencies = [ 502 | "zerocopy-derive", 503 | ] 504 | 505 | [[package]] 506 | name = "zerocopy-derive" 507 | version = "0.7.35" 508 | source = "registry+https://github.com/rust-lang/crates.io-index" 509 | checksum = "fa4f8080344d4671fb4e831a13ad1e68092748387dfc4f55e356242fae12ce3e" 510 | dependencies = [ 511 | "proc-macro2", 512 | "quote", 513 | "syn", 514 | ] 515 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "norg-fmt" 3 | version = "0.1.0" 4 | edition = "2021" 5 | 6 | # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html 7 | 8 | [dependencies] 9 | ariadne = "0.4.1" 10 | chumsky = "0.9.3" 11 | clap = { version = "4.4.18", features = ["derive"] } 12 | eyre = "0.6.11" 13 | itertools = "0.12.1" 14 | regex = "1.10.3" 15 | rust-norg = { git = "https://github.com/nvim-neorg/rust-norg" } 16 | serde = { version = "1.0.196", features = ["derive"] } 17 | -------------------------------------------------------------------------------- /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 | # Opinionated Formatter for Norg Files 2 | 3 | This project serves as a proof of concept formatter for Norg files using the latest V3 treesitter parsing engine. 4 | 5 | The formatting style is currently very opinionated and was devised by the creators of Norg (hey that's me!). 6 | In the future we hope to provide a plethora of flags to tune the document to your style. 7 | 8 | > [!NOTE] 9 | > Not all of the syntax is supported by the formatter due to temporary limitations in the V3 parser. 10 | > The capabilities of this project will be extended as the parser nears full completion. 11 | 12 | # Current Capabilities 13 | 14 | - Formatting of headings and proper indentation of children 15 | - Formatting of lists and quotes 16 | - Consistent formatting of links and anchors 17 | - Removal of extraneous escape sequences 18 | - Automatic conversion of markup to free-form markup and vice versa if there 19 | are escape characters (e.g. `$Hello \\LaTeX!$` => `$|Hello \LaTeX!|$`) 20 | - Smart formatting of paragraphs to a specific line length while preserving proper link structures. 21 | 22 | # Usage 23 | 24 | ```sh 25 | norg-fmt 26 | ``` 27 | 28 | Currently `norg-fmt` is capable of formatting one file at a time. 29 | 30 | Available options may be viewed by running `norg-fmt --help`. The formatter will print to stdout, so feel 31 | free to pipe the output anywhere you might need. 32 | -------------------------------------------------------------------------------- /src/converter.rs: -------------------------------------------------------------------------------- 1 | use chumsky::{select, Parser}; 2 | use itertools::Itertools as _; 3 | use regex::Regex; 4 | use rust_norg::{LinkTarget, NorgASTFlat, ParagraphSegment}; 5 | 6 | fn format_link_target(input: LinkTarget) -> String { 7 | match input { 8 | LinkTarget::Heading { level, title } => { 9 | format!("{} {}", "*".repeat(level.into()), format_paragraph(title)) 10 | } 11 | LinkTarget::Footnote(title) => format!("^ {}", format_paragraph(title)), 12 | LinkTarget::Definition(title) => format!("$ {}", format_paragraph(title)), 13 | LinkTarget::Generic(title) => format!("# {}", format_paragraph(title)), 14 | LinkTarget::Wiki(title) => format!("? {}", format_paragraph(title)), 15 | LinkTarget::Extendable(title) => format!("= {}", format_paragraph(title)), 16 | LinkTarget::Path(path) => format!("/ {path}"), 17 | LinkTarget::Url(url) => url, 18 | LinkTarget::Timestamp(timestamp) => format!("@ {timestamp}"), 19 | } 20 | } 21 | 22 | fn format_link( 23 | filepath: Option, 24 | targets: Vec, 25 | description: Option>, 26 | ) -> String { 27 | let filepath = filepath.unwrap_or_default(); 28 | let targets = targets.into_iter().map(format_link_target).join(" : "); 29 | 30 | if let Some(description) = description.map(format_paragraph) { 31 | format!("{{{filepath}{targets}}}[{description}]") 32 | } else { 33 | format!("{{{filepath}{targets}}}") 34 | } 35 | } 36 | 37 | fn format_paragraph_segment(input: ParagraphSegment) -> String { 38 | use ParagraphSegment::*; 39 | 40 | match input { 41 | Token(token) => token.to_string(), 42 | //AttachedModifierCandidate { modifier_type, content, closer } => todo!(), 43 | AttachedModifier { 44 | modifier_type, 45 | content, 46 | } => format!( 47 | "{modifier_type}{}{modifier_type}", 48 | format_paragraph(content) 49 | ), 50 | Link { 51 | filepath, 52 | targets, 53 | description, 54 | } => format_link(filepath, targets, description), 55 | AnchorDefinition { content, target } => { 56 | let content = format_paragraph(content); 57 | 58 | match *target { 59 | Link { 60 | filepath, 61 | targets, 62 | description, 63 | } => { 64 | let link = format_link(filepath, targets, description); 65 | 66 | format!("[{content}]{link}") 67 | } 68 | _ => unreachable!(), 69 | } 70 | } 71 | Anchor { 72 | content, 73 | description, 74 | } => { 75 | let content = format_paragraph(content); 76 | 77 | if let Some(description) = description.map(format_paragraph) { 78 | format!("[{content}][{description}]") 79 | } else { 80 | format!("[{content}]") 81 | } 82 | } 83 | InlineLinkTarget(content) => format!("<{}>", format_paragraph(content)), 84 | _ => unreachable!(), 85 | } 86 | } 87 | 88 | fn reflow_paragraph(input: Vec) -> String { 89 | let whitespace_regex = Regex::new(r"\s+").unwrap(); 90 | let mergables = ["{", "[", "<"]; 91 | 92 | whitespace_regex 93 | .split(&input.join("")) 94 | .map_into() 95 | .coalesce(|first: String, second: String| { 96 | if mergables 97 | .iter() 98 | .any(|possibility| first.starts_with(possibility)) 99 | { 100 | Ok(first.to_string() + " " + &second) 101 | } else { 102 | Err((first, second)) 103 | } 104 | }) 105 | .fold::, _>(vec![String::default()], |mut lines, word| { 106 | let current_line = lines.last_mut().unwrap(); 107 | let new_len = word.len(); 108 | 109 | // This odd-looking less than operation is intentional, as we are also taking into 110 | // account the space that will be inserted. 111 | if current_line.len() + new_len < 80 { 112 | current_line.push_str(&(" ".to_string() + &word)); 113 | } else { 114 | *current_line = current_line.trim().to_string(); 115 | lines.push(word.to_string()); 116 | } 117 | 118 | lines 119 | }) 120 | .join("\n") 121 | .trim() 122 | .to_string() 123 | } 124 | 125 | fn format_paragraph(input: Vec) -> String { 126 | reflow_paragraph(input.into_iter().map(format_paragraph_segment).collect()) 127 | } 128 | 129 | pub fn format() -> impl Parser, Error = chumsky::error::Simple> 130 | { 131 | use NorgASTFlat::*; 132 | 133 | let formatter = select! { 134 | // TODO: Format attached modifier extensions. 135 | // TODO: Find way to appropriately propagate error messages. 136 | Heading { level, title, extensions: _ } => { 137 | format!("{} {}\n", "*".repeat(level.into()), title.into_iter().map_into::().collect::()) 138 | }, 139 | NestableDetachedModifier { modifier_type, level, content, extensions: _ } => { 140 | let content = format().parse(vec![*content]).unwrap().join("").replace("\n", &format!("\n{}", " ".repeat(level as usize + 1))); 141 | 142 | format!("{} {content}", modifier_type.to_string().repeat(level.into())) 143 | }, 144 | RangeableDetachedModifier { modifier_type, title, content, extensions: _ } => { 145 | let is_single_line = content.len() == 1 && matches!(content[0], Paragraph(_)); 146 | 147 | if is_single_line { 148 | format!("{modifier_type} {}\n{}", title.into_iter().map_into::().collect::(), format().parse(content).unwrap().join("")) 149 | } else { 150 | format!("{modifier_type}{modifier_type} {}\n{}\n$$\n", title.into_iter().map_into::().collect::(), format().parse(content).unwrap().join("")) 151 | } 152 | }, 153 | CarryoverTag { tag_type, name, parameters, next_object } => { 154 | let tag_type = match tag_type { 155 | rust_norg::CarryoverTag::Attribute => "+", 156 | rust_norg::CarryoverTag::Macro => "#", 157 | }; 158 | let name = name.join("."); 159 | let parameters = parameters.join(" "); 160 | let next_object = format().parse(vec![*next_object]).unwrap().join(""); 161 | 162 | format!("{tag_type}{name} {parameters}\n{next_object}") 163 | }, 164 | InfirmTag { name, parameters } => { 165 | let name = name.join("."); 166 | let parameters = parameters.join(" "); 167 | 168 | format!(".{name} {parameters}") 169 | }, 170 | VerbatimRangedTag { name, parameters, content } => { 171 | let name = name.join("."); 172 | let parameters = parameters.join(" "); 173 | 174 | // TODO: Make `content` respect indentation 175 | format!("@{name} {parameters}\n{content}@end\n") 176 | }, 177 | RangedTag { name, parameters, content } => { 178 | let name = name.join("."); 179 | let parameters = parameters.join(" "); 180 | let content = format().parse(content).unwrap().join(""); 181 | 182 | format!("|{name} {parameters}\n{content}|end\n") 183 | }, 184 | Paragraph(content) => format_paragraph(content) + "\n", 185 | }; 186 | 187 | formatter.repeated().at_least(1) 188 | } 189 | -------------------------------------------------------------------------------- /src/main.rs: -------------------------------------------------------------------------------- 1 | use chumsky::Parser as _; 2 | use clap::Parser as ClapParser; 3 | use converter::format; 4 | use eyre::Result; 5 | use rust_norg::parse; 6 | use std::path::PathBuf; 7 | 8 | mod converter; 9 | 10 | #[derive(ClapParser)] 11 | struct NorgFmt { 12 | /// The path of the file to format. 13 | file: PathBuf, 14 | 15 | /// (todo) Verify the output of the AST after the formatting. 16 | #[arg(long)] 17 | verify: bool, 18 | 19 | /// If true will add an extra newline after a heading title to separate the content. 20 | #[arg(long)] 21 | newline_after_headings: bool, 22 | 23 | /// If true will not forcefully give heading titles zero indentation. 24 | #[arg(long)] 25 | indent_headings: bool, 26 | 27 | /// Determines the maximum length of a paragraph's line. Default: 80. 28 | #[arg(long)] 29 | line_length: Option, 30 | } 31 | 32 | pub struct Config { 33 | newline_after_headings: bool, 34 | indent_headings: bool, 35 | line_length: usize, 36 | } 37 | 38 | impl Default for Config { 39 | fn default() -> Self { 40 | Self { 41 | newline_after_headings: false, 42 | indent_headings: false, 43 | line_length: 80, 44 | } 45 | } 46 | } 47 | 48 | fn main() -> Result<()> { 49 | let cli = NorgFmt::parse(); 50 | 51 | let config = Config { 52 | newline_after_headings: cli.newline_after_headings, 53 | indent_headings: cli.indent_headings, 54 | line_length: cli.line_length.unwrap_or(80), 55 | }; 56 | 57 | let file = cli.file; 58 | let content = String::from_utf8(std::fs::read(file)?)?; 59 | 60 | let ast = parse(&content).unwrap(); 61 | 62 | let (formatted_output, errors) = format().parse_recovery(ast); 63 | 64 | if let Some(formatted_output) = formatted_output { 65 | print!("{}", formatted_output.join("")); 66 | } 67 | 68 | Ok(()) 69 | } 70 | --------------------------------------------------------------------------------