/usr/include/xercesc/internal/XSerializeEngine.hpp is in libxerces-c2-dev 2.8.0+deb1-2build3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 | /*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* $Id: XSerializeEngine.hpp 568078 2007-08-21 11:43:25Z amassari $
*/
#if !defined(XSERIALIZE_ENGINE_HPP)
#define XSERIALIZE_ENGINE_HPP
#include <xercesc/util/RefHashTableOf.hpp>
#include <xercesc/util/ValueVectorOf.hpp>
#include <xercesc/util/XMLExceptMsgs.hpp>
#include <xercesc/internal/XSerializationException.hpp>
XERCES_CPP_NAMESPACE_BEGIN
class XSerializable;
class XProtoType;
class MemoryManager;
class XSerializedObjectId;
class BinOutputStream;
class BinInputStream;
class XMLGrammarPool;
class XMLGrammarPoolImpl;
class XMLStringPool;
class XMLUTIL_EXPORT XSerializeEngine
{
public:
enum { mode_Store
, mode_Load
};
static const bool toReadBufferLen;
typedef unsigned int XSerializedObjectId_t;
/***
*
* Destructor
*
***/
~XSerializeEngine();
/***
*
* Constructor for de-serialization(loading)
*
* Application needs to make sure that the instance of
* BinInputStream, persists beyond the life of this
* SerializeEngine.
*
* Param
* inStream input stream
* gramPool Grammar Pool
* bufSize the size of the internal buffer
*
***/
XSerializeEngine(BinInputStream* inStream
, XMLGrammarPool* const gramPool
, unsigned long bufSize = 8192 );
/***
*
* Constructor for serialization(storing)
*
* Application needs to make sure that the instance of
* BinOutputStream, persists beyond the life of this
* SerializeEngine.
*
* Param
* outStream output stream
* gramPool Grammar Pool
* bufSize the size of the internal buffer
*
***/
XSerializeEngine(BinOutputStream* outStream
, XMLGrammarPool* const gramPool
, unsigned long bufSize = 8192 );
/***
*
* Deprecated
*
* Constructor for de-serialization(loading)
*
* Application needs to make sure that the instance of
* BinInputStream, persists beyond the life of this
* SerializeEngine.
*
* Param
* inStream input stream
* manager MemoryManager
* bufSize the size of the internal buffer
*
***/
XSerializeEngine(BinInputStream* inStream
, MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
, unsigned long bufSize = 8192 );
/***
*
* Deprecated
*
* Constructor for serialization(storing)
*
* Application needs to make sure that the instance of
* BinOutputStream, persists beyond the life of this
* SerializeEngine.
*
* Param
* outStream output stream
* manager MemoryManager
* bufSize the size of the internal buffer
*
***/
XSerializeEngine(BinOutputStream* outStream
, MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
, unsigned long bufSize = 8192 );
/***
*
* When serialization, flush out the internal buffer
*
* Return:
*
***/
void flush();
/***
*
* Checking if the serialize engine is doing serialization(storing)
*
* Return: true, if it is
* false, otherwise
*
***/
inline bool isStoring() const;
/***
*
* Checking if the serialize engine is doing de-serialization(loading)
*
* Return: true, if it is
* false, otherwise
*
***/
inline bool isLoading() const;
/***
*
* Get the GrammarPool
*
* Return: XMLGrammarPool
*
***/
XMLGrammarPool* getGrammarPool() const;
/***
*
* Get the StringPool
*
* Return: XMLStringPool
*
***/
XMLStringPool* getStringPool() const;
/***
*
* Get the embeded Memory Manager
*
* Return: MemoryManager
*
***/
MemoryManager* getMemoryManager() const;
/***
*
* Get the storer level (the level of the serialize engine
* which created the binary stream that this serialize engine
* is loading).
*
* The level returned is meaningful only when
* the engine isLoading.
*
* Return: level
*
***/
inline unsigned short getStorerLevel() const;
/***
*
* Write object to the internal buffer.
*
* Param
* objectToWrite: the object to be serialized
*
* Return:
*
***/
void write(XSerializable* const objectToWrite);
/***
*
* Write prototype info to the internal buffer.
*
* Param
* protoType: instance of prototype
*
* Return:
*
***/
void write(XProtoType* const protoType);
/***
*
* Write a stream of XMLByte to the internal buffer.
*
* Param
* toWrite: the stream of XMLByte to write
* writeLen: the length of the stream
*
* Return:
*
***/
void write(const XMLByte* const toWrite
, int writeLen);
/***
*
* Write a stream of XMLCh to the internal buffer.
*
* Param
* toWrite: the stream of XMLCh to write
* writeLen: the length of the stream
*
* Return:
*
***/
void write(const XMLCh* const toWrite
, int writeLen);
/***
*
* Write a stream of XMLCh to the internal buffer.
*
* Write the bufferLen first if requested, then the length
* of the stream followed by the stream.
*
* Param
* toWrite: the stream of XMLCh to write
* bufferLen: the maximum size of the buffer
* toWriteBufLen: specify if the bufferLen need to be written or not
*
* Return:
*
***/
void writeString(const XMLCh* const toWrite
, const int bufferLen = 0
, bool toWriteBufLen = false);
/***
*
* Write a stream of XMLByte to the internal buffer.
*
* Write the bufferLen first if requested, then the length
* of the stream followed by the stream.
*
* Param
* toWrite: the stream of XMLByte to write
* bufferLen: the maximum size of the buffer
* toWriteBufLen: specify if the bufferLen need to be written or not
*
* Return:
*
***/
void writeString(const XMLByte* const toWrite
, const int bufferLen = 0
, bool toWriteBufLen = false);
static const bool toWriteBufferLen;
/***
*
* Read/Create object from the internal buffer.
*
* Param
* protoType: an instance of prototype of the object anticipated
*
* Return: to object read/created
*
***/
XSerializable* read(XProtoType* const protoType);
/***
*
* Read prototype object from the internal buffer.
* Verify if the same prototype object found in buffer.
*
* Param
* protoType: an instance of prototype of the object anticipated
* objTag: the object Tag to an existing object
*
* Return: true : if matching found
* false : otherwise
*
***/
bool read(XProtoType* const protoType
, XSerializedObjectId_t* objTag);
/***
*
* Read XMLByte stream from the internal buffer.
*
* Param
* toRead: the buffer to hold the XMLByte stream
* readLen: the length of the XMLByte to read in
*
* Return:
*
***/
void read(XMLByte* const toRead
, int readLen);
/***
*
* Read XMLCh stream from the internal buffer.
*
* Param
* toRead: the buffer to hold the XMLCh stream
* readLen: the length of the XMLCh to read in
*
* Return:
*
***/
void read(XMLCh* const toRead
, int readLen);
/***
*
* Read a stream of XMLCh from the internal buffer.
*
* Read the bufferLen first if requested, then the length
* of the stream followed by the stream.
*
* Param
* toRead: the pointer to the buffer to hold the XMLCh stream
* bufferLen: the size of the buffer created
* dataLen: the length of the stream
* toReadBufLen: specify if the bufferLen need to be read or not
*
* Return:
*
***/
void readString(XMLCh*& toRead
, int& bufferLen
, int& dataLen
, bool toReadBufLen = false);
/***
*
* Read a stream of XMLCh from the internal buffer.
*
* Read the bufferLen first if requested, then the length
* of the stream followed by the stream.
*
* Param
* toRead: the pointer to the buffer to hold the XMLCh stream
* bufferLen: the size of the buffer created
*
* Return:
*
***/
inline void readString(XMLCh*& toRead
, int& bufferLen);
/***
*
* Read a stream of XMLCh from the internal buffer.
*
* Param
* toRead: the pointer to the buffer to hold the XMLCh stream
*
* Return:
*
***/
inline void readString(XMLCh*& toRead);
/***
*
* Read a stream of XMLByte from the internal buffer.
*
* Read the bufferLen first if requested, then the length
* of the stream followed by the stream.
*
* Param
* toRead: the pointer to the buffer to hold the XMLByte stream
* bufferLen: the size of the buffer created
* dataLen: the length of the stream
* toReadBufLen: specify if the bufferLen need to be read or not
*
* Return:
*
***/
void readString(XMLByte*& toRead
, int& bufferLen
, int& dataLen
, bool toReadBufLen = false);
/***
*
* Read a stream of XMLByte from the internal buffer.
*
* Read the bufferLen first if requested, then the length
* of the stream followed by the stream.
*
* Param
* toRead: the pointer to the buffer to hold the XMLByte stream
* bufferLen: the size of the buffer created
*
* Return:
*
***/
inline void readString(XMLByte*& toRead
, int& bufferLen);
/***
*
* Read a stream of XMLByte from the internal buffer.
*
* Read the bufferLen first if requested, then the length
* of the stream followed by the stream.
*
* Param
* toRead: the pointer to the buffer to hold the XMLByte stream
* bufferLen: the size of the buffer created
* dataLen: the length of the stream
* toReadBufLen: specify if the bufferLen need to be read or not
*
* Return:
*
***/
inline void readString(XMLByte*& toRead);
/***
*
* Check if the template object has been stored or not
*
* Param
* objectPtr: the template object pointer
*
* Return: true : the object has NOT been stored yet
* false : otherwise
*
***/
bool needToStoreObject(void* const templateObjectToWrite);
/***
*
* Check if the template object has been loaded or not
*
* Param
* objectPtr: the address of the template object pointer
*
* Return: true : the object has NOT been loaded yet
* false : otherwise
*
***/
bool needToLoadObject(void** templateObjectToRead);
/***
*
* In the case of needToLoadObject() return true, the client
* application needs to instantiate an expected template object, and
* register the address to the engine.
*
* Param
* objectPtr: the template object pointer newly instantiated
*
* Return:
*
***/
void registerObject(void* const templateObjectToRegister);
/***
*
* Insertion operator for serializable classes
*
***/
friend XSerializeEngine& operator<<(XSerializeEngine&
, XSerializable* const );
/***
*
* Insertion operators for
* . basic Xerces data types
* . built-in types
*
***/
XSerializeEngine& operator<<(XMLByte);
XSerializeEngine& operator<<(XMLCh);
XSerializeEngine& operator<<(char);
XSerializeEngine& operator<<(short);
XSerializeEngine& operator<<(int);
XSerializeEngine& operator<<(unsigned int);
XSerializeEngine& operator<<(long);
XSerializeEngine& operator<<(unsigned long);
XSerializeEngine& operator<<(float);
XSerializeEngine& operator<<(double);
XSerializeEngine& operator<<(bool);
/***
*
* Extraction operators for
* . basic Xerces data types
* . built-in types
*
***/
XSerializeEngine& operator>>(XMLByte&);
XSerializeEngine& operator>>(XMLCh&);
XSerializeEngine& operator>>(char&);
XSerializeEngine& operator>>(short&);
XSerializeEngine& operator>>(int&);
XSerializeEngine& operator>>(unsigned int&);
XSerializeEngine& operator>>(long&);
XSerializeEngine& operator>>(unsigned long&);
XSerializeEngine& operator>>(float&);
XSerializeEngine& operator>>(double&);
XSerializeEngine& operator>>(bool&);
/***
*
* Getters
*
***/
inline
XMLSize_t getBufSize() const;
inline
XMLSize_t getBufCur() const;
inline
XMLSize_t getBufCurAccumulated() const;
inline
XMLSize_t getBufCount() const;
void trace(char*) const;
private:
// -----------------------------------------------------------------------
// Unimplemented constructors and operators
// -----------------------------------------------------------------------
XSerializeEngine();
XSerializeEngine(const XSerializeEngine&);
XSerializeEngine& operator=(const XSerializeEngine&);
/***
*
* Store Pool Opertions
*
***/
XSerializedObjectId_t lookupStorePool(void* const objectPtr) const;
void addStorePool(void* const objectPtr);
/***
*
* Load Pool Opertions
*
***/
XSerializable* lookupLoadPool(XSerializedObjectId_t objectTag) const;
void addLoadPool(void* const objectPtr);
/***
*
* Intenal Buffer Operations
*
***/
inline void checkAndFillBuffer(int bytesNeedToRead);
inline void checkAndFlushBuffer(int bytesNeedToWrite);
void fillBuffer();
void flushBuffer();
void pumpCount();
inline void resetBuffer();
/***
*
* Helper
*
***/
inline void ensureStoring() const;
inline void ensureLoading() const;
inline void ensureStoreBuffer() const;
inline void ensureLoadBuffer() const;
inline void ensurePointer(void* const) const;
inline void ensureBufferLen(int bufferLen) const;
inline void Assert(bool toEval
, const XMLExcepts::Codes toThrow) const;
inline XMLSize_t calBytesNeeded(XMLSize_t) const;
inline XMLSize_t alignAdjust(XMLSize_t) const;
inline void alignBufCur(XMLSize_t);
// Make XTemplateSerializer friend of XSerializeEngine so that
// we can call lookupStorePool and lookupLoadPool in the case of
// annotations.
friend class XTemplateSerializer;
// -------------------------------------------------------------------------------
// data
//
// fStoreLoad:
// Indicator: storing(serialization) or loading(de-serialization)
//
// fStorerLevel:
// The level of the serialize engine which created the binary
// stream that this serialize engine is loading
//
// It is set by GrammarPool when loading
//
// fGrammarPool:
// Thw owning GrammarPool which instantiate this SerializeEngine
// instance
//
// fInputStream:
// Binary stream to read from (de-serialization), provided
// by client application, not owned.
//
// fOutputStream:
// Binary stream to write to (serialization), provided
// by client application, not owned.
//
// fBufSize:
// The size of the internal buffer
//
// fBufStart/fBufEnd:
//
// The internal buffer.
// fBufEnd:
// one beyond the last valid cell
// fBufEnd === (fBufStart + fBufSize)
//
// fBufCur:
// The cursor of the buffer
//
// fBufLoadMax:
// Indicating the end of the valid content in the buffer
//
// fStorePool:
// Object collection for storing
//
// fLoadPool:
// Object collection for loading
//
// fMapCount:
// -------------------------------------------------------------------------------
const short fStoreLoad;
short fStorerLevel;
XMLGrammarPool* const fGrammarPool;
BinInputStream* const fInputStream;
BinOutputStream* const fOutputStream;
XMLSize_t fBufCount;
//buffer
const XMLSize_t fBufSize;
XMLByte* const fBufStart;
XMLByte* const fBufEnd;
XMLByte* fBufCur;
XMLByte* fBufLoadMax;
/***
* Map for storing object
*
* key: XSerializable*
* XProtoType*
*
* value: XMLInteger*, owned
*
***/
RefHashTableOf<XSerializedObjectId>* fStorePool;
/***
* Vector for loading object, objects are NOT owned
*
* data: XSerializable*
* XProtoType*
*
***/
ValueVectorOf<void*>* fLoadPool;
/***
* object counter
***/
XSerializedObjectId_t fObjectCount;
//to allow grammar pool to set storer level when loading
friend class XMLGrammarPoolImpl;
};
inline bool XSerializeEngine::isStoring() const
{
return (fStoreLoad == mode_Store);
}
inline bool XSerializeEngine::isLoading() const
{
return (fStoreLoad == mode_Load);
}
inline XSerializeEngine& operator<<(XSerializeEngine& serEng
, XSerializable* const serObj)
{
serEng.write(serObj);
return serEng;
}
inline void XSerializeEngine::ensureStoring() const
{
Assert(isStoring(), XMLExcepts::XSer_Storing_Violation);
}
inline void XSerializeEngine::ensureLoading() const
{
Assert(isLoading(), XMLExcepts::XSer_Loading_Violation);
}
inline void XSerializeEngine::Assert(bool toEval
, const XMLExcepts::Codes toThrow) const
{
if (!toEval)
{
ThrowXMLwithMemMgr(XSerializationException, toThrow, getMemoryManager());
}
}
inline void XSerializeEngine::readString(XMLCh*& toRead
, int& bufferLen)
{
int dummyDataLen;
readString(toRead, bufferLen, dummyDataLen);
}
inline void XSerializeEngine::readString(XMLCh*& toRead)
{
int dummyBufferLen;
int dummyDataLen;
readString(toRead, dummyBufferLen, dummyDataLen);
}
inline void XSerializeEngine::readString(XMLByte*& toRead
, int& bufferLen)
{
int dummyDataLen;
readString(toRead, bufferLen, dummyDataLen);
}
inline void XSerializeEngine::readString(XMLByte*& toRead)
{
int dummyBufferLen;
int dummyDataLen;
readString(toRead, dummyBufferLen, dummyDataLen);
}
inline
XMLSize_t XSerializeEngine::getBufSize() const
{
return fBufSize;
}
inline
XMLSize_t XSerializeEngine::getBufCur() const
{
return XMLSize_t (fBufCur-fBufStart);
}
inline
XMLSize_t XSerializeEngine::getBufCurAccumulated() const
{
return (fBufCount - (isStoring() ? 0: 1)) * fBufSize + (fBufCur-fBufStart);
}
inline
XMLSize_t XSerializeEngine::getBufCount() const
{
return fBufCount;
}
inline
unsigned short XSerializeEngine::getStorerLevel() const
{
return fStorerLevel;
}
/***
* Ought to be nested class
***/
class XSerializedObjectId : public XMemory
{
public:
~XSerializedObjectId(){};
private:
inline XSerializedObjectId(XSerializeEngine::XSerializedObjectId_t val):
fData(val) { };
inline XSerializeEngine::XSerializedObjectId_t getValue() const {return fData; };
friend class XSerializeEngine;
private:
// -----------------------------------------------------------------------
// Unimplemented constructors and operators
// -----------------------------------------------------------------------
XSerializedObjectId();
XSerializedObjectId(const XSerializedObjectId&);
XSerializedObjectId& operator=(const XSerializedObjectId&);
XSerializeEngine::XSerializedObjectId_t fData;
};
XERCES_CPP_NAMESPACE_END
#endif
|