BinaryStream renamed to BinaryUtils

Author: AtomicScience

javoc/class/accessFlagsLoader.lua

@@ -1,7 +1,7 @@
 local javoc, accessFlagsLoader = require("umfal")("javoc")
 
 local debugPrint = javoc.util.debug.print
-local binaryStream = javoc.util.binaryStream
+local binaryUtils = javoc.util.binaryUtils
 
 local function debugPrintAccessFlag(name, value)
     debugPrint(name .. " - " .. tostring(value))
@@ -12,11 +12,11 @@ function accessFlagsLoader.load(stream)
 
 	local accessFlags = {}
 
-    local allFlagsFromStream = binaryStream.readU2(stream)
+    local allFlagsFromStream = binaryUtils.readU2(stream)
     debugPrint("Access flags mask: " .. string.format("0x%x", allFlagsFromStream))
 
     for flagName, flagMask in pairs(javoc.class.values.accessFlagsMasks) do
-        local flagValue = binaryStream.mask(allFlagsFromStream, flagMask)
+        local flagValue = binaryUtils.mask(allFlagsFromStream, flagMask)
 
         accessFlags[flagName] = flagValue
 

javoc/class/classLoader.lua

@@ -1,7 +1,7 @@
 local javoc, classLoader = require("umfal")("javoc")
 
 local debugPrint = javoc.util.debug.print
-local binaryStream = javoc.util.binaryStream
+local binaryUtils = javoc.util.binaryUtils
 ---Loads a class from a file. Path is relative from classpath
 ---@param file string           @ Name of the class to load
 ---@param classpath string      @ Absolute path to the classes to load
@@ -50,7 +50,7 @@ end
 
 function classLoader.checkMagicValue(stream)
 	debugPrint("Loading 'magic value' (0xCAFEBABE)")
-	local magicValue = binaryStream.readU4(stream)
+	local magicValue = binaryUtils.readU4(stream)
 
 	return (magicValue == 0xCAFEBABE)
 end
@@ -59,8 +59,8 @@ function classLoader.loadVersion(stream)
 	debugPrint("Loading versions (major and minor)")
 	local version = {}
 
-	version.minor = binaryStream.readU2(stream)
-	version.major = binaryStream.readU2(stream)
+	version.minor = binaryUtils.readU2(stream)
+	version.major = binaryUtils.readU2(stream)
 
 	debugPrint("Versions loaded successfully!")
 	debugPrint("Major - " .. version.major .. "; Minor - " .. version.minor)
@@ -72,8 +72,8 @@ function classLoader.loadClassNames(stream, constantPool)
 	local thisClass  = {}
 	local superClass = {}
 
-	thisClass.index  = binaryStream.readU2(stream)
-	superClass.index = binaryStream.readU2(stream)
+	thisClass.index  = binaryUtils.readU2(stream)
+	superClass.index = binaryUtils.readU2(stream)
 
 	-- Both 'thisClassIndex' and 'superClassIndex' point at
 	-- the CONSTANT_Class, which points at the CONSTANT_Utf8,

javoc/class/constantPoolLoader.lua

@@ -1,20 +1,20 @@
 local javoc, constantPoolLoader = require("umfal")("javoc")
 
 local debugPrint = javoc.util.debug.print
-local binaryStream = javoc.util.binaryStream
+local binaryUtils = javoc.util.binaryUtils
 
 function constantPoolLoader.load(stream)
 	debugPrint("Loading constant pool")
 
 	local constantPool = {}
-	constantPool.size = binaryStream.readU2(stream)
+	constantPool.size = binaryUtils.readU2(stream)
 	debugPrint("Size of the constant pool - " .. constantPool.size)
 
 	local currentIndex = 1
 
 	debugPrint("Constants in the pool:")
 	while currentIndex < constantPool.size do
-		local tag = binaryStream.readU1(stream)
+		local tag = binaryUtils.readU1(stream)
 		debugPrint("Constant #" .. currentIndex .. " with tag " .. tag)
 		-- Since Double and Long constants occuppy two indexes in the
 		-- constant pool, they will return not one constant, but two:

javoc/class/handlers/constantPool.lua

@@ -2,7 +2,7 @@ local javoc = require("umfal")("javoc")
 
 local constantPoolHandler = javoc.util.handlerFactory.getEmptyHandler()
 local debugPrint = javoc.util.debug.print
-local binaryStream = javoc.util.binaryStream
+local binaryUtils = javoc.util.binaryUtils
 
 local bit32 = require("bit32")
 
@@ -17,11 +17,11 @@ constantPoolHandler[1] = function(stream)
 	constant.type  = "Utf8"
 	constant.value = ""
 
-	local length = binaryStream.readU2(stream)
+	local length = binaryUtils.readU2(stream)
 
 	-- TODO: Implement proper UTF8 loading
 	for i = 1, length do
-		constant.value = constant.value .. string.char(binaryStream.readU1(stream))
+		constant.value = constant.value .. string.char(binaryUtils.readU1(stream))
 	end
 
 	debugPrint("Utf8 constant.")
@@ -39,7 +39,7 @@ end
 constantPoolHandler[3] = function(stream)
 	local constant = {}
 	constant.type  = "Integer"
-	constant.value = binaryStream.readU4(stream)
+	constant.value = binaryUtils.readU4(stream)
 
 	debugPrint("Integer constant.")
 	debugPrint("Value - " .. constant.value)
@@ -76,8 +76,8 @@ constantPoolHandler[5] = function(stream)
 	local constant = {}
 	constant.type  = "Long"
 
-	local highBytes = binaryStream.readU4(stream)
-	local lowBytes  = binaryStream.readU4(stream)
+	local highBytes = binaryUtils.readU4(stream)
+	local lowBytes  = binaryUtils.readU4(stream)
 
 	-- value = (highBytes << 32) + lowBytes
 	constant.value = bit32.lshift(highBytes, 32) + lowBytes
@@ -123,7 +123,7 @@ constantPoolHandler[7] = function(stream)
 	local constant = {}
 	constant.type  = "Class"
 
-	constant.nameIndex = binaryStream.readU2(stream)
+	constant.nameIndex = binaryUtils.readU2(stream)
 
 	debugPrint("Class constant.")
 	debugPrint("Name index - " .. constant.nameIndex)
@@ -140,7 +140,7 @@ constantPoolHandler[8] = function(stream)
 	local constant = {}
 	constant.type  = "String"
 
-	constant.stringIndex = binaryStream.readU2(stream)
+	constant.stringIndex = binaryUtils.readU2(stream)
 
 	debugPrint("String constant.")
 	debugPrint("Utf8 index - " .. constant.stringIndex)
@@ -158,8 +158,8 @@ constantPoolHandler[9] = function(stream)
 	local constant = {}
 	constant.type  = "Fieldref"
 
-	constant.classIndex       = binaryStream.readU2(stream)
-	constant.nameAndTypeIndex = binaryStream.readU2(stream)
+	constant.classIndex       = binaryUtils.readU2(stream)
+	constant.nameAndTypeIndex = binaryUtils.readU2(stream)
 
 	debugPrint("Fieldref constant")
 	debugPrint("Class index         - " .. constant.classIndex)
@@ -178,8 +178,8 @@ constantPoolHandler[10] = function(stream)
 	local constant = {}
 	constant.type  = "Methodref"
 
-	constant.classIndex       = binaryStream.readU2(stream)
-	constant.nameAndTypeIndex = binaryStream.readU2(stream)
+	constant.classIndex       = binaryUtils.readU2(stream)
+	constant.nameAndTypeIndex = binaryUtils.readU2(stream)
 
 	debugPrint("Methodref constant")
 	debugPrint("Class index         - " .. constant.classIndex)
@@ -198,8 +198,8 @@ constantPoolHandler[11] = function(stream)
 	local constant = {}
 	constant.type  = "InterfaceMethodref"
 
-	constant.classIndex       = binaryStream.readU2(stream)
-	constant.nameAndTypeIndex = binaryStream.readU2(stream)
+	constant.classIndex       = binaryUtils.readU2(stream)
+	constant.nameAndTypeIndex = binaryUtils.readU2(stream)
 
 	debugPrint("InterfaceMethodref constant")
 	debugPrint("Class index         - " .. constant.classIndex)
@@ -218,8 +218,8 @@ constantPoolHandler[12] = function(stream)
 	local constant = {}
 	constant.type  = "NameAndType"
 
-	constant.nameIndex        = binaryStream.readU2(stream)
-	constant.descriptorIndex  = binaryStream.readU2(stream)
+	constant.nameIndex        = binaryUtils.readU2(stream)
+	constant.descriptorIndex  = binaryUtils.readU2(stream)
 
 	debugPrint("NameAndType constant")
 	debugPrint("Name index       - " .. constant.nameIndex)

javoc/util/binaryStream.lua renamed to javoc/util/binaryUtils.lua

@@ -1,37 +1,37 @@
 local bit32 = require("bit32")
 
 -- TODO: Rename to binaryUtils
-local binaryStream = {}
+local binaryUtils = {}
 
 ---Loads a one-byte (8 bit) unsigned integer from the stream
 ---@param stream file_stream    @ Stream to load integer from
 ---@return number int           @ Integer loaded
-function binaryStream.readU1(stream)
+function binaryUtils.readU1(stream)
 	return string.byte(stream:read(1))
 end
 
 ---Loads a two-byte (16 bit) unsigned integer from the stream
 ---@param stream file_stream    @ Stream to load integer from
 ---@return number int           @ Integer loaded
-function binaryStream.readU2(stream)
+function binaryUtils.readU2(stream)
 	-- u2() = (u1() << 8) + u1()
-	return bit32.lshift(binaryStream.readU1(stream), 8) + binaryStream.readU1(stream)
+	return bit32.lshift(binaryUtils.readU1(stream), 8) + binaryUtils.readU1(stream)
 end
 
 ---Loads a four-byte (32 bit) unsigned integer from the stream
 ---@param stream file_stream    @ Stream to load integer from
 ---@return number int           @ Integer loaded
-function binaryStream.readU4(stream)
+function binaryUtils.readU4(stream)
 	-- u4() = (u2() << 16) + u2()
-	return bit32.lshift(binaryStream.readU2(stream), 16) + binaryStream.readU2(stream)
+	return bit32.lshift(binaryUtils.readU2(stream), 16) + binaryUtils.readU2(stream)
 end
 
 ---Checks if bit in maskedValue is 1 under mask
 ---@param maskedValue number   @ Value to apply mask to
 ---@param mask number          @ Mask to apply
 ---@return boolean isSet       @ If bit under mask or not
-function binaryStream.mask(maskedValue, mask)
+function binaryUtils.mask(maskedValue, mask)
 	return (bit32.band(maskedValue, mask) == mask)
 end
 
-return binaryStream
+return binaryUtils