├── COPYING ├── COPYING.LESSER ├── Makefile ├── README ├── bwxform.c ├── bwxform.h ├── optlist ├── .bzrignore ├── .gitignore ├── COPYING ├── COPYING.LESSER ├── Makefile ├── README ├── optlist.c ├── optlist.h ├── sample.c └── sample.cpp ├── sample.c └── test_this.sh /COPYING: -------------------------------------------------------------------------------- 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 | -------------------------------------------------------------------------------- /COPYING.LESSER: -------------------------------------------------------------------------------- 1 | GNU LESSER 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 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | ############################################################################ 2 | # Makefile for Burrows-Wheeler transform library and sample program 3 | # 4 | ############################################################################ 5 | CC = gcc 6 | LD = gcc 7 | CFLAGS = -O2 -Wall -Wextra -pedantic -ansi -c 8 | LDFLAGS = -O2 -o 9 | 10 | # libraries 11 | LIBS = -L. -Loptlist -lbwt -loptlist 12 | 13 | # Treat NT and non-NT windows the same 14 | ifeq ($(OS),Windows_NT) 15 | OS = Windows 16 | endif 17 | 18 | ifeq ($(OS),Windows) 19 | EXE = .exe 20 | DEL = del 21 | else #assume Linux/Unix 22 | EXE = 23 | DEL = rm -f 24 | endif 25 | 26 | all: sample$(EXE) 27 | 28 | sample$(EXE): sample.o libbwt.a optlist/liboptlist.a 29 | $(LD) $< $(LIBS) $(LDFLAGS) $@ 30 | 31 | sample.o: sample.c bwxform.h optlist/optlist.h 32 | $(CC) $(CFLAGS) $< 33 | 34 | libbwt.a: bwxform.o 35 | ar crv libbwt.a bwxform.o 36 | ranlib libbwt.a 37 | 38 | bwxform.o: bwxform.c bwxform.h 39 | $(CC) $(CFLAGS) $< 40 | 41 | optlist/liboptlist.a: 42 | cd optlist && $(MAKE) liboptlist.a 43 | 44 | clean: 45 | $(DEL) *.o 46 | $(DEL) *.a 47 | $(DEL) sample$(EXE) 48 | cd optlist && $(MAKE) clean 49 | -------------------------------------------------------------------------------- /README: -------------------------------------------------------------------------------- 1 | DESCRIPTION 2 | ----------- 3 | This archive contains a simple and readable ANSI C implementation of the 4 | Burrows-Wheeler transformation (BWT) and its reverse transformation. The 5 | code for this implementation is derived directly from "A Block-sorting 6 | Lossless Data Compression Algorithm" by M. Burrows and D.J. Wheeler. 7 | 8 | A PDF copy of the document may be found at: 9 | ftp://apotheca.hpl.hp.com/pub/dec/SRC/research-reports/SRC-124.pdf 10 | 11 | More information on Burrows-Wheeler Transform may be found at: 12 | https://michaeldipperstein.github.io/bwt.html 13 | 14 | FILES 15 | ----- 16 | bwxform.c - Library of Burrows-Wheeler transform (BWT) routines. 17 | bwxform.h - Header containing prototypes for library functions. 18 | COPYING - Rules for copying and distributing GPL software 19 | COPYING.LESSER - Rules for copying and distributing LGPL software 20 | Makefile - makefile for this project (assumes gcc compiler and GNU make) 21 | README - this file 22 | sample.c - Demonstration of how to use BWT library functions 23 | optlist/ - Subtree containing optlist command line option parser library 24 | 25 | BUILDING 26 | -------- 27 | To build these files with GNU make and gcc, simply enter "make" from the 28 | command line. The executable will be named sample (or sample.exe). 29 | 30 | GIT NOTE: Updates to the subtree optlist don't get pulled by "git pull" 31 | Use the following commands to pull their updates: 32 | git subtree pull --prefix optlist https://github.com/MichaelDipperstein/optlist.git master --squash 33 | 34 | 35 | USAGE 36 | ----- 37 | Usage: sample 38 | 39 | options: 40 | -c : Encode input file to output file. 41 | -d : Decode input file to output file. 42 | -m : Perform the Move-to-Front coding. 43 | -i : Name of input file. 44 | -o : Name of output file. 45 | -h|? : Print out command line options. 46 | 47 | -c Generate a probability range list for the specified input file 48 | (see -i) then use arithmetic coding compresses the file using the 49 | range list to the specified output file (see -o). 50 | 51 | -d Decompresses the specified input file (see -i) writing the results to 52 | the specified output file (see -o). Only files compressed by this 53 | program may be decompressed. 54 | 55 | -m Perform move to front encoding/decoding on each block. 56 | 57 | -i The name of the input file. There is no valid usage of this 58 | program without a specified input file. 59 | 60 | -o The name of the output file. If no file is specified, stdout 61 | will be used. NOTE: Sending compressed output to stdout may 62 | produce undesirable results. 63 | 64 | LIBRARY API 65 | ----------- 66 | Transforming Data: 67 | int BWXform(FILE *fpIn, FILE *fpOut, const xform_t method); 68 | fpIn 69 | The file stream to be transformed. It must non-NULL and opened. 70 | fpOut 71 | The file stream receiving the transformed data. It must non-NULL and 72 | opened. 73 | method 74 | xform_t type value indicating whether indicate whether or not MTF is used. 75 | Return Value 76 | Zero for success, non-zero for failure. 77 | 78 | Reverse Transforming Data: 79 | int BWXform(FILE *fpIn, FILE *fpOut, const xform_t method); 80 | fpIn 81 | The file stream to be reverse transformed. It must non-NULL and opened. 82 | fpOut 83 | The file stream receiving the reverse transformed data. It must non-NULL 84 | and opened. 85 | method 86 | xform_t type value indicating whether indicate whether or not MTF is used. 87 | Return Value 88 | Zero for success, non-zero for failure. 89 | 90 | HISTORY 91 | ------- 92 | 08/20/04 - Initial Release 93 | 08/25/04 - Don't prefix blocks with block size. Use value returned 94 | by fread() to recognize partial blocks instead. 95 | 05/02/05 - Allocating large arrays on heap instead of stack so that 96 | gcc can handle larger blocks. 97 | 11/03/05 - Sort algorithm is now similar to the "faster method" in the 98 | Burrows and Wheeler paper. 99 | 08/29/07 - Explicitly licensed under LGPL version 3. 100 | - Replaces getopt() with optlist library 101 | 10/29/14 - Changed the API so that encode and decode routines accept opened 102 | file streams instead of file names. 103 | - Upgrade to latest Oplist library 104 | - Tighter adherence to Michael Barr's "Top 10 Bug-Killing Coding 105 | Standard Rules" (http://www.barrgroup.com/webinars/10rules). 106 | 07/15/17 - Directory stucture changes for ease of use with GitHub 107 | - Included a test script that I've always used to test things 108 | 09/19/19 - Update e-mail address 109 | - pull the latest optlist 110 | 111 | TODO 112 | ---- 113 | - Use "known" efficient Move-To-Front algorithm 114 | - Investigate suffix tree based sorting solutions 115 | - There are several papers claiming speed improvements 116 | 117 | AUTHOR 118 | ------ 119 | Michael Dipperstein (mdipperstein@gmail.com) 120 | https://michaeldipperstein.github.io/ 121 | -------------------------------------------------------------------------------- /bwxform.c: -------------------------------------------------------------------------------- 1 | /*************************************************************************** 2 | * Burrows-Wheeler Transform Library 3 | * 4 | * File : bwxform.c 5 | * Purpose : Provides prototypes for functions that apply and reverse the 6 | * Burrows-Wheeler transform (with or without move to front 7 | * coding/decoding). The algorithms implemented are based upon 8 | * those described in "A Block-sorting Lossless Data Compression 9 | * Algorithm" by M. Burrows and D.J. Wheeler. 10 | * Author : Michael Dipperstein 11 | * Date : August 20, 2004 12 | * 13 | **************************************************************************** 14 | * 15 | * bwxform: An ANSI C Burrows-Wheeler Transform/Reverse Transform Routines 16 | * Copyright (C) 2004-2005, 2007, 2014 by 17 | * Michael Dipperstein (mdipperstein@gmail.com) 18 | * 19 | * This file is part of the BWT library. 20 | * 21 | * The BWT library is free software; you can redistribute it and/or modify 22 | * it under the terms of the GNU Lesser General Public License as published 23 | * by the Free Software Foundation; either version 3 of the License, or (at 24 | * your option) any later version. 25 | * 26 | * The BWT library is distributed in the hope that it will be useful, but 27 | * WITHOUT ANY WARRANTY; without even the implied warranty of 28 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 29 | * General Public License for more details. 30 | * 31 | * You should have received a copy of the GNU Lesser General Public License 32 | * along with this program. If not, see . 33 | * 34 | ***************************************************************************/ 35 | 36 | /*************************************************************************** 37 | * INCLUDED FILES 38 | ***************************************************************************/ 39 | #include 40 | #include 41 | #include 42 | #include 43 | #include 44 | #include "bwxform.h" 45 | 46 | /*************************************************************************** 47 | * CONSTANTS 48 | ***************************************************************************/ 49 | #define BLOCK_SIZE 4096 /* size of blocks */ 50 | 51 | #if BLOCK_SIZE > INT_MAX 52 | #error BLOCK_SIZE must be <= INT_MAX and maximum size_t 53 | #endif 54 | 55 | /* NOTE: Need to find a way to check for maximum size_t */ 56 | 57 | /*************************************************************************** 58 | * TYPE DEFINITIONS 59 | ***************************************************************************/ 60 | 61 | /*************************************************************************** 62 | * GLOBAL VARIABLES 63 | ***************************************************************************/ 64 | static unsigned char block[BLOCK_SIZE]; /* block being (un)transformed */ 65 | static size_t blockSize; /* actual size of block */ 66 | 67 | /*************************************************************************** 68 | * MACROS 69 | ***************************************************************************/ 70 | /* wraps array index within array bounds (assumes value < 2 * limit) */ 71 | #define Wrap(value, limit) (((value) < (limit)) ? (value) : ((value) - (limit))) 72 | 73 | /*************************************************************************** 74 | * PROTOTYPES 75 | ***************************************************************************/ 76 | /* move to front functions */ 77 | static int DoMTF(const unsigned char *const last, const int length); 78 | static int UndoMTF(unsigned char *const last, const int length); 79 | 80 | /*************************************************************************** 81 | * FUNCTIONS 82 | ***************************************************************************/ 83 | 84 | /*************************************************************************** 85 | * Function : ComparePresorted 86 | * Description: This comparison function is designed for use with qsort 87 | * and "block", a global array of "blockSize" unsigned chars. 88 | * It compares two strings in "block" starting at indices 89 | * s1 and s2 and ending at indices s1 - 1 and s2 - 1. 90 | * The strings are assumed to be presorted so that first two 91 | * characters are known to be matching. 92 | * Parameters : s1 - The starting index of a string in block 93 | * s2 - The starting index of a string in block 94 | * Effects : NONE 95 | * Returned : > 0 if string s1 > string s2 96 | * 0 if string s1 == string s2 97 | * < 0 if string s1 < string s2 98 | ***************************************************************************/ 99 | static int ComparePresorted(const void *s1, const void *s2) 100 | { 101 | unsigned int offset1, offset2; 102 | unsigned int i; 103 | 104 | /*********************************************************************** 105 | * Compare 1 character at a time until there's difference or the end of 106 | * the block is reached. Since we're only sorting strings that already 107 | * match at the first two characters, start with the third character. 108 | ***********************************************************************/ 109 | offset1 = *((unsigned int *)s1) + 2; 110 | offset2 = *((unsigned int *)s2) + 2; 111 | 112 | for(i = 2; i < blockSize; i++) 113 | { 114 | unsigned char c1, c2; 115 | 116 | /* ensure that offsets are properly bounded */ 117 | if (offset1 >= blockSize) 118 | { 119 | offset1 -= blockSize; 120 | } 121 | 122 | if (offset2 >= blockSize) 123 | { 124 | offset2 -= blockSize; 125 | } 126 | 127 | c1 = block[offset1]; 128 | c2 = block[offset2]; 129 | 130 | if (c1 > c2) 131 | { 132 | return 1; 133 | } 134 | else if (c2 > c1) 135 | { 136 | return -1; 137 | } 138 | 139 | /* strings match to here, try next character */ 140 | offset1++; 141 | offset2++; 142 | } 143 | 144 | /* strings are identical */ 145 | return 0; 146 | } 147 | 148 | /*************************************************************************** 149 | * Function : BWXform 150 | * Description: This function performs a Burrows-Wheeler transformation 151 | * on a file (with optional move to front) and writes the 152 | * resulting data to the specified output file. Comments in 153 | * this function indicate corresponding variables, labels, 154 | * and sections in "A Block-sorting Lossless Data Compression 155 | * Algorithm" by M. Burrows and D.J. Wheeler. 156 | * Parameters : fpIn - FILE pointer to file to transform 157 | * fpOut - FILE pointer to file to write transformed output 158 | * method - Set to XFORM_WITH_MTF if move to front coding 159 | * should be applied. 160 | * Effects : A Burrows-Wheeler transformation (and possibly move to 161 | * front encoding) is applied to fpIn. The results of 162 | * the transformation are written to fpOut. 163 | * Returned : Zero for success, otherwise non-zero. 164 | ***************************************************************************/ 165 | int BWXform(FILE *fpIn, FILE *fpOut, const xform_t method) 166 | { 167 | unsigned int i, j, k; 168 | unsigned int *rotationIdx; /* index of first char in rotation */ 169 | unsigned int *v; /* index of radix sorted charaters */ 170 | int s0Idx; /* index of S0 in rotations (I) */ 171 | unsigned char *last; /* last characters from sorted rotations */ 172 | 173 | /* counters and offsets used for radix sorting with characters */ 174 | unsigned int counters[256]; 175 | unsigned int offsetTable[256]; 176 | 177 | if ((NULL == fpIn) || (NULL == fpOut)) 178 | { 179 | fprintf(stderr, "Invalid File Pointer Arguments\n"); 180 | return -1; 181 | } 182 | 183 | /*********************************************************************** 184 | * BLOCK_SIZE arrays are allocated on the heap, because gcc generates 185 | * code that throws a Segmentation fault when the large arrays are 186 | * allocated on the stack. 187 | ***********************************************************************/ 188 | rotationIdx = (unsigned int *)malloc(BLOCK_SIZE * sizeof(unsigned int)); 189 | 190 | if (NULL == rotationIdx) 191 | { 192 | perror("Allocating array of rotation indices"); 193 | return errno; 194 | } 195 | 196 | v = (unsigned int *)malloc(BLOCK_SIZE * sizeof(unsigned int)); 197 | 198 | if (v == rotationIdx) 199 | { 200 | perror("Allocating array of sort indices"); 201 | free(rotationIdx); 202 | return errno; 203 | } 204 | 205 | last = (unsigned char *)malloc(BLOCK_SIZE * sizeof(unsigned char)); 206 | 207 | if (NULL == last) 208 | { 209 | perror("Allocating array of last characters"); 210 | free(rotationIdx); 211 | free(v); 212 | return errno; 213 | } 214 | 215 | while((blockSize = fread(block, sizeof(unsigned char), BLOCK_SIZE, fpIn)) 216 | != 0) 217 | { 218 | /******************************************************************* 219 | * Sort the rotated strings in the block. A radix sort is performed 220 | * on the first to characters of all the rotated strings (2nd 221 | * character then 1st). All rotated strings with matching initial 222 | * characters are then quicksorted. - Q4..Q7 223 | *******************************************************************/ 224 | 225 | /*** radix sort on second character in rotation ***/ 226 | 227 | /* count number of characters for radix sort */ 228 | memset(counters, 0, 256 * sizeof(int)); 229 | for (i = 0; i < blockSize; i++) 230 | { 231 | counters[block[i]]++; 232 | } 233 | 234 | offsetTable[0] = 0; 235 | 236 | for(i = 1; i < 256; i++) 237 | { 238 | /* determine number of values before those sorted under i */ 239 | offsetTable[i] = offsetTable[i - 1] + counters[i - 1]; 240 | } 241 | 242 | /* sort on 2nd character */ 243 | for (i = 0; i < blockSize - 1; i++) 244 | { 245 | j = block[i + 1]; 246 | v[offsetTable[j]] = i; 247 | offsetTable[j] = offsetTable[j] + 1; 248 | } 249 | 250 | /* handle wrap around for string starting at end of block */ 251 | j = block[0]; 252 | v[offsetTable[j]] = i; 253 | offsetTable[0] = 0; 254 | 255 | /*** radix sort on first character in rotation ***/ 256 | 257 | for(i = 1; i < 256; i++) 258 | { 259 | /* determine number of values before those sorted under i */ 260 | offsetTable[i] = offsetTable[i - 1] + counters[i - 1]; 261 | } 262 | 263 | for (i = 0; i < blockSize; i++) 264 | { 265 | j = v[i]; 266 | j = block[j]; 267 | rotationIdx[offsetTable[j]] = v[i]; 268 | offsetTable[j] = offsetTable[j] + 1; 269 | } 270 | 271 | /******************************************************************* 272 | * now rotationIdx contains the sort order of all strings sorted 273 | * by their first 2 characters. Use qsort to sort the strings 274 | * that have their first two characters matching. 275 | *******************************************************************/ 276 | for (i = 0, k = 0; (i <= UCHAR_MAX) && (k < (blockSize - 1)); i++) 277 | { 278 | for (j = 0; (j <= UCHAR_MAX) && (k < (blockSize - 1)); j++) 279 | { 280 | unsigned int first = k; 281 | 282 | /* count strings starting with ij */ 283 | while ((i == block[rotationIdx[k]]) && 284 | (j == block[Wrap(rotationIdx[k] + 1, blockSize)])) 285 | { 286 | k++; 287 | 288 | if (k == blockSize) 289 | { 290 | /* we've searched the whole block */ 291 | break; 292 | } 293 | } 294 | 295 | if (k - first > 1) 296 | { 297 | /* there are at least 2 strings staring with ij, sort them */ 298 | qsort(&rotationIdx[first], k - first, sizeof(int), 299 | ComparePresorted); 300 | } 301 | } 302 | } 303 | 304 | /* find last characters of rotations (L) - C2 */ 305 | s0Idx = 0; 306 | for (i = 0; i < blockSize; i++) 307 | { 308 | if (rotationIdx[i] != 0) 309 | { 310 | last[i] = block[rotationIdx[i] - 1]; 311 | } 312 | else 313 | { 314 | /* unrotated string 1st character is end of string */ 315 | s0Idx = i; 316 | last[i] = block[blockSize - 1]; 317 | } 318 | } 319 | 320 | if (XFORM_WITH_MTF == method) 321 | { 322 | int ret; 323 | 324 | ret = DoMTF(last, blockSize); 325 | 326 | if (ret) 327 | { 328 | free(rotationIdx); 329 | free(v); 330 | free(last); 331 | return errno; 332 | } 333 | } 334 | 335 | /* write index of end of unrotated string (I) */ 336 | fwrite(&s0Idx, sizeof(int), 1, fpOut); 337 | 338 | /* write out last characters of rotations (L) */ 339 | fwrite(last, sizeof(unsigned char), blockSize, fpOut); 340 | } 341 | 342 | /* clean up */ 343 | free(rotationIdx); 344 | free(v); 345 | free(last); 346 | return 0; 347 | } 348 | 349 | /*************************************************************************** 350 | * Function : DoMTF 351 | * Description: This function performs move to front encoding on a block 352 | * on of data that has already had the Burrows-Wheeler 353 | * transformation applied to it. Comments in this function 354 | * indicate corresponding variables, labels, and sections in 355 | * "A Block-sorting Lossless Data Compression Algorithm" by 356 | * M. Burrows and D.J. Wheeler. 357 | * Parameters : last - pointer an array of "last" characters from 358 | * Burrows-Wheeler rotations (L) 359 | * length - the number of unsigned chars contained in last. 360 | * Effects : Move to front encoding is applied on an array of last 361 | * characters. The results of the encoding replace the data 362 | * that was stored in last. 363 | * Returned : Zero for success, otherwise non-zero. 364 | ***************************************************************************/ 365 | static int DoMTF(const unsigned char *const last, const int length) 366 | { 367 | unsigned char list[UCHAR_MAX + 1]; /* list of characters (Y) */ 368 | unsigned char *encoded; /* mtf encoded block (R) */ 369 | int i, j; 370 | 371 | /*********************************************************************** 372 | * BLOCK_SIZE arrays are allocated on the heap, because gcc generates 373 | * code that throws a Segmentation fault when the large arrays are 374 | * allocated on the stack. 375 | ***********************************************************************/ 376 | encoded = (unsigned char *)malloc(length * sizeof(unsigned char)); 377 | 378 | if (NULL == encoded) 379 | { 380 | perror("Allocating array to store MTF encoding"); 381 | return errno; 382 | } 383 | 384 | /* start with alphabetically sorted list of characters */ 385 | for(i = 0; i <= UCHAR_MAX; i++) 386 | { 387 | list[i] = (unsigned char)i; 388 | } 389 | 390 | /* move-to-front coding - M1 */ 391 | for (i = 0; i < length; i++) 392 | { 393 | /******************************************************************* 394 | * Find the character in the list of characters. I do a sequential 395 | * search because move to front causes common characters to be 396 | * near the front of the list. 397 | *******************************************************************/ 398 | for (j = 0; j <= UCHAR_MAX; j++) 399 | { 400 | if (list[j] == last[i]) 401 | { 402 | /* we found the character */ 403 | encoded[i] = j; 404 | break; 405 | } 406 | } 407 | 408 | /* now move the current character to the front of the list */ 409 | memmove(&(list[1]), list, j); 410 | list[0] = last[i]; 411 | } 412 | 413 | /* copy mtf encoded vector of last characters (R) to input */ 414 | memcpy((void *)last, (void *)encoded, sizeof(unsigned char) * length); 415 | free(encoded); 416 | 417 | return 0; 418 | } 419 | 420 | /*************************************************************************** 421 | * Function : BWReverseXformFile 422 | * Description: This function reverses a Burrows-Wheeler transformation 423 | * on a file (with optional move to front) and writes the 424 | * resulting data to the specified output file. Comments in 425 | * this function indicate corresponding variables, labels, 426 | * and sections in "A Block-sorting Lossless Data Compression 427 | * Algorithm" by M. Burrows and D.J. Wheeler. 428 | * Parameters : fpIn - FILE pointer to file to reverse transform 429 | * fpOut - FILE pointer to file to write reverse transformed 430 | * output to 431 | * method - Set to XFORM_WITH_MTF if move to front coding 432 | * should be applied. 433 | * Effects : A Burrows-Wheeler reverse transformation (and possibly 434 | * move to front encoding) is applied to fpIn. The results 435 | * of the reverse transformation are written to fpOut. 436 | * Returned : Zero for success, otherwise non-zero. 437 | ***************************************************************************/ 438 | int BWReverseXform(FILE *fpIn, FILE *fpOut, const xform_t method) 439 | { 440 | unsigned int i, j, sum; 441 | int count[UCHAR_MAX + 1]; /* count[i] = # of chars in block <= i */ 442 | int *pred; /* pred[i] = # of times block[i] appears in 443 | block[0 .. i - 1] */ 444 | unsigned char *unrotated; /* original block */ 445 | int s0Idx; /* index of S0 in rotations (I) */ 446 | 447 | if ((NULL == fpIn) || (NULL == fpOut)) 448 | { 449 | fprintf(stderr, "Invalid File Pointer Arguments\n"); 450 | return -1; 451 | } 452 | 453 | /*********************************************************************** 454 | * BLOCK_SIZE arrays are allocated on the heap, because gcc generates 455 | * code that throws a Segmentation fault when the large arrays are 456 | * allocated on the stack. 457 | ***********************************************************************/ 458 | pred = (int *)malloc(BLOCK_SIZE * sizeof(int)); 459 | 460 | if (NULL == pred) 461 | { 462 | perror("Allocating array of matching predecessors"); 463 | return errno; 464 | } 465 | 466 | unrotated = (unsigned char *)malloc(BLOCK_SIZE * sizeof(unsigned char)); 467 | 468 | if (NULL == unrotated) 469 | { 470 | perror("Allocating array to store unrotated block"); 471 | free(pred); 472 | return errno; 473 | } 474 | 475 | while(fread(&s0Idx, sizeof(int), 1, fpIn) != 0) 476 | { 477 | blockSize = fread(block, sizeof(unsigned char), BLOCK_SIZE, fpIn); 478 | 479 | if (XFORM_WITH_MTF == method) 480 | { 481 | int ret; 482 | 483 | ret = UndoMTF(block, blockSize); 484 | 485 | if (ret) 486 | { 487 | free(pred); 488 | free(unrotated); 489 | return ret; 490 | } 491 | } 492 | 493 | /* code based on pseudo code from section 4.2 (D1 and D2) follows */ 494 | for(i = 0; i <= UCHAR_MAX; i++) 495 | { 496 | count[i] = 0; 497 | } 498 | 499 | /******************************************************************* 500 | * Set pred[i] to the number of times block[i] appears in the 501 | * substring block[0 .. i - 1]. As a useful side effect count[i] 502 | * will be the number of times character i appears in block. 503 | *******************************************************************/ 504 | for (i = 0; i < blockSize; i++) 505 | { 506 | pred[i] = count[block[i]]; 507 | count[block[i]]++; 508 | } 509 | 510 | /******************************************************************* 511 | * Finally, set count[i] to the number of characters in block 512 | * lexicographically less than i. 513 | *******************************************************************/ 514 | sum = 0; 515 | for(i = 0; i <= UCHAR_MAX; i++) 516 | { 517 | j = count[i]; 518 | count[i] = sum; 519 | sum += j; 520 | } 521 | 522 | /* construct the initial unrotated string (S[0]) */ 523 | i = s0Idx; 524 | for(j = blockSize; j > 0; j--) 525 | { 526 | unrotated[j - 1] = block[i]; 527 | i = pred[i] + count[block[i]]; 528 | } 529 | 530 | fwrite(unrotated, sizeof(unsigned char), blockSize, fpOut); 531 | } 532 | 533 | /* clean up */ 534 | free(pred); 535 | free(unrotated); 536 | return 0; 537 | } 538 | 539 | /*************************************************************************** 540 | * Function : UndoMTF 541 | * Description: This function reverses move to front encoding on a block 542 | * on of data that has already had the Burrows-Wheeler 543 | * transformation applied to it. Comments in this function 544 | * indicate corresponding variables, labels, and sections in 545 | * "A Block-sorting Lossless Data Compression Algorithm" by 546 | * M. Burrows and D.J. Wheeler. 547 | * Parameters : last - pointer an array of mtf encoded characters from 548 | * Burrows-Wheeler rotations. 549 | * length - the number of unsigned chars contained in last. 550 | * Effects : Move to front encoding is reversed on an array of last 551 | * characters. The results of the reversal are stored in 552 | * the array last (L), providing an array of last characters 553 | * of sorted rotations. 554 | * Returned : Zero for success, otherwise non-zero. 555 | ***************************************************************************/ 556 | static int UndoMTF(unsigned char *const last, const int length) 557 | { 558 | unsigned char list[UCHAR_MAX + 1]; /* list of characters (Y) */ 559 | unsigned char *encoded; /* mtf encoded block (R) */ 560 | int i; 561 | 562 | /*********************************************************************** 563 | * BLOCK_SIZE arrays are allocated on the heap, because gcc generates 564 | * code that throws a Segmentation fault when the large arrays are 565 | * allocated on the stack. 566 | ***********************************************************************/ 567 | encoded = (unsigned char *)malloc(length * sizeof(unsigned char)); 568 | 569 | if (NULL == encoded) 570 | { 571 | perror("Allocating array to store MTF encoding"); 572 | return errno; 573 | } 574 | 575 | /* copy last into encoded */ 576 | memcpy((void *)encoded, (void *)last, sizeof(unsigned char) * length); 577 | 578 | /* start with alphabetically sorted list of characters */ 579 | for(i = 0; i <= UCHAR_MAX; i++) 580 | { 581 | list[i] = (unsigned char)i; 582 | } 583 | 584 | /* move-to-front decoding - W2 */ 585 | for (i = 0; i < length; i++) 586 | { 587 | /* decode the character */ 588 | last[i] = list[encoded[i]]; 589 | 590 | /* now move the current character to the front of the list */ 591 | memmove(&(list[1]), list, encoded[i]); 592 | list[0] = last[i]; 593 | } 594 | 595 | free(encoded); 596 | return 0; 597 | } 598 | -------------------------------------------------------------------------------- /bwxform.h: -------------------------------------------------------------------------------- 1 | /*************************************************************************** 2 | * Header for Burrows-Wheeler Transform Library 3 | * 4 | * File : bwxform.h 5 | * Purpose : Provides that apply and reverse the Burrows-Wheeler transform 6 | * (with or without move to front coding/decoding. 7 | * transformation). 8 | * Author : Michael Dipperstein 9 | * Date : August 20, 2004 10 | * 11 | **************************************************************************** 12 | * 13 | * bwxform: An ANSI C Burrows-Wheeler Transform/Reverse Transform Routines 14 | * Copyright (C) 2004-2005, 2007, 2014 by 15 | * Michael Dipperstein (mdipperstein@gmail.com) 16 | * 17 | * This file is part of the BWT library. 18 | * 19 | * The BWT library is free software; you can redistribute it and/or modify 20 | * it under the terms of the GNU Lesser General Public License as published 21 | * by the Free Software Foundation; either version 3 of the License, or (at 22 | * your option) any later version. 23 | * 24 | * The BWT library is distributed in the hope that it will be useful, but 25 | * WITHOUT ANY WARRANTY; without even the implied warranty of 26 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 27 | * General Public License for more details. 28 | * 29 | * You should have received a copy of the GNU Lesser General Public License 30 | * along with this program. If not, see . 31 | * 32 | ***************************************************************************/ 33 | 34 | #ifndef _BWXFORM_H_ 35 | #define _BWXFORM_H_ 36 | 37 | /*************************************************************************** 38 | * CONSTANTS 39 | ***************************************************************************/ 40 | typedef enum 41 | { 42 | XFORM_WITHOUT_MTF = 0, 43 | XFORM_WITH_MTF = 1 44 | } xform_t; 45 | 46 | /*************************************************************************** 47 | * PROTOTYPES 48 | ***************************************************************************/ 49 | 50 | /*************************************************************************** 51 | * Transform/Reverse Transform file stream fpIn writing results to fpOut. 52 | * Use method to indicate whether or not to use MTF. 53 | * Zero is returned on success. 54 | ***************************************************************************/ 55 | /* Transform/Reverse Tran fpIn save results to fpOut. Use MTF if mtf is TRUE */ 56 | int BWXform(FILE *fpIn, FILE *fpOut, const xform_t method); 57 | int BWReverseXform(FILE *fpIn, FILE *fpOut, const xform_t method); 58 | 59 | #endif /* ndef _BWXFORM_H_ */ 60 | -------------------------------------------------------------------------------- /optlist/.bzrignore: -------------------------------------------------------------------------------- 1 | backup.bzr 2 | -------------------------------------------------------------------------------- /optlist/.gitignore: -------------------------------------------------------------------------------- 1 | liboptlist.a 2 | optlist.o 3 | sample 4 | sample.o 5 | sample_cpp 6 | sample_cpp.o 7 | -------------------------------------------------------------------------------- /optlist/COPYING: -------------------------------------------------------------------------------- 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 | -------------------------------------------------------------------------------- /optlist/COPYING.LESSER: -------------------------------------------------------------------------------- 1 | GNU LESSER 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 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | -------------------------------------------------------------------------------- /optlist/Makefile: -------------------------------------------------------------------------------- 1 | ############################################################################ 2 | # Makefile for oplist command line library sample 3 | ############################################################################ 4 | CC = gcc 5 | LD = gcc 6 | CFLAGS = -I. -O3 -Wall -Wextra -pedantic -ansi -c 7 | LDFLAGS = -O3 -o 8 | 9 | CXX = g++ 10 | CXXFLAGS = -I. -O3 -Wall -Wextra -c 11 | 12 | # libraries 13 | LIBS = -L. -loptlist 14 | 15 | # Treat NT and non-NT windows the same 16 | ifeq ($(OS),Windows_NT) 17 | OS = Windows 18 | endif 19 | 20 | ifeq ($(OS),Windows) 21 | EXE = .exe 22 | DEL = del 23 | else #assume Linux/Unix 24 | EXE = 25 | DEL = rm -f 26 | endif 27 | 28 | all: sample$(EXE) sample_cpp$(EXE) liboptlist.a 29 | 30 | sample$(EXE): sample.o liboptlist.a 31 | $(LD) $< $(LIBS) $(LDFLAGS) $@ 32 | 33 | sample.o: sample.c optlist.h 34 | $(CC) $(CFLAGS) $< 35 | 36 | sample_cpp$(EXE): sample_cpp.o liboptlist.a 37 | $(CXX) $< $(LIBS) $(LDFLAGS) $@ 38 | 39 | sample_cpp.o: sample.cpp optlist.h 40 | $(CXX) $(CXXFLAGS) $< -o $@ 41 | 42 | liboptlist.a: optlist.o 43 | ar crv liboptlist.a optlist.o 44 | ranlib liboptlist.a 45 | 46 | optlist.o: optlist.c optlist.h 47 | $(CC) $(CFLAGS) $< 48 | 49 | clean: 50 | $(DEL) *.o 51 | $(DEL) sample$(EXE) sample_cpp$(EXE) liboptlist.a 52 | -------------------------------------------------------------------------------- /optlist/README: -------------------------------------------------------------------------------- 1 | DESCRIPTION 2 | ----------- 3 | This archive contains the source code and supporting documentation for OptList, 4 | an ANSI C command line option parser library. 5 | 6 | OptList is released under the GNU LGPL version 3.0. 7 | 8 | The latest revision of this program may be found at: 9 | https://michaeldipperstein.github.io/optlist.html 10 | 11 | FILES 12 | ----- 13 | COPYING - Rules for copying and distributing GNU GPL software 14 | COPYING.LESSER - Rules for copying and distributing GNU LGPL software 15 | optlist.c - Source code for the Optlist function and supporting 16 | function. 17 | optlist.h - Header file to be included by code using OptList 18 | Makefile - Makefile for this project (assumes gcc compiler and GNU make) 19 | README - This file 20 | sample.c - A small program demonstrating how to use OptList 21 | sample.cpp - A small c++ program demonstrating how to use OptList 22 | 23 | BUILDING 24 | -------- 25 | To build these files with GNU make and gcc: 26 | 1. Windows users should define the environment variable OS to be Windows or 27 | Windows_NT. This is often already done. 28 | 2. Enter the command "make" from the command line. 29 | 30 | USAGE 31 | ----- 32 | The file sample.c demonstrates the usage of OptList. 33 | 34 | SYNOPSIS 35 | typedef struct option_t 36 | { 37 | char option; 38 | char *argument; 39 | int argIndex; 40 | struct option_t *next; 41 | } option_t; 42 | 43 | option_t *GetOptList(int argc, char *const argv[], char *const options); 44 | 45 | 46 | DESCRIPTION 47 | The GetOptList() function is similar to getopt(). Its most notable differences 48 | are that it returns a linked list to the command line arguments and their 49 | parameters. One call to GetOptList() will return all of the command line 50 | options and their arguments. GetOptList() will not modify argc or argv. 51 | 52 | GetOptList()'s parameters "argc" and "argv" are the argument count and array as 53 | passed to the main() function on program invocation. An element of argv that 54 | starts with "-" is an option element. The character following the "-" is option 55 | an character. 56 | 57 | The parameter "options" is a string containing the legitimate option characters. 58 | If such a character is followed by a colon, the option requires an argument. 59 | (e.g. "a:bc?" a, b ,c, and, ? are all options. a should be followed by an 60 | argument.) 61 | 62 | GetOptList() returns a linked list of type option_t. The "*next" field of the 63 | element at the end of the list will be set to NULL. The "option" field will 64 | contain the option character. A pointer to the following text in the same 65 | argv-element, or the text of the following argv-element will be stored in the 66 | "arguement" field, otherwise the "arguement" field is set to NULL. The index 67 | of the argv-element containing the argument will be stored in the "argIndex". 68 | If there is no argument, the field will contain OL_NOINDEX. 69 | 70 | HISTORY 71 | ------- 72 | 08/01/07 - Initial release 73 | 09/13/14 - Added FindFileName function, because I always use it with GetOptList 74 | Tighter adherence to Michael Barr's "Top 10 Bug-Killing Coding 75 | Standard Rules" (http://www.barrgroup.com/webinars/10rules). 76 | 10/18/18 - Made header compatible with c++ and added c++ example 77 | 09/19/19 - change e-mail address from ucsb to gmail 78 | 79 | TODO 80 | ---- 81 | - Add support for --option_name 82 | 83 | AUTHOR 84 | ------ 85 | Michael Dipperstein (mdipperstein@gmail.com) 86 | -------------------------------------------------------------------------------- /optlist/optlist.c: -------------------------------------------------------------------------------- 1 | /*************************************************************************** 2 | * Command Line Option Parser 3 | * 4 | * File : optlist.c 5 | * Purpose : Provide getopt style command line option parsing 6 | * Author : Michael Dipperstein 7 | * Date : August 1, 2007 8 | * 9 | **************************************************************************** 10 | * 11 | * OptList: A command line option parsing library 12 | * Copyright (C) 2007, 2014 by 13 | * Michael Dipperstein (mdipperstein@gmail.com) 14 | * 15 | * This file is part of the OptList library. 16 | * 17 | * OptList is free software; you can redistribute it and/or modify it 18 | * under the terms of the GNU Lesser General Public License as published by 19 | * the Free Software Foundation; either version 3 of the License, or (at 20 | * your option) any later version. 21 | * 22 | * OptList is distributed in the hope that it will be useful, but 23 | * WITHOUT ANY WARRANTY; without even the implied warranty of 24 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 25 | * General Public License for more details. 26 | * 27 | * You should have received a copy of the GNU Lesser General Public License 28 | * along with this program. If not, see . 29 | * 30 | ***************************************************************************/ 31 | 32 | /*************************************************************************** 33 | * INCLUDED FILES 34 | ***************************************************************************/ 35 | #include "optlist.h" 36 | #include 37 | #include 38 | #include 39 | 40 | /*************************************************************************** 41 | * TYPE DEFINITIONS 42 | ***************************************************************************/ 43 | 44 | /*************************************************************************** 45 | * CONSTANTS 46 | ***************************************************************************/ 47 | 48 | /*************************************************************************** 49 | * GLOBAL VARIABLES 50 | ***************************************************************************/ 51 | 52 | /*************************************************************************** 53 | * PROTOTYPES 54 | ***************************************************************************/ 55 | static option_t *MakeOpt( 56 | const char option, char *const argument, const int index); 57 | 58 | static size_t MatchOpt(const char argument, const char *const options); 59 | 60 | /*************************************************************************** 61 | * FUNCTIONS 62 | ***************************************************************************/ 63 | 64 | /**************************************************************************** 65 | * Function : GetOptList 66 | * Description: This function is similar to the POSIX function getopt. All 67 | * options and their corresponding arguments are returned in a 68 | * linked list. This function should only be called once per 69 | * an option list and it does not modify argv or argc. 70 | * Parameters : argc - the number of command line arguments (including the 71 | * name of the executable) 72 | * argv - pointer to the open binary file to write encoded 73 | * output 74 | * options - getopt style option list. A NULL terminated 75 | * string of single character options. Follow an 76 | * option with a colon to indicate that it requires 77 | * an argument. 78 | * Effects : Creates a link list of command line options and their 79 | * arguments. 80 | * Returned : option_t type value where the option and arguement fields 81 | * contain the next option symbol and its argument (if any). 82 | * The argument field will be set to NULL if the option is 83 | * specified as having no arguments or no arguments are found. 84 | * The option field will be set to PO_NO_OPT if no more 85 | * options are found. 86 | * 87 | * NOTE: The caller is responsible for freeing up the option list when it 88 | * is no longer needed. 89 | ****************************************************************************/ 90 | option_t *GetOptList(const int argc, char *const argv[], 91 | const char *const options) 92 | { 93 | int nextArg; 94 | option_t *head, *tail; 95 | size_t optIndex; 96 | size_t argIndex; 97 | 98 | /* start with first argument and nothing found */ 99 | nextArg = 1; 100 | head = NULL; 101 | tail = NULL; 102 | 103 | /* loop through all of the command line arguments */ 104 | while (nextArg < argc) 105 | { 106 | argIndex = 1; 107 | 108 | while ((strlen(argv[nextArg]) > argIndex) && ('-' == argv[nextArg][0])) 109 | { 110 | /* attempt to find a matching option */ 111 | optIndex = MatchOpt(argv[nextArg][argIndex], options); 112 | 113 | if (options[optIndex] == argv[nextArg][argIndex]) 114 | { 115 | /* we found the matching option */ 116 | if (NULL == head) 117 | { 118 | head = MakeOpt(options[optIndex], NULL, OL_NOINDEX); 119 | tail = head; 120 | } 121 | else 122 | { 123 | tail->next = MakeOpt(options[optIndex], NULL, OL_NOINDEX); 124 | tail = tail->next; 125 | } 126 | 127 | if (':' == options[optIndex + 1]) 128 | { 129 | /* the option found should have a text arguement */ 130 | argIndex++; 131 | 132 | if (strlen(argv[nextArg]) > argIndex) 133 | { 134 | /* no space between argument and option */ 135 | tail->argument = &(argv[nextArg][argIndex]); 136 | tail->argIndex = nextArg; 137 | } 138 | else if (nextArg < argc) 139 | { 140 | /* there must be space between the argument option */ 141 | nextArg++; 142 | tail->argument = argv[nextArg]; 143 | tail->argIndex = nextArg; 144 | } 145 | 146 | break; /* done with argv[nextArg] */ 147 | } 148 | } 149 | 150 | argIndex++; 151 | } 152 | 153 | nextArg++; 154 | } 155 | 156 | return head; 157 | } 158 | 159 | /**************************************************************************** 160 | * Function : MakeOpt 161 | * Description: This function uses malloc to allocate space for an option_t 162 | * type structure and initailizes the structure with the 163 | * values passed as a parameter. 164 | * Parameters : option - this option character 165 | * argument - pointer string containg the argument for option. 166 | * Use NULL for no argument 167 | * index - argv[index] contains argument use OL_NOINDEX for 168 | * no argument 169 | * Effects : A new option_t type variable is created on the heap. 170 | * Returned : Pointer to newly created and initialized option_t type 171 | * structure. NULL if space for structure can't be allocated. 172 | ****************************************************************************/ 173 | static option_t *MakeOpt( 174 | const char option, char *const argument, const int index) 175 | { 176 | option_t *opt; 177 | 178 | opt = malloc(sizeof(option_t)); 179 | 180 | if (opt != NULL) 181 | { 182 | opt->option = option; 183 | opt->argument = argument; 184 | opt->argIndex = index; 185 | opt->next = NULL; 186 | } 187 | else 188 | { 189 | perror("Failed to Allocate option_t"); 190 | } 191 | 192 | return opt; 193 | } 194 | 195 | /**************************************************************************** 196 | * Function : FreeOptList 197 | * Description: This function will free all the elements in an option_t 198 | * type linked list starting from the node passed as a 199 | * parameter. 200 | * Parameters : list - head of linked list to be freed 201 | * Effects : All elements of the linked list pointed to by list will 202 | * be freed and list will be set to NULL. 203 | * Returned : None 204 | ****************************************************************************/ 205 | void FreeOptList(option_t *list) 206 | { 207 | option_t *head, *next; 208 | 209 | head = list; 210 | list = NULL; 211 | 212 | while (head != NULL) 213 | { 214 | next = head->next; 215 | free(head); 216 | head = next; 217 | } 218 | 219 | return; 220 | } 221 | 222 | /**************************************************************************** 223 | * Function : MatchOpt 224 | * Description: This function searches for an arguement in an option list. 225 | * It will return the index to the option matching the 226 | * arguement or the index to the NULL if none is found. 227 | * Parameters : arguement - character arguement to be matched to an 228 | * option in the option list 229 | * options - getopt style option list. A NULL terminated 230 | * string of single character options. Follow an 231 | * option with a colon to indicate that it requires 232 | * an argument. 233 | * Effects : None 234 | * Returned : Index of argument in option list. Index of end of string 235 | * if arguement does not appear in the option list. 236 | ****************************************************************************/ 237 | static size_t MatchOpt(const char argument, const char *const options) 238 | { 239 | size_t optIndex = 0; 240 | 241 | /* attempt to find a matching option */ 242 | while ((options[optIndex] != '\0') && 243 | (options[optIndex] != argument)) 244 | { 245 | do 246 | { 247 | optIndex++; 248 | } 249 | while ((options[optIndex] != '\0') && 250 | (':' == options[optIndex])); 251 | } 252 | 253 | return optIndex; 254 | } 255 | 256 | /**************************************************************************** 257 | * Function : FindFileName 258 | * Description: This is function accepts a pointer to the name of a file 259 | * along with path information and returns a pointer to the 260 | * first character that is not part of the path. 261 | * Parameters : fullPath - pointer to an array of characters containing 262 | * a file name and possible path modifiers. 263 | * Effects : None 264 | * Returned : Returns a pointer to the first character after any path 265 | * information. 266 | ****************************************************************************/ 267 | char *FindFileName(const char *const fullPath) 268 | { 269 | int i; 270 | const char *start; /* start of file name */ 271 | const char *tmp; 272 | const char delim[3] = {'\\', '/', ':'}; /* path deliminators */ 273 | 274 | start = fullPath; 275 | 276 | /* find the first character after all file path delimiters */ 277 | for (i = 0; i < 3; i++) 278 | { 279 | tmp = strrchr(start, delim[i]); 280 | 281 | if (tmp != NULL) 282 | { 283 | start = tmp + 1; 284 | } 285 | } 286 | 287 | return (char *)start; 288 | } 289 | 290 | -------------------------------------------------------------------------------- /optlist/optlist.h: -------------------------------------------------------------------------------- 1 | /*************************************************************************** 2 | * Command Line Option Parser 3 | * 4 | * File : optlist.h 5 | * Purpose : Header for getopt style command line option parsing 6 | * Author : Michael Dipperstein 7 | * Date : August 1, 2007 8 | * 9 | **************************************************************************** 10 | * 11 | * OptList: A command line option parsing library 12 | * Copyright (C) 2007, 20014, 2018 by 13 | * Michael Dipperstein (mdipperstein@gmail.com) 14 | * 15 | * This file is part of the OptList library. 16 | * 17 | * OptList is free software; you can redistribute it and/or modify it 18 | * under the terms of the GNU Lesser General Public License as published by 19 | * the Free Software Foundation; either version 3 of the License, or (at 20 | * your option) any later version. 21 | * 22 | * OptList is distributed in the hope that it will be useful, but 23 | * WITHOUT ANY WARRANTY; without even the implied warranty of 24 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 25 | * General Public License for more details. 26 | * 27 | * You should have received a copy of the GNU Lesser General Public License 28 | * along with this program. If not, see . 29 | * 30 | ***************************************************************************/ 31 | #ifndef OPTLIST_H 32 | #define OPTLIST_H 33 | 34 | /*************************************************************************** 35 | * INCLUDED FILES 36 | ***************************************************************************/ 37 | 38 | /*************************************************************************** 39 | * MACROS 40 | ***************************************************************************/ 41 | 42 | /*************************************************************************** 43 | * CONSTANTS 44 | ***************************************************************************/ 45 | #define OL_NOINDEX -1 /* this option has no arguement */ 46 | 47 | /*************************************************************************** 48 | * TYPE DEFINITIONS 49 | ***************************************************************************/ 50 | typedef struct option_t 51 | { 52 | char option; /* the current character option character */ 53 | char *argument; /* pointer to arguments for this option */ 54 | int argIndex; /* index into argv[] containing the argument */ 55 | struct option_t *next; /* the next option in the linked list */ 56 | } option_t; 57 | 58 | /*************************************************************************** 59 | * PROTOTYPES 60 | ***************************************************************************/ 61 | 62 | #if defined __cplusplus 63 | extern "C" 64 | { 65 | #endif 66 | 67 | /* returns a linked list of options and arguments similar to getopt() */ 68 | option_t *GetOptList(const int argc, char *const argv[], 69 | const char *const options); 70 | 71 | /* frees the linked list of option_t returned by GetOptList */ 72 | void FreeOptList(option_t *list); 73 | 74 | /* return a pointer to file name in a full path. useful for argv[0] */ 75 | char *FindFileName(const char *const fullPath); 76 | 77 | #if defined __cplusplus 78 | } 79 | #endif 80 | 81 | #endif /* ndef OPTLIST_H */ 82 | -------------------------------------------------------------------------------- /optlist/sample.c: -------------------------------------------------------------------------------- 1 | /*************************************************************************** 2 | * OptList Usage Sample 3 | * 4 | * File : sample.c 5 | * Purpose : Demonstrates usage of optlist library. 6 | * Author : Michael Dipperstein 7 | * Date : July 23, 2004 8 | * 9 | **************************************************************************** 10 | * 11 | * Sample: A optlist library sample usage program 12 | * Copyright (C) 2007, 2014 by 13 | * Michael Dipperstein (mdipperstein@gmail.com) 14 | * 15 | * This file is part of the optlist library. 16 | * 17 | * The optlist library is free software; you can redistribute it and/or 18 | * modify it under the terms of the GNU Lesser General Public License as 19 | * published by the Free Software Foundation; either version 3 of the 20 | * License, or (at your option) any later version. 21 | * 22 | * The optlist library is distributed in the hope that it will be useful, 23 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 24 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 25 | * General Public License for more details. 26 | * 27 | * You should have received a copy of the GNU Lesser General Public License 28 | * along with this program. If not, see . 29 | * 30 | ***************************************************************************/ 31 | 32 | /*************************************************************************** 33 | * INCLUDED FILES 34 | ***************************************************************************/ 35 | #include 36 | #include 37 | #include "optlist.h" 38 | 39 | /*************************************************************************** 40 | * PROTOTYPES 41 | ***************************************************************************/ 42 | 43 | /*************************************************************************** 44 | * FUNCTIONS 45 | ***************************************************************************/ 46 | 47 | /**************************************************************************** 48 | * Function : main 49 | * Description: This is the main function for this program, it calls 50 | * optlist to parse the command line input displays the 51 | * results of the parsing. 52 | * Parameters : argc - number of parameters 53 | * argv - parameter list 54 | * Effects : parses command line parameters 55 | * Returned : EXIT_SUCCESS for success, otherwise EXIT_FAILURE. 56 | ****************************************************************************/ 57 | int main(int argc, char *argv[]) 58 | { 59 | option_t *optList, *thisOpt; 60 | 61 | /* get list of command line options and their arguments */ 62 | optList = NULL; 63 | optList = GetOptList(argc, argv, "a:bcd:ef?"); 64 | 65 | /* display results of parsing */ 66 | while (optList != NULL) 67 | { 68 | thisOpt = optList; 69 | optList = optList->next; 70 | 71 | if ('?' == thisOpt->option) 72 | { 73 | printf("Usage: %s \n\n", FindFileName(argv[0])); 74 | printf("options:\n"); 75 | printf(" -a : option excepting argument.\n"); 76 | printf(" -b : option without arguments.\n"); 77 | printf(" -c : option without arguments.\n"); 78 | printf(" -d : option excepting argument.\n"); 79 | printf(" -e : option without arguments.\n"); 80 | printf(" -f : option without arguments.\n"); 81 | printf(" -? : print out command line options.\n\n"); 82 | 83 | FreeOptList(thisOpt); /* free the rest of the list */ 84 | return EXIT_SUCCESS; 85 | } 86 | 87 | printf("found option %c\n", thisOpt->option); 88 | 89 | if (thisOpt->argument != NULL) 90 | { 91 | printf("\tfound argument %s", thisOpt->argument); 92 | printf(" at index %d\n", thisOpt->argIndex); 93 | } 94 | else 95 | { 96 | printf("\tno argument for this option\n"); 97 | } 98 | 99 | free(thisOpt); /* done with this item, free it */ 100 | } 101 | 102 | return EXIT_SUCCESS; 103 | } 104 | -------------------------------------------------------------------------------- /optlist/sample.cpp: -------------------------------------------------------------------------------- 1 | /*************************************************************************** 2 | * OptList Usage Sample 3 | * 4 | * File : sample.cpp 5 | * Purpose : Demonstrates usage of optlist library. 6 | * Author : Michael Dipperstein 7 | * Date : October 18, 2018 8 | * 9 | **************************************************************************** 10 | * 11 | * Sample: A optlist library sample usage program 12 | * Copyright (C) 2018 by 13 | * Michael Dipperstein (mdipperstein@gmail.com) 14 | * 15 | * This file is part of the optlist library. 16 | * 17 | * The optlist library is free software; you can redistribute it and/or 18 | * modify it under the terms of the GNU Lesser General Public License as 19 | * published by the Free Software Foundation; either version 3 of the 20 | * License, or (at your option) any later version. 21 | * 22 | * The optlist library is distributed in the hope that it will be useful, 23 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 24 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 25 | * General Public License for more details. 26 | * 27 | * You should have received a copy of the GNU Lesser General Public License 28 | * along with this program. If not, see . 29 | * 30 | ***************************************************************************/ 31 | 32 | /*************************************************************************** 33 | * INCLUDED FILES 34 | ***************************************************************************/ 35 | #include 36 | #include "optlist.h" 37 | 38 | /*************************************************************************** 39 | * PROTOTYPES 40 | ***************************************************************************/ 41 | 42 | /*************************************************************************** 43 | * FUNCTIONS 44 | ***************************************************************************/ 45 | 46 | /**************************************************************************** 47 | * Function : main 48 | * Description: This is the main function for this program, it calls 49 | * optlist to parse the command line input displays the 50 | * results of the parsing. 51 | * Parameters : argc - number of parameters 52 | * argv - parameter list 53 | * Effects : parses command line parameters 54 | * Returned : EXIT_SUCCESS for success, otherwise EXIT_FAILURE. 55 | ****************************************************************************/ 56 | int main(int argc, char *argv[]) 57 | { 58 | option_t *optList, *thisOpt; 59 | 60 | /* get list of command line options and their arguments */ 61 | optList = NULL; 62 | optList = GetOptList(argc, argv, "a:bcd:ef?"); 63 | 64 | /* display results of parsing */ 65 | while (optList != NULL) 66 | { 67 | thisOpt = optList; 68 | optList = optList->next; 69 | 70 | if ('?' == thisOpt->option) 71 | { 72 | std::cout << "Usage: " << FindFileName(argv[0]) << " " << 73 | std::endl << std::endl; 74 | std::cout << "options:" << std::endl; 75 | std::cout << " -a : option excepting argument." << std::endl; 76 | std::cout << " -b : option without arguments." << std::endl; 77 | std::cout << " -c : option without arguments." << std::endl; 78 | std::cout << " -d : option excepting argument." << std::endl; 79 | std::cout << " -e : option without arguments." << std::endl; 80 | std::cout << " -f : option without arguments." << std::endl; 81 | std::cout << " -? : print out command line options.\n" << 82 | std::endl; 83 | 84 | FreeOptList(thisOpt); /* free the rest of the list */ 85 | return EXIT_SUCCESS; 86 | } 87 | 88 | std::cout << "found option " << thisOpt->option << std::endl; 89 | 90 | if (thisOpt->argument != NULL) 91 | { 92 | std::cout << "\tfound argument " << thisOpt->argument << 93 | " at index " << thisOpt->argIndex << std::endl; 94 | } 95 | else 96 | { 97 | std::cout << "\tno argument for this option" << std::endl; 98 | } 99 | 100 | free(thisOpt); /* done with this item, free it */ 101 | } 102 | 103 | return EXIT_SUCCESS; 104 | } 105 | -------------------------------------------------------------------------------- /sample.c: -------------------------------------------------------------------------------- 1 | /*************************************************************************** 2 | * Sample Program Using Burrows-Wheeler Transform Library 3 | * 4 | * File : sample.c 5 | * Purpose : Demonstrate usage of Burrows-Wheeler transform library 6 | * Author : Michael Dipperstein 7 | * Date : August 20, 2004 8 | * 9 | **************************************************************************** 10 | * 11 | * SAMPLE: Sample usage of Burrows-Wheeler transform library 12 | * Copyright (C) 2004-2005, 2007, 2014, 2017 by 13 | * Michael Dipperstein (mdipperstein@gmail.com) 14 | * 15 | * This file is part of the BWT library. 16 | * 17 | * The BWT library is free software; you can redistribute it and/or modify 18 | * it under the terms of the GNU Lesser General Public License as published 19 | * by the Free Software Foundation; either version 3 of the License, or (at 20 | * your option) any later version. 21 | * 22 | * The BWT library is distributed in the hope that it will be useful, but 23 | * WITHOUT ANY WARRANTY; without even the implied warranty of 24 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 25 | * General Public License for more details. 26 | * 27 | * You should have received a copy of the GNU Lesser General Public License 28 | * along with this program. If not, see . 29 | * 30 | ***************************************************************************/ 31 | 32 | /*************************************************************************** 33 | * INCLUDED FILES 34 | ***************************************************************************/ 35 | #include 36 | #include 37 | #include 38 | #include "optlist/optlist.h" 39 | #include "bwxform.h" 40 | 41 | /*************************************************************************** 42 | * PROTOTYPES 43 | ***************************************************************************/ 44 | 45 | /*************************************************************************** 46 | * FUNCTIONS 47 | ***************************************************************************/ 48 | 49 | /*************************************************************************** 50 | * Function : main 51 | * Description: This is the main function for this program, it validates 52 | * the command line input and, if valid, it will call 53 | * functions to transform or reverse transform a file using 54 | * the Burrows-Wheeler trasnform algorithm with or without 55 | * additional move to front coding. 56 | * Parameters : argc - number of parameters 57 | * argv - parameter list 58 | * Effects : Encodes/Decodes input file 59 | * Returned : EXIT_SUCCESS for success, otherwise EXIT_FAILURE. 60 | ***************************************************************************/ 61 | int main(int argc, char *argv[]) 62 | { 63 | option_t *optList, *thisOpt; 64 | FILE *inFile, *outFile; /* pointer to input & output files */ 65 | char encode; /* encode/decode */ 66 | xform_t method; /* perform move to front */ 67 | 68 | /* initialize data */ 69 | inFile = NULL; 70 | outFile = NULL; 71 | encode = 1; 72 | method = XFORM_WITHOUT_MTF; 73 | 74 | /* parse command line */ 75 | optList = GetOptList(argc, argv, "cdmi:o:h?"); 76 | thisOpt = optList; 77 | 78 | while (thisOpt != NULL) 79 | { 80 | switch(thisOpt->option) 81 | { 82 | case 'c': /* compression mode */ 83 | encode = 1; 84 | break; 85 | 86 | case 'd': /* decompression mode */ 87 | encode = 0; 88 | break; 89 | 90 | case 'm': /* perform move to front */ 91 | method = XFORM_WITH_MTF; 92 | break; 93 | 94 | case 'i': /* input file name */ 95 | if (inFile != NULL) 96 | { 97 | fprintf(stderr, "Multiple input files not allowed.\n"); 98 | fclose(inFile); 99 | 100 | if (outFile != NULL) 101 | { 102 | fclose(outFile); 103 | } 104 | 105 | FreeOptList(optList); 106 | exit(EXIT_FAILURE); 107 | } 108 | else if ((inFile = fopen(thisOpt->argument, "rb")) == NULL) 109 | { 110 | perror("Opening Input File"); 111 | 112 | if (outFile != NULL) 113 | { 114 | fclose(outFile); 115 | } 116 | 117 | FreeOptList(optList); 118 | exit(EXIT_FAILURE); 119 | } 120 | 121 | break; 122 | 123 | case 'o': /* output file name */ 124 | if (outFile != NULL) 125 | { 126 | fprintf(stderr, "Multiple output files not allowed.\n"); 127 | fclose(outFile); 128 | 129 | if (inFile != NULL) 130 | { 131 | fclose(inFile); 132 | } 133 | 134 | FreeOptList(optList); 135 | exit(EXIT_FAILURE); 136 | } 137 | else if ((outFile = fopen(thisOpt->argument, "wb")) == NULL) 138 | { 139 | perror("Opening Output File"); 140 | 141 | if (inFile != NULL) 142 | { 143 | fclose(inFile); 144 | } 145 | 146 | FreeOptList(optList); 147 | exit(EXIT_FAILURE); 148 | } 149 | 150 | break; 151 | 152 | case 'h': 153 | case '?': 154 | printf("Usage: %s \n\n", FindFileName(argv[0])); 155 | printf("options:\n"); 156 | printf(" -c : Encode input file to output file.\n"); 157 | printf(" -d : Decode input file to output file.\n"); 158 | printf(" -m : Perform the Move-to-Front coding.\n"); 159 | printf(" -i : Name of input file.\n"); 160 | printf(" -o : Name of output file.\n"); 161 | printf(" -h | ? : Print out command line options.\n\n"); 162 | printf("Default: %s -c\n", FindFileName(argv[0])); 163 | FreeOptList(optList); 164 | return(EXIT_SUCCESS); 165 | } 166 | 167 | optList = thisOpt->next; 168 | free(thisOpt); 169 | thisOpt = optList; 170 | } 171 | 172 | /* validate command line */ 173 | if (inFile == NULL) 174 | { 175 | fprintf(stderr, "Input file must be provided\n"); 176 | fprintf(stderr, "Enter \"%s -?\" for help.\n", FindFileName(argv[0])); 177 | 178 | if (outFile != NULL) 179 | { 180 | free(outFile); 181 | } 182 | 183 | exit (EXIT_FAILURE); 184 | } 185 | else if (outFile == NULL) 186 | { 187 | fprintf(stderr, "Output file must be provided\n"); 188 | fprintf(stderr, "Enter \"%s -?\" for help.\n", FindFileName(argv[0])); 189 | 190 | if (inFile != NULL) 191 | { 192 | free(inFile); 193 | } 194 | 195 | exit (EXIT_FAILURE); 196 | } 197 | 198 | /* we have valid parameters encode or decode */ 199 | if (encode) 200 | { 201 | BWXform(inFile, outFile, method); 202 | } 203 | else 204 | { 205 | BWReverseXform(inFile, outFile, method); 206 | } 207 | 208 | fclose(inFile); 209 | fclose(outFile); 210 | return EXIT_SUCCESS; 211 | } 212 | -------------------------------------------------------------------------------- /test_this.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | if [ -f foo ] 4 | then 5 | echo this script requies use of a file foo 6 | exit 1 7 | fi 8 | 9 | if [ -f bar ] 10 | then 11 | echo this script requies use of a file bar 12 | exit 1 13 | fi 14 | 15 | for X in * 16 | do 17 | if [ -f "$X" ] 18 | then 19 | echo checking $X 20 | ./sample -cm -i $X -o foo 21 | ./sample -dm -i foo -o bar 22 | diff $X bar 23 | rm foo 24 | rm bar 25 | fi 26 | done 27 | 28 | exit 0 29 | --------------------------------------------------------------------------------