diff options
author | June McEnroe <june@causal.agency> | 2020-01-27 19:10:18 -0500 |
---|---|---|
committer | June McEnroe <june@causal.agency> | 2020-01-27 19:10:18 -0500 |
commit | ff011685a87e4314e0ddc58fc909d0d018dd788e (patch) | |
tree | 38939e200850a1bc76162b2bf3776b5cebd79005 /cards | |
parent | Remove cards submodule (diff) | |
parent | Remove README (diff) | |
download | wep-ff011685a87e4314e0ddc58fc909d0d018dd788e.tar.gz wep-ff011685a87e4314e0ddc58fc909d0d018dd788e.zip |
Add 'cards/' from commit 'daf6fd1d716aad3c03b6dadbbd7a4b724acbfece'
git-subtree-dir: cards git-subtree-mainline: 97e1d0e9a7eb2cfad54e518cd5eba3f4523f788d git-subtree-split: daf6fd1d716aad3c03b6dadbbd7a4b724acbfece
Diffstat (limited to 'cards')
-rw-r--r-- | cards/.gitignore | 8 | ||||
-rw-r--r-- | cards/LICENSE | 661 | ||||
-rw-r--r-- | cards/Makefile | 17 | ||||
-rw-r--r-- | cards/cards.3 | 231 | ||||
-rw-r--r-- | cards/cards.c | 428 | ||||
-rw-r--r-- | cards/cards.h | 80 | ||||
-rwxr-xr-x | cards/configure | 8 | ||||
-rw-r--r-- | cards/dump.1 | 48 | ||||
-rw-r--r-- | cards/dump.c | 82 | ||||
-rw-r--r-- | cards/example.c | 103 | ||||
-rw-r--r-- | cards/exefmt.txt | 593 |
11 files changed, 2259 insertions, 0 deletions
diff --git a/cards/.gitignore b/cards/.gitignore new file mode 100644 index 0000000..0ca9d1f --- /dev/null +++ b/cards/.gitignore @@ -0,0 +1,8 @@ +*.bmp +*.o +CARDS.DLL +FREECELL.EXE +SOL.EXE +config.mk +dump +example diff --git a/cards/LICENSE b/cards/LICENSE new file mode 100644 index 0000000..dba13ed --- /dev/null +++ b/cards/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +<http://www.gnu.org/licenses/>. diff --git a/cards/Makefile b/cards/Makefile new file mode 100644 index 0000000..488245d --- /dev/null +++ b/cards/Makefile @@ -0,0 +1,17 @@ +CFLAGS += -std=c99 -Wall -Wextra -Wpedantic + +include config.mk + +BINS = dump example + +all: ${BINS} + +${BINS}: cards.o + +.o: + ${CC} ${LDFLAGS} $< cards.o ${LDLIBS} -o $@ + +cards.o dump.o example.o: cards.h + +clean: + rm -f ${BINS} *.o *.bmp diff --git a/cards/cards.3 b/cards/cards.3 new file mode 100644 index 0000000..26c142c --- /dev/null +++ b/cards/cards.3 @@ -0,0 +1,231 @@ +.Dd August 22, 2019 +.Dt CARDS 3 +.Os +. +.Sh NAME +.Nm Cards_LoadCards , +.Nm Cards_LoadFreeCell , +.Nm Cards_InvertSurface +.Nd bitmap resource loader +. +.Sh SYNOPSIS +.In cards.h +. +.Ft int +.Fo Cards_LoadCards +.Fa "SDL_Surface *surfaces[]" +.Fa "size_t count" +.Fa "SDL_RWops *rw" +.Fa "enum Cards_Flag flags" +.Fc +. +.Ft int +.Fo Cards_LoadFreeCell +.Fa "SDL_Surface *surfaces[]" +.Fa "size_t count" +.Fa "SDL_RWops *rw" +.Fa "enum Cards_Flag flags" +.Fc +. +.Ft int +.Fn Cards_InvertSurface "SDL_Surface *surface" +. +.Sh DESCRIPTION +.Fn Cards_LoadCards +and +.Fn Cards_LoadFreeCell +load bitmap resources +into an array of +.Fa count +surfaces. +Resources can be loaded +from 16-bit NE executables +or from 32-bit PE executables. +. +.Pp +.Fn Cards_LoadCards +loads card bitmaps from a +.Pa CARDS.DLL +or Windows 3.0 +.Pa SOL.EXE +file +.Fa rw . +. +.Pp +Indices of loaded surfaces +are defined by the following: +.Bl -tag -width Ds -offset indent +.It Suit +.Dv Cards_Club , +.Dv Cards_Diamond , +.Dv Cards_Heart , +.Dv Cards_Spade . +.It Rank +.Dv Cards_A , +.Dv Cards_2 , +.Dv Cards_3 , +.Dv Cards_4 , +.Dv Cards_5 , +.Dv Cards_6 , +.Dv Cards_7 , +.Dv Cards_8 , +.Dv Cards_9 , +.Dv Cards_10 , +.Dv Cards_J , +.Dv Cards_Q , +.Dv Cards_K . +.It Back +.Dv Cards_Back1 , +.Dv Cards_Back2 , +.Dv Cards_Back3 , +.Dv Cards_Back4 , +.Dv Cards_Back5 , +.Dv Cards_Back6 , +.Dv Cards_Back7 , +.Dv Cards_Back8 , +.Dv Cards_Back9 , +.Dv Cards_Back10 , +.Dv Cards_Back11 , +.Dv Cards_Back12 . +.It Other +.Dv Cards_Empty , +.Dv Cards_X , +.Dv Cards_O . +.El +. +.Pp +Where suit and rank constants +are added together to form an index. +Note that there are gaps in the indices +and some surface pointers will be set to +.Dv NULL . +The maximum number of surfaces +is defined by +.Dv Cards_CardCount . +. +.Pp +The dimensions of the loaded surfaces +are defined by +.Dv Cards_CardWidth +and +.Dv Cards_CardHeight . +. +.Pp +.Fn Cards_LoadCards +accepts the following flags: +.Bl -tag -width "Cards_BlackBorders" -offset indent +.It Dv Cards_ColorKey +Use color key transparency for the +.Dv Cards_Empty , +.Dv Cards_X +and +.Dv Cards_O +surfaces. +.It Dv Cards_AlphaCorners +Make the rounded card corners transparent. +.It Dv Cards_BlackBorders +Make all card borders black. +.El +. +.Pp +.Fn Cards_LoadFreeCell +loads bitmaps from a +.Pa FREECELL.EXE +file +.Fa rw . +. +.Pp +Indices of loaded surfaces +are defined by +.Dv Cards_KingRight , +.Dv Cards_KingLeft +and +.Dv Cards_KingWin . +Note that there are gaps in the indices +and some surface pointers will be set to +.Dv NULL . +The maximum number of surfaces +is defined by +.Dv Cards_FreeCellCount . +. +.Pp +The dimensions of the loaded surfaces +are defined by +.Dv Cards_KingWidth +and +.Dv Cards_KingHeight . +. +.Pp +.Fn Cards_LoadFreeCell +accepts the following flags: +.Bl -tag -width "Cards_ColorKey" -offset indent +.It Dv Cards_ColorKey +Use color key transparency. +.El +. +.Pp +.Fn Cards_InvertSurface +inverts the colors of a surface loaded by +.Fn Cards_LoadCards . +. +.Sh RETURN VALUES +Upon successful completion, +the value 0 is returned; +otherwise the value -1 is returned. +. +.Sh FILES +The +.Lk https://code.causal.agency/june/cards.dll "cards.dll repository" +contains various versions +of the files +.Pa CARDS.DLL , +.Pa FREECELL.EXE +and +.Pa SOL.EXE . +. +.Sh EXAMPLES +See +.Pa example.c . +. +.Sh ERRORS +Error messages are set with +.Fn SDL_SetError +and can be retrieved with +.Fn SDL_GetError . +. +.Pp +.Fn Cards_LoadCards +and +.Fn Cards_LoadFreeCell +may fail for the following reasons: +any +.Vt SDL_RWops +or +.Vt SDL_Surface +error; +invalid MZ, NE or PE signatures; +missing resource table; +invalid resource hierarchy; +missing resource. +. +.Pp +.Fn Cards_InvertSurface +may fail for any +.Vt SDL_Surface +error +or if the surface format is not supported. +. +.Sh STANDARDS +.Bl -item +.It +The New Executable format, +documented in +.Pa exefmt.txt . +.It +The Portable Executable format, +documented at +.Lk https://docs.microsoft.com/en-us/windows/desktop/Debug/pe-format . +.El +. +.Sh AUTHORS +.An C. McEnroe Aq Mt june@causal.agency diff --git a/cards/cards.c b/cards/cards.c new file mode 100644 index 0000000..ddc5b86 --- /dev/null +++ b/cards/cards.c @@ -0,0 +1,428 @@ +/* Copyright (C) 2019 C. McEnroe <june@causal.agency> + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + */ + +#include <errno.h> +#include <stdlib.h> +#include <string.h> + +#include "cards.h" + +static SDL_Surface * +dibSurface(SDL_RWops *rw, Uint32 offset, Uint32 length) { + Uint32 bitmapLength = 0x0E + length; + + Uint8 *buffer = malloc(bitmapLength); + if (!buffer) { + SDL_SetError("malloc error: %s", strerror(errno)); + return NULL; + } + + SDL_RWops *bitmap = SDL_RWFromMem(buffer, bitmapLength); + if (!bitmap) { + free(buffer); + return NULL; + } + + if (SDL_RWseek(rw, offset, RW_SEEK_SET) < 0) goto fail; + Uint32 dibHeaderLength = SDL_ReadLE32(rw); + Uint32 bitmapDataOffset = 0x0E + dibHeaderLength; + + if (dibHeaderLength == 0x0C) { + if (SDL_RWseek(rw, 0x06, RW_SEEK_CUR) < 0) goto fail; + Uint16 bitsPerPixel = SDL_ReadLE16(rw); + bitmapDataOffset += 3 * (1 << bitsPerPixel); + + } else if (dibHeaderLength == 0x28) { + if (SDL_RWseek(rw, 0x0A, RW_SEEK_CUR) < 0) goto fail; + Uint16 bitsPerPixel = SDL_ReadLE16(rw); + if (SDL_RWseek(rw, 0x10, RW_SEEK_CUR) < 0) goto fail; + Uint32 paletteLength = SDL_ReadLE32(rw); + + if (!paletteLength && bitsPerPixel < 16) { + paletteLength = 1 << bitsPerPixel; + } + bitmapDataOffset += 4 * paletteLength; + + } else { + SDL_SetError("unrecognized DIB header length %u", dibHeaderLength); + goto fail; + } + + SDL_WriteU8(bitmap, 'B'); + SDL_WriteU8(bitmap, 'M'); + SDL_WriteLE32(bitmap, bitmapLength); + SDL_WriteLE16(bitmap, 0); // reserved + SDL_WriteLE16(bitmap, 0); // reserved + SDL_WriteLE32(bitmap, bitmapDataOffset); + + if (SDL_RWseek(rw, offset, RW_SEEK_SET) < 0) goto fail; + if (SDL_RWread(rw, &buffer[SDL_RWtell(bitmap)], length, 1) < 1) goto fail; + + SDL_RWseek(bitmap, 0, RW_SEEK_SET); + SDL_Surface *surface = SDL_LoadBMP_RW(bitmap, 1); + free(buffer); + return surface; + +fail: + SDL_RWclose(bitmap); + free(buffer); + return NULL; +} + +// exefmt.txt +static int +loadNE( + SDL_Surface **surfaces, size_t count, + SDL_RWops *rw, Uint16 neOffset, Uint32 idSkip +) { + if (SDL_RWseek(rw, neOffset + 0x24, RW_SEEK_SET) < 0) return -1; + Uint16 resourceTableOffset = neOffset + SDL_ReadLE16(rw); + + if (SDL_RWseek(rw, resourceTableOffset, RW_SEEK_SET) < 0) return -1; + Uint16 alignmentShift = SDL_ReadLE16(rw); + + Uint16 resourceCount; + for (;;) { + Uint16 typeID = SDL_ReadLE16(rw); + resourceCount = SDL_ReadLE16(rw); + SDL_ReadLE32(rw); // reserved + + if (!typeID) { + SDL_SetError("no bitmap resources"); + return -1; + } + if (typeID == 0x8002) break; + + if (SDL_RWseek(rw, 0x0C * resourceCount, RW_SEEK_CUR) < 0) return -1; + } + + for (Uint16 i = 0; i < resourceCount; ++i) { + Uint16 dataOffset = SDL_ReadLE16(rw); + Uint16 dataLength = SDL_ReadLE16(rw); + /* Uint16 flags = */ SDL_ReadLE16(rw); + Uint16 resourceID = SDL_ReadLE16(rw); + SDL_ReadLE32(rw); // reserved + + resourceID &= 0x7FFF; + if (resourceID >= idSkip) resourceID -= idSkip; + if (resourceID >= count) continue; + + Sint64 nextResource = SDL_RWtell(rw); + if (nextResource < 0) return -1; + + surfaces[resourceID] = dibSurface( + rw, + (Uint32)dataOffset << alignmentShift, + (Uint32)dataLength << alignmentShift + ); + if (!surfaces[resourceID]) return -1; + + if (SDL_RWseek(rw, nextResource, RW_SEEK_SET) < 0) return -1; + } + + return 0; +} + +// <https://docs.microsoft.com/en-us/windows/desktop/Debug/pe-format> +static int +loadPE( + SDL_Surface **surfaces, size_t count, + SDL_RWops *rw, Uint16 peOffset, Uint32 idSkip +) { + if (SDL_RWseek(rw, peOffset + 0x04 + 0x02, RW_SEEK_SET) < 0) return -1; + Uint16 sectionCount = SDL_ReadLE16(rw); + + if (SDL_RWseek(rw, peOffset + 0x04 + 0x10, RW_SEEK_SET) < 0) return -1; + Uint16 optionalHeaderLength = SDL_ReadLE16(rw); + Uint16 sectionTableOffset = peOffset + 0x04 + 0x14 + optionalHeaderLength; + + Uint32 resourceTableOffset = 0; + Uint32 resourceTableVirtual = 0; + for (Uint16 i = 0; i < sectionCount; ++i) { + Uint16 headerOffset = sectionTableOffset + 0x28 * i; + + if (SDL_RWseek(rw, headerOffset, RW_SEEK_SET) < 0) return -1; + char name[8]; + if (!SDL_RWread(rw, name, sizeof(name), 1)) return -1; + if (strncmp(".rsrc", name, sizeof(name))) continue; + + if (SDL_RWseek(rw, headerOffset + 0x0C, RW_SEEK_SET) < 0) return -1; + resourceTableVirtual = SDL_ReadLE32(rw); + + if (SDL_RWseek(rw, headerOffset + 0x14, RW_SEEK_SET) < 0) return -1; + resourceTableOffset = SDL_ReadLE32(rw); + + break; + } + if (!resourceTableOffset) { + SDL_SetError("no resource table"); + return -1; + } + + if (SDL_RWseek(rw, resourceTableOffset + 0x0C, RW_SEEK_SET) < 0) return -1; + Uint16 typeNameCount = SDL_ReadLE16(rw); + Uint16 typeIDCount = SDL_ReadLE16(rw); + + if (SDL_RWseek(rw, 0x08 * typeNameCount, RW_SEEK_CUR) < 0) return -1; + + Uint32 bitmapTableOffset = 0; + for (Uint16 i = 0; i < typeIDCount; ++i) { + Uint32 typeID = SDL_ReadLE32(rw); + Uint32 subdirOffset = SDL_ReadLE32(rw); + if (typeID != 0x02) continue; + if (!(subdirOffset & (1 << 31))) { + SDL_SetError("bitmap type entry does not point to table"); + return -1; + } + bitmapTableOffset = resourceTableOffset + (subdirOffset & ~(1 << 31)); + break; + } + + if (SDL_RWseek(rw, bitmapTableOffset + 0x0C, RW_SEEK_SET) < 0) return -1; + Uint16 nameNameCount = SDL_ReadLE16(rw); + Uint16 nameIDCount = SDL_ReadLE16(rw); + + if (SDL_RWseek(rw, 0x08 * nameNameCount, RW_SEEK_CUR) < 0) return -1; + + for (Uint16 i = 0; i < nameIDCount; ++i) { + Uint32 nameID = SDL_ReadLE32(rw); + if (nameID >= idSkip) nameID -= idSkip; + if (nameID >= count) continue; + + Uint32 subdirOffset = SDL_ReadLE32(rw); + if (!(subdirOffset & (1 << 31))) { + SDL_SetError("bitmap name entry does not point to table"); + return -1; + } + + Sint64 nextName = SDL_RWtell(rw); + if (nextName < 0) return -1; + + Uint32 langTableOffset = + resourceTableOffset + (subdirOffset & ~(1 << 31)); + + if (SDL_RWseek(rw, langTableOffset + 0x0C, RW_SEEK_SET) < 0) return -1; + Uint16 langNameCount = SDL_ReadLE16(rw); + Uint16 langIDCount = SDL_ReadLE16(rw); + if (langNameCount != 0 || langIDCount != 1) { + SDL_SetError("language table contains more than one entry"); + return -1; + } + + /* Uint32 langID = */ SDL_ReadLE32(rw); + Uint32 dataEntryOffset = SDL_ReadLE32(rw); + if (dataEntryOffset & (1 << 31)) { + SDL_SetError("language entry does not point to data"); + return -1; + } + dataEntryOffset += resourceTableOffset; + + if (SDL_RWseek(rw, dataEntryOffset, RW_SEEK_SET) < 0) return -1; + Uint32 dataVirtual = SDL_ReadLE32(rw); + Uint32 dataLength = SDL_ReadLE32(rw); + Uint32 dataOffset = + dataVirtual - (resourceTableVirtual - resourceTableOffset); + + surfaces[nameID] = dibSurface(rw, dataOffset, dataLength); + if (!surfaces[nameID]) return -1; + + if (SDL_RWseek(rw, nextName, RW_SEEK_SET) < 0) return -1; + } + + return 0; +} + +static int +loadEXE(SDL_Surface **surfaces, size_t count, SDL_RWops *rw, Uint32 idSkip) { + if (SDL_RWseek(rw, 0, RW_SEEK_SET) < 0) return -1; + if (SDL_ReadU8(rw) != 'M' || SDL_ReadU8(rw) != 'Z') { + SDL_SetError("invalid MZ signature"); + return -1; + } + + if (SDL_RWseek(rw, 0x3C, RW_SEEK_SET) < 0) return -1; + Uint16 offset = SDL_ReadLE16(rw); + + if (SDL_RWseek(rw, offset, RW_SEEK_SET) < 0) return -1; + Uint8 sig[2] = { SDL_ReadU8(rw), SDL_ReadU8(rw) }; + + if (sig[0] == 'N' && sig[1] == 'E') { + return loadNE(surfaces, count, rw, offset, idSkip); + } else if (sig[0] == 'P' && sig[1] == 'E') { + return loadPE(surfaces, count, rw, offset, idSkip); + } else { + SDL_SetError("invalid NE/PE signature"); + return -1; + } +} + +static int setColorKey(SDL_Surface **surfaces, size_t count) { + size_t i = Cards_Empty; + if (i < count) { + if (SDL_SetColorKey(surfaces[i], SDL_TRUE, 1) < 0) return -1; + } + for (i = Cards_X; i <= Cards_O; ++i) { + if (i >= count) break; + if (SDL_SetColorKey(surfaces[i], SDL_TRUE, 12) < 0) return -1; + } + return 0; +} + +static int setAlphaCorners(SDL_Surface **surfaces, size_t count) { + SDL_Surface *alpha = NULL; + for (size_t i = 0; i < count; ++i) { + if (!surfaces[i]) continue; + + alpha = SDL_ConvertSurfaceFormat(surfaces[i], SDL_PIXELFORMAT_RGBA32, 0); + if (!alpha) return -1; + + if (SDL_SetSurfaceBlendMode(alpha, SDL_BLENDMODE_BLEND) < 0) goto fail; + + SDL_Rect rects[8] = { + { 0, 0, 2, 1 }, + { 0, 1, 1, 1 }, + { Cards_CardWidth - 2, 0, 2, 1 }, + { Cards_CardWidth - 1, 1, 1, 1 }, + { 0, Cards_CardHeight - 1, 2, 1 }, + { 0, Cards_CardHeight - 2, 1, 1 }, + { Cards_CardWidth - 2, Cards_CardHeight - 1, 2, 1 }, + { Cards_CardWidth - 1, Cards_CardHeight - 2, 1, 1 }, + }; + Uint32 trans = SDL_MapRGBA(alpha->format, 0x00, 0x00, 0x00, 0x00); + if (SDL_FillRects(alpha, rects, 8, trans) < 0) goto fail; + + SDL_FreeSurface(surfaces[i]); + surfaces[i] = alpha; + } + return 0; + +fail: + SDL_FreeSurface(alpha); + return -1; +} + +static int setBlackBorders(SDL_Surface **surfaces, size_t count) { + for (size_t i = Cards_Diamond + Cards_A; i <= Cards_Heart + Cards_K; ++i) { + if (i >= count) break; + if (!surfaces[i]) continue; + SDL_Rect rects[8] = { + { 2, 0, Cards_CardWidth - 4, 1 }, + { 2, Cards_CardHeight - 1, Cards_CardWidth - 4, 1 }, + { 0, 2, 1, Cards_CardHeight - 4 }, + { Cards_CardWidth - 1, 2, 1, Cards_CardHeight - 4 }, + { 1, 1, 1, 1 }, + { Cards_CardWidth - 2, 1, 1, 1 }, + { 1, Cards_CardHeight - 2, 1, 1 }, + { Cards_CardWidth - 2, Cards_CardHeight - 2, 1, 1 }, + }; + Uint32 black = SDL_MapRGB(surfaces[i]->format, 0x00, 0x00, 0x00); + if (SDL_FillRects(surfaces[i], rects, 8, black) < 0) return -1; + } + return 0; +} + +static int +checkRange(SDL_Surface **surfaces, size_t count, size_t a, size_t b) { + for (size_t i = a; i <= b; ++i) { + if (i >= count) break; + if (surfaces[i]) continue; + SDL_SetError("missing resource %zu", i); + return -1; + } + return 0; +} + +int +Cards_LoadCards( + SDL_Surface *surfaces[], size_t count, + SDL_RWops *rw, enum Cards_Flag flags +) { + memset(surfaces, 0, sizeof(*surfaces) * count); + if (loadEXE(surfaces, count, rw, 0) < 0) return -1; + if (checkRange(surfaces, count, Cards_A, Cards_Back12) < 0) return -1; + if (checkRange(surfaces, count, Cards_X, Cards_O) < 0) return -1; + if (flags & Cards_ColorKey) { + if (setColorKey(surfaces, count) < 0) return -1; + } + if (flags & Cards_AlphaCorners) { + if (setAlphaCorners(surfaces, count) < 0) return -1; + } + if (flags & Cards_BlackBorders) { + if (setBlackBorders(surfaces, count) < 0) return -1; + } + return 0; +} + +int +Cards_LoadFreeCell( + SDL_Surface *surfaces[], size_t count, + SDL_RWops *rw, enum Cards_Flag flags +) { + memset(surfaces, 0, sizeof(*surfaces) * count); + if (loadEXE(surfaces, count, rw, 402) < 0) return -1; + if (checkRange(surfaces, count, Cards_KingRight, Cards_KingWin) < 0) { + return -1; + } + if (flags & Cards_ColorKey) { + for (size_t i = Cards_KingRight; i <= Cards_KingWin; ++i) { + if (i >= count) break; + if (SDL_SetColorKey(surfaces[i], SDL_TRUE, 2) < 0) return -1; + } + } + return 0; +} + +static int invertPalette(SDL_Surface *surface) { + const SDL_Palette *palette = surface->format->palette; + SDL_Palette *invert = SDL_AllocPalette(palette->ncolors); + if (!invert) return -1; + for (int i = 0; i < invert->ncolors; ++i) { + invert->colors[i].r = ~palette->colors[i].r; + invert->colors[i].g = ~palette->colors[i].g; + invert->colors[i].b = ~palette->colors[i].b; + invert->colors[i].a = palette->colors[i].a; + } + if (SDL_SetSurfacePalette(surface, invert) < 0) return -1; + SDL_FreePalette(invert); + return 0; +} + +static int invertPixels(SDL_Surface *surface) { + if (SDL_LockSurface(surface) < 0) return -1; + Uint8 *pixels = surface->pixels; + for (int y = 0; y < surface->h; ++y) { + Uint32 *row = (Uint32 *)&pixels[y * surface->pitch]; + for (int x = 0; x < surface->w; ++x) { + Uint32 color = ~row[x] & ~surface->format->Amask; + Uint32 alpha = row[x] & surface->format->Amask; + row[x] = color | alpha; + } + } + SDL_UnlockSurface(surface); + return 0; +} + +int Cards_InvertSurface(SDL_Surface *surface) { + if (surface->format->palette) { + if (invertPalette(surface) < 0) return -1; + } else if (surface->format->BytesPerPixel == 4) { + if (invertPixels(surface) < 0) return -1; + } else { + SDL_SetError("cannot invert surface format"); + return -1; + } + return 0; +} diff --git a/cards/cards.h b/cards/cards.h new file mode 100644 index 0000000..9625cb8 --- /dev/null +++ b/cards/cards.h @@ -0,0 +1,80 @@ +/* Copyright (C) 2019 C. McEnroe <june@causal.agency> + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + */ + +#ifndef CARDS_H +#define CARDS_H + +#include <SDL_rwops.h> +#include <SDL_surface.h> +#include <stddef.h> + +enum { + Cards_CardWidth = 71, + Cards_CardHeight = 96, + Cards_KingWidth = 32, + Cards_KingHeight = 32, +}; + +enum Cards_Card { + Cards_Club, + Cards_Diamond = 13, + Cards_Heart = 26, + Cards_Spade = 39, + + // Add rank to suit to obtain card index. + Cards_A = 1, + Cards_2, Cards_3, Cards_4, Cards_5, Cards_6, Cards_7, Cards_8, Cards_9, + Cards_10, Cards_J, Cards_Q, Cards_K, + + Cards_Empty = 53, + Cards_Back1, Cards_Back2, Cards_Back3, Cards_Back4, + Cards_Back5, Cards_Back6, Cards_Back7, Cards_Back8, + Cards_Back9, Cards_Back10, Cards_Back11, Cards_Back12, + + Cards_X = 67, + Cards_O, + + Cards_CardCount, +}; + +enum Cards_FreeCell { + Cards_KingRight = 1, + Cards_KingLeft, + Cards_KingWin, + Cards_FreeCellCount, +}; + +enum Cards_Flag { + Cards_ColorKey = 1 << 0, + Cards_AlphaCorners = 1 << 1, + Cards_BlackBorders = 1 << 2, +}; + +int +Cards_LoadCards( + SDL_Surface *surfaces[], size_t count, + SDL_RWops *rw, enum Cards_Flag flags +); + +int +Cards_LoadFreeCell( + SDL_Surface *surfaces[], size_t count, + SDL_RWops *rw, enum Cards_Flag flags +); + +int Cards_InvertSurface(SDL_Surface *surface); + +#endif diff --git a/cards/configure b/cards/configure new file mode 100755 index 0000000..ba1718c --- /dev/null +++ b/cards/configure @@ -0,0 +1,8 @@ +#!/bin/sh +set -eu +cflags=$(pkg-config --cflags sdl2) +ldlibs=$(pkg-config --libs sdl2) +cat > config.mk << EOF +CFLAGS += ${cflags} +LDLIBS += ${ldlibs} +EOF diff --git a/cards/dump.1 b/cards/dump.1 new file mode 100644 index 0000000..a7fc3db --- /dev/null +++ b/cards/dump.1 @@ -0,0 +1,48 @@ +.Dd March 29, 2019 +.Dt DUMP 1 +.Os +. +.Sh NAME +.Nm dump +.Nd dump bitmap resources +. +.Sh SYNOPSIS +.Nm +.Op Fl abfik +.Op Ar file +. +.Sh DESCRIPTION +.Nm +dumps bitmap resources from +.Pa CARDS.DLL , +.Pa SOL.EXE +or +.Pa FREECELL.EXE +files. +Bitmaps are written to the current directory +starting with +.Pa 01.bmp . +. +.Pp +The arguments are as follows: +.Bl -tag -width Ds +.It Fl a +Set the +.Xr cards 3 +.Dv Cards_AlphaCorners +flag. +.It Fl b +Set the +.Xr cards 3 +.Dv Cards_BlackBorders +flag. +.It Fl f +Dump FreeCell bitmaps. +.It Fl i +Invert the colors of the bitmaps +.It Fl k +Set the +.Xr cards 3 +.Dv Cards_ColorKey +flag. +.El diff --git a/cards/dump.c b/cards/dump.c new file mode 100644 index 0000000..127d6b1 --- /dev/null +++ b/cards/dump.c @@ -0,0 +1,82 @@ +/* Copyright (C) 2019 C. McEnroe <june@causal.agency> + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + */ + +#define _XOPEN_SOURCE + +#include <err.h> +#include <stdbool.h> +#include <stdio.h> +#include <stdlib.h> +#include <sysexits.h> +#include <unistd.h> + +#include <SDL.h> + +#include "cards.h" + +int main(int argc, char *argv[]) { + bool freecell = false; + enum Cards_Flag flags = 0; + bool invert = false; + + int opt; + while (0 < (opt = getopt(argc, argv, "abfik"))) { + switch (opt) { + break; case 'a': flags |= Cards_AlphaCorners; + break; case 'b': flags |= Cards_BlackBorders; + break; case 'f': freecell = true; + break; case 'i': invert = true; + break; case 'k': flags |= Cards_ColorKey; + break; default: return EX_USAGE; + } + } + + struct SDL_RWops *rw; + if (optind < argc) { + rw = SDL_RWFromFile(argv[optind], "rb"); + } else { + rw = SDL_RWFromFP(stdin, SDL_FALSE); + } + if (!rw) errx(EX_NOINPUT, "SDL_RWFromFile: %s", SDL_GetError()); + + SDL_Surface *surfaces[Cards_CardCount]; + if (freecell) { + int error = Cards_LoadFreeCell( + surfaces, Cards_CardCount, rw, flags + ); + if (error) errx(EX_DATAERR, "Cards_LoadFreeCell: %s", SDL_GetError()); + } else { + int error = Cards_LoadCards(surfaces, Cards_CardCount, rw, flags); + if (error) errx(EX_DATAERR, "Cards_LoadCards: %s", SDL_GetError()); + } + SDL_RWclose(rw); + + for (size_t i = 0; i < Cards_CardCount; ++i) { + if (!surfaces[i]) continue; + + if (invert) { + int error = Cards_InvertSurface(surfaces[i]); + if (error) { + errx(EX_DATAERR, "Cards_InvertSurface: %s", SDL_GetError()); + } + } + + char name[sizeof("00.bmp")]; + snprintf(name, sizeof(name), "%02zu.bmp", i); + int error = SDL_SaveBMP(surfaces[i], name); + if (error) errx(EX_CANTCREAT, "SDL_SaveBMP: %s", SDL_GetError()); + } +} diff --git a/cards/example.c b/cards/example.c new file mode 100644 index 0000000..8790d65 --- /dev/null +++ b/cards/example.c @@ -0,0 +1,103 @@ +/* Copyright (C) 2019 C. McEnroe <june@causal.agency> + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + */ + +#include <stdio.h> +#include <stdlib.h> + +#include <SDL.h> + +#include "cards.h" + +static void err(const char *title) { + int error = SDL_ShowSimpleMessageBox( + SDL_MESSAGEBOX_ERROR, title, SDL_GetError(), NULL + ); + if (error) fprintf(stderr, "%s\n", SDL_GetError()); + SDL_Quit(); + exit(EXIT_FAILURE); +} + +enum { + MarginX = 11, + MarginY = 6, + DeltaX = 14, + DeltaY = 6 + Cards_CardHeight, + WindowWidth = MarginX + 12 * DeltaX + Cards_CardWidth + MarginX, + WindowHeight = MarginY + 4 * DeltaY, +}; + +int main(void) { + if (SDL_Init(SDL_INIT_VIDEO) < 0) err("SDL_Init"); + + struct SDL_RWops *rw = SDL_RWFromFile("CARDS.DLL", "rb"); + if (!rw) err("SDL_RWFromFile"); + + SDL_Surface *surfaces[Cards_CardCount]; + int error = Cards_LoadCards( + surfaces, Cards_CardCount, + rw, Cards_ColorKey | Cards_AlphaCorners | Cards_BlackBorders + ); + if (error) err("Cards_LoadCards"); + SDL_RWclose(rw); + + SDL_Window *window; + SDL_Renderer *render; + error = SDL_CreateWindowAndRenderer( + WindowWidth, WindowHeight, SDL_WINDOW_ALLOW_HIGHDPI, + &window, &render + ); + if (error) err("SDL_CreateWindowAndRenderer"); + SDL_SetWindowTitle(window, "Cards Example"); + + SDL_RenderSetIntegerScale(render, SDL_TRUE); + SDL_RenderSetLogicalSize(render, WindowWidth, WindowHeight); + + SDL_Texture *textures[Cards_CardCount]; + for (int i = 0; i < Cards_CardCount; ++i) { + textures[i] = NULL; + if (!surfaces[i]) continue; + textures[i] = SDL_CreateTextureFromSurface(render, surfaces[i]); + if (!textures[i]) err("SDL_CreateTextureFromSurface"); + SDL_FreeSurface(surfaces[i]); + } + + SDL_Rect rects[Cards_CardCount] = {0}; + for (int i = 1; i <= 52; ++i) { + rects[i].x = MarginX + (i - 1) % 13 * DeltaX; + rects[i].y = MarginY + (i - 1) / 13 * DeltaY; + rects[i].w = Cards_CardWidth; + rects[i].h = Cards_CardHeight; + } + + for (;;) { + SDL_SetRenderDrawColor(render, 0x00, 0xAA, 0x55, 0xFF); + SDL_RenderClear(render); + for (int i = 0; i < Cards_CardCount; ++i) { + if (!rects[i].w) continue; + SDL_RenderCopy(render, textures[i], NULL, &rects[i]); + } + SDL_RenderPresent(render); + + SDL_Event event; + for (;;) { + SDL_WaitEvent(&event); + if (event.type == SDL_QUIT) goto quit; + } + } + +quit: + SDL_Quit(); +} diff --git a/cards/exefmt.txt b/cards/exefmt.txt new file mode 100644 index 0000000..51fa9a7 --- /dev/null +++ b/cards/exefmt.txt @@ -0,0 +1,593 @@ +INF: Executable-File Header Format [P_WinSDK] + +3.00 +WINDOWS +PSSONLY | Windows 3 Developers Notes softlib ENDUSER + +Summary: + +Note: This article is part of a set of seven articles, collectively +called the "Windows 3.00 Developer's Notes." More information about +the contents of the other articles, and procedures for ordering a +hard-copy set, can be found in the knowledge base article titled "INF: +The Windows 3.00 Developer's Notes" (Q65260). + +This article can be found in the Software/Data Library by searching on +the word EXEFMT or S12688. EXEFMT was archived using the PKware +file-compression utility. + +More Information: + +Microsoft defined the segmented executable file format for Windows +applications and dynamic-link libraries (DLLs). This file format is +also referred to as the New Executable Format. This new format is an +extension of the existing MS-DOS .EXE format (old-style format). The +purpose of the segmented executable format is to provide the +information needed to support the dynamic linking and segmentation +capabilities of the Windows environment. + +An executable file contains Microsoft Windows code and data, or +Windows code, data, and resources. Specific fields have been added to +the old-style .EXE format header to indicate the existence of the +segmented file format. The old-style header may contain a valid +executable program, called a stub program, that will be executed if +the program is run on MS-DOS (without Windows). This stub program +usually prints a message indicating that Microsoft Windows is required +to run the program. The segmented executable format extensions also +begin with a header that describes the contents and location of the +executable image in the file. The loader uses this header information +when it loads the executable segments in memory. + + +====================================================================== + OLD-STYLE HEADER EXTENSIONS +====================================================================== + +The old-style header contains information the loader expects for a DOS +executable file. It describes a stub program (WINSTUB) the loader can +place in memory when necessary, it points to the new-style header, and +it contains the stub programs relocation table. + +The following illustrates the distinct parts of the old-style +executable format: + + +-------------------------+ + 00h | Old-style header info | + +-------------------------+ + 20h | Reserved | + +-------------------------+ + 3Ch | Offset to segmented | + | .EXE header | + +-------------------------+ + 40h | Relocation table and | + | DOS stub program | + +-------------------------+ + | Segmented .EXE Header | + | . | + | . | + | . | + +The word at offset 18h in the old-style .EXE header contains the +relative byte offset to the stub program's relocation table. If this +offset is 40h, then the double word at offset 3Ch is assumed to be the +relative byte offset from the beginning of the file to the beginning +of the segmented executable header. A new-format .EXE file is +identified if the segmented executable header contains a valid +signature. If the signature is not valid, the file is assumed to be an +old-style format .EXE file. The remainder of the old-style format +header will describe a DOS program, the stub. The stub may be any +valid program but will typically be a program that displays an error +message. + +====================================================================== + SEGMENTED EXE FORMAT +====================================================================== + +Because Windows executable files are often larger than one segment +(64K), additional information (that does not appear in the old-style +header) is required so that the loader can load each segment properly. +The segmented EXE format was developed to provide the loader with this +information. + +The segmented .EXE file has the following format: + + +-----------------+ + 00h | Old-style EXE | + | Header | + +-----------------+ + 20h | Reserved | + +-----------------+ + 3Ch | Offset to | ---+ + | Segmented Header| | + +-----------------+ | + 40h | Relocation Table| | + | & Stub Program | | + +-----------------+ | + | | | + +-----------------+ | + xxh | Segmented EXE | <--+ + | Header | + +-----------------+ + | Segment Table | + +-----------------+ + | Resource Table | + +-----------------+ + | Resident Name | + | Table | + +-----------------+ + | Module Reference| + | Table | + +-----------------+ + | Imported Names | + | Table | + +-----------------+ + | Entry Table | + +-----------------+ + | Non-Resident | + | Name Table | + +-----------------+ + | Seg #1 Data | + | Seg #1 Info | + +-----------------+ + . + . + . + +-----------------+ + | Seg #n Data | + | Seg #n Info | + +-----------------+ + + +The following sections describe each of the components that make up +the segmented EXE format. Each section contains a description of the +component and the fields in the structures that make up that +component. + +Note: All unused fields and flag bits are reserved for future use and +must contain 0 (zero) values. + +====================================================================== + SEGMENTED EXE HEADER +====================================================================== + +The segmented EXE header contains general information about the EXE +file and contains information on the location and size of the other +sections. The Windows loader copies this section, along with other +data, into the module table in the system data. The module table is +internal data used by the loader to manage the loaded executable +modules in the system and to support dynamic linking. + +The following describes the format of the segmented executable header. +For each field, the offset is given relative to the beginning of the +segmented header, the size of the field is defined, and a description +is given. + + Offset Size Description + ------ ---- ----------- + + 00h DW Signature word. + "N" is low-order byte. + "E" is high-order byte. + + 02h DB Version number of the linker. + + 03h DB Revision number of the linker. + + 04h DW Entry Table file offset, relative to the beginning of + the segmented EXE header. + 06h DW Number of bytes in the entry table. + + 08h DD 32-bit CRC of entire contents of file. + These words are taken as 00 during the calculation. + + 0Ch DW Flag word. + 0000h = NOAUTODATA + 0001h = SINGLEDATA (Shared automatic data segment) + 0002h = MULTIPLEDATA (Instanced automatic data + segment) + 2000h = Errors detected at link time, module will not + load. + 8000h = Library module. + The SS:SP information is invalid, CS:IP points + to an initialization procedure that is called + with AX equal to the module handle. This + initialization procedure must perform a far + return to the caller, with AX not equal to + zero to indicate success, or AX equal to zero + to indicate failure to initialize. DS is set + to the library's data segment if the + SINGLEDATA flag is set. Otherwise, DS is set + to the caller's data segment. + + A program or DLL can only contain dynamic + links to executable files that have this + library module flag set. One program cannot + dynamic-link to another program. + + 0Eh DW Segment number of automatic data segment. + This value is set to zero if SINGLEDATA and + MULTIPLEDATA flag bits are clear, NOAUTODATA is + indicated in the flags word. + + A Segment number is an index into the module's segment + table. The first entry in the segment table is segment + number 1. + + 10h DW Initial size, in bytes, of dynamic heap added to the + data segment. This value is zero if no initial local + heap is allocated. + + 12h DW Initial size, in bytes, of stack added to the data + segment. This value is zero to indicate no initial + stack allocation, or when SS is not equal to DS. + + 14h DD Segment number:offset of CS:IP. + + 18h DD Segment number:offset of SS:SP. + If SS equals the automatic data segment and SP equals + zero, the stack pointer is set to the top of the + automatic data segment just below the additional heap + area. + + +--------------------------+ + | additional dynamic heap | + +--------------------------+ <- SP + | additional stack | + +--------------------------+ + | loaded auto data segment | + +--------------------------+ <- DS, SS + + 1Ch DW Number of entries in the Segment Table. + + 1Eh DW Number of entries in the Module Reference Table. + 20h DW Number of bytes in the Non-Resident Name Table. + + 22h DW Segment Table file offset, relative to the beginning + of the segmented EXE header. + + 24h DW Resource Table file offset, relative to the beginning + of the segmented EXE header. + + 26h DW Resident Name Table file offset, relative to the + beginning of the segmented EXE header. + + 28h DW Module Reference Table file offset, relative to the + beginning of the segmented EXE header. + + 2Ah DW Imported Names Table file offset, relative to the + beginning of the segmented EXE header. + + 2Ch DD Non-Resident Name Table offset, relative to the + beginning of the file. + + 30h DW Number of movable entries in the Entry Table. + + 32h DW Logical sector alignment shift count, log(base 2) of + the segment sector size (default 9). + + 34h DW Number of resource entries. + + 36h DB Executable type, used by loader. + 02h = WINDOWS + + 37h-3Fh DB Reserved, currently 0's. + + +====================================================================== + SEGMENT TABLE +====================================================================== + +The segment table contains an entry for each segment in the executable +file. The number of segment table entries are defined in the segmented +EXE header. The first entry in the segment table is segment number 1. +The following is the structure of a segment table entry. + + Size Description + ---- ----------- + + DW Logical-sector offset (n byte) to the contents of the segment + data, relative to the beginning of the file. Zero means no + file data. + + DW Length of the segment in the file, in bytes. Zero means 64K. + + DW Flag word. + 0007h = TYPE_MASK Segment-type field. + 0000h = CODE Code-segment type. + 0001h = DATA Data-segment type. + 0010h = MOVEABLE Segment is not fixed. + 0040h = PRELOAD Segment will be preloaded; read-only if + this is a data segment. + 0100h = RELOCINFO Set if segment has relocation records. + F000h = DISCARD Discard priority. + + DW Minimum allocation size of the segment, in bytes. Total size + of the segment. Zero means 64K. + + +====================================================================== + RESOURCE TABLE +====================================================================== + +The resource table follows the segment table and contains entries for +each resource in the executable file. The resource table consists of +an alignment shift count, followed by a table of resource records. The +resource records define the type ID for a set of resources. Each +resource record contains a table of resource entries of the defined +type. The resource entry defines the resource ID or name ID for the +resource. It also defines the location and size of the resource. The +following describes the contents of each of these structures: + + Size Description + ---- ----------- + + DW Alignment shift count for resource data. + + A table of resource type information blocks follows. The following + is the format of each type information block: + + DW Type ID. This is an integer type if the high-order bit is + set (8000h); otherwise, it is an offset to the type string, + the offset is relative to the beginning of the resource + table. A zero type ID marks the end of the resource type + information blocks. + + DW Number of resources for this type. + + DD Reserved. + + A table of resources for this type follows. The following is + the format of each resource (8 bytes each): + + DW File offset to the contents of the resource data, + relative to beginning of file. The offset is in terms + of the alignment shift count value specified at + beginning of the resource table. + + DW Length of the resource in the file (in bytes). + + DW Flag word. + 0010h = MOVEABLE Resource is not fixed. + 0020h = PURE Resource can be shared. + 0040h = PRELOAD Resource is preloaded. + + DW Resource ID. This is an integer type if the high-order + bit is set (8000h), otherwise it is the offset to the + resource string, the offset is relative to the + beginning of the resource table. + + DD Reserved. + + Resource type and name strings are stored at the end of the + resource table. Note that these strings are NOT null terminated and + are case sensitive. + + DB Length of the type or name string that follows. A zero value + indicates the end of the resource type and name string, also + the end of the resource table. + + DB ASCII text of the type or name string. + + +====================================================================== + RESIDENT-NAME TABLE +====================================================================== + +The resident-name table follows the resource table, and contains this +module's name string and resident exported procedure name strings. The +first string in this table is this module's name. These name strings +are case-sensitive and are not null-terminated. The following +describes the format of the name strings: + + Size Description + ---- ----------- + + DB Length of the name string that follows. A zero value indicates + the end of the name table. + + DB ASCII text of the name string. + + DW Ordinal number (index into entry table). This value is ignored + for the module name. + + +====================================================================== + MODULE-REFERENCE TABLE +====================================================================== + +The module-reference table follows the resident-name table. Each entry +contains an offset for the module-name string within the imported- +names table; each entry is 2 bytes long. + + Size Description + ---- ----------- + + DW Offset within Imported Names Table to referenced module name + string. + + +====================================================================== + IMPORTED-NAME TABLE +====================================================================== + +The imported-name table follows the module-reference table. This table +contains the names of modules and procedures that are imported by the +executable file. Each entry is composed of a 1-byte field that +contains the length of the string, followed by any number of +characters. The strings are not null-terminated and are case +sensitive. + + Size Description + ---- ----------- + + DB Length of the name string that follows. + + DB ASCII text of the name string. + + +====================================================================== + ENTRY TABLE +====================================================================== + +The entry table follows the imported-name table. This table contains +bundles of entry-point definitions. Bundling is done to save space in +the entry table. The entry table is accessed by an ordinal value. +Ordinal number one is defined to index the first entry in the entry +table. To find an entry point, the bundles are scanned searching for a +specific entry point using an ordinal number. The ordinal number is +adjusted as each bundle is checked. When the bundle that contains the +entry point is found, the ordinal number is multiplied by the size of +the bundle's entries to index the proper entry. + +The linker forms bundles in the most dense manner it can, under the +restriction that it cannot reorder entry points to improve bundling. +The reason for this restriction is that other .EXE files may refer to +entry points within this bundle by their ordinal number. The following +describes the format of the entry table bundles. + + Size Description + ---- ----------- + + DB Number of entries in this bundle. All records in one bundle + are either moveable or refer to the same fixed segment. A zero + value in this field indicates the end of the entry table. + + DB Segment indicator for this bundle. This defines the type of + entry table entry data within the bundle. There are three + types of entries that are defined. + + 000h = Unused entries. There is no entry data in an unused + bundle. The next bundle follows this field. This is + used by the linker to skip ordinal numbers. + + 001h-0FEh = Segment number for fixed segment entries. A fixed + segment entry is 3 bytes long and has the following + format. + + DB Flag word. + 01h = Set if the entry is exported. + 02h = Set if the entry uses a global (shared) data + segments. + The first assembly-language instruction in the + entry point prologue must be "MOV AX,data + segment number". This may be set only for + SINGLEDATA library modules. + + DW Offset within segment to entry point. + + 0FFH = Moveable segment entries. The entry data contains the + segment number for the entry points. A moveable segment + entry is 6 bytes long and has the following format. + + DB Flag word. + 01h = Set if the entry is exported. + 02h = Set if the entry uses a global (shared) data + segments. + + INT 3FH. + + DB Segment number. + + DW Offset within segment to entry point. + + +====================================================================== + NONRESIDENT-NAME TABLE +====================================================================== + +The nonresident-name table follows the entry table, and contains a +module description and nonresident exported procedure name strings. +The first string in this table is a module description. These name +strings are case-sensitive and are not null-terminated. The name +strings follow the same format as those defined in the resident name +table. + + +====================================================================== + PER SEGMENT DATA +====================================================================== + +The location and size of the per-segment data is defined in the +segment table entry for the segment. If the segment has relocation +fixups, as defined in the segment table entry flags, they directly +follow the segment data in the file. The relocation fixup information +is defined as follows: + + + Size Description + ---- ----------- + + DW Number of relocation records that follow. + + A table of relocation records follows. The following is the format + of each relocation record. + + DB Source type. + 0Fh = SOURCE_MASK + 00h = LOBYTE + 02h = SEGMENT + 03h = FAR_ADDR (32-bit pointer) + 05h = OFFSET (16-bit offset) + + DB Flags byte. + 03h = TARGET_MASK + 00h = INTERNALREF + 01h = IMPORTORDINAL + 02h = IMPORTNAME + 03h = OSFIXUP + 04h = ADDITIVE + + DW Offset within this segment of the source chain. + If the ADDITIVE flag is set, then target value is added to + the source contents, instead of replacing the source and + following the chain. The source chain is an 0FFFFh + terminated linked list within this segment of all + references to the target. + + The target value has four types that are defined in the flag + byte field. The following are the formats for each target + type: + + INTERNALREF + + DB Segment number for a fixed segment, or 0FFh for a + movable segment. + + DB 0 + + DW Offset into segment if fixed segment, or ordinal + number index into Entry Table if movable segment. + + IMPORTNAME + + DW Index into module reference table for the imported + module. + + DW Offset within Imported Names Table to procedure name + string. + + IMPORTORDINAL + + DW Index into module reference table for the imported + module. + DW Procedure ordinal number. + + OSFIXUP + + DW Operating system fixup type. + Floating-point fixups. + 0001h = FIARQQ, FJARQQ + 0002h = FISRQQ, FJSRQQ + 0003h = FICRQQ, FJCRQQ + 0004h = FIERQQ + 0005h = FIDRQQ + 0006h = FIWRQQ + + DW 0 + +====================================================================== + +Microsoft is a registered trademark and Windows is a trademark of +Microsoft Corporation. + +Additional reference words: 3.0 |