*
* @author Roland Haeder <webmaster@ship-simu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
* @license GNU GPL 3.0 or any newer version
* @link http://www.ship-simu.org
*
*/
const INDEX_MAGIC = 'INDEXv0.1';
+ /**
+ * Separator group->hash
+ */
+ const SEPARATOR_GROUP_HASH = 0x01;
+
+ /**
+ * Separator hash->gap position
+ */
+ const SEPARATOR_HASH_GAP_POSITION = 0x02;
+
+ /**
+ * Separator gap position->length
+ */
+ const SEPARATOR_GAP_LENGTH = 0x03;
+
/**
* Protected constructor
*
// Last character must be the separator
//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] data(-1)=%s', __METHOD__, __LINE__, dechex(ord(substr($data, -1, 1)))));
- assert(substr($data, -1, 1) == chr(BaseFile::SEPARATOR_HEADER_ENTRIES));
+ assert(substr($data, -1, 1) == chr(BaseBinaryFile::SEPARATOR_HEADER_ENTRIES));
//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Passed assert().', __METHOD__, __LINE__));
// Okay, then remove it
* 0 => magic
* 1 => total entries
*/
- $header = explode(chr(BaseFile::SEPARATOR_HEADER_DATA), $data);
+ $header = explode(chr(BaseBinaryFile::SEPARATOR_HEADER_DATA), $data);
// Set it here
$this->getIteratorInstance()->setHeader($header);
//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Passed assert().', __METHOD__, __LINE__));
// Check length of count
- assert(strlen($header[1]) == BaseFile::LENGTH_COUNT);
+ assert(strlen($header[1]) == BaseBinaryFile::LENGTH_COUNT);
//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Passed assert().', __METHOD__, __LINE__));
// Decode count
self::INDEX_MAGIC,
// Separator header data
- chr(BaseFile::SEPARATOR_HEADER_DATA),
+ chr(BaseBinaryFile::SEPARATOR_HEADER_DATA),
// Total entries
- str_pad($this->dec2hex($this->getIteratorInstance()->getCounter()), BaseFile::LENGTH_COUNT, '0', STR_PAD_LEFT),
+ str_pad($this->dec2hex($this->getIteratorInstance()->getCounter()), BaseBinaryFile::LENGTH_COUNT, '0', STR_PAD_LEFT),
// Separator header<->entries
- chr(BaseFile::SEPARATOR_HEADER_ENTRIES)
+ chr(BaseBinaryFile::SEPARATOR_HEADER_ENTRIES)
);
// Write it to disk (header is always at seek position 0)
- $this->writeData(0, $header, FALSE);
+ $this->getIteratorInstance()->writeData(0, $header, FALSE);
//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!', __METHOD__, __LINE__));
}
// Calculate header size
$this->getIteratorInstance()->setHeaderSize(
strlen(self::INDEX_MAGIC) +
- strlen(chr(BaseFile::SEPARATOR_HEADER_DATA)) +
- BaseFile::LENGTH_COUNT +
- strlen(chr(BaseFile::SEPARATOR_HEADER_ENTRIES))
+ strlen(chr(BaseBinaryFile::SEPARATOR_HEADER_DATA)) +
+ BaseBinaryFile::LENGTH_COUNT +
+ strlen(chr(BaseBinaryFile::SEPARATOR_HEADER_ENTRIES))
);
// Init counters and gaps array
*/
public function calculateMinimumBlockLength () {
// Calulcate it
- $length = BaseFile::LENGTH_TYPE + strlen(chr(BaseFile::SEPARATOR_TYPE_POSITION)) + BaseFile::LENGTH_POSITION + strlen(chr(BaseFile::SEPARATOR_ENTRIES));
+ $length = BaseBinaryFile::LENGTH_TYPE + strlen(chr(BaseBinaryFile::SEPARATOR_TYPE_POSITION)) + BaseBinaryFile::LENGTH_POSITION + strlen(chr(BaseBinaryFile::SEPARATOR_ENTRIES));
// Return it
return $length;
}
- /**
- * Close a file source and set it's instance to null and the file name
- * to empty.
- *
- * @return void
- * @throws UnsupportedOperationException If this method is called
- */
- public function closeFile () {
- throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
- }
-
/**
* Determines whether the EOF has been reached
*
// Call iterator's method
return $this->getIteratorInstance()->getFileSize();
}
+
+ /**
+ * Writes data at given position
+ *
+ * @param $seekPosition Seek position
+ * @param $data Data to be written
+ * @param $flushHeader Whether to flush the header (default: flush)
+ * @return void
+ * @throws UnsupportedOperationException This method is not (and maybe never will be) supported
+ */
+ public function writeData ($seekPosition, $data, $flushHeader = TRUE) {
+ /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] seekPosition=%s,data[]=%s,flushHeader=%d', __METHOD__, __LINE__, $seekPosition, gettype($data), intval($flushHeader)));
+ throw new UnsupportedOperationException(array($this, __FUNCTION__, $this->getIteratorInstance()->getPointerInstance()), self::EXCEPTION_UNSPPORTED_OPERATION);
+ }
+
+ /**
+ * Writes given value to the file and returns a hash and gap position for it
+ *
+ * @param $groupId Group identifier
+ * @param $value Value to be added to the stack
+ * @return $data Hash and gap position
+ * @throws UnsupportedOperationException If this method is called
+ */
+ public function writeValueToFile ($groupId, $value) {
+ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] groupId=' . $groupId . ',value[' . gettype($value) . ']=' . print_r($value, TRUE));
+ throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
+ }
+
+ /**
+ * Writes given raw data to the file and returns a gap position and length
+ *
+ * @param $groupId Group identifier
+ * @param $hash Hash from encoded value
+ * @param $encoded Encoded value to be written to the file
+ * @return $data Gap position and length of the raw data
+ */
+ public function writeDataToFreeGap ($groupId, $hash, $encoded) {
+ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] groupId=' . $groupId . ',hash=' . $hash . ',encoded()=' . strlen($encoded));
+ throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
+ }
}
// [EOF]
projects / core.git / blobdiff