Initial commit

Author: luk3skyw4lker

.gitignore

@@ -0,0 +1 @@
+node_modules

.npmignore

@@ -0,0 +1,4 @@
+__tests__
+node_modules
+jest.config.jest
+README.md

README.md

@@ -0,0 +1,74 @@
+# bit-macros
+
+This is a set of C macros used in embedded systems development for bit level operations. You can use them to directly manipulate the bit values on a integer variable.
+
+It contains 4 fundamental macros:
+
+- set_bit: used to set the value of a bit from 0 to 1;
+- tst_bit: used to check if a bit inside a set of bits is equal to 1;
+- clr_bit: used to set the value of a bit from 1 to 0;
+- cpl_bit: used to toggle the bit value (from 0 to 1 or from 1 to 0);
+
+## set_bit
+
+```javascript
+const { set_bit } = require("bit-macros");
+
+const integer_monday = set_bit(0, 1);
+const integer_tuesday = set_bit(0, 2);
+
+console.log(integer_monday); // 2
+console.log(integer_tuesday): // 4
+
+const monday_and_tuesday = integer_monday + integer_tuesday;
+
+console.log(monday_and_tuesday); // 6
+```
+
+## tst_bit
+
+```javascript
+const { tst_bit } = require("bit-macros");
+
+const value = 2;
+
+// The bit count starts from 0, so 1 means the second bit in the sequence
+if (tst_bit(value, 1)) {
+	// Should be truthy since 2 in bit sequence is 00000010
+	console.log("The variable has the second bit enabled");
+} else {
+	console.log("The variable doesn't have the second bit enabled");
+}
+```
+
+## clr_bit
+
+```javascript
+const { clr_bit } = require("bit-macros");
+
+const value = 255;
+
+const cleared_value = clr_bit(value, 0);
+
+console.log(cleared_value); // 254;
+```
+
+## cpl_bit
+
+```javascript
+const { cpl_bit } = require("bit-macros");
+
+const value = 255;
+
+const coupled_value = cpl_bit(value, 7);
+
+console.log(coupled_value); // 127
+
+const coupled_value2 = cpl_bit(coupled_value, 7);
+
+console.log(coupled_value2); // 255
+```
+
+# TODO
+
+[] Add set/tst/clr/cpl many bits

__tests__/index.spec.js

@@ -0,0 +1,34 @@
+const { set_bit, tst_bit, clr_bit, cpl_bit } = require("../src/index");
+
+test("set_bit success", () => {
+	let value = 0;
+
+	for (let i = 0; i < 8; i++) {
+		value = set_bit(value, i);
+	}
+
+	expect(value).toEqual(255);
+});
+
+test("tst_bit success", () => {
+	const value = 2;
+
+	expect(tst_bit(value, 1)).toEqual(true);
+});
+
+test("clr_bit success", () => {
+	let final = 255;
+
+	for (let i = 0; i < 8; i++) {
+		final = clr_bit(final, i);
+	}
+
+	expect(final).toEqual(0);
+});
+
+test("cpl_bit", () => {
+	const value = 255;
+	const coupled_value = cpl_bit(value, 7);
+
+	expect(coupled_value).toEqual(127);
+});

jest.config.js

@@ -0,0 +1,192 @@
+// For a detailed explanation regarding each configuration property, visit:
+// https://jestjs.io/docs/en/configuration.html
+
+module.exports = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/tmp/jest_rs",
+
+  // Automatically clear mock calls and instances between every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  // collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: "coverage",
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  // coverageProvider: "babel",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "json",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state between every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state between every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: "node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jasmine2",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};

package.json

@@ -0,0 +1,15 @@
+{
+	"name": "bit-macros",
+	"version": "1.0.1",
+	"main": "src/index.js",
+	"repository": {
+		"url": "https://github.com/luk3skyw4lker/bit-macros"
+	},
+	"license": "MIT",
+	"devDependencies": {
+		"jest": "^26.4.0"
+	},
+	"scripts": {
+		"test": "jest"
+	}
+}

src/index.js

@@ -0,0 +1,14 @@
+module.exports = {
+	set_bit(value, bit) {
+		return value | (1 << bit);
+	},
+	tst_bit(value, bit) {
+		return (value & (1 << bit)) === value;
+	},
+	clr_bit(value, bit) {
+		return value & ~(1 << bit);
+	},
+	cpl_bit(value, bit) {
+		return value ^ (1 << bit);
+	}
+};