├── .gitignore ├── gleam.toml ├── .github └── workflows │ └── test.yml ├── README.md ├── CHANGELOG.md ├── manifest.toml ├── src ├── gleam_bitwise.mjs └── gleam │ └── bitwise.gleam ├── test └── gleam_bitwise_test.gleam └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | *.beam 2 | *.iml 3 | *.o 4 | *.plt 5 | *.swo 6 | *.swp 7 | *~ 8 | .erlang.cookie 9 | .eunit 10 | .idea 11 | .rebar 12 | .rebar3 13 | ebin 14 | erl_crash.dump 15 | build 16 | -------------------------------------------------------------------------------- /gleam.toml: -------------------------------------------------------------------------------- 1 | name = "gleam_bitwise" 2 | version = "1.3.1" 3 | licences = ["Apache-2.0"] 4 | description = "Bitwise operations on integers" 5 | 6 | repository = { type = "github", user = "gleam-lang", repo = "bitwise" } 7 | links = [ 8 | { title = "Website", href = "https://gleam.run" }, 9 | { title = "Sponsor", href = "https://github.com/sponsors/lpil" }, 10 | ] 11 | 12 | [dependencies] 13 | 14 | [dev-dependencies] 15 | gleeunit = "~> 0.6" 16 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: test 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | pull_request: 8 | 9 | jobs: 10 | test: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: actions/checkout@v3 14 | - uses: erlef/setup-beam@v1 15 | with: 16 | otp-version: "26.1" 17 | gleam-version: "0.32.2" 18 | - run: gleam test --target erlang 19 | - run: gleam test --target javascript 20 | - run: gleam format --check src test 21 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # bitwise 2 | 3 | [![Package Version](https://img.shields.io/hexpm/v/gleam_bitwise)](https://hex.pm/packages/gleam_bitwise) 4 | [![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/gleam_bitwise/) 5 | 6 | 🍓 Bitwise operations on integers. 7 | 8 | This library works with Gleam running on Erlang or JavaScript. 9 | 10 | ## Usage 11 | 12 | Add `gleam_bitwise` to your Gleam project. 13 | 14 | ```sh 15 | gleam add gleam_bitwise 16 | ``` 17 | 18 | Documentation can be found at . 19 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | ## v1.3.1 - 2023-11-06 4 | 5 | - Deprecated in favour of the bitwise operations in the standard library. 6 | 7 | ## v1.3.0 - 2023-08-24 8 | 9 | - Updated for Gleam v0.30.0. 10 | - This package no longer depends on the standard library. 11 | 12 | ## v1.2.0 - 2022-05-29 13 | 14 | - Make the library compatible with the JavaScript target 15 | 16 | ## v1.1.0 - 2021-11-27 17 | 18 | - Converted to use the Gleam build tool. 19 | 20 | ## v1.0.1 - 2020-06-08 21 | 22 | - Updated for Gleam v0.9.0. 23 | 24 | ## v1.0.0 - 2019-12-17 25 | 26 | - Initial release. 27 | -------------------------------------------------------------------------------- /manifest.toml: -------------------------------------------------------------------------------- 1 | # This file was generated by Gleam 2 | # You typically do not need to edit this file 3 | 4 | packages = [ 5 | { name = "gleam_stdlib", version = "0.32.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "07D64C26D014CF570F8ACADCE602761EA2E74C842D26F2FD49B0D61973D9966F" }, 6 | { name = "gleeunit", version = "0.11.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleeunit", source = "hex", outer_checksum = "1397E5C4AC4108769EE979939AC39BF7870659C5AFB714630DEEEE16B8272AD5" }, 7 | ] 8 | 9 | [requirements] 10 | gleeunit = { version = "~> 0.6" } 11 | -------------------------------------------------------------------------------- /src/gleam_bitwise.mjs: -------------------------------------------------------------------------------- 1 | // In Javascript bitwise operations convert numbers to a sequence of 32 bits 2 | // while Erlang uses arbitrary precision. 3 | // To get around this problem and get consistent results use BigInt and then 4 | // downcast the value back to a Number value. 5 | 6 | export function and(x, y) { 7 | return Number(BigInt(x) & BigInt(y)); 8 | } 9 | 10 | export function not(x) { 11 | return Number(~BigInt(x)); 12 | } 13 | 14 | export function or(x, y) { 15 | return Number(BigInt(x) | BigInt(y)); 16 | } 17 | 18 | export function exclusive_or(x, y) { 19 | return Number(BigInt(x) ^ BigInt(y)); 20 | } 21 | 22 | export function shift_left(x, y) { 23 | return Number(BigInt(x) << BigInt(y)); 24 | } 25 | 26 | export function shift_right(x, y) { 27 | return Number(BigInt(x) >> BigInt(y)); 28 | } 29 | -------------------------------------------------------------------------------- /test/gleam_bitwise_test.gleam: -------------------------------------------------------------------------------- 1 | import gleam/bitwise 2 | import gleeunit/should 3 | import gleeunit 4 | 5 | pub fn main() { 6 | gleeunit.main() 7 | } 8 | 9 | pub fn and_test() { 10 | bitwise.and(9, 3) 11 | |> should.equal(1) 12 | 13 | // To check compatibility with JavaScript, try a 32 bit unsigned integer 14 | // (signed integers are in the range -2147483648 to +2147483647, while 15 | // 32 bit unsigned integers are in the range 0 to +4294967295). 16 | bitwise.and(2_147_483_648, 2_147_483_648) 17 | |> should.equal(2_147_483_648) 18 | } 19 | 20 | pub fn not_test() { 21 | bitwise.not(2) 22 | |> should.equal(-3) 23 | 24 | // To check compatibility with JavaScript, try a 32 bit unsigned integer. 25 | bitwise.not(2_147_483_648) 26 | |> should.equal(-2_147_483_649) 27 | } 28 | 29 | pub fn or_test() { 30 | bitwise.or(9, 3) 31 | |> should.equal(11) 32 | 33 | // To check compatibility with JavaScript, try a 32 bit unsigned integer. 34 | bitwise.or(1, 2_147_483_648) 35 | |> should.equal(2_147_483_649) 36 | } 37 | 38 | pub fn exclusive_or_test() { 39 | bitwise.exclusive_or(9, 3) 40 | |> should.equal(10) 41 | 42 | // To check compatibility with JavaScript, try a 32 bit unsigned integer. 43 | bitwise.exclusive_or(0, 2_147_483_648) 44 | |> should.equal(2_147_483_648) 45 | } 46 | 47 | pub fn shift_left_test() { 48 | bitwise.shift_left(1, 2) 49 | |> should.equal(4) 50 | 51 | bitwise.shift_left(1, -2) 52 | |> should.equal(0) 53 | 54 | bitwise.shift_left(-1, 2) 55 | |> should.equal(-4) 56 | 57 | bitwise.shift_left(-1, -2) 58 | |> should.equal(-1) 59 | } 60 | 61 | pub fn shift_right_test() { 62 | bitwise.shift_right(1, 2) 63 | |> should.equal(0) 64 | 65 | bitwise.shift_right(1, -2) 66 | |> should.equal(4) 67 | 68 | bitwise.shift_right(-1, 2) 69 | |> should.equal(-1) 70 | 71 | bitwise.shift_right(-1, -2) 72 | |> should.equal(-4) 73 | } 74 | -------------------------------------------------------------------------------- /src/gleam/bitwise.gleam: -------------------------------------------------------------------------------- 1 | //// A set of functions for bitwise operations on integers. 2 | 3 | /// Calculates the bitwise AND of its arguments. 4 | @deprecated("Please use the bitwise functions in gleam/int") 5 | pub fn and(x: Int, y: Int) -> Int { 6 | do_and(x, y) 7 | } 8 | 9 | @external(erlang, "erlang", "band") 10 | @external(javascript, "../gleam_bitwise.mjs", "and") 11 | fn do_and(a: Int, b: Int) -> Int 12 | 13 | /// Calculates the bitwise NOT of its argument. 14 | @deprecated("Please use the bitwise functions in gleam/int") 15 | pub fn not(x: Int) -> Int { 16 | do_not(x) 17 | } 18 | 19 | @external(erlang, "erlang", "bnot") 20 | @external(javascript, "../gleam_bitwise.mjs", "not") 21 | fn do_not(a: Int) -> Int 22 | 23 | /// Calculates the bitwise OR of its arguments. 24 | @deprecated("Please use the bitwise functions in gleam/int") 25 | pub fn or(x: Int, y: Int) -> Int { 26 | do_or(x, y) 27 | } 28 | 29 | @external(erlang, "erlang", "bor") 30 | @external(javascript, "../gleam_bitwise.mjs", "or") 31 | fn do_or(a: Int, b: Int) -> Int 32 | 33 | /// Calculates the bitwise XOR of its arguments. 34 | @deprecated("Please use the bitwise functions in gleam/int") 35 | pub fn exclusive_or(x: Int, y: Int) -> Int { 36 | do_exclusive_or(x, y) 37 | } 38 | 39 | @external(erlang, "erlang", "bxor") 40 | @external(javascript, "../gleam_bitwise.mjs", "exclusive_or") 41 | fn do_exclusive_or(a: Int, b: Int) -> Int 42 | 43 | /// Calculates the result of an arithmetic left bitshift. 44 | @deprecated("Please use the bitwise functions in gleam/int") 45 | pub fn shift_left(x: Int, y: Int) -> Int { 46 | do_shift_left(x, y) 47 | } 48 | 49 | @external(erlang, "erlang", "bsl") 50 | @external(javascript, "../gleam_bitwise.mjs", "shift_left") 51 | fn do_shift_left(a: Int, b: Int) -> Int 52 | 53 | /// Calculates the result of an arithmetic right bitshift. 54 | @deprecated("Please use the bitwise functions in gleam/int") 55 | pub fn shift_right(x: Int, y: Int) -> Int { 56 | do_shift_right(x, y) 57 | } 58 | 59 | @external(erlang, "erlang", "bsr") 60 | @external(javascript, "../gleam_bitwise.mjs", "shift_right") 61 | fn do_shift_right(a: Int, b: Int) -> Int 62 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | Copyright {{copyright_year}}, {{author_name}} <{{author_email}}>. 179 | 180 | Licensed under the Apache License, Version 2.0 (the "License"); 181 | you may not use this file except in compliance with the License. 182 | You may obtain a copy of the License at 183 | 184 | http://www.apache.org/licenses/LICENSE-2.0 185 | 186 | Unless required by applicable law or agreed to in writing, software 187 | distributed under the License is distributed on an "AS IS" BASIS, 188 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 189 | See the License for the specific language governing permissions and 190 | limitations under the License. 191 | 192 | --------------------------------------------------------------------------------