diff --git a/.emmyrc.json b/.emmyrc.json new file mode 100644 index 0000000..c1a24f3 --- /dev/null +++ b/.emmyrc.json @@ -0,0 +1,28 @@ +{ + "$schema": "https://raw.githubusercontent.com/EmmyLuaLs/emmylua-analyzer-rust/refs/heads/main/crates/emmylua_code_analysis/resources/schema.json", + "runtime": { + "version": "LuaJIT" + }, + "workspace": { + "userThirdParty": [ + "/Users/demiller/git/lua-addons" + ], + "library": [ + ], + "useGitIgnore": false, + "ignoreDir": [ + ".claude", + ".git", + ".idea", + ".venv", + "build", + "dist", + "node_modules" + ] + }, + "diagnostics": { + "disable": [ + "unnecessary-assert" + ] + } +} diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..0b3059a --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,122 @@ +name: Lua Tests + +on: + push: + branches: [ main, master ] + pull_request: + branches: [ main, master ] + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + check: + runs-on: ubuntu-latest + name: Check + steps: + - uses: actions/checkout@v4 + + - name: Setup Lua + uses: leafo/gh-actions-lua@v11 + with: + luaVersion: '5.4' + + - name: Setup LuaRocks + uses: leafo/gh-actions-luarocks@v5 + with: + luarocksVersion: "3.12.2" + + - name: Install luacheck + run: luarocks install luacheck + + - name: Install stylua + uses: JohnnyMorganz/stylua-action@v4 + with: + token: ${{ secrets.GITHUB_TOKEN }} + version: v2.1.0 + args: false # Will be run as part of `make check` + + - name: Check + run: make check + + test: + needs: check + runs-on: ubuntu-latest + continue-on-error: false + strategy: + fail-fast: true + matrix: + lua-version: ['5.1', '5.2', '5.3', '5.4', 'luajit-2.0', 'luajit-2.1'] + + name: Lua ${{ matrix.lua-version }} + steps: + - uses: actions/checkout@v4 + + - name: Setup Lua + uses: leafo/gh-actions-lua@v11 + with: + luaVersion: ${{ matrix.lua-version }} + + - name: Setup tests + run: | + # Set the correct binary name based on the Lua version + if [[ "${{ matrix.lua-version }}" == luajit* ]]; then + LUA_BINARY=luajit + else + LUA_BINARY=lua + fi + + echo "LUA_BINARY=$LUA_BINARY" >> "$GITHUB_ENV" + ${LUA_BINARY} -v + + - name: Run tests + run: | + make test-all + + build: + needs: test + runs-on: ubuntu-latest + name: Build Combined Module + steps: + - uses: actions/checkout@v4 + + - name: Setup Lua + uses: leafo/gh-actions-lua@v11 + with: + luaVersion: '5.4' + + - name: Setup LuaRocks + uses: leafo/gh-actions-luarocks@v5 + with: + luarocksVersion: "3.12.2" + + - name: Install amalg + run: luarocks install amalg + + - name: Build combined module + run: make build + + - name: Verify build + run: | + # Check default build + if [ -f "build/bitn.lua" ]; then + echo "✅ build/bitn.lua exists ($(wc -c < "build/bitn.lua") bytes)" + # Quick sanity check - make sure it contains expected content + if grep -q "bitn" build/bitn.lua; then + echo "✅ Build contains expected content" + else + echo "❌ Build seems corrupted" + exit 1 + fi + else + echo "❌ build/bitn.lua missing" + exit 1 + fi + + - name: Upload artifacts + uses: actions/upload-artifact@v4 + with: + name: bitn.lua + path: build/bitn.lua + retention-days: 30 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..f5989f2 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,47 @@ +name: Release + +on: + push: + tags: + - 'v*' + +permissions: + contents: write + +jobs: + release: + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Setup Lua + uses: leafo/gh-actions-lua@v11 + with: + luaVersion: '5.4' + + - name: Setup LuaRocks + uses: leafo/gh-actions-luarocks@v5 + with: + luarocksVersion: "3.12.2" + + - name: Install amalg + run: luarocks install amalg + + - name: Build combined module + run: | + # The make build command will automatically inject the version from the git tag + make build + + - name: Create Release + uses: softprops/action-gh-release@v1 + with: + draft: false + prerelease: ${{ contains(github.ref_name, '-rc') || contains(github.ref_name, '-beta') || contains(github.ref_name, '-alpha') }} + name: Release ${{ github.ref_name }} + tag_name: ${{ github.ref }} + generate_release_notes: true + files: | + build/bitn.lua diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..284737f --- /dev/null +++ b/.gitignore @@ -0,0 +1,43 @@ +# Compiled Lua sources +luac.out + +# luarocks build files +*.src.rock +*.zip +*.tar.gz + +# Object files +*.o +*.os +*.ko +*.obj +*.elf + +# Precompiled Headers +*.gch +*.pch + +# Libraries +*.lib +*.a +*.la +*.lo +*.def +*.exp + +# Shared objects (inc. Windows DLLs) +*.dll +*.so +*.so.* +*.dylib + +# Executables +*.exe +*.out +*.app +*.i*86 +*.x86_64 +*.hex + +# Build artifacts +build/ diff --git a/.luacheckrc b/.luacheckrc new file mode 100644 index 0000000..34544ed --- /dev/null +++ b/.luacheckrc @@ -0,0 +1,12 @@ +std = "min" +globals = { + unpack = {} +} +ignore = { + "212/_.*", + "211/_.*", + "213/_.*", +} +compat = true +unused_args = false +max_line_length = false diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..5760f01 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,110 @@ +# lua-bitn Development Guide + +## Project Structure + +``` +lua-bitn/ +├── src/bitn/ +│ ├── init.lua # Module aggregator, exports bit16/bit32/bit64 +│ ├── bit16.lua # 16-bit bitwise operations +│ ├── bit32.lua # 32-bit bitwise operations +│ └── bit64.lua # 64-bit bitwise operations (uses {high, low} pairs) +├── tests/ +│ ├── test_bit16.lua # 16-bit test vectors +│ ├── test_bit32.lua # 32-bit test vectors +│ └── test_bit64.lua # 64-bit test vectors +├── .github/workflows/ +│ ├── build.yml # CI: lint, test matrix, build +│ └── release.yml # Release automation +├── run_tests.sh # Main test runner +├── run_tests_matrix.sh # Multi-version test runner +└── Makefile # Build automation +``` + +## Key Commands + +```bash +# Run tests +make test + +# Run specific module tests +make test-bit32 + +# Run across Lua versions +make test-matrix + +# Format code +make format + +# Lint code +make lint + +# Build single-file distribution +make build +``` + +## Architecture + +### Module Design + +Each bit module (bit16, bit32, bit64) provides the same API: +- Bitwise: band, bor, bxor, bnot +- Shifts: lshift, rshift, arshift +- Rotates: rol, ror +- Arithmetic: add, mask +- Byte conversions: uN_to_be_bytes, uN_to_le_bytes, be_bytes_to_uN, le_bytes_to_uN + +### 64-bit Representation + +64-bit values use `{high, low}` pairs for Lua 5.1 compatibility: +```lua +-- 0x123456789ABCDEF0 represented as: +local value = {0x12345678, 0x9ABCDEF0} +``` + +### Pure Lua Implementation + +All operations are implemented using basic Lua arithmetic to ensure +compatibility across all Lua versions without native bit library dependencies. + +## Testing + +Tests use Lua table-based vectors for easy maintenance: + +```lua +local test_vectors = { + { name = "band(0xFF, 0x0F)", fn = bit32.band, inputs = {0xFF, 0x0F}, expected = 0x0F }, + -- ... +} +``` + +Run with: `./run_tests.sh` or `make test` + +## Building + +The build process uses `amalg` to create a single-file distribution: + +```bash +make build +# Output: build/bitn.lua +``` + +Version is automatically injected from git tags during release. + +## CI/CD + +- **build.yml**: Runs on push/PR to main + - Format check with stylua + - Lint with luacheck + - Test matrix (Lua 5.1-5.4, LuaJIT 2.0/2.1) + - Build single-file distribution + +- **release.yml**: Runs on version tags (v*) + - Builds and publishes release with bitn.lua artifact + +## Code Style + +- 2-space indentation +- 120 column width +- Double quotes preferred +- LuaDoc annotations for all public functions diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..29ebfa5 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU 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. + + + Copyright (C) + + 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 . + +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 +. \ No newline at end of file diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..fa7663f --- /dev/null +++ b/Makefile @@ -0,0 +1,161 @@ +# Default target +.PHONY: all +all: format lint test build + +# Run tests +.PHONY: test +test: + ./run_tests.sh + +# Run test matrix +.PHONY: test-matrix +test-matrix: + ./run_tests_matrix.sh + +# Run specific test suite for test matrix +.PHONY: test-matrix-% +test-matrix-%: + ./run_tests_matrix.sh $* + +# Run specific test suite +.PHONY: test-% +test-%: + ./run_tests.sh $* + + +build/amalg.cache: src/bitn/init.lua + @echo "Generating amalgamation cache..." + @mkdir -p build + @if command -v amalg.lua >/dev/null 2>&1; then \ + LUA_PATH="./src/?.lua;./src/?/init.lua;$(LUA_PATH)" lua -lamalg src/bitn/init.lua && mv amalg.cache build || exit 1; \ + echo "Generated amalg.cache"; \ + else \ + echo "Error: amalg not found."; \ + echo "Please install amalg: luarocks install amalg"; \ + echo "Or run: make install-deps"; \ + exit 1; \ + fi + +# Build single-file distributions +.PHONY: build +build: build/amalg.cache + @echo "Building single-file distribution..." + @if command -v amalg.lua >/dev/null 2>&1; then \ + LUA_PATH="./src/?.lua;./src/?/init.lua;$(LUA_PATH)" amalg.lua -o build/bitn.lua -C ./build/amalg.cache || exit 1;\ + echo "Built build/bitn.lua"; \ + VERSION=$$(git describe --exact-match --tags 2>/dev/null || echo "dev"); \ + if [ "$$VERSION" != "dev" ]; then \ + echo "Injecting version $$VERSION..."; \ + sed -i.bak 's/VERSION = "dev"/VERSION = "'$$VERSION'"/' build/bitn.lua && rm build/bitn.lua.bak; \ + fi; \ + echo "Testing version function..."; \ + LUA_VERSION=$$(lua -e 'local b = require("build.bitn"); print(b.version())' 2>/dev/null || echo "test failed"); \ + if [ "$$LUA_VERSION" = "$$VERSION" ]; then \ + echo "Version correctly set to: $$VERSION"; \ + else \ + echo "Version test failed. Expected: $$VERSION, Got: $$LUA_VERSION"; \ + fi; \ + else \ + echo "Error: amalg not found."; \ + echo "Please install amalg: luarocks install amalg"; \ + echo "Or run: make install-deps"; \ + exit 1; \ + fi + +# Install all development dependencies +.PHONY: install-deps +install-deps: + @echo "Installing development dependencies..." + @echo "" + @echo "=== Installing system tools ===" + @if command -v brew >/dev/null 2>&1; then \ + echo "Using Homebrew to install tools..."; \ + brew install lua-language-server stylua || true; \ + else \ + echo "Please install the following manually:"; \ + echo " - lua-language-server: https://github.com/LuaLS/lua-language-server/releases"; \ + echo " - stylua: https://github.com/JohnnyMorganz/StyLua/releases"; \ + echo " - luarocks: https://github.com/luarocks/luarocks/wiki/Download"; \ + fi + @echo "" + @echo "=== Installing Lua tools ===" + @if command -v luarocks >/dev/null 2>&1; then \ + echo "Using LuaRocks to install tools..."; \ + luarocks install luacheck || exit 1; \ + luarocks install amalg || exit 1; \ + else \ + echo "luarocks not found. Please install it first."; \ + echo " macOS: brew install luarocks"; \ + echo " Linux: apt-get install luarocks"; \ + exit 1; \ + fi + +# Format Lua code with stylua +.PHONY: format +format: + @if command -v stylua >/dev/null 2>&1; then \ + echo "Running stylua..."; \ + stylua --indent-type Spaces --column-width 120 --line-endings Unix \ + --indent-width 2 --quote-style AutoPreferDouble \ + src/ 2>/dev/null; \ + else \ + echo "stylua not found. Install with: make install-deps"; \ + exit 1; \ + fi + +# Check Lua formatting +.PHONY: format-check +format-check: + @if command -v stylua >/dev/null 2>&1; then \ + echo "Running stylua check..."; \ + stylua --check --indent-type Spaces --column-width 120 --line-endings Unix \ + --indent-width 2 --quote-style AutoPreferDouble \ + src/; \ + else \ + echo "stylua not found. Install with: make install-deps"; \ + exit 1; \ + fi + +# Lint the code with luacheck +.PHONY: lint +lint: + @if command -v luacheck >/dev/null 2>&1; then \ + echo "Running luacheck..."; \ + luacheck src/; \ + else \ + echo "luacheck not found. Install with: make install-deps"; \ + exit 1; \ + fi + +.PHONY: check +check: format-check lint + @echo "Code quality checks complete." + +# Clean generated files +.PHONY: clean +clean: + rm -rf build/ + +# Help +.PHONY: help +help: + @echo "Lua bitN Library - Makefile targets" + @echo "" + @echo "Testing:" + @echo " make test - Run all tests" + @echo " make test- - Run specific test (e.g., make test-bit32)" + @echo " make test-matrix - Run test matrix across Lua versions" + @echo "" + @echo "Building:" + @echo " make build - Build single-file distribution" + @echo "" + @echo "Code Quality:" + @echo " make format - Format all code (Lua)" + @echo " make format-check - Check code formatting" + @echo " make lint - Lint code with luacheck" + @echo "" + @echo "Setup:" + @echo " make install-deps - Install all development dependencies" + @echo " make clean - Remove generated files" + @echo "" + @echo " make help - Show this help" diff --git a/README.md b/README.md index 1060238..eb6d184 100644 --- a/README.md +++ b/README.md @@ -1 +1,105 @@ # lua-bitn + +A pure Lua implementation of bitwise operations for 16-bit, 32-bit, and 64-bit +integers with **zero external dependencies**. This library provides a complete, +portable implementation that runs on Lua 5.1, 5.2, 5.3, 5.4, and LuaJIT. + +## Features + +- **Zero Dependencies**: Pure Lua implementation, no C extensions or external + libraries required +- **Portable**: Runs on any Lua interpreter (5.1+) +- **Complete**: Full bitwise operations API for 16-bit, 32-bit, and 64-bit integers +- **Byte Conversions**: Big-endian and little-endian byte string conversions +- **Well-tested**: Comprehensive self-tests with embedded test vectors + +## Installation + +Clone this repository: + +```bash +git clone https://github.com/finitelabs/lua-bitn.git +cd lua-bitn +``` + +Add the `src` directory to your Lua path, or copy the files to your project. + +## Usage + +### Basic Example + +```lua +local bitn = require("bitn") + +-- Check version +print(bitn.version()) + +-- 32-bit operations +local bit32 = bitn.bit32 +local result = bit32.band(0xFF00, 0x0FF0) -- 0x0F00 +local shifted = bit32.lshift(1, 8) -- 256 +local rotated = bit32.ror(0x12345678, 8) -- 0x78123456 + +-- Byte conversions (big-endian) +local bytes = bit32.u32_to_be_bytes(0x12345678) +local num = bit32.be_bytes_to_u32(bytes) -- 0x12345678 + +-- 16-bit operations +local bit16 = bitn.bit16 +local masked = bit16.mask(0x12345) -- 0x2345 +local negated = bit16.bnot(0xFF00) -- 0x00FF + +-- 64-bit operations (using {high, low} pairs) +local bit64 = bitn.bit64 +local a = {0x00000001, 0xFFFFFFFF} -- 0x1FFFFFFFF +local b = {0x00000000, 0x00000001} -- 0x1 +local sum = bit64.add(a, b) -- {0x00000002, 0x00000000} +local xored = bit64.bxor( + {0x12345678, 0x9ABCDEF0}, + {0x12345678, 0x9ABCDEF0} +) -- {0, 0} +``` + +### 64-bit Value Representation + +64-bit values are represented as `{high, low}` pairs where: +- `high` is the upper 32 bits +- `low` is the lower 32 bits + +Example: `0x123456789ABCDEF0` is represented as `{0x12345678, 0x9ABCDEF0}` + +## Testing + +Run the test suite: + +```bash +# Run all tests with default Lua interpreter +./run_tests.sh + +# Run with specific Lua version +LUA_BINARY=lua5.1 ./run_tests.sh + +# Run specific module +./run_tests.sh bit32 + +# Run test matrix across all Lua versions +./run_tests_matrix.sh +``` + +## Current Limitations + +- Pure Lua performance is slower than native bit libraries +- No constant-time guarantees + +## License + +GNU Affero General Public License v3.0 - see LICENSE file for details + +## Contributing + +Contributions are welcome! Please ensure all tests pass and add new tests for +any new functionality. + +--- + +Buy Me A Coffee diff --git a/run_tests.sh b/run_tests.sh new file mode 100755 index 0000000..919be84 --- /dev/null +++ b/run_tests.sh @@ -0,0 +1,167 @@ +#!/bin/bash + +# lua-bitn Test Runner +# +# Usage: ./run_tests.sh [module_names...] +# +# Examples: +# ./run_tests.sh # Run all modules +# ./run_tests.sh bit32 bit64 # Run only bit32 and bit64 +# +# Available modules: bit16, bit32, bit64 + +set -e # Exit on any error + +echo "=============================================" +echo "Bit-N Library - Test Suite Runner" +echo "=============================================" +echo + +# Colors for output +green='\033[0;32m' +red='\033[0;31m' +blue='\033[0;34m' +nc='\033[0m' # No Color + +# Track overall results +passed_modules=() +failed_modules=() + +# Lua binary to use for running tests +lua_binary="${LUA_BINARY:-lua}" + +# Check if the lua binary is available +if ! command -v "$lua_binary" &> /dev/null; then + echo -e "${red}Error: $lua_binary command not found.${nc}" + exit 1 +fi +echo "$($lua_binary -v)" +echo + +# Get script directory +script_dir=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd) + +# Add repository root to Lua's package path +# This allows require() to find modules in the src/tests directories +lua_path="$script_dir/?.lua;$script_dir/?/init.lua;$script_dir/src/?.lua;$script_dir/src/?/init.lua;$script_dir/tests/?.lua;$LUA_PATH" + +# Parse command line arguments to determine which modules to run +default_modules=("bit16" "bit32" "bit64") +all_modules=("bit16" "bit32" "bit64") +modules_to_run=("$@") + +# Validate modules if specified +if [ ${#modules_to_run[@]} -gt 0 ] && [ "${modules_to_run[0]}" != "all" ]; then + for module in "${modules_to_run[@]}"; do + valid=0 + for valid_module in "${all_modules[@]}"; do + if [ "$module" = "$valid_module" ]; then + valid=1 + break + fi + done + if [ $valid -eq 0 ]; then + echo -e "${red}Error: Unknown module '$module'${nc}" + echo "Available modules: ${all_modules[*]}" + exit 1 + fi + done +fi + +if [ ${#modules_to_run[@]} -eq 0 ]; then + modules_to_run=("${default_modules[@]}") + echo "Running default modules: ${modules_to_run[*]}" +elif [ "${modules_to_run[0]}" = "all" ]; then + modules_to_run=("${all_modules[@]}") + echo "Running all modules: ${modules_to_run[*]}" +else + echo "Running specified modules: ${modules_to_run[*]}" +fi +echo + +# Function to check if a module should be run +should_run_module() { + local module_key="$1" + for module in "${modules_to_run[@]}"; do + if [ "$module" = "$module_key" ]; then + return 0 + fi + done + return 1 +} + +# Function to run a test and capture result +run_test() { + local module_name="$1" + local module_key="$2" + local lua_command="$3" + + if ! should_run_module "$module_key"; then + return + fi + + echo "---------------------------------------------" + echo -e "${blue}Testing $module_name...${nc}" + echo "---------------------------------------------" + + if LUA_PATH="$lua_path" "$lua_binary" -e "$lua_command" 2>&1; then + echo -e "${green}✅ $module_name: ALL TESTS PASSED${nc}" + passed_modules+=("$module_name") + else + echo -e "${red}❌ $module_name: TESTS FAILED${nc}" + failed_modules+=("$module_name") + fi + + echo +} + +run_selftest() { + local module_name="$1" + local module_key="$2" + local lua_module="$3" + run_test "$module_name" "$module_key" " + local result = require('$lua_module').selftest() + if not result then + os.exit(1) + end + " +} + +run_selftest "16-bit operations" "bit16" "bitn.bit16" +run_selftest "32-bit operations" "bit32" "bitn.bit32" +run_selftest "64-bit operations" "bit64" "bitn.bit64" + +passed_count=${#passed_modules[@]} +failed_count=${#failed_modules[@]} +total_count=$((passed_count + failed_count)) + +# If only one module is run, no need to summarize +if [ $total_count -eq 1 ]; then + if [ $failed_count -gt 0 ]; then + exit 1 + fi + exit 0 +fi + +# Summary +echo "=============================================" +echo "📊 TEST SUMMARY" +echo "=============================================" + +if [ $passed_count -eq $total_count ]; then + echo -e "${green}🎉 ALL MODULES PASSED: $passed_count/$total_count${nc}" + echo + echo "Passed modules:" + for module in "${passed_modules[@]}"; do + echo "• $module: ✅ PASS" + done + exit 0 +else + echo -e "${red}💥 SOME MODULES FAILED: $passed_count/$total_count passed${nc}" + echo + echo "Failed modules:" + for module in "${failed_modules[@]}"; do + echo "• $module: ❌ FAIL" + done + exit 1 +fi diff --git a/run_tests_matrix.sh b/run_tests_matrix.sh new file mode 100755 index 0000000..4d81e76 --- /dev/null +++ b/run_tests_matrix.sh @@ -0,0 +1,62 @@ +#!/bin/bash + +# List of luaenv versions to test +LUA_VERSIONS=("5.1.5" "5.2.4" "5.3.6" "5.4.8" "luajit-2.1-dev") + +# Colors for output +green='\033[0;32m' +yellow='\033[1;33m' +red='\033[0;31m' +nc='\033[0m' # No Color + +luaenv_binary="${LUAENV_BINARY:-luaenv}" # Use luaenv by default, can be overridden + +# Get script directory +script_dir=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd) + +if ! command -v "$luaenv_binary" &> /dev/null; then + echo -e "${red}❌ Error: $luaenv_binary command not found.${nc}" + exit 1 +fi + +if [ ! -d "$($luaenv_binary prefix)/../../plugins/luaenv-luarocks" ]; then + echo -e "${red}❌ Error: luaenv-luarocks plugin not found. Please install it first.${nc}" + exit 1 +fi + +# Track overall results +failed_versions=() +passed_versions=() + +for lua_version in "${LUA_VERSIONS[@]}"; do + echo -e "${yellow}~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~${nc}" + echo -e "${yellow}Running tests with $lua_version${nc}" + echo -e "${yellow}~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~${nc}" + echo + + "$luaenv_binary" install -s $lua_version + lua_prefix="$($luaenv_binary prefix $lua_version)" + lua_binary="$lua_prefix/bin/lua" + + # Run the tests and pass all arguments + if ! LUA_BINARY="$lua_binary" "$script_dir/run_tests.sh" "$@"; then + failed_versions+=("$lua_version") + else + passed_versions+=("$lua_version") + fi +done + +# Final summary +echo "=============================================" +echo "📊 Matrix Test Summary" +echo "=============================================" + +if [ ${#failed_versions[@]} -eq 0 ]; then + echo -e "${green}✅ All LUA VERSIONS PASSED:${nc}" + printf '%s\n' "${passed_versions[@]}" + exit 0 +else + echo -e "${red}💥 SOME LUA VERSIONS FAILED:${nc}" + printf '%s\n' "${failed_versions[@]}" + exit 1 +fi diff --git a/src/bitn/bit16.lua b/src/bitn/bit16.lua new file mode 100644 index 0000000..e79d73a --- /dev/null +++ b/src/bitn/bit16.lua @@ -0,0 +1,440 @@ +--- @module "bitn.bit16" +--- Pure Lua 16-bit bitwise operations library. +--- This module provides a complete, version-agnostic implementation of 16-bit +--- bitwise operations that works across Lua 5.1, 5.2, 5.3, 5.4, and LuaJIT +--- without depending on any built-in bit libraries. +--- @class bit16 +local bit16 = {} + +-- 16-bit mask constant +local MASK16 = 0xFFFF + +--- Ensure value fits in 16-bit unsigned integer. +--- @param n number Input value +--- @return integer result 16-bit unsigned integer (0 to 0xFFFF) +function bit16.mask(n) + return math.floor(n % 0x10000) +end + +--- Bitwise AND operation. +--- @param a integer First operand (16-bit) +--- @param b integer Second operand (16-bit) +--- @return integer result Result of a AND b +function bit16.band(a, b) + a = bit16.mask(a) + b = bit16.mask(b) + + local result = 0 + local bit_val = 1 + + for _ = 0, 15 do + if (a % 2 == 1) and (b % 2 == 1) then + result = result + bit_val + end + a = math.floor(a / 2) + b = math.floor(b / 2) + bit_val = bit_val * 2 + + if a == 0 and b == 0 then + break + end + end + + return result +end + +--- Bitwise OR operation. +--- @param a integer First operand (16-bit) +--- @param b integer Second operand (16-bit) +--- @return integer result Result of a OR b +function bit16.bor(a, b) + a = bit16.mask(a) + b = bit16.mask(b) + + local result = 0 + local bit_val = 1 + + for _ = 0, 15 do + if (a % 2 == 1) or (b % 2 == 1) then + result = result + bit_val + end + a = math.floor(a / 2) + b = math.floor(b / 2) + bit_val = bit_val * 2 + + if a == 0 and b == 0 then + break + end + end + + return result +end + +--- Bitwise XOR operation. +--- @param a integer First operand (16-bit) +--- @param b integer Second operand (16-bit) +--- @return integer result Result of a XOR b +function bit16.bxor(a, b) + a = bit16.mask(a) + b = bit16.mask(b) + + local result = 0 + local bit_val = 1 + + for _ = 0, 15 do + if (a % 2) ~= (b % 2) then + result = result + bit_val + end + a = math.floor(a / 2) + b = math.floor(b / 2) + bit_val = bit_val * 2 + + if a == 0 and b == 0 then + break + end + end + + return result +end + +--- Bitwise NOT operation. +--- @param a integer Operand (16-bit) +--- @return integer result Result of NOT a +function bit16.bnot(a) + return bit16.mask(MASK16 - bit16.mask(a)) +end + +--- Left shift operation. +--- @param a integer Value to shift (16-bit) +--- @param n integer Number of positions to shift (must be >= 0) +--- @return integer result Result of a << n +function bit16.lshift(a, n) + assert(n >= 0, "Shift amount must be non-negative") + if n >= 16 then + return 0 + end + return bit16.mask(bit16.mask(a) * math.pow(2, n)) +end + +--- Logical right shift operation (fills with 0s). +--- @param a integer Value to shift (16-bit) +--- @param n integer Number of positions to shift (must be >= 0) +--- @return integer result Result of a >> n (logical) +function bit16.rshift(a, n) + assert(n >= 0, "Shift amount must be non-negative") + a = bit16.mask(a) + if n >= 16 then + return 0 + end + return math.floor(a / math.pow(2, n)) +end + +--- Arithmetic right shift operation (sign-extending, fills with sign bit). +--- @param a integer Value to shift (16-bit, treated as signed) +--- @param n integer Number of positions to shift (must be >= 0) +--- @return integer result Result of a >> n with sign extension +function bit16.arshift(a, n) + assert(n >= 0, "Shift amount must be non-negative") + a = bit16.mask(a) + + -- Check if sign bit is set (bit 15) + local is_negative = a >= 0x8000 + + if n >= 16 then + -- All bits shift out, result is all 1s if negative, all 0s if positive + return is_negative and 0xFFFF or 0 + end + + -- Perform logical right shift first + local result = math.floor(a / math.pow(2, n)) + + -- If original was negative, fill high bits with 1s + if is_negative then + -- Create mask for high bits that need to be 1 + local fill_mask = MASK16 - (math.pow(2, 16 - n) - 1) + result = bit16.bor(result, fill_mask) + end + + return result +end + +--- Left rotate operation. +--- @param x integer Value to rotate (16-bit) +--- @param n integer Number of positions to rotate +--- @return integer result Result of rotating x left by n positions +function bit16.rol(x, n) + n = n % 16 + x = bit16.mask(x) + return bit16.mask(bit16.lshift(x, n) + bit16.rshift(x, 16 - n)) +end + +--- Right rotate operation. +--- @param x integer Value to rotate (16-bit) +--- @param n integer Number of positions to rotate +--- @return integer result Result of rotating x right by n positions +function bit16.ror(x, n) + n = n % 16 + x = bit16.mask(x) + return bit16.mask(bit16.rshift(x, n) + bit16.lshift(x, 16 - n)) +end + +--- 16-bit addition with overflow handling. +--- @param a integer First operand (16-bit) +--- @param b integer Second operand (16-bit) +--- @return integer result Result of (a + b) mod 2^16 +function bit16.add(a, b) + return bit16.mask(bit16.mask(a) + bit16.mask(b)) +end + +-------------------------------------------------------------------------------- +-- Byte conversion functions +-------------------------------------------------------------------------------- + +--- Convert 16-bit unsigned integer to 2 bytes (big-endian). +--- @param n integer 16-bit unsigned integer +--- @return string bytes 2-byte string in big-endian order +function bit16.u16_to_be_bytes(n) + n = bit16.mask(n) + return string.char(math.floor(n / 256), n % 256) +end + +--- Convert 16-bit unsigned integer to 2 bytes (little-endian). +--- @param n integer 16-bit unsigned integer +--- @return string bytes 2-byte string in little-endian order +function bit16.u16_to_le_bytes(n) + n = bit16.mask(n) + return string.char(n % 256, math.floor(n / 256)) +end + +--- Convert 2 bytes to 16-bit unsigned integer (big-endian). +--- @param str string Binary string (at least 2 bytes from offset) +--- @param offset? integer Starting position (default: 1) +--- @return integer n 16-bit unsigned integer +function bit16.be_bytes_to_u16(str, offset) + offset = offset or 1 + assert(#str >= offset + 1, "Insufficient bytes for u16") + local b1, b2 = string.byte(str, offset, offset + 1) + return b1 * 256 + b2 +end + +--- Convert 2 bytes to 16-bit unsigned integer (little-endian). +--- @param str string Binary string (at least 2 bytes from offset) +--- @param offset? integer Starting position (default: 1) +--- @return integer n 16-bit unsigned integer +function bit16.le_bytes_to_u16(str, offset) + offset = offset or 1 + assert(#str >= offset + 1, "Insufficient bytes for u16") + local b1, b2 = string.byte(str, offset, offset + 1) + return b1 + b2 * 256 +end + +-------------------------------------------------------------------------------- +-- Self-test +-------------------------------------------------------------------------------- + +-- Compatibility for unpack +local unpack_fn = unpack or table.unpack + +--- Run comprehensive self-test with test vectors. +--- @return boolean result True if all tests pass, false otherwise +function bit16.selftest() + print("Running 16-bit operations test vectors...") + local passed = 0 + local total = 0 + + local test_vectors = { + -- mask tests + { name = "mask(0)", fn = bit16.mask, inputs = { 0 }, expected = 0 }, + { name = "mask(1)", fn = bit16.mask, inputs = { 1 }, expected = 1 }, + { name = "mask(0xFFFF)", fn = bit16.mask, inputs = { 0xFFFF }, expected = 0xFFFF }, + { name = "mask(0x10000)", fn = bit16.mask, inputs = { 0x10000 }, expected = 0 }, + { name = "mask(0x10001)", fn = bit16.mask, inputs = { 0x10001 }, expected = 1 }, + { name = "mask(-1)", fn = bit16.mask, inputs = { -1 }, expected = 0xFFFF }, + { name = "mask(-256)", fn = bit16.mask, inputs = { -256 }, expected = 0xFF00 }, + + -- band tests + { name = "band(0xFF00, 0x00FF)", fn = bit16.band, inputs = { 0xFF00, 0x00FF }, expected = 0 }, + { name = "band(0xFFFF, 0xFFFF)", fn = bit16.band, inputs = { 0xFFFF, 0xFFFF }, expected = 0xFFFF }, + { name = "band(0xAAAA, 0x5555)", fn = bit16.band, inputs = { 0xAAAA, 0x5555 }, expected = 0 }, + { name = "band(0xF0F0, 0xFF00)", fn = bit16.band, inputs = { 0xF0F0, 0xFF00 }, expected = 0xF000 }, + + -- bor tests + { name = "bor(0xFF00, 0x00FF)", fn = bit16.bor, inputs = { 0xFF00, 0x00FF }, expected = 0xFFFF }, + { name = "bor(0, 0)", fn = bit16.bor, inputs = { 0, 0 }, expected = 0 }, + { name = "bor(0xAAAA, 0x5555)", fn = bit16.bor, inputs = { 0xAAAA, 0x5555 }, expected = 0xFFFF }, + + -- bxor tests + { name = "bxor(0xFF00, 0x00FF)", fn = bit16.bxor, inputs = { 0xFF00, 0x00FF }, expected = 0xFFFF }, + { name = "bxor(0xFFFF, 0xFFFF)", fn = bit16.bxor, inputs = { 0xFFFF, 0xFFFF }, expected = 0 }, + { name = "bxor(0xAAAA, 0x5555)", fn = bit16.bxor, inputs = { 0xAAAA, 0x5555 }, expected = 0xFFFF }, + { name = "bxor(0x1234, 0x1234)", fn = bit16.bxor, inputs = { 0x1234, 0x1234 }, expected = 0 }, + + -- bnot tests + { name = "bnot(0)", fn = bit16.bnot, inputs = { 0 }, expected = 0xFFFF }, + { name = "bnot(0xFFFF)", fn = bit16.bnot, inputs = { 0xFFFF }, expected = 0 }, + { name = "bnot(0xAAAA)", fn = bit16.bnot, inputs = { 0xAAAA }, expected = 0x5555 }, + { name = "bnot(0x1234)", fn = bit16.bnot, inputs = { 0x1234 }, expected = 0xEDCB }, + + -- lshift tests + { name = "lshift(1, 0)", fn = bit16.lshift, inputs = { 1, 0 }, expected = 1 }, + { name = "lshift(1, 1)", fn = bit16.lshift, inputs = { 1, 1 }, expected = 2 }, + { name = "lshift(1, 15)", fn = bit16.lshift, inputs = { 1, 15 }, expected = 0x8000 }, + { name = "lshift(1, 16)", fn = bit16.lshift, inputs = { 1, 16 }, expected = 0 }, + { name = "lshift(0xFF, 8)", fn = bit16.lshift, inputs = { 0xFF, 8 }, expected = 0xFF00 }, + { name = "lshift(0x8000, 1)", fn = bit16.lshift, inputs = { 0x8000, 1 }, expected = 0 }, + + -- rshift tests + { name = "rshift(1, 0)", fn = bit16.rshift, inputs = { 1, 0 }, expected = 1 }, + { name = "rshift(2, 1)", fn = bit16.rshift, inputs = { 2, 1 }, expected = 1 }, + { name = "rshift(0x8000, 15)", fn = bit16.rshift, inputs = { 0x8000, 15 }, expected = 1 }, + { name = "rshift(0x8000, 16)", fn = bit16.rshift, inputs = { 0x8000, 16 }, expected = 0 }, + { name = "rshift(0xFF00, 8)", fn = bit16.rshift, inputs = { 0xFF00, 8 }, expected = 0xFF }, + { name = "rshift(0xFFFF, 8)", fn = bit16.rshift, inputs = { 0xFFFF, 8 }, expected = 0xFF }, + + -- arshift tests (arithmetic shift - sign extending) + { name = "arshift(0x8000, 1)", fn = bit16.arshift, inputs = { 0x8000, 1 }, expected = 0xC000 }, + { name = "arshift(0x8000, 15)", fn = bit16.arshift, inputs = { 0x8000, 15 }, expected = 0xFFFF }, + { name = "arshift(0x8000, 16)", fn = bit16.arshift, inputs = { 0x8000, 16 }, expected = 0xFFFF }, + { name = "arshift(0x7FFF, 1)", fn = bit16.arshift, inputs = { 0x7FFF, 1 }, expected = 0x3FFF }, + { name = "arshift(0x7FFF, 15)", fn = bit16.arshift, inputs = { 0x7FFF, 15 }, expected = 0 }, + { name = "arshift(0xFF00, 8)", fn = bit16.arshift, inputs = { 0xFF00, 8 }, expected = 0xFFFF }, + { name = "arshift(0x0F00, 8)", fn = bit16.arshift, inputs = { 0x0F00, 8 }, expected = 0x000F }, + + -- rol tests + { name = "rol(1, 0)", fn = bit16.rol, inputs = { 1, 0 }, expected = 1 }, + { name = "rol(1, 1)", fn = bit16.rol, inputs = { 1, 1 }, expected = 2 }, + { name = "rol(0x8000, 1)", fn = bit16.rol, inputs = { 0x8000, 1 }, expected = 1 }, + { name = "rol(1, 16)", fn = bit16.rol, inputs = { 1, 16 }, expected = 1 }, + { name = "rol(0x1234, 8)", fn = bit16.rol, inputs = { 0x1234, 8 }, expected = 0x3412 }, + { name = "rol(0x1234, 4)", fn = bit16.rol, inputs = { 0x1234, 4 }, expected = 0x2341 }, + + -- ror tests + { name = "ror(1, 0)", fn = bit16.ror, inputs = { 1, 0 }, expected = 1 }, + { name = "ror(1, 1)", fn = bit16.ror, inputs = { 1, 1 }, expected = 0x8000 }, + { name = "ror(2, 1)", fn = bit16.ror, inputs = { 2, 1 }, expected = 1 }, + { name = "ror(1, 16)", fn = bit16.ror, inputs = { 1, 16 }, expected = 1 }, + { name = "ror(0x1234, 8)", fn = bit16.ror, inputs = { 0x1234, 8 }, expected = 0x3412 }, + { name = "ror(0x1234, 4)", fn = bit16.ror, inputs = { 0x1234, 4 }, expected = 0x4123 }, + + -- add tests + { name = "add(0, 0)", fn = bit16.add, inputs = { 0, 0 }, expected = 0 }, + { name = "add(1, 1)", fn = bit16.add, inputs = { 1, 1 }, expected = 2 }, + { name = "add(0xFFFF, 1)", fn = bit16.add, inputs = { 0xFFFF, 1 }, expected = 0 }, + { name = "add(0xFFFF, 2)", fn = bit16.add, inputs = { 0xFFFF, 2 }, expected = 1 }, + { name = "add(0x8000, 0x8000)", fn = bit16.add, inputs = { 0x8000, 0x8000 }, expected = 0 }, + + -- u16_to_be_bytes tests + { name = "u16_to_be_bytes(0)", fn = bit16.u16_to_be_bytes, inputs = { 0 }, expected = string.char(0x00, 0x00) }, + { name = "u16_to_be_bytes(1)", fn = bit16.u16_to_be_bytes, inputs = { 1 }, expected = string.char(0x00, 0x01) }, + { + name = "u16_to_be_bytes(0x1234)", + fn = bit16.u16_to_be_bytes, + inputs = { 0x1234 }, + expected = string.char(0x12, 0x34), + }, + { + name = "u16_to_be_bytes(0xFFFF)", + fn = bit16.u16_to_be_bytes, + inputs = { 0xFFFF }, + expected = string.char(0xFF, 0xFF), + }, + + -- u16_to_le_bytes tests + { name = "u16_to_le_bytes(0)", fn = bit16.u16_to_le_bytes, inputs = { 0 }, expected = string.char(0x00, 0x00) }, + { name = "u16_to_le_bytes(1)", fn = bit16.u16_to_le_bytes, inputs = { 1 }, expected = string.char(0x01, 0x00) }, + { + name = "u16_to_le_bytes(0x1234)", + fn = bit16.u16_to_le_bytes, + inputs = { 0x1234 }, + expected = string.char(0x34, 0x12), + }, + { + name = "u16_to_le_bytes(0xFFFF)", + fn = bit16.u16_to_le_bytes, + inputs = { 0xFFFF }, + expected = string.char(0xFF, 0xFF), + }, + + -- be_bytes_to_u16 tests + { + name = "be_bytes_to_u16(0x0000)", + fn = bit16.be_bytes_to_u16, + inputs = { string.char(0x00, 0x00) }, + expected = 0, + }, + { + name = "be_bytes_to_u16(0x0001)", + fn = bit16.be_bytes_to_u16, + inputs = { string.char(0x00, 0x01) }, + expected = 1, + }, + { + name = "be_bytes_to_u16(0x1234)", + fn = bit16.be_bytes_to_u16, + inputs = { string.char(0x12, 0x34) }, + expected = 0x1234, + }, + { + name = "be_bytes_to_u16(0xFFFF)", + fn = bit16.be_bytes_to_u16, + inputs = { string.char(0xFF, 0xFF) }, + expected = 0xFFFF, + }, + + -- le_bytes_to_u16 tests + { + name = "le_bytes_to_u16(0x0000)", + fn = bit16.le_bytes_to_u16, + inputs = { string.char(0x00, 0x00) }, + expected = 0, + }, + { + name = "le_bytes_to_u16(0x0001)", + fn = bit16.le_bytes_to_u16, + inputs = { string.char(0x01, 0x00) }, + expected = 1, + }, + { + name = "le_bytes_to_u16(0x1234)", + fn = bit16.le_bytes_to_u16, + inputs = { string.char(0x34, 0x12) }, + expected = 0x1234, + }, + { + name = "le_bytes_to_u16(0xFFFF)", + fn = bit16.le_bytes_to_u16, + inputs = { string.char(0xFF, 0xFF) }, + expected = 0xFFFF, + }, + } + + for _, test in ipairs(test_vectors) do + total = total + 1 + local result = test.fn(unpack_fn(test.inputs)) + if result == test.expected then + print(" PASS: " .. test.name) + passed = passed + 1 + else + print(" FAIL: " .. test.name) + if type(test.expected) == "string" then + local exp_hex, got_hex = "", "" + for i = 1, #test.expected do + exp_hex = exp_hex .. string.format("%02X", string.byte(test.expected, i)) + end + for i = 1, #result do + got_hex = got_hex .. string.format("%02X", string.byte(result, i)) + end + print(" Expected: " .. exp_hex) + print(" Got: " .. got_hex) + else + print(string.format(" Expected: 0x%04X", test.expected)) + print(string.format(" Got: 0x%04X", result)) + end + end + end + + print(string.format("\n16-bit operations: %d/%d tests passed\n", passed, total)) + return passed == total +end + +return bit16 diff --git a/src/bitn/bit32.lua b/src/bitn/bit32.lua new file mode 100644 index 0000000..5f3589c --- /dev/null +++ b/src/bitn/bit32.lua @@ -0,0 +1,497 @@ +--- @module "bitn.bit32" +--- Pure Lua 32-bit bitwise operations library. +--- This module provides a complete, version-agnostic implementation of 32-bit +--- bitwise operations that works across Lua 5.1, 5.2, 5.3, 5.4, and LuaJIT +--- without depending on any built-in bit libraries. +--- @class bit32 +local bit32 = {} + +-- 32-bit mask constant +local MASK32 = 0xFFFFFFFF + +--- Ensure value fits in 32-bit unsigned integer. +--- @param n number Input value +--- @return integer result 32-bit unsigned integer (0 to 0xFFFFFFFF) +function bit32.mask(n) + return math.floor(n % 0x100000000) +end + +--- Bitwise AND operation. +--- @param a integer First operand (32-bit) +--- @param b integer Second operand (32-bit) +--- @return integer result Result of a AND b +function bit32.band(a, b) + a = bit32.mask(a) + b = bit32.mask(b) + + local result = 0 + local bit_val = 1 + + for _ = 0, 31 do + if (a % 2 == 1) and (b % 2 == 1) then + result = result + bit_val + end + a = math.floor(a / 2) + b = math.floor(b / 2) + bit_val = bit_val * 2 + + if a == 0 and b == 0 then + break + end + end + + return result +end + +--- Bitwise OR operation. +--- @param a integer First operand (32-bit) +--- @param b integer Second operand (32-bit) +--- @return integer result Result of a OR b +function bit32.bor(a, b) + a = bit32.mask(a) + b = bit32.mask(b) + + local result = 0 + local bit_val = 1 + + for _ = 0, 31 do + if (a % 2 == 1) or (b % 2 == 1) then + result = result + bit_val + end + a = math.floor(a / 2) + b = math.floor(b / 2) + bit_val = bit_val * 2 + + if a == 0 and b == 0 then + break + end + end + + return result +end + +--- Bitwise XOR operation. +--- @param a integer First operand (32-bit) +--- @param b integer Second operand (32-bit) +--- @return integer result Result of a XOR b +function bit32.bxor(a, b) + a = bit32.mask(a) + b = bit32.mask(b) + + local result = 0 + local bit_val = 1 + + for _ = 0, 31 do + if (a % 2) ~= (b % 2) then + result = result + bit_val + end + a = math.floor(a / 2) + b = math.floor(b / 2) + bit_val = bit_val * 2 + + if a == 0 and b == 0 then + break + end + end + + return result +end + +--- Bitwise NOT operation. +--- @param a integer Operand (32-bit) +--- @return integer result Result of NOT a +function bit32.bnot(a) + return bit32.mask(MASK32 - bit32.mask(a)) +end + +--- Left shift operation. +--- @param a integer Value to shift (32-bit) +--- @param n integer Number of positions to shift (must be >= 0) +--- @return integer result Result of a << n +function bit32.lshift(a, n) + assert(n >= 0, "Shift amount must be non-negative") + if n >= 32 then + return 0 + end + return bit32.mask(bit32.mask(a) * math.pow(2, n)) +end + +--- Logical right shift operation (fills with 0s). +--- @param a integer Value to shift (32-bit) +--- @param n integer Number of positions to shift (must be >= 0) +--- @return integer result Result of a >> n (logical) +function bit32.rshift(a, n) + assert(n >= 0, "Shift amount must be non-negative") + a = bit32.mask(a) + if n >= 32 then + return 0 + end + return math.floor(a / math.pow(2, n)) +end + +--- Arithmetic right shift operation (sign-extending, fills with sign bit). +--- @param a integer Value to shift (32-bit, treated as signed) +--- @param n integer Number of positions to shift (must be >= 0) +--- @return integer result Result of a >> n with sign extension +function bit32.arshift(a, n) + assert(n >= 0, "Shift amount must be non-negative") + a = bit32.mask(a) + + -- Check if sign bit is set (bit 31) + local is_negative = a >= 0x80000000 + + if n >= 32 then + -- All bits shift out, result is all 1s if negative, all 0s if positive + return is_negative and 0xFFFFFFFF or 0 + end + + -- Perform logical right shift first + local result = math.floor(a / math.pow(2, n)) + + -- If original was negative, fill high bits with 1s + if is_negative then + -- Create mask for high bits that need to be 1 + local fill_mask = MASK32 - (math.pow(2, 32 - n) - 1) + result = bit32.bor(result, fill_mask) + end + + return result +end + +--- Left rotate operation. +--- @param x integer Value to rotate (32-bit) +--- @param n integer Number of positions to rotate +--- @return integer result Result of rotating x left by n positions +function bit32.rol(x, n) + n = n % 32 + x = bit32.mask(x) + return bit32.mask(bit32.lshift(x, n) + bit32.rshift(x, 32 - n)) +end + +--- Right rotate operation. +--- @param x integer Value to rotate (32-bit) +--- @param n integer Number of positions to rotate +--- @return integer result Result of rotating x right by n positions +function bit32.ror(x, n) + n = n % 32 + x = bit32.mask(x) + return bit32.mask(bit32.rshift(x, n) + bit32.lshift(x, 32 - n)) +end + +--- 32-bit addition with overflow handling. +--- @param a integer First operand (32-bit) +--- @param b integer Second operand (32-bit) +--- @return integer result Result of (a + b) mod 2^32 +function bit32.add(a, b) + return bit32.mask(bit32.mask(a) + bit32.mask(b)) +end + +-------------------------------------------------------------------------------- +-- Byte conversion functions +-------------------------------------------------------------------------------- + +--- Convert 32-bit unsigned integer to 4 bytes (big-endian). +--- @param n integer 32-bit unsigned integer +--- @return string bytes 4-byte string in big-endian order +function bit32.u32_to_be_bytes(n) + n = bit32.mask(n) + return string.char(math.floor(n / 16777216) % 256, math.floor(n / 65536) % 256, math.floor(n / 256) % 256, n % 256) +end + +--- Convert 32-bit unsigned integer to 4 bytes (little-endian). +--- @param n integer 32-bit unsigned integer +--- @return string bytes 4-byte string in little-endian order +function bit32.u32_to_le_bytes(n) + n = bit32.mask(n) + return string.char(n % 256, math.floor(n / 256) % 256, math.floor(n / 65536) % 256, math.floor(n / 16777216) % 256) +end + +--- Convert 4 bytes to 32-bit unsigned integer (big-endian). +--- @param str string Binary string (at least 4 bytes from offset) +--- @param offset? integer Starting position (default: 1) +--- @return integer n 32-bit unsigned integer +function bit32.be_bytes_to_u32(str, offset) + offset = offset or 1 + assert(#str >= offset + 3, "Insufficient bytes for u32") + local b1, b2, b3, b4 = string.byte(str, offset, offset + 3) + return b1 * 16777216 + b2 * 65536 + b3 * 256 + b4 +end + +--- Convert 4 bytes to 32-bit unsigned integer (little-endian). +--- @param str string Binary string (at least 4 bytes from offset) +--- @param offset? integer Starting position (default: 1) +--- @return integer n 32-bit unsigned integer +function bit32.le_bytes_to_u32(str, offset) + offset = offset or 1 + assert(#str >= offset + 3, "Insufficient bytes for u32") + local b1, b2, b3, b4 = string.byte(str, offset, offset + 3) + return b1 + b2 * 256 + b3 * 65536 + b4 * 16777216 +end + +-------------------------------------------------------------------------------- +-- Self-test +-------------------------------------------------------------------------------- + +-- Compatibility for unpack +local unpack_fn = unpack or table.unpack + +--- Run comprehensive self-test with test vectors. +--- @return boolean result True if all tests pass, false otherwise +function bit32.selftest() + print("Running 32-bit operations test vectors...") + local passed = 0 + local total = 0 + + local test_vectors = { + -- mask tests + { name = "mask(0)", fn = bit32.mask, inputs = { 0 }, expected = 0 }, + { name = "mask(1)", fn = bit32.mask, inputs = { 1 }, expected = 1 }, + { name = "mask(0xFFFFFFFF)", fn = bit32.mask, inputs = { 0xFFFFFFFF }, expected = 0xFFFFFFFF }, + { name = "mask(0x100000000)", fn = bit32.mask, inputs = { 0x100000000 }, expected = 0 }, + { name = "mask(0x100000001)", fn = bit32.mask, inputs = { 0x100000001 }, expected = 1 }, + { name = "mask(-1)", fn = bit32.mask, inputs = { -1 }, expected = 0xFFFFFFFF }, + { name = "mask(-256)", fn = bit32.mask, inputs = { -256 }, expected = 0xFFFFFF00 }, + + -- band tests + { name = "band(0xFF00FF00, 0x00FF00FF)", fn = bit32.band, inputs = { 0xFF00FF00, 0x00FF00FF }, expected = 0 }, + { + name = "band(0xFFFFFFFF, 0xFFFFFFFF)", + fn = bit32.band, + inputs = { 0xFFFFFFFF, 0xFFFFFFFF }, + expected = 0xFFFFFFFF, + }, + { name = "band(0xAAAAAAAA, 0x55555555)", fn = bit32.band, inputs = { 0xAAAAAAAA, 0x55555555 }, expected = 0 }, + { + name = "band(0xF0F0F0F0, 0xFF00FF00)", + fn = bit32.band, + inputs = { 0xF0F0F0F0, 0xFF00FF00 }, + expected = 0xF000F000, + }, + { name = "band(0, 0xFFFFFFFF)", fn = bit32.band, inputs = { 0, 0xFFFFFFFF }, expected = 0 }, + + -- bor tests + { + name = "bor(0xFF00FF00, 0x00FF00FF)", + fn = bit32.bor, + inputs = { 0xFF00FF00, 0x00FF00FF }, + expected = 0xFFFFFFFF, + }, + { name = "bor(0, 0)", fn = bit32.bor, inputs = { 0, 0 }, expected = 0 }, + { + name = "bor(0xAAAAAAAA, 0x55555555)", + fn = bit32.bor, + inputs = { 0xAAAAAAAA, 0x55555555 }, + expected = 0xFFFFFFFF, + }, + { + name = "bor(0xF0F0F0F0, 0x0F0F0F0F)", + fn = bit32.bor, + inputs = { 0xF0F0F0F0, 0x0F0F0F0F }, + expected = 0xFFFFFFFF, + }, + + -- bxor tests + { + name = "bxor(0xFF00FF00, 0x00FF00FF)", + fn = bit32.bxor, + inputs = { 0xFF00FF00, 0x00FF00FF }, + expected = 0xFFFFFFFF, + }, + { name = "bxor(0xFFFFFFFF, 0xFFFFFFFF)", fn = bit32.bxor, inputs = { 0xFFFFFFFF, 0xFFFFFFFF }, expected = 0 }, + { + name = "bxor(0xAAAAAAAA, 0x55555555)", + fn = bit32.bxor, + inputs = { 0xAAAAAAAA, 0x55555555 }, + expected = 0xFFFFFFFF, + }, + { name = "bxor(0x12345678, 0x12345678)", fn = bit32.bxor, inputs = { 0x12345678, 0x12345678 }, expected = 0 }, + + -- bnot tests + { name = "bnot(0)", fn = bit32.bnot, inputs = { 0 }, expected = 0xFFFFFFFF }, + { name = "bnot(0xFFFFFFFF)", fn = bit32.bnot, inputs = { 0xFFFFFFFF }, expected = 0 }, + { name = "bnot(0xAAAAAAAA)", fn = bit32.bnot, inputs = { 0xAAAAAAAA }, expected = 0x55555555 }, + { name = "bnot(0x12345678)", fn = bit32.bnot, inputs = { 0x12345678 }, expected = 0xEDCBA987 }, + + -- lshift tests + { name = "lshift(1, 0)", fn = bit32.lshift, inputs = { 1, 0 }, expected = 1 }, + { name = "lshift(1, 1)", fn = bit32.lshift, inputs = { 1, 1 }, expected = 2 }, + { name = "lshift(1, 31)", fn = bit32.lshift, inputs = { 1, 31 }, expected = 0x80000000 }, + { name = "lshift(1, 32)", fn = bit32.lshift, inputs = { 1, 32 }, expected = 0 }, + { name = "lshift(0xFF, 8)", fn = bit32.lshift, inputs = { 0xFF, 8 }, expected = 0xFF00 }, + { name = "lshift(0x80000000, 1)", fn = bit32.lshift, inputs = { 0x80000000, 1 }, expected = 0 }, + + -- rshift tests + { name = "rshift(1, 0)", fn = bit32.rshift, inputs = { 1, 0 }, expected = 1 }, + { name = "rshift(2, 1)", fn = bit32.rshift, inputs = { 2, 1 }, expected = 1 }, + { name = "rshift(0x80000000, 31)", fn = bit32.rshift, inputs = { 0x80000000, 31 }, expected = 1 }, + { name = "rshift(0x80000000, 32)", fn = bit32.rshift, inputs = { 0x80000000, 32 }, expected = 0 }, + { name = "rshift(0xFF00, 8)", fn = bit32.rshift, inputs = { 0xFF00, 8 }, expected = 0xFF }, + { name = "rshift(0xFFFFFFFF, 16)", fn = bit32.rshift, inputs = { 0xFFFFFFFF, 16 }, expected = 0xFFFF }, + + -- arshift tests (arithmetic shift - sign extending) + { name = "arshift(0x80000000, 1)", fn = bit32.arshift, inputs = { 0x80000000, 1 }, expected = 0xC0000000 }, + { name = "arshift(0x80000000, 31)", fn = bit32.arshift, inputs = { 0x80000000, 31 }, expected = 0xFFFFFFFF }, + { name = "arshift(0x80000000, 32)", fn = bit32.arshift, inputs = { 0x80000000, 32 }, expected = 0xFFFFFFFF }, + { name = "arshift(0x7FFFFFFF, 1)", fn = bit32.arshift, inputs = { 0x7FFFFFFF, 1 }, expected = 0x3FFFFFFF }, + { name = "arshift(0x7FFFFFFF, 31)", fn = bit32.arshift, inputs = { 0x7FFFFFFF, 31 }, expected = 0 }, + { name = "arshift(0xFF000000, 8)", fn = bit32.arshift, inputs = { 0xFF000000, 8 }, expected = 0xFFFF0000 }, + { name = "arshift(0x0F000000, 8)", fn = bit32.arshift, inputs = { 0x0F000000, 8 }, expected = 0x000F0000 }, + + -- rol tests + { name = "rol(1, 0)", fn = bit32.rol, inputs = { 1, 0 }, expected = 1 }, + { name = "rol(1, 1)", fn = bit32.rol, inputs = { 1, 1 }, expected = 2 }, + { name = "rol(0x80000000, 1)", fn = bit32.rol, inputs = { 0x80000000, 1 }, expected = 1 }, + { name = "rol(1, 32)", fn = bit32.rol, inputs = { 1, 32 }, expected = 1 }, + { name = "rol(0x12345678, 8)", fn = bit32.rol, inputs = { 0x12345678, 8 }, expected = 0x34567812 }, + { name = "rol(0x12345678, 16)", fn = bit32.rol, inputs = { 0x12345678, 16 }, expected = 0x56781234 }, + + -- ror tests + { name = "ror(1, 0)", fn = bit32.ror, inputs = { 1, 0 }, expected = 1 }, + { name = "ror(1, 1)", fn = bit32.ror, inputs = { 1, 1 }, expected = 0x80000000 }, + { name = "ror(2, 1)", fn = bit32.ror, inputs = { 2, 1 }, expected = 1 }, + { name = "ror(1, 32)", fn = bit32.ror, inputs = { 1, 32 }, expected = 1 }, + { name = "ror(0x12345678, 8)", fn = bit32.ror, inputs = { 0x12345678, 8 }, expected = 0x78123456 }, + { name = "ror(0x12345678, 16)", fn = bit32.ror, inputs = { 0x12345678, 16 }, expected = 0x56781234 }, + + -- add tests + { name = "add(0, 0)", fn = bit32.add, inputs = { 0, 0 }, expected = 0 }, + { name = "add(1, 1)", fn = bit32.add, inputs = { 1, 1 }, expected = 2 }, + { name = "add(0xFFFFFFFF, 1)", fn = bit32.add, inputs = { 0xFFFFFFFF, 1 }, expected = 0 }, + { name = "add(0xFFFFFFFF, 2)", fn = bit32.add, inputs = { 0xFFFFFFFF, 2 }, expected = 1 }, + { name = "add(0x80000000, 0x80000000)", fn = bit32.add, inputs = { 0x80000000, 0x80000000 }, expected = 0 }, + + -- u32_to_be_bytes tests + { + name = "u32_to_be_bytes(0)", + fn = bit32.u32_to_be_bytes, + inputs = { 0 }, + expected = string.char(0x00, 0x00, 0x00, 0x00), + }, + { + name = "u32_to_be_bytes(1)", + fn = bit32.u32_to_be_bytes, + inputs = { 1 }, + expected = string.char(0x00, 0x00, 0x00, 0x01), + }, + { + name = "u32_to_be_bytes(0x12345678)", + fn = bit32.u32_to_be_bytes, + inputs = { 0x12345678 }, + expected = string.char(0x12, 0x34, 0x56, 0x78), + }, + { + name = "u32_to_be_bytes(0xFFFFFFFF)", + fn = bit32.u32_to_be_bytes, + inputs = { 0xFFFFFFFF }, + expected = string.char(0xFF, 0xFF, 0xFF, 0xFF), + }, + + -- u32_to_le_bytes tests + { + name = "u32_to_le_bytes(0)", + fn = bit32.u32_to_le_bytes, + inputs = { 0 }, + expected = string.char(0x00, 0x00, 0x00, 0x00), + }, + { + name = "u32_to_le_bytes(1)", + fn = bit32.u32_to_le_bytes, + inputs = { 1 }, + expected = string.char(0x01, 0x00, 0x00, 0x00), + }, + { + name = "u32_to_le_bytes(0x12345678)", + fn = bit32.u32_to_le_bytes, + inputs = { 0x12345678 }, + expected = string.char(0x78, 0x56, 0x34, 0x12), + }, + { + name = "u32_to_le_bytes(0xFFFFFFFF)", + fn = bit32.u32_to_le_bytes, + inputs = { 0xFFFFFFFF }, + expected = string.char(0xFF, 0xFF, 0xFF, 0xFF), + }, + + -- be_bytes_to_u32 tests + { + name = "be_bytes_to_u32(0x00000000)", + fn = bit32.be_bytes_to_u32, + inputs = { string.char(0x00, 0x00, 0x00, 0x00) }, + expected = 0, + }, + { + name = "be_bytes_to_u32(0x00000001)", + fn = bit32.be_bytes_to_u32, + inputs = { string.char(0x00, 0x00, 0x00, 0x01) }, + expected = 1, + }, + { + name = "be_bytes_to_u32(0x12345678)", + fn = bit32.be_bytes_to_u32, + inputs = { string.char(0x12, 0x34, 0x56, 0x78) }, + expected = 0x12345678, + }, + { + name = "be_bytes_to_u32(0xFFFFFFFF)", + fn = bit32.be_bytes_to_u32, + inputs = { string.char(0xFF, 0xFF, 0xFF, 0xFF) }, + expected = 0xFFFFFFFF, + }, + + -- le_bytes_to_u32 tests + { + name = "le_bytes_to_u32(0x00000000)", + fn = bit32.le_bytes_to_u32, + inputs = { string.char(0x00, 0x00, 0x00, 0x00) }, + expected = 0, + }, + { + name = "le_bytes_to_u32(0x00000001)", + fn = bit32.le_bytes_to_u32, + inputs = { string.char(0x01, 0x00, 0x00, 0x00) }, + expected = 1, + }, + { + name = "le_bytes_to_u32(0x12345678)", + fn = bit32.le_bytes_to_u32, + inputs = { string.char(0x78, 0x56, 0x34, 0x12) }, + expected = 0x12345678, + }, + { + name = "le_bytes_to_u32(0xFFFFFFFF)", + fn = bit32.le_bytes_to_u32, + inputs = { string.char(0xFF, 0xFF, 0xFF, 0xFF) }, + expected = 0xFFFFFFFF, + }, + } + + for _, test in ipairs(test_vectors) do + total = total + 1 + local result = test.fn(unpack_fn(test.inputs)) + if result == test.expected then + print(" PASS: " .. test.name) + passed = passed + 1 + else + print(" FAIL: " .. test.name) + if type(test.expected) == "string" then + local exp_hex, got_hex = "", "" + for i = 1, #test.expected do + exp_hex = exp_hex .. string.format("%02X", string.byte(test.expected, i)) + end + for i = 1, #result do + got_hex = got_hex .. string.format("%02X", string.byte(result, i)) + end + print(" Expected: " .. exp_hex) + print(" Got: " .. got_hex) + else + print(string.format(" Expected: 0x%08X", test.expected)) + print(string.format(" Got: 0x%08X", result)) + end + end + end + + print(string.format("\n32-bit operations: %d/%d tests passed\n", passed, total)) + return passed == total +end + +return bit32 diff --git a/src/bitn/bit64.lua b/src/bitn/bit64.lua new file mode 100644 index 0000000..01d5dc8 --- /dev/null +++ b/src/bitn/bit64.lua @@ -0,0 +1,621 @@ +--- @module "bitn.bit64" +--- Pure Lua 64-bit bitwise operations library. +--- This module provides 64-bit bitwise operations using {high, low} pairs, +--- where high is the upper 32 bits and low is the lower 32 bits. +--- Works across Lua 5.1, 5.2, 5.3, 5.4, and LuaJIT without depending on +--- any built-in bit libraries. +--- @class bit64 +local bit64 = {} + +local bit32 = require("bitn.bit32") + +-- Type definitions +--- @alias Int64HighLow [integer, integer] Array with [1]=high 32 bits, [2]=low 32 bits + +-------------------------------------------------------------------------------- +-- Bitwise operations +-------------------------------------------------------------------------------- + +--- Bitwise AND operation. +--- @param a Int64HighLow First operand {high, low} +--- @param b Int64HighLow Second operand {high, low} +--- @return Int64HighLow result {high, low} AND result +function bit64.band(a, b) + return { + bit32.band(a[1], b[1]), + bit32.band(a[2], b[2]), + } +end + +--- Bitwise OR operation. +--- @param a Int64HighLow First operand {high, low} +--- @param b Int64HighLow Second operand {high, low} +--- @return Int64HighLow result {high, low} OR result +function bit64.bor(a, b) + return { + bit32.bor(a[1], b[1]), + bit32.bor(a[2], b[2]), + } +end + +--- Bitwise XOR operation. +--- @param a Int64HighLow First operand {high, low} +--- @param b Int64HighLow Second operand {high, low} +--- @return Int64HighLow result {high, low} XOR result +function bit64.bxor(a, b) + return { + bit32.bxor(a[1], b[1]), + bit32.bxor(a[2], b[2]), + } +end + +--- Bitwise NOT operation. +--- @param a Int64HighLow Operand {high, low} +--- @return Int64HighLow result {high, low} NOT result +function bit64.bnot(a) + return { + bit32.bnot(a[1]), + bit32.bnot(a[2]), + } +end + +-------------------------------------------------------------------------------- +-- Shift operations +-------------------------------------------------------------------------------- + +--- Left shift operation. +--- @param x Int64HighLow Value to shift {high, low} +--- @param n integer Number of positions to shift (must be >= 0) +--- @return Int64HighLow result {high, low} shifted value +function bit64.lshift(x, n) + if n == 0 then + return { x[1], x[2] } + elseif n >= 64 then + return { 0, 0 } + elseif n >= 32 then + -- Shift by 32 or more: low becomes 0, high gets bits from low + return { bit32.lshift(x[2], n - 32), 0 } + else + -- Shift by less than 32 + local new_high = bit32.bor(bit32.lshift(x[1], n), bit32.rshift(x[2], 32 - n)) + local new_low = bit32.lshift(x[2], n) + return { new_high, new_low } + end +end + +--- Logical right shift operation (fills with 0s). +--- @param x Int64HighLow Value to shift {high, low} +--- @param n integer Number of positions to shift (must be >= 0) +--- @return Int64HighLow result {high, low} shifted value +function bit64.rshift(x, n) + if n == 0 then + return { x[1], x[2] } + elseif n >= 64 then + return { 0, 0 } + elseif n >= 32 then + -- Shift by 32 or more: high becomes 0, low gets bits from high + return { 0, bit32.rshift(x[1], n - 32) } + else + -- Shift by less than 32 + local new_low = bit32.bor(bit32.rshift(x[2], n), bit32.lshift(x[1], 32 - n)) + local new_high = bit32.rshift(x[1], n) + return { new_high, new_low } + end +end + +--- Arithmetic right shift operation (sign-extending, fills with sign bit). +--- @param x Int64HighLow Value to shift {high, low} +--- @param n integer Number of positions to shift (must be >= 0) +--- @return Int64HighLow result {high, low} shifted value +function bit64.arshift(x, n) + if n == 0 then + return { x[1], x[2] } + end + + -- Check sign bit (bit 31 of high word) + local is_negative = bit32.band(x[1], 0x80000000) ~= 0 + + if n >= 64 then + -- All bits shift out, result is all 1s if negative, all 0s if positive + if is_negative then + return { 0xFFFFFFFF, 0xFFFFFFFF } + else + return { 0, 0 } + end + elseif n >= 32 then + -- High word shifts into low, high fills with sign + local new_low = bit32.arshift(x[1], n - 32) + local new_high = is_negative and 0xFFFFFFFF or 0 + return { new_high, new_low } + else + -- Shift by less than 32 + local new_low = bit32.bor(bit32.rshift(x[2], n), bit32.lshift(x[1], 32 - n)) + local new_high = bit32.arshift(x[1], n) + return { new_high, new_low } + end +end + +-------------------------------------------------------------------------------- +-- Rotate operations +-------------------------------------------------------------------------------- + +--- Left rotate operation. +--- @param x Int64HighLow Value to rotate {high, low} +--- @param n integer Number of positions to rotate +--- @return Int64HighLow result {high, low} rotated value +function bit64.rol(x, n) + n = n % 64 + if n == 0 then + return { x[1], x[2] } + end + + local high, low = x[1], x[2] + + if n == 32 then + -- Special case: swap high and low + return { low, high } + elseif n < 32 then + -- Rotate within 32-bit boundaries + local new_high = bit32.bor(bit32.lshift(high, n), bit32.rshift(low, 32 - n)) + local new_low = bit32.bor(bit32.lshift(low, n), bit32.rshift(high, 32 - n)) + return { new_high, new_low } + else + -- n > 32: rotate by (n - 32) after swapping + n = n - 32 + local new_high = bit32.bor(bit32.lshift(low, n), bit32.rshift(high, 32 - n)) + local new_low = bit32.bor(bit32.lshift(high, n), bit32.rshift(low, 32 - n)) + return { new_high, new_low } + end +end + +--- Right rotate operation. +--- @param x Int64HighLow Value to rotate {high, low} +--- @param n integer Number of positions to rotate +--- @return Int64HighLow result {high, low} rotated value +function bit64.ror(x, n) + n = n % 64 + if n == 0 then + return { x[1], x[2] } + end + + local high, low = x[1], x[2] + + if n == 32 then + -- Special case: swap high and low + return { low, high } + elseif n < 32 then + -- Rotate within 32-bit boundaries + local new_low = bit32.bor(bit32.rshift(low, n), bit32.lshift(high, 32 - n)) + local new_high = bit32.bor(bit32.rshift(high, n), bit32.lshift(low, 32 - n)) + return { new_high, new_low } + else + -- n > 32: rotate by (n - 32) after swapping + n = n - 32 + local new_low = bit32.bor(bit32.rshift(high, n), bit32.lshift(low, 32 - n)) + local new_high = bit32.bor(bit32.rshift(low, n), bit32.lshift(high, 32 - n)) + return { new_high, new_low } + end +end + +-------------------------------------------------------------------------------- +-- Arithmetic operations +-------------------------------------------------------------------------------- + +--- 64-bit addition with overflow handling. +--- @param a Int64HighLow First operand {high, low} +--- @param b Int64HighLow Second operand {high, low} +--- @return Int64HighLow result {high, low} sum +function bit64.add(a, b) + local low = a[2] + b[2] + local high = a[1] + b[1] + + -- Handle carry from low to high + if low >= 0x100000000 then + high = high + 1 + low = low % 0x100000000 + end + + -- Keep high within 32 bits + high = high % 0x100000000 + + return { high, low } +end + +-------------------------------------------------------------------------------- +-- Byte conversion functions +-------------------------------------------------------------------------------- + +--- Convert 64-bit value to 8 bytes (big-endian). +--- @param x Int64HighLow 64-bit value {high, low} +--- @return string bytes 8-byte string in big-endian order +function bit64.u64_to_be_bytes(x) + return bit32.u32_to_be_bytes(x[1]) .. bit32.u32_to_be_bytes(x[2]) +end + +--- Convert 64-bit value to 8 bytes (little-endian). +--- @param x Int64HighLow 64-bit value {high, low} +--- @return string bytes 8-byte string in little-endian order +function bit64.u64_to_le_bytes(x) + return bit32.u32_to_le_bytes(x[2]) .. bit32.u32_to_le_bytes(x[1]) +end + +--- Convert 8 bytes to 64-bit value (big-endian). +--- @param str string Binary string (at least 8 bytes from offset) +--- @param offset? integer Starting position (default: 1) +--- @return Int64HighLow value {high, low} 64-bit value +function bit64.be_bytes_to_u64(str, offset) + offset = offset or 1 + assert(#str >= offset + 7, "Insufficient bytes for u64") + local high = bit32.be_bytes_to_u32(str, offset) + local low = bit32.be_bytes_to_u32(str, offset + 4) + return { high, low } +end + +--- Convert 8 bytes to 64-bit value (little-endian). +--- @param str string Binary string (at least 8 bytes from offset) +--- @param offset? integer Starting position (default: 1) +--- @return Int64HighLow value {high, low} 64-bit value +function bit64.le_bytes_to_u64(str, offset) + offset = offset or 1 + assert(#str >= offset + 7, "Insufficient bytes for u64") + local low = bit32.le_bytes_to_u32(str, offset) + local high = bit32.le_bytes_to_u32(str, offset + 4) + return { high, low } +end + +-------------------------------------------------------------------------------- +-- Aliases for compatibility +-------------------------------------------------------------------------------- + +--- Alias for bxor (compatibility with older API). +bit64.xor = bit64.bxor + +--- Alias for rshift (compatibility with older API). +bit64.shr = bit64.rshift + +--- Alias for lshift (compatibility with older API). +bit64.lsl = bit64.lshift + +--- Alias for arshift (compatibility with older API). +bit64.asr = bit64.arshift + +-------------------------------------------------------------------------------- +-- Self-test +-------------------------------------------------------------------------------- + +-- Compatibility for unpack +local unpack_fn = unpack or table.unpack + +--- Compare two 64-bit values (high/low pairs). +--- @param a Int64HighLow First value {high, low} +--- @param b Int64HighLow Second value {high, low} +--- @return boolean equal True if equal +local function eq64(a, b) + return a[1] == b[1] and a[2] == b[2] +end + +--- Format 64-bit value as hex string. +--- @param x Int64HighLow Value {high, low} +--- @return string formatted Hex string +local function fmt64(x) + return string.format("{0x%08X, 0x%08X}", x[1], x[2]) +end + +--- Run comprehensive self-test with test vectors. +--- @return boolean result True if all tests pass, false otherwise +function bit64.selftest() + print("Running 64-bit operations test vectors...") + local passed = 0 + local total = 0 + + local test_vectors = { + -- band tests + { + name = "band({0xFFFFFFFF, 0}, {0, 0xFFFFFFFF})", + fn = bit64.band, + inputs = { { 0xFFFFFFFF, 0 }, { 0, 0xFFFFFFFF } }, + expected = { 0, 0 }, + }, + { + name = "band({0xFFFFFFFF, 0xFFFFFFFF}, {0xFFFFFFFF, 0xFFFFFFFF})", + fn = bit64.band, + inputs = { { 0xFFFFFFFF, 0xFFFFFFFF }, { 0xFFFFFFFF, 0xFFFFFFFF } }, + expected = { 0xFFFFFFFF, 0xFFFFFFFF }, + }, + { + name = "band({0xAAAAAAAA, 0x55555555}, {0x55555555, 0xAAAAAAAA})", + fn = bit64.band, + inputs = { { 0xAAAAAAAA, 0x55555555 }, { 0x55555555, 0xAAAAAAAA } }, + expected = { 0, 0 }, + }, + + -- bor tests + { + name = "bor({0xFFFF0000, 0}, {0, 0x0000FFFF})", + fn = bit64.bor, + inputs = { { 0xFFFF0000, 0 }, { 0, 0x0000FFFF } }, + expected = { 0xFFFF0000, 0x0000FFFF }, + }, + { name = "bor({0, 0}, {0, 0})", fn = bit64.bor, inputs = { { 0, 0 }, { 0, 0 } }, expected = { 0, 0 } }, + { + name = "bor({0xAAAAAAAA, 0x55555555}, {0x55555555, 0xAAAAAAAA})", + fn = bit64.bor, + inputs = { { 0xAAAAAAAA, 0x55555555 }, { 0x55555555, 0xAAAAAAAA } }, + expected = { 0xFFFFFFFF, 0xFFFFFFFF }, + }, + + -- bxor tests + { + name = "bxor({0xFFFFFFFF, 0}, {0, 0xFFFFFFFF})", + fn = bit64.bxor, + inputs = { { 0xFFFFFFFF, 0 }, { 0, 0xFFFFFFFF } }, + expected = { 0xFFFFFFFF, 0xFFFFFFFF }, + }, + { + name = "bxor({0x12345678, 0x9ABCDEF0}, {0x12345678, 0x9ABCDEF0})", + fn = bit64.bxor, + inputs = { { 0x12345678, 0x9ABCDEF0 }, { 0x12345678, 0x9ABCDEF0 } }, + expected = { 0, 0 }, + }, + + -- bnot tests + { name = "bnot({0, 0})", fn = bit64.bnot, inputs = { { 0, 0 } }, expected = { 0xFFFFFFFF, 0xFFFFFFFF } }, + { + name = "bnot({0xFFFFFFFF, 0xFFFFFFFF})", + fn = bit64.bnot, + inputs = { { 0xFFFFFFFF, 0xFFFFFFFF } }, + expected = { 0, 0 }, + }, + { + name = "bnot({0xAAAAAAAA, 0x55555555})", + fn = bit64.bnot, + inputs = { { 0xAAAAAAAA, 0x55555555 } }, + expected = { 0x55555555, 0xAAAAAAAA }, + }, + + -- lshift tests + { name = "lshift({0, 1}, 0)", fn = bit64.lshift, inputs = { { 0, 1 }, 0 }, expected = { 0, 1 } }, + { name = "lshift({0, 1}, 1)", fn = bit64.lshift, inputs = { { 0, 1 }, 1 }, expected = { 0, 2 } }, + { name = "lshift({0, 1}, 32)", fn = bit64.lshift, inputs = { { 0, 1 }, 32 }, expected = { 1, 0 } }, + { name = "lshift({0, 1}, 63)", fn = bit64.lshift, inputs = { { 0, 1 }, 63 }, expected = { 0x80000000, 0 } }, + { name = "lshift({0, 1}, 64)", fn = bit64.lshift, inputs = { { 0, 1 }, 64 }, expected = { 0, 0 } }, + { + name = "lshift({0, 0xFFFFFFFF}, 8)", + fn = bit64.lshift, + inputs = { { 0, 0xFFFFFFFF }, 8 }, + expected = { 0xFF, 0xFFFFFF00 }, + }, + + -- rshift tests + { name = "rshift({0, 1}, 0)", fn = bit64.rshift, inputs = { { 0, 1 }, 0 }, expected = { 0, 1 } }, + { name = "rshift({0, 2}, 1)", fn = bit64.rshift, inputs = { { 0, 2 }, 1 }, expected = { 0, 1 } }, + { name = "rshift({1, 0}, 32)", fn = bit64.rshift, inputs = { { 1, 0 }, 32 }, expected = { 0, 1 } }, + { + name = "rshift({0x80000000, 0}, 63)", + fn = bit64.rshift, + inputs = { { 0x80000000, 0 }, 63 }, + expected = { 0, 1 }, + }, + { name = "rshift({1, 0}, 64)", fn = bit64.rshift, inputs = { { 1, 0 }, 64 }, expected = { 0, 0 } }, + { + name = "rshift({0xFF000000, 0}, 8)", + fn = bit64.rshift, + inputs = { { 0xFF000000, 0 }, 8 }, + expected = { 0x00FF0000, 0 }, + }, + + -- arshift tests (sign-extending) + { + name = "arshift({0x80000000, 0}, 1)", + fn = bit64.arshift, + inputs = { { 0x80000000, 0 }, 1 }, + expected = { 0xC0000000, 0 }, + }, + { + name = "arshift({0x80000000, 0}, 32)", + fn = bit64.arshift, + inputs = { { 0x80000000, 0 }, 32 }, + expected = { 0xFFFFFFFF, 0x80000000 }, + }, + { + name = "arshift({0x80000000, 0}, 63)", + fn = bit64.arshift, + inputs = { { 0x80000000, 0 }, 63 }, + expected = { 0xFFFFFFFF, 0xFFFFFFFF }, + }, + { + name = "arshift({0x80000000, 0}, 64)", + fn = bit64.arshift, + inputs = { { 0x80000000, 0 }, 64 }, + expected = { 0xFFFFFFFF, 0xFFFFFFFF }, + }, + { + name = "arshift({0x7FFFFFFF, 0xFFFFFFFF}, 1)", + fn = bit64.arshift, + inputs = { { 0x7FFFFFFF, 0xFFFFFFFF }, 1 }, + expected = { 0x3FFFFFFF, 0xFFFFFFFF }, + }, + { + name = "arshift({0x7FFFFFFF, 0}, 63)", + fn = bit64.arshift, + inputs = { { 0x7FFFFFFF, 0 }, 63 }, + expected = { 0, 0 }, + }, + + -- rol tests + { name = "rol({0, 1}, 0)", fn = bit64.rol, inputs = { { 0, 1 }, 0 }, expected = { 0, 1 } }, + { name = "rol({0, 1}, 1)", fn = bit64.rol, inputs = { { 0, 1 }, 1 }, expected = { 0, 2 } }, + { name = "rol({0x80000000, 0}, 1)", fn = bit64.rol, inputs = { { 0x80000000, 0 }, 1 }, expected = { 0, 1 } }, + { name = "rol({0, 1}, 32)", fn = bit64.rol, inputs = { { 0, 1 }, 32 }, expected = { 1, 0 } }, + { name = "rol({0, 1}, 64)", fn = bit64.rol, inputs = { { 0, 1 }, 64 }, expected = { 0, 1 } }, + { + name = "rol({0x12345678, 0x9ABCDEF0}, 16)", + fn = bit64.rol, + inputs = { { 0x12345678, 0x9ABCDEF0 }, 16 }, + expected = { 0x56789ABC, 0xDEF01234 }, + }, + + -- ror tests + { name = "ror({0, 1}, 0)", fn = bit64.ror, inputs = { { 0, 1 }, 0 }, expected = { 0, 1 } }, + { name = "ror({0, 1}, 1)", fn = bit64.ror, inputs = { { 0, 1 }, 1 }, expected = { 0x80000000, 0 } }, + { name = "ror({0, 2}, 1)", fn = bit64.ror, inputs = { { 0, 2 }, 1 }, expected = { 0, 1 } }, + { name = "ror({1, 0}, 32)", fn = bit64.ror, inputs = { { 1, 0 }, 32 }, expected = { 0, 1 } }, + { name = "ror({0, 1}, 64)", fn = bit64.ror, inputs = { { 0, 1 }, 64 }, expected = { 0, 1 } }, + { + name = "ror({0x12345678, 0x9ABCDEF0}, 16)", + fn = bit64.ror, + inputs = { { 0x12345678, 0x9ABCDEF0 }, 16 }, + expected = { 0xDEF01234, 0x56789ABC }, + }, + + -- add tests + { name = "add({0, 0}, {0, 0})", fn = bit64.add, inputs = { { 0, 0 }, { 0, 0 } }, expected = { 0, 0 } }, + { name = "add({0, 1}, {0, 1})", fn = bit64.add, inputs = { { 0, 1 }, { 0, 1 } }, expected = { 0, 2 } }, + { + name = "add({0, 0xFFFFFFFF}, {0, 1})", + fn = bit64.add, + inputs = { { 0, 0xFFFFFFFF }, { 0, 1 } }, + expected = { 1, 0 }, + }, + { + name = "add({0xFFFFFFFF, 0xFFFFFFFF}, {0, 1})", + fn = bit64.add, + inputs = { { 0xFFFFFFFF, 0xFFFFFFFF }, { 0, 1 } }, + expected = { 0, 0 }, + }, + { + name = "add({0xFFFFFFFF, 0xFFFFFFFF}, {0, 2})", + fn = bit64.add, + inputs = { { 0xFFFFFFFF, 0xFFFFFFFF }, { 0, 2 } }, + expected = { 0, 1 }, + }, + + -- u64_to_be_bytes tests + { + name = "u64_to_be_bytes({0, 0})", + fn = bit64.u64_to_be_bytes, + inputs = { { 0, 0 } }, + expected = string.char(0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00), + }, + { + name = "u64_to_be_bytes({0, 1})", + fn = bit64.u64_to_be_bytes, + inputs = { { 0, 1 } }, + expected = string.char(0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01), + }, + { + name = "u64_to_be_bytes({0x12345678, 0x9ABCDEF0})", + fn = bit64.u64_to_be_bytes, + inputs = { { 0x12345678, 0x9ABCDEF0 } }, + expected = string.char(0x12, 0x34, 0x56, 0x78, 0x9A, 0xBC, 0xDE, 0xF0), + }, + + -- u64_to_le_bytes tests + { + name = "u64_to_le_bytes({0, 0})", + fn = bit64.u64_to_le_bytes, + inputs = { { 0, 0 } }, + expected = string.char(0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00), + }, + { + name = "u64_to_le_bytes({0, 1})", + fn = bit64.u64_to_le_bytes, + inputs = { { 0, 1 } }, + expected = string.char(0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00), + }, + { + name = "u64_to_le_bytes({0x12345678, 0x9ABCDEF0})", + fn = bit64.u64_to_le_bytes, + inputs = { { 0x12345678, 0x9ABCDEF0 } }, + expected = string.char(0xF0, 0xDE, 0xBC, 0x9A, 0x78, 0x56, 0x34, 0x12), + }, + + -- be_bytes_to_u64 tests + { + name = "be_bytes_to_u64(zeros)", + fn = bit64.be_bytes_to_u64, + inputs = { string.char(0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00) }, + expected = { 0, 0 }, + }, + { + name = "be_bytes_to_u64(one)", + fn = bit64.be_bytes_to_u64, + inputs = { string.char(0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01) }, + expected = { 0, 1 }, + }, + { + name = "be_bytes_to_u64(0x123456789ABCDEF0)", + fn = bit64.be_bytes_to_u64, + inputs = { string.char(0x12, 0x34, 0x56, 0x78, 0x9A, 0xBC, 0xDE, 0xF0) }, + expected = { 0x12345678, 0x9ABCDEF0 }, + }, + + -- le_bytes_to_u64 tests + { + name = "le_bytes_to_u64(zeros)", + fn = bit64.le_bytes_to_u64, + inputs = { string.char(0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00) }, + expected = { 0, 0 }, + }, + { + name = "le_bytes_to_u64(one)", + fn = bit64.le_bytes_to_u64, + inputs = { string.char(0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00) }, + expected = { 0, 1 }, + }, + { + name = "le_bytes_to_u64(0x123456789ABCDEF0)", + fn = bit64.le_bytes_to_u64, + inputs = { string.char(0xF0, 0xDE, 0xBC, 0x9A, 0x78, 0x56, 0x34, 0x12) }, + expected = { 0x12345678, 0x9ABCDEF0 }, + }, + } + + for _, test in ipairs(test_vectors) do + total = total + 1 + local result = test.fn(unpack_fn(test.inputs)) + + if type(test.expected) == "table" then + -- 64-bit comparison + if eq64(result, test.expected) then + print(" PASS: " .. test.name) + passed = passed + 1 + else + print(" FAIL: " .. test.name) + print(" Expected: " .. fmt64(test.expected)) + print(" Got: " .. fmt64(result)) + end + elseif type(test.expected) == "string" then + -- Byte string comparison + if result == test.expected then + print(" PASS: " .. test.name) + passed = passed + 1 + else + local exp_hex, got_hex = "", "" + for i = 1, #test.expected do + exp_hex = exp_hex .. string.format("%02X", string.byte(test.expected, i)) + end + for i = 1, #result do + got_hex = got_hex .. string.format("%02X", string.byte(result, i)) + end + print(" FAIL: " .. test.name) + print(" Expected: " .. exp_hex) + print(" Got: " .. got_hex) + end + else + if result == test.expected then + print(" PASS: " .. test.name) + passed = passed + 1 + else + print(" FAIL: " .. test.name) + print(" Expected: " .. tostring(test.expected)) + print(" Got: " .. tostring(result)) + end + end + end + + print(string.format("\n64-bit operations: %d/%d tests passed\n", passed, total)) + return passed == total +end + +return bit64 diff --git a/src/bitn/init.lua b/src/bitn/init.lua new file mode 100644 index 0000000..254f6cf --- /dev/null +++ b/src/bitn/init.lua @@ -0,0 +1,37 @@ +--- @module "bitn" +--- Pure Lua bitwise operations library. +--- This library provides standalone, version-agnostic implementations of +--- bitwise operations for 16-bit, 32-bit, and 64-bit integers. It works +--- across Lua 5.1, 5.2, 5.3, 5.4, and LuaJIT without depending on any +--- built-in bit libraries. +--- +--- @usage +--- local bitn = require("bitn") +--- print(bitn.version()) +--- +--- -- 32-bit operations +--- local result = bitn.bit32.band(0xFF00, 0x0FF0) -- 0x0F00 +--- +--- -- 64-bit operations (using {high, low} pairs) +--- local sum = bitn.bit64.add({0, 1}, {0, 2}) -- {0, 3} +--- +--- -- 16-bit operations +--- local shifted = bitn.bit16.lshift(1, 8) -- 256 +--- +--- @class bitn +local bitn = { + bit16 = require("bitn.bit16"), + bit32 = require("bitn.bit32"), + bit64 = require("bitn.bit64"), +} + +--- Library version (injected at build time for releases). +local VERSION = "dev" + +--- Get the library version string. +--- @return string version Version string (e.g., "v1.0.0" or "dev") +function bitn.version() + return VERSION +end + +return bitn