/usr/include/Ice/OutputStream.h is in libzeroc-ice-dev 3.7.0-5.
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 | // **********************************************************************
//
// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
//
// This copy of Ice is licensed to you under the terms described in the
// ICE_LICENSE file included in this distribution.
//
// **********************************************************************
#ifndef ICE_OUTPUT_STREAM_H
#define ICE_OUTPUT_STREAM_H
#include <Ice/CommunicatorF.h>
#include <Ice/InstanceF.h>
#include <Ice/Object.h>
#include <Ice/ValueF.h>
#include <Ice/ProxyF.h>
#include <Ice/Buffer.h>
#include <Ice/Protocol.h>
#include <Ice/SlicedDataF.h>
#include <Ice/StreamHelpers.h>
namespace Ice
{
class UserException;
class ICE_API OutputStream : public IceInternal::Buffer
{
public:
typedef size_t size_type;
//
// Constructing an OutputStream without providing a communicator means the stream will
// use the default encoding version, the default format for class encoding, and the
// process string converters. You can supply a communicator later by calling initialize().
//
OutputStream();
//
// This constructor uses the communicator's default encoding version.
//
OutputStream(const CommunicatorPtr&);
//
// This constructor uses the given communicator and encoding version.
//
OutputStream(const CommunicatorPtr&, const EncodingVersion&);
//
// This constructor uses the given communicator and encoding version. The byte pair denotes
// application-supplied memory that the stream uses as its initial marshaling buffer. The
// stream will reallocate if the size of the marshaled data exceeds the application's buffer.
//
OutputStream(const CommunicatorPtr&, const EncodingVersion&, const std::pair<const Byte*, const Byte*>&);
~OutputStream()
{
// Inlined for performance reasons.
if(_currentEncaps != &_preAllocatedEncaps)
{
clear(); // Not inlined.
}
}
//
// Initializes the stream to use the communicator's default encoding version and class
// encoding format
//
void initialize(const CommunicatorPtr&);
//
// Initializes the stream to use the given encoding version and the communicator's
// default class encoding format and string converters.
//
void initialize(const CommunicatorPtr&, const EncodingVersion&);
void clear();
//
// Must return Instance*, because we don't hold an InstancePtr for
// optimization reasons (see comments below).
//
IceInternal::Instance* instance() const { return _instance; } // Inlined for performance reasons.
void setFormat(FormatType);
void* getClosure() const;
void* setClosure(void*);
void swap(OutputStream&);
void resetEncapsulation();
void resize(Container::size_type sz)
{
b.resize(sz);
}
void startValue(const SlicedDataPtr& data)
{
assert(_currentEncaps && _currentEncaps->encoder);
_currentEncaps->encoder->startInstance(ValueSlice, data);
}
void endValue()
{
assert(_currentEncaps && _currentEncaps->encoder);
_currentEncaps->encoder->endInstance();
}
void startException(const SlicedDataPtr& data)
{
assert(_currentEncaps && _currentEncaps->encoder);
_currentEncaps->encoder->startInstance(ExceptionSlice, data);
}
void endException()
{
assert(_currentEncaps && _currentEncaps->encoder);
_currentEncaps->encoder->endInstance();
}
void startEncapsulation();
void startEncapsulation(const EncodingVersion& encoding, FormatType format)
{
IceInternal::checkSupportedEncoding(encoding);
Encaps* oldEncaps = _currentEncaps;
if(!oldEncaps) // First allocated encaps?
{
_currentEncaps = &_preAllocatedEncaps;
}
else
{
_currentEncaps = new Encaps();
_currentEncaps->previous = oldEncaps;
}
_currentEncaps->format = format;
_currentEncaps->encoding = encoding;
_currentEncaps->start = b.size();
write(Int(0)); // Placeholder for the encapsulation length.
write(_currentEncaps->encoding);
}
void endEncapsulation()
{
assert(_currentEncaps);
// Size includes size and version.
const Int sz = static_cast<Int>(b.size() - _currentEncaps->start);
write(sz, &(*(b.begin() + _currentEncaps->start)));
Encaps* oldEncaps = _currentEncaps;
_currentEncaps = _currentEncaps->previous;
if(oldEncaps == &_preAllocatedEncaps)
{
oldEncaps->reset();
}
else
{
delete oldEncaps;
}
}
void writeEmptyEncapsulation(const EncodingVersion& encoding)
{
IceInternal::checkSupportedEncoding(encoding);
write(Int(6)); // Size
write(encoding);
}
void writeEncapsulation(const Byte* v, Int sz)
{
if(sz < 6)
{
throwEncapsulationException(__FILE__, __LINE__);
}
Container::size_type position = b.size();
resize(position + sz);
memcpy(&b[position], &v[0], sz);
}
const EncodingVersion& getEncoding() const
{
return _currentEncaps ? _currentEncaps->encoding : _encoding;
}
void startSlice(const std::string& typeId, int compactId, bool last)
{
assert(_currentEncaps && _currentEncaps->encoder);
_currentEncaps->encoder->startSlice(typeId, compactId, last);
}
void endSlice()
{
assert(_currentEncaps && _currentEncaps->encoder);
_currentEncaps->encoder->endSlice();
}
void writePendingValues();
void writeSize(Int v) // Inlined for performance reasons.
{
assert(v >= 0);
if(v > 254)
{
write(Byte(255));
write(v);
}
else
{
write(static_cast<Byte>(v));
}
}
void rewriteSize(Int v, Container::iterator dest)
{
assert(v >= 0);
if(v > 254)
{
*dest++ = Byte(255);
write(v, dest);
}
else
{
*dest = static_cast<Byte>(v);
}
}
size_type startSize()
{
size_type position = b.size();
write(Int(0));
return position;
}
void endSize(size_type position)
{
rewrite(static_cast<Int>(b.size() - position) - 4, position);
}
void writeBlob(const std::vector<Byte>&);
void writeBlob(const Byte* v, Container::size_type sz)
{
if(sz > 0)
{
Container::size_type position = b.size();
resize(position + sz);
memcpy(&b[position], &v[0], sz);
}
}
template<typename T> void write(const T& v)
{
StreamHelper<T, StreamableTraits<T>::helper>::write(this, v);
}
template<typename T> void write(Int tag, const IceUtil::Optional<T>& v)
{
if(!v)
{
return; // Optional not set
}
if(writeOptional(tag, StreamOptionalHelper<T,
StreamableTraits<T>::helper,
StreamableTraits<T>::fixedLength>::optionalFormat))
{
StreamOptionalHelper<T,
StreamableTraits<T>::helper,
StreamableTraits<T>::fixedLength>::write(this, *v);
}
}
//
// Template functions for sequences and custom sequences
//
template<typename T> void write(const std::vector<T>& v)
{
if(v.empty())
{
writeSize(0);
}
else
{
write(&v[0], &v[0] + v.size());
}
}
template<typename T> void write(const T* begin, const T* end)
{
writeSize(static_cast<Int>(end - begin));
for(const T* p = begin; p != end; ++p)
{
write(*p);
}
}
#ifdef ICE_CPP11_MAPPING
template<typename T> void writeAll(const T& v)
{
write(v);
}
template<typename T, typename... Te> void writeAll(const T& v, const Te&... ve)
{
write(v);
writeAll(ve...);
}
template<size_t I = 0, typename... Te>
typename std::enable_if<I == sizeof...(Te), void>::type
writeAll(std::tuple<Te...>)
{
// Do nothing. Either tuple is empty or we are at the end.
}
template<size_t I = 0, typename... Te>
typename std::enable_if<I < sizeof...(Te), void>::type
writeAll(std::tuple<Te...> tuple)
{
write(std::get<I>(tuple));
writeAll<I + 1, Te...>(tuple);
}
template<typename T>
void writeAll(std::initializer_list<int> tags, const IceUtil::Optional<T>& v)
{
write(*(tags.begin() + tags.size() - 1), v);
}
template<typename T, typename... Te>
void writeAll(std::initializer_list<int> tags, const IceUtil::Optional<T>& v, const IceUtil::Optional<Te>&... ve)
{
size_t index = tags.size() - sizeof...(ve) - 1;
write(*(tags.begin() + index), v);
writeAll(tags, ve...);
}
#endif
// Write type and tag for optionals
bool writeOptional(Int tag, OptionalFormat format)
{
assert(_currentEncaps);
if(_currentEncaps->encoder)
{
return _currentEncaps->encoder->writeOptional(tag, format);
}
else
{
return writeOptImpl(tag, format);
}
}
// Byte
void write(Byte v)
{
b.push_back(v);
}
void write(const Byte*, const Byte*);
// Bool
void write(bool v)
{
b.push_back(static_cast<Byte>(v));
}
void write(const std::vector<bool>&);
void write(const bool*, const bool*);
// Short
void write(Short);
void write(const Short*, const Short*);
// Int
void write(Int v) // Inlined for performance reasons.
{
Container::size_type position = b.size();
resize(position + sizeof(Int));
write(v, &b[position]);
}
void write(Int v, Container::iterator dest)
{
#ifdef ICE_BIG_ENDIAN
const Byte* src = reinterpret_cast<const Byte*>(&v) + sizeof(Int) - 1;
*dest++ = *src--;
*dest++ = *src--;
*dest++ = *src--;
*dest = *src;
#else
const Byte* src = reinterpret_cast<const Byte*>(&v);
*dest++ = *src++;
*dest++ = *src++;
*dest++ = *src++;
*dest = *src;
#endif
}
void write(const Int*, const Int*);
// Long
void write(Long);
void write(const Long*, const Long*);
// Float
void write(Float);
void write(const Float*, const Float*);
// Double
void write(Double);
void write(const Double*, const Double*);
// String
void write(const std::string& v, bool convert = true)
{
Int sz = static_cast<Int>(v.size());
if(convert && sz > 0)
{
writeConverted(v.data(), static_cast<size_t>(sz));
}
else
{
writeSize(sz);
if(sz > 0)
{
Container::size_type position = b.size();
resize(position + sz);
memcpy(&b[position], v.data(), sz);
}
}
}
// for custom strings
void write(const char* vdata, size_t vsize, bool convert = true)
{
Int sz = static_cast<Int>(vsize);
if(convert && sz > 0)
{
writeConverted(vdata, vsize);
}
else
{
writeSize(sz);
if(sz > 0)
{
Container::size_type position = b.size();
resize(position + sz);
memcpy(&b[position], vdata, vsize);
}
}
}
// Null-terminated C string
void write(const char* vdata, bool convert = true)
{
write(vdata, strlen(vdata), convert);
}
void write(const std::string*, const std::string*, bool = true);
void write(const std::wstring& v);
void write(const std::wstring*, const std::wstring*);
// Proxy
#ifdef ICE_CPP11_MAPPING
void writeProxy(const ::std::shared_ptr<ObjectPrx>&);
template<typename T, typename ::std::enable_if<::std::is_base_of<ObjectPrx, T>::value>::type* = nullptr>
void write(const ::std::shared_ptr<T>& v)
{
writeProxy(::std::static_pointer_cast<ObjectPrx>(v));
}
#else
void write(const ObjectPrx&);
template<typename T> void write(const IceInternal::ProxyHandle<T>& v)
{
write(ObjectPrx(upCast(v.get())));
}
#endif
// Class
#ifdef ICE_CPP11_MAPPING // C++11 mapping
template<typename T, typename ::std::enable_if<::std::is_base_of<Value, T>::value>::type* = nullptr>
void write(const ::std::shared_ptr<T>& v)
{
initEncaps();
_currentEncaps->encoder->write(v);
}
#else // C++98 mapping
void write(const ObjectPtr& v)
{
initEncaps();
_currentEncaps->encoder->write(v);
}
template<typename T> void write(const IceInternal::Handle<T>& v)
{
write(ObjectPtr(upCast(v.get())));
}
#endif
// Enum
void writeEnum(Int, Int);
// Exception
void writeException(const UserException&);
size_type pos()
{
return b.size();
}
void rewrite(Int value, size_type p)
{
write(value, b.begin() + p);
}
OutputStream(IceInternal::Instance*, const EncodingVersion&);
void initialize(IceInternal::Instance*, const EncodingVersion&);
void finished(std::vector<Byte>&);
std::pair<const Byte*, const Byte*> finished();
// Optionals
bool writeOptImpl(Int, OptionalFormat);
private:
//
// String
//
void writeConverted(const char*, size_t);
//
// We can't throw this exception from inline functions from within
// this file, because we cannot include the header with the
// exceptions. Doing so would screw up the whole include file
// ordering.
//
void throwEncapsulationException(const char*, int);
//
// Optimization. The instance may not be deleted while a
// stack-allocated stream still holds it.
//
IceInternal::Instance* _instance;
//
// The public stream API needs to attach data to a stream.
//
void* _closure;
class Encaps;
enum SliceType { NoSlice, ValueSlice, ExceptionSlice };
typedef std::vector<ValuePtr> ValueList;
class ICE_API EncapsEncoder : private ::IceUtil::noncopyable
{
public:
virtual ~EncapsEncoder();
virtual void write(const ValuePtr&) = 0;
virtual void write(const UserException&) = 0;
virtual void startInstance(SliceType, const SlicedDataPtr&) = 0;
virtual void endInstance() = 0;
virtual void startSlice(const std::string&, int, bool) = 0;
virtual void endSlice() = 0;
virtual bool writeOptional(Int, OptionalFormat)
{
return false;
}
virtual void writePendingValues()
{
}
protected:
EncapsEncoder(OutputStream* stream, Encaps* encaps) : _stream(stream), _encaps(encaps), _typeIdIndex(0)
{
}
Int registerTypeId(const std::string&);
OutputStream* _stream;
Encaps* _encaps;
typedef std::map<ValuePtr, Int> PtrToIndexMap;
typedef std::map<std::string, Int> TypeIdMap;
// Encapsulation attributes for value marshaling.
PtrToIndexMap _marshaledMap;
private:
// Encapsulation attributes for value marshaling.
TypeIdMap _typeIdMap;
Int _typeIdIndex;
};
class ICE_API EncapsEncoder10 : public EncapsEncoder
{
public:
EncapsEncoder10(OutputStream* stream, Encaps* encaps) :
EncapsEncoder(stream, encaps), _sliceType(NoSlice), _valueIdIndex(0)
{
}
virtual void write(const ValuePtr&);
virtual void write(const UserException&);
virtual void startInstance(SliceType, const SlicedDataPtr&);
virtual void endInstance();
virtual void startSlice(const std::string&, int, bool);
virtual void endSlice();
virtual void writePendingValues();
private:
Int registerValue(const ValuePtr&);
// Instance attributes
SliceType _sliceType;
// Slice attributes
Container::size_type _writeSlice; // Position of the slice data members
// Encapsulation attributes for value marshaling.
Int _valueIdIndex;
PtrToIndexMap _toBeMarshaledMap;
};
class ICE_API EncapsEncoder11 : public EncapsEncoder
{
public:
EncapsEncoder11(OutputStream* stream, Encaps* encaps) :
EncapsEncoder(stream, encaps), _preAllocatedInstanceData(0), _current(0), _valueIdIndex(1)
{
}
virtual void write(const ValuePtr&);
virtual void write(const UserException&);
virtual void startInstance(SliceType, const SlicedDataPtr&);
virtual void endInstance();
virtual void startSlice(const std::string&, int, bool);
virtual void endSlice();
virtual bool writeOptional(Int, OptionalFormat);
private:
void writeSlicedData(const SlicedDataPtr&);
void writeInstance(const ValuePtr&);
struct InstanceData
{
InstanceData(InstanceData* p) : previous(p), next(0)
{
if(previous)
{
previous->next = this;
}
}
~InstanceData()
{
if(next)
{
delete next;
}
}
// Instance attributes
SliceType sliceType;
bool firstSlice;
// Slice attributes
Byte sliceFlags;
Container::size_type writeSlice; // Position of the slice data members
Container::size_type sliceFlagsPos; // Position of the slice flags
PtrToIndexMap indirectionMap;
ValueList indirectionTable;
InstanceData* previous;
InstanceData* next;
};
InstanceData _preAllocatedInstanceData;
InstanceData* _current;
Int _valueIdIndex; // The ID of the next value to marhsal
};
class Encaps : private ::IceUtil::noncopyable
{
public:
Encaps() : format(ICE_ENUM(FormatType, DefaultFormat)), encoder(0), previous(0)
{
// Inlined for performance reasons.
}
~Encaps()
{
// Inlined for performance reasons.
delete encoder;
}
void reset()
{
// Inlined for performance reasons.
delete encoder;
encoder = 0;
previous = 0;
}
Container::size_type start;
EncodingVersion encoding;
FormatType format;
EncapsEncoder* encoder;
Encaps* previous;
};
//
// The encoding version to use when there's no encapsulation to
// read from or write to. This is for example used to read message
// headers or when the user is using the streaming API with no
// encapsulation.
//
EncodingVersion _encoding;
FormatType _format;
Encaps* _currentEncaps;
void initEncaps();
Encaps _preAllocatedEncaps;
};
} // End namespace Ice
#endif
|