BitBuffer::read() - Code Metrics - Inspection of ":octocat: BitBuffer: +read functionality (from ZXi..." - chillerlan/php-qrcode - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — v5 ( 81dcab...700af4 )

by smiley

created 2021-01-22 14:46 UTC

BitBuffer::read() B

↳ Parent: BitBuffer

Complexity

Conditions	10
Paths	16

Size

Total Lines	43
Code Lines	25

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	10
eloc	25
c	1
b	0
f	0
nc	16
nop	1
dl	0
loc	43
rs	7.6666

How to fix Complexity

<?php
/**
 * Class BitBuffer
 *
 * @filesource   BitBuffer.php
 * @created      25.11.2015
 * @package      chillerlan\QRCode\Common
 * @author       Smiley <[email protected]>
 * @copyright    2015 Smiley
 * @license      MIT
 */

namespace chillerlan\QRCode\Common;

use InvalidArgumentException;
use function count, floor;

/**
 * Holds the raw binary data
 */
final class BitBuffer{

	/**
	 * The buffer content
	 *
	 * @var int[]
	 */
	private array $buffer;

	/**
	 * Length of the content (bits)
	 */
	private int $length;

	private int $bytesRead = 0;
	private int $bitsRead  = 0;

	/**
	 * BitBuffer constructor.
	 */
	public function __construct(array $bytes = null){
		$this->buffer = $bytes ?? [];
		$this->length = count($this->buffer);
	}

	/**
	 * clears the buffer
	 */
	public function clear():BitBuffer{
		$this->buffer = [];
		$this->length = 0;

		return $this;
	}

	/**
	 * appends a sequence of bits
	 */
	public function put(int $num, int $length):BitBuffer{

		for($i = 0; $i < $length; $i++){
			$this->putBit((($num >> ($length - $i - 1)) & 1) === 1);
		}

		return $this;
	}

	/**
	 * appends a single bit
	 */
	public function putBit(bool $bit):BitBuffer{
		$bufIndex = (int)floor($this->length / 8);

		if(count($this->buffer) <= $bufIndex){
			$this->buffer[] = 0;
		}

		if($bit === true){
			$this->buffer[$bufIndex] |= (0x80 >> ($this->length % 8));
		}

		$this->length++;

		return $this;
	}

	/**
	 * returns the current buffer length
	 */
	public function getLength():int{
		return $this->length;
	}

	/**
	 * returns the buffer content
	 */
	public function getBuffer():array{
		return $this->buffer;
	}

	/**
	 * @return int number of bits that can be read successfully
	 */
	public function available():int{
		return 8 * ($this->length - $this->bytesRead) - $this->bitsRead;
	}

	/**
	 * @author Sean Owen, ZXing
	 *
	 * @param int $numBits number of bits to read
	 *
	 * @return int representing the bits read. The bits will appear as the least-significant
	 *         bits of the int
	 * @throws InvalidArgumentException if numBits isn't in [1,32] or more than is available
	 */
	public function read(int $numBits):int{

		if($numBits < 1 || $numBits > 32 || $numBits > $this->available()){
			throw new InvalidArgumentException('invalid $numBits: '.$numBits);
		}

		$result = 0;

		// First, read remainder from current byte
		if($this->bitsRead > 0){
			$bitsLeft       = 8 - $this->bitsRead;
			$toRead         = $numBits < $bitsLeft ? $numBits : $bitsLeft;
			$bitsToNotRead  = $bitsLeft - $toRead;
			$mask           = (0xff >> (8 - $toRead)) << $bitsToNotRead;
			$result         = ($this->buffer[$this->bytesRead] & $mask) >> $bitsToNotRead;
			$numBits        -= $toRead;
			$this->bitsRead += $toRead;

			if($this->bitsRead == 8){
				$this->bitsRead = 0;
				$this->bytesRead++;
			}
		}

		// Next read whole bytes
		if($numBits > 0){

			while($numBits >= 8){
				$result = ($result << 8) | ($this->buffer[$this->bytesRead] & 0xff);
				$this->bytesRead++;
				$numBits -= 8;
			}

			// Finally read a partial byte
			if($numBits > 0){
				$bitsToNotRead  = 8 - $numBits;
				$mask           = (0xff >> $bitsToNotRead) << $bitsToNotRead;
				$result         = ($result << $numBits) | (($this->buffer[$this->bytesRead] & $mask) >> $bitsToNotRead);
				$this->bitsRead += $numBits;
			}
		}

		return $result;
	}

}


1			<?php
2			/**
3			* Class BitBuffer
4			*
5			* @filesource BitBuffer.php
6			* @created 25.11.2015
7			* @package chillerlan\QRCode\Common
8			* @author Smiley <[email protected]>
9			* @copyright 2015 Smiley
10			* @license MIT
11			*/
12
13			namespace chillerlan\QRCode\Common;
14
15			use InvalidArgumentException;
16			use function count, floor;
17
18			/**
19			* Holds the raw binary data
20			*/
21			final class BitBuffer{
22
23			/**
24			* The buffer content
25			*
26			* @var int[]
27			*/
28			private array $buffer;
29
30			/**
31			* Length of the content (bits)
32			*/
33			private int $length;
34
35			private int $bytesRead = 0;
36			private int $bitsRead = 0;
37
38			/**
39			* BitBuffer constructor.
40			*/
41			public function __construct(array $bytes = null){
42			$this->buffer = $bytes ?? [];
43			$this->length = count($this->buffer);
44			}
45
46			/**
47			* clears the buffer
48			*/
49			public function clear():BitBuffer{
50			$this->buffer = [];
51			$this->length = 0;
52
53			return $this;
54			}
55
56			/**
57			* appends a sequence of bits
58			*/
59			public function put(int $num, int $length):BitBuffer{
60
61			for($i = 0; $i < $length; $i++){
62			$this->putBit((($num >> ($length - $i - 1)) & 1) === 1);
63			}
64
65			return $this;
66			}
67
68			/**
69			* appends a single bit
70			*/
71			public function putBit(bool $bit):BitBuffer{
72			$bufIndex = (int)floor($this->length / 8);
73
74			if(count($this->buffer) <= $bufIndex){
75			$this->buffer[] = 0;
76			}
77
78			if($bit === true){
79			$this->buffer[$bufIndex] \|= (0x80 >> ($this->length % 8));
80			}
81
82			$this->length++;
83
84			return $this;
85			}
86
87			/**
88			* returns the current buffer length
89			*/
90			public function getLength():int{
91			return $this->length;
92			}
93
94			/**
95			* returns the buffer content
96			*/
97			public function getBuffer():array{
98			return $this->buffer;
99			}
100
101			/**
102			* @return int number of bits that can be read successfully
103			*/
104			public function available():int{
105			return 8 * ($this->length - $this->bytesRead) - $this->bitsRead;
106			}
107
108			/**
109			* @author Sean Owen, ZXing
110			*
111			* @param int $numBits number of bits to read
112			*
113			* @return int representing the bits read. The bits will appear as the least-significant
114			* bits of the int
115			* @throws InvalidArgumentException if numBits isn't in [1,32] or more than is available
116			*/
117			public function read(int $numBits):int{
118
119			if($numBits < 1 \|\| $numBits > 32 \|\| $numBits > $this->available()){
120			throw new InvalidArgumentException('invalid $numBits: '.$numBits);
121			}
122
123			$result = 0;
124
125			// First, read remainder from current byte
126			if($this->bitsRead > 0){
127			$bitsLeft = 8 - $this->bitsRead;
128			$toRead = $numBits < $bitsLeft ? $numBits : $bitsLeft;
129			$bitsToNotRead = $bitsLeft - $toRead;
130			$mask = (0xff >> (8 - $toRead)) << $bitsToNotRead;
131			$result = ($this->buffer[$this->bytesRead] & $mask) >> $bitsToNotRead;
132			$numBits -= $toRead;
133			$this->bitsRead += $toRead;
134
135			if($this->bitsRead == 8){
136			$this->bitsRead = 0;
137			$this->bytesRead++;
138			}
139			}
140
141			// Next read whole bytes
142			if($numBits > 0){
143
144			while($numBits >= 8){
145			$result = ($result << 8) \| ($this->buffer[$this->bytesRead] & 0xff);
146			$this->bytesRead++;
147			$numBits -= 8;
148			}
149
150			// Finally read a partial byte
151			if($numBits > 0){
152			$bitsToNotRead = 8 - $numBits;
153			$mask = (0xff >> $bitsToNotRead) << $bitsToNotRead;
154			$result = ($result << $numBits) \| (($this->buffer[$this->bytesRead] & $mask) >> $bitsToNotRead);
155			$this->bitsRead += $numBits;
156			}
157			}
158
159			return $result;
160			}
161
162			}
163

chillerlan / php-qrcode

Push — v5 ( 81dcab...700af4 )

BitBuffer::read() B

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like