diff --git a/linux/bin/sqlite3 b/linux/bin/sqlite3 index 4a4891d5b..f29921532 100755 Binary files a/linux/bin/sqlite3 and b/linux/bin/sqlite3 differ diff --git a/linux/include/OnixS/CME/MDP3.h b/linux/include/OnixS/CME/MDP3.h new file mode 100755 index 000000000..7d7245701 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3.h @@ -0,0 +1,82 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/ABI.h" + +#include "OnixS/CME/MDP3/Config.h" + +#include "OnixS/CME/MDP3/Types.h" +#include "OnixS/CME/MDP3/Numeric.h" +#include "OnixS/CME/MDP3/String.h" +#include "OnixS/CME/MDP3/Time.h" + +#include "OnixS/CME/MDP3/BBA.h" + +#include "OnixS/CME/MDP3/DirectPriceLevel.h" +#include "OnixS/CME/MDP3/ImpliedPriceLevel.h" +#include "OnixS/CME/MDP3/ConsolidatedPriceLevel.h" + +#include "OnixS/CME/MDP3/BookChangeBase.h" +#include "OnixS/CME/MDP3/DirectBookChange.h" +#include "OnixS/CME/MDP3/ImpliedBookChange.h" +#include "OnixS/CME/MDP3/BookChangeListeners.h" + +#include "OnixS/CME/MDP3/BookBase.h" +#include "OnixS/CME/MDP3/DirectBook.h" +#include "OnixS/CME/MDP3/ImpliedBook.h" +#include "OnixS/CME/MDP3/ConsolidatedBook.h" +#include "OnixS/CME/MDP3/BookUpdateListeners.h" +#include "OnixS/CME/MDP3/BookSnapshot.h" + +#include "OnixS/CME/MDP3/Error.h" +#include "OnixS/CME/MDP3/Warning.h" + +#include "OnixS/CME/MDP3/FeedEnums.h" +#include "OnixS/CME/MDP3/FeedListener.h" +#include "OnixS/CME/MDP3/FeedEngine.h" + +#include "OnixS/CME/MDP3/AsyncLog.h" +#include "OnixS/CME/MDP3/TcpRecovery.h" + +#include "OnixS/CME/MDP3/Version.h" +#include "OnixS/CME/MDP3/Initialization.h" +#include "OnixS/CME/MDP3/ThreadAffinity.h" +#include "OnixS/CME/MDP3/HandlerSettings.h" +#include "OnixS/CME/MDP3/Handler.h" +#include "OnixS/CME/MDP3/HandlerState.h" + +#include "OnixS/CME/MDP3/Tags.h" +#include "OnixS/CME/MDP3/Messaging.h" +#include "OnixS/CME/MDP3/MessageProcessingListener.h" + +#include "OnixS/CME/MDP3/SettlementPriceType.h" +#include "OnixS/CME/MDP3/SecurityDefinition.h" +#include "OnixS/CME/MDP3/SecurityDefinitionListener.h" +#include "OnixS/CME/MDP3/SecurityStatus.h" +#include "OnixS/CME/MDP3/Statistics.h" +#include "OnixS/CME/MDP3/Trade.h" +#include "OnixS/CME/MDP3/EventIndicator.h" +#include "OnixS/CME/MDP3/EventListener.h" +#include "OnixS/CME/MDP3/EventMessageListener.h" +#include "OnixS/CME/MDP3/RequestForQuote.h" + +#include "OnixS/CME/MDP3/Replay.h" + +#include "OnixS/CME/MDP3/Namespaces.h" diff --git a/linux/include/OnixS/CME/MDP3/ABI.h b/linux/include/OnixS/CME/MDP3/ABI.h new file mode 100755 index 000000000..7283660a0 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/ABI.h @@ -0,0 +1,109 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include + +// ABI decorations. + +#if defined (_MSC_VER) + +#if defined (ONIXS_CME_MDP3_AS_LIB) +#define ONIXS_CME_MDP3_API +#elif defined (ONIXS_CME_MDP3_EXPORTS) +#define ONIXS_CME_MDP3_API __declspec(dllexport) +#else +#define ONIXS_CME_MDP3_API __declspec(dllimport) +#endif + +#define ONIXS_CME_MDP3_THROWABLE +#define ONIXS_CME_MDP3_THROWABLE_API ONIXS_CME_MDP3_API + +#elif (__GNUC__ >= 4) + +#if defined (ONIXS_CME_MDP3_AS_LIB) +#define ONIXS_CME_MDP3_API /*__attribute__ ((visibility("hidden")))*/ +#else +#define ONIXS_CME_MDP3_API __attribute__ ((visibility("default"))) +#endif + +#define ONIXS_CME_MDP3_THROWABLE __attribute__ ((visibility("default"))) +#define ONIXS_CME_MDP3_THROWABLE_API ONIXS_CME_MDP3_THROWABLE + +#else + +#define ONIXS_CME_MDP3_API +#define ONIXS_CME_MDP3_THROWABLE +#define ONIXS_CME_MDP3_THROWABLE_API + +#endif + +// Different compilers has different approaches in public class/struct +// declaration. Following set of macros eliminates miscellaneous issues +// (compiler warnings) related with class/struct forward declarations. + +#if defined (_MSC_VER) +#define ONIXS_CME_MDP3_API_DECL(typeKind, typeName) \ + typeKind ONIXS_CME_MDP3_API typeName +#else +#define ONIXS_CME_MDP3_API_DECL(typeKind, typeName) \ + typeKind typeName +#endif + +// Macro to abuse other macro substitution. + +#define ONIXS_CME_MDP3_MACRO_ABUSER + +template +class ONIXS_CME_MDP3_API Exportable +{ + T* obj_; + +public: + Exportable(): obj_(new T) + {} + + Exportable(const T& rhs): obj_(new T(rhs)) + {} + + Exportable(const Exportable& rhs): obj_(new T(*rhs.obj_)) + {} + + Exportable& operator=(const Exportable& rhs) + { + Exportable tmp(rhs); + std::swap(obj_, tmp.obj_); + return *this; + } + + ~Exportable() + { + delete obj_; + } + + T& operator*() const + { + return *obj_; + } + + T* operator->() const + { + return obj_; + } +}; diff --git a/linux/include/OnixS/CME/MDP3/AsyncLog.h b/linux/include/OnixS/CME/MDP3/AsyncLog.h new file mode 100755 index 000000000..ddcf85fab --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/AsyncLog.h @@ -0,0 +1,160 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/Types.h" +#include "OnixS/CME/MDP3/ThreadAffinity.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + + /// Asynchronous logging service configuration settings. + struct + ONIXS_CME_MDP3_API + AsyncLogSettings + { + /// Minimal interval between the moment when log entry is passed + /// to log service and moment when it is written to the disk. + /// + /// Interval is measured in milliseconds. + /// + /// @note Default value is '100'. + unsigned int flushTimeoutInterval() const + { + return flushTimeoutInterval_; + } + + /// Sets flushTimeoutInterval. @see flushTimeoutInterval. + void flushTimeoutInterval(unsigned int value) + { + flushTimeoutInterval_ = value; + } + + /// Preferred amount of allocated log entries per handler instance. + /// Asynchronous logging service uses pool to minimize memory allocations + /// and reuse log entries memory. When handler instance is bound to async + /// logging service this amount of log entries is preallocated. When pool + /// size exceeds this amount unused extra entries start freeing. + /// + /// @note Default value is '256'. + unsigned int preferredPoolSize() const + { + return preferredPoolSize_; + } + + /// Sets preferredPoolSize. @see preferredPoolSize. + void preferredPoolSize(unsigned int value) + { + preferredPoolSize_ = value; + } + + /// Defines set of CPUs by their indices (starting from zero) + /// allowed for asynchronous logging thread to be executed on. + /// + /// @note By default set is empty thus allowing thread + /// to be executed on any CPU available in the system. + const ThreadAffinity& threadAffinity() const + { + return threadAffinity_; + } + + /// @see threadAffinity. + ThreadAffinity& threadAffinity() + { + return threadAffinity_; + } + + /// Initializes parameters with default values. + AsyncLogSettings(); + + /// Cleans everything up. + ~AsyncLogSettings(); + + /// Returns textual presentation. + std::string toString() const + { + std::string str; + toString(str); + return str; + } + + /// Returns textual presentation. + void toString(std::string&) const; + + private: + unsigned int flushTimeoutInterval_; + unsigned int preferredPoolSize_; + ThreadAffinity threadAffinity_; + }; + + ONIXS_CME_MDP3_API_DECL(class, AsyncLogService); + ONIXS_CME_MDP3_API_DECL(class, Error); + + /// Listener for Asynchronous Logging Service thread-related events. + class + ONIXS_CME_MDP3_API + AsyncLogListener + { + public: + + /// Member invoked by Asynchronous Logging Service when + /// error occurred while processing log entries. + virtual + void + onAsyncLogError( + const AsyncLogService& source, + const Error& error) = 0; + + protected: + virtual ~AsyncLogListener(); + }; + + /// Asynchronous Logging Service. + /// + /// @note Starts separate auxiliary thread performing + /// disk I/O operations on background. + class + ONIXS_CME_MDP3_API + AsyncLogService + { + public: + class Implementation; + + /// Initializes instance according to given settings. + AsyncLogService( + const AsyncLogSettings& settings, + AsyncLogListener* listener = NULL); + + /// Destructor. + ~AsyncLogService(); + + private: + friend class Implementation; + Implementation* impl_; + + AsyncLogService(const AsyncLogService&); + AsyncLogService& operator =(const AsyncLogService&); + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/BBA.h b/linux/include/OnixS/CME/MDP3/BBA.h new file mode 100755 index 000000000..236a615bf --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/BBA.h @@ -0,0 +1,133 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/Config.h" +#include "OnixS/CME/MDP3/Numeric.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + /// Identifies which of available in best bid/ask + /// parameters should be tracked for changes. + struct + ONIXS_CME_MDP3_API + BestBidAskParameters + { + enum Enum + { + /// No parameters should be tracked for changes. + Neither = 0x0, + + /// Indicates that price should be tracked in best bid/ask. + Price = 0x1, + + /// Indicates that quantity should be tracked in best bid/ask. + Quantity = 0x2, + + /// Indicates that number of orders should be tracked in best bid/ask. + OrdersCount = 0x4 + }; + }; + + /// Alias for easier manipulations in the code. + typedef + BestBidAskParameters::Enum + BestBidAskParameter; + + /// Operator to combine parameters. + inline + BestBidAskParameters::Enum + operator |( + BestBidAskParameters::Enum left, + BestBidAskParameters::Enum right) + { + return + static_cast( + static_cast(left) | + static_cast(right) + ); + } + + /// Set of parameters which affect best bid/ask tracking. + struct + ONIXS_CME_MDP3_API + ImpliedBestBidAskTrackingOptions + { + /// Defines which of available in price levels + /// parameters (price, qty) should be tracked for changes. + /// + /// Multiple parameters can be defined with help of bitwise OR ( + /// e.g. BestBidAskParameters::Price | BestBidAskParameters::Quantity). + BestBidAskParameters::Enum parameters; + + /// Specifies sensitivity threshold for price values (in percents). + /// If price of the best bid/ask changes for more that specified value + /// of percents, Handler will invoke change listener. Default value is + /// zero, so all changes of best bid/ask cause Handler to invoke listener. + Decimal priceThreshold; + + /// Specifies sensitivity threshold for quantity values (in percents). + /// If quantity of the best bid/ask changes for more that specified value + /// of percents, Handler will invoke change listener. Default value is + /// zero, so all changes of best bid/ask cause Handler to invoke listener. + Decimal quantityThreshold; + + /// Initializes instance with default configuration + /// (no BBA parameters are tracked). + ImpliedBestBidAskTrackingOptions(); + + /// Initializes threshold for single or multiple parameters. + ImpliedBestBidAskTrackingOptions( + BestBidAskParameters::Enum parameters, + const Decimal& value); + }; + + /// Set of parameters which affect best bid/ask tracking. + struct + ONIXS_CME_MDP3_API + DirectBestBidAskTrackingOptions + : ImpliedBestBidAskTrackingOptions + { + /// Specifies sensitivity threshold for orders count values (in percents). + /// If orders qty of the best bid/ask changes for more that specified value + /// of percents, Handler will invoke change listener. Default value is + /// zero, so all changes of best bid/ask cause Handler to invoke listener. + Decimal ordersCountThreshold; + + /// Initializes instance with default configuration + /// (no BBA parameters are tracked). + DirectBestBidAskTrackingOptions(); + + /// Initializes threshold for single or multiple parameters. + DirectBestBidAskTrackingOptions( + BestBidAskParameters::Enum parameters, + const Decimal& value); + }; + + /// Parameters for consolidated book. + typedef + ImpliedBestBidAskTrackingOptions + ConsolidatedBestBidAskTrackingOptions; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/BookBase.h b/linux/include/OnixS/CME/MDP3/BookBase.h new file mode 100755 index 000000000..9b5a9138d --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/BookBase.h @@ -0,0 +1,602 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include +#include + +#include "OnixS/CME/MDP3/Types.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + /// Represents reference to segment + /// of built-in array of items. + template + < + typename ItemType, + typename SizeType + > + class ArrayRef + { + public: + typedef ItemType Item; + typedef ItemType* Iterator; + + typedef SizeType Index; + typedef SizeType Size; + + /// Initializes instance referencing to nothing. + ArrayRef() + : items_(NULL), + size_(0) + { + } + + /// Initializes instance referencing to given data. + ArrayRef( + Item* items, + Size itemsCount) + : items_(items), + size_(itemsCount) + { + } + + /// Initializes instance as copy of other one. + template + < + typename OtherItem, + typename OtherSize + > + ArrayRef( + const ArrayRef& other) + : items_(other.items()), + size_(other.size()) + { + } + + // Destructs the instance. + ~ArrayRef() + { + } + + /// Indicates whether array has no items. + bool + empty() const + { + return (0 == size_); + } + + /// Number of items being referenced. + Size + size() const + { + return size_; + } + + /// Iterator referencing to the first item. + Iterator + begin() const + { + return items_; + } + + /// Iterator referencing to the item behind the last item. + Iterator + end() const + { + return (items_ + size_); + } + + /// Accesses to item by index. + Item& + operator[](Index index) const + { + return items_[index]; + } + + /// Accesses to item by index + /// checking access bounds. + Item& + at(Index index) const + { + if (index < size_) + return items_[index]; + + throw std::domain_error( + "Index outside of range."); + } + + /// Re-initializes instance as copy of the other one. + template + < + typename OtherItem, + typename OtherSize + > + ArrayRef& + operator =( + const ArrayRef& other) + { + items_ = other.items(); + size_ = other.size(); + + return *this; + } + + protected: + Item* items_; + Size size_; + }; + + /// Implements vector-like container over + /// built-in array of fixed size being + /// referenced. + template + < + typename ItemType, + typename SizeType + > + class VectorOverArray + { + public: + typedef ItemType Item; + typedef ItemType* Iterator; + + typedef SizeType Index; + typedef SizeType Size; + + /// Initializes instance with no items. + VectorOverArray() + : items_(NULL), + size_(0), + capacity_(0) + { + } + + /// Initializes instance over given fixed-size array. + VectorOverArray( + Item* items, + Size capacity) + : items_(items), + size_(0), + capacity_(capacity) + { + } + + /// Does nothing. + ~VectorOverArray() + { + resize(0); + } + + /// Indicates whether instance has no items. + bool + empty() const + { + return (0 == size_); + } + + /// Number of items. + Size + size() const + { + return size_; + } + + /// Total capacity of container. + Size + capacity() const + { + return capacity_; + } + + /// Iterator referencing to the first item. + Iterator + begin() const + { + return items_; + } + + /// Iterator referencing to the item behind the last item. + Iterator + end() const + { + return (items_ + size_); + } + + /// Accesses to item by index. + Item& + operator[](Index index) const + { + assert(index < size_); + + return items_[index]; + } + + /// Accesses to item by index + /// checking access bounds. + Item& + at(Index index) const + { + if (index < size_) + return items_[index]; + + throw std::domain_error( + "Index outside of range."); + } + + /// Inserts new item to given position. + /// Items under higher indices are moved back. + /// Last item is extruded thus keeping size of + /// or container constant. + /// + /// @return Reference to an item at + /// requested position for further update. + Item& + extrudingInsert(Index index) + { + assert(index < size_); + + Item* const toBeUpdated = items_ + index; + + Item* target = items_ + size_ - 1; + Item* source = target - 1; + + while (target != toBeUpdated) + { + target->~Item(); + + new (target--) Item(*source--); + } + + return *toBeUpdated; + } + + /// Erases item at given position. + void + eraseAt( + Index index) + { + assert(index < size_); + + Item* const theEnd = end(); + Item* const toBeErased = items_ + index; + + Item* target = toBeErased; + Item* source = toBeErased + 1; + + while (source != theEnd) + { + target->~Item(); + + new (target++) Item(*source++); + } + + target->~Item(); + + --size_; + } + + /// Resizes container. + /// + /// If vector is enlarged, new items + /// constructed as copies of given instance. + void + resize( + Size newSize, + const Item& item = Item()) + { + assert(newSize <= capacity_); + + if (newSize > size_) + { + while (size_ != newSize) + new (items_ + size_++) Item(item); + } + else + { + while (size_ != newSize) + (items_ + --size_)->~Item(); + } + } + + /// Emplaces back a new item constructed using passed argument. + template + void emplaceBack(const T& arg) + { + assert(size_ < capacity_); + new (items_ + size_++) Item(arg); + } + + /// Emplaces back a new item constructed using passed arguments. + template + void emplaceBack(const T1& arg1, const T2& arg2) + { + assert(size_ < capacity_); + new (items_ + size_++) Item(arg1, arg2); + } + + /// Changes size of container without deleting or + /// constructing items (suitable for POD items). + void + size(Size newSize) + { + assert(newSize <= capacity_); + + size_ = newSize; + } + + protected: + Item* items_; + Size size_; + Size capacity_; + + VectorOverArray( + const VectorOverArray&) + { + } + + VectorOverArray& + operator =( + const VectorOverArray&) + { + return *this; + } + }; + + /// State of order book. + struct + ONIXS_CME_MDP3_API + BookStates + { + enum Enum + { + /// Book is naturally refreshed. + NaturallyRefreshed, + + /// Book is up-to-date. + Latest + }; + + /// Deserializes value from text presentation. + static Enum deserialize(const char*); + + /// Returns text presentation for given value. + static const char* toString(Enum); + }; + + typedef + BookStates::Enum + BookState; + + /// Base attributes of order book. + /// + /// A set of bids and asks data for the given security + /// (bids are descending and asks are ascending). + template + < + class PriceLevelType + > + class + BookBase + { + public: + /// Indicates price level data type. + typedef + PriceLevelType + PriceLevel; + + /// Indicates reference to array of immutable price levels. + typedef + ArrayRef + < + const PriceLevel, + MarketDepth + > + PriceLevelsRef; + + /// Indicates reference to array of mutable price levels. + typedef + ArrayRef + < + PriceLevel, + MarketDepth + > + EditablePriceLevelsRef; + + /// Collection of price levels allowing modifications. + typedef + VectorOverArray + < + PriceLevel, + MarketDepth + > + EditablePriceLevels; + + /// Unique instrument Id (tag 48) as qualified + /// by the exchange per tag 22-SecurityIDSource. + SecurityId + securityId() const + { + return id_; + } + + /// Updates unique instrument Id. + void + securityId( + SecurityId id) + { + id_ = id; + } + + /// Returns the maximal number of price levels. + MarketDepth + depth() const + { + return depth_; + } + + /// Updates the maximal number of price levels. + void + depth( + MarketDepth depth) + { + assert(depth <= bids_.capacity()); + assert(depth <= asks_.capacity()); + + depth_ = depth; + } + + /// List of descending bid prices for the security. + const + PriceLevelsRef + bids() const + { + return PriceLevelsRef( + bids_.begin(), bids_.size()); + } + + /// List of ascending ask prices for the security. + const + PriceLevelsRef + asks() const + { + return PriceLevelsRef( + asks_.begin(), asks_.size()); + } + + /// List of ascending ask prices for the security. + EditablePriceLevels& + asks() + { + return asks_; + } + + /// List of descending bid prices for the security. + EditablePriceLevels& + bids() + { + return bids_; + } + + /// Indicates current state of book. + BookState + state() const + { + return state_; + } + + /// Updates state of book. + void + state( + BookState state) + { + state_ = state; + } + + /// Instrument-level sequence number of market + /// data entry most recently applied to the book. + SequenceNumber + lastAppliedSecurityLevelSeqNumber() const + { + return securityLevelSeqNumber_; + } + + /// Updates instrument-level sequence number of market + /// data entry most recently applied to the book. + void + lastAppliedSecurityLevelSeqNumber( + SequenceNumber securityLevelSeqNumber) + { + securityLevelSeqNumber_ = securityLevelSeqNumber; + } + + protected: + /// Initializes instance with given attributes. + /// + /// Bids and asks are stored in given segments of plain arrays. + /// Book constructs vectors over input arrays of fixed size. + /// That provides more flexibility on memory layout for + /// internally used data. + BookBase( + SecurityId id, + MarketDepth depth, + const EditablePriceLevelsRef& bids, + const EditablePriceLevelsRef& asks) + : id_(id), + depth_(depth), + bids_( + bids.begin(), + bids.size()), + asks_( + asks.begin(), + asks.size()), + securityLevelSeqNumber_(0) + { + assert(depth <= bids_.capacity()); + assert(depth <= asks_.capacity()); + } + + /// Cleans everything up. + ~BookBase() + { + } + + /// Wipes out all bids and asks and other + /// data associated with book (like instance + /// of last applied FIX message). + void + reset( + BookState bookState) + { + state(bookState); + + bids_.resize(0); + asks_.resize(0); + } + + private: + // Security id. + SecurityId id_; + + // Book depth. + MarketDepth depth_; + + // Book state. + BookState state_; + + // Bids. + EditablePriceLevels bids_; + + // Asks. + EditablePriceLevels asks_; + + // last applied rpt seq + SequenceNumber securityLevelSeqNumber_; + + // Copying/Cloning is done in other way. + BookBase(const BookBase&); + BookBase& operator=(const BookBase&); + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/BookChangeBase.h b/linux/include/OnixS/CME/MDP3/BookChangeBase.h new file mode 100755 index 000000000..9a4808fe3 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/BookChangeBase.h @@ -0,0 +1,307 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/Tags.h" +#include "OnixS/CME/MDP3/Types.h" +#include "OnixS/CME/MDP3/Messaging.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + /// Known types of book changes. + struct + ONIXS_CME_MDP3_API + BookChangeTypes + { + /// Enumerates available types of book change. + enum Enum + { + /// Book change is absent. + Undefined = -1, + + /// Add entry to the book. + Add = 0, + + /// Modify an entry in the book. + Change = 1, + + /// Delete an entry from the book. + Delete = 2, + + /// All positions on one side of the book should be deleted. + DeleteThru = 3, + + /// All positions from the given to position 1 should be deleted. + DeleteFrom = 4, + + /// Add, modify, or delete an entry in the book. + Overlay = 5 + }; + + /// Transforms string presentation into constant. + static Enum deserialize(const char*); + + /// Returns the string representation of the given type. + static const char* toString(Enum type); + }; + + /// Available types of book change. + typedef + BookChangeTypes::Enum + BookChangeType; + + /// Book change side. + struct + ONIXS_CME_MDP3_API + BookChangeSides + { + /// Enumerates possible sides to which book change refer. + enum Enum + { + /// Unknown book side. + Undefined = 0, + + /// Book change refers to bid in direct book. + DirectBid = '0', + + /// Alias for direct bid. + Bid = DirectBid, + + /// Book change refers to ask in direct book. + DirectAsk = '1', + + /// Alias for direct ask. + Ask = DirectAsk, + + /// Book change refers to bid in implied book. + ImpliedBid = 'E', + + /// Book change refers to ask in implied book. + ImpliedAsk = 'F' + }; + + /// Transforms serialized presentation into constant. + static Enum deserialize(const char*); + + /// Returns the string representation of the given type. + static const char* toString(Enum side); + }; + + /// Possible sides to which book change refers. + typedef + BookChangeSides::Enum + BookChangeSide; + + /// Order book change. + template + < + class PriceLevel + > + class + BookChangeBase + { + public: + /// Price level data type. + typedef + PriceLevel + PriceLevelData; + + // Indicates security whose book + // is to be updated by given change. + SecurityId securityId() const + { + return securityId_; + } + + /// Book change type. + BookChangeType type() const + { + return type_; + } + + /// Book change side. + BookChangeSide side() const + { + return side_; + } + + /// Price level index (starts with 0). + PriceLevelIndex priceLevel() const + { + return level_; + } + + /// Price level data (price, qty, number of orders (if available)). + bool priceLevelData( + PriceLevelData& levelData) const + { + if(levelData_) + { + return (levelData = *levelData_).exist(); + } + + return (levelData.exist() = + this->extract(marketDataEntry(), levelData)); + } + + /// Returns market data entry of underlying message. + const + GroupInstance& + marketDataEntry() const + { + return entry_; + } + + protected: + /// Retrieves basic attributes of the change. + BookChangeBase( + SecurityId id, + const GroupInstance& entry) + : securityId_(id), + side_( + getCharEnumFieldValue + ( + entry, + Tags::MDEntryType)), + level_( + entry.getUInt32(Tags::MDPriceLevel) - + 1), + levelData_(NULL), + entry_(entry) + { + UInt32 typeValue; + + if (entry_. + get(Tags::MDUpdateAction). + toNumber(typeValue)) + { + type_ = + static_cast + + (typeValue); + } + else + { + const StringRef snapshotMessageType("W"); + + type_ = ( + entry_.message().type() == + snapshotMessageType) + ? BookChangeTypes::Add + : BookChangeTypes::Undefined; + } + } + + /// Cleans everything up. + ~BookChangeBase() + { + } + + /// Updates value of security identifier, + /// whose book is to be updated by the change. + void securityId(SecurityId id) + { + securityId_ = id; + } + + /// Updates type of book change. + void type(BookChangeType type) + { + type_ = type; + } + + /// Updates side of book change. + void side(BookChangeSide side) + { + side_ = side; + } + + /// Updates price level value. + void priceLevel(PriceLevelIndex level) + { + level_ = level; + } + + /// Price level data associates with change (if available). + const + PriceLevelData* + priceLevelData() const + { + return levelData_; + } + + /// Associates price level data with the change. + /// Change doesn't keep local copy of price level data. + /// Instead, it keeps reference to data stored outside of instance. + void + linkPriceLevelData( + const PriceLevelData* levelData) + { + levelData_ = levelData; + } + + /// Updates market data entry associated with change. + void + marketDataEntry( + const GroupInstance& entry) + { + entry_ = entry; + } + + /// Extracts market data for specific price level type. + /// + /// @note Must be specialized for each price level instantiation. + static + bool + extract( + const GroupInstance& entry, + PriceLevelData& priceLevel); + + private: + SecurityId securityId_; + + BookChangeType type_; + + BookChangeSide side_; + + PriceLevelIndex level_; + + const PriceLevelData* levelData_; + + GroupInstance entry_; + + BookChangeBase( + const BookChangeBase&) + { + } + + BookChangeBase& + operator =( + const BookChangeBase&) + { + return *this; + } + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/BookChangeListeners.h b/linux/include/OnixS/CME/MDP3/BookChangeListeners.h new file mode 100755 index 000000000..bfee84c2a --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/BookChangeListeners.h @@ -0,0 +1,103 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/Types.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + ONIXS_CME_MDP3_API_DECL(class, DirectBookChange); + ONIXS_CME_MDP3_API_DECL(class, ImpliedBookChange); + + /// Direct book changes listener is to be used when + /// order books are built by the end-user application. + /// + /// @see DirectBookUpdateListener. + class + ONIXS_CME_MDP3_API + DirectBookChangeListener + { + public: + /// Is called when all the direct + /// books are reset for a given channel. + virtual + void + onDirectBooksReset( + const ChannelId& channelId) = 0; + + /// Is called when book is reset for a given instrument. + virtual + void + onDirectBookReset( + SecurityId securityId, + const ChannelId& channelId) = 0; + + /// Is called when a change for a + /// particular direct book is reported. + virtual + void + onDirectBookChange( + const DirectBookChange& change, + const ChannelId& channelId) = 0; + + protected: + virtual ~DirectBookChangeListener(); + }; + + /// Implied book changes listener is to be used when + /// order books are built by the end-user application. + /// + /// @see ImpliedBookUpdateListener. + class + ONIXS_CME_MDP3_API + ImpliedBookChangeListener + { + public: + /// Is called when all the implied + /// books are reset for a given channel. + virtual + void + onImpliedBooksReset( + const ChannelId& channelId) = 0; + + /// Is called when book is reset for a given instrument. + virtual + void + onImpliedBookReset( + SecurityId securityId, + const ChannelId& channelId) = 0; + + /// Is called when a change for a + /// particular implied book is reported. + virtual + void + onImpliedBookChange( + const ImpliedBookChange& change, + const ChannelId& channelId) = 0; + + protected: + virtual ~ImpliedBookChangeListener(); + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/BookSnapshot.h b/linux/include/OnixS/CME/MDP3/BookSnapshot.h new file mode 100755 index 000000000..f0afe3139 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/BookSnapshot.h @@ -0,0 +1,271 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include +#include +#include +#include + +#include "OnixS/CME/MDP3/Types.h" +#include "OnixS/CME/MDP3/Messaging.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + /// Copies price levels from source to destination. + /// Price levels are not required to be of same type + /// thus compatible levels (like direct to implied) + /// can be copied. + template + < + class DestinationPriceLevels, + class SourcePriceLevels + > + inline + void + copyPriceLevels( + DestinationPriceLevels& destination, + const SourcePriceLevels& source, + MarketDepth maxLevels = + MarketDepthTraits::MaxDepth) + { + maxLevels = std::min + ONIXS_CME_MDP3_MACRO_ABUSER ( + maxLevels, source.size()); + + if (maxLevels <= destination.capacity()) + { + destination.resize(maxLevels); + + for ( + MarketDepth level = 0; + level != maxLevels; + ++level) + { + destination[level] = source[level]; + } + } + else + { + std::ostringstream errorReason; + + errorReason + << "Cannot copy price levels because number " + "of price levels exceeds destination capacity " + "[sourcePriceLevelsCount=" + << maxLevels + << ", destinationPriceLevelsCapacity=" + << destination.capacity() + << "]. "; + + throw std::domain_error(errorReason.str()); + } + } + + /// Copies content of one book to another. + /// Source and destination books are not required + /// to be of same type, just compatible by price levels. + /// For example, content of direct book can be copied to implied book, + /// or content of consolidated book can be copied to implied book, + /// however, implied book can't be copied to direct book as far as + /// direct price level has more attributes rather than implied one. + template + < + class DestinationBook, + class SourceBook + > + inline + void + copyBook( + DestinationBook& destination, + const SourceBook& source, + MarketDepth maxDepth = + MarketDepthTraits::MaxDepth) + { + maxDepth = std::min + ONIXS_CME_MDP3_MACRO_ABUSER ( + maxDepth, source.depth()); + + copyPriceLevels( + destination.bids(), + source.bids(), + maxDepth); + + copyPriceLevels( + destination.asks(), + source.asks(), + maxDepth); + + destination.depth(maxDepth); + destination.securityId(source.securityId()); + + destination.state(source.state()); + destination.lastAppliedSecurityLevelSeqNumber( + source.lastAppliedSecurityLevelSeqNumber()); + } + + /// Book snapshot. + /// + /// Manages instance of order book for storing and coping purposes. + template + < + class Book + > + class + BookSnapshot + { + public: + /// Identifies itself as a type. + typedef + BookSnapshot + This; + + /// Pre-constructs book of given capacity. + explicit BookSnapshot( + MarketDepth initialCapacity = 0) + { + prepareForCapacity(initialCapacity); + } + + /// Constructs instance as compatible copy + /// (optionally limited by depth) of given instance. + template + < + class Other + > + BookSnapshot( + const Other& other, + MarketDepth maxDepth = + static_cast(-1)) + { + assign(other, maxDepth); + } + + /// Deletes holding book instance. + ~BookSnapshot() + { + } + + /// Casts snapshot to book type (mutable case). + operator Book&() + { + return *book_; + } + + /// Casts snapshot to book type (immutable case). + operator const Book&() const + { + return *book_; + } + + /// Returns reference to underlying book. + Book& book() + { + return *book_; + } + + /// Returns reference to underlying book. + const Book& book() const + { + return *book_; + } + + /// Re-initializes snapshot as compatible + /// copy of the other instance. + template + < + class Other + > + This& operator =( + const Other& other) + { + return assign(other); + } + + /// Re-initializes snapshot as compatible + /// copy of the other instance with ability to + /// limit number of layers to be copied. + template + < + class OtherBook + > + This& + assign( + const OtherBook& otherBook, + MarketDepth maxDepth = MarketDepthTraits::MaxDepth) + { + if (static_cast(book_.get()) != + static_cast(&otherBook)) + { + maxDepth = std::min + ONIXS_CME_MDP3_MACRO_ABUSER ( + maxDepth, otherBook.depth()); + + prepareForCapacity(maxDepth); + + copyBook(*book_, otherBook, maxDepth); + } + + return *this; + } + + /// Re-initializes snapshot as compatible + /// copy of the other instance with ability to + /// limit number of layers to be copied. + template + < + class OtherBook + > + This& + assign( + const BookSnapshot& other, + MarketDepth maxDepth = MarketDepthTraits::MaxDepth) + { + return assign(other.book(), maxDepth); + } + + private: + // Security id. + std::auto_ptr book_; + + void + prepareForCapacity( + MarketDepth requiredCapacity) + { + if (!book_.get() + || + requiredCapacity > + book_->bids().capacity() + || + requiredCapacity > + book_->asks().capacity()) + { + book_.reset( + Book::construct( + requiredCapacity)); + } + } + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/BookUpdateListeners.h b/linux/include/OnixS/CME/MDP3/BookUpdateListeners.h new file mode 100755 index 000000000..ed26153e0 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/BookUpdateListeners.h @@ -0,0 +1,107 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/Types.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + // Forward declaration. + ONIXS_CME_MDP3_API_DECL(class, DirectBook); + ONIXS_CME_MDP3_API_DECL(class, ImpliedBook); + ONIXS_CME_MDP3_API_DECL(class, ConsolidatedBook); + + /// Direct order book update listener. + class + ONIXS_CME_MDP3_API + DirectBookUpdateListener + { + public: + /// Is called when the direct book is updated. + /// + /// In compare to the change reported through 'DirectBookChangeListener' + /// interface, update represents a complex operation and usually consists + /// of multiple changes. Also, books reported via 'DirectBookUpdateListener' + /// interface are always in a valid state, whereas atomic change may + /// invalidate book until subsequent change. + virtual + void + onDirectBookUpdated( + const DirectBook& book, + const ChannelId& channelId) = 0; + + protected: + virtual ~DirectBookUpdateListener(); + }; + + /// Implied order book update listener. + class + ONIXS_CME_MDP3_API + ImpliedBookUpdateListener + { + public: + /// Is called when the implied book is updated. + /// + /// In compare to the change reported through 'ImpliedBookChangeListener' + /// interface, update represents a complex operation and usually consists + /// of multiple changes. Also, books reported via 'ImpliedBookUpdateListener' + /// interface are always in a valid state, whereas atomic change may + /// invalidate book until subsequent change. + virtual + void + onImpliedBookUpdated( + const ImpliedBook& book, + const ChannelId& channelId) = 0; + + protected: + virtual ~ImpliedBookUpdateListener(); + }; + + /// Consolidated order book update listener. + class + ONIXS_CME_MDP3_API + ConsolidatedBookUpdateListener + { + public: + /// Is called when the consolidated book is updated. + /// + /// In compare to the change reported through + /// 'ConsolidatedBookChangeListener' interface, + /// update represents a complex operation and + /// usually consists of multiple changes. Also, + /// books reported via 'ConsolidatedBookUpdateListener' + /// interface are always in a valid state, + /// whereas atomic change may invalidate + /// book until subsequent change. + virtual + void + onConsolidatedBookUpdated( + const ConsolidatedBook& book, + const ChannelId& channelId) = 0; + + protected: + virtual ~ConsolidatedBookUpdateListener(); + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/Config.h b/linux/include/OnixS/CME/MDP3/Config.h new file mode 100755 index 000000000..0a86b71f0 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/Config.h @@ -0,0 +1,24 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/ABI.h" + +// Use same namespace as for MDP2. +// #define ONIXS_CME_MDP3_USE_COMMON_NAMESPACE diff --git a/linux/include/OnixS/CME/MDP3/ConsolidatedBook.h b/linux/include/OnixS/CME/MDP3/ConsolidatedBook.h new file mode 100755 index 000000000..6cc9938cb --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/ConsolidatedBook.h @@ -0,0 +1,132 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/DirectBook.h" +#include "OnixS/CME/MDP3/ImpliedBook.h" +#include "OnixS/CME/MDP3/ConsolidatedPriceLevel.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { +#if defined (_MSC_VER) + + template + class + ONIXS_CME_MDP3_API + ArrayRef + < + ConsolidatedPriceLevel, + MarketDepth + >; + + template + class + ONIXS_CME_MDP3_API + VectorOverArray + < + ConsolidatedPriceLevel, + MarketDepth + >; + + template + class + ONIXS_CME_MDP3_API + BookBase; + +#endif + + typedef + BookBase + ConsolidatedBookBase; + + /// Consolidated Order Book. + /// + /// A set of bid prices and ask prices for the given + /// security (bids are descending and asks are ascending). + /// The quantity is provided at each price level. + /// + /// In addition to regular book interface, provides access + /// to detailed consolidated price level data like direct + /// and implied quantity components. + class + ONIXS_CME_MDP3_API + ConsolidatedBook + : public ConsolidatedBookBase + { + public: + /// Returns direct book for a given security. + const DirectBook& direct() const + { + return direct_; + } + + /// Returns implied book for a given security. + const ImpliedBook& implied() const + { + return implied_; + } + + /// Returns brief book info. + std::string brief() const + { + std::string str; + brief(str); + return str; + } + + /// Returns brief book info. + void brief(std::string&) const; + + /// String presentation of the book. + std::string toString() const + { + std::string str; + toString(str); + return str; + } + + /// String presentation of the book. + void toString(std::string&) const; + + protected: + /// Initializes book with given features. + ConsolidatedBook( + const DirectBook&, + const ImpliedBook&, + const EditablePriceLevelsRef&, + const EditablePriceLevelsRef&); + + ~ConsolidatedBook(); + + private: + const DirectBook& direct_; + const ImpliedBook& implied_; + }; + + typedef + ImpliedBookSnapshot + ConsolidatedBookSnapshot; + + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/ConsolidatedPriceLevel.h b/linux/include/OnixS/CME/MDP3/ConsolidatedPriceLevel.h new file mode 100755 index 000000000..87be82a26 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/ConsolidatedPriceLevel.h @@ -0,0 +1,184 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/ImpliedPriceLevel.h" +#include "OnixS/CME/MDP3/DirectPriceLevel.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + /// Price level data attributes of bid + /// or ask of consolidated order book. + /// + /// Instance exposes consolidated price + /// level data as well as provides references + /// to price level from direct and implied order + /// books which comply consolidated price level. + class + ONIXS_CME_MDP3_API + ConsolidatedPriceLevel + { + public: + /// Initializes instance indicating + /// absence of consolidated data. + ConsolidatedPriceLevel() + : direct_(&unexistent_), + implied_(&unexistent_) + { + } + + /// Initializes instance from direct price level only. + ConsolidatedPriceLevel(const DirectPriceLevel& direct) + : direct_(&direct), + implied_(&unexistent_) + { + } + + /// Initializes instance from implied price level only. + ConsolidatedPriceLevel(const ImpliedPriceLevel& implied) + : direct_(&unexistent_), + implied_(&implied) + { + } + + /// Initializes instance from both direct and implied price levels. + ConsolidatedPriceLevel(const DirectPriceLevel& direct, + const ImpliedPriceLevel& implied) + : direct_(&direct), + implied_(&implied) + { + } + + /// Initializes instance as copy of the other one. + ConsolidatedPriceLevel( + const ConsolidatedPriceLevel& other) + : direct_(other.direct_), implied_(other.implied_) + { + } + + /// Cleans instance up. + ~ConsolidatedPriceLevel() + { + } + + /// Indicates whether instance has a valid data + /// and actually exists at the level accessed. + bool exist() const + { + return direct_->exist() || implied_->exist(); + } + + /// Reference to price level from direct + /// book consolidated into given instance. + /// + /// Use 'exist' member of returned reference + /// to check whether returned instance refers + /// to a valid data or there were no corresponding + /// level available in direct book. + const DirectPriceLevel& direct() const + { + return *direct_; + } + + /// Consolidates direct price level data part. + void consolidate(const DirectPriceLevel& direct) + { + direct_ = &direct; + } + + /// Reference to price level from implied + /// book consolidated into given instance. + /// + /// Use 'exist' member of returned reference + /// to check whether returned instance refers + /// to a valid data or there were no corresponding + /// level available in implied book. + const ImpliedPriceLevel& implied() const + { + return *implied_; + } + + /// Consolidates implied price level data part. + void consolidate(const ImpliedPriceLevel& implied) + { + implied_ = &implied; + } + + /// Price component. + const Price& price() const + { + return ( + direct_->exist() + ? direct_->price() + : implied_->price()); + } + + /// Quantity component. + SignedQuantity quantity() const + { + return ( + direct_->quantity() + + implied_->quantity()); + } + + /// Casts instance to implied price level. + operator ImpliedPriceLevel() const + { + if (direct_->exist()) + { + return ImpliedPriceLevel( + direct_->price(), quantity()); + } + else + { + return *implied_; + } + } + + /// Re-initializes instance as copy of other one. + ConsolidatedPriceLevel& + operator =( + const ConsolidatedPriceLevel& other) + { + direct_ = other.direct_; + implied_ = other.implied_; + + return *this; + } + + /// Builds text presentation of price level. + std::string toString() const; + + /// Builds text presentation of price level. + void toString(std::string&) const; + + private: + const DirectPriceLevel* direct_; + const ImpliedPriceLevel* implied_; + + static const DirectPriceLevel unexistent_; + }; + + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/DirectBook.h b/linux/include/OnixS/CME/MDP3/DirectBook.h new file mode 100755 index 000000000..fcac951ee --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/DirectBook.h @@ -0,0 +1,139 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/BookBase.h" +#include "OnixS/CME/MDP3/BookSnapshot.h" +#include "OnixS/CME/MDP3/DirectPriceLevel.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { +#if defined (_MSC_VER) + + template + class + ONIXS_CME_MDP3_API + ArrayRef + < + DirectPriceLevel, + MarketDepth + >; + + template + class + ONIXS_CME_MDP3_API + VectorOverArray + < + DirectPriceLevel, + MarketDepth + >; + + template + class + ONIXS_CME_MDP3_API + BookBase; + +#endif + + typedef + BookBase + DirectBookBase; + + /// Direct order book. + class + ONIXS_CME_MDP3_API + DirectBook + : public DirectBookBase + { + public: + /// Disposes allocated resources. + ~DirectBook() + { + } + + /// Returns brief information on given book. + std::string + brief() const + { + std::string str; + + brief(str); + + return str; + } + + /// Brief information on given book. + void brief(std::string&) const; + + /// String presentation of the book. + std::string + toString() const + { + std::string str; + + toString(str); + + return str; + } + + /// String presentation of the book. + void toString(std::string&) const; + + /// Constructs book of given capacity. + static DirectBook* construct(MarketDepth maxDepth); + + /// Disposes previously constructed instance. + void operator delete(void* block); + + protected: + /// Initializes instance as base does. + DirectBook( + SecurityId id, + MarketDepth depth, + const EditablePriceLevelsRef& bids, + const EditablePriceLevelsRef& asks) + : DirectBookBase(id, depth, bids, asks) + { + } + }; + +#if defined (_MSC_VER) + + template + class + ONIXS_CME_MDP3_API + std::auto_ptr; + + template + class + ONIXS_CME_MDP3_API + BookSnapshot; + +#endif + + typedef + BookSnapshot + DirectBookSnapshot; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/DirectBookChange.h b/linux/include/OnixS/CME/MDP3/DirectBookChange.h new file mode 100755 index 000000000..2447271b3 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/DirectBookChange.h @@ -0,0 +1,150 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/BookChangeBase.h" +#include "OnixS/CME/MDP3/DirectPriceLevel.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { +#if defined (_MSC_VER) + + template + class + ONIXS_CME_MDP3_API + BookChangeBase; + +#endif + + template <> + inline + bool BookChangeBase::extract( + const GroupInstance& entry, + DirectPriceLevel& level) + { + const bool hasPrice = getDecimal( + entry, Tags::MDEntryPx, level.price()); + + const bool hasSize = getNumber( + entry, Tags::MDEntrySize, level.quantity()); + + const bool hasOrders = getNumber( + entry, Tags::NumberOfOrders, level.numberOfOrders()); + + return hasPrice || hasSize || hasOrders; + } + + typedef + BookChangeBase + DirectBookChangeBase; + + /// Order book change. + /// + /// @see DirectBookChangeListener. + class + ONIXS_CME_MDP3_API + DirectBookChange + : public DirectBookChangeBase + { + public: + /// Provides access to price component if exists. + /// @return 'true' if price component is available. + bool + price( + Price& price) const + { + if ( + priceLevelData() && + priceLevelData()->exist()) + { + price = priceLevelData()->price(); + + return true; + } + + return getDecimal(marketDataEntry(), Tags::MDEntryPx, price); + } + + /// Provides access to quantity component if exists. + /// @return 'true' if quantity component is available. + bool + quantity( + SignedQuantity& quantity) const + { + if ( + priceLevelData() && + priceLevelData()->exist()) + { + quantity = priceLevelData()->quantity(); + + return true; + } + + return getNumber(marketDataEntry(), Tags::MDEntrySize, quantity); + } + + /// Provides access to number of orders component if exists. + /// @return 'true' if number of orders component is available. + bool + numberOfOrders( + Quantity& numberOfOrders) const + { + if ( + priceLevelData() && + priceLevelData()->exist()) + { + numberOfOrders = + priceLevelData()->numberOfOrders(); + + return true; + } + + return getNumber(marketDataEntry(), Tags::NumberOfOrders, numberOfOrders); + } + + /// Returns the text representation. + std::string toString() const + { + std::string str; + + toString(str); + + return str; + } + + /// Appends the text representation. + void toString(std::string&) const; + + protected: + DirectBookChange( + SecurityId id, + const GroupInstance& entry) + : DirectBookChangeBase( + id, + entry) + { + } + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/DirectPriceLevel.h b/linux/include/OnixS/CME/MDP3/DirectPriceLevel.h new file mode 100755 index 000000000..edec90296 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/DirectPriceLevel.h @@ -0,0 +1,113 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/ImpliedPriceLevel.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + /// Encapsulates price level concept. + class + ONIXS_CME_MDP3_API + DirectPriceLevel + : public ImpliedPriceLevel + { + public: + /// Initializes undefined level. + DirectPriceLevel() + : ordersQty_(0) + { + } + + /// Initializes as copy of other level. + DirectPriceLevel( + const DirectPriceLevel& other) + : ImpliedPriceLevel( + static_cast + + (other)), + ordersQty_( + other.ordersQty_) + { + } + + /// Initializes defined level + /// according to specified attributes. + DirectPriceLevel( + const Price& price, + SignedQuantity qty, + Quantity ordersQty) + : ImpliedPriceLevel(price, qty), + ordersQty_(ordersQty) + { + } + + // Actually, does nothing. + ~DirectPriceLevel() + { + } + + /// Updates total number of orders. + Quantity& numberOfOrders() + { + return ordersQty_; + } + + /// Total number of orders of given price. + Quantity numberOfOrders() const + { + return ordersQty_; + } + + /// Returns string representation of the instance. + std::string toString() const + { + std::string str; + + toString(str); + + return str; + } + + /// Appends representation of the instance to the string. + void toString(std::string&) const; + + // Re-initializes as copy of other instance. + DirectPriceLevel& + operator =( + const DirectPriceLevel& other) + { + *static_cast(this) = + static_cast(other); + + ordersQty_ = other.ordersQty_; + + return *this; + } + + private: + Quantity ordersQty_; + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/Error.h b/linux/include/OnixS/CME/MDP3/Error.h new file mode 100755 index 000000000..e883c8c7f --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/Error.h @@ -0,0 +1,157 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/ABI.h" +#include "OnixS/CME/MDP3/Types.h" + +namespace std +{ + ONIXS_CME_MDP3_API_DECL(class, exception); +} + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + /// List of known errors. + struct ONIXS_CME_MDP3_API KnownErrors + { + /// List of known errors. + enum Enum + { + /// Indicates absence of error. + Nothing, + + /// Error has generic nature. + Generic, + + /// Product is not licensed. + NotLicensed, + + /// Handler configuration is invalid. + BadConfiguration, + + /// Network packet received by the Handler is corrupted. + BadPacket, + + /// FIX message has invalid structure. + /// E.g. misses some of required fields. + BadMessage + }; + + /// Returns string presentation of value. + static const char* toString(Enum value); + }; + + /// Error code. + typedef KnownErrors::Enum ErrorCode; + + /// Error. + class + ONIXS_CME_MDP3_THROWABLE_API + Error : public std::exception + { + public: + /// Initializes instance with just a code. + Error( + const std::string& source, + ErrorCode code); + + /// Initializes instance with code and description. + Error( + const std::string& source, + ErrorCode code, + const std::string& description); + + /// Initializes as clone of another error. + Error(const Error& other); + + /// Destruction interface. + virtual ~Error() throw(); + + /// Code of error. + ErrorCode code() const + { + return code_; + } + + /// Human readable description of error. + const char* description() const + { + return description_; + } + + /// Origin of the error. + const char* source() const + { + return source_; + } + + /// Human readable description of error. + virtual const char* what() const throw(); + + /// String presentation of an error. + std::string toString() const + { + std::string str; + toString(str); + return str; + } + + /// Appends presentation of an error to the string. + void toString(std::string&) const; + + /// Copies error attributes from another instance. + Error& operator =(const Error& other); + + private: + enum Traits + { + SourceMaxLength = 128, + DescriptionMaxLength = 1024 + }; + + ErrorCode code_; + char source_[SourceMaxLength + 1]; + char description_[DescriptionMaxLength + 1]; + }; + + /// Error listener. + class + ONIXS_CME_MDP3_API + ErrorListener + { + public: + /// Is called when an error is detected + /// during the processing of the market data. + virtual + void + onError( + const Error& error, + const ChannelId& channelId) = 0; + + protected: + virtual ~ErrorListener(); + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/EventIndicator.h b/linux/include/OnixS/CME/MDP3/EventIndicator.h new file mode 100755 index 000000000..28937ebc7 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/EventIndicator.h @@ -0,0 +1,141 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/Types.h" +#include "OnixS/CME/MDP3/Tags.h" +#include "OnixS/CME/MDP3/Messaging.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + /// Indicates miscellaneous market data events signaled by MDP. + class + ONIXS_CME_MDP3_API + EventIndicator: BitmapField + { + public: + + /// Initializes from FIX message containing + /// MatchEventIndicator (tag 5799) field. + EventIndicator( + const Message& source) + : BitmapField(source, Tags::MatchEventIndicator) + { + } + + /// Indicates 'end of trades' event. + bool + endOfTrades() const + { + return state(Bits::EndOfTrades); + } + + /// Indicates 'end of electronic volumes' event. + bool + endOfElectronicVolumes() const + { + return state(Bits::EndOfElectronicVolumes); + } + + /// Indicates 'end of real quotes' + /// ('end of direct book changes') event. + bool + endOfRealQuotes() const + { + return state(Bits::EndOfRealQuotes); + } + + /// Indicates 'end of statistics' event. + bool + endOfStatistic() const + { + return state(Bits::EndOfStatistic); + } + + /// Indicates 'end of implied quotes' + /// ('end of implied book changes') event. + bool + endOfImpliedQuotes() const + { + return state(Bits::EndOfImpliedQuotes); + } + + /// Indicates 'message resent during recovery' event. + bool + messageRecovered() const + { + return state(Bits::MessageRecovered); + } + + /// Indicates 'end of event' event. + bool + endOfEvent() const + { + return state(Bits::EndOfEvent); + } + + /// Indicates any 'end of' event. + bool + endOfAny() const + { + return any() && + !state(Bits::MessageRecovered) && + !state(Bits::Reserved); + } + + /// Builds text presentation. + std::string + toString() const + { + std::string str; + + toString(str); + + return str; + } + + /// Builds text presentation. + void + toString(std::string&) const; + + private: + + struct Bits + { + enum Enum + { + EndOfTrades = 0, + EndOfElectronicVolumes = 1, + EndOfRealQuotes = 2, + EndOfStatistic = 3, + EndOfImpliedQuotes = 4, + MessageRecovered = 5, + Reserved = 6, + EndOfEvent = 7 + }; + }; + + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/EventListener.h b/linux/include/OnixS/CME/MDP3/EventListener.h new file mode 100755 index 000000000..28d169541 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/EventListener.h @@ -0,0 +1,87 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/Types.h" +#include "OnixS/CME/MDP3/Messaging.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + /// Listener for market event and sub-events. + class + ONIXS_CME_MDP3_API + EventListener + { + public: + /// Invoked at the end of processing a message + /// containing 'End Of Trades' event indicator. + virtual + void + onEndOfTrade( + const ChannelId& id) = 0; + + /// Invoked at the end of processing a message + /// containing 'End Of Electronic Volumes' event + /// indicator. + virtual + void + onEndOfElectronicVolume( + const ChannelId& id) = 0; + + /// Invoked at the end of processing a message + /// containing 'End Of Real Quotes' market event + // indicator. + virtual + void + onEndOfRealQuote( + const ChannelId& id) = 0; + + /// Invoked at the end of processing a message + /// containing 'End Of Implied Quotes' market event + // indicator. + virtual + void + onEndOfImpliedQuote( + const ChannelId& id) = 0; + + /// Invoked at the end of processing a message + /// containing 'End Of Statistic' market event + // indicator. + virtual + void + onEndOfStatistic( + const ChannelId& id) = 0; + + /// Invoked at the end of processing a message + /// containing 'End Of Event' market event indicator. + virtual + void + onEndOfEvent( + const ChannelId& id) = 0; + + protected: + virtual ~EventListener(); + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/EventMessageListener.h b/linux/include/OnixS/CME/MDP3/EventMessageListener.h new file mode 100755 index 000000000..0917e394e --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/EventMessageListener.h @@ -0,0 +1,96 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/Types.h" +#include "OnixS/CME/MDP3/Messaging.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + /// Listener for market event and sub-events + /// with relation to message processing. + class + ONIXS_CME_MDP3_API + EventMessageListener + { + public: + /// Invoked when Handler starts processing + /// incoming message containing 'End Of Trades' + /// flag in event indicator. + virtual + void + onLastTradeMessage( + const Message& message, + const ChannelId& id) = 0; + + /// Invoked when Handler starts processing + /// incoming message containing 'End Of Electronic + /// Volumes' flag in event indicator. + virtual + void + onLastElectronicVolumeMessage( + const Message& message, + const ChannelId& id) = 0; + + /// Invoked when Handler starts processing + /// incoming message containing 'End Of Real + /// Quotes' flag in event indicator. + virtual + void + onLastRealQuoteMessage( + const Message& message, + const ChannelId& id) = 0; + + /// Invoked when Handler starts processing + /// incoming message containing 'End Of Implied + /// Quotes' flag in event indicator. + virtual + void + onLastImpliedQuoteMessage( + const Message& message, + const ChannelId& id) = 0; + + /// Invoked when Handler starts processing + /// incoming message containing 'End Of Statistic' + /// flag in event indicator. + virtual + void + onLastStatisticMessage( + const Message& message, + const ChannelId& id) = 0; + + /// Invoked when Handler starts processing + /// incoming message containing 'End Of Event' + /// flag in event indicator. + virtual + void + onLastEventMessage( + const Message& message, + const ChannelId& id) = 0; + + protected: + virtual ~EventMessageListener(); + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/FeedEngine.h b/linux/include/OnixS/CME/MDP3/FeedEngine.h new file mode 100755 index 000000000..9781fe61b --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/FeedEngine.h @@ -0,0 +1,240 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include + +#include "OnixS/CME/MDP3/Types.h" +#include "OnixS/CME/MDP3/ThreadAffinity.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + ONIXS_CME_MDP3_API_DECL(class, FeedEngine); + + /// Collection of settings affecting Feed Engine behavior. + struct + ONIXS_CME_MDP3_API + FeedEngineSettings + { + /// Number of working threads to be used by feed engine. + /// @note Default value is '1'. + unsigned int threadsCount() const + { + return threadsCount_; + } + + /// Sets threadsCount. @see threadsCount. + void threadsCount(unsigned int value) + { + threadsCount_ = value; + } + + /// Defines set of CPUs by their indices (starting from zero) + /// allowed for each thread used by the Handler while processing + /// market data to be executed on. + /// + /// @note By default set is empty thus allowing threads + /// to be executed on any CPU available in the system. + const ThreadAffinity& threadsAffinity() const + { + return threadsAffinity_; + } + + /// @see threadsAffinity. + ThreadAffinity& threadsAffinity() + { + return threadsAffinity_; + } + + /// Defines amount of time Feed Engine spends on socket + /// waiting for I/O while running master processing loop. + /// + /// Time is measured in milliseconds. + /// + /// @note Default value is '10'. + /// + /// @warning Given parameter significantly affects + /// Handler's responsiveness and load onto CPU! + unsigned int dataWaitTime() const + { + return dataWaitTime_; + } + + /// Sets dataWaitTime. @see dataWaitTime. + void dataWaitTime(unsigned int value) + { + dataWaitTime_ = value; + } + + /// Defines amount of time Feed Engine keeps cycling before + /// going to sleep when no useful activity can be done. + /// + /// Time is measured in milliseconds. + /// + /// @note Default value is '1'. + /// + /// @warning Given parameter has direct influence onto CPU load! + unsigned int redundancySpinTime() const + { + return redundancySpinTime_; + } + + /// Sets redundancySpinTime. @see redundancySpinTime. + void redundancySpinTime(unsigned int value) + { + redundancySpinTime_ = value; + } + + /// Initializes default settings. + FeedEngineSettings(); + + /// Cleans everything up. + ~FeedEngineSettings(); + + /// Returns textual presentation. + std::string toString() const + { + std::string str; + toString(str); + return str; + } + + /// Returns textual presentation. + void toString(std::string&) const; + + private: + unsigned int threadsCount_; + ThreadAffinity threadsAffinity_; + unsigned int dataWaitTime_; + unsigned int redundancySpinTime_; + }; + + /// Identifies reasons feed engine threads becomes idle. + struct + ONIXS_CME_MDP3_API + FeedEngineThreadIdleReasons + { + enum Enum + { + /// Thread waited for incoming data using corresponding + /// I/O operations (like 'select') and exited waiting with + /// no data availability signs. + DataWaitTimeout, + + /// Thread entered idle state due to absence of any data and + /// while other threads are waiting for new incoming data. + Redundant + }; + }; + + /// Alias for feed engine thread idle reason. + typedef + FeedEngineThreadIdleReasons::Enum + FeedEngineThreadIdleReason; + + /// Listener for thread-related events. + /// + /// Members of this classes are invoked to reflect + /// various life-time events of threads spawned and + /// used by the feed engine while processing market data. + class + ONIXS_CME_MDP3_API + FeedEngineListener + { + public: + /// Member invoked by feed engine when + /// a new processing thread is spawned. + /// + /// @note Invocation is done within newly + /// started thread. + virtual + void + onFeedEngineThreadBegin( + const FeedEngine& source) = 0; + + /// Member is invoked by feed engine when + /// processing thread is about to end. + /// + /// @note Invocation is done within the + /// thread that is about to end. + virtual + void + onFeedEngineThreadEnd( + const FeedEngine& source) = 0; + + /// Is called when feed engine's thread is idle. + /// + /// Thread becomes idle when either no data is received within + /// time interval defined by FeedEngineSettings::dataWaitTime + /// parameter or no pending data is available for processing. + /// In the first case, callback is invoked with 'DataWaitTimeout' + /// reason. In the second case, thread is considered as redundant + /// and thus callback is invoked with 'Redundant' reason. + /// After callback invocation threads may sleep in kernel to reduce + /// load onto CPU and racing between feed engine working threads. + /// + /// @param source Identifies source engine instance going idle. + /// + /// @param reason Identifies reason of thread idle state. + /// + /// @param suggestedSleepTime defines amount of time feed engine suggest + /// for thread to sleep in kernel after invoking given member. + virtual + void + onFeedEngineThreadIdle( + const FeedEngine& source, + FeedEngineThreadIdleReason reason, + UInt32& suggestedSleepTime) = 0; + + protected: + virtual ~FeedEngineListener(); + }; + + /// Manages processing machinery for + /// market data received from feeds. + class + ONIXS_CME_MDP3_API + FeedEngine + { + public: + class Implementation; + + /// Initializes engine with given configuration. + FeedEngine( + const FeedEngineSettings&, + FeedEngineListener* = NULL); + + /// Destructs given instance. + ~FeedEngine(); + + private: + friend class Implementation; + + Implementation* impl_; + + FeedEngine(const FeedEngine&); + FeedEngine& operator =(const FeedEngine&); + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/FeedEnums.h b/linux/include/OnixS/CME/MDP3/FeedEnums.h new file mode 100755 index 000000000..b28c4f7da --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/FeedEnums.h @@ -0,0 +1,184 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include + +#include "OnixS/CME/MDP3/Config.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + /// Feed types basing on market data kind. + struct + ONIXS_CME_MDP3_API + FeedTypes + { + enum Enum + { + /// Identifies unknown type. + Unknown, + + /// TCP Replay. + Historical, + + /// Incremental/real-time. + Incremental, + + /// Instrument recovery. + Instrument, + + /// Recovery from snapshots. + Snapshot, + + /// Recovery from snapshots for MBO. + SnapshotMbo + }; + + /// Transforms string presentation into type. + static Enum deserialize(const char*); + + /// Returns string presentation of type. + static const char* toString(Enum); + }; + + /// Alias for feed type. + typedef + FeedTypes::Enum + FeedType; + + /// Feed roles (primary, secondary). + struct + ONIXS_CME_MDP3_API + FeedRoles + { + /// List of known feed roles. + enum Enum + { + /// Identifies surely unknown role. + Unknown = '*', + + /// Identifies primary feed (A). + A = 'A', + + /// Identifies secondary feed (B). + B = 'B' + }; + + /// Builds string presentation. + static + std::string + toString(Enum value) + { + return std::string(1, static_cast(value)); + } + }; + + typedef + FeedRoles::Enum + FeedRole; + + /// Defines feed layout alternates available for + /// recovery feeds like instrument and snapshot. + struct + ONIXS_CME_MDP3_API + RecoveryFeedLayout + { + enum Enum + { + /// Indicates only feed A is used as source for market data. + FeedAOnly, + + /// Indicates only feed B is used as source for market data. + FeedBOnly, + + /// Feed A is used as primary source of market data. If Handler + /// detects absense of market data on feed A, it switches to + /// feed B to continue market data processing. Feed B is used + /// by Handler until market data absense is detected on it. In + /// that case Handler will switch back to feed A. In other words, + /// this layout instructs Handler to cycle between feeds if data + /// absense is detected starting from feed A. + FeedAWithFailoverToFeedB, + + /// Feed B is used as primary source of market data. If Handler + /// detects absense of market data on feed B, it switches to + /// feed A to continue market data processing. Feed A is used + /// by Handler until market data absense is detected on it. In + /// that case Handler will switch back to feed B. In other words, + /// this layout instructs Handler to cycle between feeds if data + /// absense is detected starting from feed B. + FeedBWithFailoverToFeedA + }; + + /// Transforms string presentation into type. + static Enum deserialize(const char*); + + /// Returns string presentation of type. + static const char* toString(Enum); + }; + + /// Defines feed layout alternates available + /// for realtime feed like incremental one. + struct + ONIXS_CME_MDP3_API + RealtimeFeedLayout + { + enum Enum + { + /// Indicates only feed A is used as source for market data. + FeedAOnly, + + /// Indicates only feed B is used as source for market data. + FeedBOnly, + + /// Feed A is used as primary source of market data. If Handler + /// detects absense of market data on feed A, it switches to + /// feed B to continue market data processing. Feed B is used + /// by Handler until market data absense is detected on it. In + /// that case Handler will switch back to feed A. In other words, + /// this layout instructs Handler to cycle between feeds if data + /// absense is detected starting from feed A. + FeedAWithFailoverToFeedB, + + /// Feed B is used as primary source of market data. If Handler + /// detects absense of market data on feed B, it switches to + /// feed A to continue market data processing. Feed A is used + /// by Handler until market data absense is detected on it. In + /// that case Handler will switch back to feed B. In other words, + /// this layout instructs Handler to cycle between feeds if data + /// absense is detected starting from feed B. + FeedBWithFailoverToFeedA, + + /// Handler arbitrates between both feeds A and B. + BothFeedsWithArbitrage + }; + + /// Transforms string presentation into type. + static Enum deserialize(const char*); + + /// Returns string presentation of type. + static const char* toString(Enum); + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/FeedListener.h b/linux/include/OnixS/CME/MDP3/FeedListener.h new file mode 100755 index 000000000..0dcb5885a --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/FeedListener.h @@ -0,0 +1,115 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/Types.h" +#include "OnixS/CME/MDP3/FeedEnums.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + /// Wraps operations over feed socket handle. + class + ONIXS_CME_MDP3_API + FeedSocket + { + public: + /// Initializes instance. + FeedSocket(int handle); + + /// Does nothing. + ~FeedSocket(); + + /// Provides access to socket option. + /// @return result of socket API call. + int + getOption( + int level, + int option, + void* optionValue, + int& optionValueSize); + + /// Updates socket option. + /// @return result of socket API call. + int + setOption( + int level, + int option, + const void* optionValue, + int optionValueSize); + + private: + int handle_; + + FeedSocket(const FeedSocket&); + FeedSocket& operator =(const FeedSocket&); + }; + + /// Listener for feed-related events. + class + ONIXS_CME_MDP3_API + FeedListener + { + public: + /// Invoked when Handler establishes connectivity + /// to be able receive market data from given feed + /// identified by type and role. + virtual + void + onFeedJoin( + FeedSocket&, + FeedType, + FeedRole, + const ChannelId&) = 0; + + /// Invoked when Handler is about to terminate + /// connectivity related with market data receiving + /// from given feed identified by type and role. + virtual + void + onFeedDrop( + FeedSocket&, + FeedType, + FeedRole, + const ChannelId&) = 0; + + /// Invoked when Handler detected packet + /// sequence issues (missed or out-of-order sequence numbers) + /// with market data receiving from given feed + /// identified by type and role. + /// + /// @note Numeric parameter gives the number of issues since + /// last callback call (or feed activation for first call). + virtual + void + onFeedSequenceIssues( + FeedType, + FeedRole, + size_t, + const ChannelId&) = 0; + + protected: + virtual ~FeedListener(); + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/Handler.h b/linux/include/OnixS/CME/MDP3/Handler.h new file mode 100755 index 000000000..ba95b6341 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/Handler.h @@ -0,0 +1,859 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include +#include + +#include "OnixS/CME/MDP3/Types.h" +#include "OnixS/CME/MDP3/BBA.h" +#include "OnixS/CME/MDP3/DirectBook.h" +#include "OnixS/CME/MDP3/ImpliedBook.h" +#include "OnixS/CME/MDP3/ConsolidatedBook.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + ONIXS_CME_MDP3_API_DECL(struct, HandlerSettings); + ONIXS_CME_MDP3_API_DECL(struct, ReplayOptions); + + ONIXS_CME_MDP3_API_DECL(struct, DirectBestBidAskTrackingOptions); + ONIXS_CME_MDP3_API_DECL(struct, ImpliedBestBidAskTrackingOptions); + + ONIXS_CME_MDP3_API_DECL(class, DirectBookChangeListener); + ONIXS_CME_MDP3_API_DECL(class, ImpliedBookChangeListener); + ONIXS_CME_MDP3_API_DECL(class, DirectBookUpdateListener); + ONIXS_CME_MDP3_API_DECL(class, ImpliedBookUpdateListener); + ONIXS_CME_MDP3_API_DECL(class, ConsolidatedBookUpdateListener); + ONIXS_CME_MDP3_API_DECL(class, ErrorListener); + ONIXS_CME_MDP3_API_DECL(class, WarningListener); + ONIXS_CME_MDP3_API_DECL(class, HandlerStateChangeListener); + ONIXS_CME_MDP3_API_DECL(class, MessageProcessingListener); + ONIXS_CME_MDP3_API_DECL(class, SecurityDefinitionListener); + ONIXS_CME_MDP3_API_DECL(class, StatisticsListener); + ONIXS_CME_MDP3_API_DECL(class, SecurityStatusListener); + ONIXS_CME_MDP3_API_DECL(class, TradeListener); + ONIXS_CME_MDP3_API_DECL(class, OrderIdListener); + ONIXS_CME_MDP3_API_DECL(class, ElectronicVolumeListener); + ONIXS_CME_MDP3_API_DECL(class, RequestForQuoteListener); + ONIXS_CME_MDP3_API_DECL(class, FeedEngineListener); + ONIXS_CME_MDP3_API_DECL(class, EventMessageListener); + ONIXS_CME_MDP3_API_DECL(class, EventListener); + ONIXS_CME_MDP3_API_DECL(class, FeedListener); + + ONIXS_CME_MDP3_API_DECL(class, Timestamp); + ONIXS_CME_MDP3_API_DECL(class, FeedEngine); + ONIXS_CME_MDP3_API_DECL(class, TcpRecoveryService); + ONIXS_CME_MDP3_API_DECL(class, AsyncLogService); + + /// Export/Import template instantiations. + struct + ONIXS_CME_MDP3_API + FilteringTraits + { + typedef + std::set + SecurityIdFilters; + + typedef + std::set + TextFilters; + }; + + typedef + FilteringTraits::SecurityIdFilters + SecurityIdFilters; + + typedef + FilteringTraits::TextFilters + SecuritySymbolFilters; + + typedef + FilteringTraits::TextFilters + SecurityGroupFilters; + + typedef + FilteringTraits::TextFilters + SecurityAssetFilters; + + /// Set of options affecting behavior of the Handler + /// while maintaining order books by natural refresh. + struct + ONIXS_CME_MDP3_API + NaturalRefreshOptions + { + /// Makes Handler to use Instrument Definition Replay + /// Feed for security definitions recovery. + /// + /// @note Default value is 'true'. + bool useInstrumentFeed() const + { + return useInstrumentFeed_; + } + + /// Sets useInstrumentFeed. @see useInstrumentFeed. + void useInstrumentFeed(bool value) + { + useInstrumentFeed_ = value; + } + + /// Path to file containing instrument definitions. + /// + /// Data (instrument definitions) accepted in format + /// as it's defined by CME (secdef.dat). + /// + /// @note This setting is ignored if + /// NaturalRefreshOptions::useInstrumentFeed() set to true. + /// + /// @warning CME strongly discourages usage of secdef.dat in + /// production, it's considered legacy feature. Please avoid + /// its usage if possible. + /// + /// If value is not specified and Intrument Feed is not used, + /// Handler starts with empty instrument definitions set. + /// This case is suitable for processing market data from the + /// beginning of weekly session, when MDP transmits + /// instrument definitions via real-time (incremental) + /// feeds. + /// + /// If market data processing using natural refresh is + /// launched at the middle of the week (late join case), + /// it's preferred to use Instrument Definition Replay Feed + /// or instrument definitions file specified (not recommended by CME) + /// because otherwise Handler will apply default values for order + /// book depths which may lead to inconsistencies in order books. + const std::string& definitionsFile() const + { + return *definitionsFile_; + } + + /// Sets definitionsFile. @see definitionsFile. + void definitionsFile(const std::string& value) + { + *definitionsFile_ = value; + } + + /// Initializes options with default values. + NaturalRefreshOptions(); + + /// Cleans everything up. + ~NaturalRefreshOptions(); + + /// Returns textual presentation. + std::string toString() const + { + std::string str; + toString(str); + return str; + } + + /// Returns textual presentation. + void toString(std::string&) const; + + private: + bool useInstrumentFeed_; + Exportable definitionsFile_; + }; + + /// Market joining strategies. + struct + ONIXS_CME_MDP3_API + HandlerStartupStrategies + { + enum Enum + { + /// Identifies early joining. + + /// For a startup prior to the weekly market open, + /// all market data including book updates, statistics, + /// quotes, instrument definitions, trades, instrument/ + /// instrument group, status) are disseminated through + /// the Incremental UDP Feed A and Feed B, so there is + /// no need to use neither Security Definition Channel + /// nor Market Data Recovery Channel. + PreOpening, + + /// Identifies late joining which causes + /// Handler to use recovery channels to get + /// up-to-date market state. + LateJoin + }; + + /// Deserializes constant from string representation. + static Enum deserialize(const char*); + + /// Returns string representation of constant. + static const char* toString(Enum); + }; + + /// Market joining strategies. + typedef + HandlerStartupStrategies::Enum + HandlerStartupStrategy; + + /// Statistics on incremental market data processing. + class + ONIXS_CME_MDP3_API + PendingMarketDataInfo + { + public: + /// Initializes blank instance. + PendingMarketDataInfo() + : bufferedPacketsCount_(0), + cachedOutOfOrderPacketsCount_(0) + { + } + + /// Number of packets already received by the Handler + /// from all incremental feeds but not yet processed. + /// + /// Handler may receive packets on a background while processing + /// already received market data to avoid overflow of socket buffers. + /// If processing is slowed down, number of buffered packets may grow. + /// Buffered packets may contain duplicates especially if both feeds + /// A and B are enabled. Packets buffering is limited to one packet + /// per feed if direct packets pulling strategy is used by the Handler. + /// See documentation on packets pulling strategies for more information. + size_t + bufferedPacketsCount() const + { + return bufferedPacketsCount_; + } + + /// Updates number of packets already received by the Handler + /// from all incremental feeds but not yet processed. + void + bufferedPacketsCount(size_t count) + { + bufferedPacketsCount_ = count; + } + + /// Number of out of order packets cached by Handler. + /// + /// When out of order packet is received or gap occurs, + /// Handler waits for a certain time to let potentially + /// missed data get received. While waiting on data, + /// packets are being cached. + size_t + cachedOutOfOrderPacketsCount() const + { + return cachedOutOfOrderPacketsCount_; + } + + /// Updates number of out of order packets cached by Handler. + void + cachedOutOfOrderPacketsCount(size_t count) + { + cachedOutOfOrderPacketsCount_ = count; + } + + /// Serializes to string presentation. + std::string toString() const + { + std::string str; + toString(str); + return str; + } + + /// Serializes to string presentation. + void toString(std::string& presentation) const; + + private: + size_t bufferedPacketsCount_; + size_t cachedOutOfOrderPacketsCount_; + }; + + /// Interface for user-defined watch service to be used by Handler. + struct + ONIXS_CME_MDP3_API + WatchService + { + /// Gets current time as Timestamp object. + virtual Timestamp now() = 0; + + /// Cleans up instance. + virtual ~WatchService() + {} + }; + + /// Encapsulates all the machinery related with market + /// data processing from CME Market Data Platform. + class + ONIXS_CME_MDP3_API + Handler + { + public: + /// Initializes instance according to given settings. + Handler(const HandlerSettings& settings); + + /// Finalizes instance usage. + ~Handler(); + + /// Adds Security Id filtering value. + /// + /// @note The filter is inclusive. + void addSecurityIdFilter(SecurityId id); + + /// Removes Security Id filter. + void removeSecurityIdFilter(SecurityId id); + + /// Removes all Security Id filters. + void removeAllSecurityIdFilters(); + + /// Fills given collection with the registered Security Id filters. + void getSecurityIdFilters(SecurityIdFilters* filters) const; + + /// Adds Security Symbol filtering value. + /// + /// @note The filter is inclusive. + void addSecuritySymbolFilter(const std::string& symbol); + + /// Removes Security Symbol filter. + void removeSecuritySymbolFilter(const std::string& symbol); + + /// Removes all Security Symbol filters. + void removeAllSecuritySymbolFilters(); + + /// Fills given collection with the registered Security Symbol filters. + void getSecuritySymbolFilters(SecuritySymbolFilters* filters) const; + + /// Adds Security Group filtering value. + /// + /// @note The filter is inclusive. + void addSecurityGroupFilter(const std::string& group); + + /// Removes Security Group filter. + void removeSecurityGroupFilter(const std::string& group); + + /// Removes all Security Group filters. + void removeAllSecurityGroupFilters(); + + /// Fills given collection with the registered Security Group filters. + void getSecurityGroupFilters(SecurityGroupFilters* filters) const; + + /// Adds Security Asset filtering value. + /// + /// @note The filter is inclusive. + void addSecurityAssetFilter(const std::string& asset); + + /// Removes Security Asset filter. + void removeSecurityAssetFilter(const std::string& asset); + + /// Removes all Security Asset filters. + void removeAllSecurityAssetFilters(); + + /// Fills given collection with the registered Security Asset filters. + void getSecurityAssetFilters(SecurityAssetFilters* filters) const; + + /// Log a debug message. + void logDebug(const std::string& message); + + /// Log an error message. + void logError(const std::string& message); + + /// Log an information message. + void logMessage(const std::string& message); + + /// Log a warning message. + void logWarning(const std::string& message); + + /// Backs up current log file without stopping the Handler. + void backupLog(); + + /// Registers the error listener. + /// + /// Only single instance of listener can be associated with + /// the Handler. Registering new listener removes previous one. + /// Listener instance lifetime shall be not less than Handler's one. + /// + /// Listeners are to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerErrorListener( + ErrorListener* listener); + + /// Registers the warning listener. + /// + /// Only single instance of listener can be associated with + /// the Handler. Registering new listener removes previous one. + /// Listener instance lifetime shall be not less than Handler's one. + /// + /// Listeners are to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerWarningListener( + WarningListener* listener); + + /// Registers the direct book change listener. + /// + /// Only single instance of listener can be associated with + /// the Handler. Registering new listener removes previous one. + /// Listener instance lifetime shall be not less than Handler's one. + /// + /// Listeners are to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerDirectBookChangeListener( + DirectBookChangeListener* listener); + + /// Registers the direct book change listener. + /// + /// Only single instance of listener can be associated with + /// the Handler. Registering new listener removes previous one. + /// Listener instance lifetime shall be not less than Handler's one. + /// + /// Listeners are to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerDirectBookChangeListener( + DirectBookChangeListener* listener, + const DirectBestBidAskTrackingOptions& bbaTrackingOptions); + + /// Registers the direct book update listener. + /// + /// Only single instance of listener can be associated with + /// the Handler. Registering new listener removes previous one. + /// Listener instance lifetime shall be not less than Handler's one. + /// + /// Listeners are to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerDirectBookUpdateListener( + DirectBookUpdateListener* listener); + + /// Registers the direct book update listener. + /// + /// Only single instance of listener can be associated with + /// the Handler. Registering new listener removes previous one. + /// Listener instance lifetime shall be not less than Handler's one. + /// + /// Listeners are to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerDirectBookUpdateListener( + DirectBookUpdateListener* listener, + const DirectBestBidAskTrackingOptions& options); + + /// Registers the implied book change listener. + /// + /// Only single instance of listener can be associated with + /// the Handler. Registering new listener removes previous one. + /// Listener instance lifetime shall be not less than Handler's one. + /// + /// Listeners are to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerImpliedBookChangeListener( + ImpliedBookChangeListener* listener); + + /// Registers the implied book change listener. + /// + /// Only single instance of listener can be associated with + /// the Handler. Registering new listener removes previous one. + /// Listener instance lifetime shall be not less than Handler's one. + /// + /// Listeners are to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerImpliedBookChangeListener( + ImpliedBookChangeListener* listener, + const ImpliedBestBidAskTrackingOptions& options); + + /// Registers the implied book update listener. + /// + /// Only single instance of listener can be associated with + /// the Handler. Registering new listener removes previous one. + /// Listener instance lifetime shall be not less than Handler's one. + /// + /// Listeners are to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerImpliedBookUpdateListener( + ImpliedBookUpdateListener* listener); + + /// Registers the implied book update listener. + /// + /// Only single instance of listener can be associated with + /// the Handler. Registering new listener removes previous one. + /// Listener instance lifetime shall be not less than Handler's one. + /// + /// Listeners are to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerImpliedBookUpdateListener( + ImpliedBookUpdateListener* listener, + const ImpliedBestBidAskTrackingOptions& options); + + /// Registers the consolidated book update listener. + /// + /// Only single instance of listener can be associated with + /// the Handler. Registering new listener removes previous one. + /// Listener instance lifetime shall be not less than Handler's one. + /// + /// Listeners are to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerConsolidatedBookUpdateListener( + ConsolidatedBookUpdateListener* listener); + + /// Registers the consolidated book update listener. + /// + /// Only single instance of listener can be associated with + /// the Handler. Registering new listener removes previous one. + /// Listener instance lifetime shall be not less than Handler's one. + /// + /// Listeners are to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerConsolidatedBookUpdateListener( + ConsolidatedBookUpdateListener* listener, + const ConsolidatedBestBidAskTrackingOptions& options); + + /// Registers the security definitions listener. + /// + /// Only single instance of listener can be associated with + /// the Handler. Registering new listener removes previous one. + /// Listener instance lifetime shall be not less than Handler's one. + /// + /// Listeners are to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerSecurityDefinitionListener( + SecurityDefinitionListener* listener); + + /// Registers the statistics listener. + /// + /// Only single instance of listener can be associated with + /// the Handler. Registering new listener removes previous one. + /// Listener instance lifetime shall be not less than Handler's one. + /// + /// Listeners are to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerStatisticsListener( + StatisticsListener* listener); + + /// Registers the security status listener. + /// + /// Only single instance of listener can be associated with + /// the Handler. Registering new listener removes previous one. + /// Listener instance lifetime shall be not less than Handler's one. + /// + /// Listeners are to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerSecurityStatusListener( + SecurityStatusListener* listener); + + /// Registers the trades listener. + /// + /// Only single instance of listener can be associated with + /// the Handler. Registering new listener removes previous one. + /// Listener instance lifetime shall be not less than Handler's one. + /// + /// Listeners are to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerTradeListener( + TradeListener* listener); + + /// Registers the Order IDs listener. + /// + /// Only single instance of listener can be associated with + /// the Handler. Registering new listener removes previous one. + /// Listener instance lifetime shall be not less than Handler's one. + /// + /// Listeners are to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerOrderIdListener( + OrderIdListener* listener); + + /// Registers the electronic volumes listener. + /// + /// Only single instance of listener can be associated with + /// the Handler. Registering new listener removes previous one. + /// Listener instance lifetime shall be not less than Handler's one. + /// + /// Listeners are to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerElectronicVolumeListener( + ElectronicVolumeListener* listener); + + /// Registers the Request For Quote listener. + /// + /// Only single instance of listener can be associated with + /// the Handler. Registering new listener removes previous one. + /// Listener instance lifetime shall be not less than Handler's one. + /// + /// Listeners are to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerRequestForQuoteListener( + RequestForQuoteListener* listener); + + /// Registers the market event listener. + /// + /// Only single instance of listener can be associated with + /// the Handler. Registering new listener removes previous one. + /// Listener instance lifetime shall be not less than Handler's one. + /// + /// Listeners are to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerEventListener( + EventListener* listener); + + /// Registers the market event message listener. + /// + /// Only single instance of listener can be associated with + /// the Handler. Registering new listener removes previous one. + /// Listener instance lifetime shall be not less than Handler's one. + /// + /// Listeners are to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerEventMessageListener( + EventMessageListener* listener); + + /// Registers the message processing listener. + /// + /// Only single instance of listener can be associated with + /// the Handler. Registering new listener removes previous one. + /// Listener instance lifetime shall be not less than Handler's one. + /// + /// Listeners are to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerMessageProcessingListener( + MessageProcessingListener* listener); + + /// Registers the Handler state change listener. + /// + /// Only single instance of listener can be associated with + /// the Handler. Registering new listener removes previous one. + /// Listener instance lifetime shall be not less than Handler's one. + /// + /// Listeners are to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerStateChangeListener( + HandlerStateChangeListener* listener); + + /// Registers feed engine events listener. + /// + /// Listener instance is used only if private feed engine + /// is used by the Handler. Listener is ignored if shared + /// feed engine is binded to the Handler. + /// + /// Only single instance of listener can be associated with + /// the Handler. Registering new listener removes previous one. + /// Listener instance lifetime shall be not less than Handler's one. + /// + /// Listeners are to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerFeedEngineListener( + FeedEngineListener* listener); + + /// Registers market data feed events listener. + /// + /// Only single instance of listener can be associated with + /// the Handler. Registering new listener removes previous one. + /// Listener instance lifetime shall be not less than Handler's one. + /// + /// Listeners are to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerFeedListener( + FeedListener* listener); + + /// Registers user defined Watch Service to be used by Handler. + /// + /// Only single instance of Watch Service can be associated with + /// the Handler. Registering new Watch Service removes previous one. + /// Watch Service instance lifetime shall be not less than Handler's one. + /// + /// Watch Service is to be associated before starting market data + /// processing - Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + registerWatchService( + WatchService* watchService); + + /// If security definitions cache is used, + /// cleans it up. The Handler will refresh + /// the cache during next execution. + void clearInstrumentDefinitionsCache(); + + /// Provides information on incremental market data processing state. + void getPendingMarketDataInfo(PendingMarketDataInfo& info); + + /// Allows obtaining snapshot of direct book for given security. + /// + /// Number of levels to be copied is limited by 'maxDepth' parameter. + /// Thus, it's possible to copy only a few levels instead of full book. + /// + /// @return true if book was found for given security. + bool + directBookSnapshot( + SecurityId securityId, + DirectBookSnapshot& bookSnapshot, + MarketDepth maxDepth = MarketDepthTraits::MaxDepth); + + /// Allows obtaining snapshot of implied book for given security. + /// + /// Number of levels to be copied is limited by 'maxDepth' parameter. + /// Thus, it's possible to copy only a few levels instead of full book. + /// + /// @return true if book was found for given security. + bool + impliedBookSnapshot( + SecurityId securityId, + ImpliedBookSnapshot& bookSnapshot, + MarketDepth maxDepth = MarketDepthTraits::MaxDepth); + + /// Allows obtaining snapshot of consolidated book for given security. + /// + /// Number of levels to be copied is limited by 'maxDepth' parameter. + /// Thus, it's possible to copy only a few levels instead of full book. + /// + /// @return true if book was found for given security. + bool + consolidatedBookSnapshot( + SecurityId securityId, + ConsolidatedBookSnapshot& bookSnapshot, + MarketDepth maxDepth = MarketDepthTraits::MaxDepth); + + /// Binds Feed Engine to be used by Handler. + /// instead of creating own instance. + /// + /// Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + bindToFeedEngine( + FeedEngine* feedEngine); + + /// Binds TCP Recovery Service to be used by Handler. + /// instead of creating own instance. + /// + /// Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + bindToTcpRecoveryService( + TcpRecoveryService* tcpRecoveryService); + + /// Binds Asynchronous Logging Service to be used by Handler. + /// All logging I/O operations of this handler instance will be performed + /// asynchronously by separate thread. + /// + /// Handler must be in stopped state. + /// + /// @throw Error in case when handler is not in configurable state. + void + bindToAsyncLogService( + AsyncLogService* asyncLogService); + + /// Starts market data processing. + /// + /// @param startupStrategy identifies strategy Handler + /// must use to join the market. By default, late joining + /// strategy is used. + void + start( + HandlerStartupStrategy startupStrategy = + HandlerStartupStrategies::LateJoin); + + /// Starts market data processing in natural refresh. + /// + /// @param options Natural Refresh Mode options. + void start(const NaturalRefreshOptions& options); + + /// Starts replaying previously logged data. + /// + /// @param options Log replay options. + void start(const ReplayOptions& options); + + /// Stops the Handler. + void stop(); + + private: + class Implementation; + Implementation* impl_; + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/HandlerSettings.h b/linux/include/OnixS/CME/MDP3/HandlerSettings.h new file mode 100755 index 000000000..be0ee885b --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/HandlerSettings.h @@ -0,0 +1,835 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/Initialization.h" +#include "OnixS/CME/MDP3/TcpRecovery.h" +#include "OnixS/CME/MDP3/FeedEngine.h" +#include "OnixS/CME/MDP3/FeedEnums.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + /// Defines log alternates. + struct ONIXS_CME_MDP3_API LogModes + { + /// Log alternates. + enum Enum + { + /// Nothing is logged at all. + Disabled, + + /// Only important information like + /// warnings and errors will be logged. + /// + /// Mode is not suitable for further log + /// replays, because no market data is stored. + Important, + + /// Handler will log miscellaneous aspects + /// related with its execution like changes + /// in state, network data obtained, etc. All + /// critical important information like warnings + /// and errors will be logged as well. + /// + /// Most suitable mode to produce logs for further replay. + Regular, + + /// In addition to the data logged in 'Regular' + /// mode, Handler will output additional information + /// like step-by-step changes into books, step-by-step + /// processing of received network packets. + Debug + }; + + /// Returns mode of given string presentation. + static Enum deserialize(const char*); + + /// Returns string presentation of given mode. + static const char* toString(Enum); + }; + + /// Log mode. + typedef LogModes::Enum LogMode; + + /// Additional options to control log information. + typedef unsigned AdvancedLogOptionSet; + + /// Additional options to control log information. + struct ONIXS_CME_MDP3_API AdvancedLogOptions + { + enum Enum + { + /// Nothing except standard + /// information must be logged. + LogNothing = 0x0, + + /// Log FIX messages in addition to the + /// packets received from the network. + LogFixMessages = 0x1, + + /// Log full book once its updated. + LogFullBooks = 0x2, + + /// Logs all additional data/events. + LogEverything = LogFixMessages | LogFullBooks + }; + + /// Returns string representation of an option. + static + std::string + toString(AdvancedLogOptionSet options); + + /// Appends string representation of an option. + static + void + toString( + AdvancedLogOptionSet options, + std::string&); + + /// Returns options of given string presentation. + static + AdvancedLogOptionSet + deserialize( + const std::string& options); + }; + + inline + std::string + AdvancedLogOptions::toString( + AdvancedLogOptionSet options) + { + std::string result; + + toString(options, result); + + return result; + } + + /// Defines book update notification strategies. + struct + ONIXS_CME_MDP3_API + BookUpdateNotificationStrategies + { + enum Enum + { + /// Book update event is raised once security id is changed in + /// sequence of market data entries being processed by the Handler. + /// + /// @warning Given strategy does not follow MDP policy + /// on exposing order books and thus can be used on own risk! + /// Also, books may not be in a valid state (especially consolidated), + /// as far as exposed earlier than data for entire market event + /// is processed. + OnSecurityChange, + + /// Book update event is raised at the end of market event. + /// + /// Direct books updates are raised at the end of real + /// quotes updates, implied books updates are raised at + /// the end of implied quotes updates and consolidated + /// books updates are raised at the end of entire event. + OnEndOfEvent + }; + + /// Returns strategy of given string presentation. + static Enum deserialize(const char*); + + /// Returns string presentation. + static const char* toString(Enum); + }; + + /// Alias for book notification strategy. + typedef + BookUpdateNotificationStrategies::Enum + BookUpdateNotificationStrategy; + + /// Defines Order Id processing strategies. + struct + ONIXS_CME_MDP3_API + OrderIdProcessingStrategies + { + enum Enum + { + /// No matching between trades and Order IDs performed. Message + /// Order IDs array delivered entirely to callback. + /// @see void OrderIdListener::onOrderIds(const MessageOrderIds&, const ChannelId&) + NoMatching, + + /// Trades are matched with corresponding Order IDs. Order IDs + /// delivered to callback by associated trade. + /// @see void OrderIdListener::onOrderIds(const TradeOrderIds&, const ChannelId&) + TradeMatching + }; + + /// Returns strategy of given string presentation. + static Enum deserialize(const char*); + + /// Returns string representation of constant. + static const char* toString(Enum); + }; + + /// Alias for Order Id processing strategy. + typedef + OrderIdProcessingStrategies::Enum + OrderIdProcessingStrategy; + + /// Handler's configuration settings. + struct + ONIXS_CME_MDP3_API + HandlerSettings + : InitializationSettings + , TcpRecoverySettings + , FeedEngineSettings + { + /// ID of the CME FIX/SBE market data channel + /// from the channels configuration XML file. + const std::string& channelId() const + { + return *channelId_; + } + + /// Sets channelId. @see channelId. + void channelId(const std::string& value) + { + *channelId_ = value; + } + + /// Path to the channels configuration XML file. + const std::string& channelsConfigurationFile() const + { + return *channelsConfigurationFile_; + } + + /// Sets channelsConfigurationFile. @see channelsConfigurationFile. + void channelsConfigurationFile(const std::string& value) + { + *channelsConfigurationFile_ = value; + } + + /// Path to CME SBE templates xml file. + const std::string& codingTemplatesFile() const + { + return *codingTemplatesFile_; + } + + /// Sets codingTemplatesFile. @see codingTemplatesFile. + void codingTemplatesFile(const std::string& value) + { + *codingTemplatesFile_ = value; + } + + /// Option to use file-based caching of the security definitions. + /// + /// @note The default value is 'false'. + /// + /// @warning If this option is activated then it is recommended + /// to remove the cache file weekly to start the trading week + /// with the fresh copy of security definitions. + /// + bool cacheSecurityDefinitions() const + { + return cacheSecurityDefinitions_; + } + + /// Sets cacheSecurityDefinitions. @see cacheSecurityDefinitions. + void cacheSecurityDefinitions(bool value) + { + cacheSecurityDefinitions_ = value; + } + + /// Option to recover the Security Definition messages + /// each time when the message sequence gap is detected. + /// + /// During the trading day new instruments can be defined, + /// and these security definitions are sent over the Incremental + /// A and B feeds. + /// Therefore it is possible to miss new intra-day security definition + /// messages, so it could be required to listen to the instrument feed + /// again on a message gap. + /// + /// On the other hand, this could significantly increase the time of + /// re-synchronization with the market after the detected message gap. + /// + /// @note The default value is false. + /// + bool recoverSecurityDefinitionsOnGap() const + { + return recoverSecurityDefinitionsOnGap_; + } + + /// Sets recoverSecurityDefinitionsOnGap. @see recoverSecurityDefinitionsOnGap. + void recoverSecurityDefinitionsOnGap(bool value) + { + recoverSecurityDefinitionsOnGap_ = value; + } + + /// Defines depth of direct order book for the instrument whose + /// definition wasn't received or had no corresponding data. + /// + /// @note Default value is 10. + unsigned int directBookDepth() const + { + return directBookDepth_; + } + + /// Sets directBookDepth. @see directBookDepth. + void directBookDepth(unsigned int value) + { + directBookDepth_ = value; + } + + /// Defines depth of implied order book for the instrument whose + /// definition wasn't received or had no corresponding data. + /// + /// @note Default value is 2. + unsigned int impliedBookDepth() const + { + return impliedBookDepth_; + } + + /// Sets impliedBookDepth. @see impliedBookDepth. + void impliedBookDepth(unsigned int value) + { + impliedBookDepth_ = value; + } + + /// Specifies whether the Handler should log its events + /// and which of events should be put into the log. + /// + /// @note The default value is LogModes::Regular. + LogMode logMode() const + { + return logMode_; + } + + /// Sets logMode. @see logMode. + void logMode(LogMode value) + { + logMode_ = value; + } + + /// Additional options to control which data is to be logged. + /// Ignored if logging is disabled. + /// + /// @note The default value is AdvancedLogOptions::LogEverything. + AdvancedLogOptionSet advancedLogOptions() const + { + return advancedLogOptions_; + } + + /// Sets advancedLogOptions. @see advancedLogOptions. + void advancedLogOptions(AdvancedLogOptionSet value) + { + advancedLogOptions_ = value; + } + + /// Log files are stored in this directory. + /// Ignored if logging is disabled. + const std::string& logDirectory() const + { + return *logDirectory_; + } + + /// Sets logDirectory. @see logDirectory. + void logDirectory(const std::string& value) + { + *logDirectory_ = value; + } + + /// Log file name are started from the prefix. + /// Ignored if logging is disabled. + const std::string& logFileNamePrefix() const + { + return *logFileNamePrefix_; + } + + /// Sets logFileNamePrefix. @see logFileNamePrefix. + void logFileNamePrefix(const std::string& value) + { + *logFileNamePrefix_ = value; + } + + /// Log file size limit (in bytes). + /// + /// Handler detaches logged data into separate + /// file upon reaching given size limit. + /// + /// @note Default value is '2145386496'. + size_t logFileSizeLimit() const + { + return logFileSizeLimit_; + } + + /// Sets logFileSizeLimit. @see logFileSizeLimit. + void logFileSizeLimit(size_t value) + { + logFileSizeLimit_ = value; + } + + /// Specifies maximal time interval between two + /// network packets. If no data is received during + /// specified time frame, warning is reported and handler + /// starts failovering to secondary feed if possible. + /// + /// Interval is measured in seconds. + /// + /// @note The default value is '30'. + unsigned int heartbeatInterval() const + { + return heartbeatInterval_; + } + + /// Sets heartbeatInterval. @see heartbeatInterval. + void heartbeatInterval(unsigned int value) + { + heartbeatInterval_ = value; + } + + /// Defines feed layout for instrument feed group. + /// + /// @note By default, feed A is used as primary + /// source for market data with failover to feed B. + RecoveryFeedLayout::Enum instrumentFeedLayout() const + { + return instrumentFeedLayout_; + } + + /// Sets instrumentFeedLayout. @see instrumentFeedLayout. + void instrumentFeedLayout(RecoveryFeedLayout::Enum value) + { + instrumentFeedLayout_ = value; + } + + /// Defines feed layout for snapshot feed group. + /// + /// @note By default, feed A is used as primary + /// source for market data with failover to feed B. + RecoveryFeedLayout::Enum snapshotFeedLayout() const + { + return snapshotFeedLayout_; + } + + /// Sets snapshotFeedLayout. @see snapshotFeedLayout. + void snapshotFeedLayout(RecoveryFeedLayout::Enum value) + { + snapshotFeedLayout_ = value; + } + + /// Defines feed layout for incremental feed group. + /// + /// @note By default, Handler arbitrates between feeds A and B. + RealtimeFeedLayout::Enum incrementalFeedLayout() const + { + return incrementalFeedLayout_; + } + + /// Sets incrementalFeedLayout. @see incrementalFeedLayout. + void incrementalFeedLayout(RealtimeFeedLayout::Enum value) + { + incrementalFeedLayout_ = value; + } + + /// Specifies one or more network interfaces to use while + /// joining the multicast group; use semi-colon delimited + /// list if more than one. + /// + /// @note On Linux the network interface is specified + /// by its name, on Windows - by IP address. + /// + /// @note If the value is empty or absent then the + /// default networking interface is used. + /// + /// @see networkInterfaceA, networkInterfaceB. + const std::string& networkInterface() const + { + return *networkInterface_; + } + + /// Sets networkInterface. @see networkInterface. + void networkInterface(const std::string& value) + { + *networkInterface_ = value; + } + + /// Specifies one or more network interfaces to use for + /// "A" feeds while joining the multicast group; use + /// semi-colon delimited list if more than one. + /// + /// @note On Linux the network interface is specified + /// by its name, on Windows - by IP address. + /// + /// @note If the value is empty or absent then the + /// Settings::networkInterface value is used. + const std::string& networkInterfaceA() const + { + return *networkInterfaceA_; + } + + /// Sets networkInterfaceA. @see networkInterfaceA. + void networkInterfaceA(const std::string& value) + { + *networkInterfaceA_ = value; + } + + /// Specifies one or more network interfaces to use for "B" + /// feeds while joining the multicast group; use semi-colon + /// delimited list if more than one. + /// + /// @note On Linux the network interface is specified by + /// its name, on Windows - by IP address. + /// + /// @note If the value is empty or absent then the + /// Settings::networkInterface value is used. + const std::string& networkInterfaceB() const + { + return *networkInterfaceB_; + } + + /// Sets networkInterfaceB. @see networkInterfaceB. + void networkInterfaceB(const std::string& value) + { + *networkInterfaceB_ = value; + } + + /// Maximum number of packets to be hold in internal queues + /// used by the Handler while processing incoming market data. + /// + /// Handler uses internal queues while processes incoming market data. + /// When Handler recovers order books from snapshots, given parameter + /// limits size of internal queue used by the Handler to keep packets + /// coming from incremental feeds. Upon reaching limit, newer packets + /// substitute older ones. + /// + /// Also, if Handler configured to use shared feed engine with multiple threads, + /// given parameter also limits size of queue/buffer used by Handler to store + /// incoming packets received by Handler but not yet processed by main market + /// data processing loop. An important aspect is that single buffer/queue is + /// used to store packets comming from all feeds (A and B) within same multicast + /// group (incremental, snapshot, instrument). New packets are not pushed to queue + /// upon reaching buffer limit in this case. + /// + /// @note The default value is 10000. + unsigned int packetQueueMaxSize() const + { + return packetQueueMaxSize_; + } + + /// Sets packetQueueMaxSize. @see packetQueueMaxSize. + void packetQueueMaxSize(unsigned int value) + { + packetQueueMaxSize_ = value; + } + + /// Max size for network packet transmitted by MDP. + /// + /// @note Default value is '1420'. + unsigned int maxPacketSize() const + { + return maxPacketSize_; + } + + /// Sets maxPacketSize. @see maxPacketSize. + void maxPacketSize(unsigned int value) + { + maxPacketSize_ = value; + } + + /// Limits packet pool size. + /// + /// To speed-up data processing, Handler may accumulate packets + /// for further reuse during data bursts to avoid slowdowns caused + /// by memory allocations. Given parameter defines maximal number + /// of packets allowed for storing in pool for further reuse. + /// + /// @note Default value is '1000'. + unsigned int packetPoolMaxSize() const + { + return packetPoolMaxSize_; + } + + /// Sets packetPoolMaxSize. @see packetPoolMaxSize. + void packetPoolMaxSize(unsigned int value) + { + packetPoolMaxSize_ = value; + } + + /// Defines value of threshold used by Handler to differ + /// out-of-order packets from gaps. + /// + /// Due to unreliable nature of multicast, packets transmitted by MDP + /// may be received in the order different to original. To differ the + /// case when Handler received out-of-order packets from the case when + /// some of packets were completely lost, Handler uses given parameter. + /// It defines size of interval for incoming packets starting from the + /// last received. Packet is considered as out-of-order if its sequence + /// number fits into interval [seqNumberOfLastReceivedPacket, + /// seqNumberOfLastReceivedPacket + outOfOrderPacketsMaxInterval]. + /// In that case Handler waits for other packets to fulfill the incoming + /// sequence. If received packet has greater sequence number than + /// 'seqNumberOfLastReceivedPacket + outOfOrderPacketsMaxInterval', + /// then Handler makes a decision on packets lost and gap is reported. + /// + /// @note When out-of-order packet is received, Handler makes a decision + /// on data loss if either waiting time is over or if newly received packet + /// has sequence number greater than 'seqNumberOfLastReceivedPacket + + /// outOfOrderPacketMaxInterval'. + /// + /// @see 'lostPacketWaitTime' parameter for more information. + /// + /// @note The default value is '3'. + unsigned int outOfOrderPacketMaxInterval() const + { + return outOfOrderPacketMaxInterval_; + } + + /// Sets outOfOrderPacketMaxInterval. @see outOfOrderPacketMaxInterval. + void outOfOrderPacketMaxInterval(unsigned int value) + { + outOfOrderPacketMaxInterval_ = value; + } + + /// Indicates for how long Handler should wait for + /// the packet before it's considered as totally lost. + /// + /// Due to unreliable nature of multicast, data transmitted by MDP + /// may come in order other than original or be completely lost. When + /// Handler receives packet with sequence number greater than expected, + /// it considers received data as out-of-order. If for a certain time + /// interval Handler receives missing data, Handler resumes normal data + /// processing. However, if no data is received for predefined time frame, + /// Handler considers missing data as lost and raises packet gap event. + /// Given parameter defines size of time interval Handler waits for missing + /// data. + /// + /// @note When out-of-order packet is received, Handler makes a decision + /// on data loss if either waiting time is over or if newly received packet + /// has sequence number greater than 'seqNumberOfLastReceivedPacket + + /// outOfOrderPacketMaxInterval'. + /// + /// @see 'outOfOrderPacketMaxInterval' parameter for more information. + /// + /// Time interval is measured in microseconds (usec). + /// + /// @note The default value is '100000' (100 milliseconds). + unsigned int lostPacketWaitTime() const + { + return lostPacketWaitTime_; + } + + /// Sets lostPacketWaitTime. @see lostPacketWaitTime. + void lostPacketWaitTime(unsigned int value) + { + lostPacketWaitTime_ = value; + } + + /// Defines size of buffer in bytes for UDP/multicast sockets. + /// + /// @note Default value is zero which means + /// system default setting will be used. + unsigned int udpSocketBufferSize() const + { + return udpSocketBufferSize_; + } + + /// Sets udpSocketBufferSize. @see udpSocketBufferSize. + void udpSocketBufferSize(unsigned int value) + { + udpSocketBufferSize_ = value; + } + + /// Maximum number of repeating group entries. + /// + /// This setting could be used to detect mismatch between + /// the SBE template that was used for message encoding + /// and the SBE template that is used for message decoding. + /// + /// @note The default value is 1000. + unsigned int repeatingGroupEntriesMaxCount() const + { + return repeatingGroupEntriesMaxCount_; + } + + /// Sets repeatingGroupEntriesMaxCount. @see repeatingGroupEntriesMaxCount. + void repeatingGroupEntriesMaxCount(unsigned int value) + { + repeatingGroupEntriesMaxCount_ = value; + } + + /// Indicates whether local or UTC time is used by the Handler + /// while assigning timestamps to log events and packets received. + /// @note Default value is 'false' thus local time is used. + bool useUniversalTime() const + { + return useUniversalTime_; + } + + /// Sets useUniversalTime. @see useUniversalTime. + void useUniversalTime(bool value) + { + useUniversalTime_ = value; + } + + /// Forces Handler to build direct order book. + /// + /// Unless book update listener is registered or + /// best bid/ask is tracked, Handler doesn't construct + /// and thus doesn't maintain order book. If book isn't + /// maintained, snapshot retrieval is not possible. + /// + /// @note Default value is 'false'. + bool forceDirectBookMaintenance() const + { + return forceDirectBookMaintenance_; + } + + /// Sets forceDirectBookMaintenance. @see forceDirectBookMaintenance. + void forceDirectBookMaintenance(bool value) + { + forceDirectBookMaintenance_ = value; + } + + /// Forces Handler to build implied order book. + /// + /// Unless book update listener is registered or + /// best bid/ask is tracked, Handler doesn't construct + /// and thus doesn't maintain order book. If book isn't + /// maintained, snapshot retrieval is not possible. + /// + /// @note Default value is 'false'. + bool forceImpliedBookMaintenance() const + { + return forceImpliedBookMaintenance_; + } + + /// Sets forceImpliedBookMaintenance. @see forceImpliedBookMaintenance. + void forceImpliedBookMaintenance(bool value) + { + forceImpliedBookMaintenance_ = value; + } + + /// Forces Handler to build consolidated order book. + /// + /// Unless book update listener is registered or + /// best bid/ask is tracked, Handler doesn't construct + /// and thus doesn't maintain order book. If book isn't + /// maintained, snapshot retrieval is not possible. + /// + /// @note Default value is 'false'. + bool forceConsolidatedBookMaintenance() const + { + return forceConsolidatedBookMaintenance_; + } + + /// Sets forceConsolidatedBookMaintenance. @see forceConsolidatedBookMaintenance. + void forceConsolidatedBookMaintenance(bool value) + { + forceConsolidatedBookMaintenance_ = value; + } + + /// Book update notification strategy. + /// + /// Defines the way Handler raises order book update event. + /// + /// @note Default strategy is BookUpdateNotificationStrategies::OnEndOfEvent. + BookUpdateNotificationStrategy bookUpdateNotificationStrategy() const + { + return bookUpdateNotificationStrategy_; + } + + /// Sets bookUpdateNotificationStrategy. @see bookUpdateNotificationStrategy. + void bookUpdateNotificationStrategy(BookUpdateNotificationStrategy value) + { + bookUpdateNotificationStrategy_ = value; + } + + /// Order IDs processing strategy. + /// + /// Defines the way Handler processes Order IDs array. + /// + /// @note Default strategy is OrderIdProcessingStrategies::NoMatching. + OrderIdProcessingStrategy orderIdProcessingStrategy() const + { + return orderIdProcessingStrategy_; + } + + /// Sets orderIdProcessingStrategy. @see orderIdProcessingStrategy. + void orderIdProcessingStrategy(OrderIdProcessingStrategy value) + { + orderIdProcessingStrategy_ = value; + } + + /// Initializes parameters with default values. + HandlerSettings(); + + /// Cleans everything up. + ~HandlerSettings(); + + /// Returns textual presentation. + std::string toString() const + { + std::string str; + toString(str); + return str; + } + + /// Returns textual presentation. + void toString(std::string&) const; + + private: + Exportable channelId_; + Exportable channelsConfigurationFile_; + Exportable codingTemplatesFile_; + bool cacheSecurityDefinitions_; + bool recoverSecurityDefinitionsOnGap_; + unsigned int directBookDepth_; + unsigned int impliedBookDepth_; + LogMode logMode_; + AdvancedLogOptionSet advancedLogOptions_; + Exportable logDirectory_; + Exportable logFileNamePrefix_; + size_t logFileSizeLimit_; + unsigned int heartbeatInterval_; + RecoveryFeedLayout::Enum instrumentFeedLayout_; + RecoveryFeedLayout::Enum snapshotFeedLayout_; + RealtimeFeedLayout::Enum incrementalFeedLayout_; + Exportable networkInterface_; + Exportable networkInterfaceA_; + Exportable networkInterfaceB_; + unsigned int packetQueueMaxSize_; + unsigned int maxPacketSize_; + unsigned int packetPoolMaxSize_; + unsigned int outOfOrderPacketMaxInterval_; + unsigned int lostPacketWaitTime_; + unsigned int udpSocketBufferSize_; + unsigned int repeatingGroupEntriesMaxCount_; + bool useUniversalTime_; + bool forceDirectBookMaintenance_; + bool forceImpliedBookMaintenance_; + bool forceConsolidatedBookMaintenance_; + BookUpdateNotificationStrategy bookUpdateNotificationStrategy_; + OrderIdProcessingStrategy orderIdProcessingStrategy_; + }; + + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/HandlerState.h b/linux/include/OnixS/CME/MDP3/HandlerState.h new file mode 100755 index 000000000..1a5e65902 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/HandlerState.h @@ -0,0 +1,160 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/Types.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + /// Available Handler's states. + struct ONIXS_CME_MDP3_API HandlerStates + { + /// Available Handler's states. + enum Enum + { + /// Handler is stopped. + Stopped = 0, + + /// Handler is started but no data processing is performed yet. + Started, + + /// Download or replay of Security Definition(d) messages is started. + SecurityDefinitionsRecoveryStarted, + + /// Download or replay of Security Definition(d) messages is finished. + SecurityDefinitionsRecoveryFinished, + + /// + /// The correct books state is lost. + /// + /// Handler switches to this state when it joins the market and the + /// initial books state is built from MarketDataSnapshotFullRefresh + /// (MsgType=W) messages or when the TCP Recovery is not used and the + /// message sequence number gap is detected, so the book state should + /// be re-built from MarketDataSnapshotFullRefresh (MsgType=W) messages + /// again. + /// + /// It should be assumed at this point that all books maintained + /// in the Handler may no longer have the correct, latest state + /// maintained by CME, so they are cleared. + /// + BookRecoveryStarted, + + /// + /// The latest books state is restored. + /// + /// Handler switches to this state when the the latest books state + /// is restored from MarketDataSnapshotFullRefresh (MsgType=W) messages + /// (all snapshot data is retrieved). + /// + /// It should be assumed at this point that all books maintained in + /// the Handler have the correct, latest state maintained by CME. + /// + BookRecoveryFinished, + + /// Handler initiated retransmission of + /// lost packets over TCP replay channel. + TcpRecoveryStarted, + + /// Handler accomplished retransmission of + /// lost packets over TCP replay channel. + TcpRecoveryFinished + }; + + /// Returns constant from its string representation. + static Enum deserialize(const char* state); + + /// Returns string representation of a state. + static const char* toString(Enum state); + }; + + /// States of the Handler in which it may reside. + typedef + HandlerStates::Enum + HandlerState; + + /// Handler state change. + class + ONIXS_CME_MDP3_API + HandlerStateChange + { + public: + + HandlerStateChange( + HandlerState newState, + HandlerState oldState); + + /// New State. + HandlerState newState() const + { + return newState_; + } + + /// Old state. + HandlerState oldState() const + { + return oldState_; + } + + /// String representation. + std::string toString() const + { + std::string str; + toString(str); + return str; + } + + /// Appends string representation. + void toString(std::string&) const; + + private: + HandlerState newState_; + HandlerState oldState_; + + HandlerStateChange( + const HandlerStateChange& other); + + HandlerStateChange& + operator =( + const HandlerStateChange& other); + }; + + /// Handler state change listener. + class + ONIXS_CME_MDP3_API + HandlerStateChangeListener + { + public: + /// Is called when the handler state is changed. + virtual + void + onHandlerStateChange( + const HandlerStateChange& change, + const ChannelId& channelId) = 0; + + protected: + virtual ~HandlerStateChangeListener(); + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/ImpliedBook.h b/linux/include/OnixS/CME/MDP3/ImpliedBook.h new file mode 100755 index 000000000..d2edc53af --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/ImpliedBook.h @@ -0,0 +1,137 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/DirectBook.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + ONIXS_CME_MDP3_API_DECL( + class, + ConsolidatedBook); + +#if defined (_MSC_VER) + + template + class + ONIXS_CME_MDP3_API + ArrayRef + < + ImpliedPriceLevel, + MarketDepth + >; + + template + class + ONIXS_CME_MDP3_API + VectorOverArray + < + ImpliedPriceLevel, + MarketDepth + >; + + template + class + ONIXS_CME_MDP3_API + BookBase; + +#endif + + typedef + BookBase + ImpliedBookBase; + + class + ONIXS_CME_MDP3_API + ImpliedBook + : public ImpliedBookBase + { + public: + /// Disposes allocated resources. + ~ImpliedBook() + { + } + + /// Book brief info. + std::string + brief() const + { + std::string str; + + brief(str); + + return str; + } + + /// Book brief info. + void brief(std::string&) const; + + /// String presentation of the book. + std::string toString() const + { + std::string str; + toString(str); + return str; + } + + /// String presentation of the book. + void toString(std::string&) const; + + /// Constructs book of given capacity. + static ImpliedBook* construct(MarketDepth maxDepth); + + /// Disposes previously constructed instance. + void operator delete(void* block); + + protected: + /// Initializes instance as base does. + ImpliedBook( + SecurityId id, + MarketDepth depth, + const EditablePriceLevelsRef& bids, + const EditablePriceLevelsRef& asks) + : ImpliedBookBase(id, depth, bids, asks) + { + } + }; + +#if defined (_MSC_VER) + + template + class + ONIXS_CME_MDP3_API + std::auto_ptr; + + template + class + ONIXS_CME_MDP3_API + BookSnapshot; + +#endif + + typedef + BookSnapshot + ImpliedBookSnapshot; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/ImpliedBookChange.h b/linux/include/OnixS/CME/MDP3/ImpliedBookChange.h new file mode 100755 index 000000000..7e07d4931 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/ImpliedBookChange.h @@ -0,0 +1,126 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/BookChangeBase.h" +#include "OnixS/CME/MDP3/ImpliedPriceLevel.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { +#if defined (_MSC_VER) + + template + class + ONIXS_CME_MDP3_API + BookChangeBase; + +#endif + + template <> + inline + bool BookChangeBase::extract( + const GroupInstance& entry, + ImpliedPriceLevel& level) + { + const bool hasPrice = getDecimal(entry, Tags::MDEntryPx, level.price()); + const bool hasSize = getNumber(entry, Tags::MDEntrySize, level.quantity()); + + return hasPrice || hasSize; + } + + + typedef + BookChangeBase + ImpliedBookChangeBase; + + /// Order book change. + /// + /// @see ImpliedBookChangeListener. + class + ONIXS_CME_MDP3_API + ImpliedBookChange + : public ImpliedBookChangeBase + { + public: + /// Provides access to price component if exists. + /// @return 'true' if price component is available. + bool + price( + Price& price) const + { + if ( + priceLevelData() && + priceLevelData()->exist()) + { + price = priceLevelData()->price(); + + return true; + } + + return getDecimal(marketDataEntry(), Tags::MDEntryPx, price); + } + + /// Provides access to quantity component if exists. + /// @return 'true' if quantity component is available. + bool + quantity( + SignedQuantity& quantity) const + { + if ( + priceLevelData() && + priceLevelData()->exist()) + { + quantity = priceLevelData()->quantity(); + + return true; + } + + return getNumber(marketDataEntry(), Tags::MDEntrySize, quantity); + } + + /// Returns the text representation. + std::string toString() const + { + std::string str; + + toString(str); + + return str; + } + + /// Appends the text representation. + void toString(std::string&) const; + + protected: + ImpliedBookChange( + SecurityId id, + const GroupInstance& entry) + : ImpliedBookChangeBase( + id, + entry) + { + } + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/ImpliedPriceLevel.h b/linux/include/OnixS/CME/MDP3/ImpliedPriceLevel.h new file mode 100755 index 000000000..24e194205 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/ImpliedPriceLevel.h @@ -0,0 +1,138 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/Types.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + /// Encapsulates price level concept. + class + ONIXS_CME_MDP3_API + ImpliedPriceLevel + { + public: + /// Initializes undefined level. + ImpliedPriceLevel() + : exist_(false), + price_(), + qty_(0) + { + } + + /// Initializes as copy of other level. + ImpliedPriceLevel( + const ImpliedPriceLevel& other) + : exist_(other.exist_), + price_(other.price_), + qty_(other.qty_) + { + } + + /// Initializes defined level + /// according to specified attributes. + ImpliedPriceLevel( + const Price& price, SignedQuantity qty) + : exist_(true), price_(price), qty_(qty) + { + } + + ~ImpliedPriceLevel() + { + } + + /// Identifies whether price level exist. + bool exist() const + { + return exist_; + } + + /// Updates existence status. + bool& exist() + { + return exist_; + } + + /// Price value. + /// @note For CME Globex feed price always presents + /// if corresponding price level exists. + /// But this may differ for CME Partner Exchanges feeds. + /// E.g. for BVMF auction/on close market orders may have no price + /// but still reside in order book. Such orders are represented as + /// price levels with NULL price. NULL prices are stored as Decimal::Null. + /// @see Decimal::Null, Decimal::null + const Price& price() const + { + return price_; + } + + /// Price value. + Price& price() + { + return price_; + } + + /// Quantify for the given price. + SignedQuantity quantity() const + { + return qty_; + } + + /// Quantify for the given price. + SignedQuantity& quantity() + { + return qty_; + } + + /// Returns string representation of the instance. + std::string toString() const + { + std::string str; + + toString(str); + + return str; + } + + /// Appends representation of the instance to the string. + void toString(std::string&) const; + + // Re-initializes as copy of other instance. + ImpliedPriceLevel& + operator =( + const ImpliedPriceLevel& other) + { + price_ = other.price_; + qty_ = other.qty_; + exist_ = other.exist_; + + return *this; + } + private: + bool exist_; + Price price_; + SignedQuantity qty_; + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/Initialization.h b/linux/include/OnixS/CME/MDP3/Initialization.h new file mode 100755 index 000000000..899eedb2a --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/Initialization.h @@ -0,0 +1,82 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include + +#include "OnixS/CME/MDP3/Config.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + /// Collection of attributes for one-time initialization. + struct ONIXS_CME_MDP3_API InitializationSettings + { + /// Path to the folder in which licenses are stored. + /// + /// @note The default value is "./". + /// + const std::string& licenseStore() const + { + return *licenseStore_; + } + + void licenseStore(const std::string& value) + { + *licenseStore_ = value; + } + + /// Initializes settings with default values. + InitializationSettings(); + + /// Cleans up all resources. + ~InitializationSettings(); + + /// Returns the text representation. + std::string toString() const + { + std::string str; + toString(str); + return str; + } + + /// Appends the text representation. + void toString(std::string&) const; + + private: + Exportable licenseStore_; + }; + + /// One-time initialization of market data services. + ONIXS_CME_MDP3_API + void + initialize(const InitializationSettings&); + + /// Cleans up everything done by one-time initialization. + /// + /// Has no effect while there's at least one instance + /// of the Handler is constructed. Thus, is to be invoked + /// when no Handler instances are allocated. + ONIXS_CME_MDP3_API void finalize(); + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/MessageProcessingListener.h b/linux/include/OnixS/CME/MDP3/MessageProcessingListener.h new file mode 100755 index 000000000..2590fb0bd --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/MessageProcessingListener.h @@ -0,0 +1,69 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/Messaging.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + /// Notifies about the processing of the market data FIX messages. + /// + /// For example, it could be used to to know when all the book + /// changes within a “Market Data Incremental Refresh” (X) message + /// have been received before actions on them are taken. + class + ONIXS_CME_MDP3_API + MessageProcessingListener + { + public: + /// Is called before the processing of the source FIX message. + virtual + void + onProcessingBegin( + const Message& message, + const ChannelId& channelId) = 0; + + /// Is called after the processing of the source FIX message. + virtual + void + onProcessingEnd( + const Message& message, + const ChannelId& channelId) = 0; + + /// Is called when no data is coming during a reasonable + /// period of time. Since the moment of call previously + /// obtained data and thus all books built from that data + /// must be considered as outdated. Further call of any + /// of book-related events (change, update, reset) makes + /// a particular book as up-to-date. + virtual + void + onProcessingSuspended( + const ChannelId& channelId) = 0; + + protected: + virtual ~MessageProcessingListener(); + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/Messaging.h b/linux/include/OnixS/CME/MDP3/Messaging.h new file mode 100755 index 000000000..c021ea821 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/Messaging.h @@ -0,0 +1,860 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/String.h" +#include "OnixS/CME/MDP3/Numeric.h" +#include "OnixS/CME/MDP3/Time.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + ONIXS_CME_MDP3_API_DECL (class, Message); + ONIXS_CME_MDP3_API_DECL (class, Group); + + class MessageOperator; + + /// Reference to a read-only FIX field value. + /// + /// Reference may refers to a valid field value or + /// to nothing. 'operator bool()' is exposed to check + /// whether instance refers to existent field value. + class + ONIXS_CME_MDP3_API + FieldValueRef + { + public: + /// Uninitialized value. + FieldValueRef(); + + /// Shallow copy from another one. + FieldValueRef(const FieldValueRef&); + + /// Indicated whether the instance + /// refers to a valid value. + operator bool() const; + + /// Return string presentation + /// of the value being referenced. + operator std::string() const + { + std::string str; + toString(str); + return str; + } + + /// Compares with another instance for equality. + bool operator ==(const FieldValueRef&) const; + + /// Compares with another instance for inequality. + bool operator !=(const FieldValueRef&) const; + + /// Compares string presentation for + /// equality with given text reference. + bool operator ==(const StringRef&) const; + + /// Compares string presentation for + /// equality with given text reference. + bool operator !=(const StringRef&) const; + + /// Converts field value into a whole number. + /// + /// @return false if value referenced by instance + /// can't be converted into value of target type. + /// + /// @note conversion of instance referencing + /// to nothing always fails. + bool toNumber (Int32&) const; + + /// Converts field value into a whole number. + /// + /// @return false if value referenced by instance + /// can't be converted into value of target type. + /// + /// @note conversion of instance referencing + /// to nothing always fails. + bool toNumber (UInt32&) const; + + /// Converts field value into a whole number. + /// + /// @return false if value referenced by instance + /// can't be converted into value of target type. + /// + /// @note conversion of instance referencing + /// to nothing always fails. + bool toNumber (Int64&) const; + + /// Converts field value into a whole number. + /// + /// @return false if value referenced by instance + /// can't be converted into value of target type. + /// + /// @note conversion of instance referencing + /// to nothing always fails. + bool toNumber (UInt64&) const; + + /// Converts field value into a whole number. + /// + /// @return false if value referenced by instance + /// can't be converted into value of target type. + /// + /// @note conversion of instance referencing + /// to nothing always fails. + bool toNumber (Decimal&) const; + + /// Converts field value into Timestamp. + /// + /// @return false if value referenced by instance + /// can't be converted into value of target type. + /// + /// @note conversion of instance referencing + /// to nothing always fails. + bool toTimestamp(Timestamp&, SinceEpochUnit) const; + + /// If value represents text, returns reference to it. + /// + /// @return false if value referenced by instance + /// can't be converted into value of target type. + /// If value being referenced is not of string type + /// (like number or datetime), conversion fails. + /// + /// @note conversion of instance referencing + /// to nothing always fails. + bool toStringRef (StringRef&) const; + + /// If value represent one-char text, + /// copies it into given variable. + /// + /// @return false if value referenced by instance + /// can't be converted into value of target type. + /// + /// @note conversion of instance referencing + /// to nothing always fails. + bool toChar (char&) const; + + /// If repeating group is associated with + /// field, allows to get instance of it. + /// + /// @return false if no group is associated with field. + bool toGroup (Group&) const; + + /// Appends copy of referenced value text + /// presentation to the std::string. + void toString (std::string&) const; + + /// Return string presentation of field value. + std::string toString() const + { + std::string str; + toString(str); + return str; + } + + /// Updates instance to refer to another field value. + /// @warning Does NOT perform deep copy of field values. + /// Just updates reference to point to value of other field. + FieldValueRef& operator =(const FieldValueRef&); + + private: + friend class MessageOperator; + + const void* impl_; + const Message* container_; + + FieldValueRef( + const Message*, + const void*); + }; + + // More comparison operators. + + inline + bool + operator == ( + const FieldValueRef& ref, + const std::string& str) + { + return ref == StringRef (str); + } + + inline + bool + operator != ( + const FieldValueRef& ref, + const std::string& str) + { + return ref != StringRef (str); + } + + inline + bool + operator == ( + const std::string& str, + const FieldValueRef& ref) + { + return ref == StringRef (str); + } + + inline + bool + operator != ( + const std::string& str, + const FieldValueRef& ref) + { + return ref != StringRef (str); + } + + // More comparison operators. + + inline + bool + operator == ( + const FieldValueRef& ref, + const char* str) + { + return ref == StringRef (str); + } + + inline + bool + operator != ( + const FieldValueRef& ref, + const char* str) + { + return ref != StringRef (str); + } + + inline + bool + operator == ( + const char* str, + const FieldValueRef& ref) + { + return ref == StringRef (str); + } + + inline + bool + operator != ( + const char* str, + const FieldValueRef& ref) + { + return ref != StringRef (str); + } + + /// Encapsulates primary operations over collection of FIX + /// fields like FIX message and repeating group instance are. + class ONIXS_CME_MDP3_API FieldSet + { + public: + /// Indicates whether instance refers to a valid set of fields. + /// + /// If given instance doesn't refer to a valid fields set, + /// none of other members must be used. + operator bool() const; + + /// Provides access to field value using field tag. + /// + /// @return Reference to a value associated with field + /// identified by tag. If there's no value associated with + /// a field, returned reference refers to nothing. + /// + /// @warning Due to performance considerations, doesn't + /// check whether instance refers to a valid set of fields. + /// Use casting to bool operator to check whether instance + /// refers to a valid set of fields. + FieldValueRef get (Tag tag) const; + + /// Returns field value as a char value. + /// + /// @throw std::exception if field is absent or associated + /// value can't be converted to target type. + /// + /// @warning Due to performance considerations, doesn't + /// check whether instance refers to a valid set of fields. + /// Use casting to bool operator to check whether instance + /// refers to a valid set of fields. + char getChar(Tag tag) const; + + /// Returns field value as an Int32 value. + /// + /// @throw std::exception if field is absent or associated + /// value can't be converted to target type. + /// + /// @warning Due to performance considerations, doesn't + /// check whether instance refers to a valid set of fields. + /// Use casting to bool operator to check whether instance + /// refers to a valid set of fields. + Int32 getInt32 (Tag tag) const; + + /// Returns field value as an UInt32 value. + /// + /// @throw std::exception if field is absent or associated + /// value can't be converted to target type. + /// + /// @warning Due to performance considerations, doesn't + /// check whether instance refers to a valid set of fields. + /// Use casting to bool operator to check whether instance + /// refers to a valid set of fields. + UInt32 getUInt32 (Tag tag) const; + + /// Returns field value as an Int64 value. + /// + /// @throw std::exception if field is absent or associated + /// value can't be converted to target type. + /// + /// @warning Due to performance considerations, doesn't + /// check whether instance refers to a valid set of fields. + /// Use casting to bool operator to check whether instance + /// refers to a valid set of fields. + Int64 getInt64 (Tag tag) const; + + /// Returns field value as an UInt64 value. + /// + /// @throw std::exception if field is absent or associated + /// value can't be converted to target type. + /// + /// @warning Due to performance considerations, doesn't + /// check whether instance refers to a valid set of fields. + /// Use casting to bool operator to check whether instance + /// refers to a valid set of fields. + UInt64 getUInt64 (Tag tag) const; + + /// Returns the field value as a decimal number. + /// + /// @throw std::exception if field is absent or associated + /// value can't be converted to target type. + /// + /// @warning Due to performance considerations, doesn't + /// check whether instance refers to a valid set of fields. + /// Use casting to bool operator to check whether instance + /// refers to a valid set of fields. + Decimal getDecimal (Tag tag) const; + + /// Returns reference to a read-only text chain. + /// + /// @throw std::exception if field is absent or associated + /// value can't be converted to target type. + /// + /// @warning Due to performance considerations, doesn't + /// check whether instance refers to a valid set of fields. + /// Use casting to bool operator to check whether instance + /// refers to a valid set of fields. + StringRef getStringRef (Tag tag) const; + + /// Returns the field value as timestamp of requested format. + /// + /// @throw std::exception if field is absent or associated + /// value can't be converted to target type. + /// + /// @warning Due to performance considerations, doesn't + /// check whether instance refers to a valid set of fields. + /// Use casting to bool operator to check whether instance + /// refers to a valid set of fields. + Timestamp getTimestamp (Tag tag, SinceEpochUnit unit) const; + + /// Returns reference to a repeating group if underlying + /// field defines length of repeating group. + /// + /// @param tag represent tag number of the field that defines + /// number of instances in this repeating group (the NoXXX field). + /// + /// @throw std::exception if no repeating group is + /// associated with given field including field absence. + Group getGroup (Tag tag) const; + + /// Returns reference to a repeating group if underlying + /// field defines length of repeating group. If field is absent + /// returns instance referencing to nothing. If field is undefined + /// for this message throws exception (if strict parameter is true) + /// or returns instance referencing to nothing (if strict parameter is false). + /// + /// @param tag represent tag number of the field that defines + /// number of instances in this repeating group (the NoXXX field). + /// @param strict set to true (default) if field undefined for this message + /// shall throw exception or to false if shall return empty group instance. + /// + /// @throw std::exception if given field is undefined (and strict parameter + /// is true) or doesn't suppose to represent repeating group. + Group getOptionalGroup (Tag tag, bool strict = true) const; + + /// Returns true if the given flag is present + /// and it equals to "Y", otherwise false. + /// + /// @warning Due to performance considerations, doesn't + /// check whether instance refers to a valid set of fields. + /// Use operator bool() to check whether + /// instance is in valid state. + bool hasFlag (Tag tag) const; + + /// Checks the presence of a field + /// This method should be used if the actual field value is NOT of interest - + /// otherwise field lookup operation will be done twice. + bool contain (Tag tag) const; + + protected: + // Underlying implementation. + const void* impl_; + + // Message to which given set belongs to. + const Message* container_; + + // Full details initialization. + FieldSet (const Message*, const void*); + + // Clone construction. + FieldSet (const FieldSet&); + + // Destruction available via descendants. + ~FieldSet(); + + FieldSet& operator = (const FieldSet&); + + private: + friend class Message; + friend class GroupInstance; + friend class MessageOperator; + }; + + template + < + typename Enumeration + > + inline + typename + Enumeration::Enum + getIntEnumFieldValue( + const FieldSet& fieldSet, + Tag tag) + { + UInt32 value = 0; + FieldValueRef valueRef = fieldSet.get(tag); + + return ( + valueRef && valueRef.toNumber(value)) + ? static_cast (value) + : Enumeration::Undefined; + } + + template + < + typename Enumeration + > + inline + typename + Enumeration::Enum + getCharEnumFieldValue( + const FieldSet& fieldSet, + Tag tag) + { + char value = 0; + FieldValueRef valueRef = fieldSet.get(tag); + + return ( + valueRef && valueRef.toChar(value)) + ? static_cast (value) + : Enumeration::Undefined; + } + + inline + bool + getDate( + const FieldSet& fieldSet, + Tag tag, + Timestamp& date) + { + UInt64 value; + + if (fieldSet.get(tag).toNumber(value)) + { + date = Timestamp::fromUnixTimestamp(value, SinceEpochUnits::Days); + return true; + } + + return false; + } + + inline + bool + getDecimal( + const FieldSet& fieldSet, + Tag tag, + Decimal& value) + { + if(fieldSet.get(tag).toNumber(value)) return true; + + value = Decimal::Null; + return false; + } + + template + inline + bool + getNumber( + const FieldSet& fieldSet, + Tag tag, + Value& value, + const Value& defaultValue = Value()) + { + if(fieldSet.get(tag).toNumber(value)) return true; + + value = defaultValue; + return false; + } + + /// Single instance of FIX Repeating Group. Provides access + /// to the fields of a particular repeating group instance. + /// + /// Class behaves like a pointer/reference to a set of FIX + /// fields. Coping and assignment operations just update reference + /// to the field-set being pointed, no deep copying is performed. + class + ONIXS_CME_MDP3_API + GroupInstance : public FieldSet + { + public: + /// Initializes instance referencing to nothing. + GroupInstance(); + + /// Initializes instance as reference to the other one. + GroupInstance (const GroupInstance& other); + + /// Reinitializes instance as reference of other one. + GroupInstance& operator = (const GroupInstance&); + + /// Instance of Message holding + /// given repeating group instance. + /// + /// @warning Due to performance considerations, doesn't + /// check whether instance refers to a valid set of fields. + /// Use operator bool() to check whether + /// instance is in valid state. + const Message& message() const + { + return *container_; + } + + private: + friend class MessageOperator; + + GroupInstance (const Message*, const void*); + }; + + /// Encapsulates operations over FIX Repeating Group. + /// + /// Repeating group represents array of repeating group instances, + /// So, class exposes corresponding services to manipulate array + /// of repeating group instances. Similar to the GroupInstance + /// it behaves like a pointer/reference to the underlying data. It's + /// a light-weight object which just wraps internal data. + /// + /// Group remains valid until corresponding field (which defines + /// size/length of repeating group) from field-set (message or outer + /// repeating group instance) is updated. + class ONIXS_CME_MDP3_API Group + { + public: + /// Initializes instance as referred to nothing. + Group(); + + /// Initializes instance as reference to given repeating group. + Group (const Group& other); + + /// Indicated whether group refers to a valid instance. + operator bool() const; + + /// Return number of instances in repeating group. + /// + /// @warning Due to performance considerations, + /// instance is not checked for validness. Member + /// must be used only when instance is in valid state. + size_t size() const; + + /// Accesses to repeating group instance. + /// + /// @throw std::exception if If index exceeds allowed bounds. + /// + /// @warning Due to performance considerations, + /// instance is not checked for validness. Member + /// must be used only when instance is in valid state. + const GroupInstance at (size_t index) const; + + /// Accesses to repeating group instance. + /// + /// Does NOT check index validness. + /// + /// @warning Due to performance considerations, + /// instance is not checked for validness. Member + /// must be used only when instance is in valid state. + const GroupInstance operator [] (size_t index) const; + + /// Reinitializes instance as reference to other one. + Group& operator = (const Group& other); + + /// Instance of Message holding + /// given repeating group instance. + /// + /// @warning Due to performance considerations, doesn't + /// check whether instance refers to a valid set of fields. + /// Use operator bool() to check whether + /// instance is in valid state. + const Message& message() const + { + return *container_; + } + + private: + friend class MessageOperator; + + const void* impl_; + + const Message* container_; + + Group(const Message*, const void*); + }; + + template + class TypedGroup + { + public: + /// Initializes set with no entries. + TypedGroup() + : underlyingGroup_() + { + } + + /// Return number of instances in repeating group. + size_t size() const + { + return underlyingGroup_ ? underlyingGroup_.size() : 0; + } + + /// Indicates whether set has an entries. + bool empty() const + { + return 0 == size(); + } + + /// Accesses to repeating group instance. + /// + /// Does NOT check index validness. + Entry operator [] (size_t index) const + { + return Entry(underlyingGroup_[index]); + } + + /// Accesses to repeating group instance. + /// + /// check index validness. + Entry at (size_t index) const + { + if (index < size()) + return Entry(underlyingGroup_[index]); + + throw std::out_of_range("Index"); + } + + protected: + TypedGroup (const Group& group) + : underlyingGroup_(group) + { + } + + Group underlyingGroup_; + }; + + + /// Contains flags which affect FIX message textual presentation. + struct + ONIXS_CME_MDP3_API + MessageStringingFlag + { + /// Flags which affect FIX message textual presentation. + enum Enum + { + /// Only field values are serialized. + NoFieldInfo = 0x0, + + /// Field tag numbers are included during serialization. + IncludeFieldTagNumber = 0x1, + + /// Field names are included during serialization. + IncludeFieldName = 0x2 + }; + }; + + /// Collection of message stringing flags. + typedef unsigned MessageStringingFlags; + + /// Encapsulates operations over a FIX Message. + /// + /// Message supports 'unconstructed' state which can be + /// treated as pointer in null state. However, in contrast to + /// Group and GroupInstance classes it + /// does NOT represent light-weight wrapper over internal structures. + /// In fact, it holds all the data which is fully copied on assignment + /// or copy construction and disposed at instance destruction. + /// + /// FIX field related operations now available via FieldSet + /// class from which Message class is now derived. + class + ONIXS_CME_MDP3_API + Message : public FieldSet + { + public: + /// Initializes message in 'unconstructed' state. + Message(); + + /// Initializes instance as deep copy of other one. + /// + /// @param other Message to be copied from. + Message(const Message& other); + + /// Disposes all internal data structures. + /// + /// @warning Once instance is destructed, all instances of + /// Group and GroupInstance classes + /// obtained from this instance must not be used any more. + ~Message(); + + /// Returns the message type (MsgType(35) field value). + FieldValueRef type() const; + + /// Returns the MsgSeqNum field from CME binary packet header. + /// Please note: this field is attributed to packet, not message. + /// Packet can contain several messages, so they will share same sequence number. + SequenceNumber sequenceNumber() const; + + /// Returns the Sending Time field from CME binary packet header. + /// + /// @note This field is attributed to packet, not message. + /// Packet can contain several messages, so they will share same sending time. + /// + /// @warning Sending Time is not comparable to Receive Time as they are originated + /// from different non-synchronized clocks. + Timestamp sendingTime() const; + + /// Indicates local time when packet holding given message was received. + /// + /// @note This field is attributed to packet, not message. + /// Packet can contain several messages, so they will share same receive time. + /// + /// @note Timestamp is obtained by Timestamp::now() or Timestamp::utcNow() + /// (determined by OnixS::CME::MDP3::HandlerSettings::useUniversalTime option), + /// so its timezone can be either local or UTC. + /// + /// @warning Receive Time is not comparable to Sending Time as they are originated + /// from different non-synchronized clocks. + const Timestamp& receiveTime() const; + + /// Checks whether this message is last in packet. + bool lastInPacket() const; + + /// Returns the string representation of the message using + /// the given delimiter and additional control flags. + /// + /// @param delimiter Defines field delimiter to be used. + std::string + toString(char delimiter = 0x1) const + { + std::string str; + toString(str, delimiter); + return str; + } + + /// Appends string representation of the message using + /// the given delimiter and additional control flags. + /// + /// @param str String to which presentation is appended. + /// @param delimiter Defines field delimiter to be used. + void + toString ( + std::string& str, + char delimiter = 0x1) const; + + // Reassigns message as copy of other one. + Message& operator = (const Message&); + + private: + friend class MessageOperator; + + Message(void* packet, const void* core); + + private: + const void* core_; + void* packet_; + }; + + /// Simple wrapper for bitmap field + class ONIXS_CME_MDP3_API BitmapField + { + public: + + typedef UInt32 BaseType; + + /// Initializes bitmap field instance with explicit value. + explicit BitmapField(BaseType bits = 0) + : bits_(bits) + { + } + + /// Initializes bitmap field instance from FIX field set. + BitmapField(const FieldSet& msg, Tag tag) + : bits_(0) + { + msg.get(tag).toNumber(bits_); + } + + protected: + + bool state(BaseType bit) const + { + return (bits_ >> bit) & 1; + } + + bool any() const + { + return bits_ != 0; + } + + BaseType bits() const + { + return bits_; + } + + private: + BaseType bits_; + }; + + } + } +} + +namespace std +{ + // Outputs message into standard stream. + ONIXS_CME_MDP3_API + std::ostream& + operator <<( + std::ostream&, + const OnixS::CME::MDP3::Message&); +} diff --git a/linux/include/OnixS/CME/MDP3/Namespaces.h b/linux/include/OnixS/CME/MDP3/Namespaces.h new file mode 100755 index 000000000..f2e256546 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/Namespaces.h @@ -0,0 +1,33 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/Types.h" + +#if defined(ONIXS_CME_MDP3_USE_COMMON_NAMESPACE) + +namespace OnixS +{ + namespace CME + { + namespace MarketData = ::OnixS::CME::MDP3; + } +} + +#endif // ONIXS_CME_MDP3_USE_COMMON_NAMESPACE diff --git a/linux/include/OnixS/CME/MDP3/Numeric.h b/linux/include/OnixS/CME/MDP3/Numeric.h new file mode 100755 index 000000000..2299896e9 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/Numeric.h @@ -0,0 +1,506 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include +#include +#include +#include +#include + +#include "OnixS/CME/MDP3/Config.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + typedef int Int32; + typedef unsigned int UInt32; + + typedef long long Int64; + typedef unsigned long long UInt64; + + typedef double Double; + + typedef Int64 DecimalMantissa; + typedef Int32 DecimalExponent; + + /// Decimal type for better precision. + class + ONIXS_CME_MDP3_API + Decimal + { + public: + /// Initializes instance from compound components. + Decimal( + DecimalMantissa mantissa = 0, + DecimalExponent exponent = 0) + : mantissa_(mantissa) + , exponent_(exponent) + {} + + /// Converts Double value to decimal. + /// @param value double precision floating-point value. + /// @param precision defines conversion precision. + Decimal(Double value, size_t precision); + + /// Initializes as copy of given value. + Decimal(const Decimal& other) + : mantissa_(other.mantissa_) + , exponent_(other.exponent_) + {} + + /// Reinitializes instance from another one. + Decimal& operator=(const Decimal& other) + { + mantissa_ = other.mantissa_; + exponent_ = other.exponent_; + return *this; + } + + /// Returns mantissa part of decimal. + DecimalMantissa mantissa() const + { + return mantissa_; + } + + /// Updates mantissa part of decimal. + void mantissa(DecimalMantissa value) + { + mantissa_ = value; + } + + /// Returns exponent part of decimal. + DecimalExponent exponent() const + { + return exponent_; + } + + /// Updates exponent part of decimal. + void exponent(DecimalExponent value) + { + exponent_ = value; + } + + /// Null value. + static const Decimal Null; + + /// Checks is decimal null. + bool null() const; + + /// Compares two numbers. + bool operator ==(const Decimal&) const; + + /// Compares two numbers. + bool operator !=(const Decimal&) const; + + /// Establishes order between two values. + bool operator <(const Decimal&) const; + + /// Establishes order between two values. + bool operator >(const Decimal&) const; + + /// Casts to whole integer number as regular + /// floating point value is casted. + /// @throw domain_error exception on failure. + operator Int32() const; + + /// Casts to whole integer number as regular + /// floating point value is casted. + /// @throw domain_error exception on failure. + operator UInt32() const; + + /// Casts to whole integer number as regular + /// floating point value is casted. + /// @throw domain_error exception on failure. + operator Int64() const; + + /// Casts to whole integer number as regular + /// floating point value is casted. + /// @throw domain_error exception on failure. + operator UInt64() const; + + /// Casts to whole floating point as regular + /// value is casted to a smaller precision. + /// @throw domain_error exception on failure. + operator Double() const; + + /// Casts to whole integer number as regular + /// floating point value is casted. + /// @return false if conversion fails. + bool toNumber(Int32&) const; + + /// Casts to whole integer number as regular + /// floating point value is casted. + /// @return false if conversion fails. + bool toNumber(UInt32&) const; + + /// Casts to whole integer number as regular + /// floating point value is casted. + /// @return false if conversion fails. + bool toNumber(Int64&) const; + + /// Casts to whole integer number as regular + /// floating point value is casted. + /// @return false if conversion fails. + bool toNumber(UInt64&) const; + + /// Casts to double floating point number. + /// @return false if conversion fails. + bool toNumber(Double&) const; + + /// Fast cast to double floating point number. + /// @note For the sake of performance no range checks are done. + /// Result may be invalid if decimal cannot be represented as double value. + /// @warning Result may be different (less precise) from toNumber(Double&) + /// result due to performance vs precison trade-off. + Double toDoubleUnchecked() const; + + /// Fast cast from double floating point number. + /// @note For the sake of performance no range checks are done. + /// Result may be invalid if decimal cannot be represented as double value. + /// @warning Result may be different (less precise) from Decimal(Double, size_t) + /// result due to performance vs precison trade-off. + static Decimal fromDoubleUnchecked(Double value, size_t precision); + + /// Appends text presentation to given string. + void toString(std::string&) const; + + /// Returns text presentation of decimal. + std::string toString() const + { + std::string str; + toString(str); + return str; + } + + /// Attempts to parse decimal value + /// from its string/text presentation. + /// @return false on parsing failure. + static + bool + tryParse( + const char* buffer, + size_t bufferSize, + Decimal&); + + /// Parses decimal from string presentation. + /// @throw std::exception on failure. + static + Decimal + parse( + const char* buffer, + size_t bufferSize); + + private: + /// Mantissa. + DecimalMantissa mantissa_; + + /// Exponent. + DecimalExponent exponent_; + }; + + inline + Decimal::operator Int32() const + { + Int32 number; + + if (toNumber (number) ) + return number; + + throw std::domain_error ( + "Cannot cast value to target type. "); + } + + inline + Decimal::operator UInt32() const + { + UInt32 number; + + if (toNumber (number) ) + return number; + + throw std::domain_error ( + "Cannot cast value to target type. "); + } + + inline + Decimal::operator Int64() const + { + Int64 number; + + if (toNumber (number) ) + return number; + + throw std::domain_error ( + "Cannot cast value to target type. "); + } + + inline + Decimal::operator UInt64() const + { + UInt64 number; + + if (toNumber (number) ) + return number; + + throw std::domain_error ( + "Cannot cast value to target type. "); + } + + inline + Decimal::operator Double() const + { + Double number; + + if (toNumber (number) ) + return number; + + throw std::domain_error ( + "Cannot cast value to target type. "); + } + + namespace NumericDetails + { + static const int maxAbsPower10 = 20; + static const int powers10Size = maxAbsPower10 * 2 + 1; // Negative, positive and zero powers + + static const double powers10[] = + { + 1E-20, 1E-19, 1E-18, 1E-17, 1E-16, 1E-15, 1E-14, 1E-13, 1E-12, 1E-11, + 1E-10, 1E-9, 1E-8, 1E-7, 1E-6, 1E-5, 1E-4, 1E-3, 1E-2, 1E-1, + 1E0, + 1E1, 1E2, 1E3, 1E4, 1E5, 1E6, 1E7, 1E8, 1E9, 1E10, + 1E11, 1E12, 1E13, 1E14, 1E15, 1E16, 1E17, 1E18, 1E19, 1E20 + }; + + inline OnixS::CME::MDP3::Double fastPower10(int power) + { + const int offset = power + maxAbsPower10; + if(offset >= 0 && offset < powers10Size) + { + return powers10[offset]; + } + + throw std::invalid_argument("Invalid power argument, must be in range [-20, 20]"); + } + } + + inline + Double Decimal::toDoubleUnchecked() const + { + assert(!null()); + using namespace NumericDetails; + return mantissa_ * fastPower10(exponent_); + } + + inline + Decimal Decimal::fromDoubleUnchecked(Double value, size_t precision) + { + using namespace NumericDetails; + DecimalExponent convertedExponent = 0; + + Double dummy; + if(fabs(modf(value, &dummy)) != 0.0) + { + const DecimalExponent exp = static_cast(precision); + + // Apply last digit rounding + const Double rounding = 0.5 * fastPower10(-exp); + value += (value > 0) ? rounding : -rounding; + + value *= fastPower10(exp); + convertedExponent = -exp; + } + + return Decimal(static_cast(value), convertedExponent); + } + + /// Helper class for conversion from string to number. + struct + ONIXS_CME_MDP3_API + Number + { + static + bool + tryParse( + const char* buffer, + size_t bufferSize, + Int32& number); + + static + bool + tryParse( + const char* buffer, + size_t bufferSize, + UInt32& number); + + static + bool + tryParse( + const char* buffer, + size_t bufferSize, + Int64& number); + + static + bool + tryParse( + const char* buffer, + size_t bufferSize, + UInt64& number); + + static + bool + tryParse( + const char* buffer, + size_t bufferSize, + Double& number); + + static + bool + tryParse( + const char* buffer, + size_t bufferSize, + Decimal& number); + }; + + /// Comparator aggregate providing compare functions. + /// Such functions can be generic (slower, but able to deal + /// with any decimal) or fixed point based (faster, but assuming that + /// all compating values have the same exponent). + struct DecimalComparator + { + /// Comparing function signature. + typedef bool(*CompareFunction)(const Decimal&, const Decimal&); + + /// Comparing functions. + const CompareFunction equal; + const CompareFunction nonEqual; + const CompareFunction less; + const CompareFunction greater; + + /// Constructor. + DecimalComparator( + const CompareFunction equalFunc, + const CompareFunction nonEqualFunc, + const CompareFunction lessFunc, + const CompareFunction greaterFunc) + : equal(equalFunc) + , nonEqual(nonEqualFunc) + , less(lessFunc) + , greater(greaterFunc) + {} + + // Assigment operator: not defined. + DecimalComparator& operator=(const DecimalComparator&); + + /// Returns true if this instance is fixed point decimal comparator. + bool fixedPoint() const; + + /// Returns true if this instance is generic decimal comparator. + bool genericDecimal() const; + }; + + /// Helper functions for generic decimal case. + namespace GenericDecimal + { + inline bool equal(const Decimal& lhs, const Decimal& rhs) + { + return lhs == rhs; + } + + inline bool nonEqual(const Decimal& lhs, const Decimal& rhs) + { + return lhs != rhs; + } + + inline bool less(const Decimal& lhs, const Decimal& rhs) + { + return lhs < rhs; + } + + inline bool greater(const Decimal& lhs, const Decimal& rhs) + { + return lhs > rhs; + } + + ONIXS_CME_MDP3_API extern const DecimalComparator Comparator; + } + + /// Helper functions for CME fixed point decimal case. + namespace FixedPointDecimal + { + inline bool equal(const Decimal& lhs, const Decimal& rhs) + { + assert(lhs.exponent() == rhs.exponent() || lhs.null() || rhs.null()); + return lhs.mantissa() == rhs.mantissa(); + } + + inline bool nonEqual(const Decimal& lhs, const Decimal& rhs) + { + assert(lhs.exponent() == rhs.exponent() || lhs.null() || rhs.null()); + return lhs.mantissa() != rhs.mantissa(); + } + + inline bool less(const Decimal& lhs, const Decimal& rhs) + { + assert(lhs.exponent() == rhs.exponent() || lhs.null() || rhs.null()); + return lhs.mantissa() < rhs.mantissa(); + } + + inline bool greater(const Decimal& lhs, const Decimal& rhs) + { + assert(lhs.exponent() == rhs.exponent() || lhs.null() || rhs.null()); + return lhs.mantissa() > rhs.mantissa(); + } + + ONIXS_CME_MDP3_API extern const DecimalComparator Comparator; + } + + inline + bool + DecimalComparator::fixedPoint() const + { + return this == &FixedPointDecimal::Comparator; + } + + inline + bool + DecimalComparator::genericDecimal() const + { + return this == &GenericDecimal::Comparator; + } + + static const DecimalComparator& + defaultDecimalComparator = GenericDecimal::Comparator; + } + } +} + +namespace std +{ + // Outputs decimal into standard stream. + ONIXS_CME_MDP3_API + std::ostream& + operator <<( + std::ostream&, + const OnixS::CME::MDP3::Decimal&); +} diff --git a/linux/include/OnixS/CME/MDP3/Replay.h b/linux/include/OnixS/CME/MDP3/Replay.h new file mode 100755 index 000000000..6f69c4787 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/Replay.h @@ -0,0 +1,124 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include +#include +#include + +#include "OnixS/CME/MDP3/Types.h" +#include "OnixS/CME/MDP3/Version.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + + /// Ordered list of logs to be replayed. + typedef + std::vector + HandlerLogs; + + /// Listening interface for log replay-related events. + class ONIXS_CME_MDP3_API ReplayListener + { + public: + /// Is called once error occurs while replaying logs. + virtual void onReplayError( + const ChannelId& channelId, + const std::string& errorDescription) = 0; + + /// Is called once all the logs are replayed. + virtual void onReplayFinished( + const ChannelId& channelId) = 0; + + protected: + /// Deletion is not supposed + /// through interface of this class. + virtual ~ReplayListener(); + }; + + /// Defines parameters which affect logs replay. + struct ONIXS_CME_MDP3_API ReplayOptions + { + /// This setting makes log replay to use only original timestamps + /// of replayed packets for produced log. All packet subsequent + /// events will be logged with this packet receive timestamp + /// instead of current time. + /// + /// @note Default setting is 'false'. + bool reusePacketTimestampForLog() const + { + return reusePacketTimestampForLog_; + } + + /// Sets reusePacketTimestampForLog. @see reusePacketTimestampForLog. + void reusePacketTimestampForLog(bool value) + { + reusePacketTimestampForLog_ = value; + } + + /// List of instruments logs to be replayed. + /// Must be stored in 'oldest to recent' order. + const HandlerLogs& logs() const + { + return *logs_; + } + + /// @see logs. + HandlerLogs& logs() + { + return *logs_; + } + + /// Initializes instance with default values. + explicit ReplayOptions( + ReplayListener* listener = NULL); + + /// Initializes with all the logs which are available + /// for given channel id and are stored in a given folder. + ReplayOptions( + const ChannelId& channel, + const std::string& logsRoot, + ReplayListener* listener = NULL); + + /// Initializes with all the logs which are available + /// for given channel id and are stored in a given folder + /// with corresponding log file name prefix. + ReplayOptions( + const ChannelId& channel, + const std::string& logsRoot, + const std::string& logFileNamePrefix, + ReplayListener* listener = NULL); + + /// Cleans up allocated resources. + ~ReplayOptions(); + + private: + friend class LogPlayer; + ReplayListener* listener_; + bool reusePacketTimestampForLog_; + Exportable logs_; + }; + + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/RequestForQuote.h b/linux/include/OnixS/CME/MDP3/RequestForQuote.h new file mode 100755 index 000000000..3bba8bd8c --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/RequestForQuote.h @@ -0,0 +1,200 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/Tags.h" +#include "OnixS/CME/MDP3/Messaging.h" +#include "OnixS/CME/MDP3/EventIndicator.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + + /// Known requested sides. + struct ONIXS_CME_MDP3_API RequestedSides + { + /// Known requested sides. + enum Enum + { + /// Identifies absence of value. + Undefined = -1, + + /// Requested buy. + Buy = 1, + + /// Requested sell. + Sell = 2, + + /// Requested cross order (Request For Cross AKA RFC). + Cross = 8 + }; + + /// Returns constant from its string representation. + static Enum deserialize(const char* text); + + /// Returns string representation of given constant. + static const char* toString(Enum value); + }; + + typedef RequestedSides::Enum RequestedSide; + + /// Known requested quote types. + struct ONIXS_CME_MDP3_API RequestedQuoteTypes + { + /// Known requested quote types. + enum Enum + { + /// Identifies absence of value. + Undefined = -1, + + /// Requested tradable quote. + Tradable = 1 + }; + + /// Returns constant from its string representation. + static Enum deserialize(const char* text); + + /// Returns string representation of given constant. + static const char* toString(Enum value); + }; + + typedef RequestedQuoteTypes::Enum RequestedQuoteType; + + /// Request For Quote (tag 35-MsgType=R) single entry. + class + ONIXS_CME_MDP3_API + RequestForQuote + { + public: + /// Initializes instance from given FIX message group entry. + explicit RequestForQuote( + const GroupInstance& entry) + : entry_(entry) + { + } + + /// Start of event processing time (UTC) with nanoseconds precision. + /// @note Required field + Timestamp transactTime() const + { + return entry_.message().getTimestamp( + Tags::TransactTime, SinceEpochUnits::Nanoseconds); + } + + /// Market data events present in the FIX message + /// which is the data source for given object. + EventIndicator eventIndicator() const + { + return EventIndicator(entry_.message()); + } + + /// Exchange ID of Quote Request event. + /// @note Optional field. + bool quoteReqId(QuoteReqId& id) const + { + return entry_.message().get(Tags::QuoteReqID).toStringRef(id); + } + + /// Requested symbol or instrument name. + /// @note Required field. + StringRef symbol() const + { + return entry_.getStringRef(Tags::Symbol); + } + + /// Unique security ID of requested symbol. + /// @note Required field. + SecurityId securityId() const + { + return entry_.getInt32(Tags::SecurityID); + } + + /// The type of the requested quote. + /// @note Required field. + RequestedQuoteType quoteType() const + { + return getIntEnumFieldValue( + entry_, Tags::QuoteType); + } + + /// The order quantity of the requested quote. + /// @note Optional field. + bool orderQty(SignedQuantity& qty) const + { + return entry_.get(Tags::OrderQty).toNumber(qty); + } + + /// The side of the requested quote. + /// @note Optional field. + RequestedSide side() const + { + return getIntEnumFieldValue( + entry_, Tags::Side); + } + + /// Returns group entry (FIX fields) of underlying message. + /// Group entry contains all the data related with given request for quote. + const GroupInstance& entry() const + { + return entry_; + } + + /// Returns string representation of an object. + std::string toString() const + { + std::string str; + + toString(str); + + return str; + } + + /// Appends string representation of an object. + void toString(std::string&) const; + + private: + RequestForQuote(const RequestForQuote&); + RequestForQuote& operator=(const RequestForQuote&); + + const GroupInstance entry_; + }; + + /// Request For Quote listener. + class + ONIXS_CME_MDP3_API + RequestForQuoteListener + { + public: + /// Is called for each requested symbol + /// when a Request For Quote (35=R) FIX message is received. + virtual + void + onRequestForQuote( + const RequestForQuote& request, + const ChannelId& channelId) = 0; + + protected: + virtual ~RequestForQuoteListener(); + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/SecurityDefinition.h b/linux/include/OnixS/CME/MDP3/SecurityDefinition.h new file mode 100755 index 000000000..7b0a2f5be --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/SecurityDefinition.h @@ -0,0 +1,1261 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/Types.h" +#include "OnixS/CME/MDP3/Tags.h" +#include "OnixS/CME/MDP3/Messaging.h" +#include "OnixS/CME/MDP3/EventIndicator.h" +#include "OnixS/CME/MDP3/SettlementPriceType.h" +#include "OnixS/CME/MDP3/SecurityStatus.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + + /// Security update actions. + struct + ONIXS_CME_MDP3_API + SecurityUpdateActions + { + enum Enum + { + /// Used to identify absence of value. + Undefined = -1, + + /// Represents Security Definition messages that are : + /// - Newly added during the current week; + /// - Disseminated during the Sunday Startup period; + /// - Resent by the system during the week. + Add = 'A', + + /// Represents deletions of a Security Definition. + Delete = 'D', + + /// Represents modifications to a Security Definition. + Modify = 'M' + }; + }; + + typedef + SecurityUpdateActions::Enum + SecurityUpdateAction; + + /// Indicates the product complex. + struct + ONIXS_CME_MDP3_API + UnderlyingProducts + { + enum Enum + { + /// Used to identify absence of value. + Undefined = -1, + + /// Commodity/Agriculture. + CommodityOrAgriculture= 2, + + /// Currency. + Currency = 4, + + /// Equity. + Equity = 5, + + /// Other. + Other = 12, + + /// Interest rate. + InterestRate = 14, + + /// FX cash. + FxCash = 15, + + /// Energy. + Energy = 16, + + /// Metals. + Metals = 17 + }; + }; + + /// Indicates the product complex. + typedef + UnderlyingProducts::Enum + UnderlyingProduct; + + /// Matching Algorithms. + struct + ONIXS_CME_MDP3_API + MatchAlgorithms + { + enum Enum + { + /// Used to identify absence of value. + Undefined = -1, + + /// FIFO. + Fifo = 'F', + + /// Split FIFO or Pro-Rata. + SplitFifoOrProRata = 'K', + + /// Pro-Rata. + ProRata = 'C', + + /// Allocation. + Allocation = 'A', + + /// FIFO with LMM. + FifoWithLmm = 'T', + + /// Threshold Pro-Rata. + ThresholdProRata = 'O', + + /// FIFO with top and LMM. + FifoWithTopAndLmm = 'S', + + /// Threshold Pro-Rata with LMM. + ThresholdProRataWithLmm = 'Q', + + /// Euro/Dollar options. + EuroDollarOptions = 'Y' + }; + }; + + typedef + MatchAlgorithms::Enum + MatchAlgorithm; + + /// Indicates the type of multiplier being applied to the product. + struct + ONIXS_CME_MDP3_API + ContractMultiplierUnits + { + enum Enum + { + /// Used to identify absence of value. + Undefined = -1, + + /// Multiplied by hour. + MultipliedByHour = 1, + + /// Multiplied by day. + MultipliedByDay = 2 + }; + }; + + typedef + ContractMultiplierUnits::Enum + ContractMultiplierUnit; + + /// The schedule according to which the electricity is delivered + /// in a physical contract, or priced in a financial contract. + struct + ONIXS_CME_MDP3_API + FlowScheduleTypes + { + enum Enum + { + /// Used to identify absence of value. + Undefined = -1, + + /// NERC Eastern Off-Peak. + EasternOffPeak = 0, + + /// NERC Western Off-Peak. + WesternOffPeak = 1, + + /// Calendar-All Days in month. + Calendar = 2, + + /// NERC Eastern Peak. + EasternPeak = 3, + + /// NERC Western Peak. + WesternPeak = 4 + }; + }; + + typedef + FlowScheduleTypes::Enum + FlowScheduleType; + + /// Leg sides (buy or sell). + struct + ONIXS_CME_MDP3_API + LegSides + { + enum Enum + { + /// Used to identify absence of value. + Undefined = -1, + + /// Buy side. + Buy = 1, + + /// Sell side. + Sell = 2 + }; + }; + + typedef + LegSides::Enum + LegSide; + + struct + ONIXS_CME_MDP3_API + EventTypes + { + enum Enum + { + /// Used to identify absence of value. + Undefined = -1, + + /// Activation. + Activation = 5, + + /// Last eligible trade date. + LastEligibleTradeDate = 7 + }; + }; + + typedef + EventTypes::Enum + EventType; + + /// Available instrument attribute types. + struct ONIXS_CME_MDP3_API InstrumentAttributeTypes + { + enum Enum + { + /// Used to identify absence of value. + Undefined = -1, + + /// Instrument eligibility. + Eligibility = 24 + }; + }; + + typedef + InstrumentAttributeTypes::Enum + InstrumentAttributeType; + + /// Available lot types. + struct + ONIXS_CME_MDP3_API + LotTypes + { + enum Enum + { + /// Used to identify absence of value. + Undefined = -1, + + /// Minimum order entry quantity for an instrument. + MinimumOrderEntryQtyForAnInstrument = 2, + + /// The minimum qty required for a block trade. + MinimumQtyRequiredForBlockTrade = 3, + + /// The round lot for Variable Quantity Products. + RoundLot = 4 + }; + }; + + typedef + LotTypes::Enum + LotType; + + /// Available option types. + struct + ONIXS_CME_MDP3_API + OptionTypes + { + enum Enum + { + /// Used to identify absence of value. + Undefined = -1, + + /// Put option. + Put = 0, + + /// Call option. + Call = 1 + }; + }; + + typedef + OptionTypes::Enum + OptionType; + + inline + bool + getYearMonth( + const FieldSet& fieldSet, + Tag tag, + YearMonth& yearMonth) + { + const FieldValueRef valueRef = fieldSet.get(tag); + StringRef yearMonthStr; + if(valueRef && valueRef.toStringRef(yearMonthStr)) + { + yearMonth = YearMonth::deserialize(yearMonthStr); + return true; + } + + return false; + } + + /// Events of a security definition. + class + ONIXS_CME_MDP3_API + Event : public GroupInstance + { + public: + /// Cleans up underlying resources. + ~Event() + { + } + + /// Code to represent the type of event. + EventType type() const + { + return getIntEnumFieldValue(*this, Tags::EventType); + } + + /// Time of event. + Timestamp time() const + { + return getTimestamp(Tags::EventTime, SinceEpochUnits::Nanoseconds); + } + + private: + friend class TypedGroup; + Event(const GroupInstance& entry) + : GroupInstance(entry) + { + } + }; + + /// Security events group. + class ONIXS_CME_MDP3_API Events : public TypedGroup + { + private: + Events (const Group& group) + : TypedGroup (group) + { + } + + friend class SecurityDefinition; + }; + + /// Feed types of a security definition. + class + ONIXS_CME_MDP3_API + MarketDataFeedType: public GroupInstance + { + public: + /// Cleans up underlying resources. + ~MarketDataFeedType() + {} + + /// Describes a class of service for a given data feed. + /// GBX- Real Book, GBI-Implied Book. + StringRef type() const + { + return getStringRef(Tags::MDFeedType); + } + + /// Book depth. + Int32 marketDepth() const + { + return getInt32(Tags::MarketDepth); + } + + private: + friend class TypedGroup; + MarketDataFeedType(const GroupInstance& entry) + : GroupInstance(entry) + {} + }; + + /// Security feed types. + class ONIXS_CME_MDP3_API MarketDataFeedTypes: + public TypedGroup + { + private: + MarketDataFeedTypes(const Group& group) + : TypedGroup(group) + {} + + friend class SecurityDefinition; + }; + + /// Strategy leg attributes. + class ONIXS_CME_MDP3_API Leg : public GroupInstance + { + public: + /// Cleans up underlying resources. + ~Leg() + { + } + + /// Unique instrument ID for the leg. + SecurityId securityId() const + { + return getInt32(Tags::LegSecurityID); + } + + /// Identifies class or source of the leg security ID (Tag 602) value. + /// This tag is always '8' for CME. + StringRef securityIdSource() const + { + return getStringRef(Tags::LegSecurityIDSource); + } + + /// The side of the leg for this repeating group. + LegSide side() const + { + return getIntEnumFieldValue(*this, Tags::LegSide); + } + + /// The ratio of quantity for this individual leg + /// relative to the entire multi-leg instrument. + Quantity ratioQty() const + { + return getUInt32(Tags::LegRatioQty); + } + + /// Price for a futures leg of a covered. + bool price(Price& price) const + { + return get(Tags::LegPrice).toNumber(price); + } + + /// Delta used to calculate the quantity of futures + /// used to cover the option or option strategy. + bool optionDelta(FloatQuantity& qty) const + { + return get(Tags::LegOptionDelta).toNumber(qty); + } + + private: + friend class TypedGroup; + + Leg(const GroupInstance& entry) + : GroupInstance(entry) + { + } + }; + + /// Strategy legs group. + class ONIXS_CME_MDP3_API Legs : public TypedGroup + { + private: + Legs (const Group& group) + : TypedGroup (group) + { + } + + friend class SecurityDefinition; + }; + + /// Underlying security attributes. + class ONIXS_CME_MDP3_API Underlying : public GroupInstance + { + public: + + /// Cleans up underlying resources. + ~Underlying() + { + } + + /// Unique instrument ID as qualified by the exchange. + SecurityId securityId() const + { + return getUInt32(Tags::UnderlyingSecurityID); + } + + /// Identifies class or source of the underlying security ID (Tag 309) value. + /// This tag is always '8' for CME. + StringRef securityIdSource() const + { + return getStringRef(Tags::UnderlyingSecurityIDSource); + } + + /// Underlying Instrument Name or Symbol. + /// This value will be the same as that contained in Leg Instrument’s + /// Security Definition Tag 55-Symbol. + StringRef symbol() const + { + StringRef val; + return get(Tags::UnderlyingSymbol).toStringRef(val) ? val : StringRef(); + } + + private: + friend class TypedGroup; + + Underlying( + const GroupInstance& entry) + : GroupInstance(entry) + { + } + }; + + /// Underlying securities group. + class ONIXS_CME_MDP3_API Underlyings : public TypedGroup + { + private: + Underlyings (const Group& group) + : TypedGroup (group) + { + } + + friend class SecurityDefinition; + }; + + ONIXS_CME_MDP3_API_DECL(class, InstrumentAttribute); + + /// Security eligibility bitmap field. + class ONIXS_CME_MDP3_API Eligibility: BitmapField + { + public: + + /// Initializes from instrument attribute containing Tag 871-InstAttribType + /// equal to Eligibility and Tag 872-InstAttribValue. + /// @note Attribute type is checked to be equal to Eligibility. + /// If it's different or missing empty instance is created. + Eligibility(const InstrumentAttribute* attr = NULL); + + /// Initializes from instrument attribute containing Tag 872-InstAttribValue. + /// @note No actual checking for attribute type is done. + Eligibility(const InstrumentAttribute& attr); + + /// Checks whether given attribute is valid and contains Eligibility value. + static bool validAttribute(const InstrumentAttribute& attr); + + /// Indicates product is Electronic Match Eligible. + bool isElectronicMatch() const + { + return state(Bits::ElectronicMatch); + } + + /// Indicates product is Order Cross Eligible. + bool isOrderCross() const + { + return state(Bits::OrderCross); + } + + /// Indicates product is Block Trade Eligible. + bool isBlockTrade() const + { + return state(Bits::BlockTrade); + } + + /// Indicates product is EFP Eligible. + bool isEFP() const + { + return state(Bits::EFP); + } + + /// Indicates product is EBF Eligible. + bool isEBF() const + { + return state(Bits::EBF); + } + + /// Indicates product is EFS Eligible. + bool isEFS() const + { + return state(Bits::EFS); + } + + /// Indicates product is EFR Eligible. + bool isEFR() const + { + return state(Bits::EFR); + } + + /// Indicates product is OTC Eligible. + bool isOTC() const + { + return state(Bits::OTC); + } + + /// Indicates product is iLink Indicative Mass Quoting Eligible. + bool isILinkIndicativeMassQuoting() const + { + return state(Bits::ILinkIndicativeMassQuoting); + } + + /// Indicates product is Negative Strike Eligible. + bool isNegativeStrike() const + { + return state(Bits::NegativeStrike); + } + + /// Indicates product is Negative Price Outright Eligible. + bool isNegativePriceOutright() const + { + return state(Bits::NegativePriceOutright); + } + + /// Indicates product has fractional display price. + bool isFractional() const + { + return state(Bits::IsFractional); + } + + /// Indicates product is RFQ Cross Eligible. + bool isRFQCross() const + { + return state(Bits::RFQCross); + } + + /// Indicates product is Zero Price Outright Eligible. + bool isZeroPriceOutright() const + { + return state(Bits::ZeroPriceOutright); + } + + /// Indicates Decaying Product Eligibility. + bool isDecayingProduct() const + { + return state(Bits::DecayingProduct); + } + + /// Indicates Variable Product Eligibility. + bool isVariableProduct() const + { + return state(Bits::VariableProduct); + } + + /// Indicates Daily Product Eligibility. + bool isDailyProduct() const + { + return state(Bits::DailyProduct); + } + + /// Indicates GT Orders Eligibility (Previously Tag 827). + bool isGTOrders() const + { + return state(Bits::GTOrders); + } + + /// Indicates Implied Matching Eligibility (Previously tag 1144). + bool isImpliedMatching() const + { + return state(Bits::ImpliedMatching); + } + + private: + + struct Bits + { + enum Enum + { + ElectronicMatch = 0, + OrderCross = 1, + BlockTrade = 2, + EFP = 3, + EBF = 4, + EFS = 5, + EFR = 6, + OTC = 7, + ILinkIndicativeMassQuoting = 8, + NegativeStrike = 9, + NegativePriceOutright = 10, + IsFractional = 11, + // Bit 12 is currently not used (was VolatilityQuotedOption). + RFQCross = 13, + ZeroPriceOutright = 14, + DecayingProduct = 15, + VariableProduct = 16, + DailyProduct = 17, + GTOrders = 18, + ImpliedMatching = 19 + // Bits 20-32 are reserved. + }; + }; + + }; + + /// Instrument attribute. + class ONIXS_CME_MDP3_API InstrumentAttribute : public GroupInstance + { + public: + + /// Cleans up underlying resources. + ~InstrumentAttribute() + { + } + + /// Indicates the type of value that the value() returns. + InstrumentAttributeType type() const + { + return getIntEnumFieldValue( + *this, Tags::InstrAttribType); + } + + /// Attribute value appropriate to the type field. + Eligibility value() const + { + return Eligibility(this); + } + + private: + friend class TypedGroup; + + InstrumentAttribute( + const GroupInstance& entry) + : GroupInstance(entry) + { + } + }; + + inline Eligibility::Eligibility(const InstrumentAttribute& attr) + : BitmapField(attr.getUInt32(Tags::InstrAttribValue)) + {} + + inline Eligibility::Eligibility(const InstrumentAttribute* attr) + : BitmapField(attr && validAttribute(*attr) ? + attr->getUInt32(Tags::InstrAttribValue) : 0) + {} + + inline bool Eligibility::validAttribute(const InstrumentAttribute& attr) + { + return attr.type() == InstrumentAttributeTypes::Eligibility; + } + + /// Instrument Attributes group. + class ONIXS_CME_MDP3_API InstrumentAttributes : public TypedGroup + { + private: + InstrumentAttributes (const Group& group) + : TypedGroup (group) + { + } + + friend class SecurityDefinition; + }; + + /// Lot type rule. + struct ONIXS_CME_MDP3_API LotTypeRule : public GroupInstance + { + public: + + /// Cleans up underlying resources. + ~LotTypeRule() + { + } + + /// The quantity type used for the leg of the spread. + LotType type() const + { + return getIntEnumFieldValue(*this, Tags::LotType); + } + + /// Minimum quantity accepted for order entry. + /// If LotType is this value is the minimum quantity + /// for order entry expressed in the applicable units, + /// specified in tag 996-UnitOfMeasure, (e.g., megawatts). + bool minLotSize(FloatQuantity& size) const + { + return get(Tags::MinLotSize).toNumber(size); + } + + private: + friend class TypedGroup; + + LotTypeRule( + const GroupInstance& entry) + : GroupInstance(entry) + { + } + }; + + /// Lot type rules group. + class ONIXS_CME_MDP3_API LotTypeRules : public TypedGroup + { + private: + LotTypeRules (const Group& group) + : TypedGroup (group) + { + } + + friend class SecurityDefinition; + }; + + /// Security Definition. + class ONIXS_CME_MDP3_API SecurityDefinition + { + public: + + /// Initializes instance from given FIX message. + SecurityDefinition(const Message&); + + /// Market data events present in the message containing given instance. + EventIndicator eventIndicator() const + { + return EventIndicator(message_); + } + + /// Total number of instruments in the Replay loop.Used on Replay Feed only. + bool totNumReports(UInt32& value) const + { + return message_.get(Tags::TotNumReports).toNumber(value); + } + + /// Action related to the current security definition instance. + SecurityUpdateAction securityUpdateAction() const + { + return getCharEnumFieldValue( + message_, Tags::SecurityUpdateAction); + } + + /// Events entries. + Events events() const + { + return Events(message_.getGroup(Tags::NoEvents)); + } + + /// Timestamp of when the instrument was last added, modified or deleted. + Timestamp lastUpdateTime() const + { + return message_.getTimestamp(Tags::LastUpdateTime, + SinceEpochUnits::Nanoseconds); + } + + /// Security type. + StringRef securityType() const + { + return message_.getStringRef(Tags::SecurityType); + } + + /// VTT code. Provided for instruments with variable tick in addition to Tick + /// Size in tag 969 MinPriceIncrement. For VTT ineligible instruments, this field + /// will be sent as null. + bool tickRule(UInt32& value) const + { + return message_.get(Tags::TickRule).toNumber(value); + } + + /// Price Denominator of Main Fraction. + bool mainFraction(UInt32& value) const + { + return message_.get(Tags::MainFraction).toNumber(value); + } + + /// Price Denominator of Sub Fraction. + bool subFraction(UInt32& value) const + { + return message_.get(Tags::SubFraction).toNumber(value); + } + + /// Number of Decimals in Displayed Price. + bool priceDisplayFormat(UInt32& value) const + { + return message_.get(Tags::PriceDisplayFormat).toNumber(value); + } + + /// Bitmap field of eight Boolean type indicators + /// representing settlement price type. + SettlementPriceType settlPriceType() const + { + return SettlementPriceType(message_); + } + + /// Identifies the market segment. Populated for all CME Globex instruments. + bool marketSegmentId(MarketSegmentId& id) const + { + return message_.get(Tags::MarketSegmentID).toNumber(id); + } + + /// Reference price for prelisted instruments or the last calculated + /// Settlement, which can be Theoretical, Preliminary or + /// a Final Settlement of the session. + bool tradingReferencePrice(Price& price) const + { + return message_.get(Tags::TradingReferencePrice).toNumber(price); + } + + /// Upper price threshold for the instrument. + /// Orders submitted with prices above the + /// upper limit will be rejected. + bool highLimitPrice(Price& price) const + { + return message_.get(Tags::HighLimitPrice).toNumber(price); + } + + /// Lower price threshold for the instrument. + /// Orders submitted with prices below the lower + /// limit will be rejected. + bool lowLimitPrice(Price& price) const + { + return message_.get(Tags::LowLimitPrice).toNumber(price); + } + + /// An exchange specific code assigned to a group of related securities, + /// which are concurrently affected by market events. + StringRef securityGroup() const + { + return message_.getStringRef(Tags::SecurityGroup); + } + + /// Instrument Name or Symbol. e.g. ‘6EN2 P1220’, 6AZ4 + StringRef symbol() const + { + return message_.getStringRef(Tags::Symbol); + } + + /// String field that indicates the underlying asset code (Product Code). + /// Example: GE (Eurodollars), ES (E-Minis). + StringRef asset() const + { + return message_.getStringRef(Tags::Asset); + } + + /// Unique instrument id (FIX tag 48) as qualified + /// by the exchange per tag 22-SecurityIDSource. + /// Returns 'false' if no data (FIX tag) available + /// in underlying security definition message. + SecurityId securityId() const + { + return message_.getUInt32(Tags::SecurityID); + } + + /// Identifies class or source of the security ID (Tag 48) value. + /// This tag is always '8' for CME. + StringRef securityIdSource() const + { + return message_.getStringRef(Tags::SecurityIDSource); + } + + /// Indicates the type of security using ISO 10962 standard, + /// Classification of Financial Instruments (CFI code) values. + /// ISO 10962 is maintained by ANNA (association of National + /// Numbering Agencies) acting as registration Authority. + StringRef CFICode() const + { + return message_.getStringRef(Tags::CFICode); + } + + /// Indicates the option type (Put or Call). + OptionType putOrCall() const + { + return getIntEnumFieldValue(message_, Tags::PutOrCall); + } + + /// Indicates the product complex. + UnderlyingProduct underlyingProduct() const + { + return getIntEnumFieldValue( + message_, Tags::UnderlyingProduct); + } + + /// Exchange used to identify a security. + StringRef securityExchange() const + { + return message_.getStringRef(Tags::SecurityExchange); + } + + /// Accesses to security trading status if available. + SecurityTradingStatus tradingStatus() const + { + return getIntEnumFieldValue( + message_, Tags::MDSecurityTradingStatus); + } + + /// The channel ID as defined in the XML Configuration file. + Int32 applId() const + { + return message_.getInt32(Tags::ApplID); + } + + /// Defines cabinet price for outright options products. + bool minCabPrice(Price& price) const + { + return message_.get(Tags::MinCabPrice).toNumber(price); + } + + /// This field contains the contract size for each instrument. + bool unitOfMeasureQty(FloatQuantity& qty) const + { + return message_.get(Tags::UnitOfMeasureQty).toNumber(qty); + } + + /// Strike Price for an option. + bool strikePrice(Price& price) const + { + return message_.get(Tags::StrikePrice).toNumber(price); + } + + /// Currency in which the StrikePrice is denominated. + StringRef strikeCurrency() const + { + StringRef val; + return message_.get(Tags::StrikeCurrency).toStringRef(val) ? val : StringRef(); + } + + /// The minimum trading volume for a security. + bool minTradeVol(Quantity& volume) const + { + return message_.get(Tags::MinTradeVol).toNumber(volume); + } + + /// The maximum trading volume for a security. + bool maxTradeVol(Quantity& volume) const + { + return message_.get(Tags::MaxTradeVol).toNumber(volume); + } + + /// Identifies currency used for price. + /// Absence of this field is interpreted as the default + /// for the security. It is recommended that systems + /// provide the currency value whenever possible. + StringRef currency() const + { + return message_.getStringRef(Tags::Currency); + } + + /// Identifies currency used for settlement price. + StringRef settlCurrency() const + { + StringRef val; + return message_.get(Tags::SettlCurrency).toStringRef(val) ? val : StringRef(); + } + + /// Retrieves depth values for direct and implied book. + /// @note Assigns zero in case of book depth value absence. + void bookDepths(MarketDepth& direct, MarketDepth& implied) const; + + /// Matching Algorithm - CME assigned values. + MatchAlgorithm matchAlgorithm() const + { + return getCharEnumFieldValue(message_, Tags::MatchAlgorithm); + } + + /// Strategy type. + StringRef securitySubType() const + { + StringRef val; + return message_.get(Tags::SecuritySubType).toStringRef(val) + ? val : StringRef(); + } + + /// Underlying legs that make up the security. + Underlyings underlyings() const + { + return Underlyings(message_.getOptionalGroup(Tags::NoUnderlyings)); + } + + /// Differential value for price banding. + bool maxPriceVariation(Price& price) const + { + return message_.get(Tags::MaxPriceVariation).toNumber(price); + } + + /// Collection of instrument attributes. + InstrumentAttributes instrumentAttributes() const + { + return InstrumentAttributes(message_.getGroup(Tags::NoInstrAttrib)); + } + + /// Security eligibility bitmap contained in Instrument Attributes, Type=24. + /// @note This function returns data from the first found Instrument + /// Attributes group instance of Type=24. + Eligibility eligibility() const + { + const InstrumentAttributes& attrs = instrumentAttributes(); + for(size_t i = 0; i < attrs.size(); ++i) + { + if(Eligibility::validAttribute(attrs[i])) + { + return Eligibility(attrs[i]); + } + } + return Eligibility(); + } + + /// This field provides the actual calendar date for contract maturity - + /// month and year (used for standardized futures and options) - fmt YYYYMM. + /// For futures spreads and options spreads, this field contains + /// the first leg maturity (YYYYMMDD). + /// For packs and bundles, this value represents the rollover date (YYYYMMDD). + /// For daily products, this tag contains the daily maturity (YYYYMMDD). + /// For weekly options products, this tag contains the weekly maturity (YYYYMMWW) + /// denoted 1, 2, 3, 4, or 5. + bool maturityMonthYear(YearMonth& yearMonth) const + { + return getYearMonth(message_, Tags::MaturityMonthYear, yearMonth); + } + + /// Minimum constant tick for the instrument, + /// sent only if instrument is non-VTT (Variable + /// Tick Table) eligible. + bool minPriceIncrement(Price& increment) const + { + return message_.get(Tags::MinPriceIncrement).toNumber(increment); + } + + /// Minimum price increment amount associated with the MinPriceIncrement (969). + bool minPriceIncrementAmount(Amount& increment) const + { + return message_.get(Tags::MinPriceIncrementAmount).toNumber(increment); + } + + /// Contains the multiplier to convert the CME + /// Globex display price to the conventional price. + bool displayFactor(PriceFactor& factor) const + { + return message_.get(Tags::DisplayFactor).toNumber(factor); + } + + /// Collection of legs. + Legs legs() const + { + return Legs(message_.getOptionalGroup(Tags::NoLegs)); + } + + /// Collection of feed types. + MarketDataFeedTypes feedTypes() const + { + return MarketDataFeedTypes(message_.getGroup(Tags::NoMdFeedTypes)); + } + + /// Identifies user-defined instruments. + bool userDefinedInstrument() const + { + return message_.hasFlag(Tags::UserDefinedInstrument); + } + + /// Used for price calculation in spread and leg pricing. + bool priceRatio(PriceFactor& ratio) const + { + return message_.get(Tags::PriceRatio).toNumber(ratio); + } + + /// Indicates the type of multiplier being applied to the product. + /// Optionally used in combination with tag 231-ContractMultiplier. + ContractMultiplierUnit contractMultiplierUnit() const + { + return getIntEnumFieldValue( + message_, Tags::ContractMultiplierUnit); + } + + /// The schedule according to which the electricity is delivered + /// in a physical contract, or priced in a financial contract. + /// Specifies whether the contract is defined according to the + /// Easter Peak, Eastern Off-Peak, Western Peak or Western Off-Peak. + FlowScheduleType flowScheduleType() const + { + return getIntEnumFieldValue( + message_, Tags::FlowScheduleType); + } + + /// Number of deliverable units per instrument, e.g., peak days + /// in maturity month or number of calendar days in maturity month. + /// Security Definition for the variable quantity spread will be + /// populated with the value '0' for ContractMultiplier. + /// Security Definition is populated with values for the outright + /// legs for ContractMultiplier and customers must extract this value. + bool contractMultiplier(SignedQuantity& multiplier) const + { + return message_.get(Tags::ContractMultiplier).toNumber(multiplier); + } + + /// Unit of measure for the products' original contract size. + /// This will be populated for all products listed on CME Globex. + StringRef unitOfMeasure() const + { + StringRef val; + return message_.get(Tags::UnitOfMeasure).toStringRef(val) ? val : StringRef(); + } + + /// Indicates the quantity that a contract will decay daily by once + /// the decay start date is reached. + bool decayQty(SignedQuantity& decayBy) const + { + return message_.get(Tags::DecayQty).toNumber(decayBy); + } + + /// Indicates the date at which a decay contract will begin to decay. + bool decayStartDate(Timestamp& date) const + { + return getDate(message_, Tags::DecayStartDate, date); + } + + /// Fixed contract value assigned to a product. + bool originalContractSize(SignedQuantity& size) const + { + return message_.get(Tags::OriginalContractSize).toNumber(size); + } + + /// Indicates the total cleared volume of instruments + /// traded during the prior trading session. + bool clearedVolume(SignedQuantity& volume) const + { + return message_.get(Tags::ClearedVolume).toNumber(volume); + } + + /// Indicates the total open interest for the market + /// at the close of the prior trading session. + bool openInterestQty(SignedQuantity& qty) const + { + return message_.get(Tags::OpenInterestQty).toNumber(qty); + } + + /// Quantity types. + LotTypeRules lotTypeRules() const + { + return LotTypeRules(message_.getGroup(Tags::NoLotTypeRules)); + } + + /// Trading reference date. + bool tradingReferenceDate(Timestamp& date) const + { + return getDate(message_, Tags::TradingReferenceDate, date); + } + + /// The source FIX Security Definition (35=d) message. + const Message& message() const + { + return message_; + } + + /// Returns string representation of an object. + std::string toString() const + { + std::string str; + + toString(str); + + return str; + } + + /// Appends string representation of an object. + void toString(std::string&) const; + + private: + Message message_; + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/SecurityDefinitionListener.h b/linux/include/OnixS/CME/MDP3/SecurityDefinitionListener.h new file mode 100755 index 000000000..1d300c0a3 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/SecurityDefinitionListener.h @@ -0,0 +1,72 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/Types.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + ONIXS_CME_MDP3_API_DECL(class, SecurityDefinition); + + /// Security Definition listener. + class + ONIXS_CME_MDP3_API + SecurityDefinitionListener + { + public: + /// Is called when a new Security + /// Definition (35=d) FIX message is received. + virtual + void + onSecurityDefinition( + const SecurityDefinition& definition, + const ChannelId& channelId) = 0; + + /// Is called when Dynamic User Defined + /// Spread (UDS) instrument is deleted. + virtual + void + onSecurityDefinitionDeleted( + SecurityId securityId, + const ChannelId& channelId) = 0; + + /// Is called when Security Definition (35=d) + /// FIX messages are expected for reception. + virtual + void + onSecurityDefinitionsRecoveryStarted( + const ChannelId& channelId) = 0; + + /// Is called when all Security Definition + /// (35=d) FIX message are received or re-played. + virtual + void + onSecurityDefinitionsRecoveryFinished( + const ChannelId& channelId) = 0; + + protected: + virtual ~SecurityDefinitionListener(); + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/SecurityStatus.h b/linux/include/OnixS/CME/MDP3/SecurityStatus.h new file mode 100755 index 000000000..9c9718467 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/SecurityStatus.h @@ -0,0 +1,283 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/Tags.h" +#include "OnixS/CME/MDP3/EventIndicator.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + /// Known Security Trading Statuses. + struct + ONIXS_CME_MDP3_API + SecurityTradingStatuses + { + /// Known Security Trading Statuses. + enum Enum + { + Undefined = 0, + + TradingHalt = 2, + Close = 4, + NewPriceIndication = 15, + ReadyToTrade = 17, + NotAvailableForTrading = 18, + UnknownOrInvalid = 20, + PreOpen = 21, + PreCross = 24, + Cross = 25, + PostClose = 26, + NoChange = 103 + }; + + /// Returns constant from its string representation. + static Enum deserialize(const char* status); + + /// Returns string representation of trading status. + static const char* toString(Enum status); + }; + + /// Known Security Trading Statuses. + typedef + SecurityTradingStatuses::Enum + SecurityTradingStatus; + + /// Known Halt reasons. + struct + ONIXS_CME_MDP3_API + HaltReasons + { + enum Enum + { + Undefined = -1, + + GroupSchedule = 0, + SurveillanceIntervention = 1, + MarketEvent = 2, + InstrumentActivation = 3, + InstrumentExpiration = 4, + Unknown = 5, + RecoveryInProcess = 6 + }; + + /// Returns constant from its string representation. + static Enum deserialize(const char* status); + + /// Text representation of Enum value. + static const char* toString(Enum); + }; + + typedef + HaltReasons::Enum + HaltReason; + + /// Known Security Trading Events. + struct + ONIXS_CME_MDP3_API + SecurityTradingEvents + { + /// Known Security Trading Events. + enum Enum + { + Undefined = -1, + + NoEvent = 0, + NoCancel = 1, + ChangeOfTradingSession = 4, + ImpliedMatchingOn = 5, + ImpliedMatchingOff = 6 + }; + + /// Returns constant from its string representation. + static Enum deserialize(const char* status); + + /// Returns string representation of trading event. + static const char* toString(Enum value); + }; + + /// Security Trading Event type. + typedef + SecurityTradingEvents::Enum + SecurityTradingEvent; + + /// Security Status. + class + ONIXS_CME_MDP3_API + SecurityStatus + { + public: + /// Initializes instance from given FIX message. + SecurityStatus( + const Message& message) + : message_(message) + { + } + + // Releases associated message. + ~SecurityStatus() + { + } + + /// Start of event processing time (UTC). + Timestamp transactTime() const + { + return message_.getTimestamp(Tags::TransactTime, SinceEpochUnits::Nanoseconds); + } + + /// Indicates the date of the trade session. + Timestamp tradeDate() const + { + return message_.getTimestamp(Tags::TradeDate, SinceEpochUnits::Days); + } + + /// Market data events present in the + /// message containing given instance. + EventIndicator + eventIndicator() const + { + return EventIndicator(message_); + } + + /// If this tag is present (value is not empty), + /// status is sent for instrument group. + StringRef + securityGroup() const + { + StringRef group; + + message_. + get(Tags::SecurityGroup). + toStringRef(group); + + return group; + } + + /// Product Code. + /// + /// @return Empty value if no product code is available. + StringRef + asset() const + { + StringRef asset; + + message_. + get(Tags::Asset). + toStringRef(asset); + + return asset; + } + + /// If id presents, status is sent for instrument. + /// Returns 'false' if status is sent for group. + bool + securityId( + SecurityId& id) const + { + return + message_.get(Tags::SecurityID). + toNumber(id); + } + + /// Accesses to security trading status if available. + SecurityTradingStatus + tradingStatus() const + { + return getIntEnumFieldValue + + ( + message_, + message_.type() == "f" + ? Tags::SecurityTradingStatus + : Tags::MDSecurityTradingStatus + ); + } + + /// Identifies the reason for the status change. + HaltReason + haltReason() const + { + return message_.type() == "f" + ? getIntEnumFieldValue + + ( + message_, + Tags::HaltReason + ) + : HaltReasons::Undefined; + } + + /// Identifies an additional event or a rule + /// related to the SecurityTradingStatus (326). + SecurityTradingEvent + tradingEvent() const + { + return message_.type() == "f" + ? getIntEnumFieldValue + + ( + message_, + Tags::SecurityTradingEvent + ) + : SecurityTradingEvents::Undefined; + } + + /// Underlying FIX message containing security status. + const Message& message() const + { + return message_; + } + + /// String representation. + std::string toString() const + { + std::string str; + toString(str); + return str; + } + + /// Appends string representation. + void toString(std::string&) const; + + private: + Message message_; + }; + + /// Security Status listener. + class + ONIXS_CME_MDP3_API + SecurityStatusListener + { + public: + /// Is called when Security Status is received. + virtual + void + onSecurityStatus( + const SecurityStatus& status, + const ChannelId& channelId) = 0; + + protected: + virtual ~SecurityStatusListener(); + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/SettlementPriceType.h b/linux/include/OnixS/CME/MDP3/SettlementPriceType.h new file mode 100755 index 000000000..c97a659b7 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/SettlementPriceType.h @@ -0,0 +1,105 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/Types.h" +#include "OnixS/CME/MDP3/Tags.h" +#include "OnixS/CME/MDP3/Messaging.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + + /// Settlement price type bitmap field. + class ONIXS_CME_MDP3_API SettlementPriceType: BitmapField + { + public: + + /// Initializes from FIX field set containing + /// SettlPriceType (tag 731) field. + SettlementPriceType(const FieldSet& source) + : BitmapField(source, Tags::SettlPriceType) + { + } + + /// Checks is price Final (true) or Preliminary (false). + bool isFinal() const + { + return state(Bits::PreliminaryVsFinal); + } + + /// Checks is price Actual (true) or Theoretical (false). + bool isActual() const + { + return state(Bits::TheoreticalVsActual); + } + + /// Checks is price rounded. + bool isRounded() const + { + return state(Bits::Rounded); + } + + /// Checks is price intraday. + bool isIntraday() const + { + return state(Bits::Intraday); + } + + /// Checks is price type bitmap undefined and shall not be used. + bool isUndefined() const + { + return state(Bits::Undefined); + } + + /// Builds text presentation. + std::string toString() const + { + std::string str; + + toString(str); + + return str; + } + + /// Builds text presentation. + void toString(std::string&) const; + + private: + + struct Bits + { + enum Enum + { + PreliminaryVsFinal = 0, + TheoreticalVsActual = 1, + Rounded = 2, + Intraday = 3, + Undefined = 7 + }; + }; + + }; + + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/Statistics.h b/linux/include/OnixS/CME/MDP3/Statistics.h new file mode 100755 index 000000000..db65fb5c5 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/Statistics.h @@ -0,0 +1,751 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/Tags.h" +#include "OnixS/CME/MDP3/Messaging.h" +#include "OnixS/CME/MDP3/EventIndicator.h" +#include "OnixS/CME/MDP3/SettlementPriceType.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + // Known statistics types. + struct + ONIXS_CME_MDP3_API + StatisticsTypes + { + // Known statistics types. + enum Enum + { + OpenPrice = '4', + SettlementPrice = '6', + TradingSessionHighPrice = '7', + TradingSessionLowPrice = '8', + SessionHighBid = 'N', + SessionLowOffer = 'O', + ClearedVolume = 'B', + OpenInterest = 'C', + FixingPrice = 'W', + ThresholdLimits = 'g' + }; + + /// Returns constant from its string representation. + static Enum deserialize(const char*); + + /// Returns string representation of statistics type. + static const char* toString(Enum type); + }; + + /// Type of statistics. + typedef + StatisticsTypes::Enum + StatisticsType; + + /// Statistics base attributes. + class + ONIXS_CME_MDP3_API + Statistics + { + public: + + /// Start of event processing time (UTC) with nanoseconds precision. + Timestamp transactTime() const + { + return marketDataEntry().message().getTimestamp( + Tags::TransactTime, SinceEpochUnits::Nanoseconds); + } + + /// Tag 48. Unique instrument ID as qualified + /// by the exchange per tag 22-SecurityIDSource. + SecurityId + securityId() const + { + return security_; + } + + /// Statistics type. + StatisticsType + type() const + { + return type_; + } + + /// Market data events present in the + /// message containing given instance. + EventIndicator + eventIndicator() const + { + return EventIndicator(entry_.message()); + } + + /// Underlying FIX message containing statistics. + /// Group entry contains all the data related with this statistics. + const + GroupInstance& + marketDataEntry() const + { + return entry_; + } + + protected: + /// Initializes instance from primary attributes. + Statistics( + SecurityId id, + StatisticsType type, + const GroupInstance& entry) + : security_(id), + type_(type), + entry_(entry) + { + } + + /// Cleans everything up. + ~Statistics() + { + } + + private: + const SecurityId security_; + const StatisticsType type_; + const GroupInstance entry_; + + Statistics(const Statistics&); + Statistics& operator =(const Statistics&); + }; + + /// Flags describing Open Price entry. + struct + ONIXS_CME_MDP3_API + OpenCloseSettlementFlags + { + enum Enum + { + /// Undefined value. + Undefined = -1, + + /// Daily Open Price. + DailyOpenPrice = 0, + + /// Indicative Opening Price. + IndicativeOpeningPrice = 5 + }; + + /// Returns constant from its string representation. + static Enum deserialize(const char*); + + /// Returns string representation of statistics type. + static const char* toString(Enum type); + }; + + /// Open price flag. + typedef + OpenCloseSettlementFlags::Enum + OpenCloseSettlementFlag; + + // Opening Price. + class + ONIXS_CME_MDP3_API + OpeningPrice : public Statistics + { + public: + /// Initializes instance from primary attributes. + OpeningPrice( + SecurityId security, + const GroupInstance& marketData) + : Statistics( + security, + StatisticsTypes::OpenPrice, + marketData) + { + } + + /// Detaches from associated market data. + ~OpeningPrice() + { + } + + /// Statistic field value. + Price + value() const + { + return marketDataEntry().getDecimal(Tags::MDEntryPx); + } + + /// Open/Close Settlement Flag. + OpenCloseSettlementFlag + openCloseSettlementFlag() const + { + return getIntEnumFieldValue + ( + marketDataEntry(), + Tags::OpenCloseSettlFlag); + } + + /// Returns the string representation. + std::string toString() const + { + std::string str; + + toString(str); + + return str; + } + + /// Appends the string representation. + void toString(std::string&) const; + }; + + /// Settlement price. + class + ONIXS_CME_MDP3_API + SettlementPrice : public Statistics + { + public: + /// Initializes instance from primary attributes. + SettlementPrice( + SecurityId security, + const GroupInstance& marketData) + : Statistics( + security, + StatisticsTypes::SettlementPrice, + marketData) + { + } + + /// Detaches from underlying resources. + ~SettlementPrice() + { + } + + /// Statistic field value. + Price value() const + { + return marketDataEntry().getDecimal(Tags::MDEntryPx); + } + + /// Bitmap field of eight Boolean type indicators representing settlement price type + SettlementPriceType settlPriceType() const + { + return SettlementPriceType(marketDataEntry()); + } + + /// Trading reference date. + bool tradingReferenceDate(Timestamp& date) const + { + return getDate(marketDataEntry(), Tags::TradingReferenceDate, date); + } + + /// Returns the string representation. + std::string toString() const + { + std::string str; + + toString(str); + + return str; + } + + /// Appends the string representation. + void toString(std::string&) const; + }; + + /// Trading Session High Price. + class + ONIXS_CME_MDP3_API + TradingSessionHighPrice : public Statistics + { + public: + /// Initializes instance from primary attributes. + TradingSessionHighPrice( + SecurityId security, + const GroupInstance& marketData) + : Statistics( + security, + StatisticsTypes::TradingSessionHighPrice, + marketData) + { + } + + /// Detaches from underlying resources. + ~TradingSessionHighPrice() + { + } + + /// Statistic field value. + Price + value() const + { + return marketDataEntry().getDecimal(Tags::MDEntryPx); + } + + /// Returns the string representation. + std::string toString() const + { + std::string str; + + toString(str); + + return str; + } + + /// Appends the string representation. + void toString(std::string&) const; + }; + + /// Trading Session Low Price. + class + ONIXS_CME_MDP3_API + TradingSessionLowPrice : public Statistics + { + public: + /// Initializes instance from primary attributes. + TradingSessionLowPrice( + SecurityId security, + const GroupInstance& marketData) + : Statistics( + security, + StatisticsTypes::TradingSessionLowPrice, + marketData) + { + } + + /// Detaches from underlying resources. + ~TradingSessionLowPrice() + { + } + + /// Statistic field value. + Price + value() const + { + return marketDataEntry().getDecimal(Tags::MDEntryPx); + } + + /// Returns the string representation. + std::string toString() const + { + std::string str; + + toString(str); + + return str; + } + + /// Appends the string representation. + void toString(std::string&) const; + }; + + /// Session High Bid. + class + ONIXS_CME_MDP3_API + SessionHighBid : public Statistics + { + public: + /// Initializes instance from primary attributes. + SessionHighBid( + SecurityId security, + const GroupInstance& marketData) + : Statistics( + security, + StatisticsTypes::SessionHighBid, + marketData) + { + } + + /// Detaches from underlying resources. + ~SessionHighBid() + { + } + + /// Statistic field value. + Price + value() const + { + return marketDataEntry().getDecimal(Tags::MDEntryPx); + } + + /// Returns the string representation. + std::string toString() const + { + std::string str; + + toString(str); + + return str; + } + + /// Appends the string representation. + void toString(std::string&) const; + }; + + /// Session Low Offer. + class + ONIXS_CME_MDP3_API + SessionLowOffer : public Statistics + { + public: + /// Initializes instance from primary attributes. + SessionLowOffer( + SecurityId security, + const GroupInstance& marketData) + : Statistics( + security, + StatisticsTypes::SessionLowOffer, + marketData) + { + } + + /// Detaches from underlying resources. + ~SessionLowOffer() + { + } + + /// Statistic field value. + Price + value() const + { + return marketDataEntry().getDecimal(Tags::MDEntryPx); + } + + /// Returns the string representation. + std::string toString() const + { + std::string str; + + toString(str); + + return str; + } + + /// Appends the string representation. + void toString(std::string&) const; + }; + + /// Trade Volume. + class + ONIXS_CME_MDP3_API + TradeVolume : public Statistics + { + public: + /// Initializes instance from primary attributes. + TradeVolume( + SecurityId security, + const GroupInstance& marketData) + : Statistics( + security, + StatisticsTypes::ClearedVolume, + marketData) + { + } + + /// Detaches from underlying resources. + ~TradeVolume() + { + } + + /// Statistic field value. + SignedQuantity + value() const + { + return marketDataEntry().getInt32(Tags::MDEntrySize); + } + + /// Trading reference date. + bool tradingReferenceDate(Timestamp& date) const + { + return getDate(marketDataEntry(), Tags::TradingReferenceDate, date); + } + + /// Returns the string representation. + std::string toString() const + { + std::string str; + + toString(str); + + return str; + } + + /// Appends the string representation. + void toString(std::string&) const; + }; + + /// Open Interest. + class + ONIXS_CME_MDP3_API + OpenInterest : public Statistics + { + public: + /// Initializes instance from primary attributes. + OpenInterest( + SecurityId security, + const GroupInstance& marketData) + : Statistics( + security, + StatisticsTypes::OpenInterest, + marketData) + { + } + + /// Detaches from underlying resources. + ~OpenInterest() + { + } + + /// Statistic field value. + SignedQuantity + value() const + { + return marketDataEntry().getInt32(Tags::MDEntrySize); + } + + /// Trading reference date. + bool tradingReferenceDate(Timestamp& date) const + { + return getDate(marketDataEntry(), Tags::TradingReferenceDate, date); + } + + /// Returns the string representation. + std::string toString() const + { + std::string str; + + toString(str); + + return str; + } + + /// Appends the string representation. + void toString(std::string&) const; + }; + + /// Fixing Price. + class + ONIXS_CME_MDP3_API + FixingPrice : public Statistics + { + public: + /// Initializes instance from primary attributes. + FixingPrice( + SecurityId security, + const GroupInstance& marketData) + : Statistics( + security, + StatisticsTypes::FixingPrice, + marketData) + { + } + + /// Detaches from underlying resources. + ~FixingPrice() + { + } + + /// Statistic field value. + Price + value() const + { + return marketDataEntry().getDecimal(Tags::MDEntryPx); + } + + /// Trading reference date. + bool tradingReferenceDate(Timestamp& date) const + { + return getDate(marketDataEntry(), Tags::TradingReferenceDate, date); + } + + /// Returns the string representation. + std::string toString() const + { + std::string str; + + toString(str); + + return str; + } + + /// Appends the string representation. + void toString(std::string&) const; + }; + + /// Threshold Limits/Banding. + class + ONIXS_CME_MDP3_API + ThresholdLimits : public Statistics + { + public: + /// Initializes instance from primary attributes. + ThresholdLimits( + SecurityId id, + const GroupInstance& marketData) + : Statistics( + id, + StatisticsTypes::ThresholdLimits, + marketData) + { + } + + /// Cleans everything up. + ~ThresholdLimits() + { + } + + /// Low limit price. + bool + lowLimitPrice(Price& value) const + { + return marketDataEntry(). + get(Tags::LowLimitPrice). + toNumber(value); + } + + /// High limit price. + bool + highLimitPrice(Price& value) const + { + return marketDataEntry(). + get(Tags::HighLimitPrice). + toNumber(value); + } + + /// Max price variation. + bool + maxPriceVariation(Price& value) const + { + return marketDataEntry(). + get(Tags::MaxPriceVariation). + toNumber(value); + } + + /// Returns the string representation. + std::string toString() const + { + std::string str; + + toString(str); + + return str; + } + + /// Appends the string representation. + void toString(std::string&) const; + }; + + /// Statistics updates listener. + class + ONIXS_CME_MDP3_API + StatisticsListener + { + public: + /// Is called with a statistics is + /// removed at the end of a trading session. + virtual + void + onStatisticsReset( + SecurityId securityId, + const ChannelId& channelId) = 0; + + /// Is called with a statistics is + /// removed at the end of a trading session. + virtual + void + onStatisticsReset( + const StringRef& securityGroup, + const ChannelId& channelId) = 0; + + /// Invoked when statistics of certain type is received. + virtual + void + onStatistics( + const OpeningPrice& openingPrice, + const ChannelId& channelId) = 0; + + /// Invoked when statistics of certain type is received. + virtual + void + onStatistics( + const SettlementPrice& settlementPrice, + const ChannelId& channelId) = 0; + + /// Invoked when statistics of certain type is received. + virtual + void + onStatistics( + const TradingSessionHighPrice& highPrice, + const ChannelId& channelId) = 0; + + /// Invoked when statistics of certain type is received. + virtual + void + onStatistics( + const TradingSessionLowPrice& lowPrice, + const ChannelId& channelId) = 0; + + /// Invoked when statistics of certain type is received. + virtual + void + onStatistics( + const SessionHighBid& highBid, + const ChannelId& channelId) = 0; + + /// Invoked when statistics of certain type is received. + virtual + void + onStatistics( + const SessionLowOffer& lowOffer, + const ChannelId& channelId) = 0; + + /// Invoked when statistics of certain type is received. + virtual + void + onStatistics( + const TradeVolume& volume, + const ChannelId& channelId) = 0; + + /// Invoked when statistics of certain type is received. + virtual + void + onStatistics( + const OpenInterest& interest, + const ChannelId& channelId) = 0; + + /// Invoked when statistics of certain type is received. + virtual + void + onStatistics( + const FixingPrice& fixingPrice, + const ChannelId& channelId) = 0; + + /// Invoked when statistics of certain type is received. + virtual + void + onStatistics( + const ThresholdLimits& limits, + const ChannelId& channelId) = 0; + + protected: + virtual ~StatisticsListener(); + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/String.h b/linux/include/OnixS/CME/MDP3/String.h new file mode 100755 index 000000000..e3ac88972 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/String.h @@ -0,0 +1,348 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include +#include +#include +#include +#include + +#include "OnixS/CME/MDP3/Config.h" +#include "OnixS/CME/MDP3/Numeric.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + + /// Provides efficient way of accessing text-based FIX field values. + class + ONIXS_CME_MDP3_API + StringRef + { + public: + /// Immutable iterator over chars. + typedef const char* ConstIterator; + + /// Initializes blank instance. + StringRef() + : chars_(NULL), + size_(0) + { + } + + /// Full initialization. + StringRef( + const char* chars, + size_t size) + : chars_(chars), + size_(size) + { + } + + /// Initializes as clone of other instance. + /// Data referenced by clone is not copied. + /// Instead both instances will refer to same + /// text segment. + StringRef( + const StringRef& other) + : chars_(other.chars_), + size_(other.size_) + { + } + + /// Initializes instance from string content. + explicit StringRef( + const std::string& stdStr) + : chars_(stdStr.c_str()), + size_(stdStr.size()) + { + } + + /// Initializes instance from zero-terminated string. + explicit StringRef(const char* cStr) + : chars_(cStr), size_(cStr ? strlen(cStr) : 0) + { + } + + /// Indicates whether array of zero length. + bool empty() const + { + return (0 == size_); + } + + /// Read-only content. + const char* data() const + { + return chars_; + } + + /// STL-like begin(). + ConstIterator begin() const + { + return chars_; + } + + /// STL-like end(). + ConstIterator end() const + { + return chars_ + size_; + } + + /// Number of chars. + size_t size() const + { + return size_; + } + + /// Resets reference to nothing. + void reset() + { + reset(NULL, 0); + } + + /// Updates data being referenced. + void + reset( + const char* chars, + size_t size) + { + chars_ = chars; + size_ = size; + } + + const char& + operator [](size_t index) const + { + return chars_[index]; + } + + const char& + at(size_t index) const + { + if (index < size_) + return chars_[index]; + + throw std::invalid_argument("index"); + } + + /// Returns number if text is string + /// representation of an integer. + template + < + typename NumericType + > + bool + toNumber(NumericType& number) const + { + return OnixS::CME::MDP3::Number:: + tryParse(chars_, size_, number); + } + + // Appends copy of text to the std::string. + void toString(std::string& str) const + { + str.append(chars_, size_); + } + + // Return copy of text as std::string. + std::string toString() const + { + return std::string(chars_, size_); + } + + /// Implicit conversion to std::string. + operator std::string() const + { + return std::string(chars_, size_); + } + + /// Compares with another instance. + bool + operator ==( + const StringRef& other) const + { + return ( + size_ == other.size_ + && + 0 == memcmp( + chars_, other.chars_, size_) ); + } + + /// Compares with another instance. + bool + operator !=( + const StringRef& other) const + { + return ( + size_ != other.size_ + || + 0 != memcmp( + chars_, other.chars_, size_) ); + } + + /// Reinitializes from another instance. + StringRef& + operator =( + const StringRef& other) + { + chars_ = other.chars_; + size_ = other.size_; + + return *this; + } + + /// Swaps content with other instance. + void + swap(StringRef& other) + { + std::swap(chars_, other.chars_); + std::swap(size_, other.size_); + } + + private: + /// Items being referenced. + const char* chars_; + + /// Number of chars being referenced. + size_t size_; + }; + + inline + bool + operator ==( + const StringRef& ref, + const std::string& str) + { + return ref == StringRef(str); + } + + inline + bool + operator !=( + const StringRef& ref, + const std::string& str) + { + return ref != StringRef(str); + } + + inline + bool + operator ==( + const std::string& str, + const StringRef& ref) + { + return ref == StringRef(str); + } + + inline + bool + operator !=( + const std::string& str, + const StringRef& ref) + { + return ref != StringRef(str); + } + + // + + inline + bool + operator ==( + const StringRef& ref, + const char* str) + { + return ref == StringRef(str); + } + + inline + bool + operator !=( + const StringRef& ref, + const char* str) + { + return ref != StringRef(str); + } + + inline + bool + operator ==( + const char* str, + const StringRef& ref) + { + return ref == StringRef(str); + } + + inline + bool + operator !=( + const char* str, + const StringRef& ref) + { + return ref != StringRef(str); + } + } + } +} + +namespace std +{ + /// Allows using of StringRef in collections like std::map. + template<> + struct + ONIXS_CME_MDP3_API + less + { + bool + operator ()( + const OnixS::CME::MDP3::StringRef& left, + const OnixS::CME::MDP3::StringRef& right) const + { + ptrdiff_t + compareResult = memcmp( + left.data(), right.data(), + left.size() < right.size() + ? left.size() : right.size()); + + if (0 == compareResult) + { + compareResult = + static_cast ( + left.size() - right.size() ); + } + + return (0 > compareResult); + } + }; + + inline + std::ostream& + operator <<( + std::ostream& stream, + const OnixS::CME::MDP3::StringRef& text) + { + stream.write(text.data(), text.size()); + + return stream; + } + +} diff --git a/linux/include/OnixS/CME/MDP3/Tags.h b/linux/include/OnixS/CME/MDP3/Tags.h new file mode 100755 index 000000000..87fa6f3c7 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/Tags.h @@ -0,0 +1,1218 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/Types.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + namespace Tags + { + static const Tag Account = 1; + static const Tag AdvId = 2; + static const Tag AdvRefID = 3; + static const Tag AdvSide = 4; + static const Tag AdvTransType = 5; + static const Tag AvgPx = 6; + static const Tag BeginSeqNo = 7; + static const Tag BeginString = 8; + static const Tag BodyLength = 9; + static const Tag CheckSum = 10; + static const Tag ClOrdID = 11; + static const Tag Commission = 12; + static const Tag CommType = 13; + static const Tag CumQty = 14; + static const Tag Currency = 15; + static const Tag EndSeqNo = 16; + static const Tag ExecID = 17; + static const Tag ExecInst = 18; + static const Tag ExecRefID = 19; + static const Tag ExecTransType = 20; + static const Tag HandlInst = 21; + static const Tag SecurityIDSource = 22; + static const Tag IOIID = 23; + static const Tag IOIQltyInd = 25; + static const Tag IOIRefID = 26; + static const Tag IOIQty = 27; + static const Tag IOITransType = 28; + static const Tag LastCapacity = 29; + static const Tag LastMkt = 30; + static const Tag LastPx = 31; + static const Tag LastQty = 32; + static const Tag NoLinesOfText = 33; + static const Tag MsgSeqNum = 34; + static const Tag MsgType = 35; + static const Tag NewSeqNo = 36; + static const Tag OrderID = 37; + static const Tag OrderQty = 38; + static const Tag OrdStatus = 39; + static const Tag OrdType = 40; + static const Tag OrigClOrdID = 41; + static const Tag OrigTime = 42; + static const Tag PossDupFlag = 43; + static const Tag Price = 44; + static const Tag RefSeqNum = 45; + static const Tag SecurityID = 48; + static const Tag SenderCompID = 49; + static const Tag SenderSubID = 50; + static const Tag SendingTime = 52; + static const Tag Quantity = 53; + static const Tag Side = 54; + static const Tag Symbol = 55; + static const Tag TargetCompID = 56; + static const Tag TargetSubID = 57; + static const Tag Text = 58; + static const Tag TimeInForce = 59; + static const Tag TransactTime = 60; + static const Tag Urgency = 61; + static const Tag ValidUntilTime = 62; + static const Tag SettlType = 63; + static const Tag SettlDate = 64; + static const Tag SymbolSfx = 65; + static const Tag ListID = 66; + static const Tag ListSeqNo = 67; + static const Tag TotNoOrders = 68; + static const Tag ListExecInst = 69; + static const Tag AllocID = 70; + static const Tag AllocTransType = 71; + static const Tag RefAllocID = 72; + static const Tag NoOrders = 73; + static const Tag AvgPxPrecision = 74; + static const Tag TradeDate = 75; + static const Tag ExecBroker = 76; + static const Tag PositionEffect = 77; + static const Tag NoAllocs = 78; + static const Tag AllocAccount = 79; + static const Tag AllocQty = 80; + static const Tag ProcessCode = 81; + static const Tag NoRpts = 82; + static const Tag RptSeq = 83; + static const Tag CxlQty = 84; + static const Tag NoDlvyInst = 85; + static const Tag DlvyInst = 86; + static const Tag AllocStatus = 87; + static const Tag AllocRejCode = 88; + static const Tag Signature = 89; + static const Tag SecureDataLen = 90; + static const Tag SecureData = 91; + static const Tag BrokerOfCredit = 92; + static const Tag SignatureLength = 93; + static const Tag EmailType = 94; + static const Tag RawDataLength = 95; + static const Tag RawData = 96; + static const Tag PossResend = 97; + static const Tag EncryptMethod = 98; + static const Tag StopPx = 99; + static const Tag ExDestination = 100; + static const Tag CxlRejReason = 102; + static const Tag OrdRejReason = 103; + static const Tag IOIQualifier = 104; + static const Tag WaveNo = 105; + static const Tag Issuer = 106; + static const Tag SecurityDesc = 107; + static const Tag HeartBtInt = 108; + static const Tag ClientID = 109; + static const Tag MinQty = 110; + static const Tag MaxFloor = 111; + static const Tag TestReqID = 112; + static const Tag ReportToExch = 113; + static const Tag LocateReqd = 114; + static const Tag OnBehalfOfCompID = 115; + static const Tag OnBehalfOfSubID = 116; + static const Tag QuoteID = 117; + static const Tag NetMoney = 118; + static const Tag SettlCurrAmt = 119; + static const Tag SettlCurrency = 120; + static const Tag ForexReq = 121; + static const Tag OrigSendingTime = 122; + static const Tag GapFillFlag = 123; + static const Tag NoExecs = 124; + static const Tag CxlType = 125; + static const Tag ExpireTime = 126; + static const Tag DKReason = 127; + static const Tag DeliverToCompID = 128; + static const Tag DeliverToSubID = 129; + static const Tag IOINaturalFlag = 130; + static const Tag QuoteReqID = 131; + static const Tag BidPx = 132; + static const Tag OfferPx = 133; + static const Tag BidSize = 134; + static const Tag OfferSize = 135; + static const Tag NoMiscFees = 136; + static const Tag MiscFeeAmt = 137; + static const Tag MiscFeeCurr = 138; + static const Tag MiscFeeType = 139; + static const Tag PrevClosePx = 140; + static const Tag ResetSeqNumFlag = 141; + static const Tag SenderLocationID = 142; + static const Tag TargetLocationID = 143; + static const Tag OnBehalfOfLocationID = 144; + static const Tag DeliverToLocationID = 145; + static const Tag NoRelatedSym = 146; + static const Tag Subject = 147; + static const Tag Headline = 148; + static const Tag URLLink = 149; + static const Tag ExecType = 150; + static const Tag LeavesQty = 151; + static const Tag CashOrderQty = 152; + static const Tag AllocAvgPx = 153; + static const Tag AllocNetMoney = 154; + static const Tag SettlCurrFxRate = 155; + static const Tag SettlCurrFxRateCalc = 156; + static const Tag NumDaysInterest = 157; + static const Tag AccruedInterestRate = 158; + static const Tag AccruedInterestAmt = 159; + static const Tag SettlInstMode = 160; + static const Tag AllocText = 161; + static const Tag SettlInstID = 162; + static const Tag SettlInstTransType = 163; + static const Tag EmailThreadID = 164; + static const Tag SettlInstSource = 165; + static const Tag SettlLocation = 166; + static const Tag SecurityType = 167; + static const Tag EffectiveTime = 168; + static const Tag StandInstDbType = 169; + static const Tag StandInstDbName = 170; + static const Tag StandInstDbID = 171; + static const Tag SettlDeliveryType = 172; + static const Tag SettlDepositoryCode = 173; + static const Tag SettlBrkrCode = 174; + static const Tag SettlInstCode = 175; + static const Tag SecuritySettlAgentName = 176; + static const Tag SecuritySettlAgentCode = 177; + static const Tag SecuritySettlAgentAcctNum = 178; + static const Tag SecuritySettlAgentAcctName = 179; + static const Tag SecuritySettlAgentContactName = 180; + static const Tag SecuritySettlAgentContactPhone = 181; + static const Tag CashSettlAgentName = 182; + static const Tag CashSettlAgentCode = 183; + static const Tag CashSettlAgentAcctNum = 184; + static const Tag CashSettlAgentAcctName = 185; + static const Tag CashSettlAgentContactName = 186; + static const Tag CashSettlAgentContactPhone = 187; + static const Tag BidSpotRate = 188; + static const Tag BidForwardPoints = 189; + static const Tag OfferSpotRate = 190; + static const Tag OfferForwardPoints = 191; + static const Tag OrderQty2 = 192; + static const Tag SettlDate2 = 193; + static const Tag LastSpotRate = 194; + static const Tag LastForwardPoints = 195; + static const Tag AllocLinkID = 196; + static const Tag AllocLinkType = 197; + static const Tag SecondaryOrderID = 198; + static const Tag NoIOIQualifiers = 199; + static const Tag MaturityMonthYear = 200; + static const Tag PutOrCall = 201; + static const Tag StrikePrice = 202; + static const Tag CoveredOrUncovered = 203; + static const Tag CustomerOrFirm = 204; + static const Tag MaturityDay = 205; + static const Tag OptAttribute = 206; + static const Tag SecurityExchange = 207; + static const Tag NotifyBrokerOfCredit = 208; + static const Tag AllocHandlInst = 209; + static const Tag MaxShow = 210; + static const Tag PegOffsetValue = 211; + static const Tag XmlDataLen = 212; + static const Tag XmlData = 213; + static const Tag SettlInstRefID = 214; + static const Tag NoRoutingIDs = 215; + static const Tag RoutingType = 216; + static const Tag RoutingID = 217; + static const Tag Spread = 218; + static const Tag Benchmark = 219; + static const Tag BenchmarkCurveCurrency = 220; + static const Tag BenchmarkCurveName = 221; + static const Tag BenchmarkCurvePoint = 222; + static const Tag CouponRate = 223; + static const Tag CouponPaymentDate = 224; + static const Tag IssueDate = 225; + static const Tag RepurchaseTerm = 226; + static const Tag RepurchaseRate = 227; + static const Tag Factor = 228; + static const Tag TradeOriginationDate = 229; + static const Tag ExDate = 230; + static const Tag ContractMultiplier = 231; + static const Tag NoStipulations = 232; + static const Tag StipulationType = 233; + static const Tag StipulationValue = 234; + static const Tag YieldType = 235; + static const Tag Yield = 236; + static const Tag TotalTakedown = 237; + static const Tag Concession = 238; + static const Tag RepoCollateralSecurityType = 239; + static const Tag RedemptionDate = 240; + static const Tag UnderlyingCouponPaymentDate = 241; + static const Tag UnderlyingIssueDate = 242; + static const Tag UnderlyingRepoCollateralSecurityType = 243; + static const Tag UnderlyingRepurchaseTerm = 244; + static const Tag UnderlyingRepurchaseRate = 245; + static const Tag UnderlyingFactor = 246; + static const Tag UnderlyingRedemptionDate = 247; + static const Tag LegCouponPaymentDate = 248; + static const Tag LegIssueDate = 249; + static const Tag LegRepoCollateralSecurityType = 250; + static const Tag LegRepurchaseTerm = 251; + static const Tag LegRepurchaseRate = 252; + static const Tag LegFactor = 253; + static const Tag LegRedemptionDate = 254; + static const Tag CreditRating = 255; + static const Tag UnderlyingCreditRating = 256; + static const Tag LegCreditRating = 257; + static const Tag TradedFlatSwitch = 258; + static const Tag BasisFeatureDate = 259; + static const Tag BasisFeaturePrice = 260; + static const Tag MDReqID = 262; + static const Tag SubscriptionRequestType = 263; + static const Tag MarketDepth = 264; + static const Tag MDUpdateType = 265; + static const Tag AggregatedBook = 266; + static const Tag NoMDEntryTypes = 267; + static const Tag NoMDEntries = 268; + static const Tag MDEntryType = 269; + static const Tag MDEntryPx = 270; + static const Tag MDEntrySize = 271; + static const Tag MDEntryDate = 272; + static const Tag MDEntryTime = 273; + static const Tag TickDirection = 274; + static const Tag MDMkt = 275; + static const Tag QuoteCondition = 276; + static const Tag TradeCondition = 277; + static const Tag MDEntryID = 278; + static const Tag MDUpdateAction = 279; + static const Tag MDEntryRefID = 280; + static const Tag MDReqRejReason = 281; + static const Tag MDEntryOriginator = 282; + static const Tag LocationID = 283; + static const Tag DeskID = 284; + static const Tag DeleteReason = 285; + static const Tag OpenCloseSettlFlag = 286; + static const Tag SellerDays = 287; + static const Tag MDEntryBuyer = 288; + static const Tag MDEntrySeller = 289; + static const Tag MDEntryPositionNo = 290; + static const Tag FinancialStatus = 291; + static const Tag CorporateAction = 292; + static const Tag DefBidSize = 293; + static const Tag DefOfferSize = 294; + static const Tag NoQuoteEntries = 295; + static const Tag NoQuoteSets = 296; + static const Tag QuoteStatus = 297; + static const Tag QuoteCancelType = 298; + static const Tag QuoteEntryID = 299; + static const Tag QuoteRejectReason = 300; + static const Tag QuoteResponseLevel = 301; + static const Tag QuoteSetID = 302; + static const Tag QuoteRequestType = 303; + static const Tag TotNoQuoteEntries = 304; + static const Tag UnderlyingSecurityIDSource = 305; + static const Tag UnderlyingIssuer = 306; + static const Tag UnderlyingSecurityDesc = 307; + static const Tag UnderlyingSecurityExchange = 308; + static const Tag UnderlyingSecurityID = 309; + static const Tag UnderlyingSecurityType = 310; + static const Tag UnderlyingSymbol = 311; + static const Tag UnderlyingSymbolSfx = 312; + static const Tag UnderlyingMaturityMonthYear = 313; + static const Tag UnderlyingMaturityDay = 314; + static const Tag UnderlyingPutOrCall = 315; + static const Tag UnderlyingStrikePrice = 316; + static const Tag UnderlyingOptAttribute = 317; + static const Tag UnderlyingCurrency = 318; + static const Tag RatioQty = 319; + static const Tag SecurityReqID = 320; + static const Tag SecurityRequestType = 321; + static const Tag SecurityResponseID = 322; + static const Tag SecurityResponseType = 323; + static const Tag SecurityStatusReqID = 324; + static const Tag UnsolicitedIndicator = 325; + static const Tag SecurityTradingStatus = 326; + static const Tag HaltReason = 327; + static const Tag InViewOfCommon = 328; + static const Tag DueToRelated = 329; + static const Tag BuyVolume = 330; + static const Tag SellVolume = 331; + static const Tag HighPx = 332; + static const Tag LowPx = 333; + static const Tag Adjustment = 334; + static const Tag TradSesReqID = 335; + static const Tag TradingSessionID = 336; + static const Tag ContraTrader = 337; + static const Tag TradSesMethod = 338; + static const Tag TradSesMode = 339; + static const Tag TradSesStatus = 340; + static const Tag TradSesStartTime = 341; + static const Tag TradSesOpenTime = 342; + static const Tag TradSesPreCloseTime = 343; + static const Tag TradSesCloseTime = 344; + static const Tag TradSesEndTime = 345; + static const Tag NumberOfOrders = 346; + static const Tag MessageEncoding = 347; + static const Tag EncodedIssuerLen = 348; + static const Tag EncodedIssuer = 349; + static const Tag EncodedSecurityDescLen = 350; + static const Tag EncodedSecurityDesc = 351; + static const Tag EncodedListExecInstLen = 352; + static const Tag EncodedListExecInst = 353; + static const Tag EncodedTextLen = 354; + static const Tag EncodedText = 355; + static const Tag EncodedSubjectLen = 356; + static const Tag EncodedSubject = 357; + static const Tag EncodedHeadlineLen = 358; + static const Tag EncodedHeadline = 359; + static const Tag EncodedAllocTextLen = 360; + static const Tag EncodedAllocText = 361; + static const Tag EncodedUnderlyingIssuerLen = 362; + static const Tag EncodedUnderlyingIssuer = 363; + static const Tag EncodedUnderlyingSecurityDescLen = 364; + static const Tag EncodedUnderlyingSecurityDesc = 365; + static const Tag AllocPrice = 366; + static const Tag QuoteSetValidUntilTime = 367; + static const Tag QuoteEntryRejectReason = 368; + static const Tag LastMsgSeqNumProcessed = 369; + static const Tag OnBehalfOfSendingTime = 370; + static const Tag RefTagsID = 371; + static const Tag RefMsgType = 372; + static const Tag SessionRejectReason = 373; + static const Tag BidRequestTransType = 374; + static const Tag ContraBroker = 375; + static const Tag ComplianceID = 376; + static const Tag SolicitedFlag = 377; + static const Tag ExecRestatementReason = 378; + static const Tag BusinessRejectRefID = 379; + static const Tag BusinessRejectReason = 380; + static const Tag GrossTradeAmt = 381; + static const Tag NoContraBrokers = 382; + static const Tag MaxMessageSize = 383; + static const Tag NoMsgTypes = 384; + static const Tag MsgDirection = 385; + static const Tag NoTradingSessions = 386; + static const Tag TotalVolumeTraded = 387; + static const Tag DiscretionInst = 388; + static const Tag DiscretionOffsetValue = 389; + static const Tag BidID = 390; + static const Tag ClientBidID = 391; + static const Tag ListName = 392; + static const Tag TotNoRelatedSym = 393; + static const Tag BidType = 394; + static const Tag NumTickets = 395; + static const Tag SideValue1 = 396; + static const Tag SideValue2 = 397; + static const Tag NoBidDescriptors = 398; + static const Tag BidDescriptorType = 399; + static const Tag BidDescriptor = 400; + static const Tag SideValueInd = 401; + static const Tag LiquidityPctLow = 402; + static const Tag LiquidityPctHigh = 403; + static const Tag LiquidityValue = 404; + static const Tag EFPTrackingError = 405; + static const Tag FairValue = 406; + static const Tag OutsideIndexPct = 407; + static const Tag ValueOfFutures = 408; + static const Tag LiquidityIndType = 409; + static const Tag WtAverageLiquidity = 410; + static const Tag ExchangeForPhysical = 411; + static const Tag OutMainCntryUIndex = 412; + static const Tag CrossPercent = 413; + static const Tag ProgRptReqs = 414; + static const Tag ProgPeriodInterval = 415; + static const Tag IncTaxInd = 416; + static const Tag NumBidders = 417; + static const Tag BidTradeType = 418; + static const Tag BasisPxType = 419; + static const Tag NoBidComponents = 420; + static const Tag Country = 421; + static const Tag TotNoStrikes = 422; + static const Tag PriceType = 423; + static const Tag DayOrderQty = 424; + static const Tag DayCumQty = 425; + static const Tag DayAvgPx = 426; + static const Tag GTBookingInst = 427; + static const Tag NoStrikes = 428; + static const Tag ListStatusType = 429; + static const Tag NetGrossInd = 430; + static const Tag ListOrderStatus = 431; + static const Tag ExpireDate = 432; + static const Tag ListExecInstType = 433; + static const Tag CxlRejResponseTo = 434; + static const Tag UnderlyingCouponRate = 435; + static const Tag UnderlyingContractMultiplier = 436; + static const Tag ContraTradeQty = 437; + static const Tag ContraTradeTime = 438; + static const Tag ClearingFirm = 439; + static const Tag ClearingAccount = 440; + static const Tag LiquidityNumSecurities = 441; + static const Tag MultiLegReportingType = 442; + static const Tag StrikeTime = 443; + static const Tag ListStatusText = 444; + static const Tag EncodedListStatusTextLen = 445; + static const Tag EncodedListStatusText = 446; + static const Tag PartyIDSource = 447; + static const Tag PartyID = 448; + static const Tag TotalVolumeTradedDate = 449; + static const Tag TotalVolumeTradedTime = 450; + static const Tag NetChgPrevDay = 451; + static const Tag PartyRole = 452; + static const Tag NoPartyIDs = 453; + static const Tag NoSecurityAltID = 454; + static const Tag SecurityAltID = 455; + static const Tag SecurityAltIDSource = 456; + static const Tag NoUnderlyingSecurityAltID = 457; + static const Tag UnderlyingSecurityAltID = 458; + static const Tag UnderlyingSecurityAltIDSource = 459; + static const Tag Product = 460; + static const Tag CFICode = 461; + static const Tag UnderlyingProduct = 462; + static const Tag UnderlyingCFICode = 463; + static const Tag TestMessageIndicator = 464; + static const Tag QuantityType = 465; + static const Tag BookingRefID = 466; + static const Tag IndividualAllocID = 467; + static const Tag RoundingDirection = 468; + static const Tag RoundingModulus = 469; + static const Tag CountryOfIssue = 470; + static const Tag StateOrProvinceOfIssue = 471; + static const Tag LocaleOfIssue = 472; + static const Tag NoRegistDtls = 473; + static const Tag MailingDtls = 474; + static const Tag InvestorCountryOfResidence = 475; + static const Tag PaymentRef = 476; + static const Tag DistribPaymentMethod = 477; + static const Tag CashDistribCurr = 478; + static const Tag CommCurrency = 479; + static const Tag CancellationRights = 480; + static const Tag MoneyLaunderingStatus = 481; + static const Tag MailingInst = 482; + static const Tag TransBkdTime = 483; + static const Tag ExecPriceType = 484; + static const Tag ExecPriceAdjustment = 485; + static const Tag DateOfBirth = 486; + static const Tag TradeReportTransType = 487; + static const Tag CardHolderName = 488; + static const Tag CardNumber = 489; + static const Tag CardExpDate = 490; + static const Tag CardIssNum = 491; + static const Tag PaymentMethod = 492; + static const Tag RegistAcctType = 493; + static const Tag Designation = 494; + static const Tag TaxAdvantageType = 495; + static const Tag RegistRejReasonText = 496; + static const Tag FundRenewWaiv = 497; + static const Tag CashDistribAgentName = 498; + static const Tag CashDistribAgentCode = 499; + static const Tag CashDistribAgentAcctNumber = 500; + static const Tag CashDistribPayRef = 501; + static const Tag CashDistribAgentAcctName = 502; + static const Tag CardStartDate = 503; + static const Tag PaymentDate = 504; + static const Tag PaymentRemitterID = 505; + static const Tag RegistStatus = 506; + static const Tag RegistRejReasonCode = 507; + static const Tag RegistRefID = 508; + static const Tag RegistDtls = 509; + static const Tag NoDistribInsts = 510; + static const Tag RegistEmail = 511; + static const Tag DistribPercentage = 512; + static const Tag RegistID = 513; + static const Tag RegistTransType = 514; + static const Tag ExecValuationPoint = 515; + static const Tag OrderPercent = 516; + static const Tag OwnershipType = 517; + static const Tag NoContAmts = 518; + static const Tag ContAmtType = 519; + static const Tag ContAmtValue = 520; + static const Tag ContAmtCurr = 521; + static const Tag OwnerType = 522; + static const Tag PartySubID = 523; + static const Tag NestedPartyID = 524; + static const Tag NestedPartyIDSource = 525; + static const Tag SecondaryClOrdID = 526; + static const Tag SecondaryExecID = 527; + static const Tag OrderCapacity = 528; + static const Tag OrderRestrictions = 529; + static const Tag MassCancelRequestType = 530; + static const Tag MassCancelResponse = 531; + static const Tag MassCancelRejectReason = 532; + static const Tag TotalAffectedOrders = 533; + static const Tag NoAffectedOrders = 534; + static const Tag AffectedOrderID = 535; + static const Tag AffectedSecondaryOrderID = 536; + static const Tag QuoteType = 537; + static const Tag NestedPartyRole = 538; + static const Tag NoNestedPartyIDs = 539; + static const Tag TotalAccruedInterestAmt = 540; + static const Tag MaturityDate = 541; + static const Tag UnderlyingMaturityDate = 542; + static const Tag InstrRegistry = 543; + static const Tag CashMargin = 544; + static const Tag NestedPartySubID = 545; + static const Tag Scope = 546; + static const Tag MDImplicitDelete = 547; + static const Tag CrossID = 548; + static const Tag CrossType = 549; + static const Tag CrossPrioritization = 550; + static const Tag OrigCrossID = 551; + static const Tag NoSides = 552; + static const Tag Username = 553; + static const Tag Password = 554; + static const Tag NoLegs = 555; + static const Tag LegCurrency = 556; + static const Tag TotNoSecurityTypes = 557; + static const Tag NoSecurityTypes = 558; + static const Tag SecurityListRequestType = 559; + static const Tag SecurityRequestResult = 560; + static const Tag RoundLot = 561; + static const Tag MinTradeVol = 562; + static const Tag MultiLegRptTypeReq = 563; + static const Tag LegPositionEffect = 564; + static const Tag LegCoveredOrUncovered = 565; + static const Tag LegPrice = 566; + static const Tag TradSesStatusRejReason = 567; + static const Tag TradeRequestID = 568; + static const Tag TradeRequestType = 569; + static const Tag PreviouslyReported = 570; + static const Tag TradeReportID = 571; + static const Tag TradeReportRefID = 572; + static const Tag MatchStatus = 573; + static const Tag MatchType = 574; + static const Tag OddLot = 575; + static const Tag NoClearingInstructions = 576; + static const Tag ClearingInstruction = 577; + static const Tag TradeInputSource = 578; + static const Tag TradeInputDevice = 579; + static const Tag NoDates = 580; + static const Tag AccountType = 581; + static const Tag CustOrderCapacity = 582; + static const Tag ClOrdLinkID = 583; + static const Tag MassStatusReqID = 584; + static const Tag MassStatusReqType = 585; + static const Tag OrigOrdModTime = 586; + static const Tag LegSettlType = 587; + static const Tag LegSettlDate = 588; + static const Tag DayBookingInst = 589; + static const Tag BookingUnit = 590; + static const Tag PreallocMethod = 591; + static const Tag UnderlyingCountryOfIssue = 592; + static const Tag UnderlyingStateOrProvinceOfIssue = 593; + static const Tag UnderlyingLocaleOfIssue = 594; + static const Tag UnderlyingInstrRegistry = 595; + static const Tag LegCountryOfIssue = 596; + static const Tag LegStateOrProvinceOfIssue = 597; + static const Tag LegLocaleOfIssue = 598; + static const Tag LegInstrRegistry = 599; + static const Tag LegSymbol = 600; + static const Tag LegSymbolSfx = 601; + static const Tag LegSecurityID = 602; + static const Tag LegSecurityIDSource = 603; + static const Tag NoLegSecurityAltID = 604; + static const Tag LegSecurityAltID = 605; + static const Tag LegSecurityAltIDSource = 606; + static const Tag LegProduct = 607; + static const Tag LegCFICode = 608; + static const Tag LegSecurityType = 609; + static const Tag LegMaturityMonthYear = 610; + static const Tag LegMaturityDate = 611; + static const Tag LegStrikePrice = 612; + static const Tag LegOptAttribute = 613; + static const Tag LegContractMultiplier = 614; + static const Tag LegCouponRate = 615; + static const Tag LegSecurityExchange = 616; + static const Tag LegIssuer = 617; + static const Tag EncodedLegIssuerLen = 618; + static const Tag EncodedLegIssuer = 619; + static const Tag LegSecurityDesc = 620; + static const Tag EncodedLegSecurityDescLen = 621; + static const Tag EncodedLegSecurityDesc = 622; + static const Tag LegRatioQty = 623; + static const Tag LegSide = 624; + static const Tag TradingSessionSubID = 625; + static const Tag AllocType = 626; + static const Tag NoHops = 627; + static const Tag HopCompID = 628; + static const Tag HopSendingTime = 629; + static const Tag HopRefID = 630; + static const Tag MidPx = 631; + static const Tag BidYield = 632; + static const Tag MidYield = 633; + static const Tag OfferYield = 634; + static const Tag ClearingFeeIndicator = 635; + static const Tag WorkingIndicator = 636; + static const Tag LegLastPx = 637; + static const Tag PriorityIndicator = 638; + static const Tag PriceImprovement = 639; + static const Tag Price2 = 640; + static const Tag LastForwardPoints2 = 641; + static const Tag BidForwardPoints2 = 642; + static const Tag OfferForwardPoints2 = 643; + static const Tag RFQReqID = 644; + static const Tag MktBidPx = 645; + static const Tag MktOfferPx = 646; + static const Tag MinBidSize = 647; + static const Tag MinOfferSize = 648; + static const Tag QuoteStatusReqID = 649; + static const Tag LegalConfirm = 650; + static const Tag UnderlyingLastPx = 651; + static const Tag UnderlyingLastQty = 652; + static const Tag SecDefStatus = 653; + static const Tag LegRefID = 654; + static const Tag ContraLegRefID = 655; + static const Tag SettlCurrBidFxRate = 656; + static const Tag SettlCurrOfferFxRate = 657; + static const Tag QuoteRequestRejectReason = 658; + static const Tag SideComplianceID = 659; + static const Tag AcctIDSource = 660; + static const Tag AllocAcctIDSource = 661; + static const Tag BenchmarkPrice = 662; + static const Tag BenchmarkPriceType = 663; + static const Tag ConfirmID = 664; + static const Tag ConfirmStatus = 665; + static const Tag ConfirmTransType = 666; + static const Tag ContractSettlMonth = 667; + static const Tag DeliveryForm = 668; + static const Tag LastParPx = 669; + static const Tag NoLegAllocs = 670; + static const Tag LegAllocAccount = 671; + static const Tag LegIndividualAllocID = 672; + static const Tag LegAllocQty = 673; + static const Tag LegAllocAcctIDSource = 674; + static const Tag LegSettlCurrency = 675; + static const Tag LegBenchmarkCurveCurrency = 676; + static const Tag LegBenchmarkCurveName = 677; + static const Tag LegBenchmarkCurvePoint = 678; + static const Tag LegBenchmarkPrice = 679; + static const Tag LegBenchmarkPriceType = 680; + static const Tag LegBidPx = 681; + static const Tag LegIOIQty = 682; + static const Tag NoLegStipulations = 683; + static const Tag LegOfferPx = 684; + static const Tag LegOrderQty = 685; + static const Tag LegPriceType = 686; + static const Tag LegQty = 687; + static const Tag LegStipulationType = 688; + static const Tag LegStipulationValue = 689; + static const Tag LegSwapType = 690; + static const Tag Pool = 691; + static const Tag QuotePriceType = 692; + static const Tag QuoteRespID = 693; + static const Tag QuoteRespType = 694; + static const Tag QuoteQualifier = 695; + static const Tag YieldRedemptionDate = 696; + static const Tag YieldRedemptionPrice = 697; + static const Tag YieldRedemptionPriceType = 698; + static const Tag BenchmarkSecurityID = 699; + static const Tag ReversalIndicator = 700; + static const Tag YieldCalcDate = 701; + static const Tag NoPositions = 702; + static const Tag PosType = 703; + static const Tag LongQty = 704; + static const Tag ShortQty = 705; + static const Tag PosQtyStatus = 706; + static const Tag PosAmtType = 707; + static const Tag PosAmt = 708; + static const Tag PosTransType = 709; + static const Tag PosReqID = 710; + static const Tag NoUnderlyings = 711; + static const Tag PosMaintAction = 712; + static const Tag OrigPosReqRefID = 713; + static const Tag PosMaintRptRefID = 714; + static const Tag ClearingBusinessDate = 715; + static const Tag SettlSessID = 716; + static const Tag SettlSessSubID = 717; + static const Tag AdjustmentType = 718; + static const Tag ContraryInstructionIndicator = 719; + static const Tag PriorSpreadIndicator = 720; + static const Tag PosMaintRptID = 721; + static const Tag PosMaintStatus = 722; + static const Tag PosMaintResult = 723; + static const Tag PosReqType = 724; + static const Tag ResponseTransportType = 725; + static const Tag ResponseDestination = 726; + static const Tag TotalNumPosReports = 727; + static const Tag PosReqResult = 728; + static const Tag PosReqStatus = 729; + static const Tag SettlPrice = 730; + static const Tag SettlPriceType = 731; + static const Tag UnderlyingSettlPrice = 732; + static const Tag UnderlyingSettlPriceType = 733; + static const Tag PriorSettlPrice = 734; + static const Tag NoQuoteQualifiers = 735; + static const Tag AllocSettlCurrency = 736; + static const Tag AllocSettlCurrAmt = 737; + static const Tag InterestAtMaturity = 738; + static const Tag LegDatedDate = 739; + static const Tag LegPool = 740; + static const Tag AllocInterestAtMaturity = 741; + static const Tag AllocAccruedInterestAmt = 742; + static const Tag DeliveryDate = 743; + static const Tag AssignmentMethod = 744; + static const Tag AssignmentUnit = 745; + static const Tag OpenInterest = 746; + static const Tag ExerciseMethod = 747; + static const Tag TotNumTradeReports = 748; + static const Tag TradeRequestResult = 749; + static const Tag TradeRequestStatus = 750; + static const Tag TradeReportRejectReason = 751; + static const Tag SideMultiLegReportingType = 752; + static const Tag NoPosAmt = 753; + static const Tag AutoAcceptIndicator = 754; + static const Tag AllocReportID = 755; + static const Tag NoNested2PartyIDs = 756; + static const Tag Nested2PartyID = 757; + static const Tag Nested2PartyIDSource = 758; + static const Tag Nested2PartyRole = 759; + static const Tag Nested2PartySubID = 760; + static const Tag BenchmarkSecurityIDSource = 761; + static const Tag SecuritySubType = 762; + static const Tag UnderlyingSecuritySubType = 763; + static const Tag LegSecuritySubType = 764; + static const Tag AllowableOneSidednessPct = 765; + static const Tag AllowableOneSidednessValue = 766; + static const Tag AllowableOneSidednessCurr = 767; + static const Tag NoTrdRegTimestamps = 768; + static const Tag TrdRegTimestamp = 769; + static const Tag TrdRegTimestampType = 770; + static const Tag TrdRegTimestampOrigin = 771; + static const Tag ConfirmRefID = 772; + static const Tag ConfirmType = 773; + static const Tag ConfirmRejReason = 774; + static const Tag BookingType = 775; + static const Tag IndividualAllocRejCode = 776; + static const Tag SettlInstMsgID = 777; + static const Tag NoSettlInst = 778; + static const Tag LastUpdateTime = 779; + static const Tag AllocSettlInstType = 780; + static const Tag NoSettlPartyIDs = 781; + static const Tag SettlPartyID = 782; + static const Tag SettlPartyIDSource = 783; + static const Tag SettlPartyRole = 784; + static const Tag SettlPartySubID = 785; + static const Tag SettlPartySubIDType = 786; + static const Tag DlvyInstType = 787; + static const Tag TerminationType = 788; + static const Tag NextExpectedMsgSeqNum = 789; + static const Tag OrdStatusReqID = 790; + static const Tag SettlInstReqID = 791; + static const Tag SettlInstReqRejCode = 792; + static const Tag SecondaryAllocID = 793; + static const Tag AllocReportType = 794; + static const Tag AllocReportRefID = 795; + static const Tag AllocCancReplaceReason = 796; + static const Tag CopyMsgIndicator = 797; + static const Tag AllocAccountType = 798; + static const Tag OrderAvgPx = 799; + static const Tag OrderBookingQty = 800; + static const Tag NoSettlPartySubIDs = 801; + static const Tag NoPartySubIDs = 802; + static const Tag PartySubIDType = 803; + static const Tag NoNestedPartySubIDs = 804; + static const Tag NestedPartySubIDType = 805; + static const Tag NoNested2PartySubIDs = 806; + static const Tag Nested2PartySubIDType = 807; + static const Tag AllocIntermedReqType = 808; + static const Tag UnderlyingPx = 810; + static const Tag PriceDelta = 811; + static const Tag ApplQueueMax = 812; + static const Tag ApplQueueDepth = 813; + static const Tag ApplQueueResolution = 814; + static const Tag ApplQueueAction = 815; + static const Tag NoAltMDSource = 816; + static const Tag AltMDSourceID = 817; + static const Tag SecondaryTradeReportID = 818; + static const Tag AvgPxIndicator = 819; + static const Tag TradeLinkID = 820; + static const Tag OrderInputDevice = 821; + static const Tag UnderlyingTradingSessionID = 822; + static const Tag UnderlyingTradingSessionSubID = 823; + static const Tag TradeLegRefID = 824; + static const Tag ExchangeRule = 825; + static const Tag TradeAllocIndicator = 826; + static const Tag ExpirationCycle = 827; + static const Tag TrdType = 828; + static const Tag TrdSubType = 829; + static const Tag TransferReason = 830; + static const Tag AsgnReqID = 831; + static const Tag TotNumAssignmentReports = 832; + static const Tag AsgnRptID = 833; + static const Tag ThresholdAmount = 834; + static const Tag PegMoveType = 835; + static const Tag PegOffsetType = 836; + static const Tag PegLimitType = 837; + static const Tag PegRoundDirection = 838; + static const Tag PeggedPrice = 839; + static const Tag PegScope = 840; + static const Tag DiscretionMoveType = 841; + static const Tag DiscretionOffsetType = 842; + static const Tag DiscretionLimitType = 843; + static const Tag DiscretionRoundDirection = 844; + static const Tag DiscretionPrice = 845; + static const Tag DiscretionScope = 846; + static const Tag TargetStrategy = 847; + static const Tag TargetStrategyParameters = 848; + static const Tag ParticipationRate = 849; + static const Tag TargetStrategyPerformance = 850; + static const Tag LastLiquidityInd = 851; + static const Tag PublishTrdIndicator = 852; + static const Tag ShortSaleReason = 853; + static const Tag QtyType = 854; + static const Tag SecondaryTrdType = 855; + static const Tag TradeReportType = 856; + static const Tag AllocNoOrdersType = 857; + static const Tag SharedCommission = 858; + static const Tag ConfirmReqID = 859; + static const Tag AvgParPx = 860; + static const Tag ReportedPx = 861; + static const Tag NoCapacities = 862; + static const Tag OrderCapacityQty = 863; + static const Tag NoEvents = 864; + static const Tag EventType = 865; + static const Tag EventDate = 866; + static const Tag EventPx = 867; + static const Tag EventText = 868; + static const Tag PctAtRisk = 869; + static const Tag NoInstrAttrib = 870; + static const Tag InstrAttribType = 871; + static const Tag InstrAttribValue = 872; + static const Tag DatedDate = 873; + static const Tag InterestAccrualDate = 874; + static const Tag CPProgram = 875; + static const Tag CPRegType = 876; + static const Tag UnderlyingCPProgram = 877; + static const Tag UnderlyingCPRegType = 878; + static const Tag UnderlyingQty = 879; + static const Tag TrdMatchID = 880; + static const Tag SecondaryTradeReportRefID = 881; + static const Tag UnderlyingDirtyPrice = 882; + static const Tag UnderlyingEndPrice = 883; + static const Tag UnderlyingStartValue = 884; + static const Tag UnderlyingCurrentValue = 885; + static const Tag UnderlyingEndValue = 886; + static const Tag NoUnderlyingStips = 887; + static const Tag UnderlyingStipType = 888; + static const Tag UnderlyingStipValue = 889; + static const Tag MaturityNetMoney = 890; + static const Tag MiscFeeBasis = 891; + static const Tag TotNoAllocs = 892; + static const Tag LastFragment = 893; + static const Tag CollReqID = 894; + static const Tag CollAsgnReason = 895; + static const Tag CollInquiryQualifier = 896; + static const Tag NoTrades = 897; + static const Tag MarginRatio = 898; + static const Tag MarginExcess = 899; + static const Tag TotalNetValue = 900; + static const Tag CashOutstanding = 901; + static const Tag CollAsgnID = 902; + static const Tag CollAsgnTransType = 903; + static const Tag CollRespID = 904; + static const Tag CollAsgnRespType = 905; + static const Tag CollAsgnRejectReason = 906; + static const Tag CollAsgnRefID = 907; + static const Tag CollRptID = 908; + static const Tag CollInquiryID = 909; + static const Tag CollStatus = 910; + static const Tag TotNumReports = 911; + static const Tag LastRptRequested = 912; + static const Tag AgreementDesc = 913; + static const Tag AgreementID = 914; + static const Tag AgreementDate = 915; + static const Tag StartDate = 916; + static const Tag EndDate = 917; + static const Tag AgreementCurrency = 918; + static const Tag DeliveryType = 919; + static const Tag EndAccruedInterestAmt = 920; + static const Tag StartCash = 921; + static const Tag EndCash = 922; + static const Tag UserRequestID = 923; + static const Tag UserRequestType = 924; + static const Tag NewPassword = 925; + static const Tag UserStatus = 926; + static const Tag UserStatusText = 927; + static const Tag StatusValue = 928; + static const Tag StatusText = 929; + static const Tag RefCompID = 930; + static const Tag RefSubID = 931; + static const Tag NetworkResponseID = 932; + static const Tag NetworkRequestID = 933; + static const Tag LastNetworkResponseID = 934; + static const Tag NetworkRequestType = 935; + static const Tag NoCompIDs = 936; + static const Tag NetworkStatusResponseType = 937; + static const Tag NoCollInquiryQualifier = 938; + static const Tag TrdRptStatus = 939; + static const Tag AffirmStatus = 940; + static const Tag UnderlyingStrikeCurrency = 941; + static const Tag LegStrikeCurrency = 942; + static const Tag TimeBracket = 943; + static const Tag CollAction = 944; + static const Tag CollInquiryStatus = 945; + static const Tag CollInquiryResult = 946; + static const Tag StrikeCurrency = 947; + static const Tag NoNested3PartyIDs = 948; + static const Tag Nested3PartyID = 949; + static const Tag Nested3PartyIDSource = 950; + static const Tag Nested3PartyRole = 951; + static const Tag NoNested3PartySubIDs = 952; + static const Tag Nested3PartySubID = 953; + static const Tag Nested3PartySubIDType = 954; + static const Tag LegContractSettlMonth = 955; + static const Tag LegInterestAccrualDate = 956; + static const Tag NoStrategyParameters = 957; + static const Tag StrategyParameterName = 958; + static const Tag StrategyParameterType = 959; + static const Tag StrategyParameterValue = 960; + static const Tag HostCrossID = 961; + static const Tag SideTimeInForce = 962; + static const Tag MDReportID = 963; + static const Tag SecurityReportID = 964; + static const Tag SecurityStatus = 965; + static const Tag SettleOnOpenFlag = 966; + static const Tag StrikeMultiplier = 967; + static const Tag StrikeValue = 968; + static const Tag MinPriceIncrement = 969; + static const Tag PositionLimit = 970; + static const Tag NTPositionLimit = 971; + static const Tag UnderlyingAllocationPercent = 972; + static const Tag UnderlyingCashAmount = 973; + static const Tag UnderlyingCashType = 974; + static const Tag UnderlyingSettlementType = 975; + static const Tag QuantityDate = 976; + static const Tag ContIntRptID = 977; + static const Tag LateIndicator = 978; + static const Tag InputSource = 979; + static const Tag SecurityUpdateAction = 980; + static const Tag NoExpiration = 981; + static const Tag ExpType = 982; + static const Tag ExpQty = 983; + static const Tag NoUnderlyingAmounts = 984; + static const Tag UnderlyingPayAmount = 985; + static const Tag UnderlyingCollectAmount = 986; + static const Tag UnderlyingSettlementDate = 987; + static const Tag UnderlyingSettlementStatus = 988; + static const Tag SecondaryIndividualAllocID = 989; + static const Tag LegReportID = 990; + static const Tag RndPx = 991; + static const Tag IndividualAllocType = 992; + static const Tag AllocCustomerCapacity = 993; + static const Tag TierCode = 994; + static const Tag UnitOfMeasure = 996; + static const Tag TimeUnit = 997; + static const Tag UnderlyingUnitOfMeasure = 998; + static const Tag LegUnitOfMeasure = 999; + static const Tag UnderlyingTimeUnit = 1000; + static const Tag LegTimeUnit = 1001; + static const Tag AllocMethod = 1002; + static const Tag TradeID = 1003; + static const Tag SideTradeReportID = 1005; + static const Tag SideFillStationCd = 1006; + static const Tag SideReasonCd = 1007; + static const Tag SideTrdSubTyp = 1008; + static const Tag SideQty = 1009; + static const Tag MessageEventSource = 1011; + static const Tag SideTrdRegTimestamp = 1012; + static const Tag SideTrdRegTimestampType = 1013; + static const Tag SideTrdRegTimestampSrc = 1014; + static const Tag AsOfIndicator = 1015; + static const Tag NoSideTrdRegTS = 1016; + static const Tag LegOptionDelta = 1017; + static const Tag NoInstrumentParties = 1018; + static const Tag InstrumentPartyID = 1019; + static const Tag TradeVolume = 1020; + static const Tag MDBookType = 1021; + static const Tag MDFeedType = 1022; + static const Tag MDPriceLevel = 1023; + static const Tag MDOriginType = 1024; + static const Tag FirstPx = 1025; + static const Tag MDEntrySpotRate = 1026; + static const Tag MDEntryForwardPoints = 1027; + static const Tag ManualOrderIndicator = 1028; + static const Tag CustDirectedOrder = 1029; + static const Tag ReceivedDeptID = 1030; + static const Tag CustOrderHandlingInst = 1031; + static const Tag OrderHandlingInstSource = 1032; + static const Tag DeskType = 1033; + static const Tag DeskTypeSource = 1034; + static const Tag DeskOrderHandlingInst = 1035; + static const Tag ExecAckStatus = 1036; + static const Tag UnderlyingDeliveryAmount = 1037; + static const Tag UnderlyingCapValue = 1038; + static const Tag UnderlyingSettlMethod = 1039; + static const Tag SecondaryTradeID = 1040; + static const Tag FirmTradeID = 1041; + static const Tag SecondaryFirmTradeID = 1042; + static const Tag CollApplType = 1043; + static const Tag UnderlyingAdjustedQuantity = 1044; + static const Tag UnderlyingFXRate = 1045; + static const Tag UnderlyingFXRateCalc = 1046; + static const Tag AllocPositionEffect = 1047; + static const Tag DealingCapacity = 1048; + static const Tag InstrmtAssignmentMethod = 1049; + static const Tag InstrumentPartyIDSource = 1050; + static const Tag InstrumentPartyRole = 1051; + static const Tag NoInstrumentPartySubIDs = 1052; + static const Tag InstrumentPartySubID = 1053; + static const Tag InstrumentPartySubIDType = 1054; + static const Tag PositionCurrency = 1055; + static const Tag CalculatedCcyLastQty = 1056; + static const Tag AggressorIndicator = 1057; + static const Tag NoUndlyInstrumentParties = 1058; + static const Tag UndlyInstrumentPartyID = 1059; + static const Tag UndlyInstrumentPartyIDSource = 1060; + static const Tag UndlyInstrumentPartyRole = 1061; + static const Tag NoUndlyInstrumentPartySubIDs = 1062; + static const Tag UndlyInstrumentPartySubID = 1063; + static const Tag UndlyInstrumentPartySubIDType = 1064; + static const Tag BidSwapPoints = 1065; + static const Tag OfferSwapPoints = 1066; + static const Tag LegBidForwardPoints = 1067; + static const Tag LegOfferForwardPoints = 1068; + static const Tag SwapPoints = 1069; + static const Tag MDQuoteType = 1070; + static const Tag LastSwapPoints = 1071; + static const Tag SideGrossTradeAmt = 1072; + static const Tag LegLastForwardPoints = 1073; + static const Tag LegCalculatedCcyLastQty = 1074; + static const Tag LegGrossTradeAmt = 1075; + static const Tag MaturityTime = 1079; + static const Tag RefOrderID = 1080; + static const Tag RefOrderIDSource = 1081; + static const Tag SecondaryDisplayQty = 1082; + static const Tag DisplayWhen = 1083; + static const Tag DisplayMethod = 1084; + static const Tag DisplayLowQty = 1085; + static const Tag DisplayHighQty = 1086; + static const Tag DisplayMinIncr = 1087; + static const Tag RefreshQty = 1088; + static const Tag MatchIncrement = 1089; + static const Tag MaxPriceLevels = 1090; + static const Tag PreTradeAnonymity = 1091; + static const Tag PriceProtectionScope = 1092; + static const Tag LotType = 1093; + static const Tag PegPriceType = 1094; + static const Tag PeggedRefPrice = 1095; + static const Tag PegSecurityIDSource = 1096; + static const Tag PegSecurityID = 1097; + static const Tag PegSymbol = 1098; + static const Tag PegSecurityDesc = 1099; + static const Tag TriggerType = 1100; + static const Tag TriggerAction = 1101; + static const Tag TriggerPrice = 1102; + static const Tag TriggerSymbol = 1103; + static const Tag TriggerSecurityID = 1104; + static const Tag TriggerSecurityIDSource = 1105; + static const Tag TriggerSecurityDesc = 1106; + static const Tag TriggerPriceType = 1107; + static const Tag TriggerPriceTypeScope = 1108; + static const Tag TriggerPriceDirection = 1109; + static const Tag TriggerNewPrice = 1110; + static const Tag TriggerOrderType = 1111; + static const Tag TriggerNewQty = 1112; + static const Tag TriggerTradingSessionID = 1113; + static const Tag TriggerTradingSessionSubID = 1114; + static const Tag OrderCategory = 1115; + static const Tag NoRootPartyIDs = 1116; + static const Tag RootPartyID = 1117; + static const Tag RootPartyIDSource = 1118; + static const Tag RootPartyRole = 1119; + static const Tag NoRootPartySubIDs = 1120; + static const Tag RootPartySubID = 1121; + static const Tag RootPartySubIDType = 1122; + static const Tag TradeHandlingInstr = 1123; + static const Tag OrigTradeHandlingInstr = 1124; + static const Tag OrigTradeDate = 1125; + static const Tag OrigTradeID = 1126; + static const Tag OrigSecondaryTradeID = 1127; + static const Tag ApplVerID = 1128; + static const Tag CstmApplVerID = 1129; + static const Tag RefApplVerID = 1130; + static const Tag RefCstmApplVerID = 1131; + static const Tag TZTransactTime = 1132; + static const Tag ExDestinationIDSource = 1133; + static const Tag ReportedPxDiff = 1134; + static const Tag RptSys = 1135; + static const Tag AllocClearingFeeIndicator = 1136; + static const Tag DefaultApplVerID = 1137; + static const Tag DisplayQty = 1138; + static const Tag ExchangeSpecialInstructions = 1139; + static const Tag MaxTradeVol = 1140; + static const Tag NoMdFeedTypes = 1141; + static const Tag MatchAlgorithm = 1142; + static const Tag MaxPriceVariation = 1143; + static const Tag ImpliedMarketIndicator = 1144; + static const Tag EventTime = 1145; + static const Tag MinPriceIncrementAmount = 1146; + static const Tag UnitOfMeasureQty = 1147; + static const Tag LowLimitPrice = 1148; + static const Tag HighLimitPrice = 1149; + static const Tag TradingReferencePrice = 1150; + static const Tag SecurityGroup = 1151; + static const Tag SecurityTradingEvent = 1174; + + static const Tag ApplID = 1180; + static const Tag ApplBegSeqNum = 1182; + static const Tag ApplEndSeqNum = 1183; + + static const Tag MinLotSize = 1231; + static const Tag NoLotTypeRules = 1234; + + static const Tag ContractMultiplierUnit = 1435; + static const Tag FlowScheduleType = 1439; + static const Tag MDSecurityTradingStatus = 1682; + + static const Tag PriceRatio = 5770; + + static const Tag ClearedVolume= 5791; + static const Tag OpenInterestQty = 5792; + + static const Tag LegSecurityGroup = 5795; + + static const Tag TradingReferenceDate = 5796; + static const Tag AggressorSide = 5797; + static const Tag MatchEventIndicator = 5799; + + static const Tag DecayQty = 5818; + static const Tag DecayStartDate = 5819; + + static const Tag OriginalContractSize = 5849; + + static const Tag TickRule = 6350; + static const Tag Asset = 6937; + + static const Tag UserDefinedInstrument = 9779; + static const Tag DisplayFactor = 9787; + + static const Tag MinCabPrice = 9850; + static const Tag PricingModel = 9853; + + static const Tag MarketSegmentID = 1300; + + static const Tag MainFraction = 37702; + static const Tag SubFraction = 37703; + + static const Tag NoOrderIDEntries = 37705; + + static const Tag PriceDisplayFormat = 9800; + } + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/TcpRecovery.h b/linux/include/OnixS/CME/MDP3/TcpRecovery.h new file mode 100755 index 000000000..ad270a8d4 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/TcpRecovery.h @@ -0,0 +1,203 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/Types.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + + /// TCP recovery service configuration settings. + struct + ONIXS_CME_MDP3_API + TcpRecoverySettings + { + /// Username to be used to identify a recovery + /// requester while logging on to TCP recovery feed. + /// + /// @note If empty (by default) then TCP recovery is disabled. + const std::string& tcpRecoveryUsername() const + { + return *tcpRecoveryUsername_; + } + + /// Sets tcpRecoveryUsername. @see tcpRecoveryUsername. + void tcpRecoveryUsername(const std::string& value) + { + *tcpRecoveryUsername_ = value; + } + + /// Password to be used to identify a recovery + /// requester while logging on to TCP recovery feed. + const std::string& tcpRecoveryPassword() const + { + return *tcpRecoveryPassword_; + } + + /// Sets tcpRecoveryPassword. @see tcpRecoveryPassword. + void tcpRecoveryPassword(const std::string& value) + { + *tcpRecoveryPassword_ = value; + } + + /// Number of attempts to receive missed + /// messages via the TCP recovery feed. + unsigned int tcpRecoveryReconnectAttempts() const + { + return tcpRecoveryReconnectAttempts_; + } + + /// Sets tcpRecoveryReconnectAttempts. @see tcpRecoveryReconnectAttempts. + void tcpRecoveryReconnectAttempts(unsigned int value) + { + tcpRecoveryReconnectAttempts_ = value; + } + + /// Interval between the attempts to receive + /// missed packets via the TCP recovery feed if + /// previous attempt either failed or was rejected. + /// + /// Interval is measured in milliseconds. + /// + /// @note Default value is '500'. + unsigned int tcpRecoveryReconnectInterval() const + { + return tcpRecoveryReconnectInterval_; + } + + /// Sets tcpRecoveryReconnectInterval. @see tcpRecoveryReconnectInterval. + void tcpRecoveryReconnectInterval(unsigned int value) + { + tcpRecoveryReconnectInterval_ = value; + } + + /// Amount of time allocated to process TCP recovery + /// request. Handler interrupts request processing + /// if it doesn't accomplish within given time frame. + /// + /// Interval is measured in seconds. + /// + /// @note Default value is '30'. + unsigned int tcpRecoveryRequestTimeframe() const + { + return tcpRecoveryRequestTimeframe_; + } + + /// Sets tcpRecoveryRequestTimeframe. @see tcpRecoveryRequestTimeframe. + void tcpRecoveryRequestTimeframe(unsigned int value) + { + tcpRecoveryRequestTimeframe_ = value; + } + + /// Timeout of request for shared TCP recovery service. + /// If shared TCP recovery service is used and another Handler + /// instance owned it for processing, this Handler instance + /// will wait for specified timeout and cancel TCP recovery request + /// if TCP Recovery service still not released. + /// + /// Timeout is measured in milliseconds. + /// + /// @note Default value is '500'. + unsigned int tcpRecoveryRequestExpirationTimeout() const + { + return tcpRecoveryRequestExpirationTimeout_; + } + + /// Sets tcpRecoveryRequestExpirationTimeout. @see tcpRecoveryRequestExpirationTimeout. + void tcpRecoveryRequestExpirationTimeout(unsigned int value) + { + tcpRecoveryRequestExpirationTimeout_ = value; + } + + /// Defines size of buffer in bytes for TCP recovery receiving socket. + /// + /// @note Default value is zero which means + /// system default setting will be used. + unsigned int tcpRecoverySocketReceiveBufferSize() const + { + return tcpRecoverySocketReceiveBufferSize_; + } + + /// Sets tcpRecoverySocketReceiveBufferSize. @see tcpRecoverySocketReceiveBufferSize. + void tcpRecoverySocketReceiveBufferSize(unsigned int value) + { + tcpRecoverySocketReceiveBufferSize_ = value; + } + + /// Initializes parameters with default values. + TcpRecoverySettings(); + + /// Cleans everything up. + ~TcpRecoverySettings(); + + /// Checks whether usage of TCP Recovery service is enabled. + bool useTcpRecovery() const + { + return !tcpRecoveryUsername().empty(); + } + + /// Returns textual presentation. + std::string toString() const + { + std::string str; + toString(str); + return str; + } + + /// Returns textual presentation. + void toString(std::string&) const; + + private: + Exportable tcpRecoveryUsername_; + Exportable tcpRecoveryPassword_; + unsigned int tcpRecoveryReconnectAttempts_; + unsigned int tcpRecoveryReconnectInterval_; + unsigned int tcpRecoveryRequestTimeframe_; + unsigned int tcpRecoveryRequestExpirationTimeout_; + unsigned int tcpRecoverySocketReceiveBufferSize_; + }; + + /// TCP Recovery Service. + class + ONIXS_CME_MDP3_API + TcpRecoveryService + { + public: + class Implementation; + + /// Initializes instance according to given settings. + TcpRecoveryService(const TcpRecoverySettings& settings); + + /// Destructor. + ~TcpRecoveryService(); + + private: + friend class Implementation; + Implementation* impl_; + + TcpRecoveryService(const TcpRecoveryService&); + TcpRecoveryService& operator =(const TcpRecoveryService&); + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/ThreadAffinity.h b/linux/include/OnixS/CME/MDP3/ThreadAffinity.h new file mode 100755 index 000000000..438c2def8 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/ThreadAffinity.h @@ -0,0 +1,89 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include +#include + +#include "OnixS/CME/MDP3/Types.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + + /// Zero-based index of CPU. + typedef int CpuIndex; + + /// Represents set of CPU indices. + class + ONIXS_CME_MDP3_API + ThreadAffinity + { + public: + /// Initializes empty set. + ThreadAffinity(); + + /// Initializes as copy of other set. + ThreadAffinity(const ThreadAffinity&); + + /// Re-initializes instance as copy of other set. + ThreadAffinity& operator =(const ThreadAffinity&); + + /// Utilizes all the resources. + ~ThreadAffinity(); + + /// Indicates whether is empty. + bool empty() const; + + /// Copies set into another set. + void copyTo(std::set&) const; + + /// Adds CPU index into set. + bool insert(CpuIndex index); + + /// Removes CPU index from the set. + bool erase(CpuIndex index); + + /// Makes set empty. + void clear(); + + /// Returns textual presentation. + std::string toString() const + { + std::string str; + toString(str); + return str; + } + + /// Serializes indices into text. + void toString(std::string&) const; + + /// Returns thread affinity of given string presentation. + static ThreadAffinity deserialize(const std::string&); + + private: + /// System index. + Exportable > indices_; + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/Time.h b/linux/include/OnixS/CME/MDP3/Time.h new file mode 100755 index 000000000..1df906cb9 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/Time.h @@ -0,0 +1,668 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include + +#include "OnixS/CME/MDP3/Config.h" +#include "OnixS/CME/MDP3/Types.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + /// Time span formats supported. + struct + ONIXS_CME_MDP3_API + TimeSpanFormats + { + enum Enum + { + /// HH:MM:SS. + HHMMSS, + + /// HH:MM:SS.sss. + HHMMSSmsec, + + /// HH:MM:SS.sssssssss. + SDHHMMSSnsec + }; + }; + + /// Time span format. + typedef + TimeSpanFormats::Enum + TimeSpanFormat; + + /// Subseconds formats supported. + struct ONIXS_CME_MDP3_API Subseconds + { + enum Enum + { + /// Milliseconds + Milli, + + /// Microseconds + Micro, + + /// Nanoseconds + Nano + }; + }; + + /// Time span format. + typedef Subseconds::Enum Subsecond; + + /// Represents time interval. Used primarily to + /// present time-only stamps and to measure time + /// intervals between two timestamps. + class + ONIXS_CME_MDP3_API + TimeSpan + { + public: + /// Initializes zero span. + TimeSpan(); + + /// Initializes with given set of values. + /// Input parameters are treated as quantities, + /// but not as a time stamp. Therefore, there's + /// no requirement to fit in a certain range like + /// hours must fit into [0, 24) range. After + /// initialization time span will be normalized. + TimeSpan( + Int32 hours, + Int32 minutes, + Int32 seconds, + Int32 nanoseconds = 0); + + /// Initializes with given set of values. + /// Input parameters are treated as quantities, + /// but not as a time stamp. Therefore, there's + /// no requirement to fit in a certain range like + /// hours must fit into [0, 24) range. After + /// initialization time span will be normalized. + TimeSpan( + Int32 days, + Int32 hours, + Int32 minutes, + Int32 seconds, + Int32 nanoseconds); + + /// Initializes time interval from total number + /// seconds and its fractional (nanosecond) part. + TimeSpan( + Int64 totalSeconds, + Int32 nanoseconds); + + /// Initializes as clone of other instance. + TimeSpan(const TimeSpan& other); + + /// Whole number of seconds in time interval. + Int64 totalSeconds() const; + + /// Whole number of subseconds in time interval. + Int64 totalSubseconds(Subsecond subsecondType) const; + + /// Days component of time interval. + /// Whole number of days in time interval. + Int32 days() const; + + /// Hours component of time interval. + /// Values are in range from -23 through 23. + Int32 hours() const; + + /// Minutes component of time interval. + /// Values are in range from -59 through 59. + Int32 minutes() const; + + /// Seconds component of time interval. + /// Values are in range from -59 through 59. + Int32 seconds() const; + + /// Milliseconds component of time interval. + /// Values are in range from -999 through 999. + Int32 milliseconds() const; + + /// Microseconds component of time interval. + /// Values are in range from -999999 through 999999. + Int32 microseconds() const; + + /// Nanoseconds component of time interval. + /// Values are in range from -999999999 through 999999999. + Int32 nanoseconds() const; + + /// Compares with other instance for equality. + bool operator ==(const TimeSpan& other) const; + + /// Compares with other instance for in-equality. + bool operator !=(const TimeSpan& other) const; + + /// Checks whether time interval less than other one. + bool operator <(const TimeSpan& other) const; + + /// Checks whether time interval greater than other one. + bool operator >(const TimeSpan& other) const; + + /// Adds time interval to current one. + TimeSpan& operator +=(const TimeSpan& other); + + /// Subtracts time interval from current one. + TimeSpan& operator -=(const TimeSpan& other); + + /// Re-assigns time interval from other one. + TimeSpan& operator =(const TimeSpan& other); + + /// Serializes time stamp into text presentation + /// using specified time-span presentation format. + void + toString( + std::string& str, + TimeSpanFormat format = + TimeSpanFormats::SDHHMMSSnsec) const; + + /// Serializes time stamp into text presentation + /// using specified time-span presentation format. + std::string + toString( + TimeSpanFormat format = + TimeSpanFormats::SDHHMMSSnsec) const; + + /// De-serializes time interval from its text presentation. + static TimeSpan deserialize(const std::string& str); + + /// Time interval of zero length. + static const TimeSpan Zero; + + private: + Int64 seconds_; + Int32 nanoseconds_; + }; + + inline + Int64 + TimeSpan::totalSeconds() const + { + return seconds_; + } + + inline + Int32 + TimeSpan::nanoseconds() const + { + return nanoseconds_; + } + + inline + std::string + TimeSpan::toString( + TimeSpanFormat format) const + { + std::string str; + + toString(str, format); + + return str; + } + + /// Identifies months in year. + struct + ONIXS_CME_MDP3_API + Months + { + enum Enum + { + Bad, + + January, + February, + March, + April, + May, + June, + July, + August, + September, + October, + November, + December, + + Count = December + }; + + /// Deserializes value from text presentation. + static Enum deserialize(const char*); + + /// Returns text presentation for given value. + static const char* toString(Enum); + }; + + /// Identifies months in year. + typedef + Months::Enum + Month; + + /// Identifies day within week. + struct + ONIXS_CME_MDP3_API + DaysOfWeek + { + enum Enum + { + Sunday, + Monday, + Tuesday, + Wednesday, + Thursday, + Friday, + Saturday, + + Total + }; + + /// Deserializes value from text presentation. + static Enum deserialize(const char*); + + /// Returns text presentation for given value. + static const char* toString(Enum); + }; + + /// Identifies days in week. + typedef + DaysOfWeek::Enum + DayOfWeek; + + /// Identifies week number within month. + struct ONIXS_CME_MDP3_API WeekCodes + { + enum Enum + { + Invalid, + Week1, + Week2, + Week3, + Week4, + Week5, + + LastWeek = Week5 + }; + + /// Deserializes value from text presentation. + static Enum deserialize(const char*); + + /// Returns text presentation for given value. + static const char* toString(Enum); + }; + + /// Identifies week number within month. + typedef + WeekCodes::Enum + WeekCode; + + /// Represents month-year pair. + /// Year must fit into [0001, 9999] range. + /// Month must fit into [01, 12] range. + class + ONIXS_CME_MDP3_API + YearMonth + { + public: + /// Initializes instance as Jan, 0001. + YearMonth(); + + /// Initializes instance with given values according + /// YYYYMM (year/month) format. + /// Input parameters are checked for validness. + /// @throw exception if input parameters do + /// not fit into a valid range. + YearMonth( + UInt32 year, + Month month); + + /// Initializes instance with given values according + /// YYYYMMDD (year/month/day) format. + /// Input parameters are checked for validness. + /// @throw exception if input parameters do + /// not fit into a valid range. + YearMonth( + UInt32 year, + Month month, + UInt32 day); + + /// Initializes instance with given values according + /// YYYYMMWW (year/month/week) format. + /// Input parameters are checked for validness. + /// @throw exception if input parameters do + /// not fit into a valid range. + YearMonth( + UInt32 year, + Month month, + WeekCode week); + + /// Initializes as copy of other instance. + YearMonth(const YearMonth& other); + + /// Year component. + /// Valid range of values is [0001, 9999]. + UInt32 year() const + { + return year_; + } + + /// Month component. + /// Valid range of values is [01, 12]. + Month month() const + { + return month_; + } + + /// Day component. + /// Valid range of values is [01, 31]. + UInt32 day() const + { + return day_; + } + + /// Week component. + /// Valid range of values is [1, 5]. + WeekCode week() const + { + return week_; + } + + /// Checks that instance has valid day component. + /// Note: it's not valid to have both valid day and week, only one of them allowed. + bool hasDay() const + { + return day_ != 0; + } + + /// Checks that instance has valid week component. + /// Note: it's not valid to have both valid day and week, only one of them allowed. + bool hasWeek() const + { + return week_ != WeekCodes::Invalid; + } + + /// Compares with other instance for equality. + bool operator ==(const YearMonth&) const; + + /// Compares with other instance for inequality. + bool operator !=(const YearMonth&) const; + + /// Checks whether this instance is less than other one. + /// Note: when comparing objects with different date components, + /// e.g. days vs weeks (but same year and month) following order is applied: + /// YYYYMM < YYYYMMWW < YYYYMMDD + bool operator <(const YearMonth& other) const; + + /// Checks whether this instance is greater than other one. + /// Note: when comparing objects with different date components, + /// e.g. days vs weeks (but same year and month) following order is applied: + /// YYYYMMDD > YYYYMMWW > YYYYMM + bool operator >(const YearMonth& other) const; + + // Re-initializes instance as copy of other one. + YearMonth& operator =(const YearMonth& other); + + /// Serializes into text (YYYYMM/YYYYMMDD/YYYYMMWW) presentation. + std::string toString() const + { + std::string str; + toString(str); + return str; + } + + /// Serializes into text (YYYYMM/YYYYMMDD/YYYYMMWW) presentation. + void toString(std::string&) const; + + /// De-serializes instance from its string + /// presentation (YYYYMM/YYYYMMDD/YYYYMMWW) as it's used by CME Globex. + static YearMonth deserialize(const StringRef&); + + private: + // Year component. + UInt32 year_; + + // Month component. + Month month_; + + // Day component. + UInt32 day_; + + // Week component. + WeekCode week_; + }; + + /// Collection of timestamp formats supported. + struct + ONIXS_CME_MDP3_API + TimestampFormats + { + enum Enum + { + /// YYYYMMDD. + YYYYMMDD, + + /// YYYYMMDD-HH:MM:SS. + YYYYMMDDHHMMSS, + + /// YYYYMMDD-HH:MM:SS.sss. + YYYYMMDDHHMMSSmsec, + + /// YYYYMMDD-HH:MM:SS.sssssssss. + YYYYMMDDHHMMSSnsec + }; + }; + + /// Timestamp format. + typedef + TimestampFormats::Enum + TimestampFormat; + + /// Since epoch time units supported. + struct + ONIXS_CME_MDP3_API + SinceEpochUnits + { + enum Enum + { + Nanoseconds, + Days + }; + }; + + /// Since epoch units format. + typedef + SinceEpochUnits::Enum + SinceEpochUnit; + + /// Represents timestamp without time-zone information. + class + ONIXS_CME_MDP3_API + Timestamp + { + public: + /// Initializes as Jan 1, 1970, 00:00:00. + Timestamp(); + + /// Initializes as date with zero time component. + /// + /// Input parameters are validated, therefore + /// constructor throws exception if input values + /// do not fit into their valid ranges. + Timestamp( + UInt32 year, + Month month, + UInt32 day); + + /// Explicit timestamp initialization. + /// + /// Input parameters are validated, therefore + /// constructor throws exception if input values + /// do not fit into their valid ranges. + Timestamp( + UInt32 year, + Month month, + UInt32 day, + UInt32 hour, + UInt32 minute, + UInt32 second, + UInt32 nanosecond); + + /// Initializes as copy of other instance. + Timestamp(const Timestamp& other); + + /// Year component of timestamp. + UInt32 year() const; + + /// Month component of timestamp. + Month month() const; + + /// Day component of timestamp. + UInt32 day() const; + + /// Hour component of timestamp. + UInt32 hour() const; + + /// Minute component of timestamp. + UInt32 minute() const; + + /// Second component of timestamp. + UInt32 second() const; + + /// Millisecond component of timestamp. + UInt32 millisecond() const; + + /// Microsecond component of timestamp. + UInt32 microsecond() const; + + /// Nanosecond component of timestamp. + UInt32 nanosecond() const; + + /// Returns timestamp without time part. + Timestamp date() const; + + /// Return time part of timestamp. + TimeSpan time() const; + + /// Returns day of the week. + DayOfWeek dayOfWeek() const; + + /// Compares with other instance for equality. + bool operator ==(const Timestamp& other) const; + + /// Compares with other instance for inequality. + bool operator !=(const Timestamp& other) const; + + /// Checks whether timestamp is less than other one. + bool operator <(const Timestamp& other) const; + + /// Checks whether timestamp is greater than other one. + bool operator >(const Timestamp& other) const; + + /// Adds time interval to given timestamp. + Timestamp& operator +=(const TimeSpan& span); + + /// Subtracts time interval from given timestamp. + Timestamp& operator -=(const TimeSpan& span); + + /// Re-initializes as copy of other timestamp. + Timestamp& operator =(const Timestamp& other); + + /// Return timestamp that is current date + /// and time expressed as local time. + static Timestamp now(); + + /// Return timestamp that is current date + /// and time expressed as local time. + static void now(Timestamp&); + + /// Return timestamp that is current date + /// and time expressed as UTC time. + static Timestamp utcNow(); + + /// Return timestamp that is current date + /// and time expressed as UTC time. + static void utcNow(Timestamp&); + + /// Returns text presentation of timestamp + /// using specified presentation format. + std::string + toString( + TimestampFormat format = + TimestampFormats::YYYYMMDDHHMMSSnsec) const + { + std::string str; + toString(str, format); + return str; + } + + /// Returns text presentation of timestamp + /// using specified presentation format. + void + toString( + std::string& str, + TimestampFormat format = + TimestampFormats::YYYYMMDDHHMMSSnsec) const; + + /// De-serializes timestamp from text presentation. + static Timestamp deserialize(const StringRef&); + + /// Converts timestamp from its numeric presentation + /// (Unix timestamp in nanoseconds or days since 01-01-1970 UTC) + /// as it's used by the CME Globex. + static Timestamp fromUnixTimestamp(UInt64 sinceEpoch, SinceEpochUnit unit); + + /// Converts timestamp into its numeric presentation + /// (Unix timestamp in nanoseconds or days since 01-01-1970 UTC) + /// as it's used by the CME Globex. + UInt64 toUnixTimestamp(SinceEpochUnit unit) const; + + /// Returns the maximal possible timestamp (year 2554) + static Timestamp maxTimestamp(); + + private: + friend + ONIXS_CME_MDP3_API + TimeSpan + operator -( + const Timestamp& left, + const Timestamp& right); + + /// Initializes from time interval since the Unix Epoch + /// (in nanoseconds since 01-01-1970 UTC). + Timestamp(UInt64); + + /// Time interval since the Unix Epoch + /// (nanoseconds since 01-01-1970 UTC). + UInt64 sinceEpoch_; + }; + + /// Calculates time interval between two timestamps. + ONIXS_CME_MDP3_API + TimeSpan + operator -( + const Timestamp& left, + const Timestamp& right); + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/Trade.h b/linux/include/OnixS/CME/MDP3/Trade.h new file mode 100755 index 000000000..577bad338 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/Trade.h @@ -0,0 +1,613 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/Types.h" +#include "OnixS/CME/MDP3/Tags.h" +#include "OnixS/CME/MDP3/EventIndicator.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + /// Known trade update actions. + struct + ONIXS_CME_MDP3_API + TradeUpdateActions + { + /// Known trade update actions. + enum Enum + { + /// Identifies absence of value. + Undefined = -1, + + /// New trade. + New = 0, + + /// Trade adjustment. + Change = 1, + + /// Trade deletion. + Delete = 2 + }; + + /// Returns constant from its string representation. + static Enum deserialize(const char* text); + + /// Returns string representation of given constant. + static const char* toString(Enum value); + }; + + /// Type of trade update action. + typedef + TradeUpdateActions::Enum + TradeUpdateAction; + + /// Known aggressors sides. + struct + ONIXS_CME_MDP3_API + AggressorSides + { + /// Known aggressors sides. + enum Enum + { + /// Used to identify absence of value. + Undefined = -1, + + /// Aggressor side is undefined. + NoAgressor = 0, + + /// Buy side. + Buy = 1, + + /// Sell side. + Sell = 2 + }; + + /// Returns constant from its string representation. + static Enum deserialize(const char* text); + + /// Returns string representation of given constant. + static const char* toString(Enum value); + }; + + /// Indicates which side is aggressor of the trade. + typedef + AggressorSides::Enum + AggressorSide; + + /// Identifies trade position inside market event. + typedef + unsigned int + TradeIndex; + + ONIXS_CME_MDP3_API_DECL(class, MessageOrderIds); + ONIXS_CME_MDP3_API_DECL(class, TradeOrderIds); + + /// Attributes associated with trade on certain order. + class + ONIXS_CME_MDP3_API + OrderIdEntry + { + friend class MessageOrderIds; + friend class TradeOrderIds; + + GroupInstance entry_; + + OrderIdEntry( + const GroupInstance& entry) + : entry_(entry) + { + } + + public: + + /// Default instance referring to nothing. + OrderIdEntry() + { + } + + /// Detaches from associated resources. + ~OrderIdEntry() + { + } + + /// Indicates whether instance refers to valid data. + operator bool() const + { + return static_cast(entry_); + } + + /// Order identifier (if instance refers to valid data). + OrderId orderId() const + { + return entry_.getUInt64(Tags::OrderID); + } + + /// Last quantity (if instance refers to valid data). + SignedQuantity lastQty() const + { + return entry_.getInt32(Tags::LastQty); + } + + /// Returns text presentation. + std::string toString() const + { + std::string str; + toString(str); + return str; + } + + /// Appends text presentation. + void toString(std::string&) const; + }; + + /// Order Id array presented in message. + /// @warning Order Ids are supported for CME Globex feed only. + /// They will not be sent by CME Partner Exchanges. + class + ONIXS_CME_MDP3_API + MessageOrderIds + { + Group entries_; + + public: + /// Initializes instance referring to no data. + MessageOrderIds() + {} + + /// Initializes from message. + MessageOrderIds(const Message& message) + : entries_(message.getOptionalGroup(Tags::NoOrderIDEntries, false)) + {} + + /// Detaches from associated resources. + ~MessageOrderIds() + {} + + /// Indicates whether instance refers to valid data. + operator bool() const + { + return static_cast(entries_); + } + + /// Number of entries in array. + /// + /// @warning Due to performance considerations, + /// instance is not checked for validness. Member + /// must be used only when instance is in valid state. + size_t size() const + { + return entries_.size(); + } + + /// Provides access to single order data + /// and quantity traded under that order. + /// + /// @warning Due to performance considerations, + /// instance is not checked for validness. Member + /// must be used only when instance is in valid state. + OrderIdEntry + operator []( + size_t index) const + { + return OrderIdEntry(entries_[index]); + } + + /// Returns text presentation. + std::string toString() const + { + std::string str; + toString(str); + return str; + } + + /// Appends text presentation. + void toString(std::string&) const; + }; + + /// Order-related attributes associated with particular trade. + /// @warning Order Ids are supported for CME Globex feed only. + /// They will not be sent by CME Partner Exchanges. + class + ONIXS_CME_MDP3_API + TradeOrderIds + { + Group entries_; + TradeIndex tradeIndex_; + size_t startFrom_; + size_t count_; + + public: + /// Initializes instance referring to no data. + TradeOrderIds() + : tradeIndex_(0) + , startFrom_(0) + , count_(0) + { + } + + /// Initializes from repeating group. + TradeOrderIds( + const Group& entries, + TradeIndex tradeIndex, + size_t startFrom, + size_t count) + : entries_(entries) + , tradeIndex_(tradeIndex) + , startFrom_(startFrom) + , count_(count) + { + } + + /// Detaches from associated resources. + ~TradeOrderIds() + { + } + + /// Index of associated trade. + /// @see Trade::index() + TradeIndex tradeIndex() const + { + return tradeIndex_; + } + + /// Indicates whether instance refers to valid data. + operator bool() const + { + return static_cast(entries_); + } + + /// Number of entries containing order-related + /// information associated with a trade. + /// + /// @warning Due to performance considerations, + /// instance is not checked for validness. Member + /// must be used only when instance is in valid state. + size_t size() const + { + return count_; + } + + /// Provides access to single order data + /// and quantity traded under that order. + /// + /// @warning Due to performance considerations, + /// instance is not checked for validness. Member + /// must be used only when instance is in valid state. + OrderIdEntry + operator []( + size_t index) const + { + return OrderIdEntry(entries_[startFrom_ + index]); + } + + /// Returns text presentation. + std::string toString() const + { + std::string str; + toString(str); + return str; + } + + /// Appends text presentation. + void toString(std::string&) const; + }; + + /// Trade. + class + ONIXS_CME_MDP3_API + Trade + { + public: + /// Initializes an instance. + Trade( + SecurityId security, + TradeIndex index, + const GroupInstance& entry) + : securityId_(security) + , index_(index) + , entry_(entry) + { + } + + /// Cleans everything up. + ~Trade() + { + } + + /// Start of event processing time (UTC) with nanoseconds precision. + /// @note Required field + Timestamp transactTime() const + { + return entry_.message().getTimestamp( + Tags::TransactTime, SinceEpochUnits::Nanoseconds); + } + + /// Unique instrument ID. + SecurityId + securityId() const + { + return securityId_; + } + + /// Unique index of trade inside market event. + /// @note There may be gaps in trade indexes due to filtering. + TradeIndex + index() const + { + return index_; + } + + /// Price. + /// @note Required field + Price + price() const + { + return entry_.getDecimal(Tags::MDEntryPx); + } + + /// Quantity. + /// @note Required field + SignedQuantity + quantity() const + { + return entry_.getInt32(Tags::MDEntrySize); + } + + /// Type of Market Data (Trade) update action. + TradeUpdateAction + action() const + { + return + getIntEnumFieldValue + + ( + entry_, + Tags::MDUpdateAction + ); + } + + /// Number of orders. + bool + numberOfOrders( + SignedQuantity& numberOfOrders) const + { + return entry_. + get(Tags::NumberOfOrders). + toNumber(numberOfOrders); + } + + /// Returns the aggressor side of the trade. + AggressorSide + aggressorSide() const + { + return getIntEnumFieldValue + (entry_, Tags::AggressorSide); + } + + /// Market data events present in the + /// message containing given instance. + EventIndicator + eventIndicator() const + { + return EventIndicator(entry_.message()); + } + + /// Returns TradeID value if present. + /// @warning TradeID is supported only by CME Partner Exchanges (e.g. BVMF). + /// It will NOT be available for CME Globex feed. + bool + tradeId(Int32& id) const + { + return entry_. + get(Tags::TradeID). + toNumber(id); + } + + /// Returns group entry (FIX fields) of underlying message. + /// Group entry contains all the data related with given trade. + const + GroupInstance& + marketDataEntry() const + { + return entry_; + } + + /// Returns text presentation. + std::string toString() const + { + std::string str; + toString(str); + return str; + } + + /// Appends text presentation. + void toString(std::string&) const; + + private: + const SecurityId securityId_; + const TradeIndex index_; + GroupInstance entry_; + + Trade(const Trade&); + Trade& operator =(const Trade&); + }; + + /// Electronic Volume (implied trade). + class + ONIXS_CME_MDP3_API + ElectronicVolume + { + public: + /// Initializes instance from primary attributes. + ElectronicVolume( + SecurityId id, + const GroupInstance& entry) + : security_(id), entry_(entry) + { + } + + /// Cleans everything up. + ~ElectronicVolume() + { + } + + /// Start of event processing time (UTC) with nanoseconds precision. + /// @note Required field + Timestamp transactTime() const + { + return entry_.message().getTimestamp( + Tags::TransactTime, SinceEpochUnits::Nanoseconds); + } + + /// Unique instrument ID as qualified by + /// the exchange per tag 22-SecurityIDSource. + SecurityId securityId() const + { + return security_; + } + + /// Quantity. + SignedQuantity quantity() const + { + return entry_.getInt32(Tags::MDEntrySize); + } + + /// Market data events present in the + /// message containing given instance. + EventIndicator + eventIndicator() const + { + return EventIndicator(entry_.message()); + } + + /// Underlying FIX message containing electronic volume. + /// Group entry contains all the data related with this instance. + const + GroupInstance& + marketDataEntry() const + { + return entry_; + } + + /// Returns the string representation. + std::string toString() const + { + std::string str; + toString(str); + return str; + } + + /// Appends the string representation. + void toString(std::string&) const; + + private: + const SecurityId security_; + GroupInstance entry_; + + ElectronicVolume( + const ElectronicVolume&); + + ElectronicVolume& + operator =( + const ElectronicVolume&); + }; + + // Listeners. + + /// Listener for trades. + class + ONIXS_CME_MDP3_API + TradeListener + { + public: + /// Is called when a new trade market data entry + /// is received from incremental update + /// or recovered from snapshot. + /// + /// @param trade Trade instance + /// @param channelId Channel identificator + virtual + void + onTrade( + const Trade& trade, + const ChannelId& channelId) = 0; + + protected: + virtual ~TradeListener(); + }; + + /// Listener for Order IDs. + class + ONIXS_CME_MDP3_API + OrderIdListener + { + public: + /// Is called when a new message with Order IDs is received and + /// no matching to trades strategy is selected in handler settings. + /// @see OrderIdProcessingStrategies::NoMatching + /// + /// @param orderIds Order IDs array related to entire message. + /// @param channelId Channel identificator + virtual + void + onOrderIds( + const MessageOrderIds& orderIds, + const ChannelId& channelId) = 0; + + /// Is called when a new Order IDs data block is matched to + /// associated trade and trade matching strategy is selected + /// in handler settings. + /// @see OrderIdProcessingStrategies::TradeMatching + /// + /// @param orderIds Order IDs array associated to trade at tradeIndex. + /// @param channelId Channel identificator + virtual + void + onOrderIds( + const TradeOrderIds& orderIds, + const ChannelId& channelId) = 0; + + protected: + virtual ~OrderIdListener(); + }; + + /// Listener for electronic volumes. + class + ONIXS_CME_MDP3_API + ElectronicVolumeListener + { + public: + /// Is called when an electronic volume + /// market data entry is received. + virtual + void + onElectronicVolume( + const ElectronicVolume& volume, + const ChannelId& channelId) = 0; + + protected: + virtual ~ElectronicVolumeListener(); + }; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/Types.h b/linux/include/OnixS/CME/MDP3/Types.h new file mode 100755 index 000000000..5d7d8040f --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/Types.h @@ -0,0 +1,88 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/Numeric.h" +#include "OnixS/CME/MDP3/String.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + /// Alias for channel identifier. + typedef StringRef ChannelId; + + /// Alias for Security Id type. + typedef int SecurityId; + + /// Alias for MarketSegment ID type. + typedef unsigned int MarketSegmentId; + + /// Alias for market data depth. + typedef size_t MarketDepth; + + /// Market depth traits. + struct + ONIXS_CME_MDP3_API + MarketDepthTraits + { + /// Maximal possible value for market depth. + static + const MarketDepth + MaxDepth = static_cast(-1); + }; + + /// Alias for price level index. + typedef MarketDepth PriceLevelIndex; + + // Semantical alias for price type. + typedef Decimal Price; + + // Semantical alias for price factor type. + typedef Decimal PriceFactor; + + // Semantical alias for amount (price multiplied by qty) type. + typedef Decimal Amount; + + /// Quantity that fits into 32-bit unsigned integer. + typedef unsigned int Quantity; + + /// Quantity that fits into 32-bit integer + /// and may accept negative values. + typedef int SignedQuantity; + + /// Quantity with fractional part. + typedef Decimal FloatQuantity; + + /// Alias for message/packet sequence number. + typedef unsigned int SequenceNumber; + + /// FIX message field identifying/indexing type. + typedef unsigned int Tag; + + /// Alias for unique order identifier. + typedef unsigned long long OrderId; + + /// Alias for exchange side defined Quote Request Id. + typedef StringRef QuoteReqId; + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/Version.h b/linux/include/OnixS/CME/MDP3/Version.h new file mode 100755 index 000000000..4318f2aea --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/Version.h @@ -0,0 +1,124 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include + +#include "OnixS/CME/MDP3/Config.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + /// Alias for the numeric component of version. + typedef unsigned short VersionComponent; + + /// Identifies version of the product. + /// + /// Provides access to single components which compound whole version, + /// comparing and serialization/deserialization facilities. + class + ONIXS_CME_MDP3_API + Version + { + public: + /// Initializes instances from all the components. + Version( + VersionComponent major, + VersionComponent minor, + VersionComponent improvement, + VersionComponent build); + + /// Initializes as clone of other instance. + Version(const Version& other); + + /// 'major' component of version. + VersionComponent major() const + { + return major_; + } + + /// 'minor' component of version. + VersionComponent minor() const + { + return minor_; + } + + /// 'improvement' component of version. + VersionComponent improvement() const + { + return improvement_; + } + + /// 'build number' component of version. + VersionComponent build() const + { + return build_; + } + + /// Compares with other instance for equality. + bool operator ==(const Version&) const; + + /// Compares with other instance for inequality. + bool operator !=(const Version&) const; + + /// Checks whether the version is less then the other. + bool operator <(const Version&) const; + + /// Checks whether the version is grater then the other. + bool operator >(const Version&) const; + + /// Re-initializes instance as copy of other one. + Version& operator =(const Version&); + + /// Serializes into point-separated presentation. + void toString(std::string&) const; + + /// Serializes into point-separated presentation. + std::string toString() const + { + std::string str; + toString(str); + return str; + } + + /// Extracts version from point-separated presentation. + /// Updates version parameter if buffer is parsed successfully. + static + bool + parse( + const char*, + size_t, + Version&); + + /// Identifies current version of the product. + static Version current(); + + private: + VersionComponent major_; + VersionComponent minor_; + VersionComponent improvement_; + VersionComponent build_; + }; + + } + } +} diff --git a/linux/include/OnixS/CME/MDP3/Warning.h b/linux/include/OnixS/CME/MDP3/Warning.h new file mode 100755 index 000000000..2014fe231 --- /dev/null +++ b/linux/include/OnixS/CME/MDP3/Warning.h @@ -0,0 +1,156 @@ +// Copyright Onix Solutions Limited [OnixS]. All rights reserved. +// +// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law +// and international copyright treaties. +// +// Access to and use of the software is governed by the terms of the applicable OnixS Software +// Services Agreement (the Agreement) and Customer end user license agreements granting +// a non-assignable, non-transferable and non-exclusive license to use the software +// for it's own data processing purposes under the terms defined in the Agreement. +// +// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part +// of this source code or associated reference material to any other location for further reproduction +// or redistribution, and any amendments to this copyright notice, are expressly prohibited. +// +// Any reproduction or redistribution for sale or hiring of the Software not in accordance with +// the terms of the Agreement is a violation of copyright law. +// + +#pragma once + +#include "OnixS/CME/MDP3/Types.h" + +namespace OnixS +{ + namespace CME + { + namespace MDP3 + { + /// List of known warnings. + struct ONIXS_CME_MDP3_API KnownWarnings + { + /// List of known warnings. + enum Enum + { + /// General-purpose warning. + Generic, + + /// For each feed channel server sends out messages + /// or heartbeats at fixed intervals. If the Handler + /// hasn’t received any message or a heartbeat for an + /// extended period of time, NoNetworkActivity + /// warning is raised by the Handler to identify that + /// either multicast channel is no longer active or + /// there is a network related issue. + NoNetworkActivity, + + /// Tells that there is sequence number + /// gap in packets from a multicast feed. + PacketGap, + + /// Indicates that one of internal queues + /// used by the Handler to store packets + /// coming from network is overflowed. + PacketQueueOverflow, + + /// Indicates failure in the user-space code. + /// When the Handler catches exception from the + /// user-space code, warning of given code reported. + ListenerFailure + }; + + /// Returns constant from its text presentation. + static Enum deserialize(const char* value); + + /// Returns description of a particular warning. + static const char* toString(Enum value); + }; + + /// Code of warning. + typedef KnownWarnings::Enum WarningCode; + + /// Warning. + class ONIXS_CME_MDP3_API Warning + { + public: + /// Initializes instance with just a code. + Warning( + const std::string& source, + WarningCode code); + + /// Initializes instance with code and description. + Warning( + const std::string& source, + WarningCode code, + const std::string& description); + + /// Initializes as clone of another warning. + Warning(const Warning& other); + + /// Cleans internal resources. + ~Warning(); + + /// Code of warning. + WarningCode code() const + { + return code_; + } + + /// Human readable description. + const char* description() const + { + return description_; + } + + /// Origin of the warning. + const char* source() const + { + return source_; + } + + /// String presentation of an warning. + std::string toString() const + { + std::string str; + toString(str); + return str; + } + + /// Appends presentation of an warning to the string. + void toString(std::string&) const; + + /// Copies warning attributes from another instance. + Warning& operator =(const Warning& other); + + private: + enum Traits + { + SourceMaxLength = 128, + DescriptionMaxLength = 1024 + }; + + WarningCode code_; + char source_[SourceMaxLength]; + char description_[DescriptionMaxLength]; + }; + + /// Warning listener. + class + ONIXS_CME_MDP3_API + WarningListener + { + public: + /// Is called when a warning is detected + /// during the processing of the market data. + virtual + void + onWarning( + const Warning& warning, + const ChannelId& channelId) = 0; + + protected: + virtual ~WarningListener(); + }; + } + } +} diff --git a/linux/include/pugixml/pugiconfig.hpp b/linux/include/pugixml/pugiconfig.hpp new file mode 100644 index 000000000..2d1e6aa8b --- /dev/null +++ b/linux/include/pugixml/pugiconfig.hpp @@ -0,0 +1,74 @@ +/** + * pugixml parser - version 1.8 + * -------------------------------------------------------- + * Copyright (C) 2006-2016, by Arseny Kapoulkine (arseny.kapoulkine@gmail.com) + * Report bugs and download new versions at http://pugixml.org/ + * + * This library is distributed under the MIT License. See notice at the end + * of this file. + * + * This work is based on the pugxml parser, which is: + * Copyright (C) 2003, by Kristen Wegner (kristen@tima.net) + */ + +#ifndef HEADER_PUGICONFIG_HPP +#define HEADER_PUGICONFIG_HPP + +// Uncomment this to enable wchar_t mode +// #define PUGIXML_WCHAR_MODE + +// Uncomment this to enable compact mode +// #define PUGIXML_COMPACT + +// Uncomment this to disable XPath +// #define PUGIXML_NO_XPATH + +// Uncomment this to disable STL +// #define PUGIXML_NO_STL + +// Uncomment this to disable exceptions +// #define PUGIXML_NO_EXCEPTIONS + +// Set this to control attributes for public classes/functions, i.e.: +// #define PUGIXML_API __declspec(dllexport) // to export all public symbols from DLL +// #define PUGIXML_CLASS __declspec(dllimport) // to import all classes from DLL +// #define PUGIXML_FUNCTION __fastcall // to set calling conventions to all public functions to fastcall +// In absence of PUGIXML_CLASS/PUGIXML_FUNCTION definitions PUGIXML_API is used instead + +// Tune these constants to adjust memory-related behavior +// #define PUGIXML_MEMORY_PAGE_SIZE 32768 +// #define PUGIXML_MEMORY_OUTPUT_STACK 10240 +// #define PUGIXML_MEMORY_XPATH_PAGE_SIZE 4096 + +// Uncomment this to switch to header-only version +// #define PUGIXML_HEADER_ONLY + +// Uncomment this to enable long long support +// #define PUGIXML_HAS_LONG_LONG + +#endif + +/** + * Copyright (c) 2006-2016 Arseny Kapoulkine + * + * Permission is hereby granted, free of charge, to any person + * obtaining a copy of this software and associated documentation + * files (the "Software"), to deal in the Software without + * restriction, including without limitation the rights to use, + * copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following + * conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR + * OTHER DEALINGS IN THE SOFTWARE. + */ diff --git a/linux/include/pugixml/pugixml.cpp b/linux/include/pugixml/pugixml.cpp new file mode 100644 index 000000000..cac51a534 --- /dev/null +++ b/linux/include/pugixml/pugixml.cpp @@ -0,0 +1,12622 @@ +/** + * pugixml parser - version 1.8 + * -------------------------------------------------------- + * Copyright (C) 2006-2016, by Arseny Kapoulkine (arseny.kapoulkine@gmail.com) + * Report bugs and download new versions at http://pugixml.org/ + * + * This library is distributed under the MIT License. See notice at the end + * of this file. + * + * This work is based on the pugxml parser, which is: + * Copyright (C) 2003, by Kristen Wegner (kristen@tima.net) + */ + +#ifndef SOURCE_PUGIXML_CPP +#define SOURCE_PUGIXML_CPP + +#include "pugixml.hpp" + +#include +#include +#include +#include +#include + +#ifdef PUGIXML_WCHAR_MODE +# include +#endif + +#ifndef PUGIXML_NO_XPATH +# include +# include +# ifdef PUGIXML_NO_EXCEPTIONS +# include +# endif +#endif + +#ifndef PUGIXML_NO_STL +# include +# include +# include +#endif + +// For placement new +#include + +#ifdef _MSC_VER +# pragma warning(push) +# pragma warning(disable: 4127) // conditional expression is constant +# pragma warning(disable: 4324) // structure was padded due to __declspec(align()) +# pragma warning(disable: 4611) // interaction between '_setjmp' and C++ object destruction is non-portable +# pragma warning(disable: 4702) // unreachable code +# pragma warning(disable: 4996) // this function or variable may be unsafe +# pragma warning(disable: 4793) // function compiled as native: presence of '_setjmp' makes a function unmanaged +#endif + +#ifdef __INTEL_COMPILER +# pragma warning(disable: 177) // function was declared but never referenced +# pragma warning(disable: 279) // controlling expression is constant +# pragma warning(disable: 1478 1786) // function was declared "deprecated" +# pragma warning(disable: 1684) // conversion from pointer to same-sized integral type +#endif + +#if defined(__BORLANDC__) && defined(PUGIXML_HEADER_ONLY) +# pragma warn -8080 // symbol is declared but never used; disabling this inside push/pop bracket does not make the warning go away +#endif + +#ifdef __BORLANDC__ +# pragma option push +# pragma warn -8008 // condition is always false +# pragma warn -8066 // unreachable code +#endif + +#ifdef __SNC__ +// Using diag_push/diag_pop does not disable the warnings inside templates due to a compiler bug +# pragma diag_suppress=178 // function was declared but never referenced +# pragma diag_suppress=237 // controlling expression is constant +#endif + +// Inlining controls +#if defined(_MSC_VER) && _MSC_VER >= 1300 +# define PUGI__NO_INLINE __declspec(noinline) +#elif defined(__GNUC__) +# define PUGI__NO_INLINE __attribute__((noinline)) +#else +# define PUGI__NO_INLINE +#endif + +// Branch weight controls +#if defined(__GNUC__) +# define PUGI__UNLIKELY(cond) __builtin_expect(cond, 0) +#else +# define PUGI__UNLIKELY(cond) (cond) +#endif + +// Simple static assertion +#define PUGI__STATIC_ASSERT(cond) { static const char condition_failed[(cond) ? 1 : -1] = {0}; (void)condition_failed[0]; } + +// Digital Mars C++ bug workaround for passing char loaded from memory via stack +#ifdef __DMC__ +# define PUGI__DMC_VOLATILE volatile +#else +# define PUGI__DMC_VOLATILE +#endif + +// Borland C++ bug workaround for not defining ::memcpy depending on header include order (can't always use std::memcpy because some compilers don't have it at all) +#if defined(__BORLANDC__) && !defined(__MEM_H_USING_LIST) +using std::memcpy; +using std::memmove; +using std::memset; +#endif + +// Some MinGW versions have headers that erroneously omit LLONG_MIN/LLONG_MAX/ULLONG_MAX definitions in strict ANSI mode +#if defined(PUGIXML_HAS_LONG_LONG) && defined(__MINGW32__) && defined(__STRICT_ANSI__) && !defined(LLONG_MAX) && !defined(LLONG_MIN) && !defined(ULLONG_MAX) +# define LLONG_MAX 9223372036854775807LL +# define LLONG_MIN (-LLONG_MAX-1) +# define ULLONG_MAX (2ULL*LLONG_MAX+1) +#endif + +// In some environments MSVC is a compiler but the CRT lacks certain MSVC-specific features +#if defined(_MSC_VER) && !defined(__S3E__) +# define PUGI__MSVC_CRT_VERSION _MSC_VER +#endif + +#ifdef PUGIXML_HEADER_ONLY +# define PUGI__NS_BEGIN namespace pugi { namespace impl { +# define PUGI__NS_END } } +# define PUGI__FN inline +# define PUGI__FN_NO_INLINE inline +#else +# if defined(_MSC_VER) && _MSC_VER < 1300 // MSVC6 seems to have an amusing bug with anonymous namespaces inside namespaces +# define PUGI__NS_BEGIN namespace pugi { namespace impl { +# define PUGI__NS_END } } +# else +# define PUGI__NS_BEGIN namespace pugi { namespace impl { namespace { +# define PUGI__NS_END } } } +# endif +# define PUGI__FN +# define PUGI__FN_NO_INLINE PUGI__NO_INLINE +#endif + +// uintptr_t +#if (defined(_MSC_VER) && _MSC_VER < 1600) || (defined(__BORLANDC__) && __BORLANDC__ < 0x561) +namespace pugi +{ +# ifndef _UINTPTR_T_DEFINED + typedef size_t uintptr_t; +# endif + + typedef unsigned __int8 uint8_t; + typedef unsigned __int16 uint16_t; + typedef unsigned __int32 uint32_t; +} +#else +# include +#endif + +// Memory allocation +PUGI__NS_BEGIN + PUGI__FN void* default_allocate(size_t size) + { + return malloc(size); + } + + PUGI__FN void default_deallocate(void* ptr) + { + free(ptr); + } + + template + struct xml_memory_management_function_storage + { + static allocation_function allocate; + static deallocation_function deallocate; + }; + + // Global allocation functions are stored in class statics so that in header mode linker deduplicates them + // Without a template<> we'll get multiple definitions of the same static + template allocation_function xml_memory_management_function_storage::allocate = default_allocate; + template deallocation_function xml_memory_management_function_storage::deallocate = default_deallocate; + + typedef xml_memory_management_function_storage xml_memory; +PUGI__NS_END + +// String utilities +PUGI__NS_BEGIN + // Get string length + PUGI__FN size_t strlength(const char_t* s) + { + assert(s); + + #ifdef PUGIXML_WCHAR_MODE + return wcslen(s); + #else + return strlen(s); + #endif + } + + // Compare two strings + PUGI__FN bool strequal(const char_t* src, const char_t* dst) + { + assert(src && dst); + + #ifdef PUGIXML_WCHAR_MODE + return wcscmp(src, dst) == 0; + #else + return strcmp(src, dst) == 0; + #endif + } + + // Compare lhs with [rhs_begin, rhs_end) + PUGI__FN bool strequalrange(const char_t* lhs, const char_t* rhs, size_t count) + { + for (size_t i = 0; i < count; ++i) + if (lhs[i] != rhs[i]) + return false; + + return lhs[count] == 0; + } + + // Get length of wide string, even if CRT lacks wide character support + PUGI__FN size_t strlength_wide(const wchar_t* s) + { + assert(s); + + #ifdef PUGIXML_WCHAR_MODE + return wcslen(s); + #else + const wchar_t* end = s; + while (*end) end++; + return static_cast(end - s); + #endif + } +PUGI__NS_END + +// auto_ptr-like object for exception recovery +PUGI__NS_BEGIN + template struct auto_deleter + { + typedef void (*D)(T*); + + T* data; + D deleter; + + auto_deleter(T* data_, D deleter_): data(data_), deleter(deleter_) + { + } + + ~auto_deleter() + { + if (data) deleter(data); + } + + T* release() + { + T* result = data; + data = 0; + return result; + } + }; +PUGI__NS_END + +#ifdef PUGIXML_COMPACT +PUGI__NS_BEGIN + class compact_hash_table + { + public: + compact_hash_table(): _items(0), _capacity(0), _count(0) + { + } + + void clear() + { + if (_items) + { + xml_memory::deallocate(_items); + _items = 0; + _capacity = 0; + _count = 0; + } + } + + void** find(const void* key) + { + assert(key); + + if (_capacity == 0) return 0; + + size_t hashmod = _capacity - 1; + size_t bucket = hash(key) & hashmod; + + for (size_t probe = 0; probe <= hashmod; ++probe) + { + item_t& probe_item = _items[bucket]; + + if (probe_item.key == key) + return &probe_item.value; + + if (probe_item.key == 0) + return 0; + + // hash collision, quadratic probing + bucket = (bucket + probe + 1) & hashmod; + } + + assert(false && "Hash table is full"); + return 0; + } + + void** insert(const void* key) + { + assert(key); + assert(_capacity != 0 && _count < _capacity - _capacity / 4); + + size_t hashmod = _capacity - 1; + size_t bucket = hash(key) & hashmod; + + for (size_t probe = 0; probe <= hashmod; ++probe) + { + item_t& probe_item = _items[bucket]; + + if (probe_item.key == 0) + { + probe_item.key = key; + _count++; + return &probe_item.value; + } + + if (probe_item.key == key) + return &probe_item.value; + + // hash collision, quadratic probing + bucket = (bucket + probe + 1) & hashmod; + } + + assert(false && "Hash table is full"); + return 0; + } + + bool reserve() + { + if (_count + 16 >= _capacity - _capacity / 4) + return rehash(); + + return true; + } + + private: + struct item_t + { + const void* key; + void* value; + }; + + item_t* _items; + size_t _capacity; + + size_t _count; + + bool rehash(); + + static unsigned int hash(const void* key) + { + unsigned int h = static_cast(reinterpret_cast(key)); + + // MurmurHash3 32-bit finalizer + h ^= h >> 16; + h *= 0x85ebca6bu; + h ^= h >> 13; + h *= 0xc2b2ae35u; + h ^= h >> 16; + + return h; + } + }; + + PUGI__FN_NO_INLINE bool compact_hash_table::rehash() + { + compact_hash_table rt; + rt._capacity = (_capacity == 0) ? 32 : _capacity * 2; + rt._items = static_cast(xml_memory::allocate(sizeof(item_t) * rt._capacity)); + + if (!rt._items) + return false; + + memset(rt._items, 0, sizeof(item_t) * rt._capacity); + + for (size_t i = 0; i < _capacity; ++i) + if (_items[i].key) + *rt.insert(_items[i].key) = _items[i].value; + + if (_items) + xml_memory::deallocate(_items); + + _capacity = rt._capacity; + _items = rt._items; + + assert(_count == rt._count); + + return true; + } + +PUGI__NS_END +#endif + +PUGI__NS_BEGIN +#ifdef PUGIXML_COMPACT + static const uintptr_t xml_memory_block_alignment = 4; +#else + static const uintptr_t xml_memory_block_alignment = sizeof(void*); +#endif + + // extra metadata bits + static const uintptr_t xml_memory_page_contents_shared_mask = 64; + static const uintptr_t xml_memory_page_name_allocated_mask = 32; + static const uintptr_t xml_memory_page_value_allocated_mask = 16; + static const uintptr_t xml_memory_page_type_mask = 15; + + // combined masks for string uniqueness + static const uintptr_t xml_memory_page_name_allocated_or_shared_mask = xml_memory_page_name_allocated_mask | xml_memory_page_contents_shared_mask; + static const uintptr_t xml_memory_page_value_allocated_or_shared_mask = xml_memory_page_value_allocated_mask | xml_memory_page_contents_shared_mask; + +#ifdef PUGIXML_COMPACT + #define PUGI__GETHEADER_IMPL(object, page, flags) // unused + #define PUGI__GETPAGE_IMPL(header) (header).get_page() +#else + #define PUGI__GETHEADER_IMPL(object, page, flags) (((reinterpret_cast(object) - reinterpret_cast(page)) << 8) | (flags)) + // this macro casts pointers through void* to avoid 'cast increases required alignment of target type' warnings + #define PUGI__GETPAGE_IMPL(header) static_cast(const_cast(static_cast(reinterpret_cast(&header) - (header >> 8)))) +#endif + + #define PUGI__GETPAGE(n) PUGI__GETPAGE_IMPL((n)->header) + #define PUGI__NODETYPE(n) static_cast((n)->header & impl::xml_memory_page_type_mask) + + struct xml_allocator; + + struct xml_memory_page + { + static xml_memory_page* construct(void* memory) + { + xml_memory_page* result = static_cast(memory); + + result->allocator = 0; + result->prev = 0; + result->next = 0; + result->busy_size = 0; + result->freed_size = 0; + + #ifdef PUGIXML_COMPACT + result->compact_string_base = 0; + result->compact_shared_parent = 0; + result->compact_page_marker = 0; + #endif + + return result; + } + + xml_allocator* allocator; + + xml_memory_page* prev; + xml_memory_page* next; + + size_t busy_size; + size_t freed_size; + + #ifdef PUGIXML_COMPACT + char_t* compact_string_base; + void* compact_shared_parent; + uint32_t* compact_page_marker; + #endif + }; + + static const size_t xml_memory_page_size = + #ifdef PUGIXML_MEMORY_PAGE_SIZE + (PUGIXML_MEMORY_PAGE_SIZE) + #else + 32768 + #endif + - sizeof(xml_memory_page); + + struct xml_memory_string_header + { + uint16_t page_offset; // offset from page->data + uint16_t full_size; // 0 if string occupies whole page + }; + + struct xml_allocator + { + xml_allocator(xml_memory_page* root): _root(root), _busy_size(root->busy_size) + { + #ifdef PUGIXML_COMPACT + _hash = 0; + #endif + } + + xml_memory_page* allocate_page(size_t data_size) + { + size_t size = sizeof(xml_memory_page) + data_size; + + // allocate block with some alignment, leaving memory for worst-case padding + void* memory = xml_memory::allocate(size); + if (!memory) return 0; + + // prepare page structure + xml_memory_page* page = xml_memory_page::construct(memory); + assert(page); + + page->allocator = _root->allocator; + + return page; + } + + static void deallocate_page(xml_memory_page* page) + { + xml_memory::deallocate(page); + } + + void* allocate_memory_oob(size_t size, xml_memory_page*& out_page); + + void* allocate_memory(size_t size, xml_memory_page*& out_page) + { + if (PUGI__UNLIKELY(_busy_size + size > xml_memory_page_size)) + return allocate_memory_oob(size, out_page); + + void* buf = reinterpret_cast(_root) + sizeof(xml_memory_page) + _busy_size; + + _busy_size += size; + + out_page = _root; + + return buf; + } + + #ifdef PUGIXML_COMPACT + void* allocate_object(size_t size, xml_memory_page*& out_page) + { + void* result = allocate_memory(size + sizeof(uint32_t), out_page); + if (!result) return 0; + + // adjust for marker + ptrdiff_t offset = static_cast(result) - reinterpret_cast(out_page->compact_page_marker); + + if (PUGI__UNLIKELY(static_cast(offset) >= 256 * xml_memory_block_alignment)) + { + // insert new marker + uint32_t* marker = static_cast(result); + + *marker = static_cast(reinterpret_cast(marker) - reinterpret_cast(out_page)); + out_page->compact_page_marker = marker; + + // since we don't reuse the page space until we reallocate it, we can just pretend that we freed the marker block + // this will make sure deallocate_memory correctly tracks the size + out_page->freed_size += sizeof(uint32_t); + + return marker + 1; + } + else + { + // roll back uint32_t part + _busy_size -= sizeof(uint32_t); + + return result; + } + } + #else + void* allocate_object(size_t size, xml_memory_page*& out_page) + { + return allocate_memory(size, out_page); + } + #endif + + void deallocate_memory(void* ptr, size_t size, xml_memory_page* page) + { + if (page == _root) page->busy_size = _busy_size; + + assert(ptr >= reinterpret_cast(page) + sizeof(xml_memory_page) && ptr < reinterpret_cast(page) + sizeof(xml_memory_page) + page->busy_size); + (void)!ptr; + + page->freed_size += size; + assert(page->freed_size <= page->busy_size); + + if (page->freed_size == page->busy_size) + { + if (page->next == 0) + { + assert(_root == page); + + // top page freed, just reset sizes + page->busy_size = 0; + page->freed_size = 0; + + #ifdef PUGIXML_COMPACT + // reset compact state to maximize efficiency + page->compact_string_base = 0; + page->compact_shared_parent = 0; + page->compact_page_marker = 0; + #endif + + _busy_size = 0; + } + else + { + assert(_root != page); + assert(page->prev); + + // remove from the list + page->prev->next = page->next; + page->next->prev = page->prev; + + // deallocate + deallocate_page(page); + } + } + } + + char_t* allocate_string(size_t length) + { + static const size_t max_encoded_offset = (1 << 16) * xml_memory_block_alignment; + + PUGI__STATIC_ASSERT(xml_memory_page_size <= max_encoded_offset); + + // allocate memory for string and header block + size_t size = sizeof(xml_memory_string_header) + length * sizeof(char_t); + + // round size up to block alignment boundary + size_t full_size = (size + (xml_memory_block_alignment - 1)) & ~(xml_memory_block_alignment - 1); + + xml_memory_page* page; + xml_memory_string_header* header = static_cast(allocate_memory(full_size, page)); + + if (!header) return 0; + + // setup header + ptrdiff_t page_offset = reinterpret_cast(header) - reinterpret_cast(page) - sizeof(xml_memory_page); + + assert(page_offset % xml_memory_block_alignment == 0); + assert(page_offset >= 0 && static_cast(page_offset) < max_encoded_offset); + header->page_offset = static_cast(static_cast(page_offset) / xml_memory_block_alignment); + + // full_size == 0 for large strings that occupy the whole page + assert(full_size % xml_memory_block_alignment == 0); + assert(full_size < max_encoded_offset || (page->busy_size == full_size && page_offset == 0)); + header->full_size = static_cast(full_size < max_encoded_offset ? full_size / xml_memory_block_alignment : 0); + + // round-trip through void* to avoid 'cast increases required alignment of target type' warning + // header is guaranteed a pointer-sized alignment, which should be enough for char_t + return static_cast(static_cast(header + 1)); + } + + void deallocate_string(char_t* string) + { + // this function casts pointers through void* to avoid 'cast increases required alignment of target type' warnings + // we're guaranteed the proper (pointer-sized) alignment on the input string if it was allocated via allocate_string + + // get header + xml_memory_string_header* header = static_cast(static_cast(string)) - 1; + assert(header); + + // deallocate + size_t page_offset = sizeof(xml_memory_page) + header->page_offset * xml_memory_block_alignment; + xml_memory_page* page = reinterpret_cast(static_cast(reinterpret_cast(header) - page_offset)); + + // if full_size == 0 then this string occupies the whole page + size_t full_size = header->full_size == 0 ? page->busy_size : header->full_size * xml_memory_block_alignment; + + deallocate_memory(header, full_size, page); + } + + bool reserve() + { + #ifdef PUGIXML_COMPACT + return _hash->reserve(); + #else + return true; + #endif + } + + xml_memory_page* _root; + size_t _busy_size; + + #ifdef PUGIXML_COMPACT + compact_hash_table* _hash; + #endif + }; + + PUGI__FN_NO_INLINE void* xml_allocator::allocate_memory_oob(size_t size, xml_memory_page*& out_page) + { + const size_t large_allocation_threshold = xml_memory_page_size / 4; + + xml_memory_page* page = allocate_page(size <= large_allocation_threshold ? xml_memory_page_size : size); + out_page = page; + + if (!page) return 0; + + if (size <= large_allocation_threshold) + { + _root->busy_size = _busy_size; + + // insert page at the end of linked list + page->prev = _root; + _root->next = page; + _root = page; + + _busy_size = size; + } + else + { + // insert page before the end of linked list, so that it is deleted as soon as possible + // the last page is not deleted even if it's empty (see deallocate_memory) + assert(_root->prev); + + page->prev = _root->prev; + page->next = _root; + + _root->prev->next = page; + _root->prev = page; + + page->busy_size = size; + } + + return reinterpret_cast(page) + sizeof(xml_memory_page); + } +PUGI__NS_END + +#ifdef PUGIXML_COMPACT +PUGI__NS_BEGIN + static const uintptr_t compact_alignment_log2 = 2; + static const uintptr_t compact_alignment = 1 << compact_alignment_log2; + + class compact_header + { + public: + compact_header(xml_memory_page* page, unsigned int flags) + { + PUGI__STATIC_ASSERT(xml_memory_block_alignment == compact_alignment); + + ptrdiff_t offset = (reinterpret_cast(this) - reinterpret_cast(page->compact_page_marker)); + assert(offset % compact_alignment == 0 && static_cast(offset) < 256 * compact_alignment); + + _page = static_cast(offset >> compact_alignment_log2); + _flags = static_cast(flags); + } + + void operator&=(uintptr_t mod) + { + _flags &= static_cast(mod); + } + + void operator|=(uintptr_t mod) + { + _flags |= static_cast(mod); + } + + uintptr_t operator&(uintptr_t mod) const + { + return _flags & mod; + } + + xml_memory_page* get_page() const + { + // round-trip through void* to silence 'cast increases required alignment of target type' warnings + const char* page_marker = reinterpret_cast(this) - (_page << compact_alignment_log2); + const char* page = page_marker - *reinterpret_cast(static_cast(page_marker)); + + return const_cast(reinterpret_cast(static_cast(page))); + } + + private: + unsigned char _page; + unsigned char _flags; + }; + + PUGI__FN xml_memory_page* compact_get_page(const void* object, int header_offset) + { + const compact_header* header = reinterpret_cast(static_cast(object) - header_offset); + + return header->get_page(); + } + + template PUGI__FN_NO_INLINE T* compact_get_value(const void* object) + { + return static_cast(*compact_get_page(object, header_offset)->allocator->_hash->find(object)); + } + + template PUGI__FN_NO_INLINE void compact_set_value(const void* object, T* value) + { + *compact_get_page(object, header_offset)->allocator->_hash->insert(object) = value; + } + + template class compact_pointer + { + public: + compact_pointer(): _data(0) + { + } + + void operator=(const compact_pointer& rhs) + { + *this = rhs + 0; + } + + void operator=(T* value) + { + if (value) + { + // value is guaranteed to be compact-aligned; 'this' is not + // our decoding is based on 'this' aligned to compact alignment downwards (see operator T*) + // so for negative offsets (e.g. -3) we need to adjust the diff by compact_alignment - 1 to + // compensate for arithmetic shift rounding for negative values + ptrdiff_t diff = reinterpret_cast(value) - reinterpret_cast(this); + ptrdiff_t offset = ((diff + int(compact_alignment - 1)) >> compact_alignment_log2) - start; + + if (static_cast(offset) <= 253) + _data = static_cast(offset + 1); + else + { + compact_set_value(this, value); + + _data = 255; + } + } + else + _data = 0; + } + + operator T*() const + { + if (_data) + { + if (_data < 255) + { + uintptr_t base = reinterpret_cast(this) & ~(compact_alignment - 1); + + return reinterpret_cast(base + ((_data - 1 + start) << compact_alignment_log2)); + } + else + return compact_get_value(this); + } + else + return 0; + } + + T* operator->() const + { + return *this; + } + + private: + unsigned char _data; + }; + + template class compact_pointer_parent + { + public: + compact_pointer_parent(): _data(0) + { + } + + void operator=(const compact_pointer_parent& rhs) + { + *this = rhs + 0; + } + + void operator=(T* value) + { + if (value) + { + // value is guaranteed to be compact-aligned; 'this' is not + // our decoding is based on 'this' aligned to compact alignment downwards (see operator T*) + // so for negative offsets (e.g. -3) we need to adjust the diff by compact_alignment - 1 to + // compensate for arithmetic shift behavior for negative values + ptrdiff_t diff = reinterpret_cast(value) - reinterpret_cast(this); + ptrdiff_t offset = ((diff + int(compact_alignment - 1)) >> compact_alignment_log2) + 65533; + + if (static_cast(offset) <= 65533) + { + _data = static_cast(offset + 1); + } + else + { + xml_memory_page* page = compact_get_page(this, header_offset); + + if (PUGI__UNLIKELY(page->compact_shared_parent == 0)) + page->compact_shared_parent = value; + + if (page->compact_shared_parent == value) + { + _data = 65534; + } + else + { + compact_set_value(this, value); + + _data = 65535; + } + } + } + else + { + _data = 0; + } + } + + operator T*() const + { + if (_data) + { + if (_data < 65534) + { + uintptr_t base = reinterpret_cast(this) & ~(compact_alignment - 1); + + return reinterpret_cast(base + ((_data - 1 - 65533) << compact_alignment_log2)); + } + else if (_data == 65534) + return static_cast(compact_get_page(this, header_offset)->compact_shared_parent); + else + return compact_get_value(this); + } + else + return 0; + } + + T* operator->() const + { + return *this; + } + + private: + uint16_t _data; + }; + + template class compact_string + { + public: + compact_string(): _data(0) + { + } + + void operator=(const compact_string& rhs) + { + *this = rhs + 0; + } + + void operator=(char_t* value) + { + if (value) + { + xml_memory_page* page = compact_get_page(this, header_offset); + + if (PUGI__UNLIKELY(page->compact_string_base == 0)) + page->compact_string_base = value; + + ptrdiff_t offset = value - page->compact_string_base; + + if (static_cast(offset) < (65535 << 7)) + { + // round-trip through void* to silence 'cast increases required alignment of target type' warnings + uint16_t* base = reinterpret_cast(static_cast(reinterpret_cast(this) - base_offset)); + + if (*base == 0) + { + *base = static_cast((offset >> 7) + 1); + _data = static_cast((offset & 127) + 1); + } + else + { + ptrdiff_t remainder = offset - ((*base - 1) << 7); + + if (static_cast(remainder) <= 253) + { + _data = static_cast(remainder + 1); + } + else + { + compact_set_value(this, value); + + _data = 255; + } + } + } + else + { + compact_set_value(this, value); + + _data = 255; + } + } + else + { + _data = 0; + } + } + + operator char_t*() const + { + if (_data) + { + if (_data < 255) + { + xml_memory_page* page = compact_get_page(this, header_offset); + + // round-trip through void* to silence 'cast increases required alignment of target type' warnings + const uint16_t* base = reinterpret_cast(static_cast(reinterpret_cast(this) - base_offset)); + assert(*base); + + ptrdiff_t offset = ((*base - 1) << 7) + (_data - 1); + + return page->compact_string_base + offset; + } + else + { + return compact_get_value(this); + } + } + else + return 0; + } + + private: + unsigned char _data; + }; +PUGI__NS_END +#endif + +#ifdef PUGIXML_COMPACT +namespace pugi +{ + struct xml_attribute_struct + { + xml_attribute_struct(impl::xml_memory_page* page): header(page, 0), namevalue_base(0) + { + PUGI__STATIC_ASSERT(sizeof(xml_attribute_struct) == 8); + } + + impl::compact_header header; + + uint16_t namevalue_base; + + impl::compact_string<4, 2> name; + impl::compact_string<5, 3> value; + + impl::compact_pointer prev_attribute_c; + impl::compact_pointer next_attribute; + }; + + struct xml_node_struct + { + xml_node_struct(impl::xml_memory_page* page, xml_node_type type): header(page, type), namevalue_base(0) + { + PUGI__STATIC_ASSERT(sizeof(xml_node_struct) == 12); + } + + impl::compact_header header; + + uint16_t namevalue_base; + + impl::compact_string<4, 2> name; + impl::compact_string<5, 3> value; + + impl::compact_pointer_parent parent; + + impl::compact_pointer first_child; + + impl::compact_pointer prev_sibling_c; + impl::compact_pointer next_sibling; + + impl::compact_pointer first_attribute; + }; +} +#else +namespace pugi +{ + struct xml_attribute_struct + { + xml_attribute_struct(impl::xml_memory_page* page): name(0), value(0), prev_attribute_c(0), next_attribute(0) + { + header = PUGI__GETHEADER_IMPL(this, page, 0); + } + + uintptr_t header; + + char_t* name; + char_t* value; + + xml_attribute_struct* prev_attribute_c; + xml_attribute_struct* next_attribute; + }; + + struct xml_node_struct + { + xml_node_struct(impl::xml_memory_page* page, xml_node_type type): name(0), value(0), parent(0), first_child(0), prev_sibling_c(0), next_sibling(0), first_attribute(0) + { + header = PUGI__GETHEADER_IMPL(this, page, type); + } + + uintptr_t header; + + char_t* name; + char_t* value; + + xml_node_struct* parent; + + xml_node_struct* first_child; + + xml_node_struct* prev_sibling_c; + xml_node_struct* next_sibling; + + xml_attribute_struct* first_attribute; + }; +} +#endif + +PUGI__NS_BEGIN + struct xml_extra_buffer + { + char_t* buffer; + xml_extra_buffer* next; + }; + + struct xml_document_struct: public xml_node_struct, public xml_allocator + { + xml_document_struct(xml_memory_page* page): xml_node_struct(page, node_document), xml_allocator(page), buffer(0), extra_buffers(0) + { + } + + const char_t* buffer; + + xml_extra_buffer* extra_buffers; + + #ifdef PUGIXML_COMPACT + compact_hash_table hash; + #endif + }; + + template inline xml_allocator& get_allocator(const Object* object) + { + assert(object); + + return *PUGI__GETPAGE(object)->allocator; + } + + template inline xml_document_struct& get_document(const Object* object) + { + assert(object); + + return *static_cast(PUGI__GETPAGE(object)->allocator); + } +PUGI__NS_END + +// Low-level DOM operations +PUGI__NS_BEGIN + inline xml_attribute_struct* allocate_attribute(xml_allocator& alloc) + { + xml_memory_page* page; + void* memory = alloc.allocate_object(sizeof(xml_attribute_struct), page); + if (!memory) return 0; + + return new (memory) xml_attribute_struct(page); + } + + inline xml_node_struct* allocate_node(xml_allocator& alloc, xml_node_type type) + { + xml_memory_page* page; + void* memory = alloc.allocate_object(sizeof(xml_node_struct), page); + if (!memory) return 0; + + return new (memory) xml_node_struct(page, type); + } + + inline void destroy_attribute(xml_attribute_struct* a, xml_allocator& alloc) + { + if (a->header & impl::xml_memory_page_name_allocated_mask) + alloc.deallocate_string(a->name); + + if (a->header & impl::xml_memory_page_value_allocated_mask) + alloc.deallocate_string(a->value); + + alloc.deallocate_memory(a, sizeof(xml_attribute_struct), PUGI__GETPAGE(a)); + } + + inline void destroy_node(xml_node_struct* n, xml_allocator& alloc) + { + if (n->header & impl::xml_memory_page_name_allocated_mask) + alloc.deallocate_string(n->name); + + if (n->header & impl::xml_memory_page_value_allocated_mask) + alloc.deallocate_string(n->value); + + for (xml_attribute_struct* attr = n->first_attribute; attr; ) + { + xml_attribute_struct* next = attr->next_attribute; + + destroy_attribute(attr, alloc); + + attr = next; + } + + for (xml_node_struct* child = n->first_child; child; ) + { + xml_node_struct* next = child->next_sibling; + + destroy_node(child, alloc); + + child = next; + } + + alloc.deallocate_memory(n, sizeof(xml_node_struct), PUGI__GETPAGE(n)); + } + + inline void append_node(xml_node_struct* child, xml_node_struct* node) + { + child->parent = node; + + xml_node_struct* head = node->first_child; + + if (head) + { + xml_node_struct* tail = head->prev_sibling_c; + + tail->next_sibling = child; + child->prev_sibling_c = tail; + head->prev_sibling_c = child; + } + else + { + node->first_child = child; + child->prev_sibling_c = child; + } + } + + inline void prepend_node(xml_node_struct* child, xml_node_struct* node) + { + child->parent = node; + + xml_node_struct* head = node->first_child; + + if (head) + { + child->prev_sibling_c = head->prev_sibling_c; + head->prev_sibling_c = child; + } + else + child->prev_sibling_c = child; + + child->next_sibling = head; + node->first_child = child; + } + + inline void insert_node_after(xml_node_struct* child, xml_node_struct* node) + { + xml_node_struct* parent = node->parent; + + child->parent = parent; + + if (node->next_sibling) + node->next_sibling->prev_sibling_c = child; + else + parent->first_child->prev_sibling_c = child; + + child->next_sibling = node->next_sibling; + child->prev_sibling_c = node; + + node->next_sibling = child; + } + + inline void insert_node_before(xml_node_struct* child, xml_node_struct* node) + { + xml_node_struct* parent = node->parent; + + child->parent = parent; + + if (node->prev_sibling_c->next_sibling) + node->prev_sibling_c->next_sibling = child; + else + parent->first_child = child; + + child->prev_sibling_c = node->prev_sibling_c; + child->next_sibling = node; + + node->prev_sibling_c = child; + } + + inline void remove_node(xml_node_struct* node) + { + xml_node_struct* parent = node->parent; + + if (node->next_sibling) + node->next_sibling->prev_sibling_c = node->prev_sibling_c; + else + parent->first_child->prev_sibling_c = node->prev_sibling_c; + + if (node->prev_sibling_c->next_sibling) + node->prev_sibling_c->next_sibling = node->next_sibling; + else + parent->first_child = node->next_sibling; + + node->parent = 0; + node->prev_sibling_c = 0; + node->next_sibling = 0; + } + + inline void append_attribute(xml_attribute_struct* attr, xml_node_struct* node) + { + xml_attribute_struct* head = node->first_attribute; + + if (head) + { + xml_attribute_struct* tail = head->prev_attribute_c; + + tail->next_attribute = attr; + attr->prev_attribute_c = tail; + head->prev_attribute_c = attr; + } + else + { + node->first_attribute = attr; + attr->prev_attribute_c = attr; + } + } + + inline void prepend_attribute(xml_attribute_struct* attr, xml_node_struct* node) + { + xml_attribute_struct* head = node->first_attribute; + + if (head) + { + attr->prev_attribute_c = head->prev_attribute_c; + head->prev_attribute_c = attr; + } + else + attr->prev_attribute_c = attr; + + attr->next_attribute = head; + node->first_attribute = attr; + } + + inline void insert_attribute_after(xml_attribute_struct* attr, xml_attribute_struct* place, xml_node_struct* node) + { + if (place->next_attribute) + place->next_attribute->prev_attribute_c = attr; + else + node->first_attribute->prev_attribute_c = attr; + + attr->next_attribute = place->next_attribute; + attr->prev_attribute_c = place; + place->next_attribute = attr; + } + + inline void insert_attribute_before(xml_attribute_struct* attr, xml_attribute_struct* place, xml_node_struct* node) + { + if (place->prev_attribute_c->next_attribute) + place->prev_attribute_c->next_attribute = attr; + else + node->first_attribute = attr; + + attr->prev_attribute_c = place->prev_attribute_c; + attr->next_attribute = place; + place->prev_attribute_c = attr; + } + + inline void remove_attribute(xml_attribute_struct* attr, xml_node_struct* node) + { + if (attr->next_attribute) + attr->next_attribute->prev_attribute_c = attr->prev_attribute_c; + else + node->first_attribute->prev_attribute_c = attr->prev_attribute_c; + + if (attr->prev_attribute_c->next_attribute) + attr->prev_attribute_c->next_attribute = attr->next_attribute; + else + node->first_attribute = attr->next_attribute; + + attr->prev_attribute_c = 0; + attr->next_attribute = 0; + } + + PUGI__FN_NO_INLINE xml_node_struct* append_new_node(xml_node_struct* node, xml_allocator& alloc, xml_node_type type = node_element) + { + if (!alloc.reserve()) return 0; + + xml_node_struct* child = allocate_node(alloc, type); + if (!child) return 0; + + append_node(child, node); + + return child; + } + + PUGI__FN_NO_INLINE xml_attribute_struct* append_new_attribute(xml_node_struct* node, xml_allocator& alloc) + { + if (!alloc.reserve()) return 0; + + xml_attribute_struct* attr = allocate_attribute(alloc); + if (!attr) return 0; + + append_attribute(attr, node); + + return attr; + } +PUGI__NS_END + +// Helper classes for code generation +PUGI__NS_BEGIN + struct opt_false + { + enum { value = 0 }; + }; + + struct opt_true + { + enum { value = 1 }; + }; +PUGI__NS_END + +// Unicode utilities +PUGI__NS_BEGIN + inline uint16_t endian_swap(uint16_t value) + { + return static_cast(((value & 0xff) << 8) | (value >> 8)); + } + + inline uint32_t endian_swap(uint32_t value) + { + return ((value & 0xff) << 24) | ((value & 0xff00) << 8) | ((value & 0xff0000) >> 8) | (value >> 24); + } + + struct utf8_counter + { + typedef size_t value_type; + + static value_type low(value_type result, uint32_t ch) + { + // U+0000..U+007F + if (ch < 0x80) return result + 1; + // U+0080..U+07FF + else if (ch < 0x800) return result + 2; + // U+0800..U+FFFF + else return result + 3; + } + + static value_type high(value_type result, uint32_t) + { + // U+10000..U+10FFFF + return result + 4; + } + }; + + struct utf8_writer + { + typedef uint8_t* value_type; + + static value_type low(value_type result, uint32_t ch) + { + // U+0000..U+007F + if (ch < 0x80) + { + *result = static_cast(ch); + return result + 1; + } + // U+0080..U+07FF + else if (ch < 0x800) + { + result[0] = static_cast(0xC0 | (ch >> 6)); + result[1] = static_cast(0x80 | (ch & 0x3F)); + return result + 2; + } + // U+0800..U+FFFF + else + { + result[0] = static_cast(0xE0 | (ch >> 12)); + result[1] = static_cast(0x80 | ((ch >> 6) & 0x3F)); + result[2] = static_cast(0x80 | (ch & 0x3F)); + return result + 3; + } + } + + static value_type high(value_type result, uint32_t ch) + { + // U+10000..U+10FFFF + result[0] = static_cast(0xF0 | (ch >> 18)); + result[1] = static_cast(0x80 | ((ch >> 12) & 0x3F)); + result[2] = static_cast(0x80 | ((ch >> 6) & 0x3F)); + result[3] = static_cast(0x80 | (ch & 0x3F)); + return result + 4; + } + + static value_type any(value_type result, uint32_t ch) + { + return (ch < 0x10000) ? low(result, ch) : high(result, ch); + } + }; + + struct utf16_counter + { + typedef size_t value_type; + + static value_type low(value_type result, uint32_t) + { + return result + 1; + } + + static value_type high(value_type result, uint32_t) + { + return result + 2; + } + }; + + struct utf16_writer + { + typedef uint16_t* value_type; + + static value_type low(value_type result, uint32_t ch) + { + *result = static_cast(ch); + + return result + 1; + } + + static value_type high(value_type result, uint32_t ch) + { + uint32_t msh = static_cast(ch - 0x10000) >> 10; + uint32_t lsh = static_cast(ch - 0x10000) & 0x3ff; + + result[0] = static_cast(0xD800 + msh); + result[1] = static_cast(0xDC00 + lsh); + + return result + 2; + } + + static value_type any(value_type result, uint32_t ch) + { + return (ch < 0x10000) ? low(result, ch) : high(result, ch); + } + }; + + struct utf32_counter + { + typedef size_t value_type; + + static value_type low(value_type result, uint32_t) + { + return result + 1; + } + + static value_type high(value_type result, uint32_t) + { + return result + 1; + } + }; + + struct utf32_writer + { + typedef uint32_t* value_type; + + static value_type low(value_type result, uint32_t ch) + { + *result = ch; + + return result + 1; + } + + static value_type high(value_type result, uint32_t ch) + { + *result = ch; + + return result + 1; + } + + static value_type any(value_type result, uint32_t ch) + { + *result = ch; + + return result + 1; + } + }; + + struct latin1_writer + { + typedef uint8_t* value_type; + + static value_type low(value_type result, uint32_t ch) + { + *result = static_cast(ch > 255 ? '?' : ch); + + return result + 1; + } + + static value_type high(value_type result, uint32_t ch) + { + (void)ch; + + *result = '?'; + + return result + 1; + } + }; + + struct utf8_decoder + { + typedef uint8_t type; + + template static inline typename Traits::value_type process(const uint8_t* data, size_t size, typename Traits::value_type result, Traits) + { + const uint8_t utf8_byte_mask = 0x3f; + + while (size) + { + uint8_t lead = *data; + + // 0xxxxxxx -> U+0000..U+007F + if (lead < 0x80) + { + result = Traits::low(result, lead); + data += 1; + size -= 1; + + // process aligned single-byte (ascii) blocks + if ((reinterpret_cast(data) & 3) == 0) + { + // round-trip through void* to silence 'cast increases required alignment of target type' warnings + while (size >= 4 && (*static_cast(static_cast(data)) & 0x80808080) == 0) + { + result = Traits::low(result, data[0]); + result = Traits::low(result, data[1]); + result = Traits::low(result, data[2]); + result = Traits::low(result, data[3]); + data += 4; + size -= 4; + } + } + } + // 110xxxxx -> U+0080..U+07FF + else if (static_cast(lead - 0xC0) < 0x20 && size >= 2 && (data[1] & 0xc0) == 0x80) + { + result = Traits::low(result, ((lead & ~0xC0) << 6) | (data[1] & utf8_byte_mask)); + data += 2; + size -= 2; + } + // 1110xxxx -> U+0800-U+FFFF + else if (static_cast(lead - 0xE0) < 0x10 && size >= 3 && (data[1] & 0xc0) == 0x80 && (data[2] & 0xc0) == 0x80) + { + result = Traits::low(result, ((lead & ~0xE0) << 12) | ((data[1] & utf8_byte_mask) << 6) | (data[2] & utf8_byte_mask)); + data += 3; + size -= 3; + } + // 11110xxx -> U+10000..U+10FFFF + else if (static_cast(lead - 0xF0) < 0x08 && size >= 4 && (data[1] & 0xc0) == 0x80 && (data[2] & 0xc0) == 0x80 && (data[3] & 0xc0) == 0x80) + { + result = Traits::high(result, ((lead & ~0xF0) << 18) | ((data[1] & utf8_byte_mask) << 12) | ((data[2] & utf8_byte_mask) << 6) | (data[3] & utf8_byte_mask)); + data += 4; + size -= 4; + } + // 10xxxxxx or 11111xxx -> invalid + else + { + data += 1; + size -= 1; + } + } + + return result; + } + }; + + template struct utf16_decoder + { + typedef uint16_t type; + + template static inline typename Traits::value_type process(const uint16_t* data, size_t size, typename Traits::value_type result, Traits) + { + while (size) + { + uint16_t lead = opt_swap::value ? endian_swap(*data) : *data; + + // U+0000..U+D7FF + if (lead < 0xD800) + { + result = Traits::low(result, lead); + data += 1; + size -= 1; + } + // U+E000..U+FFFF + else if (static_cast(lead - 0xE000) < 0x2000) + { + result = Traits::low(result, lead); + data += 1; + size -= 1; + } + // surrogate pair lead + else if (static_cast(lead - 0xD800) < 0x400 && size >= 2) + { + uint16_t next = opt_swap::value ? endian_swap(data[1]) : data[1]; + + if (static_cast(next - 0xDC00) < 0x400) + { + result = Traits::high(result, 0x10000 + ((lead & 0x3ff) << 10) + (next & 0x3ff)); + data += 2; + size -= 2; + } + else + { + data += 1; + size -= 1; + } + } + else + { + data += 1; + size -= 1; + } + } + + return result; + } + }; + + template struct utf32_decoder + { + typedef uint32_t type; + + template static inline typename Traits::value_type process(const uint32_t* data, size_t size, typename Traits::value_type result, Traits) + { + while (size) + { + uint32_t lead = opt_swap::value ? endian_swap(*data) : *data; + + // U+0000..U+FFFF + if (lead < 0x10000) + { + result = Traits::low(result, lead); + data += 1; + size -= 1; + } + // U+10000..U+10FFFF + else + { + result = Traits::high(result, lead); + data += 1; + size -= 1; + } + } + + return result; + } + }; + + struct latin1_decoder + { + typedef uint8_t type; + + template static inline typename Traits::value_type process(const uint8_t* data, size_t size, typename Traits::value_type result, Traits) + { + while (size) + { + result = Traits::low(result, *data); + data += 1; + size -= 1; + } + + return result; + } + }; + + template struct wchar_selector; + + template <> struct wchar_selector<2> + { + typedef uint16_t type; + typedef utf16_counter counter; + typedef utf16_writer writer; + typedef utf16_decoder decoder; + }; + + template <> struct wchar_selector<4> + { + typedef uint32_t type; + typedef utf32_counter counter; + typedef utf32_writer writer; + typedef utf32_decoder decoder; + }; + + typedef wchar_selector::counter wchar_counter; + typedef wchar_selector::writer wchar_writer; + + struct wchar_decoder + { + typedef wchar_t type; + + template static inline typename Traits::value_type process(const wchar_t* data, size_t size, typename Traits::value_type result, Traits traits) + { + typedef wchar_selector::decoder decoder; + + return decoder::process(reinterpret_cast(data), size, result, traits); + } + }; + +#ifdef PUGIXML_WCHAR_MODE + PUGI__FN void convert_wchar_endian_swap(wchar_t* result, const wchar_t* data, size_t length) + { + for (size_t i = 0; i < length; ++i) + result[i] = static_cast(endian_swap(static_cast::type>(data[i]))); + } +#endif +PUGI__NS_END + +PUGI__NS_BEGIN + enum chartype_t + { + ct_parse_pcdata = 1, // \0, &, \r, < + ct_parse_attr = 2, // \0, &, \r, ', " + ct_parse_attr_ws = 4, // \0, &, \r, ', ", \n, tab + ct_space = 8, // \r, \n, space, tab + ct_parse_cdata = 16, // \0, ], >, \r + ct_parse_comment = 32, // \0, -, >, \r + ct_symbol = 64, // Any symbol > 127, a-z, A-Z, 0-9, _, :, -, . + ct_start_symbol = 128 // Any symbol > 127, a-z, A-Z, _, : + }; + + static const unsigned char chartype_table[256] = + { + 55, 0, 0, 0, 0, 0, 0, 0, 0, 12, 12, 0, 0, 63, 0, 0, // 0-15 + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 16-31 + 8, 0, 6, 0, 0, 0, 7, 6, 0, 0, 0, 0, 0, 96, 64, 0, // 32-47 + 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 192, 0, 1, 0, 48, 0, // 48-63 + 0, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, // 64-79 + 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 0, 0, 16, 0, 192, // 80-95 + 0, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, // 96-111 + 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 0, 0, 0, 0, 0, // 112-127 + + 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, // 128+ + 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, + 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, + 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, + 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, + 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, + 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, + 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192, 192 + }; + + enum chartypex_t + { + ctx_special_pcdata = 1, // Any symbol >= 0 and < 32 (except \t, \r, \n), &, <, > + ctx_special_attr = 2, // Any symbol >= 0 and < 32 (except \t), &, <, >, " + ctx_start_symbol = 4, // Any symbol > 127, a-z, A-Z, _ + ctx_digit = 8, // 0-9 + ctx_symbol = 16 // Any symbol > 127, a-z, A-Z, 0-9, _, -, . + }; + + static const unsigned char chartypex_table[256] = + { + 3, 3, 3, 3, 3, 3, 3, 3, 3, 0, 2, 3, 3, 2, 3, 3, // 0-15 + 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, // 16-31 + 0, 0, 2, 0, 0, 0, 3, 0, 0, 0, 0, 0, 0, 16, 16, 0, // 32-47 + 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 0, 0, 3, 0, 3, 0, // 48-63 + + 0, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, // 64-79 + 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 0, 0, 0, 0, 20, // 80-95 + 0, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, // 96-111 + 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 0, 0, 0, 0, 0, // 112-127 + + 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, // 128+ + 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, + 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, + 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, + 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, + 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, + 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, + 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20 + }; + +#ifdef PUGIXML_WCHAR_MODE + #define PUGI__IS_CHARTYPE_IMPL(c, ct, table) ((static_cast(c) < 128 ? table[static_cast(c)] : table[128]) & (ct)) +#else + #define PUGI__IS_CHARTYPE_IMPL(c, ct, table) (table[static_cast(c)] & (ct)) +#endif + + #define PUGI__IS_CHARTYPE(c, ct) PUGI__IS_CHARTYPE_IMPL(c, ct, chartype_table) + #define PUGI__IS_CHARTYPEX(c, ct) PUGI__IS_CHARTYPE_IMPL(c, ct, chartypex_table) + + PUGI__FN bool is_little_endian() + { + unsigned int ui = 1; + + return *reinterpret_cast(&ui) == 1; + } + + PUGI__FN xml_encoding get_wchar_encoding() + { + PUGI__STATIC_ASSERT(sizeof(wchar_t) == 2 || sizeof(wchar_t) == 4); + + if (sizeof(wchar_t) == 2) + return is_little_endian() ? encoding_utf16_le : encoding_utf16_be; + else + return is_little_endian() ? encoding_utf32_le : encoding_utf32_be; + } + + PUGI__FN bool parse_declaration_encoding(const uint8_t* data, size_t size, const uint8_t*& out_encoding, size_t& out_length) + { + #define PUGI__SCANCHAR(ch) { if (offset >= size || data[offset] != ch) return false; offset++; } + #define PUGI__SCANCHARTYPE(ct) { while (offset < size && PUGI__IS_CHARTYPE(data[offset], ct)) offset++; } + + // check if we have a non-empty XML declaration + if (size < 6 || !((data[0] == '<') & (data[1] == '?') & (data[2] == 'x') & (data[3] == 'm') & (data[4] == 'l') && PUGI__IS_CHARTYPE(data[5], ct_space))) + return false; + + // scan XML declaration until the encoding field + for (size_t i = 6; i + 1 < size; ++i) + { + // declaration can not contain ? in quoted values + if (data[i] == '?') + return false; + + if (data[i] == 'e' && data[i + 1] == 'n') + { + size_t offset = i; + + // encoding follows the version field which can't contain 'en' so this has to be the encoding if XML is well formed + PUGI__SCANCHAR('e'); PUGI__SCANCHAR('n'); PUGI__SCANCHAR('c'); PUGI__SCANCHAR('o'); + PUGI__SCANCHAR('d'); PUGI__SCANCHAR('i'); PUGI__SCANCHAR('n'); PUGI__SCANCHAR('g'); + + // S? = S? + PUGI__SCANCHARTYPE(ct_space); + PUGI__SCANCHAR('='); + PUGI__SCANCHARTYPE(ct_space); + + // the only two valid delimiters are ' and " + uint8_t delimiter = (offset < size && data[offset] == '"') ? '"' : '\''; + + PUGI__SCANCHAR(delimiter); + + size_t start = offset; + + out_encoding = data + offset; + + PUGI__SCANCHARTYPE(ct_symbol); + + out_length = offset - start; + + PUGI__SCANCHAR(delimiter); + + return true; + } + } + + return false; + + #undef PUGI__SCANCHAR + #undef PUGI__SCANCHARTYPE + } + + PUGI__FN xml_encoding guess_buffer_encoding(const uint8_t* data, size_t size) + { + // skip encoding autodetection if input buffer is too small + if (size < 4) return encoding_utf8; + + uint8_t d0 = data[0], d1 = data[1], d2 = data[2], d3 = data[3]; + + // look for BOM in first few bytes + if (d0 == 0 && d1 == 0 && d2 == 0xfe && d3 == 0xff) return encoding_utf32_be; + if (d0 == 0xff && d1 == 0xfe && d2 == 0 && d3 == 0) return encoding_utf32_le; + if (d0 == 0xfe && d1 == 0xff) return encoding_utf16_be; + if (d0 == 0xff && d1 == 0xfe) return encoding_utf16_le; + if (d0 == 0xef && d1 == 0xbb && d2 == 0xbf) return encoding_utf8; + + // look for <, (contents); + + return guess_buffer_encoding(data, size); + } + + PUGI__FN bool get_mutable_buffer(char_t*& out_buffer, size_t& out_length, const void* contents, size_t size, bool is_mutable) + { + size_t length = size / sizeof(char_t); + + if (is_mutable) + { + out_buffer = static_cast(const_cast(contents)); + out_length = length; + } + else + { + char_t* buffer = static_cast(xml_memory::allocate((length + 1) * sizeof(char_t))); + if (!buffer) return false; + + if (contents) + memcpy(buffer, contents, length * sizeof(char_t)); + else + assert(length == 0); + + buffer[length] = 0; + + out_buffer = buffer; + out_length = length + 1; + } + + return true; + } + +#ifdef PUGIXML_WCHAR_MODE + PUGI__FN bool need_endian_swap_utf(xml_encoding le, xml_encoding re) + { + return (le == encoding_utf16_be && re == encoding_utf16_le) || (le == encoding_utf16_le && re == encoding_utf16_be) || + (le == encoding_utf32_be && re == encoding_utf32_le) || (le == encoding_utf32_le && re == encoding_utf32_be); + } + + PUGI__FN bool convert_buffer_endian_swap(char_t*& out_buffer, size_t& out_length, const void* contents, size_t size, bool is_mutable) + { + const char_t* data = static_cast(contents); + size_t length = size / sizeof(char_t); + + if (is_mutable) + { + char_t* buffer = const_cast(data); + + convert_wchar_endian_swap(buffer, data, length); + + out_buffer = buffer; + out_length = length; + } + else + { + char_t* buffer = static_cast(xml_memory::allocate((length + 1) * sizeof(char_t))); + if (!buffer) return false; + + convert_wchar_endian_swap(buffer, data, length); + buffer[length] = 0; + + out_buffer = buffer; + out_length = length + 1; + } + + return true; + } + + template PUGI__FN bool convert_buffer_generic(char_t*& out_buffer, size_t& out_length, const void* contents, size_t size, D) + { + const typename D::type* data = static_cast(contents); + size_t data_length = size / sizeof(typename D::type); + + // first pass: get length in wchar_t units + size_t length = D::process(data, data_length, 0, wchar_counter()); + + // allocate buffer of suitable length + char_t* buffer = static_cast(xml_memory::allocate((length + 1) * sizeof(char_t))); + if (!buffer) return false; + + // second pass: convert utf16 input to wchar_t + wchar_writer::value_type obegin = reinterpret_cast(buffer); + wchar_writer::value_type oend = D::process(data, data_length, obegin, wchar_writer()); + + assert(oend == obegin + length); + *oend = 0; + + out_buffer = buffer; + out_length = length + 1; + + return true; + } + + PUGI__FN bool convert_buffer(char_t*& out_buffer, size_t& out_length, xml_encoding encoding, const void* contents, size_t size, bool is_mutable) + { + // get native encoding + xml_encoding wchar_encoding = get_wchar_encoding(); + + // fast path: no conversion required + if (encoding == wchar_encoding) + return get_mutable_buffer(out_buffer, out_length, contents, size, is_mutable); + + // only endian-swapping is required + if (need_endian_swap_utf(encoding, wchar_encoding)) + return convert_buffer_endian_swap(out_buffer, out_length, contents, size, is_mutable); + + // source encoding is utf8 + if (encoding == encoding_utf8) + return convert_buffer_generic(out_buffer, out_length, contents, size, utf8_decoder()); + + // source encoding is utf16 + if (encoding == encoding_utf16_be || encoding == encoding_utf16_le) + { + xml_encoding native_encoding = is_little_endian() ? encoding_utf16_le : encoding_utf16_be; + + return (native_encoding == encoding) ? + convert_buffer_generic(out_buffer, out_length, contents, size, utf16_decoder()) : + convert_buffer_generic(out_buffer, out_length, contents, size, utf16_decoder()); + } + + // source encoding is utf32 + if (encoding == encoding_utf32_be || encoding == encoding_utf32_le) + { + xml_encoding native_encoding = is_little_endian() ? encoding_utf32_le : encoding_utf32_be; + + return (native_encoding == encoding) ? + convert_buffer_generic(out_buffer, out_length, contents, size, utf32_decoder()) : + convert_buffer_generic(out_buffer, out_length, contents, size, utf32_decoder()); + } + + // source encoding is latin1 + if (encoding == encoding_latin1) + return convert_buffer_generic(out_buffer, out_length, contents, size, latin1_decoder()); + + assert(false && "Invalid encoding"); + return false; + } +#else + template PUGI__FN bool convert_buffer_generic(char_t*& out_buffer, size_t& out_length, const void* contents, size_t size, D) + { + const typename D::type* data = static_cast(contents); + size_t data_length = size / sizeof(typename D::type); + + // first pass: get length in utf8 units + size_t length = D::process(data, data_length, 0, utf8_counter()); + + // allocate buffer of suitable length + char_t* buffer = static_cast(xml_memory::allocate((length + 1) * sizeof(char_t))); + if (!buffer) return false; + + // second pass: convert utf16 input to utf8 + uint8_t* obegin = reinterpret_cast(buffer); + uint8_t* oend = D::process(data, data_length, obegin, utf8_writer()); + + assert(oend == obegin + length); + *oend = 0; + + out_buffer = buffer; + out_length = length + 1; + + return true; + } + + PUGI__FN size_t get_latin1_7bit_prefix_length(const uint8_t* data, size_t size) + { + for (size_t i = 0; i < size; ++i) + if (data[i] > 127) + return i; + + return size; + } + + PUGI__FN bool convert_buffer_latin1(char_t*& out_buffer, size_t& out_length, const void* contents, size_t size, bool is_mutable) + { + const uint8_t* data = static_cast(contents); + size_t data_length = size; + + // get size of prefix that does not need utf8 conversion + size_t prefix_length = get_latin1_7bit_prefix_length(data, data_length); + assert(prefix_length <= data_length); + + const uint8_t* postfix = data + prefix_length; + size_t postfix_length = data_length - prefix_length; + + // if no conversion is needed, just return the original buffer + if (postfix_length == 0) return get_mutable_buffer(out_buffer, out_length, contents, size, is_mutable); + + // first pass: get length in utf8 units + size_t length = prefix_length + latin1_decoder::process(postfix, postfix_length, 0, utf8_counter()); + + // allocate buffer of suitable length + char_t* buffer = static_cast(xml_memory::allocate((length + 1) * sizeof(char_t))); + if (!buffer) return false; + + // second pass: convert latin1 input to utf8 + memcpy(buffer, data, prefix_length); + + uint8_t* obegin = reinterpret_cast(buffer); + uint8_t* oend = latin1_decoder::process(postfix, postfix_length, obegin + prefix_length, utf8_writer()); + + assert(oend == obegin + length); + *oend = 0; + + out_buffer = buffer; + out_length = length + 1; + + return true; + } + + PUGI__FN bool convert_buffer(char_t*& out_buffer, size_t& out_length, xml_encoding encoding, const void* contents, size_t size, bool is_mutable) + { + // fast path: no conversion required + if (encoding == encoding_utf8) + return get_mutable_buffer(out_buffer, out_length, contents, size, is_mutable); + + // source encoding is utf16 + if (encoding == encoding_utf16_be || encoding == encoding_utf16_le) + { + xml_encoding native_encoding = is_little_endian() ? encoding_utf16_le : encoding_utf16_be; + + return (native_encoding == encoding) ? + convert_buffer_generic(out_buffer, out_length, contents, size, utf16_decoder()) : + convert_buffer_generic(out_buffer, out_length, contents, size, utf16_decoder()); + } + + // source encoding is utf32 + if (encoding == encoding_utf32_be || encoding == encoding_utf32_le) + { + xml_encoding native_encoding = is_little_endian() ? encoding_utf32_le : encoding_utf32_be; + + return (native_encoding == encoding) ? + convert_buffer_generic(out_buffer, out_length, contents, size, utf32_decoder()) : + convert_buffer_generic(out_buffer, out_length, contents, size, utf32_decoder()); + } + + // source encoding is latin1 + if (encoding == encoding_latin1) + return convert_buffer_latin1(out_buffer, out_length, contents, size, is_mutable); + + assert(false && "Invalid encoding"); + return false; + } +#endif + + PUGI__FN size_t as_utf8_begin(const wchar_t* str, size_t length) + { + // get length in utf8 characters + return wchar_decoder::process(str, length, 0, utf8_counter()); + } + + PUGI__FN void as_utf8_end(char* buffer, size_t size, const wchar_t* str, size_t length) + { + // convert to utf8 + uint8_t* begin = reinterpret_cast(buffer); + uint8_t* end = wchar_decoder::process(str, length, begin, utf8_writer()); + + assert(begin + size == end); + (void)!end; + (void)!size; + } + +#ifndef PUGIXML_NO_STL + PUGI__FN std::string as_utf8_impl(const wchar_t* str, size_t length) + { + // first pass: get length in utf8 characters + size_t size = as_utf8_begin(str, length); + + // allocate resulting string + std::string result; + result.resize(size); + + // second pass: convert to utf8 + if (size > 0) as_utf8_end(&result[0], size, str, length); + + return result; + } + + PUGI__FN std::basic_string as_wide_impl(const char* str, size_t size) + { + const uint8_t* data = reinterpret_cast(str); + + // first pass: get length in wchar_t units + size_t length = utf8_decoder::process(data, size, 0, wchar_counter()); + + // allocate resulting string + std::basic_string result; + result.resize(length); + + // second pass: convert to wchar_t + if (length > 0) + { + wchar_writer::value_type begin = reinterpret_cast(&result[0]); + wchar_writer::value_type end = utf8_decoder::process(data, size, begin, wchar_writer()); + + assert(begin + length == end); + (void)!end; + } + + return result; + } +#endif + + template + inline bool strcpy_insitu_allow(size_t length, const Header& header, uintptr_t header_mask, char_t* target) + { + // never reuse shared memory + if (header & xml_memory_page_contents_shared_mask) return false; + + size_t target_length = strlength(target); + + // always reuse document buffer memory if possible + if ((header & header_mask) == 0) return target_length >= length; + + // reuse heap memory if waste is not too great + const size_t reuse_threshold = 32; + + return target_length >= length && (target_length < reuse_threshold || target_length - length < target_length / 2); + } + + template + PUGI__FN bool strcpy_insitu(String& dest, Header& header, uintptr_t header_mask, const char_t* source, size_t source_length) + { + if (source_length == 0) + { + // empty string and null pointer are equivalent, so just deallocate old memory + xml_allocator* alloc = PUGI__GETPAGE_IMPL(header)->allocator; + + if (header & header_mask) alloc->deallocate_string(dest); + + // mark the string as not allocated + dest = 0; + header &= ~header_mask; + + return true; + } + else if (dest && strcpy_insitu_allow(source_length, header, header_mask, dest)) + { + // we can reuse old buffer, so just copy the new data (including zero terminator) + memcpy(dest, source, source_length * sizeof(char_t)); + dest[source_length] = 0; + + return true; + } + else + { + xml_allocator* alloc = PUGI__GETPAGE_IMPL(header)->allocator; + + if (!alloc->reserve()) return false; + + // allocate new buffer + char_t* buf = alloc->allocate_string(source_length + 1); + if (!buf) return false; + + // copy the string (including zero terminator) + memcpy(buf, source, source_length * sizeof(char_t)); + buf[source_length] = 0; + + // deallocate old buffer (*after* the above to protect against overlapping memory and/or allocation failures) + if (header & header_mask) alloc->deallocate_string(dest); + + // the string is now allocated, so set the flag + dest = buf; + header |= header_mask; + + return true; + } + } + + struct gap + { + char_t* end; + size_t size; + + gap(): end(0), size(0) + { + } + + // Push new gap, move s count bytes further (skipping the gap). + // Collapse previous gap. + void push(char_t*& s, size_t count) + { + if (end) // there was a gap already; collapse it + { + // Move [old_gap_end, new_gap_start) to [old_gap_start, ...) + assert(s >= end); + memmove(end - size, end, reinterpret_cast(s) - reinterpret_cast(end)); + } + + s += count; // end of current gap + + // "merge" two gaps + end = s; + size += count; + } + + // Collapse all gaps, return past-the-end pointer + char_t* flush(char_t* s) + { + if (end) + { + // Move [old_gap_end, current_pos) to [old_gap_start, ...) + assert(s >= end); + memmove(end - size, end, reinterpret_cast(s) - reinterpret_cast(end)); + + return s - size; + } + else return s; + } + }; + + PUGI__FN char_t* strconv_escape(char_t* s, gap& g) + { + char_t* stre = s + 1; + + switch (*stre) + { + case '#': // &#... + { + unsigned int ucsc = 0; + + if (stre[1] == 'x') // &#x... (hex code) + { + stre += 2; + + char_t ch = *stre; + + if (ch == ';') return stre; + + for (;;) + { + if (static_cast(ch - '0') <= 9) + ucsc = 16 * ucsc + (ch - '0'); + else if (static_cast((ch | ' ') - 'a') <= 5) + ucsc = 16 * ucsc + ((ch | ' ') - 'a' + 10); + else if (ch == ';') + break; + else // cancel + return stre; + + ch = *++stre; + } + + ++stre; + } + else // &#... (dec code) + { + char_t ch = *++stre; + + if (ch == ';') return stre; + + for (;;) + { + if (static_cast(static_cast(ch) - '0') <= 9) + ucsc = 10 * ucsc + (ch - '0'); + else if (ch == ';') + break; + else // cancel + return stre; + + ch = *++stre; + } + + ++stre; + } + + #ifdef PUGIXML_WCHAR_MODE + s = reinterpret_cast(wchar_writer::any(reinterpret_cast(s), ucsc)); + #else + s = reinterpret_cast(utf8_writer::any(reinterpret_cast(s), ucsc)); + #endif + + g.push(s, stre - s); + return stre; + } + + case 'a': // &a + { + ++stre; + + if (*stre == 'm') // &am + { + if (*++stre == 'p' && *++stre == ';') // & + { + *s++ = '&'; + ++stre; + + g.push(s, stre - s); + return stre; + } + } + else if (*stre == 'p') // &ap + { + if (*++stre == 'o' && *++stre == 's' && *++stre == ';') // ' + { + *s++ = '\''; + ++stre; + + g.push(s, stre - s); + return stre; + } + } + break; + } + + case 'g': // &g + { + if (*++stre == 't' && *++stre == ';') // > + { + *s++ = '>'; + ++stre; + + g.push(s, stre - s); + return stre; + } + break; + } + + case 'l': // &l + { + if (*++stre == 't' && *++stre == ';') // < + { + *s++ = '<'; + ++stre; + + g.push(s, stre - s); + return stre; + } + break; + } + + case 'q': // &q + { + if (*++stre == 'u' && *++stre == 'o' && *++stre == 't' && *++stre == ';') // " + { + *s++ = '"'; + ++stre; + + g.push(s, stre - s); + return stre; + } + break; + } + + default: + break; + } + + return stre; + } + + // Parser utilities + #define PUGI__ENDSWITH(c, e) ((c) == (e) || ((c) == 0 && endch == (e))) + #define PUGI__SKIPWS() { while (PUGI__IS_CHARTYPE(*s, ct_space)) ++s; } + #define PUGI__OPTSET(OPT) ( optmsk & (OPT) ) + #define PUGI__PUSHNODE(TYPE) { cursor = append_new_node(cursor, *alloc, TYPE); if (!cursor) PUGI__THROW_ERROR(status_out_of_memory, s); } + #define PUGI__POPNODE() { cursor = cursor->parent; } + #define PUGI__SCANFOR(X) { while (*s != 0 && !(X)) ++s; } + #define PUGI__SCANWHILE(X) { while (X) ++s; } + #define PUGI__SCANWHILE_UNROLL(X) { for (;;) { char_t ss = s[0]; if (PUGI__UNLIKELY(!(X))) { break; } ss = s[1]; if (PUGI__UNLIKELY(!(X))) { s += 1; break; } ss = s[2]; if (PUGI__UNLIKELY(!(X))) { s += 2; break; } ss = s[3]; if (PUGI__UNLIKELY(!(X))) { s += 3; break; } s += 4; } } + #define PUGI__ENDSEG() { ch = *s; *s = 0; ++s; } + #define PUGI__THROW_ERROR(err, m) return error_offset = m, error_status = err, static_cast(0) + #define PUGI__CHECK_ERROR(err, m) { if (*s == 0) PUGI__THROW_ERROR(err, m); } + + PUGI__FN char_t* strconv_comment(char_t* s, char_t endch) + { + gap g; + + while (true) + { + PUGI__SCANWHILE_UNROLL(!PUGI__IS_CHARTYPE(ss, ct_parse_comment)); + + if (*s == '\r') // Either a single 0x0d or 0x0d 0x0a pair + { + *s++ = '\n'; // replace first one with 0x0a + + if (*s == '\n') g.push(s, 1); + } + else if (s[0] == '-' && s[1] == '-' && PUGI__ENDSWITH(s[2], '>')) // comment ends here + { + *g.flush(s) = 0; + + return s + (s[2] == '>' ? 3 : 2); + } + else if (*s == 0) + { + return 0; + } + else ++s; + } + } + + PUGI__FN char_t* strconv_cdata(char_t* s, char_t endch) + { + gap g; + + while (true) + { + PUGI__SCANWHILE_UNROLL(!PUGI__IS_CHARTYPE(ss, ct_parse_cdata)); + + if (*s == '\r') // Either a single 0x0d or 0x0d 0x0a pair + { + *s++ = '\n'; // replace first one with 0x0a + + if (*s == '\n') g.push(s, 1); + } + else if (s[0] == ']' && s[1] == ']' && PUGI__ENDSWITH(s[2], '>')) // CDATA ends here + { + *g.flush(s) = 0; + + return s + 1; + } + else if (*s == 0) + { + return 0; + } + else ++s; + } + } + + typedef char_t* (*strconv_pcdata_t)(char_t*); + + template struct strconv_pcdata_impl + { + static char_t* parse(char_t* s) + { + gap g; + + char_t* begin = s; + + while (true) + { + PUGI__SCANWHILE_UNROLL(!PUGI__IS_CHARTYPE(ss, ct_parse_pcdata)); + + if (*s == '<') // PCDATA ends here + { + char_t* end = g.flush(s); + + if (opt_trim::value) + while (end > begin && PUGI__IS_CHARTYPE(end[-1], ct_space)) + --end; + + *end = 0; + + return s + 1; + } + else if (opt_eol::value && *s == '\r') // Either a single 0x0d or 0x0d 0x0a pair + { + *s++ = '\n'; // replace first one with 0x0a + + if (*s == '\n') g.push(s, 1); + } + else if (opt_escape::value && *s == '&') + { + s = strconv_escape(s, g); + } + else if (*s == 0) + { + char_t* end = g.flush(s); + + if (opt_trim::value) + while (end > begin && PUGI__IS_CHARTYPE(end[-1], ct_space)) + --end; + + *end = 0; + + return s; + } + else ++s; + } + } + }; + + PUGI__FN strconv_pcdata_t get_strconv_pcdata(unsigned int optmask) + { + PUGI__STATIC_ASSERT(parse_escapes == 0x10 && parse_eol == 0x20 && parse_trim_pcdata == 0x0800); + + switch (((optmask >> 4) & 3) | ((optmask >> 9) & 4)) // get bitmask for flags (eol escapes trim) + { + case 0: return strconv_pcdata_impl::parse; + case 1: return strconv_pcdata_impl::parse; + case 2: return strconv_pcdata_impl::parse; + case 3: return strconv_pcdata_impl::parse; + case 4: return strconv_pcdata_impl::parse; + case 5: return strconv_pcdata_impl::parse; + case 6: return strconv_pcdata_impl::parse; + case 7: return strconv_pcdata_impl::parse; + default: assert(false); return 0; // should not get here + } + } + + typedef char_t* (*strconv_attribute_t)(char_t*, char_t); + + template struct strconv_attribute_impl + { + static char_t* parse_wnorm(char_t* s, char_t end_quote) + { + gap g; + + // trim leading whitespaces + if (PUGI__IS_CHARTYPE(*s, ct_space)) + { + char_t* str = s; + + do ++str; + while (PUGI__IS_CHARTYPE(*str, ct_space)); + + g.push(s, str - s); + } + + while (true) + { + PUGI__SCANWHILE_UNROLL(!PUGI__IS_CHARTYPE(ss, ct_parse_attr_ws | ct_space)); + + if (*s == end_quote) + { + char_t* str = g.flush(s); + + do *str-- = 0; + while (PUGI__IS_CHARTYPE(*str, ct_space)); + + return s + 1; + } + else if (PUGI__IS_CHARTYPE(*s, ct_space)) + { + *s++ = ' '; + + if (PUGI__IS_CHARTYPE(*s, ct_space)) + { + char_t* str = s + 1; + while (PUGI__IS_CHARTYPE(*str, ct_space)) ++str; + + g.push(s, str - s); + } + } + else if (opt_escape::value && *s == '&') + { + s = strconv_escape(s, g); + } + else if (!*s) + { + return 0; + } + else ++s; + } + } + + static char_t* parse_wconv(char_t* s, char_t end_quote) + { + gap g; + + while (true) + { + PUGI__SCANWHILE_UNROLL(!PUGI__IS_CHARTYPE(ss, ct_parse_attr_ws)); + + if (*s == end_quote) + { + *g.flush(s) = 0; + + return s + 1; + } + else if (PUGI__IS_CHARTYPE(*s, ct_space)) + { + if (*s == '\r') + { + *s++ = ' '; + + if (*s == '\n') g.push(s, 1); + } + else *s++ = ' '; + } + else if (opt_escape::value && *s == '&') + { + s = strconv_escape(s, g); + } + else if (!*s) + { + return 0; + } + else ++s; + } + } + + static char_t* parse_eol(char_t* s, char_t end_quote) + { + gap g; + + while (true) + { + PUGI__SCANWHILE_UNROLL(!PUGI__IS_CHARTYPE(ss, ct_parse_attr)); + + if (*s == end_quote) + { + *g.flush(s) = 0; + + return s + 1; + } + else if (*s == '\r') + { + *s++ = '\n'; + + if (*s == '\n') g.push(s, 1); + } + else if (opt_escape::value && *s == '&') + { + s = strconv_escape(s, g); + } + else if (!*s) + { + return 0; + } + else ++s; + } + } + + static char_t* parse_simple(char_t* s, char_t end_quote) + { + gap g; + + while (true) + { + PUGI__SCANWHILE_UNROLL(!PUGI__IS_CHARTYPE(ss, ct_parse_attr)); + + if (*s == end_quote) + { + *g.flush(s) = 0; + + return s + 1; + } + else if (opt_escape::value && *s == '&') + { + s = strconv_escape(s, g); + } + else if (!*s) + { + return 0; + } + else ++s; + } + } + }; + + PUGI__FN strconv_attribute_t get_strconv_attribute(unsigned int optmask) + { + PUGI__STATIC_ASSERT(parse_escapes == 0x10 && parse_eol == 0x20 && parse_wconv_attribute == 0x40 && parse_wnorm_attribute == 0x80); + + switch ((optmask >> 4) & 15) // get bitmask for flags (wconv wnorm eol escapes) + { + case 0: return strconv_attribute_impl::parse_simple; + case 1: return strconv_attribute_impl::parse_simple; + case 2: return strconv_attribute_impl::parse_eol; + case 3: return strconv_attribute_impl::parse_eol; + case 4: return strconv_attribute_impl::parse_wconv; + case 5: return strconv_attribute_impl::parse_wconv; + case 6: return strconv_attribute_impl::parse_wconv; + case 7: return strconv_attribute_impl::parse_wconv; + case 8: return strconv_attribute_impl::parse_wnorm; + case 9: return strconv_attribute_impl::parse_wnorm; + case 10: return strconv_attribute_impl::parse_wnorm; + case 11: return strconv_attribute_impl::parse_wnorm; + case 12: return strconv_attribute_impl::parse_wnorm; + case 13: return strconv_attribute_impl::parse_wnorm; + case 14: return strconv_attribute_impl::parse_wnorm; + case 15: return strconv_attribute_impl::parse_wnorm; + default: assert(false); return 0; // should not get here + } + } + + inline xml_parse_result make_parse_result(xml_parse_status status, ptrdiff_t offset = 0) + { + xml_parse_result result; + result.status = status; + result.offset = offset; + + return result; + } + + struct xml_parser + { + xml_allocator* alloc; + char_t* error_offset; + xml_parse_status error_status; + + xml_parser(xml_allocator* alloc_): alloc(alloc_), error_offset(0), error_status(status_ok) + { + } + + // DOCTYPE consists of nested sections of the following possible types: + // , , "...", '...' + // + // + // First group can not contain nested groups + // Second group can contain nested groups of the same type + // Third group can contain all other groups + char_t* parse_doctype_primitive(char_t* s) + { + if (*s == '"' || *s == '\'') + { + // quoted string + char_t ch = *s++; + PUGI__SCANFOR(*s == ch); + if (!*s) PUGI__THROW_ERROR(status_bad_doctype, s); + + s++; + } + else if (s[0] == '<' && s[1] == '?') + { + // + s += 2; + PUGI__SCANFOR(s[0] == '?' && s[1] == '>'); // no need for ENDSWITH because ?> can't terminate proper doctype + if (!*s) PUGI__THROW_ERROR(status_bad_doctype, s); + + s += 2; + } + else if (s[0] == '<' && s[1] == '!' && s[2] == '-' && s[3] == '-') + { + s += 4; + PUGI__SCANFOR(s[0] == '-' && s[1] == '-' && s[2] == '>'); // no need for ENDSWITH because --> can't terminate proper doctype + if (!*s) PUGI__THROW_ERROR(status_bad_doctype, s); + + s += 3; + } + else PUGI__THROW_ERROR(status_bad_doctype, s); + + return s; + } + + char_t* parse_doctype_ignore(char_t* s) + { + size_t depth = 0; + + assert(s[0] == '<' && s[1] == '!' && s[2] == '['); + s += 3; + + while (*s) + { + if (s[0] == '<' && s[1] == '!' && s[2] == '[') + { + // nested ignore section + s += 3; + depth++; + } + else if (s[0] == ']' && s[1] == ']' && s[2] == '>') + { + // ignore section end + s += 3; + + if (depth == 0) + return s; + + depth--; + } + else s++; + } + + PUGI__THROW_ERROR(status_bad_doctype, s); + } + + char_t* parse_doctype_group(char_t* s, char_t endch) + { + size_t depth = 0; + + assert((s[0] == '<' || s[0] == 0) && s[1] == '!'); + s += 2; + + while (*s) + { + if (s[0] == '<' && s[1] == '!' && s[2] != '-') + { + if (s[2] == '[') + { + // ignore + s = parse_doctype_ignore(s); + if (!s) return s; + } + else + { + // some control group + s += 2; + depth++; + } + } + else if (s[0] == '<' || s[0] == '"' || s[0] == '\'') + { + // unknown tag (forbidden), or some primitive group + s = parse_doctype_primitive(s); + if (!s) return s; + } + else if (*s == '>') + { + if (depth == 0) + return s; + + depth--; + s++; + } + else s++; + } + + if (depth != 0 || endch != '>') PUGI__THROW_ERROR(status_bad_doctype, s); + + return s; + } + + char_t* parse_exclamation(char_t* s, xml_node_struct* cursor, unsigned int optmsk, char_t endch) + { + // parse node contents, starting with exclamation mark + ++s; + + if (*s == '-') // 'value = s; // Save the offset. + } + + if (PUGI__OPTSET(parse_eol) && PUGI__OPTSET(parse_comments)) + { + s = strconv_comment(s, endch); + + if (!s) PUGI__THROW_ERROR(status_bad_comment, cursor->value); + } + else + { + // Scan for terminating '-->'. + PUGI__SCANFOR(s[0] == '-' && s[1] == '-' && PUGI__ENDSWITH(s[2], '>')); + PUGI__CHECK_ERROR(status_bad_comment, s); + + if (PUGI__OPTSET(parse_comments)) + *s = 0; // Zero-terminate this segment at the first terminating '-'. + + s += (s[2] == '>' ? 3 : 2); // Step over the '\0->'. + } + } + else PUGI__THROW_ERROR(status_bad_comment, s); + } + else if (*s == '[') + { + // 'value = s; // Save the offset. + + if (PUGI__OPTSET(parse_eol)) + { + s = strconv_cdata(s, endch); + + if (!s) PUGI__THROW_ERROR(status_bad_cdata, cursor->value); + } + else + { + // Scan for terminating ']]>'. + PUGI__SCANFOR(s[0] == ']' && s[1] == ']' && PUGI__ENDSWITH(s[2], '>')); + PUGI__CHECK_ERROR(status_bad_cdata, s); + + *s++ = 0; // Zero-terminate this segment. + } + } + else // Flagged for discard, but we still have to scan for the terminator. + { + // Scan for terminating ']]>'. + PUGI__SCANFOR(s[0] == ']' && s[1] == ']' && PUGI__ENDSWITH(s[2], '>')); + PUGI__CHECK_ERROR(status_bad_cdata, s); + + ++s; + } + + s += (s[1] == '>' ? 2 : 1); // Step over the last ']>'. + } + else PUGI__THROW_ERROR(status_bad_cdata, s); + } + else if (s[0] == 'D' && s[1] == 'O' && s[2] == 'C' && s[3] == 'T' && s[4] == 'Y' && s[5] == 'P' && PUGI__ENDSWITH(s[6], 'E')) + { + s -= 2; + + if (cursor->parent) PUGI__THROW_ERROR(status_bad_doctype, s); + + char_t* mark = s + 9; + + s = parse_doctype_group(s, endch); + if (!s) return s; + + assert((*s == 0 && endch == '>') || *s == '>'); + if (*s) *s++ = 0; + + if (PUGI__OPTSET(parse_doctype)) + { + while (PUGI__IS_CHARTYPE(*mark, ct_space)) ++mark; + + PUGI__PUSHNODE(node_doctype); + + cursor->value = mark; + } + } + else if (*s == 0 && endch == '-') PUGI__THROW_ERROR(status_bad_comment, s); + else if (*s == 0 && endch == '[') PUGI__THROW_ERROR(status_bad_cdata, s); + else PUGI__THROW_ERROR(status_unrecognized_tag, s); + + return s; + } + + char_t* parse_question(char_t* s, xml_node_struct*& ref_cursor, unsigned int optmsk, char_t endch) + { + // load into registers + xml_node_struct* cursor = ref_cursor; + char_t ch = 0; + + // parse node contents, starting with question mark + ++s; + + // read PI target + char_t* target = s; + + if (!PUGI__IS_CHARTYPE(*s, ct_start_symbol)) PUGI__THROW_ERROR(status_bad_pi, s); + + PUGI__SCANWHILE(PUGI__IS_CHARTYPE(*s, ct_symbol)); + PUGI__CHECK_ERROR(status_bad_pi, s); + + // determine node type; stricmp / strcasecmp is not portable + bool declaration = (target[0] | ' ') == 'x' && (target[1] | ' ') == 'm' && (target[2] | ' ') == 'l' && target + 3 == s; + + if (declaration ? PUGI__OPTSET(parse_declaration) : PUGI__OPTSET(parse_pi)) + { + if (declaration) + { + // disallow non top-level declarations + if (cursor->parent) PUGI__THROW_ERROR(status_bad_pi, s); + + PUGI__PUSHNODE(node_declaration); + } + else + { + PUGI__PUSHNODE(node_pi); + } + + cursor->name = target; + + PUGI__ENDSEG(); + + // parse value/attributes + if (ch == '?') + { + // empty node + if (!PUGI__ENDSWITH(*s, '>')) PUGI__THROW_ERROR(status_bad_pi, s); + s += (*s == '>'); + + PUGI__POPNODE(); + } + else if (PUGI__IS_CHARTYPE(ch, ct_space)) + { + PUGI__SKIPWS(); + + // scan for tag end + char_t* value = s; + + PUGI__SCANFOR(s[0] == '?' && PUGI__ENDSWITH(s[1], '>')); + PUGI__CHECK_ERROR(status_bad_pi, s); + + if (declaration) + { + // replace ending ? with / so that 'element' terminates properly + *s = '/'; + + // we exit from this function with cursor at node_declaration, which is a signal to parse() to go to LOC_ATTRIBUTES + s = value; + } + else + { + // store value and step over > + cursor->value = value; + + PUGI__POPNODE(); + + PUGI__ENDSEG(); + + s += (*s == '>'); + } + } + else PUGI__THROW_ERROR(status_bad_pi, s); + } + else + { + // scan for tag end + PUGI__SCANFOR(s[0] == '?' && PUGI__ENDSWITH(s[1], '>')); + PUGI__CHECK_ERROR(status_bad_pi, s); + + s += (s[1] == '>' ? 2 : 1); + } + + // store from registers + ref_cursor = cursor; + + return s; + } + + char_t* parse_tree(char_t* s, xml_node_struct* root, unsigned int optmsk, char_t endch) + { + strconv_attribute_t strconv_attribute = get_strconv_attribute(optmsk); + strconv_pcdata_t strconv_pcdata = get_strconv_pcdata(optmsk); + + char_t ch = 0; + xml_node_struct* cursor = root; + char_t* mark = s; + + while (*s != 0) + { + if (*s == '<') + { + ++s; + + LOC_TAG: + if (PUGI__IS_CHARTYPE(*s, ct_start_symbol)) // '<#...' + { + PUGI__PUSHNODE(node_element); // Append a new node to the tree. + + cursor->name = s; + + PUGI__SCANWHILE_UNROLL(PUGI__IS_CHARTYPE(ss, ct_symbol)); // Scan for a terminator. + PUGI__ENDSEG(); // Save char in 'ch', terminate & step over. + + if (ch == '>') + { + // end of tag + } + else if (PUGI__IS_CHARTYPE(ch, ct_space)) + { + LOC_ATTRIBUTES: + while (true) + { + PUGI__SKIPWS(); // Eat any whitespace. + + if (PUGI__IS_CHARTYPE(*s, ct_start_symbol)) // <... #... + { + xml_attribute_struct* a = append_new_attribute(cursor, *alloc); // Make space for this attribute. + if (!a) PUGI__THROW_ERROR(status_out_of_memory, s); + + a->name = s; // Save the offset. + + PUGI__SCANWHILE_UNROLL(PUGI__IS_CHARTYPE(ss, ct_symbol)); // Scan for a terminator. + PUGI__ENDSEG(); // Save char in 'ch', terminate & step over. + + if (PUGI__IS_CHARTYPE(ch, ct_space)) + { + PUGI__SKIPWS(); // Eat any whitespace. + + ch = *s; + ++s; + } + + if (ch == '=') // '<... #=...' + { + PUGI__SKIPWS(); // Eat any whitespace. + + if (*s == '"' || *s == '\'') // '<... #="...' + { + ch = *s; // Save quote char to avoid breaking on "''" -or- '""'. + ++s; // Step over the quote. + a->value = s; // Save the offset. + + s = strconv_attribute(s, ch); + + if (!s) PUGI__THROW_ERROR(status_bad_attribute, a->value); + + // After this line the loop continues from the start; + // Whitespaces, / and > are ok, symbols and EOF are wrong, + // everything else will be detected + if (PUGI__IS_CHARTYPE(*s, ct_start_symbol)) PUGI__THROW_ERROR(status_bad_attribute, s); + } + else PUGI__THROW_ERROR(status_bad_attribute, s); + } + else PUGI__THROW_ERROR(status_bad_attribute, s); + } + else if (*s == '/') + { + ++s; + + if (*s == '>') + { + PUGI__POPNODE(); + s++; + break; + } + else if (*s == 0 && endch == '>') + { + PUGI__POPNODE(); + break; + } + else PUGI__THROW_ERROR(status_bad_start_element, s); + } + else if (*s == '>') + { + ++s; + + break; + } + else if (*s == 0 && endch == '>') + { + break; + } + else PUGI__THROW_ERROR(status_bad_start_element, s); + } + + // !!! + } + else if (ch == '/') // '<#.../' + { + if (!PUGI__ENDSWITH(*s, '>')) PUGI__THROW_ERROR(status_bad_start_element, s); + + PUGI__POPNODE(); // Pop. + + s += (*s == '>'); + } + else if (ch == 0) + { + // we stepped over null terminator, backtrack & handle closing tag + --s; + + if (endch != '>') PUGI__THROW_ERROR(status_bad_start_element, s); + } + else PUGI__THROW_ERROR(status_bad_start_element, s); + } + else if (*s == '/') + { + ++s; + + mark = s; + + char_t* name = cursor->name; + if (!name) PUGI__THROW_ERROR(status_end_element_mismatch, mark); + + while (PUGI__IS_CHARTYPE(*s, ct_symbol)) + { + if (*s++ != *name++) PUGI__THROW_ERROR(status_end_element_mismatch, mark); + } + + if (*name) + { + if (*s == 0 && name[0] == endch && name[1] == 0) PUGI__THROW_ERROR(status_bad_end_element, s); + else PUGI__THROW_ERROR(status_end_element_mismatch, mark); + } + + PUGI__POPNODE(); // Pop. + + PUGI__SKIPWS(); + + if (*s == 0) + { + if (endch != '>') PUGI__THROW_ERROR(status_bad_end_element, s); + } + else + { + if (*s != '>') PUGI__THROW_ERROR(status_bad_end_element, s); + ++s; + } + } + else if (*s == '?') // 'first_child) continue; + } + } + + if (!PUGI__OPTSET(parse_trim_pcdata)) + s = mark; + + if (cursor->parent || PUGI__OPTSET(parse_fragment)) + { + if (PUGI__OPTSET(parse_embed_pcdata) && cursor->parent && !cursor->first_child && !cursor->value) + { + cursor->value = s; // Save the offset. + } + else + { + PUGI__PUSHNODE(node_pcdata); // Append a new node on the tree. + + cursor->value = s; // Save the offset. + + PUGI__POPNODE(); // Pop since this is a standalone. + } + + s = strconv_pcdata(s); + + if (!*s) break; + } + else + { + PUGI__SCANFOR(*s == '<'); // '...<' + if (!*s) break; + + ++s; + } + + // We're after '<' + goto LOC_TAG; + } + } + + // check that last tag is closed + if (cursor != root) PUGI__THROW_ERROR(status_end_element_mismatch, s); + + return s; + } + + #ifdef PUGIXML_WCHAR_MODE + static char_t* parse_skip_bom(char_t* s) + { + unsigned int bom = 0xfeff; + return (s[0] == static_cast(bom)) ? s + 1 : s; + } + #else + static char_t* parse_skip_bom(char_t* s) + { + return (s[0] == '\xef' && s[1] == '\xbb' && s[2] == '\xbf') ? s + 3 : s; + } + #endif + + static bool has_element_node_siblings(xml_node_struct* node) + { + while (node) + { + if (PUGI__NODETYPE(node) == node_element) return true; + + node = node->next_sibling; + } + + return false; + } + + static xml_parse_result parse(char_t* buffer, size_t length, xml_document_struct* xmldoc, xml_node_struct* root, unsigned int optmsk) + { + // early-out for empty documents + if (length == 0) + return make_parse_result(PUGI__OPTSET(parse_fragment) ? status_ok : status_no_document_element); + + // get last child of the root before parsing + xml_node_struct* last_root_child = root->first_child ? root->first_child->prev_sibling_c + 0 : 0; + + // create parser on stack + xml_parser parser(static_cast(xmldoc)); + + // save last character and make buffer zero-terminated (speeds up parsing) + char_t endch = buffer[length - 1]; + buffer[length - 1] = 0; + + // skip BOM to make sure it does not end up as part of parse output + char_t* buffer_data = parse_skip_bom(buffer); + + // perform actual parsing + parser.parse_tree(buffer_data, root, optmsk, endch); + + xml_parse_result result = make_parse_result(parser.error_status, parser.error_offset ? parser.error_offset - buffer : 0); + assert(result.offset >= 0 && static_cast(result.offset) <= length); + + if (result) + { + // since we removed last character, we have to handle the only possible false positive (stray <) + if (endch == '<') + return make_parse_result(status_unrecognized_tag, length - 1); + + // check if there are any element nodes parsed + xml_node_struct* first_root_child_parsed = last_root_child ? last_root_child->next_sibling + 0 : root->first_child+ 0; + + if (!PUGI__OPTSET(parse_fragment) && !has_element_node_siblings(first_root_child_parsed)) + return make_parse_result(status_no_document_element, length - 1); + } + else + { + // roll back offset if it occurs on a null terminator in the source buffer + if (result.offset > 0 && static_cast(result.offset) == length - 1 && endch == 0) + result.offset--; + } + + return result; + } + }; + + // Output facilities + PUGI__FN xml_encoding get_write_native_encoding() + { + #ifdef PUGIXML_WCHAR_MODE + return get_wchar_encoding(); + #else + return encoding_utf8; + #endif + } + + PUGI__FN xml_encoding get_write_encoding(xml_encoding encoding) + { + // replace wchar encoding with utf implementation + if (encoding == encoding_wchar) return get_wchar_encoding(); + + // replace utf16 encoding with utf16 with specific endianness + if (encoding == encoding_utf16) return is_little_endian() ? encoding_utf16_le : encoding_utf16_be; + + // replace utf32 encoding with utf32 with specific endianness + if (encoding == encoding_utf32) return is_little_endian() ? encoding_utf32_le : encoding_utf32_be; + + // only do autodetection if no explicit encoding is requested + if (encoding != encoding_auto) return encoding; + + // assume utf8 encoding + return encoding_utf8; + } + + template PUGI__FN size_t convert_buffer_output_generic(typename T::value_type dest, const char_t* data, size_t length, D, T) + { + PUGI__STATIC_ASSERT(sizeof(char_t) == sizeof(typename D::type)); + + typename T::value_type end = D::process(reinterpret_cast(data), length, dest, T()); + + return static_cast(end - dest) * sizeof(*dest); + } + + template PUGI__FN size_t convert_buffer_output_generic(typename T::value_type dest, const char_t* data, size_t length, D, T, bool opt_swap) + { + PUGI__STATIC_ASSERT(sizeof(char_t) == sizeof(typename D::type)); + + typename T::value_type end = D::process(reinterpret_cast(data), length, dest, T()); + + if (opt_swap) + { + for (typename T::value_type i = dest; i != end; ++i) + *i = endian_swap(*i); + } + + return static_cast(end - dest) * sizeof(*dest); + } + +#ifdef PUGIXML_WCHAR_MODE + PUGI__FN size_t get_valid_length(const char_t* data, size_t length) + { + if (length < 1) return 0; + + // discard last character if it's the lead of a surrogate pair + return (sizeof(wchar_t) == 2 && static_cast(static_cast(data[length - 1]) - 0xD800) < 0x400) ? length - 1 : length; + } + + PUGI__FN size_t convert_buffer_output(char_t* r_char, uint8_t* r_u8, uint16_t* r_u16, uint32_t* r_u32, const char_t* data, size_t length, xml_encoding encoding) + { + // only endian-swapping is required + if (need_endian_swap_utf(encoding, get_wchar_encoding())) + { + convert_wchar_endian_swap(r_char, data, length); + + return length * sizeof(char_t); + } + + // convert to utf8 + if (encoding == encoding_utf8) + return convert_buffer_output_generic(r_u8, data, length, wchar_decoder(), utf8_writer()); + + // convert to utf16 + if (encoding == encoding_utf16_be || encoding == encoding_utf16_le) + { + xml_encoding native_encoding = is_little_endian() ? encoding_utf16_le : encoding_utf16_be; + + return convert_buffer_output_generic(r_u16, data, length, wchar_decoder(), utf16_writer(), native_encoding != encoding); + } + + // convert to utf32 + if (encoding == encoding_utf32_be || encoding == encoding_utf32_le) + { + xml_encoding native_encoding = is_little_endian() ? encoding_utf32_le : encoding_utf32_be; + + return convert_buffer_output_generic(r_u32, data, length, wchar_decoder(), utf32_writer(), native_encoding != encoding); + } + + // convert to latin1 + if (encoding == encoding_latin1) + return convert_buffer_output_generic(r_u8, data, length, wchar_decoder(), latin1_writer()); + + assert(false && "Invalid encoding"); + return 0; + } +#else + PUGI__FN size_t get_valid_length(const char_t* data, size_t length) + { + if (length < 5) return 0; + + for (size_t i = 1; i <= 4; ++i) + { + uint8_t ch = static_cast(data[length - i]); + + // either a standalone character or a leading one + if ((ch & 0xc0) != 0x80) return length - i; + } + + // there are four non-leading characters at the end, sequence tail is broken so might as well process the whole chunk + return length; + } + + PUGI__FN size_t convert_buffer_output(char_t* /* r_char */, uint8_t* r_u8, uint16_t* r_u16, uint32_t* r_u32, const char_t* data, size_t length, xml_encoding encoding) + { + if (encoding == encoding_utf16_be || encoding == encoding_utf16_le) + { + xml_encoding native_encoding = is_little_endian() ? encoding_utf16_le : encoding_utf16_be; + + return convert_buffer_output_generic(r_u16, data, length, utf8_decoder(), utf16_writer(), native_encoding != encoding); + } + + if (encoding == encoding_utf32_be || encoding == encoding_utf32_le) + { + xml_encoding native_encoding = is_little_endian() ? encoding_utf32_le : encoding_utf32_be; + + return convert_buffer_output_generic(r_u32, data, length, utf8_decoder(), utf32_writer(), native_encoding != encoding); + } + + if (encoding == encoding_latin1) + return convert_buffer_output_generic(r_u8, data, length, utf8_decoder(), latin1_writer()); + + assert(false && "Invalid encoding"); + return 0; + } +#endif + + class xml_buffered_writer + { + xml_buffered_writer(const xml_buffered_writer&); + xml_buffered_writer& operator=(const xml_buffered_writer&); + + public: + xml_buffered_writer(xml_writer& writer_, xml_encoding user_encoding): writer(writer_), bufsize(0), encoding(get_write_encoding(user_encoding)) + { + PUGI__STATIC_ASSERT(bufcapacity >= 8); + } + + size_t flush() + { + flush(buffer, bufsize); + bufsize = 0; + return 0; + } + + void flush(const char_t* data, size_t size) + { + if (size == 0) return; + + // fast path, just write data + if (encoding == get_write_native_encoding()) + writer.write(data, size * sizeof(char_t)); + else + { + // convert chunk + size_t result = convert_buffer_output(scratch.data_char, scratch.data_u8, scratch.data_u16, scratch.data_u32, data, size, encoding); + assert(result <= sizeof(scratch)); + + // write data + writer.write(scratch.data_u8, result); + } + } + + void write_direct(const char_t* data, size_t length) + { + // flush the remaining buffer contents + flush(); + + // handle large chunks + if (length > bufcapacity) + { + if (encoding == get_write_native_encoding()) + { + // fast path, can just write data chunk + writer.write(data, length * sizeof(char_t)); + return; + } + + // need to convert in suitable chunks + while (length > bufcapacity) + { + // get chunk size by selecting such number of characters that are guaranteed to fit into scratch buffer + // and form a complete codepoint sequence (i.e. discard start of last codepoint if necessary) + size_t chunk_size = get_valid_length(data, bufcapacity); + assert(chunk_size); + + // convert chunk and write + flush(data, chunk_size); + + // iterate + data += chunk_size; + length -= chunk_size; + } + + // small tail is copied below + bufsize = 0; + } + + memcpy(buffer + bufsize, data, length * sizeof(char_t)); + bufsize += length; + } + + void write_buffer(const char_t* data, size_t length) + { + size_t offset = bufsize; + + if (offset + length <= bufcapacity) + { + memcpy(buffer + offset, data, length * sizeof(char_t)); + bufsize = offset + length; + } + else + { + write_direct(data, length); + } + } + + void write_string(const char_t* data) + { + // write the part of the string that fits in the buffer + size_t offset = bufsize; + + while (*data && offset < bufcapacity) + buffer[offset++] = *data++; + + // write the rest + if (offset < bufcapacity) + { + bufsize = offset; + } + else + { + // backtrack a bit if we have split the codepoint + size_t length = offset - bufsize; + size_t extra = length - get_valid_length(data - length, length); + + bufsize = offset - extra; + + write_direct(data - extra, strlength(data) + extra); + } + } + + void write(char_t d0) + { + size_t offset = bufsize; + if (offset > bufcapacity - 1) offset = flush(); + + buffer[offset + 0] = d0; + bufsize = offset + 1; + } + + void write(char_t d0, char_t d1) + { + size_t offset = bufsize; + if (offset > bufcapacity - 2) offset = flush(); + + buffer[offset + 0] = d0; + buffer[offset + 1] = d1; + bufsize = offset + 2; + } + + void write(char_t d0, char_t d1, char_t d2) + { + size_t offset = bufsize; + if (offset > bufcapacity - 3) offset = flush(); + + buffer[offset + 0] = d0; + buffer[offset + 1] = d1; + buffer[offset + 2] = d2; + bufsize = offset + 3; + } + + void write(char_t d0, char_t d1, char_t d2, char_t d3) + { + size_t offset = bufsize; + if (offset > bufcapacity - 4) offset = flush(); + + buffer[offset + 0] = d0; + buffer[offset + 1] = d1; + buffer[offset + 2] = d2; + buffer[offset + 3] = d3; + bufsize = offset + 4; + } + + void write(char_t d0, char_t d1, char_t d2, char_t d3, char_t d4) + { + size_t offset = bufsize; + if (offset > bufcapacity - 5) offset = flush(); + + buffer[offset + 0] = d0; + buffer[offset + 1] = d1; + buffer[offset + 2] = d2; + buffer[offset + 3] = d3; + buffer[offset + 4] = d4; + bufsize = offset + 5; + } + + void write(char_t d0, char_t d1, char_t d2, char_t d3, char_t d4, char_t d5) + { + size_t offset = bufsize; + if (offset > bufcapacity - 6) offset = flush(); + + buffer[offset + 0] = d0; + buffer[offset + 1] = d1; + buffer[offset + 2] = d2; + buffer[offset + 3] = d3; + buffer[offset + 4] = d4; + buffer[offset + 5] = d5; + bufsize = offset + 6; + } + + // utf8 maximum expansion: x4 (-> utf32) + // utf16 maximum expansion: x2 (-> utf32) + // utf32 maximum expansion: x1 + enum + { + bufcapacitybytes = + #ifdef PUGIXML_MEMORY_OUTPUT_STACK + PUGIXML_MEMORY_OUTPUT_STACK + #else + 10240 + #endif + , + bufcapacity = bufcapacitybytes / (sizeof(char_t) + 4) + }; + + char_t buffer[bufcapacity]; + + union + { + uint8_t data_u8[4 * bufcapacity]; + uint16_t data_u16[2 * bufcapacity]; + uint32_t data_u32[bufcapacity]; + char_t data_char[bufcapacity]; + } scratch; + + xml_writer& writer; + size_t bufsize; + xml_encoding encoding; + }; + + PUGI__FN void text_output_escaped(xml_buffered_writer& writer, const char_t* s, chartypex_t type) + { + while (*s) + { + const char_t* prev = s; + + // While *s is a usual symbol + PUGI__SCANWHILE_UNROLL(!PUGI__IS_CHARTYPEX(ss, type)); + + writer.write_buffer(prev, static_cast(s - prev)); + + switch (*s) + { + case 0: break; + case '&': + writer.write('&', 'a', 'm', 'p', ';'); + ++s; + break; + case '<': + writer.write('&', 'l', 't', ';'); + ++s; + break; + case '>': + writer.write('&', 'g', 't', ';'); + ++s; + break; + case '"': + writer.write('&', 'q', 'u', 'o', 't', ';'); + ++s; + break; + default: // s is not a usual symbol + { + unsigned int ch = static_cast(*s++); + assert(ch < 32); + + writer.write('&', '#', static_cast((ch / 10) + '0'), static_cast((ch % 10) + '0'), ';'); + } + } + } + } + + PUGI__FN void text_output(xml_buffered_writer& writer, const char_t* s, chartypex_t type, unsigned int flags) + { + if (flags & format_no_escapes) + writer.write_string(s); + else + text_output_escaped(writer, s, type); + } + + PUGI__FN void text_output_cdata(xml_buffered_writer& writer, const char_t* s) + { + do + { + writer.write('<', '!', '[', 'C', 'D'); + writer.write('A', 'T', 'A', '['); + + const char_t* prev = s; + + // look for ]]> sequence - we can't output it as is since it terminates CDATA + while (*s && !(s[0] == ']' && s[1] == ']' && s[2] == '>')) ++s; + + // skip ]] if we stopped at ]]>, > will go to the next CDATA section + if (*s) s += 2; + + writer.write_buffer(prev, static_cast(s - prev)); + + writer.write(']', ']', '>'); + } + while (*s); + } + + PUGI__FN void text_output_indent(xml_buffered_writer& writer, const char_t* indent, size_t indent_length, unsigned int depth) + { + switch (indent_length) + { + case 1: + { + for (unsigned int i = 0; i < depth; ++i) + writer.write(indent[0]); + break; + } + + case 2: + { + for (unsigned int i = 0; i < depth; ++i) + writer.write(indent[0], indent[1]); + break; + } + + case 3: + { + for (unsigned int i = 0; i < depth; ++i) + writer.write(indent[0], indent[1], indent[2]); + break; + } + + case 4: + { + for (unsigned int i = 0; i < depth; ++i) + writer.write(indent[0], indent[1], indent[2], indent[3]); + break; + } + + default: + { + for (unsigned int i = 0; i < depth; ++i) + writer.write_buffer(indent, indent_length); + } + } + } + + PUGI__FN void node_output_comment(xml_buffered_writer& writer, const char_t* s) + { + writer.write('<', '!', '-', '-'); + + while (*s) + { + const char_t* prev = s; + + // look for -\0 or -- sequence - we can't output it since -- is illegal in comment body + while (*s && !(s[0] == '-' && (s[1] == '-' || s[1] == 0))) ++s; + + writer.write_buffer(prev, static_cast(s - prev)); + + if (*s) + { + assert(*s == '-'); + + writer.write('-', ' '); + ++s; + } + } + + writer.write('-', '-', '>'); + } + + PUGI__FN void node_output_pi_value(xml_buffered_writer& writer, const char_t* s) + { + while (*s) + { + const char_t* prev = s; + + // look for ?> sequence - we can't output it since ?> terminates PI + while (*s && !(s[0] == '?' && s[1] == '>')) ++s; + + writer.write_buffer(prev, static_cast(s - prev)); + + if (*s) + { + assert(s[0] == '?' && s[1] == '>'); + + writer.write('?', ' ', '>'); + s += 2; + } + } + } + + PUGI__FN void node_output_attributes(xml_buffered_writer& writer, xml_node_struct* node, const char_t* indent, size_t indent_length, unsigned int flags, unsigned int depth) + { + const char_t* default_name = PUGIXML_TEXT(":anonymous"); + + for (xml_attribute_struct* a = node->first_attribute; a; a = a->next_attribute) + { + if ((flags & (format_indent_attributes | format_raw)) == format_indent_attributes) + { + writer.write('\n'); + + text_output_indent(writer, indent, indent_length, depth + 1); + } + else + { + writer.write(' '); + } + + writer.write_string(a->name ? a->name + 0 : default_name); + writer.write('=', '"'); + + if (a->value) + text_output(writer, a->value, ctx_special_attr, flags); + + writer.write('"'); + } + } + + PUGI__FN bool node_output_start(xml_buffered_writer& writer, xml_node_struct* node, const char_t* indent, size_t indent_length, unsigned int flags, unsigned int depth) + { + const char_t* default_name = PUGIXML_TEXT(":anonymous"); + const char_t* name = node->name ? node->name + 0 : default_name; + + writer.write('<'); + writer.write_string(name); + + if (node->first_attribute) + node_output_attributes(writer, node, indent, indent_length, flags, depth); + + // element nodes can have value if parse_embed_pcdata was used + if (!node->value) + { + if (!node->first_child) + { + if (flags & format_no_empty_element_tags) + { + writer.write('>', '<', '/'); + writer.write_string(name); + writer.write('>'); + + return false; + } + else + { + if ((flags & format_raw) == 0) + writer.write(' '); + + writer.write('/', '>'); + + return false; + } + } + else + { + writer.write('>'); + + return true; + } + } + else + { + writer.write('>'); + + text_output(writer, node->value, ctx_special_pcdata, flags); + + if (!node->first_child) + { + writer.write('<', '/'); + writer.write_string(name); + writer.write('>'); + + return false; + } + else + { + return true; + } + } + } + + PUGI__FN void node_output_end(xml_buffered_writer& writer, xml_node_struct* node) + { + const char_t* default_name = PUGIXML_TEXT(":anonymous"); + const char_t* name = node->name ? node->name + 0 : default_name; + + writer.write('<', '/'); + writer.write_string(name); + writer.write('>'); + } + + PUGI__FN void node_output_simple(xml_buffered_writer& writer, xml_node_struct* node, unsigned int flags) + { + const char_t* default_name = PUGIXML_TEXT(":anonymous"); + + switch (PUGI__NODETYPE(node)) + { + case node_pcdata: + text_output(writer, node->value ? node->value + 0 : PUGIXML_TEXT(""), ctx_special_pcdata, flags); + break; + + case node_cdata: + text_output_cdata(writer, node->value ? node->value + 0 : PUGIXML_TEXT("")); + break; + + case node_comment: + node_output_comment(writer, node->value ? node->value + 0 : PUGIXML_TEXT("")); + break; + + case node_pi: + writer.write('<', '?'); + writer.write_string(node->name ? node->name + 0 : default_name); + + if (node->value) + { + writer.write(' '); + node_output_pi_value(writer, node->value); + } + + writer.write('?', '>'); + break; + + case node_declaration: + writer.write('<', '?'); + writer.write_string(node->name ? node->name + 0 : default_name); + node_output_attributes(writer, node, PUGIXML_TEXT(""), 0, flags | format_raw, 0); + writer.write('?', '>'); + break; + + case node_doctype: + writer.write('<', '!', 'D', 'O', 'C'); + writer.write('T', 'Y', 'P', 'E'); + + if (node->value) + { + writer.write(' '); + writer.write_string(node->value); + } + + writer.write('>'); + break; + + default: + assert(false && "Invalid node type"); + } + } + + enum indent_flags_t + { + indent_newline = 1, + indent_indent = 2 + }; + + PUGI__FN void node_output(xml_buffered_writer& writer, xml_node_struct* root, const char_t* indent, unsigned int flags, unsigned int depth) + { + size_t indent_length = ((flags & (format_indent | format_indent_attributes)) && (flags & format_raw) == 0) ? strlength(indent) : 0; + unsigned int indent_flags = indent_indent; + + xml_node_struct* node = root; + + do + { + assert(node); + + // begin writing current node + if (PUGI__NODETYPE(node) == node_pcdata || PUGI__NODETYPE(node) == node_cdata) + { + node_output_simple(writer, node, flags); + + indent_flags = 0; + } + else + { + if ((indent_flags & indent_newline) && (flags & format_raw) == 0) + writer.write('\n'); + + if ((indent_flags & indent_indent) && indent_length) + text_output_indent(writer, indent, indent_length, depth); + + if (PUGI__NODETYPE(node) == node_element) + { + indent_flags = indent_newline | indent_indent; + + if (node_output_start(writer, node, indent, indent_length, flags, depth)) + { + // element nodes can have value if parse_embed_pcdata was used + if (node->value) + indent_flags = 0; + + node = node->first_child; + depth++; + continue; + } + } + else if (PUGI__NODETYPE(node) == node_document) + { + indent_flags = indent_indent; + + if (node->first_child) + { + node = node->first_child; + continue; + } + } + else + { + node_output_simple(writer, node, flags); + + indent_flags = indent_newline | indent_indent; + } + } + + // continue to the next node + while (node != root) + { + if (node->next_sibling) + { + node = node->next_sibling; + break; + } + + node = node->parent; + + // write closing node + if (PUGI__NODETYPE(node) == node_element) + { + depth--; + + if ((indent_flags & indent_newline) && (flags & format_raw) == 0) + writer.write('\n'); + + if ((indent_flags & indent_indent) && indent_length) + text_output_indent(writer, indent, indent_length, depth); + + node_output_end(writer, node); + + indent_flags = indent_newline | indent_indent; + } + } + } + while (node != root); + + if ((indent_flags & indent_newline) && (flags & format_raw) == 0) + writer.write('\n'); + } + + PUGI__FN bool has_declaration(xml_node_struct* node) + { + for (xml_node_struct* child = node->first_child; child; child = child->next_sibling) + { + xml_node_type type = PUGI__NODETYPE(child); + + if (type == node_declaration) return true; + if (type == node_element) return false; + } + + return false; + } + + PUGI__FN bool is_attribute_of(xml_attribute_struct* attr, xml_node_struct* node) + { + for (xml_attribute_struct* a = node->first_attribute; a; a = a->next_attribute) + if (a == attr) + return true; + + return false; + } + + PUGI__FN bool allow_insert_attribute(xml_node_type parent) + { + return parent == node_element || parent == node_declaration; + } + + PUGI__FN bool allow_insert_child(xml_node_type parent, xml_node_type child) + { + if (parent != node_document && parent != node_element) return false; + if (child == node_document || child == node_null) return false; + if (parent != node_document && (child == node_declaration || child == node_doctype)) return false; + + return true; + } + + PUGI__FN bool allow_move(xml_node parent, xml_node child) + { + // check that child can be a child of parent + if (!allow_insert_child(parent.type(), child.type())) + return false; + + // check that node is not moved between documents + if (parent.root() != child.root()) + return false; + + // check that new parent is not in the child subtree + xml_node cur = parent; + + while (cur) + { + if (cur == child) + return false; + + cur = cur.parent(); + } + + return true; + } + + template + PUGI__FN void node_copy_string(String& dest, Header& header, uintptr_t header_mask, char_t* source, Header& source_header, xml_allocator* alloc) + { + assert(!dest && (header & header_mask) == 0); + + if (source) + { + if (alloc && (source_header & header_mask) == 0) + { + dest = source; + + // since strcpy_insitu can reuse document buffer memory we need to mark both source and dest as shared + header |= xml_memory_page_contents_shared_mask; + source_header |= xml_memory_page_contents_shared_mask; + } + else + strcpy_insitu(dest, header, header_mask, source, strlength(source)); + } + } + + PUGI__FN void node_copy_contents(xml_node_struct* dn, xml_node_struct* sn, xml_allocator* shared_alloc) + { + node_copy_string(dn->name, dn->header, xml_memory_page_name_allocated_mask, sn->name, sn->header, shared_alloc); + node_copy_string(dn->value, dn->header, xml_memory_page_value_allocated_mask, sn->value, sn->header, shared_alloc); + + for (xml_attribute_struct* sa = sn->first_attribute; sa; sa = sa->next_attribute) + { + xml_attribute_struct* da = append_new_attribute(dn, get_allocator(dn)); + + if (da) + { + node_copy_string(da->name, da->header, xml_memory_page_name_allocated_mask, sa->name, sa->header, shared_alloc); + node_copy_string(da->value, da->header, xml_memory_page_value_allocated_mask, sa->value, sa->header, shared_alloc); + } + } + } + + PUGI__FN void node_copy_tree(xml_node_struct* dn, xml_node_struct* sn) + { + xml_allocator& alloc = get_allocator(dn); + xml_allocator* shared_alloc = (&alloc == &get_allocator(sn)) ? &alloc : 0; + + node_copy_contents(dn, sn, shared_alloc); + + xml_node_struct* dit = dn; + xml_node_struct* sit = sn->first_child; + + while (sit && sit != sn) + { + if (sit != dn) + { + xml_node_struct* copy = append_new_node(dit, alloc, PUGI__NODETYPE(sit)); + + if (copy) + { + node_copy_contents(copy, sit, shared_alloc); + + if (sit->first_child) + { + dit = copy; + sit = sit->first_child; + continue; + } + } + } + + // continue to the next node + do + { + if (sit->next_sibling) + { + sit = sit->next_sibling; + break; + } + + sit = sit->parent; + dit = dit->parent; + } + while (sit != sn); + } + } + + PUGI__FN void node_copy_attribute(xml_attribute_struct* da, xml_attribute_struct* sa) + { + xml_allocator& alloc = get_allocator(da); + xml_allocator* shared_alloc = (&alloc == &get_allocator(sa)) ? &alloc : 0; + + node_copy_string(da->name, da->header, xml_memory_page_name_allocated_mask, sa->name, sa->header, shared_alloc); + node_copy_string(da->value, da->header, xml_memory_page_value_allocated_mask, sa->value, sa->header, shared_alloc); + } + + inline bool is_text_node(xml_node_struct* node) + { + xml_node_type type = PUGI__NODETYPE(node); + + return type == node_pcdata || type == node_cdata; + } + + // get value with conversion functions + template U string_to_integer(const char_t* value, U minneg, U maxpos) + { + U result = 0; + const char_t* s = value; + + while (PUGI__IS_CHARTYPE(*s, ct_space)) + s++; + + bool negative = (*s == '-'); + + s += (*s == '+' || *s == '-'); + + bool overflow = false; + + if (s[0] == '0' && (s[1] | ' ') == 'x') + { + s += 2; + + // since overflow detection relies on length of the sequence skip leading zeros + while (*s == '0') + s++; + + const char_t* start = s; + + for (;;) + { + if (static_cast(*s - '0') < 10) + result = result * 16 + (*s - '0'); + else if (static_cast((*s | ' ') - 'a') < 6) + result = result * 16 + ((*s | ' ') - 'a' + 10); + else + break; + + s++; + } + + size_t digits = static_cast(s - start); + + overflow = digits > sizeof(U) * 2; + } + else + { + // since overflow detection relies on length of the sequence skip leading zeros + while (*s == '0') + s++; + + const char_t* start = s; + + for (;;) + { + if (static_cast(*s - '0') < 10) + result = result * 10 + (*s - '0'); + else + break; + + s++; + } + + size_t digits = static_cast(s - start); + + PUGI__STATIC_ASSERT(sizeof(U) == 8 || sizeof(U) == 4 || sizeof(U) == 2); + + const size_t max_digits10 = sizeof(U) == 8 ? 20 : sizeof(U) == 4 ? 10 : 5; + const char_t max_lead = sizeof(U) == 8 ? '1' : sizeof(U) == 4 ? '4' : '6'; + const size_t high_bit = sizeof(U) * 8 - 1; + + overflow = digits >= max_digits10 && !(digits == max_digits10 && (*start < max_lead || (*start == max_lead && result >> high_bit))); + } + + if (negative) + return (overflow || result > minneg) ? 0 - minneg : 0 - result; + else + return (overflow || result > maxpos) ? maxpos : result; + } + + PUGI__FN int get_value_int(const char_t* value) + { + return string_to_integer(value, 0 - static_cast(INT_MIN), INT_MAX); + } + + PUGI__FN unsigned int get_value_uint(const char_t* value) + { + return string_to_integer(value, 0, UINT_MAX); + } + + PUGI__FN double get_value_double(const char_t* value) + { + #ifdef PUGIXML_WCHAR_MODE + return wcstod(value, 0); + #else + return strtod(value, 0); + #endif + } + + PUGI__FN float get_value_float(const char_t* value) + { + #ifdef PUGIXML_WCHAR_MODE + return static_cast(wcstod(value, 0)); + #else + return static_cast(strtod(value, 0)); + #endif + } + + PUGI__FN bool get_value_bool(const char_t* value) + { + // only look at first char + char_t first = *value; + + // 1*, t* (true), T* (True), y* (yes), Y* (YES) + return (first == '1' || first == 't' || first == 'T' || first == 'y' || first == 'Y'); + } + +#ifdef PUGIXML_HAS_LONG_LONG + PUGI__FN long long get_value_llong(const char_t* value) + { + return string_to_integer(value, 0 - static_cast(LLONG_MIN), LLONG_MAX); + } + + PUGI__FN unsigned long long get_value_ullong(const char_t* value) + { + return string_to_integer(value, 0, ULLONG_MAX); + } +#endif + + template PUGI__FN char_t* integer_to_string(char_t* begin, char_t* end, U value, bool negative) + { + char_t* result = end - 1; + U rest = negative ? 0 - value : value; + + do + { + *result-- = static_cast('0' + (rest % 10)); + rest /= 10; + } + while (rest); + + assert(result >= begin); + (void)begin; + + *result = '-'; + + return result + !negative; + } + + // set value with conversion functions + template + PUGI__FN bool set_value_ascii(String& dest, Header& header, uintptr_t header_mask, char* buf) + { + #ifdef PUGIXML_WCHAR_MODE + char_t wbuf[128]; + assert(strlen(buf) < sizeof(wbuf) / sizeof(wbuf[0])); + + size_t offset = 0; + for (; buf[offset]; ++offset) wbuf[offset] = buf[offset]; + + return strcpy_insitu(dest, header, header_mask, wbuf, offset); + #else + return strcpy_insitu(dest, header, header_mask, buf, strlen(buf)); + #endif + } + + template + PUGI__FN bool set_value_integer(String& dest, Header& header, uintptr_t header_mask, U value, bool negative) + { + char_t buf[64]; + char_t* end = buf + sizeof(buf) / sizeof(buf[0]); + char_t* begin = integer_to_string(buf, end, value, negative); + + return strcpy_insitu(dest, header, header_mask, begin, end - begin); + } + + template + PUGI__FN bool set_value_convert(String& dest, Header& header, uintptr_t header_mask, float value) + { + char buf[128]; + sprintf(buf, "%.9g", value); + + return set_value_ascii(dest, header, header_mask, buf); + } + + template + PUGI__FN bool set_value_convert(String& dest, Header& header, uintptr_t header_mask, double value) + { + char buf[128]; + sprintf(buf, "%.17g", value); + + return set_value_ascii(dest, header, header_mask, buf); + } + + template + PUGI__FN bool set_value_bool(String& dest, Header& header, uintptr_t header_mask, bool value) + { + return strcpy_insitu(dest, header, header_mask, value ? PUGIXML_TEXT("true") : PUGIXML_TEXT("false"), value ? 4 : 5); + } + + PUGI__FN xml_parse_result load_buffer_impl(xml_document_struct* doc, xml_node_struct* root, void* contents, size_t size, unsigned int options, xml_encoding encoding, bool is_mutable, bool own, char_t** out_buffer) + { + // check input buffer + if (!contents && size) return make_parse_result(status_io_error); + + // get actual encoding + xml_encoding buffer_encoding = impl::get_buffer_encoding(encoding, contents, size); + + // get private buffer + char_t* buffer = 0; + size_t length = 0; + + if (!impl::convert_buffer(buffer, length, buffer_encoding, contents, size, is_mutable)) return impl::make_parse_result(status_out_of_memory); + + // delete original buffer if we performed a conversion + if (own && buffer != contents && contents) impl::xml_memory::deallocate(contents); + + // grab onto buffer if it's our buffer, user is responsible for deallocating contents himself + if (own || buffer != contents) *out_buffer = buffer; + + // store buffer for offset_debug + doc->buffer = buffer; + + // parse + xml_parse_result res = impl::xml_parser::parse(buffer, length, doc, root, options); + + // remember encoding + res.encoding = buffer_encoding; + + return res; + } + + // we need to get length of entire file to load it in memory; the only (relatively) sane way to do it is via seek/tell trick + PUGI__FN xml_parse_status get_file_size(FILE* file, size_t& out_result) + { + #if defined(PUGI__MSVC_CRT_VERSION) && PUGI__MSVC_CRT_VERSION >= 1400 && !defined(_WIN32_WCE) + // there are 64-bit versions of fseek/ftell, let's use them + typedef __int64 length_type; + + _fseeki64(file, 0, SEEK_END); + length_type length = _ftelli64(file); + _fseeki64(file, 0, SEEK_SET); + #elif defined(__MINGW32__) && !defined(__NO_MINGW_LFS) && (!defined(__STRICT_ANSI__) || defined(__MINGW64_VERSION_MAJOR)) + // there are 64-bit versions of fseek/ftell, let's use them + typedef off64_t length_type; + + fseeko64(file, 0, SEEK_END); + length_type length = ftello64(file); + fseeko64(file, 0, SEEK_SET); + #else + // if this is a 32-bit OS, long is enough; if this is a unix system, long is 64-bit, which is enough; otherwise we can't do anything anyway. + typedef long length_type; + + fseek(file, 0, SEEK_END); + length_type length = ftell(file); + fseek(file, 0, SEEK_SET); + #endif + + // check for I/O errors + if (length < 0) return status_io_error; + + // check for overflow + size_t result = static_cast(length); + + if (static_cast(result) != length) return status_out_of_memory; + + // finalize + out_result = result; + + return status_ok; + } + + // This function assumes that buffer has extra sizeof(char_t) writable bytes after size + PUGI__FN size_t zero_terminate_buffer(void* buffer, size_t size, xml_encoding encoding) + { + // We only need to zero-terminate if encoding conversion does not do it for us + #ifdef PUGIXML_WCHAR_MODE + xml_encoding wchar_encoding = get_wchar_encoding(); + + if (encoding == wchar_encoding || need_endian_swap_utf(encoding, wchar_encoding)) + { + size_t length = size / sizeof(char_t); + + static_cast(buffer)[length] = 0; + return (length + 1) * sizeof(char_t); + } + #else + if (encoding == encoding_utf8) + { + static_cast(buffer)[size] = 0; + return size + 1; + } + #endif + + return size; + } + + PUGI__FN xml_parse_result load_file_impl(xml_document_struct* doc, FILE* file, unsigned int options, xml_encoding encoding, char_t** out_buffer) + { + if (!file) return make_parse_result(status_file_not_found); + + // get file size (can result in I/O errors) + size_t size = 0; + xml_parse_status size_status = get_file_size(file, size); + if (size_status != status_ok) return make_parse_result(size_status); + + size_t max_suffix_size = sizeof(char_t); + + // allocate buffer for the whole file + char* contents = static_cast(xml_memory::allocate(size + max_suffix_size)); + if (!contents) return make_parse_result(status_out_of_memory); + + // read file in memory + size_t read_size = fread(contents, 1, size, file); + + if (read_size != size) + { + xml_memory::deallocate(contents); + return make_parse_result(status_io_error); + } + + xml_encoding real_encoding = get_buffer_encoding(encoding, contents, size); + + return load_buffer_impl(doc, doc, contents, zero_terminate_buffer(contents, size, real_encoding), options, real_encoding, true, true, out_buffer); + } + + PUGI__FN void close_file(FILE* file) + { + fclose(file); + } + +#ifndef PUGIXML_NO_STL + template struct xml_stream_chunk + { + static xml_stream_chunk* create() + { + void* memory = xml_memory::allocate(sizeof(xml_stream_chunk)); + if (!memory) return 0; + + return new (memory) xml_stream_chunk(); + } + + static void destroy(xml_stream_chunk* chunk) + { + // free chunk chain + while (chunk) + { + xml_stream_chunk* next_ = chunk->next; + + xml_memory::deallocate(chunk); + + chunk = next_; + } + } + + xml_stream_chunk(): next(0), size(0) + { + } + + xml_stream_chunk* next; + size_t size; + + T data[xml_memory_page_size / sizeof(T)]; + }; + + template PUGI__FN xml_parse_status load_stream_data_noseek(std::basic_istream& stream, void** out_buffer, size_t* out_size) + { + auto_deleter > chunks(0, xml_stream_chunk::destroy); + + // read file to a chunk list + size_t total = 0; + xml_stream_chunk* last = 0; + + while (!stream.eof()) + { + // allocate new chunk + xml_stream_chunk* chunk = xml_stream_chunk::create(); + if (!chunk) return status_out_of_memory; + + // append chunk to list + if (last) last = last->next = chunk; + else chunks.data = last = chunk; + + // read data to chunk + stream.read(chunk->data, static_cast(sizeof(chunk->data) / sizeof(T))); + chunk->size = static_cast(stream.gcount()) * sizeof(T); + + // read may set failbit | eofbit in case gcount() is less than read length, so check for other I/O errors + if (stream.bad() || (!stream.eof() && stream.fail())) return status_io_error; + + // guard against huge files (chunk size is small enough to make this overflow check work) + if (total + chunk->size < total) return status_out_of_memory; + total += chunk->size; + } + + size_t max_suffix_size = sizeof(char_t); + + // copy chunk list to a contiguous buffer + char* buffer = static_cast(xml_memory::allocate(total + max_suffix_size)); + if (!buffer) return status_out_of_memory; + + char* write = buffer; + + for (xml_stream_chunk* chunk = chunks.data; chunk; chunk = chunk->next) + { + assert(write + chunk->size <= buffer + total); + memcpy(write, chunk->data, chunk->size); + write += chunk->size; + } + + assert(write == buffer + total); + + // return buffer + *out_buffer = buffer; + *out_size = total; + + return status_ok; + } + + template PUGI__FN xml_parse_status load_stream_data_seek(std::basic_istream& stream, void** out_buffer, size_t* out_size) + { + // get length of remaining data in stream + typename std::basic_istream::pos_type pos = stream.tellg(); + stream.seekg(0, std::ios::end); + std::streamoff length = stream.tellg() - pos; + stream.seekg(pos); + + if (stream.fail() || pos < 0) return status_io_error; + + // guard against huge files + size_t read_length = static_cast(length); + + if (static_cast(read_length) != length || length < 0) return status_out_of_memory; + + size_t max_suffix_size = sizeof(char_t); + + // read stream data into memory (guard against stream exceptions with buffer holder) + auto_deleter buffer(xml_memory::allocate(read_length * sizeof(T) + max_suffix_size), xml_memory::deallocate); + if (!buffer.data) return status_out_of_memory; + + stream.read(static_cast(buffer.data), static_cast(read_length)); + + // read may set failbit | eofbit in case gcount() is less than read_length (i.e. line ending conversion), so check for other I/O errors + if (stream.bad() || (!stream.eof() && stream.fail())) return status_io_error; + + // return buffer + size_t actual_length = static_cast(stream.gcount()); + assert(actual_length <= read_length); + + *out_buffer = buffer.release(); + *out_size = actual_length * sizeof(T); + + return status_ok; + } + + template PUGI__FN xml_parse_result load_stream_impl(xml_document_struct* doc, std::basic_istream& stream, unsigned int options, xml_encoding encoding, char_t** out_buffer) + { + void* buffer = 0; + size_t size = 0; + xml_parse_status status = status_ok; + + // if stream has an error bit set, bail out (otherwise tellg() can fail and we'll clear error bits) + if (stream.fail()) return make_parse_result(status_io_error); + + // load stream to memory (using seek-based implementation if possible, since it's faster and takes less memory) + if (stream.tellg() < 0) + { + stream.clear(); // clear error flags that could be set by a failing tellg + status = load_stream_data_noseek(stream, &buffer, &size); + } + else + status = load_stream_data_seek(stream, &buffer, &size); + + if (status != status_ok) return make_parse_result(status); + + xml_encoding real_encoding = get_buffer_encoding(encoding, buffer, size); + + return load_buffer_impl(doc, doc, buffer, zero_terminate_buffer(buffer, size, real_encoding), options, real_encoding, true, true, out_buffer); + } +#endif + +#if defined(PUGI__MSVC_CRT_VERSION) || defined(__BORLANDC__) || (defined(__MINGW32__) && (!defined(__STRICT_ANSI__) || defined(__MINGW64_VERSION_MAJOR))) + PUGI__FN FILE* open_file_wide(const wchar_t* path, const wchar_t* mode) + { + return _wfopen(path, mode); + } +#else + PUGI__FN char* convert_path_heap(const wchar_t* str) + { + assert(str); + + // first pass: get length in utf8 characters + size_t length = strlength_wide(str); + size_t size = as_utf8_begin(str, length); + + // allocate resulting string + char* result = static_cast(xml_memory::allocate(size + 1)); + if (!result) return 0; + + // second pass: convert to utf8 + as_utf8_end(result, size, str, length); + + // zero-terminate + result[size] = 0; + + return result; + } + + PUGI__FN FILE* open_file_wide(const wchar_t* path, const wchar_t* mode) + { + // there is no standard function to open wide paths, so our best bet is to try utf8 path + char* path_utf8 = convert_path_heap(path); + if (!path_utf8) return 0; + + // convert mode to ASCII (we mirror _wfopen interface) + char mode_ascii[4] = {0}; + for (size_t i = 0; mode[i]; ++i) mode_ascii[i] = static_cast(mode[i]); + + // try to open the utf8 path + FILE* result = fopen(path_utf8, mode_ascii); + + // free dummy buffer + xml_memory::deallocate(path_utf8); + + return result; + } +#endif + + PUGI__FN bool save_file_impl(const xml_document& doc, FILE* file, const char_t* indent, unsigned int flags, xml_encoding encoding) + { + if (!file) return false; + + xml_writer_file writer(file); + doc.save(writer, indent, flags, encoding); + + return ferror(file) == 0; + } + + struct name_null_sentry + { + xml_node_struct* node; + char_t* name; + + name_null_sentry(xml_node_struct* node_): node(node_), name(node_->name) + { + node->name = 0; + } + + ~name_null_sentry() + { + node->name = name; + } + }; +PUGI__NS_END + +namespace pugi +{ + PUGI__FN xml_writer_file::xml_writer_file(void* file_): file(file_) + { + } + + PUGI__FN void xml_writer_file::write(const void* data, size_t size) + { + size_t result = fwrite(data, 1, size, static_cast(file)); + (void)!result; // unfortunately we can't do proper error handling here + } + +#ifndef PUGIXML_NO_STL + PUGI__FN xml_writer_stream::xml_writer_stream(std::basic_ostream >& stream): narrow_stream(&stream), wide_stream(0) + { + } + + PUGI__FN xml_writer_stream::xml_writer_stream(std::basic_ostream >& stream): narrow_stream(0), wide_stream(&stream) + { + } + + PUGI__FN void xml_writer_stream::write(const void* data, size_t size) + { + if (narrow_stream) + { + assert(!wide_stream); + narrow_stream->write(reinterpret_cast(data), static_cast(size)); + } + else + { + assert(wide_stream); + assert(size % sizeof(wchar_t) == 0); + + wide_stream->write(reinterpret_cast(data), static_cast(size / sizeof(wchar_t))); + } + } +#endif + + PUGI__FN xml_tree_walker::xml_tree_walker(): _depth(0) + { + } + + PUGI__FN xml_tree_walker::~xml_tree_walker() + { + } + + PUGI__FN int xml_tree_walker::depth() const + { + return _depth; + } + + PUGI__FN bool xml_tree_walker::begin(xml_node&) + { + return true; + } + + PUGI__FN bool xml_tree_walker::end(xml_node&) + { + return true; + } + + PUGI__FN xml_attribute::xml_attribute(): _attr(0) + { + } + + PUGI__FN xml_attribute::xml_attribute(xml_attribute_struct* attr): _attr(attr) + { + } + + PUGI__FN static void unspecified_bool_xml_attribute(xml_attribute***) + { + } + + PUGI__FN xml_attribute::operator xml_attribute::unspecified_bool_type() const + { + return _attr ? unspecified_bool_xml_attribute : 0; + } + + PUGI__FN bool xml_attribute::operator!() const + { + return !_attr; + } + + PUGI__FN bool xml_attribute::operator==(const xml_attribute& r) const + { + return (_attr == r._attr); + } + + PUGI__FN bool xml_attribute::operator!=(const xml_attribute& r) const + { + return (_attr != r._attr); + } + + PUGI__FN bool xml_attribute::operator<(const xml_attribute& r) const + { + return (_attr < r._attr); + } + + PUGI__FN bool xml_attribute::operator>(const xml_attribute& r) const + { + return (_attr > r._attr); + } + + PUGI__FN bool xml_attribute::operator<=(const xml_attribute& r) const + { + return (_attr <= r._attr); + } + + PUGI__FN bool xml_attribute::operator>=(const xml_attribute& r) const + { + return (_attr >= r._attr); + } + + PUGI__FN xml_attribute xml_attribute::next_attribute() const + { + return _attr ? xml_attribute(_attr->next_attribute) : xml_attribute(); + } + + PUGI__FN xml_attribute xml_attribute::previous_attribute() const + { + return _attr && _attr->prev_attribute_c->next_attribute ? xml_attribute(_attr->prev_attribute_c) : xml_attribute(); + } + + PUGI__FN const char_t* xml_attribute::as_string(const char_t* def) const + { + return (_attr && _attr->value) ? _attr->value + 0 : def; + } + + PUGI__FN int xml_attribute::as_int(int def) const + { + return (_attr && _attr->value) ? impl::get_value_int(_attr->value) : def; + } + + PUGI__FN unsigned int xml_attribute::as_uint(unsigned int def) const + { + return (_attr && _attr->value) ? impl::get_value_uint(_attr->value) : def; + } + + PUGI__FN double xml_attribute::as_double(double def) const + { + return (_attr && _attr->value) ? impl::get_value_double(_attr->value) : def; + } + + PUGI__FN float xml_attribute::as_float(float def) const + { + return (_attr && _attr->value) ? impl::get_value_float(_attr->value) : def; + } + + PUGI__FN bool xml_attribute::as_bool(bool def) const + { + return (_attr && _attr->value) ? impl::get_value_bool(_attr->value) : def; + } + +#ifdef PUGIXML_HAS_LONG_LONG + PUGI__FN long long xml_attribute::as_llong(long long def) const + { + return (_attr && _attr->value) ? impl::get_value_llong(_attr->value) : def; + } + + PUGI__FN unsigned long long xml_attribute::as_ullong(unsigned long long def) const + { + return (_attr && _attr->value) ? impl::get_value_ullong(_attr->value) : def; + } +#endif + + PUGI__FN bool xml_attribute::empty() const + { + return !_attr; + } + + PUGI__FN const char_t* xml_attribute::name() const + { + return (_attr && _attr->name) ? _attr->name + 0 : PUGIXML_TEXT(""); + } + + PUGI__FN const char_t* xml_attribute::value() const + { + return (_attr && _attr->value) ? _attr->value + 0 : PUGIXML_TEXT(""); + } + + PUGI__FN size_t xml_attribute::hash_value() const + { + return static_cast(reinterpret_cast(_attr) / sizeof(xml_attribute_struct)); + } + + PUGI__FN xml_attribute_struct* xml_attribute::internal_object() const + { + return _attr; + } + + PUGI__FN xml_attribute& xml_attribute::operator=(const char_t* rhs) + { + set_value(rhs); + return *this; + } + + PUGI__FN xml_attribute& xml_attribute::operator=(int rhs) + { + set_value(rhs); + return *this; + } + + PUGI__FN xml_attribute& xml_attribute::operator=(unsigned int rhs) + { + set_value(rhs); + return *this; + } + + PUGI__FN xml_attribute& xml_attribute::operator=(long rhs) + { + set_value(rhs); + return *this; + } + + PUGI__FN xml_attribute& xml_attribute::operator=(unsigned long rhs) + { + set_value(rhs); + return *this; + } + + PUGI__FN xml_attribute& xml_attribute::operator=(double rhs) + { + set_value(rhs); + return *this; + } + + PUGI__FN xml_attribute& xml_attribute::operator=(float rhs) + { + set_value(rhs); + return *this; + } + + PUGI__FN xml_attribute& xml_attribute::operator=(bool rhs) + { + set_value(rhs); + return *this; + } + +#ifdef PUGIXML_HAS_LONG_LONG + PUGI__FN xml_attribute& xml_attribute::operator=(long long rhs) + { + set_value(rhs); + return *this; + } + + PUGI__FN xml_attribute& xml_attribute::operator=(unsigned long long rhs) + { + set_value(rhs); + return *this; + } +#endif + + PUGI__FN bool xml_attribute::set_name(const char_t* rhs) + { + if (!_attr) return false; + + return impl::strcpy_insitu(_attr->name, _attr->header, impl::xml_memory_page_name_allocated_mask, rhs, impl::strlength(rhs)); + } + + PUGI__FN bool xml_attribute::set_value(const char_t* rhs) + { + if (!_attr) return false; + + return impl::strcpy_insitu(_attr->value, _attr->header, impl::xml_memory_page_value_allocated_mask, rhs, impl::strlength(rhs)); + } + + PUGI__FN bool xml_attribute::set_value(int rhs) + { + if (!_attr) return false; + + return impl::set_value_integer(_attr->value, _attr->header, impl::xml_memory_page_value_allocated_mask, rhs, rhs < 0); + } + + PUGI__FN bool xml_attribute::set_value(unsigned int rhs) + { + if (!_attr) return false; + + return impl::set_value_integer(_attr->value, _attr->header, impl::xml_memory_page_value_allocated_mask, rhs, false); + } + + PUGI__FN bool xml_attribute::set_value(long rhs) + { + if (!_attr) return false; + + return impl::set_value_integer(_attr->value, _attr->header, impl::xml_memory_page_value_allocated_mask, rhs, rhs < 0); + } + + PUGI__FN bool xml_attribute::set_value(unsigned long rhs) + { + if (!_attr) return false; + + return impl::set_value_integer(_attr->value, _attr->header, impl::xml_memory_page_value_allocated_mask, rhs, false); + } + + PUGI__FN bool xml_attribute::set_value(double rhs) + { + if (!_attr) return false; + + return impl::set_value_convert(_attr->value, _attr->header, impl::xml_memory_page_value_allocated_mask, rhs); + } + + PUGI__FN bool xml_attribute::set_value(float rhs) + { + if (!_attr) return false; + + return impl::set_value_convert(_attr->value, _attr->header, impl::xml_memory_page_value_allocated_mask, rhs); + } + + PUGI__FN bool xml_attribute::set_value(bool rhs) + { + if (!_attr) return false; + + return impl::set_value_bool(_attr->value, _attr->header, impl::xml_memory_page_value_allocated_mask, rhs); + } + +#ifdef PUGIXML_HAS_LONG_LONG + PUGI__FN bool xml_attribute::set_value(long long rhs) + { + if (!_attr) return false; + + return impl::set_value_integer(_attr->value, _attr->header, impl::xml_memory_page_value_allocated_mask, rhs, rhs < 0); + } + + PUGI__FN bool xml_attribute::set_value(unsigned long long rhs) + { + if (!_attr) return false; + + return impl::set_value_integer(_attr->value, _attr->header, impl::xml_memory_page_value_allocated_mask, rhs, false); + } +#endif + +#ifdef __BORLANDC__ + PUGI__FN bool operator&&(const xml_attribute& lhs, bool rhs) + { + return (bool)lhs && rhs; + } + + PUGI__FN bool operator||(const xml_attribute& lhs, bool rhs) + { + return (bool)lhs || rhs; + } +#endif + + PUGI__FN xml_node::xml_node(): _root(0) + { + } + + PUGI__FN xml_node::xml_node(xml_node_struct* p): _root(p) + { + } + + PUGI__FN static void unspecified_bool_xml_node(xml_node***) + { + } + + PUGI__FN xml_node::operator xml_node::unspecified_bool_type() const + { + return _root ? unspecified_bool_xml_node : 0; + } + + PUGI__FN bool xml_node::operator!() const + { + return !_root; + } + + PUGI__FN xml_node::iterator xml_node::begin() const + { + return iterator(_root ? _root->first_child + 0 : 0, _root); + } + + PUGI__FN xml_node::iterator xml_node::end() const + { + return iterator(0, _root); + } + + PUGI__FN xml_node::attribute_iterator xml_node::attributes_begin() const + { + return attribute_iterator(_root ? _root->first_attribute + 0 : 0, _root); + } + + PUGI__FN xml_node::attribute_iterator xml_node::attributes_end() const + { + return attribute_iterator(0, _root); + } + + PUGI__FN xml_object_range xml_node::children() const + { + return xml_object_range(begin(), end()); + } + + PUGI__FN xml_object_range xml_node::children(const char_t* name_) const + { + return xml_object_range(xml_named_node_iterator(child(name_)._root, _root, name_), xml_named_node_iterator(0, _root, name_)); + } + + PUGI__FN xml_object_range xml_node::attributes() const + { + return xml_object_range(attributes_begin(), attributes_end()); + } + + PUGI__FN bool xml_node::operator==(const xml_node& r) const + { + return (_root == r._root); + } + + PUGI__FN bool xml_node::operator!=(const xml_node& r) const + { + return (_root != r._root); + } + + PUGI__FN bool xml_node::operator<(const xml_node& r) const + { + return (_root < r._root); + } + + PUGI__FN bool xml_node::operator>(const xml_node& r) const + { + return (_root > r._root); + } + + PUGI__FN bool xml_node::operator<=(const xml_node& r) const + { + return (_root <= r._root); + } + + PUGI__FN bool xml_node::operator>=(const xml_node& r) const + { + return (_root >= r._root); + } + + PUGI__FN bool xml_node::empty() const + { + return !_root; + } + + PUGI__FN const char_t* xml_node::name() const + { + return (_root && _root->name) ? _root->name + 0 : PUGIXML_TEXT(""); + } + + PUGI__FN xml_node_type xml_node::type() const + { + return _root ? PUGI__NODETYPE(_root) : node_null; + } + + PUGI__FN const char_t* xml_node::value() const + { + return (_root && _root->value) ? _root->value + 0 : PUGIXML_TEXT(""); + } + + PUGI__FN xml_node xml_node::child(const char_t* name_) const + { + if (!_root) return xml_node(); + + for (xml_node_struct* i = _root->first_child; i; i = i->next_sibling) + if (i->name && impl::strequal(name_, i->name)) return xml_node(i); + + return xml_node(); + } + + PUGI__FN xml_attribute xml_node::attribute(const char_t* name_) const + { + if (!_root) return xml_attribute(); + + for (xml_attribute_struct* i = _root->first_attribute; i; i = i->next_attribute) + if (i->name && impl::strequal(name_, i->name)) + return xml_attribute(i); + + return xml_attribute(); + } + + PUGI__FN xml_node xml_node::next_sibling(const char_t* name_) const + { + if (!_root) return xml_node(); + + for (xml_node_struct* i = _root->next_sibling; i; i = i->next_sibling) + if (i->name && impl::strequal(name_, i->name)) return xml_node(i); + + return xml_node(); + } + + PUGI__FN xml_node xml_node::next_sibling() const + { + return _root ? xml_node(_root->next_sibling) : xml_node(); + } + + PUGI__FN xml_node xml_node::previous_sibling(const char_t* name_) const + { + if (!_root) return xml_node(); + + for (xml_node_struct* i = _root->prev_sibling_c; i->next_sibling; i = i->prev_sibling_c) + if (i->name && impl::strequal(name_, i->name)) return xml_node(i); + + return xml_node(); + } + + PUGI__FN xml_attribute xml_node::attribute(const char_t* name_, xml_attribute& hint_) const + { + xml_attribute_struct* hint = hint_._attr; + + // if hint is not an attribute of node, behavior is not defined + assert(!hint || (_root && impl::is_attribute_of(hint, _root))); + + if (!_root) return xml_attribute(); + + // optimistically search from hint up until the end + for (xml_attribute_struct* i = hint; i; i = i->next_attribute) + if (i->name && impl::strequal(name_, i->name)) + { + // update hint to maximize efficiency of searching for consecutive attributes + hint_._attr = i->next_attribute; + + return xml_attribute(i); + } + + // wrap around and search from the first attribute until the hint + // 'j' null pointer check is technically redundant, but it prevents a crash in case the assertion above fails + for (xml_attribute_struct* j = _root->first_attribute; j && j != hint; j = j->next_attribute) + if (j->name && impl::strequal(name_, j->name)) + { + // update hint to maximize efficiency of searching for consecutive attributes + hint_._attr = j->next_attribute; + + return xml_attribute(j); + } + + return xml_attribute(); + } + + PUGI__FN xml_node xml_node::previous_sibling() const + { + if (!_root) return xml_node(); + + if (_root->prev_sibling_c->next_sibling) return xml_node(_root->prev_sibling_c); + else return xml_node(); + } + + PUGI__FN xml_node xml_node::parent() const + { + return _root ? xml_node(_root->parent) : xml_node(); + } + + PUGI__FN xml_node xml_node::root() const + { + return _root ? xml_node(&impl::get_document(_root)) : xml_node(); + } + + PUGI__FN xml_text xml_node::text() const + { + return xml_text(_root); + } + + PUGI__FN const char_t* xml_node::child_value() const + { + if (!_root) return PUGIXML_TEXT(""); + + // element nodes can have value if parse_embed_pcdata was used + if (PUGI__NODETYPE(_root) == node_element && _root->value) + return _root->value; + + for (xml_node_struct* i = _root->first_child; i; i = i->next_sibling) + if (impl::is_text_node(i) && i->value) + return i->value; + + return PUGIXML_TEXT(""); + } + + PUGI__FN const char_t* xml_node::child_value(const char_t* name_) const + { + return child(name_).child_value(); + } + + PUGI__FN xml_attribute xml_node::first_attribute() const + { + return _root ? xml_attribute(_root->first_attribute) : xml_attribute(); + } + + PUGI__FN xml_attribute xml_node::last_attribute() const + { + return _root && _root->first_attribute ? xml_attribute(_root->first_attribute->prev_attribute_c) : xml_attribute(); + } + + PUGI__FN xml_node xml_node::first_child() const + { + return _root ? xml_node(_root->first_child) : xml_node(); + } + + PUGI__FN xml_node xml_node::last_child() const + { + return _root && _root->first_child ? xml_node(_root->first_child->prev_sibling_c) : xml_node(); + } + + PUGI__FN bool xml_node::set_name(const char_t* rhs) + { + xml_node_type type_ = _root ? PUGI__NODETYPE(_root) : node_null; + + if (type_ != node_element && type_ != node_pi && type_ != node_declaration) + return false; + + return impl::strcpy_insitu(_root->name, _root->header, impl::xml_memory_page_name_allocated_mask, rhs, impl::strlength(rhs)); + } + + PUGI__FN bool xml_node::set_value(const char_t* rhs) + { + xml_node_type type_ = _root ? PUGI__NODETYPE(_root) : node_null; + + if (type_ != node_pcdata && type_ != node_cdata && type_ != node_comment && type_ != node_pi && type_ != node_doctype) + return false; + + return impl::strcpy_insitu(_root->value, _root->header, impl::xml_memory_page_value_allocated_mask, rhs, impl::strlength(rhs)); + } + + PUGI__FN xml_attribute xml_node::append_attribute(const char_t* name_) + { + if (!impl::allow_insert_attribute(type())) return xml_attribute(); + + impl::xml_allocator& alloc = impl::get_allocator(_root); + if (!alloc.reserve()) return xml_attribute(); + + xml_attribute a(impl::allocate_attribute(alloc)); + if (!a) return xml_attribute(); + + impl::append_attribute(a._attr, _root); + + a.set_name(name_); + + return a; + } + + PUGI__FN xml_attribute xml_node::prepend_attribute(const char_t* name_) + { + if (!impl::allow_insert_attribute(type())) return xml_attribute(); + + impl::xml_allocator& alloc = impl::get_allocator(_root); + if (!alloc.reserve()) return xml_attribute(); + + xml_attribute a(impl::allocate_attribute(alloc)); + if (!a) return xml_attribute(); + + impl::prepend_attribute(a._attr, _root); + + a.set_name(name_); + + return a; + } + + PUGI__FN xml_attribute xml_node::insert_attribute_after(const char_t* name_, const xml_attribute& attr) + { + if (!impl::allow_insert_attribute(type())) return xml_attribute(); + if (!attr || !impl::is_attribute_of(attr._attr, _root)) return xml_attribute(); + + impl::xml_allocator& alloc = impl::get_allocator(_root); + if (!alloc.reserve()) return xml_attribute(); + + xml_attribute a(impl::allocate_attribute(alloc)); + if (!a) return xml_attribute(); + + impl::insert_attribute_after(a._attr, attr._attr, _root); + + a.set_name(name_); + + return a; + } + + PUGI__FN xml_attribute xml_node::insert_attribute_before(const char_t* name_, const xml_attribute& attr) + { + if (!impl::allow_insert_attribute(type())) return xml_attribute(); + if (!attr || !impl::is_attribute_of(attr._attr, _root)) return xml_attribute(); + + impl::xml_allocator& alloc = impl::get_allocator(_root); + if (!alloc.reserve()) return xml_attribute(); + + xml_attribute a(impl::allocate_attribute(alloc)); + if (!a) return xml_attribute(); + + impl::insert_attribute_before(a._attr, attr._attr, _root); + + a.set_name(name_); + + return a; + } + + PUGI__FN xml_attribute xml_node::append_copy(const xml_attribute& proto) + { + if (!proto) return xml_attribute(); + if (!impl::allow_insert_attribute(type())) return xml_attribute(); + + impl::xml_allocator& alloc = impl::get_allocator(_root); + if (!alloc.reserve()) return xml_attribute(); + + xml_attribute a(impl::allocate_attribute(alloc)); + if (!a) return xml_attribute(); + + impl::append_attribute(a._attr, _root); + impl::node_copy_attribute(a._attr, proto._attr); + + return a; + } + + PUGI__FN xml_attribute xml_node::prepend_copy(const xml_attribute& proto) + { + if (!proto) return xml_attribute(); + if (!impl::allow_insert_attribute(type())) return xml_attribute(); + + impl::xml_allocator& alloc = impl::get_allocator(_root); + if (!alloc.reserve()) return xml_attribute(); + + xml_attribute a(impl::allocate_attribute(alloc)); + if (!a) return xml_attribute(); + + impl::prepend_attribute(a._attr, _root); + impl::node_copy_attribute(a._attr, proto._attr); + + return a; + } + + PUGI__FN xml_attribute xml_node::insert_copy_after(const xml_attribute& proto, const xml_attribute& attr) + { + if (!proto) return xml_attribute(); + if (!impl::allow_insert_attribute(type())) return xml_attribute(); + if (!attr || !impl::is_attribute_of(attr._attr, _root)) return xml_attribute(); + + impl::xml_allocator& alloc = impl::get_allocator(_root); + if (!alloc.reserve()) return xml_attribute(); + + xml_attribute a(impl::allocate_attribute(alloc)); + if (!a) return xml_attribute(); + + impl::insert_attribute_after(a._attr, attr._attr, _root); + impl::node_copy_attribute(a._attr, proto._attr); + + return a; + } + + PUGI__FN xml_attribute xml_node::insert_copy_before(const xml_attribute& proto, const xml_attribute& attr) + { + if (!proto) return xml_attribute(); + if (!impl::allow_insert_attribute(type())) return xml_attribute(); + if (!attr || !impl::is_attribute_of(attr._attr, _root)) return xml_attribute(); + + impl::xml_allocator& alloc = impl::get_allocator(_root); + if (!alloc.reserve()) return xml_attribute(); + + xml_attribute a(impl::allocate_attribute(alloc)); + if (!a) return xml_attribute(); + + impl::insert_attribute_before(a._attr, attr._attr, _root); + impl::node_copy_attribute(a._attr, proto._attr); + + return a; + } + + PUGI__FN xml_node xml_node::append_child(xml_node_type type_) + { + if (!impl::allow_insert_child(type(), type_)) return xml_node(); + + impl::xml_allocator& alloc = impl::get_allocator(_root); + if (!alloc.reserve()) return xml_node(); + + xml_node n(impl::allocate_node(alloc, type_)); + if (!n) return xml_node(); + + impl::append_node(n._root, _root); + + if (type_ == node_declaration) n.set_name(PUGIXML_TEXT("xml")); + + return n; + } + + PUGI__FN xml_node xml_node::prepend_child(xml_node_type type_) + { + if (!impl::allow_insert_child(type(), type_)) return xml_node(); + + impl::xml_allocator& alloc = impl::get_allocator(_root); + if (!alloc.reserve()) return xml_node(); + + xml_node n(impl::allocate_node(alloc, type_)); + if (!n) return xml_node(); + + impl::prepend_node(n._root, _root); + + if (type_ == node_declaration) n.set_name(PUGIXML_TEXT("xml")); + + return n; + } + + PUGI__FN xml_node xml_node::insert_child_before(xml_node_type type_, const xml_node& node) + { + if (!impl::allow_insert_child(type(), type_)) return xml_node(); + if (!node._root || node._root->parent != _root) return xml_node(); + + impl::xml_allocator& alloc = impl::get_allocator(_root); + if (!alloc.reserve()) return xml_node(); + + xml_node n(impl::allocate_node(alloc, type_)); + if (!n) return xml_node(); + + impl::insert_node_before(n._root, node._root); + + if (type_ == node_declaration) n.set_name(PUGIXML_TEXT("xml")); + + return n; + } + + PUGI__FN xml_node xml_node::insert_child_after(xml_node_type type_, const xml_node& node) + { + if (!impl::allow_insert_child(type(), type_)) return xml_node(); + if (!node._root || node._root->parent != _root) return xml_node(); + + impl::xml_allocator& alloc = impl::get_allocator(_root); + if (!alloc.reserve()) return xml_node(); + + xml_node n(impl::allocate_node(alloc, type_)); + if (!n) return xml_node(); + + impl::insert_node_after(n._root, node._root); + + if (type_ == node_declaration) n.set_name(PUGIXML_TEXT("xml")); + + return n; + } + + PUGI__FN xml_node xml_node::append_child(const char_t* name_) + { + xml_node result = append_child(node_element); + + result.set_name(name_); + + return result; + } + + PUGI__FN xml_node xml_node::prepend_child(const char_t* name_) + { + xml_node result = prepend_child(node_element); + + result.set_name(name_); + + return result; + } + + PUGI__FN xml_node xml_node::insert_child_after(const char_t* name_, const xml_node& node) + { + xml_node result = insert_child_after(node_element, node); + + result.set_name(name_); + + return result; + } + + PUGI__FN xml_node xml_node::insert_child_before(const char_t* name_, const xml_node& node) + { + xml_node result = insert_child_before(node_element, node); + + result.set_name(name_); + + return result; + } + + PUGI__FN xml_node xml_node::append_copy(const xml_node& proto) + { + xml_node_type type_ = proto.type(); + if (!impl::allow_insert_child(type(), type_)) return xml_node(); + + impl::xml_allocator& alloc = impl::get_allocator(_root); + if (!alloc.reserve()) return xml_node(); + + xml_node n(impl::allocate_node(alloc, type_)); + if (!n) return xml_node(); + + impl::append_node(n._root, _root); + impl::node_copy_tree(n._root, proto._root); + + return n; + } + + PUGI__FN xml_node xml_node::prepend_copy(const xml_node& proto) + { + xml_node_type type_ = proto.type(); + if (!impl::allow_insert_child(type(), type_)) return xml_node(); + + impl::xml_allocator& alloc = impl::get_allocator(_root); + if (!alloc.reserve()) return xml_node(); + + xml_node n(impl::allocate_node(alloc, type_)); + if (!n) return xml_node(); + + impl::prepend_node(n._root, _root); + impl::node_copy_tree(n._root, proto._root); + + return n; + } + + PUGI__FN xml_node xml_node::insert_copy_after(const xml_node& proto, const xml_node& node) + { + xml_node_type type_ = proto.type(); + if (!impl::allow_insert_child(type(), type_)) return xml_node(); + if (!node._root || node._root->parent != _root) return xml_node(); + + impl::xml_allocator& alloc = impl::get_allocator(_root); + if (!alloc.reserve()) return xml_node(); + + xml_node n(impl::allocate_node(alloc, type_)); + if (!n) return xml_node(); + + impl::insert_node_after(n._root, node._root); + impl::node_copy_tree(n._root, proto._root); + + return n; + } + + PUGI__FN xml_node xml_node::insert_copy_before(const xml_node& proto, const xml_node& node) + { + xml_node_type type_ = proto.type(); + if (!impl::allow_insert_child(type(), type_)) return xml_node(); + if (!node._root || node._root->parent != _root) return xml_node(); + + impl::xml_allocator& alloc = impl::get_allocator(_root); + if (!alloc.reserve()) return xml_node(); + + xml_node n(impl::allocate_node(alloc, type_)); + if (!n) return xml_node(); + + impl::insert_node_before(n._root, node._root); + impl::node_copy_tree(n._root, proto._root); + + return n; + } + + PUGI__FN xml_node xml_node::append_move(const xml_node& moved) + { + if (!impl::allow_move(*this, moved)) return xml_node(); + + impl::xml_allocator& alloc = impl::get_allocator(_root); + if (!alloc.reserve()) return xml_node(); + + // disable document_buffer_order optimization since moving nodes around changes document order without changing buffer pointers + impl::get_document(_root).header |= impl::xml_memory_page_contents_shared_mask; + + impl::remove_node(moved._root); + impl::append_node(moved._root, _root); + + return moved; + } + + PUGI__FN xml_node xml_node::prepend_move(const xml_node& moved) + { + if (!impl::allow_move(*this, moved)) return xml_node(); + + impl::xml_allocator& alloc = impl::get_allocator(_root); + if (!alloc.reserve()) return xml_node(); + + // disable document_buffer_order optimization since moving nodes around changes document order without changing buffer pointers + impl::get_document(_root).header |= impl::xml_memory_page_contents_shared_mask; + + impl::remove_node(moved._root); + impl::prepend_node(moved._root, _root); + + return moved; + } + + PUGI__FN xml_node xml_node::insert_move_after(const xml_node& moved, const xml_node& node) + { + if (!impl::allow_move(*this, moved)) return xml_node(); + if (!node._root || node._root->parent != _root) return xml_node(); + if (moved._root == node._root) return xml_node(); + + impl::xml_allocator& alloc = impl::get_allocator(_root); + if (!alloc.reserve()) return xml_node(); + + // disable document_buffer_order optimization since moving nodes around changes document order without changing buffer pointers + impl::get_document(_root).header |= impl::xml_memory_page_contents_shared_mask; + + impl::remove_node(moved._root); + impl::insert_node_after(moved._root, node._root); + + return moved; + } + + PUGI__FN xml_node xml_node::insert_move_before(const xml_node& moved, const xml_node& node) + { + if (!impl::allow_move(*this, moved)) return xml_node(); + if (!node._root || node._root->parent != _root) return xml_node(); + if (moved._root == node._root) return xml_node(); + + impl::xml_allocator& alloc = impl::get_allocator(_root); + if (!alloc.reserve()) return xml_node(); + + // disable document_buffer_order optimization since moving nodes around changes document order without changing buffer pointers + impl::get_document(_root).header |= impl::xml_memory_page_contents_shared_mask; + + impl::remove_node(moved._root); + impl::insert_node_before(moved._root, node._root); + + return moved; + } + + PUGI__FN bool xml_node::remove_attribute(const char_t* name_) + { + return remove_attribute(attribute(name_)); + } + + PUGI__FN bool xml_node::remove_attribute(const xml_attribute& a) + { + if (!_root || !a._attr) return false; + if (!impl::is_attribute_of(a._attr, _root)) return false; + + impl::xml_allocator& alloc = impl::get_allocator(_root); + if (!alloc.reserve()) return false; + + impl::remove_attribute(a._attr, _root); + impl::destroy_attribute(a._attr, alloc); + + return true; + } + + PUGI__FN bool xml_node::remove_child(const char_t* name_) + { + return remove_child(child(name_)); + } + + PUGI__FN bool xml_node::remove_child(const xml_node& n) + { + if (!_root || !n._root || n._root->parent != _root) return false; + + impl::xml_allocator& alloc = impl::get_allocator(_root); + if (!alloc.reserve()) return false; + + impl::remove_node(n._root); + impl::destroy_node(n._root, alloc); + + return true; + } + + PUGI__FN xml_parse_result xml_node::append_buffer(const void* contents, size_t size, unsigned int options, xml_encoding encoding) + { + // append_buffer is only valid for elements/documents + if (!impl::allow_insert_child(type(), node_element)) return impl::make_parse_result(status_append_invalid_root); + + // get document node + impl::xml_document_struct* doc = &impl::get_document(_root); + + // disable document_buffer_order optimization since in a document with multiple buffers comparing buffer pointers does not make sense + doc->header |= impl::xml_memory_page_contents_shared_mask; + + // get extra buffer element (we'll store the document fragment buffer there so that we can deallocate it later) + impl::xml_memory_page* page = 0; + impl::xml_extra_buffer* extra = static_cast(doc->allocate_memory(sizeof(impl::xml_extra_buffer), page)); + (void)page; + + if (!extra) return impl::make_parse_result(status_out_of_memory); + + // add extra buffer to the list + extra->buffer = 0; + extra->next = doc->extra_buffers; + doc->extra_buffers = extra; + + // name of the root has to be NULL before parsing - otherwise closing node mismatches will not be detected at the top level + impl::name_null_sentry sentry(_root); + + return impl::load_buffer_impl(doc, _root, const_cast(contents), size, options, encoding, false, false, &extra->buffer); + } + + PUGI__FN xml_node xml_node::find_child_by_attribute(const char_t* name_, const char_t* attr_name, const char_t* attr_value) const + { + if (!_root) return xml_node(); + + for (xml_node_struct* i = _root->first_child; i; i = i->next_sibling) + if (i->name && impl::strequal(name_, i->name)) + { + for (xml_attribute_struct* a = i->first_attribute; a; a = a->next_attribute) + if (a->name && impl::strequal(attr_name, a->name) && impl::strequal(attr_value, a->value ? a->value + 0 : PUGIXML_TEXT(""))) + return xml_node(i); + } + + return xml_node(); + } + + PUGI__FN xml_node xml_node::find_child_by_attribute(const char_t* attr_name, const char_t* attr_value) const + { + if (!_root) return xml_node(); + + for (xml_node_struct* i = _root->first_child; i; i = i->next_sibling) + for (xml_attribute_struct* a = i->first_attribute; a; a = a->next_attribute) + if (a->name && impl::strequal(attr_name, a->name) && impl::strequal(attr_value, a->value ? a->value + 0 : PUGIXML_TEXT(""))) + return xml_node(i); + + return xml_node(); + } + +#ifndef PUGIXML_NO_STL + PUGI__FN string_t xml_node::path(char_t delimiter) const + { + if (!_root) return string_t(); + + size_t offset = 0; + + for (xml_node_struct* i = _root; i; i = i->parent) + { + offset += (i != _root); + offset += i->name ? impl::strlength(i->name) : 0; + } + + string_t result; + result.resize(offset); + + for (xml_node_struct* j = _root; j; j = j->parent) + { + if (j != _root) + result[--offset] = delimiter; + + if (j->name && *j->name) + { + size_t length = impl::strlength(j->name); + + offset -= length; + memcpy(&result[offset], j->name, length * sizeof(char_t)); + } + } + + assert(offset == 0); + + return result; + } +#endif + + PUGI__FN xml_node xml_node::first_element_by_path(const char_t* path_, char_t delimiter) const + { + xml_node found = *this; // Current search context. + + if (!_root || !path_ || !path_[0]) return found; + + if (path_[0] == delimiter) + { + // Absolute path; e.g. '/foo/bar' + found = found.root(); + ++path_; + } + + const char_t* path_segment = path_; + + while (*path_segment == delimiter) ++path_segment; + + const char_t* path_segment_end = path_segment; + + while (*path_segment_end && *path_segment_end != delimiter) ++path_segment_end; + + if (path_segment == path_segment_end) return found; + + const char_t* next_segment = path_segment_end; + + while (*next_segment == delimiter) ++next_segment; + + if (*path_segment == '.' && path_segment + 1 == path_segment_end) + return found.first_element_by_path(next_segment, delimiter); + else if (*path_segment == '.' && *(path_segment+1) == '.' && path_segment + 2 == path_segment_end) + return found.parent().first_element_by_path(next_segment, delimiter); + else + { + for (xml_node_struct* j = found._root->first_child; j; j = j->next_sibling) + { + if (j->name && impl::strequalrange(j->name, path_segment, static_cast(path_segment_end - path_segment))) + { + xml_node subsearch = xml_node(j).first_element_by_path(next_segment, delimiter); + + if (subsearch) return subsearch; + } + } + + return xml_node(); + } + } + + PUGI__FN bool xml_node::traverse(xml_tree_walker& walker) + { + walker._depth = -1; + + xml_node arg_begin = *this; + if (!walker.begin(arg_begin)) return false; + + xml_node cur = first_child(); + + if (cur) + { + ++walker._depth; + + do + { + xml_node arg_for_each = cur; + if (!walker.for_each(arg_for_each)) + return false; + + if (cur.first_child()) + { + ++walker._depth; + cur = cur.first_child(); + } + else if (cur.next_sibling()) + cur = cur.next_sibling(); + else + { + // Borland C++ workaround + while (!cur.next_sibling() && cur != *this && !cur.parent().empty()) + { + --walker._depth; + cur = cur.parent(); + } + + if (cur != *this) + cur = cur.next_sibling(); + } + } + while (cur && cur != *this); + } + + assert(walker._depth == -1); + + xml_node arg_end = *this; + return walker.end(arg_end); + } + + PUGI__FN size_t xml_node::hash_value() const + { + return static_cast(reinterpret_cast(_root) / sizeof(xml_node_struct)); + } + + PUGI__FN xml_node_struct* xml_node::internal_object() const + { + return _root; + } + + PUGI__FN void xml_node::print(xml_writer& writer, const char_t* indent, unsigned int flags, xml_encoding encoding, unsigned int depth) const + { + if (!_root) return; + + impl::xml_buffered_writer buffered_writer(writer, encoding); + + impl::node_output(buffered_writer, _root, indent, flags, depth); + + buffered_writer.flush(); + } + +#ifndef PUGIXML_NO_STL + PUGI__FN void xml_node::print(std::basic_ostream >& stream, const char_t* indent, unsigned int flags, xml_encoding encoding, unsigned int depth) const + { + xml_writer_stream writer(stream); + + print(writer, indent, flags, encoding, depth); + } + + PUGI__FN void xml_node::print(std::basic_ostream >& stream, const char_t* indent, unsigned int flags, unsigned int depth) const + { + xml_writer_stream writer(stream); + + print(writer, indent, flags, encoding_wchar, depth); + } +#endif + + PUGI__FN ptrdiff_t xml_node::offset_debug() const + { + if (!_root) return -1; + + impl::xml_document_struct& doc = impl::get_document(_root); + + // we can determine the offset reliably only if there is exactly once parse buffer + if (!doc.buffer || doc.extra_buffers) return -1; + + switch (type()) + { + case node_document: + return 0; + + case node_element: + case node_declaration: + case node_pi: + return _root->name && (_root->header & impl::xml_memory_page_name_allocated_or_shared_mask) == 0 ? _root->name - doc.buffer : -1; + + case node_pcdata: + case node_cdata: + case node_comment: + case node_doctype: + return _root->value && (_root->header & impl::xml_memory_page_value_allocated_or_shared_mask) == 0 ? _root->value - doc.buffer : -1; + + default: + return -1; + } + } + +#ifdef __BORLANDC__ + PUGI__FN bool operator&&(const xml_node& lhs, bool rhs) + { + return (bool)lhs && rhs; + } + + PUGI__FN bool operator||(const xml_node& lhs, bool rhs) + { + return (bool)lhs || rhs; + } +#endif + + PUGI__FN xml_text::xml_text(xml_node_struct* root): _root(root) + { + } + + PUGI__FN xml_node_struct* xml_text::_data() const + { + if (!_root || impl::is_text_node(_root)) return _root; + + // element nodes can have value if parse_embed_pcdata was used + if (PUGI__NODETYPE(_root) == node_element && _root->value) + return _root; + + for (xml_node_struct* node = _root->first_child; node; node = node->next_sibling) + if (impl::is_text_node(node)) + return node; + + return 0; + } + + PUGI__FN xml_node_struct* xml_text::_data_new() + { + xml_node_struct* d = _data(); + if (d) return d; + + return xml_node(_root).append_child(node_pcdata).internal_object(); + } + + PUGI__FN xml_text::xml_text(): _root(0) + { + } + + PUGI__FN static void unspecified_bool_xml_text(xml_text***) + { + } + + PUGI__FN xml_text::operator xml_text::unspecified_bool_type() const + { + return _data() ? unspecified_bool_xml_text : 0; + } + + PUGI__FN bool xml_text::operator!() const + { + return !_data(); + } + + PUGI__FN bool xml_text::empty() const + { + return _data() == 0; + } + + PUGI__FN const char_t* xml_text::get() const + { + xml_node_struct* d = _data(); + + return (d && d->value) ? d->value + 0 : PUGIXML_TEXT(""); + } + + PUGI__FN const char_t* xml_text::as_string(const char_t* def) const + { + xml_node_struct* d = _data(); + + return (d && d->value) ? d->value + 0 : def; + } + + PUGI__FN int xml_text::as_int(int def) const + { + xml_node_struct* d = _data(); + + return (d && d->value) ? impl::get_value_int(d->value) : def; + } + + PUGI__FN unsigned int xml_text::as_uint(unsigned int def) const + { + xml_node_struct* d = _data(); + + return (d && d->value) ? impl::get_value_uint(d->value) : def; + } + + PUGI__FN double xml_text::as_double(double def) const + { + xml_node_struct* d = _data(); + + return (d && d->value) ? impl::get_value_double(d->value) : def; + } + + PUGI__FN float xml_text::as_float(float def) const + { + xml_node_struct* d = _data(); + + return (d && d->value) ? impl::get_value_float(d->value) : def; + } + + PUGI__FN bool xml_text::as_bool(bool def) const + { + xml_node_struct* d = _data(); + + return (d && d->value) ? impl::get_value_bool(d->value) : def; + } + +#ifdef PUGIXML_HAS_LONG_LONG + PUGI__FN long long xml_text::as_llong(long long def) const + { + xml_node_struct* d = _data(); + + return (d && d->value) ? impl::get_value_llong(d->value) : def; + } + + PUGI__FN unsigned long long xml_text::as_ullong(unsigned long long def) const + { + xml_node_struct* d = _data(); + + return (d && d->value) ? impl::get_value_ullong(d->value) : def; + } +#endif + + PUGI__FN bool xml_text::set(const char_t* rhs) + { + xml_node_struct* dn = _data_new(); + + return dn ? impl::strcpy_insitu(dn->value, dn->header, impl::xml_memory_page_value_allocated_mask, rhs, impl::strlength(rhs)) : false; + } + + PUGI__FN bool xml_text::set(int rhs) + { + xml_node_struct* dn = _data_new(); + + return dn ? impl::set_value_integer(dn->value, dn->header, impl::xml_memory_page_value_allocated_mask, rhs, rhs < 0) : false; + } + + PUGI__FN bool xml_text::set(unsigned int rhs) + { + xml_node_struct* dn = _data_new(); + + return dn ? impl::set_value_integer(dn->value, dn->header, impl::xml_memory_page_value_allocated_mask, rhs, false) : false; + } + + PUGI__FN bool xml_text::set(long rhs) + { + xml_node_struct* dn = _data_new(); + + return dn ? impl::set_value_integer(dn->value, dn->header, impl::xml_memory_page_value_allocated_mask, rhs, rhs < 0) : false; + } + + PUGI__FN bool xml_text::set(unsigned long rhs) + { + xml_node_struct* dn = _data_new(); + + return dn ? impl::set_value_integer(dn->value, dn->header, impl::xml_memory_page_value_allocated_mask, rhs, false) : false; + } + + PUGI__FN bool xml_text::set(float rhs) + { + xml_node_struct* dn = _data_new(); + + return dn ? impl::set_value_convert(dn->value, dn->header, impl::xml_memory_page_value_allocated_mask, rhs) : false; + } + + PUGI__FN bool xml_text::set(double rhs) + { + xml_node_struct* dn = _data_new(); + + return dn ? impl::set_value_convert(dn->value, dn->header, impl::xml_memory_page_value_allocated_mask, rhs) : false; + } + + PUGI__FN bool xml_text::set(bool rhs) + { + xml_node_struct* dn = _data_new(); + + return dn ? impl::set_value_bool(dn->value, dn->header, impl::xml_memory_page_value_allocated_mask, rhs) : false; + } + +#ifdef PUGIXML_HAS_LONG_LONG + PUGI__FN bool xml_text::set(long long rhs) + { + xml_node_struct* dn = _data_new(); + + return dn ? impl::set_value_integer(dn->value, dn->header, impl::xml_memory_page_value_allocated_mask, rhs, rhs < 0) : false; + } + + PUGI__FN bool xml_text::set(unsigned long long rhs) + { + xml_node_struct* dn = _data_new(); + + return dn ? impl::set_value_integer(dn->value, dn->header, impl::xml_memory_page_value_allocated_mask, rhs, false) : false; + } +#endif + + PUGI__FN xml_text& xml_text::operator=(const char_t* rhs) + { + set(rhs); + return *this; + } + + PUGI__FN xml_text& xml_text::operator=(int rhs) + { + set(rhs); + return *this; + } + + PUGI__FN xml_text& xml_text::operator=(unsigned int rhs) + { + set(rhs); + return *this; + } + + PUGI__FN xml_text& xml_text::operator=(long rhs) + { + set(rhs); + return *this; + } + + PUGI__FN xml_text& xml_text::operator=(unsigned long rhs) + { + set(rhs); + return *this; + } + + PUGI__FN xml_text& xml_text::operator=(double rhs) + { + set(rhs); + return *this; + } + + PUGI__FN xml_text& xml_text::operator=(float rhs) + { + set(rhs); + return *this; + } + + PUGI__FN xml_text& xml_text::operator=(bool rhs) + { + set(rhs); + return *this; + } + +#ifdef PUGIXML_HAS_LONG_LONG + PUGI__FN xml_text& xml_text::operator=(long long rhs) + { + set(rhs); + return *this; + } + + PUGI__FN xml_text& xml_text::operator=(unsigned long long rhs) + { + set(rhs); + return *this; + } +#endif + + PUGI__FN xml_node xml_text::data() const + { + return xml_node(_data()); + } + +#ifdef __BORLANDC__ + PUGI__FN bool operator&&(const xml_text& lhs, bool rhs) + { + return (bool)lhs && rhs; + } + + PUGI__FN bool operator||(const xml_text& lhs, bool rhs) + { + return (bool)lhs || rhs; + } +#endif + + PUGI__FN xml_node_iterator::xml_node_iterator() + { + } + + PUGI__FN xml_node_iterator::xml_node_iterator(const xml_node& node): _wrap(node), _parent(node.parent()) + { + } + + PUGI__FN xml_node_iterator::xml_node_iterator(xml_node_struct* ref, xml_node_struct* parent): _wrap(ref), _parent(parent) + { + } + + PUGI__FN bool xml_node_iterator::operator==(const xml_node_iterator& rhs) const + { + return _wrap._root == rhs._wrap._root && _parent._root == rhs._parent._root; + } + + PUGI__FN bool xml_node_iterator::operator!=(const xml_node_iterator& rhs) const + { + return _wrap._root != rhs._wrap._root || _parent._root != rhs._parent._root; + } + + PUGI__FN xml_node& xml_node_iterator::operator*() const + { + assert(_wrap._root); + return _wrap; + } + + PUGI__FN xml_node* xml_node_iterator::operator->() const + { + assert(_wrap._root); + return const_cast(&_wrap); // BCC5 workaround + } + + PUGI__FN const xml_node_iterator& xml_node_iterator::operator++() + { + assert(_wrap._root); + _wrap._root = _wrap._root->next_sibling; + return *this; + } + + PUGI__FN xml_node_iterator xml_node_iterator::operator++(int) + { + xml_node_iterator temp = *this; + ++*this; + return temp; + } + + PUGI__FN const xml_node_iterator& xml_node_iterator::operator--() + { + _wrap = _wrap._root ? _wrap.previous_sibling() : _parent.last_child(); + return *this; + } + + PUGI__FN xml_node_iterator xml_node_iterator::operator--(int) + { + xml_node_iterator temp = *this; + --*this; + return temp; + } + + PUGI__FN xml_attribute_iterator::xml_attribute_iterator() + { + } + + PUGI__FN xml_attribute_iterator::xml_attribute_iterator(const xml_attribute& attr, const xml_node& parent): _wrap(attr), _parent(parent) + { + } + + PUGI__FN xml_attribute_iterator::xml_attribute_iterator(xml_attribute_struct* ref, xml_node_struct* parent): _wrap(ref), _parent(parent) + { + } + + PUGI__FN bool xml_attribute_iterator::operator==(const xml_attribute_iterator& rhs) const + { + return _wrap._attr == rhs._wrap._attr && _parent._root == rhs._parent._root; + } + + PUGI__FN bool xml_attribute_iterator::operator!=(const xml_attribute_iterator& rhs) const + { + return _wrap._attr != rhs._wrap._attr || _parent._root != rhs._parent._root; + } + + PUGI__FN xml_attribute& xml_attribute_iterator::operator*() const + { + assert(_wrap._attr); + return _wrap; + } + + PUGI__FN xml_attribute* xml_attribute_iterator::operator->() const + { + assert(_wrap._attr); + return const_cast(&_wrap); // BCC5 workaround + } + + PUGI__FN const xml_attribute_iterator& xml_attribute_iterator::operator++() + { + assert(_wrap._attr); + _wrap._attr = _wrap._attr->next_attribute; + return *this; + } + + PUGI__FN xml_attribute_iterator xml_attribute_iterator::operator++(int) + { + xml_attribute_iterator temp = *this; + ++*this; + return temp; + } + + PUGI__FN const xml_attribute_iterator& xml_attribute_iterator::operator--() + { + _wrap = _wrap._attr ? _wrap.previous_attribute() : _parent.last_attribute(); + return *this; + } + + PUGI__FN xml_attribute_iterator xml_attribute_iterator::operator--(int) + { + xml_attribute_iterator temp = *this; + --*this; + return temp; + } + + PUGI__FN xml_named_node_iterator::xml_named_node_iterator(): _name(0) + { + } + + PUGI__FN xml_named_node_iterator::xml_named_node_iterator(const xml_node& node, const char_t* name): _wrap(node), _parent(node.parent()), _name(name) + { + } + + PUGI__FN xml_named_node_iterator::xml_named_node_iterator(xml_node_struct* ref, xml_node_struct* parent, const char_t* name): _wrap(ref), _parent(parent), _name(name) + { + } + + PUGI__FN bool xml_named_node_iterator::operator==(const xml_named_node_iterator& rhs) const + { + return _wrap._root == rhs._wrap._root && _parent._root == rhs._parent._root; + } + + PUGI__FN bool xml_named_node_iterator::operator!=(const xml_named_node_iterator& rhs) const + { + return _wrap._root != rhs._wrap._root || _parent._root != rhs._parent._root; + } + + PUGI__FN xml_node& xml_named_node_iterator::operator*() const + { + assert(_wrap._root); + return _wrap; + } + + PUGI__FN xml_node* xml_named_node_iterator::operator->() const + { + assert(_wrap._root); + return const_cast(&_wrap); // BCC5 workaround + } + + PUGI__FN const xml_named_node_iterator& xml_named_node_iterator::operator++() + { + assert(_wrap._root); + _wrap = _wrap.next_sibling(_name); + return *this; + } + + PUGI__FN xml_named_node_iterator xml_named_node_iterator::operator++(int) + { + xml_named_node_iterator temp = *this; + ++*this; + return temp; + } + + PUGI__FN const xml_named_node_iterator& xml_named_node_iterator::operator--() + { + if (_wrap._root) + _wrap = _wrap.previous_sibling(_name); + else + { + _wrap = _parent.last_child(); + + if (!impl::strequal(_wrap.name(), _name)) + _wrap = _wrap.previous_sibling(_name); + } + + return *this; + } + + PUGI__FN xml_named_node_iterator xml_named_node_iterator::operator--(int) + { + xml_named_node_iterator temp = *this; + --*this; + return temp; + } + + PUGI__FN xml_parse_result::xml_parse_result(): status(status_internal_error), offset(0), encoding(encoding_auto) + { + } + + PUGI__FN xml_parse_result::operator bool() const + { + return status == status_ok; + } + + PUGI__FN const char* xml_parse_result::description() const + { + switch (status) + { + case status_ok: return "No error"; + + case status_file_not_found: return "File was not found"; + case status_io_error: return "Error reading from file/stream"; + case status_out_of_memory: return "Could not allocate memory"; + case status_internal_error: return "Internal error occurred"; + + case status_unrecognized_tag: return "Could not determine tag type"; + + case status_bad_pi: return "Error parsing document declaration/processing instruction"; + case status_bad_comment: return "Error parsing comment"; + case status_bad_cdata: return "Error parsing CDATA section"; + case status_bad_doctype: return "Error parsing document type declaration"; + case status_bad_pcdata: return "Error parsing PCDATA section"; + case status_bad_start_element: return "Error parsing start element tag"; + case status_bad_attribute: return "Error parsing element attribute"; + case status_bad_end_element: return "Error parsing end element tag"; + case status_end_element_mismatch: return "Start-end tags mismatch"; + + case status_append_invalid_root: return "Unable to append nodes: root is not an element or document"; + + case status_no_document_element: return "No document element found"; + + default: return "Unknown error"; + } + } + + PUGI__FN xml_document::xml_document(): _buffer(0) + { + _create(); + } + + PUGI__FN xml_document::~xml_document() + { + _destroy(); + } + + PUGI__FN void xml_document::reset() + { + _destroy(); + _create(); + } + + PUGI__FN void xml_document::reset(const xml_document& proto) + { + reset(); + + for (xml_node cur = proto.first_child(); cur; cur = cur.next_sibling()) + append_copy(cur); + } + + PUGI__FN void xml_document::_create() + { + assert(!_root); + + #ifdef PUGIXML_COMPACT + const size_t page_offset = sizeof(uint32_t); + #else + const size_t page_offset = 0; + #endif + + // initialize sentinel page + PUGI__STATIC_ASSERT(sizeof(impl::xml_memory_page) + sizeof(impl::xml_document_struct) + page_offset <= sizeof(_memory)); + + // prepare page structure + impl::xml_memory_page* page = impl::xml_memory_page::construct(_memory); + assert(page); + + page->busy_size = impl::xml_memory_page_size; + + // setup first page marker + #ifdef PUGIXML_COMPACT + // round-trip through void* to avoid 'cast increases required alignment of target type' warning + page->compact_page_marker = reinterpret_cast(static_cast(reinterpret_cast(page) + sizeof(impl::xml_memory_page))); + *page->compact_page_marker = sizeof(impl::xml_memory_page); + #endif + + // allocate new root + _root = new (reinterpret_cast(page) + sizeof(impl::xml_memory_page) + page_offset) impl::xml_document_struct(page); + _root->prev_sibling_c = _root; + + // setup sentinel page + page->allocator = static_cast(_root); + + // setup hash table pointer in allocator + #ifdef PUGIXML_COMPACT + page->allocator->_hash = &static_cast(_root)->hash; + #endif + + // verify the document allocation + assert(reinterpret_cast(_root) + sizeof(impl::xml_document_struct) <= _memory + sizeof(_memory)); + } + + PUGI__FN void xml_document::_destroy() + { + assert(_root); + + // destroy static storage + if (_buffer) + { + impl::xml_memory::deallocate(_buffer); + _buffer = 0; + } + + // destroy extra buffers (note: no need to destroy linked list nodes, they're allocated using document allocator) + for (impl::xml_extra_buffer* extra = static_cast(_root)->extra_buffers; extra; extra = extra->next) + { + if (extra->buffer) impl::xml_memory::deallocate(extra->buffer); + } + + // destroy dynamic storage, leave sentinel page (it's in static memory) + impl::xml_memory_page* root_page = PUGI__GETPAGE(_root); + assert(root_page && !root_page->prev); + assert(reinterpret_cast(root_page) >= _memory && reinterpret_cast(root_page) < _memory + sizeof(_memory)); + + for (impl::xml_memory_page* page = root_page->next; page; ) + { + impl::xml_memory_page* next = page->next; + + impl::xml_allocator::deallocate_page(page); + + page = next; + } + + #ifdef PUGIXML_COMPACT + // destroy hash table + static_cast(_root)->hash.clear(); + #endif + + _root = 0; + } + +#ifndef PUGIXML_NO_STL + PUGI__FN xml_parse_result xml_document::load(std::basic_istream >& stream, unsigned int options, xml_encoding encoding) + { + reset(); + + return impl::load_stream_impl(static_cast(_root), stream, options, encoding, &_buffer); + } + + PUGI__FN xml_parse_result xml_document::load(std::basic_istream >& stream, unsigned int options) + { + reset(); + + return impl::load_stream_impl(static_cast(_root), stream, options, encoding_wchar, &_buffer); + } +#endif + + PUGI__FN xml_parse_result xml_document::load_string(const char_t* contents, unsigned int options) + { + // Force native encoding (skip autodetection) + #ifdef PUGIXML_WCHAR_MODE + xml_encoding encoding = encoding_wchar; + #else + xml_encoding encoding = encoding_utf8; + #endif + + return load_buffer(contents, impl::strlength(contents) * sizeof(char_t), options, encoding); + } + + PUGI__FN xml_parse_result xml_document::load(const char_t* contents, unsigned int options) + { + return load_string(contents, options); + } + + PUGI__FN xml_parse_result xml_document::load_file(const char* path_, unsigned int options, xml_encoding encoding) + { + reset(); + + using impl::auto_deleter; // MSVC7 workaround + auto_deleter file(fopen(path_, "rb"), impl::close_file); + + return impl::load_file_impl(static_cast(_root), file.data, options, encoding, &_buffer); + } + + PUGI__FN xml_parse_result xml_document::load_file(const wchar_t* path_, unsigned int options, xml_encoding encoding) + { + reset(); + + using impl::auto_deleter; // MSVC7 workaround + auto_deleter file(impl::open_file_wide(path_, L"rb"), impl::close_file); + + return impl::load_file_impl(static_cast(_root), file.data, options, encoding, &_buffer); + } + + PUGI__FN xml_parse_result xml_document::load_buffer(const void* contents, size_t size, unsigned int options, xml_encoding encoding) + { + reset(); + + return impl::load_buffer_impl(static_cast(_root), _root, const_cast(contents), size, options, encoding, false, false, &_buffer); + } + + PUGI__FN xml_parse_result xml_document::load_buffer_inplace(void* contents, size_t size, unsigned int options, xml_encoding encoding) + { + reset(); + + return impl::load_buffer_impl(static_cast(_root), _root, contents, size, options, encoding, true, false, &_buffer); + } + + PUGI__FN xml_parse_result xml_document::load_buffer_inplace_own(void* contents, size_t size, unsigned int options, xml_encoding encoding) + { + reset(); + + return impl::load_buffer_impl(static_cast(_root), _root, contents, size, options, encoding, true, true, &_buffer); + } + + PUGI__FN void xml_document::save(xml_writer& writer, const char_t* indent, unsigned int flags, xml_encoding encoding) const + { + impl::xml_buffered_writer buffered_writer(writer, encoding); + + if ((flags & format_write_bom) && encoding != encoding_latin1) + { + // BOM always represents the codepoint U+FEFF, so just write it in native encoding + #ifdef PUGIXML_WCHAR_MODE + unsigned int bom = 0xfeff; + buffered_writer.write(static_cast(bom)); + #else + buffered_writer.write('\xef', '\xbb', '\xbf'); + #endif + } + + if (!(flags & format_no_declaration) && !impl::has_declaration(_root)) + { + buffered_writer.write_string(PUGIXML_TEXT("'); + if (!(flags & format_raw)) buffered_writer.write('\n'); + } + + impl::node_output(buffered_writer, _root, indent, flags, 0); + + buffered_writer.flush(); + } + +#ifndef PUGIXML_NO_STL + PUGI__FN void xml_document::save(std::basic_ostream >& stream, const char_t* indent, unsigned int flags, xml_encoding encoding) const + { + xml_writer_stream writer(stream); + + save(writer, indent, flags, encoding); + } + + PUGI__FN void xml_document::save(std::basic_ostream >& stream, const char_t* indent, unsigned int flags) const + { + xml_writer_stream writer(stream); + + save(writer, indent, flags, encoding_wchar); + } +#endif + + PUGI__FN bool xml_document::save_file(const char* path_, const char_t* indent, unsigned int flags, xml_encoding encoding) const + { + using impl::auto_deleter; // MSVC7 workaround + auto_deleter file(fopen(path_, (flags & format_save_file_text) ? "w" : "wb"), impl::close_file); + + return impl::save_file_impl(*this, file.data, indent, flags, encoding); + } + + PUGI__FN bool xml_document::save_file(const wchar_t* path_, const char_t* indent, unsigned int flags, xml_encoding encoding) const + { + using impl::auto_deleter; // MSVC7 workaround + auto_deleter file(impl::open_file_wide(path_, (flags & format_save_file_text) ? L"w" : L"wb"), impl::close_file); + + return impl::save_file_impl(*this, file.data, indent, flags, encoding); + } + + PUGI__FN xml_node xml_document::document_element() const + { + assert(_root); + + for (xml_node_struct* i = _root->first_child; i; i = i->next_sibling) + if (PUGI__NODETYPE(i) == node_element) + return xml_node(i); + + return xml_node(); + } + +#ifndef PUGIXML_NO_STL + PUGI__FN std::string PUGIXML_FUNCTION as_utf8(const wchar_t* str) + { + assert(str); + + return impl::as_utf8_impl(str, impl::strlength_wide(str)); + } + + PUGI__FN std::string PUGIXML_FUNCTION as_utf8(const std::basic_string& str) + { + return impl::as_utf8_impl(str.c_str(), str.size()); + } + + PUGI__FN std::basic_string PUGIXML_FUNCTION as_wide(const char* str) + { + assert(str); + + return impl::as_wide_impl(str, strlen(str)); + } + + PUGI__FN std::basic_string PUGIXML_FUNCTION as_wide(const std::string& str) + { + return impl::as_wide_impl(str.c_str(), str.size()); + } +#endif + + PUGI__FN void PUGIXML_FUNCTION set_memory_management_functions(allocation_function allocate, deallocation_function deallocate) + { + impl::xml_memory::allocate = allocate; + impl::xml_memory::deallocate = deallocate; + } + + PUGI__FN allocation_function PUGIXML_FUNCTION get_memory_allocation_function() + { + return impl::xml_memory::allocate; + } + + PUGI__FN deallocation_function PUGIXML_FUNCTION get_memory_deallocation_function() + { + return impl::xml_memory::deallocate; + } +} + +#if !defined(PUGIXML_NO_STL) && (defined(_MSC_VER) || defined(__ICC)) +namespace std +{ + // Workarounds for (non-standard) iterator category detection for older versions (MSVC7/IC8 and earlier) + PUGI__FN std::bidirectional_iterator_tag _Iter_cat(const pugi::xml_node_iterator&) + { + return std::bidirectional_iterator_tag(); + } + + PUGI__FN std::bidirectional_iterator_tag _Iter_cat(const pugi::xml_attribute_iterator&) + { + return std::bidirectional_iterator_tag(); + } + + PUGI__FN std::bidirectional_iterator_tag _Iter_cat(const pugi::xml_named_node_iterator&) + { + return std::bidirectional_iterator_tag(); + } +} +#endif + +#if !defined(PUGIXML_NO_STL) && defined(__SUNPRO_CC) +namespace std +{ + // Workarounds for (non-standard) iterator category detection + PUGI__FN std::bidirectional_iterator_tag __iterator_category(const pugi::xml_node_iterator&) + { + return std::bidirectional_iterator_tag(); + } + + PUGI__FN std::bidirectional_iterator_tag __iterator_category(const pugi::xml_attribute_iterator&) + { + return std::bidirectional_iterator_tag(); + } + + PUGI__FN std::bidirectional_iterator_tag __iterator_category(const pugi::xml_named_node_iterator&) + { + return std::bidirectional_iterator_tag(); + } +} +#endif + +#ifndef PUGIXML_NO_XPATH +// STL replacements +PUGI__NS_BEGIN + struct equal_to + { + template bool operator()(const T& lhs, const T& rhs) const + { + return lhs == rhs; + } + }; + + struct not_equal_to + { + template bool operator()(const T& lhs, const T& rhs) const + { + return lhs != rhs; + } + }; + + struct less + { + template bool operator()(const T& lhs, const T& rhs) const + { + return lhs < rhs; + } + }; + + struct less_equal + { + template bool operator()(const T& lhs, const T& rhs) const + { + return lhs <= rhs; + } + }; + + template void swap(T& lhs, T& rhs) + { + T temp = lhs; + lhs = rhs; + rhs = temp; + } + + template I min_element(I begin, I end, const Pred& pred) + { + I result = begin; + + for (I it = begin + 1; it != end; ++it) + if (pred(*it, *result)) + result = it; + + return result; + } + + template void reverse(I begin, I end) + { + while (end - begin > 1) swap(*begin++, *--end); + } + + template I unique(I begin, I end) + { + // fast skip head + while (end - begin > 1 && *begin != *(begin + 1)) begin++; + + if (begin == end) return begin; + + // last written element + I write = begin++; + + // merge unique elements + while (begin != end) + { + if (*begin != *write) + *++write = *begin++; + else + begin++; + } + + // past-the-end (write points to live element) + return write + 1; + } + + template void copy_backwards(I begin, I end, I target) + { + while (begin != end) *--target = *--end; + } + + template void insertion_sort(I begin, I end, const Pred& pred, T*) + { + assert(begin != end); + + for (I it = begin + 1; it != end; ++it) + { + T val = *it; + + if (pred(val, *begin)) + { + // move to front + copy_backwards(begin, it, it + 1); + *begin = val; + } + else + { + I hole = it; + + // move hole backwards + while (pred(val, *(hole - 1))) + { + *hole = *(hole - 1); + hole--; + } + + // fill hole with element + *hole = val; + } + } + } + + // std variant for elements with == + template void partition(I begin, I middle, I end, const Pred& pred, I* out_eqbeg, I* out_eqend) + { + I eqbeg = middle, eqend = middle + 1; + + // expand equal range + while (eqbeg != begin && *(eqbeg - 1) == *eqbeg) --eqbeg; + while (eqend != end && *eqend == *eqbeg) ++eqend; + + // process outer elements + I ltend = eqbeg, gtbeg = eqend; + + for (;;) + { + // find the element from the right side that belongs to the left one + for (; gtbeg != end; ++gtbeg) + if (!pred(*eqbeg, *gtbeg)) + { + if (*gtbeg == *eqbeg) swap(*gtbeg, *eqend++); + else break; + } + + // find the element from the left side that belongs to the right one + for (; ltend != begin; --ltend) + if (!pred(*(ltend - 1), *eqbeg)) + { + if (*eqbeg == *(ltend - 1)) swap(*(ltend - 1), *--eqbeg); + else break; + } + + // scanned all elements + if (gtbeg == end && ltend == begin) + { + *out_eqbeg = eqbeg; + *out_eqend = eqend; + return; + } + + // make room for elements by moving equal area + if (gtbeg == end) + { + if (--ltend != --eqbeg) swap(*ltend, *eqbeg); + swap(*eqbeg, *--eqend); + } + else if (ltend == begin) + { + if (eqend != gtbeg) swap(*eqbeg, *eqend); + ++eqend; + swap(*gtbeg++, *eqbeg++); + } + else swap(*gtbeg++, *--ltend); + } + } + + template void median3(I first, I middle, I last, const Pred& pred) + { + if (pred(*middle, *first)) swap(*middle, *first); + if (pred(*last, *middle)) swap(*last, *middle); + if (pred(*middle, *first)) swap(*middle, *first); + } + + template void median(I first, I middle, I last, const Pred& pred) + { + if (last - first <= 40) + { + // median of three for small chunks + median3(first, middle, last, pred); + } + else + { + // median of nine + size_t step = (last - first + 1) / 8; + + median3(first, first + step, first + 2 * step, pred); + median3(middle - step, middle, middle + step, pred); + median3(last - 2 * step, last - step, last, pred); + median3(first + step, middle, last - step, pred); + } + } + + template void sort(I begin, I end, const Pred& pred) + { + // sort large chunks + while (end - begin > 32) + { + // find median element + I middle = begin + (end - begin) / 2; + median(begin, middle, end - 1, pred); + + // partition in three chunks (< = >) + I eqbeg, eqend; + partition(begin, middle, end, pred, &eqbeg, &eqend); + + // loop on larger half + if (eqbeg - begin > end - eqend) + { + sort(eqend, end, pred); + end = eqbeg; + } + else + { + sort(begin, eqbeg, pred); + begin = eqend; + } + } + + // insertion sort small chunk + if (begin != end) insertion_sort(begin, end, pred, &*begin); + } +PUGI__NS_END + +// Allocator used for AST and evaluation stacks +PUGI__NS_BEGIN + static const size_t xpath_memory_page_size = + #ifdef PUGIXML_MEMORY_XPATH_PAGE_SIZE + PUGIXML_MEMORY_XPATH_PAGE_SIZE + #else + 4096 + #endif + ; + + static const uintptr_t xpath_memory_block_alignment = sizeof(double) > sizeof(void*) ? sizeof(double) : sizeof(void*); + + struct xpath_memory_block + { + xpath_memory_block* next; + size_t capacity; + + union + { + char data[xpath_memory_page_size]; + double alignment; + }; + }; + + class xpath_allocator + { + xpath_memory_block* _root; + size_t _root_size; + + public: + #ifdef PUGIXML_NO_EXCEPTIONS + jmp_buf* error_handler; + #endif + + xpath_allocator(xpath_memory_block* root, size_t root_size = 0): _root(root), _root_size(root_size) + { + #ifdef PUGIXML_NO_EXCEPTIONS + error_handler = 0; + #endif + } + + void* allocate_nothrow(size_t size) + { + // round size up to block alignment boundary + size = (size + xpath_memory_block_alignment - 1) & ~(xpath_memory_block_alignment - 1); + + if (_root_size + size <= _root->capacity) + { + void* buf = &_root->data[0] + _root_size; + _root_size += size; + return buf; + } + else + { + // make sure we have at least 1/4th of the page free after allocation to satisfy subsequent allocation requests + size_t block_capacity_base = sizeof(_root->data); + size_t block_capacity_req = size + block_capacity_base / 4; + size_t block_capacity = (block_capacity_base > block_capacity_req) ? block_capacity_base : block_capacity_req; + + size_t block_size = block_capacity + offsetof(xpath_memory_block, data); + + xpath_memory_block* block = static_cast(xml_memory::allocate(block_size)); + if (!block) return 0; + + block->next = _root; + block->capacity = block_capacity; + + _root = block; + _root_size = size; + + return block->data; + } + } + + void* allocate(size_t size) + { + void* result = allocate_nothrow(size); + + if (!result) + { + #ifdef PUGIXML_NO_EXCEPTIONS + assert(error_handler); + longjmp(*error_handler, 1); + #else + throw std::bad_alloc(); + #endif + } + + return result; + } + + void* reallocate(void* ptr, size_t old_size, size_t new_size) + { + // round size up to block alignment boundary + old_size = (old_size + xpath_memory_block_alignment - 1) & ~(xpath_memory_block_alignment - 1); + new_size = (new_size + xpath_memory_block_alignment - 1) & ~(xpath_memory_block_alignment - 1); + + // we can only reallocate the last object + assert(ptr == 0 || static_cast(ptr) + old_size == &_root->data[0] + _root_size); + + // adjust root size so that we have not allocated the object at all + bool only_object = (_root_size == old_size); + + if (ptr) _root_size -= old_size; + + // allocate a new version (this will obviously reuse the memory if possible) + void* result = allocate(new_size); + assert(result); + + // we have a new block + if (result != ptr && ptr) + { + // copy old data + assert(new_size >= old_size); + memcpy(result, ptr, old_size); + + // free the previous page if it had no other objects + if (only_object) + { + assert(_root->data == result); + assert(_root->next); + + xpath_memory_block* next = _root->next->next; + + if (next) + { + // deallocate the whole page, unless it was the first one + xml_memory::deallocate(_root->next); + _root->next = next; + } + } + } + + return result; + } + + void revert(const xpath_allocator& state) + { + // free all new pages + xpath_memory_block* cur = _root; + + while (cur != state._root) + { + xpath_memory_block* next = cur->next; + + xml_memory::deallocate(cur); + + cur = next; + } + + // restore state + _root = state._root; + _root_size = state._root_size; + } + + void release() + { + xpath_memory_block* cur = _root; + assert(cur); + + while (cur->next) + { + xpath_memory_block* next = cur->next; + + xml_memory::deallocate(cur); + + cur = next; + } + } + }; + + struct xpath_allocator_capture + { + xpath_allocator_capture(xpath_allocator* alloc): _target(alloc), _state(*alloc) + { + } + + ~xpath_allocator_capture() + { + _target->revert(_state); + } + + xpath_allocator* _target; + xpath_allocator _state; + }; + + struct xpath_stack + { + xpath_allocator* result; + xpath_allocator* temp; + }; + + struct xpath_stack_data + { + xpath_memory_block blocks[2]; + xpath_allocator result; + xpath_allocator temp; + xpath_stack stack; + + #ifdef PUGIXML_NO_EXCEPTIONS + jmp_buf error_handler; + #endif + + xpath_stack_data(): result(blocks + 0), temp(blocks + 1) + { + blocks[0].next = blocks[1].next = 0; + blocks[0].capacity = blocks[1].capacity = sizeof(blocks[0].data); + + stack.result = &result; + stack.temp = &temp; + + #ifdef PUGIXML_NO_EXCEPTIONS + result.error_handler = temp.error_handler = &error_handler; + #endif + } + + ~xpath_stack_data() + { + result.release(); + temp.release(); + } + }; +PUGI__NS_END + +// String class +PUGI__NS_BEGIN + class xpath_string + { + const char_t* _buffer; + bool _uses_heap; + size_t _length_heap; + + static char_t* duplicate_string(const char_t* string, size_t length, xpath_allocator* alloc) + { + char_t* result = static_cast(alloc->allocate((length + 1) * sizeof(char_t))); + assert(result); + + memcpy(result, string, length * sizeof(char_t)); + result[length] = 0; + + return result; + } + + xpath_string(const char_t* buffer, bool uses_heap_, size_t length_heap): _buffer(buffer), _uses_heap(uses_heap_), _length_heap(length_heap) + { + } + + public: + static xpath_string from_const(const char_t* str) + { + return xpath_string(str, false, 0); + } + + static xpath_string from_heap_preallocated(const char_t* begin, const char_t* end) + { + assert(begin <= end && *end == 0); + + return xpath_string(begin, true, static_cast(end - begin)); + } + + static xpath_string from_heap(const char_t* begin, const char_t* end, xpath_allocator* alloc) + { + assert(begin <= end); + + size_t length = static_cast(end - begin); + + return length == 0 ? xpath_string() : xpath_string(duplicate_string(begin, length, alloc), true, length); + } + + xpath_string(): _buffer(PUGIXML_TEXT("")), _uses_heap(false), _length_heap(0) + { + } + + void append(const xpath_string& o, xpath_allocator* alloc) + { + // skip empty sources + if (!*o._buffer) return; + + // fast append for constant empty target and constant source + if (!*_buffer && !_uses_heap && !o._uses_heap) + { + _buffer = o._buffer; + } + else + { + // need to make heap copy + size_t target_length = length(); + size_t source_length = o.length(); + size_t result_length = target_length + source_length; + + // allocate new buffer + char_t* result = static_cast(alloc->reallocate(_uses_heap ? const_cast(_buffer) : 0, (target_length + 1) * sizeof(char_t), (result_length + 1) * sizeof(char_t))); + assert(result); + + // append first string to the new buffer in case there was no reallocation + if (!_uses_heap) memcpy(result, _buffer, target_length * sizeof(char_t)); + + // append second string to the new buffer + memcpy(result + target_length, o._buffer, source_length * sizeof(char_t)); + result[result_length] = 0; + + // finalize + _buffer = result; + _uses_heap = true; + _length_heap = result_length; + } + } + + const char_t* c_str() const + { + return _buffer; + } + + size_t length() const + { + return _uses_heap ? _length_heap : strlength(_buffer); + } + + char_t* data(xpath_allocator* alloc) + { + // make private heap copy + if (!_uses_heap) + { + size_t length_ = strlength(_buffer); + + _buffer = duplicate_string(_buffer, length_, alloc); + _uses_heap = true; + _length_heap = length_; + } + + return const_cast(_buffer); + } + + bool empty() const + { + return *_buffer == 0; + } + + bool operator==(const xpath_string& o) const + { + return strequal(_buffer, o._buffer); + } + + bool operator!=(const xpath_string& o) const + { + return !strequal(_buffer, o._buffer); + } + + bool uses_heap() const + { + return _uses_heap; + } + }; +PUGI__NS_END + +PUGI__NS_BEGIN + PUGI__FN bool starts_with(const char_t* string, const char_t* pattern) + { + while (*pattern && *string == *pattern) + { + string++; + pattern++; + } + + return *pattern == 0; + } + + PUGI__FN const char_t* find_char(const char_t* s, char_t c) + { + #ifdef PUGIXML_WCHAR_MODE + return wcschr(s, c); + #else + return strchr(s, c); + #endif + } + + PUGI__FN const char_t* find_substring(const char_t* s, const char_t* p) + { + #ifdef PUGIXML_WCHAR_MODE + // MSVC6 wcsstr bug workaround (if s is empty it always returns 0) + return (*p == 0) ? s : wcsstr(s, p); + #else + return strstr(s, p); + #endif + } + + // Converts symbol to lower case, if it is an ASCII one + PUGI__FN char_t tolower_ascii(char_t ch) + { + return static_cast(ch - 'A') < 26 ? static_cast(ch | ' ') : ch; + } + + PUGI__FN xpath_string string_value(const xpath_node& na, xpath_allocator* alloc) + { + if (na.attribute()) + return xpath_string::from_const(na.attribute().value()); + else + { + xml_node n = na.node(); + + switch (n.type()) + { + case node_pcdata: + case node_cdata: + case node_comment: + case node_pi: + return xpath_string::from_const(n.value()); + + case node_document: + case node_element: + { + xpath_string result; + + // element nodes can have value if parse_embed_pcdata was used + if (n.value()[0]) + result.append(xpath_string::from_const(n.value()), alloc); + + xml_node cur = n.first_child(); + + while (cur && cur != n) + { + if (cur.type() == node_pcdata || cur.type() == node_cdata) + result.append(xpath_string::from_const(cur.value()), alloc); + + if (cur.first_child()) + cur = cur.first_child(); + else if (cur.next_sibling()) + cur = cur.next_sibling(); + else + { + while (!cur.next_sibling() && cur != n) + cur = cur.parent(); + + if (cur != n) cur = cur.next_sibling(); + } + } + + return result; + } + + default: + return xpath_string(); + } + } + } + + PUGI__FN bool node_is_before_sibling(xml_node_struct* ln, xml_node_struct* rn) + { + assert(ln->parent == rn->parent); + + // there is no common ancestor (the shared parent is null), nodes are from different documents + if (!ln->parent) return ln < rn; + + // determine sibling order + xml_node_struct* ls = ln; + xml_node_struct* rs = rn; + + while (ls && rs) + { + if (ls == rn) return true; + if (rs == ln) return false; + + ls = ls->next_sibling; + rs = rs->next_sibling; + } + + // if rn sibling chain ended ln must be before rn + return !rs; + } + + PUGI__FN bool node_is_before(xml_node_struct* ln, xml_node_struct* rn) + { + // find common ancestor at the same depth, if any + xml_node_struct* lp = ln; + xml_node_struct* rp = rn; + + while (lp && rp && lp->parent != rp->parent) + { + lp = lp->parent; + rp = rp->parent; + } + + // parents are the same! + if (lp && rp) return node_is_before_sibling(lp, rp); + + // nodes are at different depths, need to normalize heights + bool left_higher = !lp; + + while (lp) + { + lp = lp->parent; + ln = ln->parent; + } + + while (rp) + { + rp = rp->parent; + rn = rn->parent; + } + + // one node is the ancestor of the other + if (ln == rn) return left_higher; + + // find common ancestor... again + while (ln->parent != rn->parent) + { + ln = ln->parent; + rn = rn->parent; + } + + return node_is_before_sibling(ln, rn); + } + + PUGI__FN bool node_is_ancestor(xml_node_struct* parent, xml_node_struct* node) + { + while (node && node != parent) node = node->parent; + + return parent && node == parent; + } + + PUGI__FN const void* document_buffer_order(const xpath_node& xnode) + { + xml_node_struct* node = xnode.node().internal_object(); + + if (node) + { + if ((get_document(node).header & xml_memory_page_contents_shared_mask) == 0) + { + if (node->name && (node->header & impl::xml_memory_page_name_allocated_or_shared_mask) == 0) return node->name; + if (node->value && (node->header & impl::xml_memory_page_value_allocated_or_shared_mask) == 0) return node->value; + } + + return 0; + } + + xml_attribute_struct* attr = xnode.attribute().internal_object(); + + if (attr) + { + if ((get_document(attr).header & xml_memory_page_contents_shared_mask) == 0) + { + if ((attr->header & impl::xml_memory_page_name_allocated_or_shared_mask) == 0) return attr->name; + if ((attr->header & impl::xml_memory_page_value_allocated_or_shared_mask) == 0) return attr->value; + } + + return 0; + } + + return 0; + } + + struct document_order_comparator + { + bool operator()(const xpath_node& lhs, const xpath_node& rhs) const + { + // optimized document order based check + const void* lo = document_buffer_order(lhs); + const void* ro = document_buffer_order(rhs); + + if (lo && ro) return lo < ro; + + // slow comparison + xml_node ln = lhs.node(), rn = rhs.node(); + + // compare attributes + if (lhs.attribute() && rhs.attribute()) + { + // shared parent + if (lhs.parent() == rhs.parent()) + { + // determine sibling order + for (xml_attribute a = lhs.attribute(); a; a = a.next_attribute()) + if (a == rhs.attribute()) + return true; + + return false; + } + + // compare attribute parents + ln = lhs.parent(); + rn = rhs.parent(); + } + else if (lhs.attribute()) + { + // attributes go after the parent element + if (lhs.parent() == rhs.node()) return false; + + ln = lhs.parent(); + } + else if (rhs.attribute()) + { + // attributes go after the parent element + if (rhs.parent() == lhs.node()) return true; + + rn = rhs.parent(); + } + + if (ln == rn) return false; + + if (!ln || !rn) return ln < rn; + + return node_is_before(ln.internal_object(), rn.internal_object()); + } + }; + + struct duplicate_comparator + { + bool operator()(const xpath_node& lhs, const xpath_node& rhs) const + { + if (lhs.attribute()) return rhs.attribute() ? lhs.attribute() < rhs.attribute() : true; + else return rhs.attribute() ? false : lhs.node() < rhs.node(); + } + }; + + PUGI__FN double gen_nan() + { + #if defined(__STDC_IEC_559__) || ((FLT_RADIX - 0 == 2) && (FLT_MAX_EXP - 0 == 128) && (FLT_MANT_DIG - 0 == 24)) + PUGI__STATIC_ASSERT(sizeof(float) == sizeof(uint32_t)); + typedef uint32_t UI; // BCC5 workaround + union { float f; UI i; } u; + u.i = 0x7fc00000; + return u.f; + #else + // fallback + const volatile double zero = 0.0; + return zero / zero; + #endif + } + + PUGI__FN bool is_nan(double value) + { + #if defined(PUGI__MSVC_CRT_VERSION) || defined(__BORLANDC__) + return !!_isnan(value); + #elif defined(fpclassify) && defined(FP_NAN) + return fpclassify(value) == FP_NAN; + #else + // fallback + const volatile double v = value; + return v != v; + #endif + } + + PUGI__FN const char_t* convert_number_to_string_special(double value) + { + #if defined(PUGI__MSVC_CRT_VERSION) || defined(__BORLANDC__) + if (_finite(value)) return (value == 0) ? PUGIXML_TEXT("0") : 0; + if (_isnan(value)) return PUGIXML_TEXT("NaN"); + return value > 0 ? PUGIXML_TEXT("Infinity") : PUGIXML_TEXT("-Infinity"); + #elif defined(fpclassify) && defined(FP_NAN) && defined(FP_INFINITE) && defined(FP_ZERO) + switch (fpclassify(value)) + { + case FP_NAN: + return PUGIXML_TEXT("NaN"); + + case FP_INFINITE: + return value > 0 ? PUGIXML_TEXT("Infinity") : PUGIXML_TEXT("-Infinity"); + + case FP_ZERO: + return PUGIXML_TEXT("0"); + + default: + return 0; + } + #else + // fallback + const volatile double v = value; + + if (v == 0) return PUGIXML_TEXT("0"); + if (v != v) return PUGIXML_TEXT("NaN"); + if (v * 2 == v) return value > 0 ? PUGIXML_TEXT("Infinity") : PUGIXML_TEXT("-Infinity"); + return 0; + #endif + } + + PUGI__FN bool convert_number_to_boolean(double value) + { + return (value != 0 && !is_nan(value)); + } + + PUGI__FN void truncate_zeros(char* begin, char* end) + { + while (begin != end && end[-1] == '0') end--; + + *end = 0; + } + + // gets mantissa digits in the form of 0.xxxxx with 0. implied and the exponent +#if defined(PUGI__MSVC_CRT_VERSION) && PUGI__MSVC_CRT_VERSION >= 1400 && !defined(_WIN32_WCE) + PUGI__FN void convert_number_to_mantissa_exponent(double value, char* buffer, size_t buffer_size, char** out_mantissa, int* out_exponent) + { + // get base values + int sign, exponent; + _ecvt_s(buffer, buffer_size, value, DBL_DIG + 1, &exponent, &sign); + + // truncate redundant zeros + truncate_zeros(buffer, buffer + strlen(buffer)); + + // fill results + *out_mantissa = buffer; + *out_exponent = exponent; + } +#else + PUGI__FN void convert_number_to_mantissa_exponent(double value, char* buffer, size_t buffer_size, char** out_mantissa, int* out_exponent) + { + // get a scientific notation value with IEEE DBL_DIG decimals + sprintf(buffer, "%.*e", DBL_DIG, value); + assert(strlen(buffer) < buffer_size); + (void)!buffer_size; + + // get the exponent (possibly negative) + char* exponent_string = strchr(buffer, 'e'); + assert(exponent_string); + + int exponent = atoi(exponent_string + 1); + + // extract mantissa string: skip sign + char* mantissa = buffer[0] == '-' ? buffer + 1 : buffer; + assert(mantissa[0] != '0' && mantissa[1] == '.'); + + // divide mantissa by 10 to eliminate integer part + mantissa[1] = mantissa[0]; + mantissa++; + exponent++; + + // remove extra mantissa digits and zero-terminate mantissa + truncate_zeros(mantissa, exponent_string); + + // fill results + *out_mantissa = mantissa; + *out_exponent = exponent; + } +#endif + + PUGI__FN xpath_string convert_number_to_string(double value, xpath_allocator* alloc) + { + // try special number conversion + const char_t* special = convert_number_to_string_special(value); + if (special) return xpath_string::from_const(special); + + // get mantissa + exponent form + char mantissa_buffer[32]; + + char* mantissa; + int exponent; + convert_number_to_mantissa_exponent(value, mantissa_buffer, sizeof(mantissa_buffer), &mantissa, &exponent); + + // allocate a buffer of suitable length for the number + size_t result_size = strlen(mantissa_buffer) + (exponent > 0 ? exponent : -exponent) + 4; + char_t* result = static_cast(alloc->allocate(sizeof(char_t) * result_size)); + assert(result); + + // make the number! + char_t* s = result; + + // sign + if (value < 0) *s++ = '-'; + + // integer part + if (exponent <= 0) + { + *s++ = '0'; + } + else + { + while (exponent > 0) + { + assert(*mantissa == 0 || static_cast(static_cast(*mantissa) - '0') <= 9); + *s++ = *mantissa ? *mantissa++ : '0'; + exponent--; + } + } + + // fractional part + if (*mantissa) + { + // decimal point + *s++ = '.'; + + // extra zeroes from negative exponent + while (exponent < 0) + { + *s++ = '0'; + exponent++; + } + + // extra mantissa digits + while (*mantissa) + { + assert(static_cast(*mantissa - '0') <= 9); + *s++ = *mantissa++; + } + } + + // zero-terminate + assert(s < result + result_size); + *s = 0; + + return xpath_string::from_heap_preallocated(result, s); + } + + PUGI__FN bool check_string_to_number_format(const char_t* string) + { + // parse leading whitespace + while (PUGI__IS_CHARTYPE(*string, ct_space)) ++string; + + // parse sign + if (*string == '-') ++string; + + if (!*string) return false; + + // if there is no integer part, there should be a decimal part with at least one digit + if (!PUGI__IS_CHARTYPEX(string[0], ctx_digit) && (string[0] != '.' || !PUGI__IS_CHARTYPEX(string[1], ctx_digit))) return false; + + // parse integer part + while (PUGI__IS_CHARTYPEX(*string, ctx_digit)) ++string; + + // parse decimal part + if (*string == '.') + { + ++string; + + while (PUGI__IS_CHARTYPEX(*string, ctx_digit)) ++string; + } + + // parse trailing whitespace + while (PUGI__IS_CHARTYPE(*string, ct_space)) ++string; + + return *string == 0; + } + + PUGI__FN double convert_string_to_number(const char_t* string) + { + // check string format + if (!check_string_to_number_format(string)) return gen_nan(); + + // parse string + #ifdef PUGIXML_WCHAR_MODE + return wcstod(string, 0); + #else + return strtod(string, 0); + #endif + } + + PUGI__FN bool convert_string_to_number_scratch(char_t (&buffer)[32], const char_t* begin, const char_t* end, double* out_result) + { + size_t length = static_cast(end - begin); + char_t* scratch = buffer; + + if (length >= sizeof(buffer) / sizeof(buffer[0])) + { + // need to make dummy on-heap copy + scratch = static_cast(xml_memory::allocate((length + 1) * sizeof(char_t))); + if (!scratch) return false; + } + + // copy string to zero-terminated buffer and perform conversion + memcpy(scratch, begin, length * sizeof(char_t)); + scratch[length] = 0; + + *out_result = convert_string_to_number(scratch); + + // free dummy buffer + if (scratch != buffer) xml_memory::deallocate(scratch); + + return true; + } + + PUGI__FN double round_nearest(double value) + { + return floor(value + 0.5); + } + + PUGI__FN double round_nearest_nzero(double value) + { + // same as round_nearest, but returns -0 for [-0.5, -0] + // ceil is used to differentiate between +0 and -0 (we return -0 for [-0.5, -0] and +0 for +0) + return (value >= -0.5 && value <= 0) ? ceil(value) : floor(value + 0.5); + } + + PUGI__FN const char_t* qualified_name(const xpath_node& node) + { + return node.attribute() ? node.attribute().name() : node.node().name(); + } + + PUGI__FN const char_t* local_name(const xpath_node& node) + { + const char_t* name = qualified_name(node); + const char_t* p = find_char(name, ':'); + + return p ? p + 1 : name; + } + + struct namespace_uri_predicate + { + const char_t* prefix; + size_t prefix_length; + + namespace_uri_predicate(const char_t* name) + { + const char_t* pos = find_char(name, ':'); + + prefix = pos ? name : 0; + prefix_length = pos ? static_cast(pos - name) : 0; + } + + bool operator()(xml_attribute a) const + { + const char_t* name = a.name(); + + if (!starts_with(name, PUGIXML_TEXT("xmlns"))) return false; + + return prefix ? name[5] == ':' && strequalrange(name + 6, prefix, prefix_length) : name[5] == 0; + } + }; + + PUGI__FN const char_t* namespace_uri(xml_node node) + { + namespace_uri_predicate pred = node.name(); + + xml_node p = node; + + while (p) + { + xml_attribute a = p.find_attribute(pred); + + if (a) return a.value(); + + p = p.parent(); + } + + return PUGIXML_TEXT(""); + } + + PUGI__FN const char_t* namespace_uri(xml_attribute attr, xml_node parent) + { + namespace_uri_predicate pred = attr.name(); + + // Default namespace does not apply to attributes + if (!pred.prefix) return PUGIXML_TEXT(""); + + xml_node p = parent; + + while (p) + { + xml_attribute a = p.find_attribute(pred); + + if (a) return a.value(); + + p = p.parent(); + } + + return PUGIXML_TEXT(""); + } + + PUGI__FN const char_t* namespace_uri(const xpath_node& node) + { + return node.attribute() ? namespace_uri(node.attribute(), node.parent()) : namespace_uri(node.node()); + } + + PUGI__FN char_t* normalize_space(char_t* buffer) + { + char_t* write = buffer; + + for (char_t* it = buffer; *it; ) + { + char_t ch = *it++; + + if (PUGI__IS_CHARTYPE(ch, ct_space)) + { + // replace whitespace sequence with single space + while (PUGI__IS_CHARTYPE(*it, ct_space)) it++; + + // avoid leading spaces + if (write != buffer) *write++ = ' '; + } + else *write++ = ch; + } + + // remove trailing space + if (write != buffer && PUGI__IS_CHARTYPE(write[-1], ct_space)) write--; + + // zero-terminate + *write = 0; + + return write; + } + + PUGI__FN char_t* translate(char_t* buffer, const char_t* from, const char_t* to, size_t to_length) + { + char_t* write = buffer; + + while (*buffer) + { + PUGI__DMC_VOLATILE char_t ch = *buffer++; + + const char_t* pos = find_char(from, ch); + + if (!pos) + *write++ = ch; // do not process + else if (static_cast(pos - from) < to_length) + *write++ = to[pos - from]; // replace + } + + // zero-terminate + *write = 0; + + return write; + } + + PUGI__FN unsigned char* translate_table_generate(xpath_allocator* alloc, const char_t* from, const char_t* to) + { + unsigned char table[128] = {0}; + + while (*from) + { + unsigned int fc = static_cast(*from); + unsigned int tc = static_cast(*to); + + if (fc >= 128 || tc >= 128) + return 0; + + // code=128 means "skip character" + if (!table[fc]) + table[fc] = static_cast(tc ? tc : 128); + + from++; + if (tc) to++; + } + + for (int i = 0; i < 128; ++i) + if (!table[i]) + table[i] = static_cast(i); + + void* result = alloc->allocate_nothrow(sizeof(table)); + + if (result) + { + memcpy(result, table, sizeof(table)); + } + + return static_cast(result); + } + + PUGI__FN char_t* translate_table(char_t* buffer, const unsigned char* table) + { + char_t* write = buffer; + + while (*buffer) + { + char_t ch = *buffer++; + unsigned int index = static_cast(ch); + + if (index < 128) + { + unsigned char code = table[index]; + + // code=128 means "skip character" (table size is 128 so 128 can be a special value) + // this code skips these characters without extra branches + *write = static_cast(code); + write += 1 - (code >> 7); + } + else + { + *write++ = ch; + } + } + + // zero-terminate + *write = 0; + + return write; + } + + inline bool is_xpath_attribute(const char_t* name) + { + return !(starts_with(name, PUGIXML_TEXT("xmlns")) && (name[5] == 0 || name[5] == ':')); + } + + struct xpath_variable_boolean: xpath_variable + { + xpath_variable_boolean(): xpath_variable(xpath_type_boolean), value(false) + { + } + + bool value; + char_t name[1]; + }; + + struct xpath_variable_number: xpath_variable + { + xpath_variable_number(): xpath_variable(xpath_type_number), value(0) + { + } + + double value; + char_t name[1]; + }; + + struct xpath_variable_string: xpath_variable + { + xpath_variable_string(): xpath_variable(xpath_type_string), value(0) + { + } + + ~xpath_variable_string() + { + if (value) xml_memory::deallocate(value); + } + + char_t* value; + char_t name[1]; + }; + + struct xpath_variable_node_set: xpath_variable + { + xpath_variable_node_set(): xpath_variable(xpath_type_node_set) + { + } + + xpath_node_set value; + char_t name[1]; + }; + + static const xpath_node_set dummy_node_set; + + PUGI__FN unsigned int hash_string(const char_t* str) + { + // Jenkins one-at-a-time hash (http://en.wikipedia.org/wiki/Jenkins_hash_function#one-at-a-time) + unsigned int result = 0; + + while (*str) + { + result += static_cast(*str++); + result += result << 10; + result ^= result >> 6; + } + + result += result << 3; + result ^= result >> 11; + result += result << 15; + + return result; + } + + template PUGI__FN T* new_xpath_variable(const char_t* name) + { + size_t length = strlength(name); + if (length == 0) return 0; // empty variable names are invalid + + // $$ we can't use offsetof(T, name) because T is non-POD, so we just allocate additional length characters + void* memory = xml_memory::allocate(sizeof(T) + length * sizeof(char_t)); + if (!memory) return 0; + + T* result = new (memory) T(); + + memcpy(result->name, name, (length + 1) * sizeof(char_t)); + + return result; + } + + PUGI__FN xpath_variable* new_xpath_variable(xpath_value_type type, const char_t* name) + { + switch (type) + { + case xpath_type_node_set: + return new_xpath_variable(name); + + case xpath_type_number: + return new_xpath_variable(name); + + case xpath_type_string: + return new_xpath_variable(name); + + case xpath_type_boolean: + return new_xpath_variable(name); + + default: + return 0; + } + } + + template PUGI__FN void delete_xpath_variable(T* var) + { + var->~T(); + xml_memory::deallocate(var); + } + + PUGI__FN void delete_xpath_variable(xpath_value_type type, xpath_variable* var) + { + switch (type) + { + case xpath_type_node_set: + delete_xpath_variable(static_cast(var)); + break; + + case xpath_type_number: + delete_xpath_variable(static_cast(var)); + break; + + case xpath_type_string: + delete_xpath_variable(static_cast(var)); + break; + + case xpath_type_boolean: + delete_xpath_variable(static_cast(var)); + break; + + default: + assert(false && "Invalid variable type"); + } + } + + PUGI__FN bool copy_xpath_variable(xpath_variable* lhs, const xpath_variable* rhs) + { + switch (rhs->type()) + { + case xpath_type_node_set: + return lhs->set(static_cast(rhs)->value); + + case xpath_type_number: + return lhs->set(static_cast(rhs)->value); + + case xpath_type_string: + return lhs->set(static_cast(rhs)->value); + + case xpath_type_boolean: + return lhs->set(static_cast(rhs)->value); + + default: + assert(false && "Invalid variable type"); + return false; + } + } + + PUGI__FN bool get_variable_scratch(char_t (&buffer)[32], xpath_variable_set* set, const char_t* begin, const char_t* end, xpath_variable** out_result) + { + size_t length = static_cast(end - begin); + char_t* scratch = buffer; + + if (length >= sizeof(buffer) / sizeof(buffer[0])) + { + // need to make dummy on-heap copy + scratch = static_cast(xml_memory::allocate((length + 1) * sizeof(char_t))); + if (!scratch) return false; + } + + // copy string to zero-terminated buffer and perform lookup + memcpy(scratch, begin, length * sizeof(char_t)); + scratch[length] = 0; + + *out_result = set->get(scratch); + + // free dummy buffer + if (scratch != buffer) xml_memory::deallocate(scratch); + + return true; + } +PUGI__NS_END + +// Internal node set class +PUGI__NS_BEGIN + PUGI__FN xpath_node_set::type_t xpath_get_order(const xpath_node* begin, const xpath_node* end) + { + if (end - begin < 2) + return xpath_node_set::type_sorted; + + document_order_comparator cmp; + + bool first = cmp(begin[0], begin[1]); + + for (const xpath_node* it = begin + 1; it + 1 < end; ++it) + if (cmp(it[0], it[1]) != first) + return xpath_node_set::type_unsorted; + + return first ? xpath_node_set::type_sorted : xpath_node_set::type_sorted_reverse; + } + + PUGI__FN xpath_node_set::type_t xpath_sort(xpath_node* begin, xpath_node* end, xpath_node_set::type_t type, bool rev) + { + xpath_node_set::type_t order = rev ? xpath_node_set::type_sorted_reverse : xpath_node_set::type_sorted; + + if (type == xpath_node_set::type_unsorted) + { + xpath_node_set::type_t sorted = xpath_get_order(begin, end); + + if (sorted == xpath_node_set::type_unsorted) + { + sort(begin, end, document_order_comparator()); + + type = xpath_node_set::type_sorted; + } + else + type = sorted; + } + + if (type != order) reverse(begin, end); + + return order; + } + + PUGI__FN xpath_node xpath_first(const xpath_node* begin, const xpath_node* end, xpath_node_set::type_t type) + { + if (begin == end) return xpath_node(); + + switch (type) + { + case xpath_node_set::type_sorted: + return *begin; + + case xpath_node_set::type_sorted_reverse: + return *(end - 1); + + case xpath_node_set::type_unsorted: + return *min_element(begin, end, document_order_comparator()); + + default: + assert(false && "Invalid node set type"); + return xpath_node(); + } + } + + class xpath_node_set_raw + { + xpath_node_set::type_t _type; + + xpath_node* _begin; + xpath_node* _end; + xpath_node* _eos; + + public: + xpath_node_set_raw(): _type(xpath_node_set::type_unsorted), _begin(0), _end(0), _eos(0) + { + } + + xpath_node* begin() const + { + return _begin; + } + + xpath_node* end() const + { + return _end; + } + + bool empty() const + { + return _begin == _end; + } + + size_t size() const + { + return static_cast(_end - _begin); + } + + xpath_node first() const + { + return xpath_first(_begin, _end, _type); + } + + void push_back_grow(const xpath_node& node, xpath_allocator* alloc); + + void push_back(const xpath_node& node, xpath_allocator* alloc) + { + if (_end != _eos) + *_end++ = node; + else + push_back_grow(node, alloc); + } + + void append(const xpath_node* begin_, const xpath_node* end_, xpath_allocator* alloc) + { + if (begin_ == end_) return; + + size_t size_ = static_cast(_end - _begin); + size_t capacity = static_cast(_eos - _begin); + size_t count = static_cast(end_ - begin_); + + if (size_ + count > capacity) + { + // reallocate the old array or allocate a new one + xpath_node* data = static_cast(alloc->reallocate(_begin, capacity * sizeof(xpath_node), (size_ + count) * sizeof(xpath_node))); + assert(data); + + // finalize + _begin = data; + _end = data + size_; + _eos = data + size_ + count; + } + + memcpy(_end, begin_, count * sizeof(xpath_node)); + _end += count; + } + + void sort_do() + { + _type = xpath_sort(_begin, _end, _type, false); + } + + void truncate(xpath_node* pos) + { + assert(_begin <= pos && pos <= _end); + + _end = pos; + } + + void remove_duplicates() + { + if (_type == xpath_node_set::type_unsorted) + sort(_begin, _end, duplicate_comparator()); + + _end = unique(_begin, _end); + } + + xpath_node_set::type_t type() const + { + return _type; + } + + void set_type(xpath_node_set::type_t value) + { + _type = value; + } + }; + + PUGI__FN_NO_INLINE void xpath_node_set_raw::push_back_grow(const xpath_node& node, xpath_allocator* alloc) + { + size_t capacity = static_cast(_eos - _begin); + + // get new capacity (1.5x rule) + size_t new_capacity = capacity + capacity / 2 + 1; + + // reallocate the old array or allocate a new one + xpath_node* data = static_cast(alloc->reallocate(_begin, capacity * sizeof(xpath_node), new_capacity * sizeof(xpath_node))); + assert(data); + + // finalize + _begin = data; + _end = data + capacity; + _eos = data + new_capacity; + + // push + *_end++ = node; + } +PUGI__NS_END + +PUGI__NS_BEGIN + struct xpath_context + { + xpath_node n; + size_t position, size; + + xpath_context(const xpath_node& n_, size_t position_, size_t size_): n(n_), position(position_), size(size_) + { + } + }; + + enum lexeme_t + { + lex_none = 0, + lex_equal, + lex_not_equal, + lex_less, + lex_greater, + lex_less_or_equal, + lex_greater_or_equal, + lex_plus, + lex_minus, + lex_multiply, + lex_union, + lex_var_ref, + lex_open_brace, + lex_close_brace, + lex_quoted_string, + lex_number, + lex_slash, + lex_double_slash, + lex_open_square_brace, + lex_close_square_brace, + lex_string, + lex_comma, + lex_axis_attribute, + lex_dot, + lex_double_dot, + lex_double_colon, + lex_eof + }; + + struct xpath_lexer_string + { + const char_t* begin; + const char_t* end; + + xpath_lexer_string(): begin(0), end(0) + { + } + + bool operator==(const char_t* other) const + { + size_t length = static_cast(end - begin); + + return strequalrange(other, begin, length); + } + }; + + class xpath_lexer + { + const char_t* _cur; + const char_t* _cur_lexeme_pos; + xpath_lexer_string _cur_lexeme_contents; + + lexeme_t _cur_lexeme; + + public: + explicit xpath_lexer(const char_t* query): _cur(query) + { + next(); + } + + const char_t* state() const + { + return _cur; + } + + void next() + { + const char_t* cur = _cur; + + while (PUGI__IS_CHARTYPE(*cur, ct_space)) ++cur; + + // save lexeme position for error reporting + _cur_lexeme_pos = cur; + + switch (*cur) + { + case 0: + _cur_lexeme = lex_eof; + break; + + case '>': + if (*(cur+1) == '=') + { + cur += 2; + _cur_lexeme = lex_greater_or_equal; + } + else + { + cur += 1; + _cur_lexeme = lex_greater; + } + break; + + case '<': + if (*(cur+1) == '=') + { + cur += 2; + _cur_lexeme = lex_less_or_equal; + } + else + { + cur += 1; + _cur_lexeme = lex_less; + } + break; + + case '!': + if (*(cur+1) == '=') + { + cur += 2; + _cur_lexeme = lex_not_equal; + } + else + { + _cur_lexeme = lex_none; + } + break; + + case '=': + cur += 1; + _cur_lexeme = lex_equal; + + break; + + case '+': + cur += 1; + _cur_lexeme = lex_plus; + + break; + + case '-': + cur += 1; + _cur_lexeme = lex_minus; + + break; + + case '*': + cur += 1; + _cur_lexeme = lex_multiply; + + break; + + case '|': + cur += 1; + _cur_lexeme = lex_union; + + break; + + case '$': + cur += 1; + + if (PUGI__IS_CHARTYPEX(*cur, ctx_start_symbol)) + { + _cur_lexeme_contents.begin = cur; + + while (PUGI__IS_CHARTYPEX(*cur, ctx_symbol)) cur++; + + if (cur[0] == ':' && PUGI__IS_CHARTYPEX(cur[1], ctx_symbol)) // qname + { + cur++; // : + + while (PUGI__IS_CHARTYPEX(*cur, ctx_symbol)) cur++; + } + + _cur_lexeme_contents.end = cur; + + _cur_lexeme = lex_var_ref; + } + else + { + _cur_lexeme = lex_none; + } + + break; + + case '(': + cur += 1; + _cur_lexeme = lex_open_brace; + + break; + + case ')': + cur += 1; + _cur_lexeme = lex_close_brace; + + break; + + case '[': + cur += 1; + _cur_lexeme = lex_open_square_brace; + + break; + + case ']': + cur += 1; + _cur_lexeme = lex_close_square_brace; + + break; + + case ',': + cur += 1; + _cur_lexeme = lex_comma; + + break; + + case '/': + if (*(cur+1) == '/') + { + cur += 2; + _cur_lexeme = lex_double_slash; + } + else + { + cur += 1; + _cur_lexeme = lex_slash; + } + break; + + case '.': + if (*(cur+1) == '.') + { + cur += 2; + _cur_lexeme = lex_double_dot; + } + else if (PUGI__IS_CHARTYPEX(*(cur+1), ctx_digit)) + { + _cur_lexeme_contents.begin = cur; // . + + ++cur; + + while (PUGI__IS_CHARTYPEX(*cur, ctx_digit)) cur++; + + _cur_lexeme_contents.end = cur; + + _cur_lexeme = lex_number; + } + else + { + cur += 1; + _cur_lexeme = lex_dot; + } + break; + + case '@': + cur += 1; + _cur_lexeme = lex_axis_attribute; + + break; + + case '"': + case '\'': + { + char_t terminator = *cur; + + ++cur; + + _cur_lexeme_contents.begin = cur; + while (*cur && *cur != terminator) cur++; + _cur_lexeme_contents.end = cur; + + if (!*cur) + _cur_lexeme = lex_none; + else + { + cur += 1; + _cur_lexeme = lex_quoted_string; + } + + break; + } + + case ':': + if (*(cur+1) == ':') + { + cur += 2; + _cur_lexeme = lex_double_colon; + } + else + { + _cur_lexeme = lex_none; + } + break; + + default: + if (PUGI__IS_CHARTYPEX(*cur, ctx_digit)) + { + _cur_lexeme_contents.begin = cur; + + while (PUGI__IS_CHARTYPEX(*cur, ctx_digit)) cur++; + + if (*cur == '.') + { + cur++; + + while (PUGI__IS_CHARTYPEX(*cur, ctx_digit)) cur++; + } + + _cur_lexeme_contents.end = cur; + + _cur_lexeme = lex_number; + } + else if (PUGI__IS_CHARTYPEX(*cur, ctx_start_symbol)) + { + _cur_lexeme_contents.begin = cur; + + while (PUGI__IS_CHARTYPEX(*cur, ctx_symbol)) cur++; + + if (cur[0] == ':') + { + if (cur[1] == '*') // namespace test ncname:* + { + cur += 2; // :* + } + else if (PUGI__IS_CHARTYPEX(cur[1], ctx_symbol)) // namespace test qname + { + cur++; // : + + while (PUGI__IS_CHARTYPEX(*cur, ctx_symbol)) cur++; + } + } + + _cur_lexeme_contents.end = cur; + + _cur_lexeme = lex_string; + } + else + { + _cur_lexeme = lex_none; + } + } + + _cur = cur; + } + + lexeme_t current() const + { + return _cur_lexeme; + } + + const char_t* current_pos() const + { + return _cur_lexeme_pos; + } + + const xpath_lexer_string& contents() const + { + assert(_cur_lexeme == lex_var_ref || _cur_lexeme == lex_number || _cur_lexeme == lex_string || _cur_lexeme == lex_quoted_string); + + return _cur_lexeme_contents; + } + }; + + enum ast_type_t + { + ast_unknown, + ast_op_or, // left or right + ast_op_and, // left and right + ast_op_equal, // left = right + ast_op_not_equal, // left != right + ast_op_less, // left < right + ast_op_greater, // left > right + ast_op_less_or_equal, // left <= right + ast_op_greater_or_equal, // left >= right + ast_op_add, // left + right + ast_op_subtract, // left - right + ast_op_multiply, // left * right + ast_op_divide, // left / right + ast_op_mod, // left % right + ast_op_negate, // left - right + ast_op_union, // left | right + ast_predicate, // apply predicate to set; next points to next predicate + ast_filter, // select * from left where right + ast_string_constant, // string constant + ast_number_constant, // number constant + ast_variable, // variable + ast_func_last, // last() + ast_func_position, // position() + ast_func_count, // count(left) + ast_func_id, // id(left) + ast_func_local_name_0, // local-name() + ast_func_local_name_1, // local-name(left) + ast_func_namespace_uri_0, // namespace-uri() + ast_func_namespace_uri_1, // namespace-uri(left) + ast_func_name_0, // name() + ast_func_name_1, // name(left) + ast_func_string_0, // string() + ast_func_string_1, // string(left) + ast_func_concat, // concat(left, right, siblings) + ast_func_starts_with, // starts_with(left, right) + ast_func_contains, // contains(left, right) + ast_func_substring_before, // substring-before(left, right) + ast_func_substring_after, // substring-after(left, right) + ast_func_substring_2, // substring(left, right) + ast_func_substring_3, // substring(left, right, third) + ast_func_string_length_0, // string-length() + ast_func_string_length_1, // string-length(left) + ast_func_normalize_space_0, // normalize-space() + ast_func_normalize_space_1, // normalize-space(left) + ast_func_translate, // translate(left, right, third) + ast_func_boolean, // boolean(left) + ast_func_not, // not(left) + ast_func_true, // true() + ast_func_false, // false() + ast_func_lang, // lang(left) + ast_func_number_0, // number() + ast_func_number_1, // number(left) + ast_func_sum, // sum(left) + ast_func_floor, // floor(left) + ast_func_ceiling, // ceiling(left) + ast_func_round, // round(left) + ast_step, // process set left with step + ast_step_root, // select root node + + ast_opt_translate_table, // translate(left, right, third) where right/third are constants + ast_opt_compare_attribute // @name = 'string' + }; + + enum axis_t + { + axis_ancestor, + axis_ancestor_or_self, + axis_attribute, + axis_child, + axis_descendant, + axis_descendant_or_self, + axis_following, + axis_following_sibling, + axis_namespace, + axis_parent, + axis_preceding, + axis_preceding_sibling, + axis_self + }; + + enum nodetest_t + { + nodetest_none, + nodetest_name, + nodetest_type_node, + nodetest_type_comment, + nodetest_type_pi, + nodetest_type_text, + nodetest_pi, + nodetest_all, + nodetest_all_in_namespace + }; + + enum predicate_t + { + predicate_default, + predicate_posinv, + predicate_constant, + predicate_constant_one + }; + + enum nodeset_eval_t + { + nodeset_eval_all, + nodeset_eval_any, + nodeset_eval_first + }; + + template struct axis_to_type + { + static const axis_t axis; + }; + + template const axis_t axis_to_type::axis = N; + + class xpath_ast_node + { + private: + // node type + char _type; + char _rettype; + + // for ast_step + char _axis; + + // for ast_step/ast_predicate/ast_filter + char _test; + + // tree node structure + xpath_ast_node* _left; + xpath_ast_node* _right; + xpath_ast_node* _next; + + union + { + // value for ast_string_constant + const char_t* string; + // value for ast_number_constant + double number; + // variable for ast_variable + xpath_variable* variable; + // node test for ast_step (node name/namespace/node type/pi target) + const char_t* nodetest; + // table for ast_opt_translate_table + const unsigned char* table; + } _data; + + xpath_ast_node(const xpath_ast_node&); + xpath_ast_node& operator=(const xpath_ast_node&); + + template static bool compare_eq(xpath_ast_node* lhs, xpath_ast_node* rhs, const xpath_context& c, const xpath_stack& stack, const Comp& comp) + { + xpath_value_type lt = lhs->rettype(), rt = rhs->rettype(); + + if (lt != xpath_type_node_set && rt != xpath_type_node_set) + { + if (lt == xpath_type_boolean || rt == xpath_type_boolean) + return comp(lhs->eval_boolean(c, stack), rhs->eval_boolean(c, stack)); + else if (lt == xpath_type_number || rt == xpath_type_number) + return comp(lhs->eval_number(c, stack), rhs->eval_number(c, stack)); + else if (lt == xpath_type_string || rt == xpath_type_string) + { + xpath_allocator_capture cr(stack.result); + + xpath_string ls = lhs->eval_string(c, stack); + xpath_string rs = rhs->eval_string(c, stack); + + return comp(ls, rs); + } + } + else if (lt == xpath_type_node_set && rt == xpath_type_node_set) + { + xpath_allocator_capture cr(stack.result); + + xpath_node_set_raw ls = lhs->eval_node_set(c, stack, nodeset_eval_all); + xpath_node_set_raw rs = rhs->eval_node_set(c, stack, nodeset_eval_all); + + for (const xpath_node* li = ls.begin(); li != ls.end(); ++li) + for (const xpath_node* ri = rs.begin(); ri != rs.end(); ++ri) + { + xpath_allocator_capture cri(stack.result); + + if (comp(string_value(*li, stack.result), string_value(*ri, stack.result))) + return true; + } + + return false; + } + else + { + if (lt == xpath_type_node_set) + { + swap(lhs, rhs); + swap(lt, rt); + } + + if (lt == xpath_type_boolean) + return comp(lhs->eval_boolean(c, stack), rhs->eval_boolean(c, stack)); + else if (lt == xpath_type_number) + { + xpath_allocator_capture cr(stack.result); + + double l = lhs->eval_number(c, stack); + xpath_node_set_raw rs = rhs->eval_node_set(c, stack, nodeset_eval_all); + + for (const xpath_node* ri = rs.begin(); ri != rs.end(); ++ri) + { + xpath_allocator_capture cri(stack.result); + + if (comp(l, convert_string_to_number(string_value(*ri, stack.result).c_str()))) + return true; + } + + return false; + } + else if (lt == xpath_type_string) + { + xpath_allocator_capture cr(stack.result); + + xpath_string l = lhs->eval_string(c, stack); + xpath_node_set_raw rs = rhs->eval_node_set(c, stack, nodeset_eval_all); + + for (const xpath_node* ri = rs.begin(); ri != rs.end(); ++ri) + { + xpath_allocator_capture cri(stack.result); + + if (comp(l, string_value(*ri, stack.result))) + return true; + } + + return false; + } + } + + assert(false && "Wrong types"); + return false; + } + + static bool eval_once(xpath_node_set::type_t type, nodeset_eval_t eval) + { + return type == xpath_node_set::type_sorted ? eval != nodeset_eval_all : eval == nodeset_eval_any; + } + + template static bool compare_rel(xpath_ast_node* lhs, xpath_ast_node* rhs, const xpath_context& c, const xpath_stack& stack, const Comp& comp) + { + xpath_value_type lt = lhs->rettype(), rt = rhs->rettype(); + + if (lt != xpath_type_node_set && rt != xpath_type_node_set) + return comp(lhs->eval_number(c, stack), rhs->eval_number(c, stack)); + else if (lt == xpath_type_node_set && rt == xpath_type_node_set) + { + xpath_allocator_capture cr(stack.result); + + xpath_node_set_raw ls = lhs->eval_node_set(c, stack, nodeset_eval_all); + xpath_node_set_raw rs = rhs->eval_node_set(c, stack, nodeset_eval_all); + + for (const xpath_node* li = ls.begin(); li != ls.end(); ++li) + { + xpath_allocator_capture cri(stack.result); + + double l = convert_string_to_number(string_value(*li, stack.result).c_str()); + + for (const xpath_node* ri = rs.begin(); ri != rs.end(); ++ri) + { + xpath_allocator_capture crii(stack.result); + + if (comp(l, convert_string_to_number(string_value(*ri, stack.result).c_str()))) + return true; + } + } + + return false; + } + else if (lt != xpath_type_node_set && rt == xpath_type_node_set) + { + xpath_allocator_capture cr(stack.result); + + double l = lhs->eval_number(c, stack); + xpath_node_set_raw rs = rhs->eval_node_set(c, stack, nodeset_eval_all); + + for (const xpath_node* ri = rs.begin(); ri != rs.end(); ++ri) + { + xpath_allocator_capture cri(stack.result); + + if (comp(l, convert_string_to_number(string_value(*ri, stack.result).c_str()))) + return true; + } + + return false; + } + else if (lt == xpath_type_node_set && rt != xpath_type_node_set) + { + xpath_allocator_capture cr(stack.result); + + xpath_node_set_raw ls = lhs->eval_node_set(c, stack, nodeset_eval_all); + double r = rhs->eval_number(c, stack); + + for (const xpath_node* li = ls.begin(); li != ls.end(); ++li) + { + xpath_allocator_capture cri(stack.result); + + if (comp(convert_string_to_number(string_value(*li, stack.result).c_str()), r)) + return true; + } + + return false; + } + else + { + assert(false && "Wrong types"); + return false; + } + } + + static void apply_predicate_boolean(xpath_node_set_raw& ns, size_t first, xpath_ast_node* expr, const xpath_stack& stack, bool once) + { + assert(ns.size() >= first); + assert(expr->rettype() != xpath_type_number); + + size_t i = 1; + size_t size = ns.size() - first; + + xpath_node* last = ns.begin() + first; + + // remove_if... or well, sort of + for (xpath_node* it = last; it != ns.end(); ++it, ++i) + { + xpath_context c(*it, i, size); + + if (expr->eval_boolean(c, stack)) + { + *last++ = *it; + + if (once) break; + } + } + + ns.truncate(last); + } + + static void apply_predicate_number(xpath_node_set_raw& ns, size_t first, xpath_ast_node* expr, const xpath_stack& stack, bool once) + { + assert(ns.size() >= first); + assert(expr->rettype() == xpath_type_number); + + size_t i = 1; + size_t size = ns.size() - first; + + xpath_node* last = ns.begin() + first; + + // remove_if... or well, sort of + for (xpath_node* it = last; it != ns.end(); ++it, ++i) + { + xpath_context c(*it, i, size); + + if (expr->eval_number(c, stack) == i) + { + *last++ = *it; + + if (once) break; + } + } + + ns.truncate(last); + } + + static void apply_predicate_number_const(xpath_node_set_raw& ns, size_t first, xpath_ast_node* expr, const xpath_stack& stack) + { + assert(ns.size() >= first); + assert(expr->rettype() == xpath_type_number); + + size_t size = ns.size() - first; + + xpath_node* last = ns.begin() + first; + + xpath_context c(xpath_node(), 1, size); + + double er = expr->eval_number(c, stack); + + if (er >= 1.0 && er <= size) + { + size_t eri = static_cast(er); + + if (er == eri) + { + xpath_node r = last[eri - 1]; + + *last++ = r; + } + } + + ns.truncate(last); + } + + void apply_predicate(xpath_node_set_raw& ns, size_t first, const xpath_stack& stack, bool once) + { + if (ns.size() == first) return; + + assert(_type == ast_filter || _type == ast_predicate); + + if (_test == predicate_constant || _test == predicate_constant_one) + apply_predicate_number_const(ns, first, _right, stack); + else if (_right->rettype() == xpath_type_number) + apply_predicate_number(ns, first, _right, stack, once); + else + apply_predicate_boolean(ns, first, _right, stack, once); + } + + void apply_predicates(xpath_node_set_raw& ns, size_t first, const xpath_stack& stack, nodeset_eval_t eval) + { + if (ns.size() == first) return; + + bool last_once = eval_once(ns.type(), eval); + + for (xpath_ast_node* pred = _right; pred; pred = pred->_next) + pred->apply_predicate(ns, first, stack, !pred->_next && last_once); + } + + bool step_push(xpath_node_set_raw& ns, xml_attribute_struct* a, xml_node_struct* parent, xpath_allocator* alloc) + { + assert(a); + + const char_t* name = a->name ? a->name + 0 : PUGIXML_TEXT(""); + + switch (_test) + { + case nodetest_name: + if (strequal(name, _data.nodetest) && is_xpath_attribute(name)) + { + ns.push_back(xpath_node(xml_attribute(a), xml_node(parent)), alloc); + return true; + } + break; + + case nodetest_type_node: + case nodetest_all: + if (is_xpath_attribute(name)) + { + ns.push_back(xpath_node(xml_attribute(a), xml_node(parent)), alloc); + return true; + } + break; + + case nodetest_all_in_namespace: + if (starts_with(name, _data.nodetest) && is_xpath_attribute(name)) + { + ns.push_back(xpath_node(xml_attribute(a), xml_node(parent)), alloc); + return true; + } + break; + + default: + ; + } + + return false; + } + + bool step_push(xpath_node_set_raw& ns, xml_node_struct* n, xpath_allocator* alloc) + { + assert(n); + + xml_node_type type = PUGI__NODETYPE(n); + + switch (_test) + { + case nodetest_name: + if (type == node_element && n->name && strequal(n->name, _data.nodetest)) + { + ns.push_back(xml_node(n), alloc); + return true; + } + break; + + case nodetest_type_node: + ns.push_back(xml_node(n), alloc); + return true; + + case nodetest_type_comment: + if (type == node_comment) + { + ns.push_back(xml_node(n), alloc); + return true; + } + break; + + case nodetest_type_text: + if (type == node_pcdata || type == node_cdata) + { + ns.push_back(xml_node(n), alloc); + return true; + } + break; + + case nodetest_type_pi: + if (type == node_pi) + { + ns.push_back(xml_node(n), alloc); + return true; + } + break; + + case nodetest_pi: + if (type == node_pi && n->name && strequal(n->name, _data.nodetest)) + { + ns.push_back(xml_node(n), alloc); + return true; + } + break; + + case nodetest_all: + if (type == node_element) + { + ns.push_back(xml_node(n), alloc); + return true; + } + break; + + case nodetest_all_in_namespace: + if (type == node_element && n->name && starts_with(n->name, _data.nodetest)) + { + ns.push_back(xml_node(n), alloc); + return true; + } + break; + + default: + assert(false && "Unknown axis"); + } + + return false; + } + + template void step_fill(xpath_node_set_raw& ns, xml_node_struct* n, xpath_allocator* alloc, bool once, T) + { + const axis_t axis = T::axis; + + switch (axis) + { + case axis_attribute: + { + for (xml_attribute_struct* a = n->first_attribute; a; a = a->next_attribute) + if (step_push(ns, a, n, alloc) & once) + return; + + break; + } + + case axis_child: + { + for (xml_node_struct* c = n->first_child; c; c = c->next_sibling) + if (step_push(ns, c, alloc) & once) + return; + + break; + } + + case axis_descendant: + case axis_descendant_or_self: + { + if (axis == axis_descendant_or_self) + if (step_push(ns, n, alloc) & once) + return; + + xml_node_struct* cur = n->first_child; + + while (cur) + { + if (step_push(ns, cur, alloc) & once) + return; + + if (cur->first_child) + cur = cur->first_child; + else + { + while (!cur->next_sibling) + { + cur = cur->parent; + + if (cur == n) return; + } + + cur = cur->next_sibling; + } + } + + break; + } + + case axis_following_sibling: + { + for (xml_node_struct* c = n->next_sibling; c; c = c->next_sibling) + if (step_push(ns, c, alloc) & once) + return; + + break; + } + + case axis_preceding_sibling: + { + for (xml_node_struct* c = n->prev_sibling_c; c->next_sibling; c = c->prev_sibling_c) + if (step_push(ns, c, alloc) & once) + return; + + break; + } + + case axis_following: + { + xml_node_struct* cur = n; + + // exit from this node so that we don't include descendants + while (!cur->next_sibling) + { + cur = cur->parent; + + if (!cur) return; + } + + cur = cur->next_sibling; + + while (cur) + { + if (step_push(ns, cur, alloc) & once) + return; + + if (cur->first_child) + cur = cur->first_child; + else + { + while (!cur->next_sibling) + { + cur = cur->parent; + + if (!cur) return; + } + + cur = cur->next_sibling; + } + } + + break; + } + + case axis_preceding: + { + xml_node_struct* cur = n; + + // exit from this node so that we don't include descendants + while (!cur->prev_sibling_c->next_sibling) + { + cur = cur->parent; + + if (!cur) return; + } + + cur = cur->prev_sibling_c; + + while (cur) + { + if (cur->first_child) + cur = cur->first_child->prev_sibling_c; + else + { + // leaf node, can't be ancestor + if (step_push(ns, cur, alloc) & once) + return; + + while (!cur->prev_sibling_c->next_sibling) + { + cur = cur->parent; + + if (!cur) return; + + if (!node_is_ancestor(cur, n)) + if (step_push(ns, cur, alloc) & once) + return; + } + + cur = cur->prev_sibling_c; + } + } + + break; + } + + case axis_ancestor: + case axis_ancestor_or_self: + { + if (axis == axis_ancestor_or_self) + if (step_push(ns, n, alloc) & once) + return; + + xml_node_struct* cur = n->parent; + + while (cur) + { + if (step_push(ns, cur, alloc) & once) + return; + + cur = cur->parent; + } + + break; + } + + case axis_self: + { + step_push(ns, n, alloc); + + break; + } + + case axis_parent: + { + if (n->parent) + step_push(ns, n->parent, alloc); + + break; + } + + default: + assert(false && "Unimplemented axis"); + } + } + + template void step_fill(xpath_node_set_raw& ns, xml_attribute_struct* a, xml_node_struct* p, xpath_allocator* alloc, bool once, T v) + { + const axis_t axis = T::axis; + + switch (axis) + { + case axis_ancestor: + case axis_ancestor_or_self: + { + if (axis == axis_ancestor_or_self && _test == nodetest_type_node) // reject attributes based on principal node type test + if (step_push(ns, a, p, alloc) & once) + return; + + xml_node_struct* cur = p; + + while (cur) + { + if (step_push(ns, cur, alloc) & once) + return; + + cur = cur->parent; + } + + break; + } + + case axis_descendant_or_self: + case axis_self: + { + if (_test == nodetest_type_node) // reject attributes based on principal node type test + step_push(ns, a, p, alloc); + + break; + } + + case axis_following: + { + xml_node_struct* cur = p; + + while (cur) + { + if (cur->first_child) + cur = cur->first_child; + else + { + while (!cur->next_sibling) + { + cur = cur->parent; + + if (!cur) return; + } + + cur = cur->next_sibling; + } + + if (step_push(ns, cur, alloc) & once) + return; + } + + break; + } + + case axis_parent: + { + step_push(ns, p, alloc); + + break; + } + + case axis_preceding: + { + // preceding:: axis does not include attribute nodes and attribute ancestors (they are the same as parent's ancestors), so we can reuse node preceding + step_fill(ns, p, alloc, once, v); + break; + } + + default: + assert(false && "Unimplemented axis"); + } + } + + template void step_fill(xpath_node_set_raw& ns, const xpath_node& xn, xpath_allocator* alloc, bool once, T v) + { + const axis_t axis = T::axis; + const bool axis_has_attributes = (axis == axis_ancestor || axis == axis_ancestor_or_self || axis == axis_descendant_or_self || axis == axis_following || axis == axis_parent || axis == axis_preceding || axis == axis_self); + + if (xn.node()) + step_fill(ns, xn.node().internal_object(), alloc, once, v); + else if (axis_has_attributes && xn.attribute() && xn.parent()) + step_fill(ns, xn.attribute().internal_object(), xn.parent().internal_object(), alloc, once, v); + } + + template xpath_node_set_raw step_do(const xpath_context& c, const xpath_stack& stack, nodeset_eval_t eval, T v) + { + const axis_t axis = T::axis; + const bool axis_reverse = (axis == axis_ancestor || axis == axis_ancestor_or_self || axis == axis_preceding || axis == axis_preceding_sibling); + const xpath_node_set::type_t axis_type = axis_reverse ? xpath_node_set::type_sorted_reverse : xpath_node_set::type_sorted; + + bool once = + (axis == axis_attribute && _test == nodetest_name) || + (!_right && eval_once(axis_type, eval)) || + (_right && !_right->_next && _right->_test == predicate_constant_one); + + xpath_node_set_raw ns; + ns.set_type(axis_type); + + if (_left) + { + xpath_node_set_raw s = _left->eval_node_set(c, stack, nodeset_eval_all); + + // self axis preserves the original order + if (axis == axis_self) ns.set_type(s.type()); + + for (const xpath_node* it = s.begin(); it != s.end(); ++it) + { + size_t size = ns.size(); + + // in general, all axes generate elements in a particular order, but there is no order guarantee if axis is applied to two nodes + if (axis != axis_self && size != 0) ns.set_type(xpath_node_set::type_unsorted); + + step_fill(ns, *it, stack.result, once, v); + if (_right) apply_predicates(ns, size, stack, eval); + } + } + else + { + step_fill(ns, c.n, stack.result, once, v); + if (_right) apply_predicates(ns, 0, stack, eval); + } + + // child, attribute and self axes always generate unique set of nodes + // for other axis, if the set stayed sorted, it stayed unique because the traversal algorithms do not visit the same node twice + if (axis != axis_child && axis != axis_attribute && axis != axis_self && ns.type() == xpath_node_set::type_unsorted) + ns.remove_duplicates(); + + return ns; + } + + public: + xpath_ast_node(ast_type_t type, xpath_value_type rettype_, const char_t* value): + _type(static_cast(type)), _rettype(static_cast(rettype_)), _axis(0), _test(0), _left(0), _right(0), _next(0) + { + assert(type == ast_string_constant); + _data.string = value; + } + + xpath_ast_node(ast_type_t type, xpath_value_type rettype_, double value): + _type(static_cast(type)), _rettype(static_cast(rettype_)), _axis(0), _test(0), _left(0), _right(0), _next(0) + { + assert(type == ast_number_constant); + _data.number = value; + } + + xpath_ast_node(ast_type_t type, xpath_value_type rettype_, xpath_variable* value): + _type(static_cast(type)), _rettype(static_cast(rettype_)), _axis(0), _test(0), _left(0), _right(0), _next(0) + { + assert(type == ast_variable); + _data.variable = value; + } + + xpath_ast_node(ast_type_t type, xpath_value_type rettype_, xpath_ast_node* left = 0, xpath_ast_node* right = 0): + _type(static_cast(type)), _rettype(static_cast(rettype_)), _axis(0), _test(0), _left(left), _right(right), _next(0) + { + } + + xpath_ast_node(ast_type_t type, xpath_ast_node* left, axis_t axis, nodetest_t test, const char_t* contents): + _type(static_cast(type)), _rettype(xpath_type_node_set), _axis(static_cast(axis)), _test(static_cast(test)), _left(left), _right(0), _next(0) + { + assert(type == ast_step); + _data.nodetest = contents; + } + + xpath_ast_node(ast_type_t type, xpath_ast_node* left, xpath_ast_node* right, predicate_t test): + _type(static_cast(type)), _rettype(xpath_type_node_set), _axis(0), _test(static_cast(test)), _left(left), _right(right), _next(0) + { + assert(type == ast_filter || type == ast_predicate); + } + + void set_next(xpath_ast_node* value) + { + _next = value; + } + + void set_right(xpath_ast_node* value) + { + _right = value; + } + + bool eval_boolean(const xpath_context& c, const xpath_stack& stack) + { + switch (_type) + { + case ast_op_or: + return _left->eval_boolean(c, stack) || _right->eval_boolean(c, stack); + + case ast_op_and: + return _left->eval_boolean(c, stack) && _right->eval_boolean(c, stack); + + case ast_op_equal: + return compare_eq(_left, _right, c, stack, equal_to()); + + case ast_op_not_equal: + return compare_eq(_left, _right, c, stack, not_equal_to()); + + case ast_op_less: + return compare_rel(_left, _right, c, stack, less()); + + case ast_op_greater: + return compare_rel(_right, _left, c, stack, less()); + + case ast_op_less_or_equal: + return compare_rel(_left, _right, c, stack, less_equal()); + + case ast_op_greater_or_equal: + return compare_rel(_right, _left, c, stack, less_equal()); + + case ast_func_starts_with: + { + xpath_allocator_capture cr(stack.result); + + xpath_string lr = _left->eval_string(c, stack); + xpath_string rr = _right->eval_string(c, stack); + + return starts_with(lr.c_str(), rr.c_str()); + } + + case ast_func_contains: + { + xpath_allocator_capture cr(stack.result); + + xpath_string lr = _left->eval_string(c, stack); + xpath_string rr = _right->eval_string(c, stack); + + return find_substring(lr.c_str(), rr.c_str()) != 0; + } + + case ast_func_boolean: + return _left->eval_boolean(c, stack); + + case ast_func_not: + return !_left->eval_boolean(c, stack); + + case ast_func_true: + return true; + + case ast_func_false: + return false; + + case ast_func_lang: + { + if (c.n.attribute()) return false; + + xpath_allocator_capture cr(stack.result); + + xpath_string lang = _left->eval_string(c, stack); + + for (xml_node n = c.n.node(); n; n = n.parent()) + { + xml_attribute a = n.attribute(PUGIXML_TEXT("xml:lang")); + + if (a) + { + const char_t* value = a.value(); + + // strnicmp / strncasecmp is not portable + for (const char_t* lit = lang.c_str(); *lit; ++lit) + { + if (tolower_ascii(*lit) != tolower_ascii(*value)) return false; + ++value; + } + + return *value == 0 || *value == '-'; + } + } + + return false; + } + + case ast_opt_compare_attribute: + { + const char_t* value = (_right->_type == ast_string_constant) ? _right->_data.string : _right->_data.variable->get_string(); + + xml_attribute attr = c.n.node().attribute(_left->_data.nodetest); + + return attr && strequal(attr.value(), value) && is_xpath_attribute(attr.name()); + } + + case ast_variable: + { + assert(_rettype == _data.variable->type()); + + if (_rettype == xpath_type_boolean) + return _data.variable->get_boolean(); + + // fallthrough to type conversion + } + + default: + { + switch (_rettype) + { + case xpath_type_number: + return convert_number_to_boolean(eval_number(c, stack)); + + case xpath_type_string: + { + xpath_allocator_capture cr(stack.result); + + return !eval_string(c, stack).empty(); + } + + case xpath_type_node_set: + { + xpath_allocator_capture cr(stack.result); + + return !eval_node_set(c, stack, nodeset_eval_any).empty(); + } + + default: + assert(false && "Wrong expression for return type boolean"); + return false; + } + } + } + } + + double eval_number(const xpath_context& c, const xpath_stack& stack) + { + switch (_type) + { + case ast_op_add: + return _left->eval_number(c, stack) + _right->eval_number(c, stack); + + case ast_op_subtract: + return _left->eval_number(c, stack) - _right->eval_number(c, stack); + + case ast_op_multiply: + return _left->eval_number(c, stack) * _right->eval_number(c, stack); + + case ast_op_divide: + return _left->eval_number(c, stack) / _right->eval_number(c, stack); + + case ast_op_mod: + return fmod(_left->eval_number(c, stack), _right->eval_number(c, stack)); + + case ast_op_negate: + return -_left->eval_number(c, stack); + + case ast_number_constant: + return _data.number; + + case ast_func_last: + return static_cast(c.size); + + case ast_func_position: + return static_cast(c.position); + + case ast_func_count: + { + xpath_allocator_capture cr(stack.result); + + return static_cast(_left->eval_node_set(c, stack, nodeset_eval_all).size()); + } + + case ast_func_string_length_0: + { + xpath_allocator_capture cr(stack.result); + + return static_cast(string_value(c.n, stack.result).length()); + } + + case ast_func_string_length_1: + { + xpath_allocator_capture cr(stack.result); + + return static_cast(_left->eval_string(c, stack).length()); + } + + case ast_func_number_0: + { + xpath_allocator_capture cr(stack.result); + + return convert_string_to_number(string_value(c.n, stack.result).c_str()); + } + + case ast_func_number_1: + return _left->eval_number(c, stack); + + case ast_func_sum: + { + xpath_allocator_capture cr(stack.result); + + double r = 0; + + xpath_node_set_raw ns = _left->eval_node_set(c, stack, nodeset_eval_all); + + for (const xpath_node* it = ns.begin(); it != ns.end(); ++it) + { + xpath_allocator_capture cri(stack.result); + + r += convert_string_to_number(string_value(*it, stack.result).c_str()); + } + + return r; + } + + case ast_func_floor: + { + double r = _left->eval_number(c, stack); + + return r == r ? floor(r) : r; + } + + case ast_func_ceiling: + { + double r = _left->eval_number(c, stack); + + return r == r ? ceil(r) : r; + } + + case ast_func_round: + return round_nearest_nzero(_left->eval_number(c, stack)); + + case ast_variable: + { + assert(_rettype == _data.variable->type()); + + if (_rettype == xpath_type_number) + return _data.variable->get_number(); + + // fallthrough to type conversion + } + + default: + { + switch (_rettype) + { + case xpath_type_boolean: + return eval_boolean(c, stack) ? 1 : 0; + + case xpath_type_string: + { + xpath_allocator_capture cr(stack.result); + + return convert_string_to_number(eval_string(c, stack).c_str()); + } + + case xpath_type_node_set: + { + xpath_allocator_capture cr(stack.result); + + return convert_string_to_number(eval_string(c, stack).c_str()); + } + + default: + assert(false && "Wrong expression for return type number"); + return 0; + } + + } + } + } + + xpath_string eval_string_concat(const xpath_context& c, const xpath_stack& stack) + { + assert(_type == ast_func_concat); + + xpath_allocator_capture ct(stack.temp); + + // count the string number + size_t count = 1; + for (xpath_ast_node* nc = _right; nc; nc = nc->_next) count++; + + // gather all strings + xpath_string static_buffer[4]; + xpath_string* buffer = static_buffer; + + // allocate on-heap for large concats + if (count > sizeof(static_buffer) / sizeof(static_buffer[0])) + { + buffer = static_cast(stack.temp->allocate(count * sizeof(xpath_string))); + assert(buffer); + } + + // evaluate all strings to temporary stack + xpath_stack swapped_stack = {stack.temp, stack.result}; + + buffer[0] = _left->eval_string(c, swapped_stack); + + size_t pos = 1; + for (xpath_ast_node* n = _right; n; n = n->_next, ++pos) buffer[pos] = n->eval_string(c, swapped_stack); + assert(pos == count); + + // get total length + size_t length = 0; + for (size_t i = 0; i < count; ++i) length += buffer[i].length(); + + // create final string + char_t* result = static_cast(stack.result->allocate((length + 1) * sizeof(char_t))); + assert(result); + + char_t* ri = result; + + for (size_t j = 0; j < count; ++j) + for (const char_t* bi = buffer[j].c_str(); *bi; ++bi) + *ri++ = *bi; + + *ri = 0; + + return xpath_string::from_heap_preallocated(result, ri); + } + + xpath_string eval_string(const xpath_context& c, const xpath_stack& stack) + { + switch (_type) + { + case ast_string_constant: + return xpath_string::from_const(_data.string); + + case ast_func_local_name_0: + { + xpath_node na = c.n; + + return xpath_string::from_const(local_name(na)); + } + + case ast_func_local_name_1: + { + xpath_allocator_capture cr(stack.result); + + xpath_node_set_raw ns = _left->eval_node_set(c, stack, nodeset_eval_first); + xpath_node na = ns.first(); + + return xpath_string::from_const(local_name(na)); + } + + case ast_func_name_0: + { + xpath_node na = c.n; + + return xpath_string::from_const(qualified_name(na)); + } + + case ast_func_name_1: + { + xpath_allocator_capture cr(stack.result); + + xpath_node_set_raw ns = _left->eval_node_set(c, stack, nodeset_eval_first); + xpath_node na = ns.first(); + + return xpath_string::from_const(qualified_name(na)); + } + + case ast_func_namespace_uri_0: + { + xpath_node na = c.n; + + return xpath_string::from_const(namespace_uri(na)); + } + + case ast_func_namespace_uri_1: + { + xpath_allocator_capture cr(stack.result); + + xpath_node_set_raw ns = _left->eval_node_set(c, stack, nodeset_eval_first); + xpath_node na = ns.first(); + + return xpath_string::from_const(namespace_uri(na)); + } + + case ast_func_string_0: + return string_value(c.n, stack.result); + + case ast_func_string_1: + return _left->eval_string(c, stack); + + case ast_func_concat: + return eval_string_concat(c, stack); + + case ast_func_substring_before: + { + xpath_allocator_capture cr(stack.temp); + + xpath_stack swapped_stack = {stack.temp, stack.result}; + + xpath_string s = _left->eval_string(c, swapped_stack); + xpath_string p = _right->eval_string(c, swapped_stack); + + const char_t* pos = find_substring(s.c_str(), p.c_str()); + + return pos ? xpath_string::from_heap(s.c_str(), pos, stack.result) : xpath_string(); + } + + case ast_func_substring_after: + { + xpath_allocator_capture cr(stack.temp); + + xpath_stack swapped_stack = {stack.temp, stack.result}; + + xpath_string s = _left->eval_string(c, swapped_stack); + xpath_string p = _right->eval_string(c, swapped_stack); + + const char_t* pos = find_substring(s.c_str(), p.c_str()); + if (!pos) return xpath_string(); + + const char_t* rbegin = pos + p.length(); + const char_t* rend = s.c_str() + s.length(); + + return s.uses_heap() ? xpath_string::from_heap(rbegin, rend, stack.result) : xpath_string::from_const(rbegin); + } + + case ast_func_substring_2: + { + xpath_allocator_capture cr(stack.temp); + + xpath_stack swapped_stack = {stack.temp, stack.result}; + + xpath_string s = _left->eval_string(c, swapped_stack); + size_t s_length = s.length(); + + double first = round_nearest(_right->eval_number(c, stack)); + + if (is_nan(first)) return xpath_string(); // NaN + else if (first >= s_length + 1) return xpath_string(); + + size_t pos = first < 1 ? 1 : static_cast(first); + assert(1 <= pos && pos <= s_length + 1); + + const char_t* rbegin = s.c_str() + (pos - 1); + const char_t* rend = s.c_str() + s.length(); + + return s.uses_heap() ? xpath_string::from_heap(rbegin, rend, stack.result) : xpath_string::from_const(rbegin); + } + + case ast_func_substring_3: + { + xpath_allocator_capture cr(stack.temp); + + xpath_stack swapped_stack = {stack.temp, stack.result}; + + xpath_string s = _left->eval_string(c, swapped_stack); + size_t s_length = s.length(); + + double first = round_nearest(_right->eval_number(c, stack)); + double last = first + round_nearest(_right->_next->eval_number(c, stack)); + + if (is_nan(first) || is_nan(last)) return xpath_string(); + else if (first >= s_length + 1) return xpath_string(); + else if (first >= last) return xpath_string(); + else if (last < 1) return xpath_string(); + + size_t pos = first < 1 ? 1 : static_cast(first); + size_t end = last >= s_length + 1 ? s_length + 1 : static_cast(last); + + assert(1 <= pos && pos <= end && end <= s_length + 1); + const char_t* rbegin = s.c_str() + (pos - 1); + const char_t* rend = s.c_str() + (end - 1); + + return (end == s_length + 1 && !s.uses_heap()) ? xpath_string::from_const(rbegin) : xpath_string::from_heap(rbegin, rend, stack.result); + } + + case ast_func_normalize_space_0: + { + xpath_string s = string_value(c.n, stack.result); + + char_t* begin = s.data(stack.result); + char_t* end = normalize_space(begin); + + return xpath_string::from_heap_preallocated(begin, end); + } + + case ast_func_normalize_space_1: + { + xpath_string s = _left->eval_string(c, stack); + + char_t* begin = s.data(stack.result); + char_t* end = normalize_space(begin); + + return xpath_string::from_heap_preallocated(begin, end); + } + + case ast_func_translate: + { + xpath_allocator_capture cr(stack.temp); + + xpath_stack swapped_stack = {stack.temp, stack.result}; + + xpath_string s = _left->eval_string(c, stack); + xpath_string from = _right->eval_string(c, swapped_stack); + xpath_string to = _right->_next->eval_string(c, swapped_stack); + + char_t* begin = s.data(stack.result); + char_t* end = translate(begin, from.c_str(), to.c_str(), to.length()); + + return xpath_string::from_heap_preallocated(begin, end); + } + + case ast_opt_translate_table: + { + xpath_string s = _left->eval_string(c, stack); + + char_t* begin = s.data(stack.result); + char_t* end = translate_table(begin, _data.table); + + return xpath_string::from_heap_preallocated(begin, end); + } + + case ast_variable: + { + assert(_rettype == _data.variable->type()); + + if (_rettype == xpath_type_string) + return xpath_string::from_const(_data.variable->get_string()); + + // fallthrough to type conversion + } + + default: + { + switch (_rettype) + { + case xpath_type_boolean: + return xpath_string::from_const(eval_boolean(c, stack) ? PUGIXML_TEXT("true") : PUGIXML_TEXT("false")); + + case xpath_type_number: + return convert_number_to_string(eval_number(c, stack), stack.result); + + case xpath_type_node_set: + { + xpath_allocator_capture cr(stack.temp); + + xpath_stack swapped_stack = {stack.temp, stack.result}; + + xpath_node_set_raw ns = eval_node_set(c, swapped_stack, nodeset_eval_first); + return ns.empty() ? xpath_string() : string_value(ns.first(), stack.result); + } + + default: + assert(false && "Wrong expression for return type string"); + return xpath_string(); + } + } + } + } + + xpath_node_set_raw eval_node_set(const xpath_context& c, const xpath_stack& stack, nodeset_eval_t eval) + { + switch (_type) + { + case ast_op_union: + { + xpath_allocator_capture cr(stack.temp); + + xpath_stack swapped_stack = {stack.temp, stack.result}; + + xpath_node_set_raw ls = _left->eval_node_set(c, swapped_stack, eval); + xpath_node_set_raw rs = _right->eval_node_set(c, stack, eval); + + // we can optimize merging two sorted sets, but this is a very rare operation, so don't bother + rs.set_type(xpath_node_set::type_unsorted); + + rs.append(ls.begin(), ls.end(), stack.result); + rs.remove_duplicates(); + + return rs; + } + + case ast_filter: + { + xpath_node_set_raw set = _left->eval_node_set(c, stack, _test == predicate_constant_one ? nodeset_eval_first : nodeset_eval_all); + + // either expression is a number or it contains position() call; sort by document order + if (_test != predicate_posinv) set.sort_do(); + + bool once = eval_once(set.type(), eval); + + apply_predicate(set, 0, stack, once); + + return set; + } + + case ast_func_id: + return xpath_node_set_raw(); + + case ast_step: + { + switch (_axis) + { + case axis_ancestor: + return step_do(c, stack, eval, axis_to_type()); + + case axis_ancestor_or_self: + return step_do(c, stack, eval, axis_to_type()); + + case axis_attribute: + return step_do(c, stack, eval, axis_to_type()); + + case axis_child: + return step_do(c, stack, eval, axis_to_type()); + + case axis_descendant: + return step_do(c, stack, eval, axis_to_type()); + + case axis_descendant_or_self: + return step_do(c, stack, eval, axis_to_type()); + + case axis_following: + return step_do(c, stack, eval, axis_to_type()); + + case axis_following_sibling: + return step_do(c, stack, eval, axis_to_type()); + + case axis_namespace: + // namespaced axis is not supported + return xpath_node_set_raw(); + + case axis_parent: + return step_do(c, stack, eval, axis_to_type()); + + case axis_preceding: + return step_do(c, stack, eval, axis_to_type()); + + case axis_preceding_sibling: + return step_do(c, stack, eval, axis_to_type()); + + case axis_self: + return step_do(c, stack, eval, axis_to_type()); + + default: + assert(false && "Unknown axis"); + return xpath_node_set_raw(); + } + } + + case ast_step_root: + { + assert(!_right); // root step can't have any predicates + + xpath_node_set_raw ns; + + ns.set_type(xpath_node_set::type_sorted); + + if (c.n.node()) ns.push_back(c.n.node().root(), stack.result); + else if (c.n.attribute()) ns.push_back(c.n.parent().root(), stack.result); + + return ns; + } + + case ast_variable: + { + assert(_rettype == _data.variable->type()); + + if (_rettype == xpath_type_node_set) + { + const xpath_node_set& s = _data.variable->get_node_set(); + + xpath_node_set_raw ns; + + ns.set_type(s.type()); + ns.append(s.begin(), s.end(), stack.result); + + return ns; + } + + // fallthrough to type conversion + } + + default: + assert(false && "Wrong expression for return type node set"); + return xpath_node_set_raw(); + } + } + + void optimize(xpath_allocator* alloc) + { + if (_left) + _left->optimize(alloc); + + if (_right) + _right->optimize(alloc); + + if (_next) + _next->optimize(alloc); + + optimize_self(alloc); + } + + void optimize_self(xpath_allocator* alloc) + { + // Rewrite [position()=expr] with [expr] + // Note that this step has to go before classification to recognize [position()=1] + if ((_type == ast_filter || _type == ast_predicate) && + _right->_type == ast_op_equal && _right->_left->_type == ast_func_position && _right->_right->_rettype == xpath_type_number) + { + _right = _right->_right; + } + + // Classify filter/predicate ops to perform various optimizations during evaluation + if (_type == ast_filter || _type == ast_predicate) + { + assert(_test == predicate_default); + + if (_right->_type == ast_number_constant && _right->_data.number == 1.0) + _test = predicate_constant_one; + else if (_right->_rettype == xpath_type_number && (_right->_type == ast_number_constant || _right->_type == ast_variable || _right->_type == ast_func_last)) + _test = predicate_constant; + else if (_right->_rettype != xpath_type_number && _right->is_posinv_expr()) + _test = predicate_posinv; + } + + // Rewrite descendant-or-self::node()/child::foo with descendant::foo + // The former is a full form of //foo, the latter is much faster since it executes the node test immediately + // Do a similar kind of rewrite for self/descendant/descendant-or-self axes + // Note that we only rewrite positionally invariant steps (//foo[1] != /descendant::foo[1]) + if (_type == ast_step && (_axis == axis_child || _axis == axis_self || _axis == axis_descendant || _axis == axis_descendant_or_self) && _left && + _left->_type == ast_step && _left->_axis == axis_descendant_or_self && _left->_test == nodetest_type_node && !_left->_right && + is_posinv_step()) + { + if (_axis == axis_child || _axis == axis_descendant) + _axis = axis_descendant; + else + _axis = axis_descendant_or_self; + + _left = _left->_left; + } + + // Use optimized lookup table implementation for translate() with constant arguments + if (_type == ast_func_translate && _right->_type == ast_string_constant && _right->_next->_type == ast_string_constant) + { + unsigned char* table = translate_table_generate(alloc, _right->_data.string, _right->_next->_data.string); + + if (table) + { + _type = ast_opt_translate_table; + _data.table = table; + } + } + + // Use optimized path for @attr = 'value' or @attr = $value + if (_type == ast_op_equal && + _left->_type == ast_step && _left->_axis == axis_attribute && _left->_test == nodetest_name && !_left->_left && !_left->_right && + (_right->_type == ast_string_constant || (_right->_type == ast_variable && _right->_rettype == xpath_type_string))) + { + _type = ast_opt_compare_attribute; + } + } + + bool is_posinv_expr() const + { + switch (_type) + { + case ast_func_position: + case ast_func_last: + return false; + + case ast_string_constant: + case ast_number_constant: + case ast_variable: + return true; + + case ast_step: + case ast_step_root: + return true; + + case ast_predicate: + case ast_filter: + return true; + + default: + if (_left && !_left->is_posinv_expr()) return false; + + for (xpath_ast_node* n = _right; n; n = n->_next) + if (!n->is_posinv_expr()) return false; + + return true; + } + } + + bool is_posinv_step() const + { + assert(_type == ast_step); + + for (xpath_ast_node* n = _right; n; n = n->_next) + { + assert(n->_type == ast_predicate); + + if (n->_test != predicate_posinv) + return false; + } + + return true; + } + + xpath_value_type rettype() const + { + return static_cast(_rettype); + } + }; + + struct xpath_parser + { + xpath_allocator* _alloc; + xpath_lexer _lexer; + + const char_t* _query; + xpath_variable_set* _variables; + + xpath_parse_result* _result; + + char_t _scratch[32]; + + #ifdef PUGIXML_NO_EXCEPTIONS + jmp_buf _error_handler; + #endif + + void throw_error(const char* message) + { + _result->error = message; + _result->offset = _lexer.current_pos() - _query; + + #ifdef PUGIXML_NO_EXCEPTIONS + longjmp(_error_handler, 1); + #else + throw xpath_exception(*_result); + #endif + } + + void throw_error_oom() + { + #ifdef PUGIXML_NO_EXCEPTIONS + throw_error("Out of memory"); + #else + throw std::bad_alloc(); + #endif + } + + void* alloc_node() + { + void* result = _alloc->allocate_nothrow(sizeof(xpath_ast_node)); + + if (!result) throw_error_oom(); + + return result; + } + + const char_t* alloc_string(const xpath_lexer_string& value) + { + if (value.begin) + { + size_t length = static_cast(value.end - value.begin); + + char_t* c = static_cast(_alloc->allocate_nothrow((length + 1) * sizeof(char_t))); + if (!c) throw_error_oom(); + assert(c); // workaround for clang static analysis + + memcpy(c, value.begin, length * sizeof(char_t)); + c[length] = 0; + + return c; + } + else return 0; + } + + xpath_ast_node* parse_function_helper(ast_type_t type0, ast_type_t type1, size_t argc, xpath_ast_node* args[2]) + { + assert(argc <= 1); + + if (argc == 1 && args[0]->rettype() != xpath_type_node_set) + throw_error("Function has to be applied to node set"); + + return new (alloc_node()) xpath_ast_node(argc == 0 ? type0 : type1, xpath_type_string, args[0]); + } + + xpath_ast_node* parse_function(const xpath_lexer_string& name, size_t argc, xpath_ast_node* args[2]) + { + switch (name.begin[0]) + { + case 'b': + if (name == PUGIXML_TEXT("boolean") && argc == 1) + return new (alloc_node()) xpath_ast_node(ast_func_boolean, xpath_type_boolean, args[0]); + + break; + + case 'c': + if (name == PUGIXML_TEXT("count") && argc == 1) + { + if (args[0]->rettype() != xpath_type_node_set) + throw_error("Function has to be applied to node set"); + + return new (alloc_node()) xpath_ast_node(ast_func_count, xpath_type_number, args[0]); + } + else if (name == PUGIXML_TEXT("contains") && argc == 2) + return new (alloc_node()) xpath_ast_node(ast_func_contains, xpath_type_boolean, args[0], args[1]); + else if (name == PUGIXML_TEXT("concat") && argc >= 2) + return new (alloc_node()) xpath_ast_node(ast_func_concat, xpath_type_string, args[0], args[1]); + else if (name == PUGIXML_TEXT("ceiling") && argc == 1) + return new (alloc_node()) xpath_ast_node(ast_func_ceiling, xpath_type_number, args[0]); + + break; + + case 'f': + if (name == PUGIXML_TEXT("false") && argc == 0) + return new (alloc_node()) xpath_ast_node(ast_func_false, xpath_type_boolean); + else if (name == PUGIXML_TEXT("floor") && argc == 1) + return new (alloc_node()) xpath_ast_node(ast_func_floor, xpath_type_number, args[0]); + + break; + + case 'i': + if (name == PUGIXML_TEXT("id") && argc == 1) + return new (alloc_node()) xpath_ast_node(ast_func_id, xpath_type_node_set, args[0]); + + break; + + case 'l': + if (name == PUGIXML_TEXT("last") && argc == 0) + return new (alloc_node()) xpath_ast_node(ast_func_last, xpath_type_number); + else if (name == PUGIXML_TEXT("lang") && argc == 1) + return new (alloc_node()) xpath_ast_node(ast_func_lang, xpath_type_boolean, args[0]); + else if (name == PUGIXML_TEXT("local-name") && argc <= 1) + return parse_function_helper(ast_func_local_name_0, ast_func_local_name_1, argc, args); + + break; + + case 'n': + if (name == PUGIXML_TEXT("name") && argc <= 1) + return parse_function_helper(ast_func_name_0, ast_func_name_1, argc, args); + else if (name == PUGIXML_TEXT("namespace-uri") && argc <= 1) + return parse_function_helper(ast_func_namespace_uri_0, ast_func_namespace_uri_1, argc, args); + else if (name == PUGIXML_TEXT("normalize-space") && argc <= 1) + return new (alloc_node()) xpath_ast_node(argc == 0 ? ast_func_normalize_space_0 : ast_func_normalize_space_1, xpath_type_string, args[0], args[1]); + else if (name == PUGIXML_TEXT("not") && argc == 1) + return new (alloc_node()) xpath_ast_node(ast_func_not, xpath_type_boolean, args[0]); + else if (name == PUGIXML_TEXT("number") && argc <= 1) + return new (alloc_node()) xpath_ast_node(argc == 0 ? ast_func_number_0 : ast_func_number_1, xpath_type_number, args[0]); + + break; + + case 'p': + if (name == PUGIXML_TEXT("position") && argc == 0) + return new (alloc_node()) xpath_ast_node(ast_func_position, xpath_type_number); + + break; + + case 'r': + if (name == PUGIXML_TEXT("round") && argc == 1) + return new (alloc_node()) xpath_ast_node(ast_func_round, xpath_type_number, args[0]); + + break; + + case 's': + if (name == PUGIXML_TEXT("string") && argc <= 1) + return new (alloc_node()) xpath_ast_node(argc == 0 ? ast_func_string_0 : ast_func_string_1, xpath_type_string, args[0]); + else if (name == PUGIXML_TEXT("string-length") && argc <= 1) + return new (alloc_node()) xpath_ast_node(argc == 0 ? ast_func_string_length_0 : ast_func_string_length_1, xpath_type_number, args[0]); + else if (name == PUGIXML_TEXT("starts-with") && argc == 2) + return new (alloc_node()) xpath_ast_node(ast_func_starts_with, xpath_type_boolean, args[0], args[1]); + else if (name == PUGIXML_TEXT("substring-before") && argc == 2) + return new (alloc_node()) xpath_ast_node(ast_func_substring_before, xpath_type_string, args[0], args[1]); + else if (name == PUGIXML_TEXT("substring-after") && argc == 2) + return new (alloc_node()) xpath_ast_node(ast_func_substring_after, xpath_type_string, args[0], args[1]); + else if (name == PUGIXML_TEXT("substring") && (argc == 2 || argc == 3)) + return new (alloc_node()) xpath_ast_node(argc == 2 ? ast_func_substring_2 : ast_func_substring_3, xpath_type_string, args[0], args[1]); + else if (name == PUGIXML_TEXT("sum") && argc == 1) + { + if (args[0]->rettype() != xpath_type_node_set) throw_error("Function has to be applied to node set"); + return new (alloc_node()) xpath_ast_node(ast_func_sum, xpath_type_number, args[0]); + } + + break; + + case 't': + if (name == PUGIXML_TEXT("translate") && argc == 3) + return new (alloc_node()) xpath_ast_node(ast_func_translate, xpath_type_string, args[0], args[1]); + else if (name == PUGIXML_TEXT("true") && argc == 0) + return new (alloc_node()) xpath_ast_node(ast_func_true, xpath_type_boolean); + + break; + + default: + break; + } + + throw_error("Unrecognized function or wrong parameter count"); + + return 0; + } + + axis_t parse_axis_name(const xpath_lexer_string& name, bool& specified) + { + specified = true; + + switch (name.begin[0]) + { + case 'a': + if (name == PUGIXML_TEXT("ancestor")) + return axis_ancestor; + else if (name == PUGIXML_TEXT("ancestor-or-self")) + return axis_ancestor_or_self; + else if (name == PUGIXML_TEXT("attribute")) + return axis_attribute; + + break; + + case 'c': + if (name == PUGIXML_TEXT("child")) + return axis_child; + + break; + + case 'd': + if (name == PUGIXML_TEXT("descendant")) + return axis_descendant; + else if (name == PUGIXML_TEXT("descendant-or-self")) + return axis_descendant_or_self; + + break; + + case 'f': + if (name == PUGIXML_TEXT("following")) + return axis_following; + else if (name == PUGIXML_TEXT("following-sibling")) + return axis_following_sibling; + + break; + + case 'n': + if (name == PUGIXML_TEXT("namespace")) + return axis_namespace; + + break; + + case 'p': + if (name == PUGIXML_TEXT("parent")) + return axis_parent; + else if (name == PUGIXML_TEXT("preceding")) + return axis_preceding; + else if (name == PUGIXML_TEXT("preceding-sibling")) + return axis_preceding_sibling; + + break; + + case 's': + if (name == PUGIXML_TEXT("self")) + return axis_self; + + break; + + default: + break; + } + + specified = false; + return axis_child; + } + + nodetest_t parse_node_test_type(const xpath_lexer_string& name) + { + switch (name.begin[0]) + { + case 'c': + if (name == PUGIXML_TEXT("comment")) + return nodetest_type_comment; + + break; + + case 'n': + if (name == PUGIXML_TEXT("node")) + return nodetest_type_node; + + break; + + case 'p': + if (name == PUGIXML_TEXT("processing-instruction")) + return nodetest_type_pi; + + break; + + case 't': + if (name == PUGIXML_TEXT("text")) + return nodetest_type_text; + + break; + + default: + break; + } + + return nodetest_none; + } + + // PrimaryExpr ::= VariableReference | '(' Expr ')' | Literal | Number | FunctionCall + xpath_ast_node* parse_primary_expression() + { + switch (_lexer.current()) + { + case lex_var_ref: + { + xpath_lexer_string name = _lexer.contents(); + + if (!_variables) + throw_error("Unknown variable: variable set is not provided"); + + xpath_variable* var = 0; + if (!get_variable_scratch(_scratch, _variables, name.begin, name.end, &var)) + throw_error_oom(); + + if (!var) + throw_error("Unknown variable: variable set does not contain the given name"); + + _lexer.next(); + + return new (alloc_node()) xpath_ast_node(ast_variable, var->type(), var); + } + + case lex_open_brace: + { + _lexer.next(); + + xpath_ast_node* n = parse_expression(); + + if (_lexer.current() != lex_close_brace) + throw_error("Unmatched braces"); + + _lexer.next(); + + return n; + } + + case lex_quoted_string: + { + const char_t* value = alloc_string(_lexer.contents()); + + xpath_ast_node* n = new (alloc_node()) xpath_ast_node(ast_string_constant, xpath_type_string, value); + _lexer.next(); + + return n; + } + + case lex_number: + { + double value = 0; + + if (!convert_string_to_number_scratch(_scratch, _lexer.contents().begin, _lexer.contents().end, &value)) + throw_error_oom(); + + xpath_ast_node* n = new (alloc_node()) xpath_ast_node(ast_number_constant, xpath_type_number, value); + _lexer.next(); + + return n; + } + + case lex_string: + { + xpath_ast_node* args[2] = {0}; + size_t argc = 0; + + xpath_lexer_string function = _lexer.contents(); + _lexer.next(); + + xpath_ast_node* last_arg = 0; + + if (_lexer.current() != lex_open_brace) + throw_error("Unrecognized function call"); + _lexer.next(); + + if (_lexer.current() != lex_close_brace) + args[argc++] = parse_expression(); + + while (_lexer.current() != lex_close_brace) + { + if (_lexer.current() != lex_comma) + throw_error("No comma between function arguments"); + _lexer.next(); + + xpath_ast_node* n = parse_expression(); + + if (argc < 2) args[argc] = n; + else last_arg->set_next(n); + + argc++; + last_arg = n; + } + + _lexer.next(); + + return parse_function(function, argc, args); + } + + default: + throw_error("Unrecognizable primary expression"); + + return 0; + } + } + + // FilterExpr ::= PrimaryExpr | FilterExpr Predicate + // Predicate ::= '[' PredicateExpr ']' + // PredicateExpr ::= Expr + xpath_ast_node* parse_filter_expression() + { + xpath_ast_node* n = parse_primary_expression(); + + while (_lexer.current() == lex_open_square_brace) + { + _lexer.next(); + + xpath_ast_node* expr = parse_expression(); + + if (n->rettype() != xpath_type_node_set) + throw_error("Predicate has to be applied to node set"); + + n = new (alloc_node()) xpath_ast_node(ast_filter, n, expr, predicate_default); + + if (_lexer.current() != lex_close_square_brace) + throw_error("Unmatched square brace"); + + _lexer.next(); + } + + return n; + } + + // Step ::= AxisSpecifier NodeTest Predicate* | AbbreviatedStep + // AxisSpecifier ::= AxisName '::' | '@'? + // NodeTest ::= NameTest | NodeType '(' ')' | 'processing-instruction' '(' Literal ')' + // NameTest ::= '*' | NCName ':' '*' | QName + // AbbreviatedStep ::= '.' | '..' + xpath_ast_node* parse_step(xpath_ast_node* set) + { + if (set && set->rettype() != xpath_type_node_set) + throw_error("Step has to be applied to node set"); + + bool axis_specified = false; + axis_t axis = axis_child; // implied child axis + + if (_lexer.current() == lex_axis_attribute) + { + axis = axis_attribute; + axis_specified = true; + + _lexer.next(); + } + else if (_lexer.current() == lex_dot) + { + _lexer.next(); + + return new (alloc_node()) xpath_ast_node(ast_step, set, axis_self, nodetest_type_node, 0); + } + else if (_lexer.current() == lex_double_dot) + { + _lexer.next(); + + return new (alloc_node()) xpath_ast_node(ast_step, set, axis_parent, nodetest_type_node, 0); + } + + nodetest_t nt_type = nodetest_none; + xpath_lexer_string nt_name; + + if (_lexer.current() == lex_string) + { + // node name test + nt_name = _lexer.contents(); + _lexer.next(); + + // was it an axis name? + if (_lexer.current() == lex_double_colon) + { + // parse axis name + if (axis_specified) + throw_error("Two axis specifiers in one step"); + + axis = parse_axis_name(nt_name, axis_specified); + + if (!axis_specified) + throw_error("Unknown axis"); + + // read actual node test + _lexer.next(); + + if (_lexer.current() == lex_multiply) + { + nt_type = nodetest_all; + nt_name = xpath_lexer_string(); + _lexer.next(); + } + else if (_lexer.current() == lex_string) + { + nt_name = _lexer.contents(); + _lexer.next(); + } + else throw_error("Unrecognized node test"); + } + + if (nt_type == nodetest_none) + { + // node type test or processing-instruction + if (_lexer.current() == lex_open_brace) + { + _lexer.next(); + + if (_lexer.current() == lex_close_brace) + { + _lexer.next(); + + nt_type = parse_node_test_type(nt_name); + + if (nt_type == nodetest_none) + throw_error("Unrecognized node type"); + + nt_name = xpath_lexer_string(); + } + else if (nt_name == PUGIXML_TEXT("processing-instruction")) + { + if (_lexer.current() != lex_quoted_string) + throw_error("Only literals are allowed as arguments to processing-instruction()"); + + nt_type = nodetest_pi; + nt_name = _lexer.contents(); + _lexer.next(); + + if (_lexer.current() != lex_close_brace) + throw_error("Unmatched brace near processing-instruction()"); + _lexer.next(); + } + else + { + throw_error("Unmatched brace near node type test"); + } + } + // QName or NCName:* + else + { + if (nt_name.end - nt_name.begin > 2 && nt_name.end[-2] == ':' && nt_name.end[-1] == '*') // NCName:* + { + nt_name.end--; // erase * + + nt_type = nodetest_all_in_namespace; + } + else + { + nt_type = nodetest_name; + } + } + } + } + else if (_lexer.current() == lex_multiply) + { + nt_type = nodetest_all; + _lexer.next(); + } + else + { + throw_error("Unrecognized node test"); + } + + const char_t* nt_name_copy = alloc_string(nt_name); + xpath_ast_node* n = new (alloc_node()) xpath_ast_node(ast_step, set, axis, nt_type, nt_name_copy); + + xpath_ast_node* last = 0; + + while (_lexer.current() == lex_open_square_brace) + { + _lexer.next(); + + xpath_ast_node* expr = parse_expression(); + + xpath_ast_node* pred = new (alloc_node()) xpath_ast_node(ast_predicate, 0, expr, predicate_default); + + if (_lexer.current() != lex_close_square_brace) + throw_error("Unmatched square brace"); + _lexer.next(); + + if (last) last->set_next(pred); + else n->set_right(pred); + + last = pred; + } + + return n; + } + + // RelativeLocationPath ::= Step | RelativeLocationPath '/' Step | RelativeLocationPath '//' Step + xpath_ast_node* parse_relative_location_path(xpath_ast_node* set) + { + xpath_ast_node* n = parse_step(set); + + while (_lexer.current() == lex_slash || _lexer.current() == lex_double_slash) + { + lexeme_t l = _lexer.current(); + _lexer.next(); + + if (l == lex_double_slash) + n = new (alloc_node()) xpath_ast_node(ast_step, n, axis_descendant_or_self, nodetest_type_node, 0); + + n = parse_step(n); + } + + return n; + } + + // LocationPath ::= RelativeLocationPath | AbsoluteLocationPath + // AbsoluteLocationPath ::= '/' RelativeLocationPath? | '//' RelativeLocationPath + xpath_ast_node* parse_location_path() + { + if (_lexer.current() == lex_slash) + { + _lexer.next(); + + xpath_ast_node* n = new (alloc_node()) xpath_ast_node(ast_step_root, xpath_type_node_set); + + // relative location path can start from axis_attribute, dot, double_dot, multiply and string lexemes; any other lexeme means standalone root path + lexeme_t l = _lexer.current(); + + if (l == lex_string || l == lex_axis_attribute || l == lex_dot || l == lex_double_dot || l == lex_multiply) + return parse_relative_location_path(n); + else + return n; + } + else if (_lexer.current() == lex_double_slash) + { + _lexer.next(); + + xpath_ast_node* n = new (alloc_node()) xpath_ast_node(ast_step_root, xpath_type_node_set); + n = new (alloc_node()) xpath_ast_node(ast_step, n, axis_descendant_or_self, nodetest_type_node, 0); + + return parse_relative_location_path(n); + } + + // else clause moved outside of if because of bogus warning 'control may reach end of non-void function being inlined' in gcc 4.0.1 + return parse_relative_location_path(0); + } + + // PathExpr ::= LocationPath + // | FilterExpr + // | FilterExpr '/' RelativeLocationPath + // | FilterExpr '//' RelativeLocationPath + // UnionExpr ::= PathExpr | UnionExpr '|' PathExpr + // UnaryExpr ::= UnionExpr | '-' UnaryExpr + xpath_ast_node* parse_path_or_unary_expression() + { + // Clarification. + // PathExpr begins with either LocationPath or FilterExpr. + // FilterExpr begins with PrimaryExpr + // PrimaryExpr begins with '$' in case of it being a variable reference, + // '(' in case of it being an expression, string literal, number constant or + // function call. + + if (_lexer.current() == lex_var_ref || _lexer.current() == lex_open_brace || + _lexer.current() == lex_quoted_string || _lexer.current() == lex_number || + _lexer.current() == lex_string) + { + if (_lexer.current() == lex_string) + { + // This is either a function call, or not - if not, we shall proceed with location path + const char_t* state = _lexer.state(); + + while (PUGI__IS_CHARTYPE(*state, ct_space)) ++state; + + if (*state != '(') return parse_location_path(); + + // This looks like a function call; however this still can be a node-test. Check it. + if (parse_node_test_type(_lexer.contents()) != nodetest_none) + return parse_location_path(); + } + + xpath_ast_node* n = parse_filter_expression(); + + if (_lexer.current() == lex_slash || _lexer.current() == lex_double_slash) + { + lexeme_t l = _lexer.current(); + _lexer.next(); + + if (l == lex_double_slash) + { + if (n->rettype() != xpath_type_node_set) + throw_error("Step has to be applied to node set"); + + n = new (alloc_node()) xpath_ast_node(ast_step, n, axis_descendant_or_self, nodetest_type_node, 0); + } + + // select from location path + return parse_relative_location_path(n); + } + + return n; + } + else if (_lexer.current() == lex_minus) + { + _lexer.next(); + + // precedence 7+ - only parses union expressions + xpath_ast_node* expr = parse_expression_rec(parse_path_or_unary_expression(), 7); + + return new (alloc_node()) xpath_ast_node(ast_op_negate, xpath_type_number, expr); + } + else + { + return parse_location_path(); + } + } + + struct binary_op_t + { + ast_type_t asttype; + xpath_value_type rettype; + int precedence; + + binary_op_t(): asttype(ast_unknown), rettype(xpath_type_none), precedence(0) + { + } + + binary_op_t(ast_type_t asttype_, xpath_value_type rettype_, int precedence_): asttype(asttype_), rettype(rettype_), precedence(precedence_) + { + } + + static binary_op_t parse(xpath_lexer& lexer) + { + switch (lexer.current()) + { + case lex_string: + if (lexer.contents() == PUGIXML_TEXT("or")) + return binary_op_t(ast_op_or, xpath_type_boolean, 1); + else if (lexer.contents() == PUGIXML_TEXT("and")) + return binary_op_t(ast_op_and, xpath_type_boolean, 2); + else if (lexer.contents() == PUGIXML_TEXT("div")) + return binary_op_t(ast_op_divide, xpath_type_number, 6); + else if (lexer.contents() == PUGIXML_TEXT("mod")) + return binary_op_t(ast_op_mod, xpath_type_number, 6); + else + return binary_op_t(); + + case lex_equal: + return binary_op_t(ast_op_equal, xpath_type_boolean, 3); + + case lex_not_equal: + return binary_op_t(ast_op_not_equal, xpath_type_boolean, 3); + + case lex_less: + return binary_op_t(ast_op_less, xpath_type_boolean, 4); + + case lex_greater: + return binary_op_t(ast_op_greater, xpath_type_boolean, 4); + + case lex_less_or_equal: + return binary_op_t(ast_op_less_or_equal, xpath_type_boolean, 4); + + case lex_greater_or_equal: + return binary_op_t(ast_op_greater_or_equal, xpath_type_boolean, 4); + + case lex_plus: + return binary_op_t(ast_op_add, xpath_type_number, 5); + + case lex_minus: + return binary_op_t(ast_op_subtract, xpath_type_number, 5); + + case lex_multiply: + return binary_op_t(ast_op_multiply, xpath_type_number, 6); + + case lex_union: + return binary_op_t(ast_op_union, xpath_type_node_set, 7); + + default: + return binary_op_t(); + } + } + }; + + xpath_ast_node* parse_expression_rec(xpath_ast_node* lhs, int limit) + { + binary_op_t op = binary_op_t::parse(_lexer); + + while (op.asttype != ast_unknown && op.precedence >= limit) + { + _lexer.next(); + + xpath_ast_node* rhs = parse_path_or_unary_expression(); + + binary_op_t nextop = binary_op_t::parse(_lexer); + + while (nextop.asttype != ast_unknown && nextop.precedence > op.precedence) + { + rhs = parse_expression_rec(rhs, nextop.precedence); + + nextop = binary_op_t::parse(_lexer); + } + + if (op.asttype == ast_op_union && (lhs->rettype() != xpath_type_node_set || rhs->rettype() != xpath_type_node_set)) + throw_error("Union operator has to be applied to node sets"); + + lhs = new (alloc_node()) xpath_ast_node(op.asttype, op.rettype, lhs, rhs); + + op = binary_op_t::parse(_lexer); + } + + return lhs; + } + + // Expr ::= OrExpr + // OrExpr ::= AndExpr | OrExpr 'or' AndExpr + // AndExpr ::= EqualityExpr | AndExpr 'and' EqualityExpr + // EqualityExpr ::= RelationalExpr + // | EqualityExpr '=' RelationalExpr + // | EqualityExpr '!=' RelationalExpr + // RelationalExpr ::= AdditiveExpr + // | RelationalExpr '<' AdditiveExpr + // | RelationalExpr '>' AdditiveExpr + // | RelationalExpr '<=' AdditiveExpr + // | RelationalExpr '>=' AdditiveExpr + // AdditiveExpr ::= MultiplicativeExpr + // | AdditiveExpr '+' MultiplicativeExpr + // | AdditiveExpr '-' MultiplicativeExpr + // MultiplicativeExpr ::= UnaryExpr + // | MultiplicativeExpr '*' UnaryExpr + // | MultiplicativeExpr 'div' UnaryExpr + // | MultiplicativeExpr 'mod' UnaryExpr + xpath_ast_node* parse_expression() + { + return parse_expression_rec(parse_path_or_unary_expression(), 0); + } + + xpath_parser(const char_t* query, xpath_variable_set* variables, xpath_allocator* alloc, xpath_parse_result* result): _alloc(alloc), _lexer(query), _query(query), _variables(variables), _result(result) + { + } + + xpath_ast_node* parse() + { + xpath_ast_node* result = parse_expression(); + + // check if there are unparsed tokens left + if (_lexer.current() != lex_eof) + throw_error("Incorrect query"); + + return result; + } + + static xpath_ast_node* parse(const char_t* query, xpath_variable_set* variables, xpath_allocator* alloc, xpath_parse_result* result) + { + xpath_parser parser(query, variables, alloc, result); + + #ifdef PUGIXML_NO_EXCEPTIONS + int error = setjmp(parser._error_handler); + + return (error == 0) ? parser.parse() : 0; + #else + return parser.parse(); + #endif + } + }; + + struct xpath_query_impl + { + static xpath_query_impl* create() + { + void* memory = xml_memory::allocate(sizeof(xpath_query_impl)); + if (!memory) return 0; + + return new (memory) xpath_query_impl(); + } + + static void destroy(xpath_query_impl* impl) + { + // free all allocated pages + impl->alloc.release(); + + // free allocator memory (with the first page) + xml_memory::deallocate(impl); + } + + xpath_query_impl(): root(0), alloc(&block) + { + block.next = 0; + block.capacity = sizeof(block.data); + } + + xpath_ast_node* root; + xpath_allocator alloc; + xpath_memory_block block; + }; + + PUGI__FN xpath_string evaluate_string_impl(xpath_query_impl* impl, const xpath_node& n, xpath_stack_data& sd) + { + if (!impl) return xpath_string(); + + #ifdef PUGIXML_NO_EXCEPTIONS + if (setjmp(sd.error_handler)) return xpath_string(); + #endif + + xpath_context c(n, 1, 1); + + return impl->root->eval_string(c, sd.stack); + } + + PUGI__FN impl::xpath_ast_node* evaluate_node_set_prepare(xpath_query_impl* impl) + { + if (!impl) return 0; + + if (impl->root->rettype() != xpath_type_node_set) + { + #ifdef PUGIXML_NO_EXCEPTIONS + return 0; + #else + xpath_parse_result res; + res.error = "Expression does not evaluate to node set"; + + throw xpath_exception(res); + #endif + } + + return impl->root; + } +PUGI__NS_END + +namespace pugi +{ +#ifndef PUGIXML_NO_EXCEPTIONS + PUGI__FN xpath_exception::xpath_exception(const xpath_parse_result& result_): _result(result_) + { + assert(_result.error); + } + + PUGI__FN const char* xpath_exception::what() const throw() + { + return _result.error; + } + + PUGI__FN const xpath_parse_result& xpath_exception::result() const + { + return _result; + } +#endif + + PUGI__FN xpath_node::xpath_node() + { + } + + PUGI__FN xpath_node::xpath_node(const xml_node& node_): _node(node_) + { + } + + PUGI__FN xpath_node::xpath_node(const xml_attribute& attribute_, const xml_node& parent_): _node(attribute_ ? parent_ : xml_node()), _attribute(attribute_) + { + } + + PUGI__FN xml_node xpath_node::node() const + { + return _attribute ? xml_node() : _node; + } + + PUGI__FN xml_attribute xpath_node::attribute() const + { + return _attribute; + } + + PUGI__FN xml_node xpath_node::parent() const + { + return _attribute ? _node : _node.parent(); + } + + PUGI__FN static void unspecified_bool_xpath_node(xpath_node***) + { + } + + PUGI__FN xpath_node::operator xpath_node::unspecified_bool_type() const + { + return (_node || _attribute) ? unspecified_bool_xpath_node : 0; + } + + PUGI__FN bool xpath_node::operator!() const + { + return !(_node || _attribute); + } + + PUGI__FN bool xpath_node::operator==(const xpath_node& n) const + { + return _node == n._node && _attribute == n._attribute; + } + + PUGI__FN bool xpath_node::operator!=(const xpath_node& n) const + { + return _node != n._node || _attribute != n._attribute; + } + +#ifdef __BORLANDC__ + PUGI__FN bool operator&&(const xpath_node& lhs, bool rhs) + { + return (bool)lhs && rhs; + } + + PUGI__FN bool operator||(const xpath_node& lhs, bool rhs) + { + return (bool)lhs || rhs; + } +#endif + + PUGI__FN void xpath_node_set::_assign(const_iterator begin_, const_iterator end_, type_t type_) + { + assert(begin_ <= end_); + + size_t size_ = static_cast(end_ - begin_); + + if (size_ <= 1) + { + // deallocate old buffer + if (_begin != &_storage) impl::xml_memory::deallocate(_begin); + + // use internal buffer + if (begin_ != end_) _storage = *begin_; + + _begin = &_storage; + _end = &_storage + size_; + _type = type_; + } + else + { + // make heap copy + xpath_node* storage = static_cast(impl::xml_memory::allocate(size_ * sizeof(xpath_node))); + + if (!storage) + { + #ifdef PUGIXML_NO_EXCEPTIONS + return; + #else + throw std::bad_alloc(); + #endif + } + + memcpy(storage, begin_, size_ * sizeof(xpath_node)); + + // deallocate old buffer + if (_begin != &_storage) impl::xml_memory::deallocate(_begin); + + // finalize + _begin = storage; + _end = storage + size_; + _type = type_; + } + } + +#ifdef PUGIXML_HAS_MOVE + PUGI__FN void xpath_node_set::_move(xpath_node_set& rhs) + { + _type = rhs._type; + _storage = rhs._storage; + _begin = (rhs._begin == &rhs._storage) ? &_storage : rhs._begin; + _end = _begin + (rhs._end - rhs._begin); + + rhs._type = type_unsorted; + rhs._begin = &rhs._storage; + rhs._end = rhs._begin; + } +#endif + + PUGI__FN xpath_node_set::xpath_node_set(): _type(type_unsorted), _begin(&_storage), _end(&_storage) + { + } + + PUGI__FN xpath_node_set::xpath_node_set(const_iterator begin_, const_iterator end_, type_t type_): _type(type_unsorted), _begin(&_storage), _end(&_storage) + { + _assign(begin_, end_, type_); + } + + PUGI__FN xpath_node_set::~xpath_node_set() + { + if (_begin != &_storage) + impl::xml_memory::deallocate(_begin); + } + + PUGI__FN xpath_node_set::xpath_node_set(const xpath_node_set& ns): _type(type_unsorted), _begin(&_storage), _end(&_storage) + { + _assign(ns._begin, ns._end, ns._type); + } + + PUGI__FN xpath_node_set& xpath_node_set::operator=(const xpath_node_set& ns) + { + if (this == &ns) return *this; + + _assign(ns._begin, ns._end, ns._type); + + return *this; + } + +#ifdef PUGIXML_HAS_MOVE + PUGI__FN xpath_node_set::xpath_node_set(xpath_node_set&& rhs): _type(type_unsorted), _begin(&_storage), _end(&_storage) + { + _move(rhs); + } + + PUGI__FN xpath_node_set& xpath_node_set::operator=(xpath_node_set&& rhs) + { + if (this == &rhs) return *this; + + if (_begin != &_storage) + impl::xml_memory::deallocate(_begin); + + _move(rhs); + + return *this; + } +#endif + + PUGI__FN xpath_node_set::type_t xpath_node_set::type() const + { + return _type; + } + + PUGI__FN size_t xpath_node_set::size() const + { + return _end - _begin; + } + + PUGI__FN bool xpath_node_set::empty() const + { + return _begin == _end; + } + + PUGI__FN const xpath_node& xpath_node_set::operator[](size_t index) const + { + assert(index < size()); + return _begin[index]; + } + + PUGI__FN xpath_node_set::const_iterator xpath_node_set::begin() const + { + return _begin; + } + + PUGI__FN xpath_node_set::const_iterator xpath_node_set::end() const + { + return _end; + } + + PUGI__FN void xpath_node_set::sort(bool reverse) + { + _type = impl::xpath_sort(_begin, _end, _type, reverse); + } + + PUGI__FN xpath_node xpath_node_set::first() const + { + return impl::xpath_first(_begin, _end, _type); + } + + PUGI__FN xpath_parse_result::xpath_parse_result(): error("Internal error"), offset(0) + { + } + + PUGI__FN xpath_parse_result::operator bool() const + { + return error == 0; + } + + PUGI__FN const char* xpath_parse_result::description() const + { + return error ? error : "No error"; + } + + PUGI__FN xpath_variable::xpath_variable(xpath_value_type type_): _type(type_), _next(0) + { + } + + PUGI__FN const char_t* xpath_variable::name() const + { + switch (_type) + { + case xpath_type_node_set: + return static_cast(this)->name; + + case xpath_type_number: + return static_cast(this)->name; + + case xpath_type_string: + return static_cast(this)->name; + + case xpath_type_boolean: + return static_cast(this)->name; + + default: + assert(false && "Invalid variable type"); + return 0; + } + } + + PUGI__FN xpath_value_type xpath_variable::type() const + { + return _type; + } + + PUGI__FN bool xpath_variable::get_boolean() const + { + return (_type == xpath_type_boolean) ? static_cast(this)->value : false; + } + + PUGI__FN double xpath_variable::get_number() const + { + return (_type == xpath_type_number) ? static_cast(this)->value : impl::gen_nan(); + } + + PUGI__FN const char_t* xpath_variable::get_string() const + { + const char_t* value = (_type == xpath_type_string) ? static_cast(this)->value : 0; + return value ? value : PUGIXML_TEXT(""); + } + + PUGI__FN const xpath_node_set& xpath_variable::get_node_set() const + { + return (_type == xpath_type_node_set) ? static_cast(this)->value : impl::dummy_node_set; + } + + PUGI__FN bool xpath_variable::set(bool value) + { + if (_type != xpath_type_boolean) return false; + + static_cast(this)->value = value; + return true; + } + + PUGI__FN bool xpath_variable::set(double value) + { + if (_type != xpath_type_number) return false; + + static_cast(this)->value = value; + return true; + } + + PUGI__FN bool xpath_variable::set(const char_t* value) + { + if (_type != xpath_type_string) return false; + + impl::xpath_variable_string* var = static_cast(this); + + // duplicate string + size_t size = (impl::strlength(value) + 1) * sizeof(char_t); + + char_t* copy = static_cast(impl::xml_memory::allocate(size)); + if (!copy) return false; + + memcpy(copy, value, size); + + // replace old string + if (var->value) impl::xml_memory::deallocate(var->value); + var->value = copy; + + return true; + } + + PUGI__FN bool xpath_variable::set(const xpath_node_set& value) + { + if (_type != xpath_type_node_set) return false; + + static_cast(this)->value = value; + return true; + } + + PUGI__FN xpath_variable_set::xpath_variable_set() + { + for (size_t i = 0; i < sizeof(_data) / sizeof(_data[0]); ++i) + _data[i] = 0; + } + + PUGI__FN xpath_variable_set::~xpath_variable_set() + { + for (size_t i = 0; i < sizeof(_data) / sizeof(_data[0]); ++i) + _destroy(_data[i]); + } + + PUGI__FN xpath_variable_set::xpath_variable_set(const xpath_variable_set& rhs) + { + for (size_t i = 0; i < sizeof(_data) / sizeof(_data[0]); ++i) + _data[i] = 0; + + _assign(rhs); + } + + PUGI__FN xpath_variable_set& xpath_variable_set::operator=(const xpath_variable_set& rhs) + { + if (this == &rhs) return *this; + + _assign(rhs); + + return *this; + } + +#ifdef PUGIXML_HAS_MOVE + PUGI__FN xpath_variable_set::xpath_variable_set(xpath_variable_set&& rhs) + { + for (size_t i = 0; i < sizeof(_data) / sizeof(_data[0]); ++i) + { + _data[i] = rhs._data[i]; + rhs._data[i] = 0; + } + } + + PUGI__FN xpath_variable_set& xpath_variable_set::operator=(xpath_variable_set&& rhs) + { + for (size_t i = 0; i < sizeof(_data) / sizeof(_data[0]); ++i) + { + _destroy(_data[i]); + + _data[i] = rhs._data[i]; + rhs._data[i] = 0; + } + + return *this; + } +#endif + + PUGI__FN void xpath_variable_set::_assign(const xpath_variable_set& rhs) + { + xpath_variable_set temp; + + for (size_t i = 0; i < sizeof(_data) / sizeof(_data[0]); ++i) + if (rhs._data[i] && !_clone(rhs._data[i], &temp._data[i])) + return; + + _swap(temp); + } + + PUGI__FN void xpath_variable_set::_swap(xpath_variable_set& rhs) + { + for (size_t i = 0; i < sizeof(_data) / sizeof(_data[0]); ++i) + { + xpath_variable* chain = _data[i]; + + _data[i] = rhs._data[i]; + rhs._data[i] = chain; + } + } + + PUGI__FN xpath_variable* xpath_variable_set::_find(const char_t* name) const + { + const size_t hash_size = sizeof(_data) / sizeof(_data[0]); + size_t hash = impl::hash_string(name) % hash_size; + + // look for existing variable + for (xpath_variable* var = _data[hash]; var; var = var->_next) + if (impl::strequal(var->name(), name)) + return var; + + return 0; + } + + PUGI__FN bool xpath_variable_set::_clone(xpath_variable* var, xpath_variable** out_result) + { + xpath_variable* last = 0; + + while (var) + { + // allocate storage for new variable + xpath_variable* nvar = impl::new_xpath_variable(var->_type, var->name()); + if (!nvar) return false; + + // link the variable to the result immediately to handle failures gracefully + if (last) + last->_next = nvar; + else + *out_result = nvar; + + last = nvar; + + // copy the value; this can fail due to out-of-memory conditions + if (!impl::copy_xpath_variable(nvar, var)) return false; + + var = var->_next; + } + + return true; + } + + PUGI__FN void xpath_variable_set::_destroy(xpath_variable* var) + { + while (var) + { + xpath_variable* next = var->_next; + + impl::delete_xpath_variable(var->_type, var); + + var = next; + } + } + + PUGI__FN xpath_variable* xpath_variable_set::add(const char_t* name, xpath_value_type type) + { + const size_t hash_size = sizeof(_data) / sizeof(_data[0]); + size_t hash = impl::hash_string(name) % hash_size; + + // look for existing variable + for (xpath_variable* var = _data[hash]; var; var = var->_next) + if (impl::strequal(var->name(), name)) + return var->type() == type ? var : 0; + + // add new variable + xpath_variable* result = impl::new_xpath_variable(type, name); + + if (result) + { + result->_next = _data[hash]; + + _data[hash] = result; + } + + return result; + } + + PUGI__FN bool xpath_variable_set::set(const char_t* name, bool value) + { + xpath_variable* var = add(name, xpath_type_boolean); + return var ? var->set(value) : false; + } + + PUGI__FN bool xpath_variable_set::set(const char_t* name, double value) + { + xpath_variable* var = add(name, xpath_type_number); + return var ? var->set(value) : false; + } + + PUGI__FN bool xpath_variable_set::set(const char_t* name, const char_t* value) + { + xpath_variable* var = add(name, xpath_type_string); + return var ? var->set(value) : false; + } + + PUGI__FN bool xpath_variable_set::set(const char_t* name, const xpath_node_set& value) + { + xpath_variable* var = add(name, xpath_type_node_set); + return var ? var->set(value) : false; + } + + PUGI__FN xpath_variable* xpath_variable_set::get(const char_t* name) + { + return _find(name); + } + + PUGI__FN const xpath_variable* xpath_variable_set::get(const char_t* name) const + { + return _find(name); + } + + PUGI__FN xpath_query::xpath_query(const char_t* query, xpath_variable_set* variables): _impl(0) + { + impl::xpath_query_impl* qimpl = impl::xpath_query_impl::create(); + + if (!qimpl) + { + #ifdef PUGIXML_NO_EXCEPTIONS + _result.error = "Out of memory"; + #else + throw std::bad_alloc(); + #endif + } + else + { + using impl::auto_deleter; // MSVC7 workaround + auto_deleter impl(qimpl, impl::xpath_query_impl::destroy); + + qimpl->root = impl::xpath_parser::parse(query, variables, &qimpl->alloc, &_result); + + if (qimpl->root) + { + qimpl->root->optimize(&qimpl->alloc); + + _impl = impl.release(); + _result.error = 0; + } + } + } + + PUGI__FN xpath_query::xpath_query(): _impl(0) + { + } + + PUGI__FN xpath_query::~xpath_query() + { + if (_impl) + impl::xpath_query_impl::destroy(static_cast(_impl)); + } + +#ifdef PUGIXML_HAS_MOVE + PUGI__FN xpath_query::xpath_query(xpath_query&& rhs) + { + _impl = rhs._impl; + _result = rhs._result; + rhs._impl = 0; + rhs._result = xpath_parse_result(); + } + + PUGI__FN xpath_query& xpath_query::operator=(xpath_query&& rhs) + { + if (this == &rhs) return *this; + + if (_impl) + impl::xpath_query_impl::destroy(static_cast(_impl)); + + _impl = rhs._impl; + _result = rhs._result; + rhs._impl = 0; + rhs._result = xpath_parse_result(); + + return *this; + } +#endif + + PUGI__FN xpath_value_type xpath_query::return_type() const + { + if (!_impl) return xpath_type_none; + + return static_cast(_impl)->root->rettype(); + } + + PUGI__FN bool xpath_query::evaluate_boolean(const xpath_node& n) const + { + if (!_impl) return false; + + impl::xpath_context c(n, 1, 1); + impl::xpath_stack_data sd; + + #ifdef PUGIXML_NO_EXCEPTIONS + if (setjmp(sd.error_handler)) return false; + #endif + + return static_cast(_impl)->root->eval_boolean(c, sd.stack); + } + + PUGI__FN double xpath_query::evaluate_number(const xpath_node& n) const + { + if (!_impl) return impl::gen_nan(); + + impl::xpath_context c(n, 1, 1); + impl::xpath_stack_data sd; + + #ifdef PUGIXML_NO_EXCEPTIONS + if (setjmp(sd.error_handler)) return impl::gen_nan(); + #endif + + return static_cast(_impl)->root->eval_number(c, sd.stack); + } + +#ifndef PUGIXML_NO_STL + PUGI__FN string_t xpath_query::evaluate_string(const xpath_node& n) const + { + impl::xpath_stack_data sd; + + impl::xpath_string r = impl::evaluate_string_impl(static_cast(_impl), n, sd); + + return string_t(r.c_str(), r.length()); + } +#endif + + PUGI__FN size_t xpath_query::evaluate_string(char_t* buffer, size_t capacity, const xpath_node& n) const + { + impl::xpath_stack_data sd; + + impl::xpath_string r = impl::evaluate_string_impl(static_cast(_impl), n, sd); + + size_t full_size = r.length() + 1; + + if (capacity > 0) + { + size_t size = (full_size < capacity) ? full_size : capacity; + assert(size > 0); + + memcpy(buffer, r.c_str(), (size - 1) * sizeof(char_t)); + buffer[size - 1] = 0; + } + + return full_size; + } + + PUGI__FN xpath_node_set xpath_query::evaluate_node_set(const xpath_node& n) const + { + impl::xpath_ast_node* root = impl::evaluate_node_set_prepare(static_cast(_impl)); + if (!root) return xpath_node_set(); + + impl::xpath_context c(n, 1, 1); + impl::xpath_stack_data sd; + + #ifdef PUGIXML_NO_EXCEPTIONS + if (setjmp(sd.error_handler)) return xpath_node_set(); + #endif + + impl::xpath_node_set_raw r = root->eval_node_set(c, sd.stack, impl::nodeset_eval_all); + + return xpath_node_set(r.begin(), r.end(), r.type()); + } + + PUGI__FN xpath_node xpath_query::evaluate_node(const xpath_node& n) const + { + impl::xpath_ast_node* root = impl::evaluate_node_set_prepare(static_cast(_impl)); + if (!root) return xpath_node(); + + impl::xpath_context c(n, 1, 1); + impl::xpath_stack_data sd; + + #ifdef PUGIXML_NO_EXCEPTIONS + if (setjmp(sd.error_handler)) return xpath_node(); + #endif + + impl::xpath_node_set_raw r = root->eval_node_set(c, sd.stack, impl::nodeset_eval_first); + + return r.first(); + } + + PUGI__FN const xpath_parse_result& xpath_query::result() const + { + return _result; + } + + PUGI__FN static void unspecified_bool_xpath_query(xpath_query***) + { + } + + PUGI__FN xpath_query::operator xpath_query::unspecified_bool_type() const + { + return _impl ? unspecified_bool_xpath_query : 0; + } + + PUGI__FN bool xpath_query::operator!() const + { + return !_impl; + } + + PUGI__FN xpath_node xml_node::select_node(const char_t* query, xpath_variable_set* variables) const + { + xpath_query q(query, variables); + return select_node(q); + } + + PUGI__FN xpath_node xml_node::select_node(const xpath_query& query) const + { + return query.evaluate_node(*this); + } + + PUGI__FN xpath_node_set xml_node::select_nodes(const char_t* query, xpath_variable_set* variables) const + { + xpath_query q(query, variables); + return select_nodes(q); + } + + PUGI__FN xpath_node_set xml_node::select_nodes(const xpath_query& query) const + { + return query.evaluate_node_set(*this); + } + + PUGI__FN xpath_node xml_node::select_single_node(const char_t* query, xpath_variable_set* variables) const + { + xpath_query q(query, variables); + return select_single_node(q); + } + + PUGI__FN xpath_node xml_node::select_single_node(const xpath_query& query) const + { + return query.evaluate_node(*this); + } +} + +#endif + +#ifdef __BORLANDC__ +# pragma option pop +#endif + +// Intel C++ does not properly keep warning state for function templates, +// so popping warning state at the end of translation unit leads to warnings in the middle. +#if defined(_MSC_VER) && !defined(__INTEL_COMPILER) +# pragma warning(pop) +#endif + +// Undefine all local macros (makes sure we're not leaking macros in header-only mode) +#undef PUGI__NO_INLINE +#undef PUGI__UNLIKELY +#undef PUGI__STATIC_ASSERT +#undef PUGI__DMC_VOLATILE +#undef PUGI__MSVC_CRT_VERSION +#undef PUGI__NS_BEGIN +#undef PUGI__NS_END +#undef PUGI__FN +#undef PUGI__FN_NO_INLINE +#undef PUGI__GETHEADER_IMPL +#undef PUGI__GETPAGE_IMPL +#undef PUGI__GETPAGE +#undef PUGI__NODETYPE +#undef PUGI__IS_CHARTYPE_IMPL +#undef PUGI__IS_CHARTYPE +#undef PUGI__IS_CHARTYPEX +#undef PUGI__ENDSWITH +#undef PUGI__SKIPWS +#undef PUGI__OPTSET +#undef PUGI__PUSHNODE +#undef PUGI__POPNODE +#undef PUGI__SCANFOR +#undef PUGI__SCANWHILE +#undef PUGI__SCANWHILE_UNROLL +#undef PUGI__ENDSEG +#undef PUGI__THROW_ERROR +#undef PUGI__CHECK_ERROR + +#endif + +/** + * Copyright (c) 2006-2016 Arseny Kapoulkine + * + * Permission is hereby granted, free of charge, to any person + * obtaining a copy of this software and associated documentation + * files (the "Software"), to deal in the Software without + * restriction, including without limitation the rights to use, + * copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following + * conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR + * OTHER DEALINGS IN THE SOFTWARE. + */ diff --git a/linux/include/pugixml/pugixml.hpp b/linux/include/pugixml/pugixml.hpp new file mode 100644 index 000000000..6288d4bd9 --- /dev/null +++ b/linux/include/pugixml/pugixml.hpp @@ -0,0 +1,1434 @@ +/** + * pugixml parser - version 1.8 + * -------------------------------------------------------- + * Copyright (C) 2006-2016, by Arseny Kapoulkine (arseny.kapoulkine@gmail.com) + * Report bugs and download new versions at http://pugixml.org/ + * + * This library is distributed under the MIT License. See notice at the end + * of this file. + * + * This work is based on the pugxml parser, which is: + * Copyright (C) 2003, by Kristen Wegner (kristen@tima.net) + */ + +#ifndef PUGIXML_VERSION +// Define version macro; evaluates to major * 100 + minor so that it's safe to use in less-than comparisons +# define PUGIXML_VERSION 180 +#endif + +// Include user configuration file (this can define various configuration macros) +#include "pugiconfig.hpp" + +#ifndef HEADER_PUGIXML_HPP +#define HEADER_PUGIXML_HPP + +// Include stddef.h for size_t and ptrdiff_t +#include + +// Include exception header for XPath +#if !defined(PUGIXML_NO_XPATH) && !defined(PUGIXML_NO_EXCEPTIONS) +# include +#endif + +// Include STL headers +#ifndef PUGIXML_NO_STL +# include +# include +# include +#endif + +// Macro for deprecated features +#ifndef PUGIXML_DEPRECATED +# if defined(__GNUC__) +# define PUGIXML_DEPRECATED __attribute__((deprecated)) +# elif defined(_MSC_VER) && _MSC_VER >= 1300 +# define PUGIXML_DEPRECATED __declspec(deprecated) +# else +# define PUGIXML_DEPRECATED +# endif +#endif + +// If no API is defined, assume default +#ifndef PUGIXML_API +# define PUGIXML_API +#endif + +// If no API for classes is defined, assume default +#ifndef PUGIXML_CLASS +# define PUGIXML_CLASS PUGIXML_API +#endif + +// If no API for functions is defined, assume default +#ifndef PUGIXML_FUNCTION +# define PUGIXML_FUNCTION PUGIXML_API +#endif + +// If the platform is known to have long long support, enable long long functions +#ifndef PUGIXML_HAS_LONG_LONG +# if __cplusplus >= 201103 +# define PUGIXML_HAS_LONG_LONG +# elif defined(_MSC_VER) && _MSC_VER >= 1400 +# define PUGIXML_HAS_LONG_LONG +# endif +#endif + +// If the platform is known to have move semantics support, compile move ctor/operator implementation +#ifndef PUGIXML_HAS_MOVE +# if __cplusplus >= 201103 +# define PUGIXML_HAS_MOVE +# elif defined(_MSC_VER) && _MSC_VER >= 1600 +# define PUGIXML_HAS_MOVE +# endif +#endif + +// If C++ is 2011 or higher, add 'override' qualifiers +#ifndef PUGIXML_OVERRIDE +# if __cplusplus >= 201103 +# define PUGIXML_OVERRIDE override +# else +# define PUGIXML_OVERRIDE +# endif +#endif + +// Character interface macros +#ifdef PUGIXML_WCHAR_MODE +# define PUGIXML_TEXT(t) L ## t +# define PUGIXML_CHAR wchar_t +#else +# define PUGIXML_TEXT(t) t +# define PUGIXML_CHAR char +#endif + +namespace pugi +{ + // Character type used for all internal storage and operations; depends on PUGIXML_WCHAR_MODE + typedef PUGIXML_CHAR char_t; + +#ifndef PUGIXML_NO_STL + // String type used for operations that work with STL string; depends on PUGIXML_WCHAR_MODE + typedef std::basic_string, std::allocator > string_t; +#endif +} + +// The PugiXML namespace +namespace pugi +{ + // Tree node types + enum xml_node_type + { + node_null, // Empty (null) node handle + node_document, // A document tree's absolute root + node_element, // Element tag, i.e. '' + node_pcdata, // Plain character data, i.e. 'text' + node_cdata, // Character data, i.e. '' + node_comment, // Comment tag, i.e. '' + node_pi, // Processing instruction, i.e. '' + node_declaration, // Document declaration, i.e. '' + node_doctype // Document type declaration, i.e. '' + }; + + // Parsing options + + // Minimal parsing mode (equivalent to turning all other flags off). + // Only elements and PCDATA sections are added to the DOM tree, no text conversions are performed. + const unsigned int parse_minimal = 0x0000; + + // This flag determines if processing instructions (node_pi) are added to the DOM tree. This flag is off by default. + const unsigned int parse_pi = 0x0001; + + // This flag determines if comments (node_comment) are added to the DOM tree. This flag is off by default. + const unsigned int parse_comments = 0x0002; + + // This flag determines if CDATA sections (node_cdata) are added to the DOM tree. This flag is on by default. + const unsigned int parse_cdata = 0x0004; + + // This flag determines if plain character data (node_pcdata) that consist only of whitespace are added to the DOM tree. + // This flag is off by default; turning it on usually results in slower parsing and more memory consumption. + const unsigned int parse_ws_pcdata = 0x0008; + + // This flag determines if character and entity references are expanded during parsing. This flag is on by default. + const unsigned int parse_escapes = 0x0010; + + // This flag determines if EOL characters are normalized (converted to #xA) during parsing. This flag is on by default. + const unsigned int parse_eol = 0x0020; + + // This flag determines if attribute values are normalized using CDATA normalization rules during parsing. This flag is on by default. + const unsigned int parse_wconv_attribute = 0x0040; + + // This flag determines if attribute values are normalized using NMTOKENS normalization rules during parsing. This flag is off by default. + const unsigned int parse_wnorm_attribute = 0x0080; + + // This flag determines if document declaration (node_declaration) is added to the DOM tree. This flag is off by default. + const unsigned int parse_declaration = 0x0100; + + // This flag determines if document type declaration (node_doctype) is added to the DOM tree. This flag is off by default. + const unsigned int parse_doctype = 0x0200; + + // This flag determines if plain character data (node_pcdata) that is the only child of the parent node and that consists only + // of whitespace is added to the DOM tree. + // This flag is off by default; turning it on may result in slower parsing and more memory consumption. + const unsigned int parse_ws_pcdata_single = 0x0400; + + // This flag determines if leading and trailing whitespace is to be removed from plain character data. This flag is off by default. + const unsigned int parse_trim_pcdata = 0x0800; + + // This flag determines if plain character data that does not have a parent node is added to the DOM tree, and if an empty document + // is a valid document. This flag is off by default. + const unsigned int parse_fragment = 0x1000; + + // This flag determines if plain character data is be stored in the parent element's value. This significantly changes the structure of + // the document; this flag is only recommended for parsing documents with many PCDATA nodes in memory-constrained environments. + // This flag is off by default. + const unsigned int parse_embed_pcdata = 0x2000; + + // The default parsing mode. + // Elements, PCDATA and CDATA sections are added to the DOM tree, character/reference entities are expanded, + // End-of-Line characters are normalized, attribute values are normalized using CDATA normalization rules. + const unsigned int parse_default = parse_cdata | parse_escapes | parse_wconv_attribute | parse_eol; + + // The full parsing mode. + // Nodes of all types are added to the DOM tree, character/reference entities are expanded, + // End-of-Line characters are normalized, attribute values are normalized using CDATA normalization rules. + const unsigned int parse_full = parse_default | parse_pi | parse_comments | parse_declaration | parse_doctype; + + // These flags determine the encoding of input data for XML document + enum xml_encoding + { + encoding_auto, // Auto-detect input encoding using BOM or < / class xml_object_range + { + public: + typedef It const_iterator; + typedef It iterator; + + xml_object_range(It b, It e): _begin(b), _end(e) + { + } + + It begin() const { return _begin; } + It end() const { return _end; } + + private: + It _begin, _end; + }; + + // Writer interface for node printing (see xml_node::print) + class PUGIXML_CLASS xml_writer + { + public: + virtual ~xml_writer() {} + + // Write memory chunk into stream/file/whatever + virtual void write(const void* data, size_t size) = 0; + }; + + // xml_writer implementation for FILE* + class PUGIXML_CLASS xml_writer_file: public xml_writer + { + public: + // Construct writer from a FILE* object; void* is used to avoid header dependencies on stdio + xml_writer_file(void* file); + + virtual void write(const void* data, size_t size) PUGIXML_OVERRIDE; + + private: + void* file; + }; + + #ifndef PUGIXML_NO_STL + // xml_writer implementation for streams + class PUGIXML_CLASS xml_writer_stream: public xml_writer + { + public: + // Construct writer from an output stream object + xml_writer_stream(std::basic_ostream >& stream); + xml_writer_stream(std::basic_ostream >& stream); + + virtual void write(const void* data, size_t size) PUGIXML_OVERRIDE; + + private: + std::basic_ostream >* narrow_stream; + std::basic_ostream >* wide_stream; + }; + #endif + + // A light-weight handle for manipulating attributes in DOM tree + class PUGIXML_CLASS xml_attribute + { + friend class xml_attribute_iterator; + friend class xml_node; + + private: + xml_attribute_struct* _attr; + + typedef void (*unspecified_bool_type)(xml_attribute***); + + public: + // Default constructor. Constructs an empty attribute. + xml_attribute(); + + // Constructs attribute from internal pointer + explicit xml_attribute(xml_attribute_struct* attr); + + // Safe bool conversion operator + operator unspecified_bool_type() const; + + // Borland C++ workaround + bool operator!() const; + + // Comparison operators (compares wrapped attribute pointers) + bool operator==(const xml_attribute& r) const; + bool operator!=(const xml_attribute& r) const; + bool operator<(const xml_attribute& r) const; + bool operator>(const xml_attribute& r) const; + bool operator<=(const xml_attribute& r) const; + bool operator>=(const xml_attribute& r) const; + + // Check if attribute is empty + bool empty() const; + + // Get attribute name/value, or "" if attribute is empty + const char_t* name() const; + const char_t* value() const; + + // Get attribute value, or the default value if attribute is empty + const char_t* as_string(const char_t* def = PUGIXML_TEXT("")) const; + + // Get attribute value as a number, or the default value if conversion did not succeed or attribute is empty + int as_int(int def = 0) const; + unsigned int as_uint(unsigned int def = 0) const; + double as_double(double def = 0) const; + float as_float(float def = 0) const; + + #ifdef PUGIXML_HAS_LONG_LONG + long long as_llong(long long def = 0) const; + unsigned long long as_ullong(unsigned long long def = 0) const; + #endif + + // Get attribute value as bool (returns true if first character is in '1tTyY' set), or the default value if attribute is empty + bool as_bool(bool def = false) const; + + // Set attribute name/value (returns false if attribute is empty or there is not enough memory) + bool set_name(const char_t* rhs); + bool set_value(const char_t* rhs); + + // Set attribute value with type conversion (numbers are converted to strings, boolean is converted to "true"/"false") + bool set_value(int rhs); + bool set_value(unsigned int rhs); + bool set_value(long rhs); + bool set_value(unsigned long rhs); + bool set_value(double rhs); + bool set_value(float rhs); + bool set_value(bool rhs); + + #ifdef PUGIXML_HAS_LONG_LONG + bool set_value(long long rhs); + bool set_value(unsigned long long rhs); + #endif + + // Set attribute value (equivalent to set_value without error checking) + xml_attribute& operator=(const char_t* rhs); + xml_attribute& operator=(int rhs); + xml_attribute& operator=(unsigned int rhs); + xml_attribute& operator=(long rhs); + xml_attribute& operator=(unsigned long rhs); + xml_attribute& operator=(double rhs); + xml_attribute& operator=(float rhs); + xml_attribute& operator=(bool rhs); + + #ifdef PUGIXML_HAS_LONG_LONG + xml_attribute& operator=(long long rhs); + xml_attribute& operator=(unsigned long long rhs); + #endif + + // Get next/previous attribute in the attribute list of the parent node + xml_attribute next_attribute() const; + xml_attribute previous_attribute() const; + + // Get hash value (unique for handles to the same object) + size_t hash_value() const; + + // Get internal pointer + xml_attribute_struct* internal_object() const; + }; + +#ifdef __BORLANDC__ + // Borland C++ workaround + bool PUGIXML_FUNCTION operator&&(const xml_attribute& lhs, bool rhs); + bool PUGIXML_FUNCTION operator||(const xml_attribute& lhs, bool rhs); +#endif + + // A light-weight handle for manipulating nodes in DOM tree + class PUGIXML_CLASS xml_node + { + friend class xml_attribute_iterator; + friend class xml_node_iterator; + friend class xml_named_node_iterator; + + protected: + xml_node_struct* _root; + + typedef void (*unspecified_bool_type)(xml_node***); + + public: + // Default constructor. Constructs an empty node. + xml_node(); + + // Constructs node from internal pointer + explicit xml_node(xml_node_struct* p); + + // Safe bool conversion operator + operator unspecified_bool_type() const; + + // Borland C++ workaround + bool operator!() const; + + // Comparison operators (compares wrapped node pointers) + bool operator==(const xml_node& r) const; + bool operator!=(const xml_node& r) const; + bool operator<(const xml_node& r) const; + bool operator>(const xml_node& r) const; + bool operator<=(const xml_node& r) const; + bool operator>=(const xml_node& r) const; + + // Check if node is empty. + bool empty() const; + + // Get node type + xml_node_type type() const; + + // Get node name, or "" if node is empty or it has no name + const char_t* name() const; + + // Get node value, or "" if node is empty or it has no value + // Note: For text node.value() does not return "text"! Use child_value() or text() methods to access text inside nodes. + const char_t* value() const; + + // Get attribute list + xml_attribute first_attribute() const; + xml_attribute last_attribute() const; + + // Get children list + xml_node first_child() const; + xml_node last_child() const; + + // Get next/previous sibling in the children list of the parent node + xml_node next_sibling() const; + xml_node previous_sibling() const; + + // Get parent node + xml_node parent() const; + + // Get root of DOM tree this node belongs to + xml_node root() const; + + // Get text object for the current node + xml_text text() const; + + // Get child, attribute or next/previous sibling with the specified name + xml_node child(const char_t* name) const; + xml_attribute attribute(const char_t* name) const; + xml_node next_sibling(const char_t* name) const; + xml_node previous_sibling(const char_t* name) const; + + // Get attribute, starting the search from a hint (and updating hint so that searching for a sequence of attributes is fast) + xml_attribute attribute(const char_t* name, xml_attribute& hint) const; + + // Get child value of current node; that is, value of the first child node of type PCDATA/CDATA + const char_t* child_value() const; + + // Get child value of child with specified name. Equivalent to child(name).child_value(). + const char_t* child_value(const char_t* name) const; + + // Set node name/value (returns false if node is empty, there is not enough memory, or node can not have name/value) + bool set_name(const char_t* rhs); + bool set_value(const char_t* rhs); + + // Add attribute with specified name. Returns added attribute, or empty attribute on errors. + xml_attribute append_attribute(const char_t* name); + xml_attribute prepend_attribute(const char_t* name); + xml_attribute insert_attribute_after(const char_t* name, const xml_attribute& attr); + xml_attribute insert_attribute_before(const char_t* name, const xml_attribute& attr); + + // Add a copy of the specified attribute. Returns added attribute, or empty attribute on errors. + xml_attribute append_copy(const xml_attribute& proto); + xml_attribute prepend_copy(const xml_attribute& proto); + xml_attribute insert_copy_after(const xml_attribute& proto, const xml_attribute& attr); + xml_attribute insert_copy_before(const xml_attribute& proto, const xml_attribute& attr); + + // Add child node with specified type. Returns added node, or empty node on errors. + xml_node append_child(xml_node_type type = node_element); + xml_node prepend_child(xml_node_type type = node_element); + xml_node insert_child_after(xml_node_type type, const xml_node& node); + xml_node insert_child_before(xml_node_type type, const xml_node& node); + + // Add child element with specified name. Returns added node, or empty node on errors. + xml_node append_child(const char_t* name); + xml_node prepend_child(const char_t* name); + xml_node insert_child_after(const char_t* name, const xml_node& node); + xml_node insert_child_before(const char_t* name, const xml_node& node); + + // Add a copy of the specified node as a child. Returns added node, or empty node on errors. + xml_node append_copy(const xml_node& proto); + xml_node prepend_copy(const xml_node& proto); + xml_node insert_copy_after(const xml_node& proto, const xml_node& node); + xml_node insert_copy_before(const xml_node& proto, const xml_node& node); + + // Move the specified node to become a child of this node. Returns moved node, or empty node on errors. + xml_node append_move(const xml_node& moved); + xml_node prepend_move(const xml_node& moved); + xml_node insert_move_after(const xml_node& moved, const xml_node& node); + xml_node insert_move_before(const xml_node& moved, const xml_node& node); + + // Remove specified attribute + bool remove_attribute(const xml_attribute& a); + bool remove_attribute(const char_t* name); + + // Remove specified child + bool remove_child(const xml_node& n); + bool remove_child(const char_t* name); + + // Parses buffer as an XML document fragment and appends all nodes as children of the current node. + // Copies/converts the buffer, so it may be deleted or changed after the function returns. + // Note: append_buffer allocates memory that has the lifetime of the owning document; removing the appended nodes does not immediately reclaim that memory. + xml_parse_result append_buffer(const void* contents, size_t size, unsigned int options = parse_default, xml_encoding encoding = encoding_auto); + + // Find attribute using predicate. Returns first attribute for which predicate returned true. + template xml_attribute find_attribute(Predicate pred) const + { + if (!_root) return xml_attribute(); + + for (xml_attribute attrib = first_attribute(); attrib; attrib = attrib.next_attribute()) + if (pred(attrib)) + return attrib; + + return xml_attribute(); + } + + // Find child node using predicate. Returns first child for which predicate returned true. + template xml_node find_child(Predicate pred) const + { + if (!_root) return xml_node(); + + for (xml_node node = first_child(); node; node = node.next_sibling()) + if (pred(node)) + return node; + + return xml_node(); + } + + // Find node from subtree using predicate. Returns first node from subtree (depth-first), for which predicate returned true. + template xml_node find_node(Predicate pred) const + { + if (!_root) return xml_node(); + + xml_node cur = first_child(); + + while (cur._root && cur._root != _root) + { + if (pred(cur)) return cur; + + if (cur.first_child()) cur = cur.first_child(); + else if (cur.next_sibling()) cur = cur.next_sibling(); + else + { + while (!cur.next_sibling() && cur._root != _root) cur = cur.parent(); + + if (cur._root != _root) cur = cur.next_sibling(); + } + } + + return xml_node(); + } + + // Find child node by attribute name/value + xml_node find_child_by_attribute(const char_t* name, const char_t* attr_name, const char_t* attr_value) const; + xml_node find_child_by_attribute(const char_t* attr_name, const char_t* attr_value) const; + + #ifndef PUGIXML_NO_STL + // Get the absolute node path from root as a text string. + string_t path(char_t delimiter = '/') const; + #endif + + // Search for a node by path consisting of node names and . or .. elements. + xml_node first_element_by_path(const char_t* path, char_t delimiter = '/') const; + + // Recursively traverse subtree with xml_tree_walker + bool traverse(xml_tree_walker& walker); + + #ifndef PUGIXML_NO_XPATH + // Select single node by evaluating XPath query. Returns first node from the resulting node set. + xpath_node select_node(const char_t* query, xpath_variable_set* variables = 0) const; + xpath_node select_node(const xpath_query& query) const; + + // Select node set by evaluating XPath query + xpath_node_set select_nodes(const char_t* query, xpath_variable_set* variables = 0) const; + xpath_node_set select_nodes(const xpath_query& query) const; + + // (deprecated: use select_node instead) Select single node by evaluating XPath query. + xpath_node select_single_node(const char_t* query, xpath_variable_set* variables = 0) const; + xpath_node select_single_node(const xpath_query& query) const; + + #endif + + // Print subtree using a writer object + void print(xml_writer& writer, const char_t* indent = PUGIXML_TEXT("\t"), unsigned int flags = format_default, xml_encoding encoding = encoding_auto, unsigned int depth = 0) const; + + #ifndef PUGIXML_NO_STL + // Print subtree to stream + void print(std::basic_ostream >& os, const char_t* indent = PUGIXML_TEXT("\t"), unsigned int flags = format_default, xml_encoding encoding = encoding_auto, unsigned int depth = 0) const; + void print(std::basic_ostream >& os, const char_t* indent = PUGIXML_TEXT("\t"), unsigned int flags = format_default, unsigned int depth = 0) const; + #endif + + // Child nodes iterators + typedef xml_node_iterator iterator; + + iterator begin() const; + iterator end() const; + + // Attribute iterators + typedef xml_attribute_iterator attribute_iterator; + + attribute_iterator attributes_begin() const; + attribute_iterator attributes_end() const; + + // Range-based for support + xml_object_range children() const; + xml_object_range children(const char_t* name) const; + xml_object_range attributes() const; + + // Get node offset in parsed file/string (in char_t units) for debugging purposes + ptrdiff_t offset_debug() const; + + // Get hash value (unique for handles to the same object) + size_t hash_value() const; + + // Get internal pointer + xml_node_struct* internal_object() const; + }; + +#ifdef __BORLANDC__ + // Borland C++ workaround + bool PUGIXML_FUNCTION operator&&(const xml_node& lhs, bool rhs); + bool PUGIXML_FUNCTION operator||(const xml_node& lhs, bool rhs); +#endif + + // A helper for working with text inside PCDATA nodes + class PUGIXML_CLASS xml_text + { + friend class xml_node; + + xml_node_struct* _root; + + typedef void (*unspecified_bool_type)(xml_text***); + + explicit xml_text(xml_node_struct* root); + + xml_node_struct* _data_new(); + xml_node_struct* _data() const; + + public: + // Default constructor. Constructs an empty object. + xml_text(); + + // Safe bool conversion operator + operator unspecified_bool_type() const; + + // Borland C++ workaround + bool operator!() const; + + // Check if text object is empty + bool empty() const; + + // Get text, or "" if object is empty + const char_t* get() const; + + // Get text, or the default value if object is empty + const char_t* as_string(const char_t* def = PUGIXML_TEXT("")) const; + + // Get text as a number, or the default value if conversion did not succeed or object is empty + int as_int(int def = 0) const; + unsigned int as_uint(unsigned int def = 0) const; + double as_double(double def = 0) const; + float as_float(float def = 0) const; + + #ifdef PUGIXML_HAS_LONG_LONG + long long as_llong(long long def = 0) const; + unsigned long long as_ullong(unsigned long long def = 0) const; + #endif + + // Get text as bool (returns true if first character is in '1tTyY' set), or the default value if object is empty + bool as_bool(bool def = false) const; + + // Set text (returns false if object is empty or there is not enough memory) + bool set(const char_t* rhs); + + // Set text with type conversion (numbers are converted to strings, boolean is converted to "true"/"false") + bool set(int rhs); + bool set(unsigned int rhs); + bool set(long rhs); + bool set(unsigned long rhs); + bool set(double rhs); + bool set(float rhs); + bool set(bool rhs); + + #ifdef PUGIXML_HAS_LONG_LONG + bool set(long long rhs); + bool set(unsigned long long rhs); + #endif + + // Set text (equivalent to set without error checking) + xml_text& operator=(const char_t* rhs); + xml_text& operator=(int rhs); + xml_text& operator=(unsigned int rhs); + xml_text& operator=(long rhs); + xml_text& operator=(unsigned long rhs); + xml_text& operator=(double rhs); + xml_text& operator=(float rhs); + xml_text& operator=(bool rhs); + + #ifdef PUGIXML_HAS_LONG_LONG + xml_text& operator=(long long rhs); + xml_text& operator=(unsigned long long rhs); + #endif + + // Get the data node (node_pcdata or node_cdata) for this object + xml_node data() const; + }; + +#ifdef __BORLANDC__ + // Borland C++ workaround + bool PUGIXML_FUNCTION operator&&(const xml_text& lhs, bool rhs); + bool PUGIXML_FUNCTION operator||(const xml_text& lhs, bool rhs); +#endif + + // Child node iterator (a bidirectional iterator over a collection of xml_node) + class PUGIXML_CLASS xml_node_iterator + { + friend class xml_node; + + private: + mutable xml_node _wrap; + xml_node _parent; + + xml_node_iterator(xml_node_struct* ref, xml_node_struct* parent); + + public: + // Iterator traits + typedef ptrdiff_t difference_type; + typedef xml_node value_type; + typedef xml_node* pointer; + typedef xml_node& reference; + + #ifndef PUGIXML_NO_STL + typedef std::bidirectional_iterator_tag iterator_category; + #endif + + // Default constructor + xml_node_iterator(); + + // Construct an iterator which points to the specified node + xml_node_iterator(const xml_node& node); + + // Iterator operators + bool operator==(const xml_node_iterator& rhs) const; + bool operator!=(const xml_node_iterator& rhs) const; + + xml_node& operator*() const; + xml_node* operator->() const; + + const xml_node_iterator& operator++(); + xml_node_iterator operator++(int); + + const xml_node_iterator& operator--(); + xml_node_iterator operator--(int); + }; + + // Attribute iterator (a bidirectional iterator over a collection of xml_attribute) + class PUGIXML_CLASS xml_attribute_iterator + { + friend class xml_node; + + private: + mutable xml_attribute _wrap; + xml_node _parent; + + xml_attribute_iterator(xml_attribute_struct* ref, xml_node_struct* parent); + + public: + // Iterator traits + typedef ptrdiff_t difference_type; + typedef xml_attribute value_type; + typedef xml_attribute* pointer; + typedef xml_attribute& reference; + + #ifndef PUGIXML_NO_STL + typedef std::bidirectional_iterator_tag iterator_category; + #endif + + // Default constructor + xml_attribute_iterator(); + + // Construct an iterator which points to the specified attribute + xml_attribute_iterator(const xml_attribute& attr, const xml_node& parent); + + // Iterator operators + bool operator==(const xml_attribute_iterator& rhs) const; + bool operator!=(const xml_attribute_iterator& rhs) const; + + xml_attribute& operator*() const; + xml_attribute* operator->() const; + + const xml_attribute_iterator& operator++(); + xml_attribute_iterator operator++(int); + + const xml_attribute_iterator& operator--(); + xml_attribute_iterator operator--(int); + }; + + // Named node range helper + class PUGIXML_CLASS xml_named_node_iterator + { + friend class xml_node; + + public: + // Iterator traits + typedef ptrdiff_t difference_type; + typedef xml_node value_type; + typedef xml_node* pointer; + typedef xml_node& reference; + + #ifndef PUGIXML_NO_STL + typedef std::bidirectional_iterator_tag iterator_category; + #endif + + // Default constructor + xml_named_node_iterator(); + + // Construct an iterator which points to the specified node + xml_named_node_iterator(const xml_node& node, const char_t* name); + + // Iterator operators + bool operator==(const xml_named_node_iterator& rhs) const; + bool operator!=(const xml_named_node_iterator& rhs) const; + + xml_node& operator*() const; + xml_node* operator->() const; + + const xml_named_node_iterator& operator++(); + xml_named_node_iterator operator++(int); + + const xml_named_node_iterator& operator--(); + xml_named_node_iterator operator--(int); + + private: + mutable xml_node _wrap; + xml_node _parent; + const char_t* _name; + + xml_named_node_iterator(xml_node_struct* ref, xml_node_struct* parent, const char_t* name); + }; + + // Abstract tree walker class (see xml_node::traverse) + class PUGIXML_CLASS xml_tree_walker + { + friend class xml_node; + + private: + int _depth; + + protected: + // Get current traversal depth + int depth() const; + + public: + xml_tree_walker(); + virtual ~xml_tree_walker(); + + // Callback that is called when traversal begins + virtual bool begin(xml_node& node); + + // Callback that is called for each node traversed + virtual bool for_each(xml_node& node) = 0; + + // Callback that is called when traversal ends + virtual bool end(xml_node& node); + }; + + // Parsing status, returned as part of xml_parse_result object + enum xml_parse_status + { + status_ok = 0, // No error + + status_file_not_found, // File was not found during load_file() + status_io_error, // Error reading from file/stream + status_out_of_memory, // Could not allocate memory + status_internal_error, // Internal error occurred + + status_unrecognized_tag, // Parser could not determine tag type + + status_bad_pi, // Parsing error occurred while parsing document declaration/processing instruction + status_bad_comment, // Parsing error occurred while parsing comment + status_bad_cdata, // Parsing error occurred while parsing CDATA section + status_bad_doctype, // Parsing error occurred while parsing document type declaration + status_bad_pcdata, // Parsing error occurred while parsing PCDATA section + status_bad_start_element, // Parsing error occurred while parsing start element tag + status_bad_attribute, // Parsing error occurred while parsing element attribute + status_bad_end_element, // Parsing error occurred while parsing end element tag + status_end_element_mismatch,// There was a mismatch of start-end tags (closing tag had incorrect name, some tag was not closed or there was an excessive closing tag) + + status_append_invalid_root, // Unable to append nodes since root type is not node_element or node_document (exclusive to xml_node::append_buffer) + + status_no_document_element // Parsing resulted in a document without element nodes + }; + + // Parsing result + struct PUGIXML_CLASS xml_parse_result + { + // Parsing status (see xml_parse_status) + xml_parse_status status; + + // Last parsed offset (in char_t units from start of input data) + ptrdiff_t offset; + + // Source document encoding + xml_encoding encoding; + + // Default constructor, initializes object to failed state + xml_parse_result(); + + // Cast to bool operator + operator bool() const; + + // Get error description + const char* description() const; + }; + + // Document class (DOM tree root) + class PUGIXML_CLASS xml_document: public xml_node + { + private: + char_t* _buffer; + + char _memory[192]; + + // Non-copyable semantics + xml_document(const xml_document&); + xml_document& operator=(const xml_document&); + + void _create(); + void _destroy(); + + public: + // Default constructor, makes empty document + xml_document(); + + // Destructor, invalidates all node/attribute handles to this document + ~xml_document(); + + // Removes all nodes, leaving the empty document + void reset(); + + // Removes all nodes, then copies the entire contents of the specified document + void reset(const xml_document& proto); + + #ifndef PUGIXML_NO_STL + // Load document from stream. + xml_parse_result load(std::basic_istream >& stream, unsigned int options = parse_default, xml_encoding encoding = encoding_auto); + xml_parse_result load(std::basic_istream >& stream, unsigned int options = parse_default); + #endif + + // (deprecated: use load_string instead) Load document from zero-terminated string. No encoding conversions are applied. + xml_parse_result load(const char_t* contents, unsigned int options = parse_default); + + // Load document from zero-terminated string. No encoding conversions are applied. + xml_parse_result load_string(const char_t* contents, unsigned int options = parse_default); + + // Load document from file + xml_parse_result load_file(const char* path, unsigned int options = parse_default, xml_encoding encoding = encoding_auto); + xml_parse_result load_file(const wchar_t* path, unsigned int options = parse_default, xml_encoding encoding = encoding_auto); + + // Load document from buffer. Copies/converts the buffer, so it may be deleted or changed after the function returns. + xml_parse_result load_buffer(const void* contents, size_t size, unsigned int options = parse_default, xml_encoding encoding = encoding_auto); + + // Load document from buffer, using the buffer for in-place parsing (the buffer is modified and used for storage of document data). + // You should ensure that buffer data will persist throughout the document's lifetime, and free the buffer memory manually once document is destroyed. + xml_parse_result load_buffer_inplace(void* contents, size_t size, unsigned int options = parse_default, xml_encoding encoding = encoding_auto); + + // Load document from buffer, using the buffer for in-place parsing (the buffer is modified and used for storage of document data). + // You should allocate the buffer with pugixml allocation function; document will free the buffer when it is no longer needed (you can't use it anymore). + xml_parse_result load_buffer_inplace_own(void* contents, size_t size, unsigned int options = parse_default, xml_encoding encoding = encoding_auto); + + // Save XML document to writer (semantics is slightly different from xml_node::print, see documentation for details). + void save(xml_writer& writer, const char_t* indent = PUGIXML_TEXT("\t"), unsigned int flags = format_default, xml_encoding encoding = encoding_auto) const; + + #ifndef PUGIXML_NO_STL + // Save XML document to stream (semantics is slightly different from xml_node::print, see documentation for details). + void save(std::basic_ostream >& stream, const char_t* indent = PUGIXML_TEXT("\t"), unsigned int flags = format_default, xml_encoding encoding = encoding_auto) const; + void save(std::basic_ostream >& stream, const char_t* indent = PUGIXML_TEXT("\t"), unsigned int flags = format_default) const; + #endif + + // Save XML to file + bool save_file(const char* path, const char_t* indent = PUGIXML_TEXT("\t"), unsigned int flags = format_default, xml_encoding encoding = encoding_auto) const; + bool save_file(const wchar_t* path, const char_t* indent = PUGIXML_TEXT("\t"), unsigned int flags = format_default, xml_encoding encoding = encoding_auto) const; + + // Get document element + xml_node document_element() const; + }; + +#ifndef PUGIXML_NO_XPATH + // XPath query return type + enum xpath_value_type + { + xpath_type_none, // Unknown type (query failed to compile) + xpath_type_node_set, // Node set (xpath_node_set) + xpath_type_number, // Number + xpath_type_string, // String + xpath_type_boolean // Boolean + }; + + // XPath parsing result + struct PUGIXML_CLASS xpath_parse_result + { + // Error message (0 if no error) + const char* error; + + // Last parsed offset (in char_t units from string start) + ptrdiff_t offset; + + // Default constructor, initializes object to failed state + xpath_parse_result(); + + // Cast to bool operator + operator bool() const; + + // Get error description + const char* description() const; + }; + + // A single XPath variable + class PUGIXML_CLASS xpath_variable + { + friend class xpath_variable_set; + + protected: + xpath_value_type _type; + xpath_variable* _next; + + xpath_variable(xpath_value_type type); + + // Non-copyable semantics + xpath_variable(const xpath_variable&); + xpath_variable& operator=(const xpath_variable&); + + public: + // Get variable name + const char_t* name() const; + + // Get variable type + xpath_value_type type() const; + + // Get variable value; no type conversion is performed, default value (false, NaN, empty string, empty node set) is returned on type mismatch error + bool get_boolean() const; + double get_number() const; + const char_t* get_string() const; + const xpath_node_set& get_node_set() const; + + // Set variable value; no type conversion is performed, false is returned on type mismatch error + bool set(bool value); + bool set(double value); + bool set(const char_t* value); + bool set(const xpath_node_set& value); + }; + + // A set of XPath variables + class PUGIXML_CLASS xpath_variable_set + { + private: + xpath_variable* _data[64]; + + void _assign(const xpath_variable_set& rhs); + void _swap(xpath_variable_set& rhs); + + xpath_variable* _find(const char_t* name) const; + + static bool _clone(xpath_variable* var, xpath_variable** out_result); + static void _destroy(xpath_variable* var); + + public: + // Default constructor/destructor + xpath_variable_set(); + ~xpath_variable_set(); + + // Copy constructor/assignment operator + xpath_variable_set(const xpath_variable_set& rhs); + xpath_variable_set& operator=(const xpath_variable_set& rhs); + + #ifdef PUGIXML_HAS_MOVE + // Move semantics support + xpath_variable_set(xpath_variable_set&& rhs); + xpath_variable_set& operator=(xpath_variable_set&& rhs); + #endif + + // Add a new variable or get the existing one, if the types match + xpath_variable* add(const char_t* name, xpath_value_type type); + + // Set value of an existing variable; no type conversion is performed, false is returned if there is no such variable or if types mismatch + bool set(const char_t* name, bool value); + bool set(const char_t* name, double value); + bool set(const char_t* name, const char_t* value); + bool set(const char_t* name, const xpath_node_set& value); + + // Get existing variable by name + xpath_variable* get(const char_t* name); + const xpath_variable* get(const char_t* name) const; + }; + + // A compiled XPath query object + class PUGIXML_CLASS xpath_query + { + private: + void* _impl; + xpath_parse_result _result; + + typedef void (*unspecified_bool_type)(xpath_query***); + + // Non-copyable semantics + xpath_query(const xpath_query&); + xpath_query& operator=(const xpath_query&); + + public: + // Construct a compiled object from XPath expression. + // If PUGIXML_NO_EXCEPTIONS is not defined, throws xpath_exception on compilation errors. + explicit xpath_query(const char_t* query, xpath_variable_set* variables = 0); + + // Constructor + xpath_query(); + + // Destructor + ~xpath_query(); + + #ifdef PUGIXML_HAS_MOVE + // Move semantics support + xpath_query(xpath_query&& rhs); + xpath_query& operator=(xpath_query&& rhs); + #endif + + // Get query expression return type + xpath_value_type return_type() const; + + // Evaluate expression as boolean value in the specified context; performs type conversion if necessary. + // If PUGIXML_NO_EXCEPTIONS is not defined, throws std::bad_alloc on out of memory errors. + bool evaluate_boolean(const xpath_node& n) const; + + // Evaluate expression as double value in the specified context; performs type conversion if necessary. + // If PUGIXML_NO_EXCEPTIONS is not defined, throws std::bad_alloc on out of memory errors. + double evaluate_number(const xpath_node& n) const; + + #ifndef PUGIXML_NO_STL + // Evaluate expression as string value in the specified context; performs type conversion if necessary. + // If PUGIXML_NO_EXCEPTIONS is not defined, throws std::bad_alloc on out of memory errors. + string_t evaluate_string(const xpath_node& n) const; + #endif + + // Evaluate expression as string value in the specified context; performs type conversion if necessary. + // At most capacity characters are written to the destination buffer, full result size is returned (includes terminating zero). + // If PUGIXML_NO_EXCEPTIONS is not defined, throws std::bad_alloc on out of memory errors. + // If PUGIXML_NO_EXCEPTIONS is defined, returns empty set instead. + size_t evaluate_string(char_t* buffer, size_t capacity, const xpath_node& n) const; + + // Evaluate expression as node set in the specified context. + // If PUGIXML_NO_EXCEPTIONS is not defined, throws xpath_exception on type mismatch and std::bad_alloc on out of memory errors. + // If PUGIXML_NO_EXCEPTIONS is defined, returns empty node set instead. + xpath_node_set evaluate_node_set(const xpath_node& n) const; + + // Evaluate expression as node set in the specified context. + // Return first node in document order, or empty node if node set is empty. + // If PUGIXML_NO_EXCEPTIONS is not defined, throws xpath_exception on type mismatch and std::bad_alloc on out of memory errors. + // If PUGIXML_NO_EXCEPTIONS is defined, returns empty node instead. + xpath_node evaluate_node(const xpath_node& n) const; + + // Get parsing result (used to get compilation errors in PUGIXML_NO_EXCEPTIONS mode) + const xpath_parse_result& result() const; + + // Safe bool conversion operator + operator unspecified_bool_type() const; + + // Borland C++ workaround + bool operator!() const; + }; + + #ifndef PUGIXML_NO_EXCEPTIONS + // XPath exception class + class PUGIXML_CLASS xpath_exception: public std::exception + { + private: + xpath_parse_result _result; + + public: + // Construct exception from parse result + explicit xpath_exception(const xpath_parse_result& result); + + // Get error message + virtual const char* what() const throw() PUGIXML_OVERRIDE; + + // Get parse result + const xpath_parse_result& result() const; + }; + #endif + + // XPath node class (either xml_node or xml_attribute) + class PUGIXML_CLASS xpath_node + { + private: + xml_node _node; + xml_attribute _attribute; + + typedef void (*unspecified_bool_type)(xpath_node***); + + public: + // Default constructor; constructs empty XPath node + xpath_node(); + + // Construct XPath node from XML node/attribute + xpath_node(const xml_node& node); + xpath_node(const xml_attribute& attribute, const xml_node& parent); + + // Get node/attribute, if any + xml_node node() const; + xml_attribute attribute() const; + + // Get parent of contained node/attribute + xml_node parent() const; + + // Safe bool conversion operator + operator unspecified_bool_type() const; + + // Borland C++ workaround + bool operator!() const; + + // Comparison operators + bool operator==(const xpath_node& n) const; + bool operator!=(const xpath_node& n) const; + }; + +#ifdef __BORLANDC__ + // Borland C++ workaround + bool PUGIXML_FUNCTION operator&&(const xpath_node& lhs, bool rhs); + bool PUGIXML_FUNCTION operator||(const xpath_node& lhs, bool rhs); +#endif + + // A fixed-size collection of XPath nodes + class PUGIXML_CLASS xpath_node_set + { + public: + // Collection type + enum type_t + { + type_unsorted, // Not ordered + type_sorted, // Sorted by document order (ascending) + type_sorted_reverse // Sorted by document order (descending) + }; + + // Constant iterator type + typedef const xpath_node* const_iterator; + + // We define non-constant iterator to be the same as constant iterator so that various generic algorithms (i.e. boost foreach) work + typedef const xpath_node* iterator; + + // Default constructor. Constructs empty set. + xpath_node_set(); + + // Constructs a set from iterator range; data is not checked for duplicates and is not sorted according to provided type, so be careful + xpath_node_set(const_iterator begin, const_iterator end, type_t type = type_unsorted); + + // Destructor + ~xpath_node_set(); + + // Copy constructor/assignment operator + xpath_node_set(const xpath_node_set& ns); + xpath_node_set& operator=(const xpath_node_set& ns); + + #ifdef PUGIXML_HAS_MOVE + // Move semantics support + xpath_node_set(xpath_node_set&& rhs); + xpath_node_set& operator=(xpath_node_set&& rhs); + #endif + + // Get collection type + type_t type() const; + + // Get collection size + size_t size() const; + + // Indexing operator + const xpath_node& operator[](size_t index) const; + + // Collection iterators + const_iterator begin() const; + const_iterator end() const; + + // Sort the collection in ascending/descending order by document order + void sort(bool reverse = false); + + // Get first node in the collection by document order + xpath_node first() const; + + // Check if collection is empty + bool empty() const; + + private: + type_t _type; + + xpath_node _storage; + + xpath_node* _begin; + xpath_node* _end; + + void _assign(const_iterator begin, const_iterator end, type_t type); + void _move(xpath_node_set& rhs); + }; +#endif + +#ifndef PUGIXML_NO_STL + // Convert wide string to UTF8 + std::basic_string, std::allocator > PUGIXML_FUNCTION as_utf8(const wchar_t* str); + std::basic_string, std::allocator > PUGIXML_FUNCTION as_utf8(const std::basic_string, std::allocator >& str); + + // Convert UTF8 to wide string + std::basic_string, std::allocator > PUGIXML_FUNCTION as_wide(const char* str); + std::basic_string, std::allocator > PUGIXML_FUNCTION as_wide(const std::basic_string, std::allocator >& str); +#endif + + // Memory allocation function interface; returns pointer to allocated memory or NULL on failure + typedef void* (*allocation_function)(size_t size); + + // Memory deallocation function interface + typedef void (*deallocation_function)(void* ptr); + + // Override default memory management functions. All subsequent allocations/deallocations will be performed via supplied functions. + void PUGIXML_FUNCTION set_memory_management_functions(allocation_function allocate, deallocation_function deallocate); + + // Get current memory management functions + allocation_function PUGIXML_FUNCTION get_memory_allocation_function(); + deallocation_function PUGIXML_FUNCTION get_memory_deallocation_function(); +} + +#if !defined(PUGIXML_NO_STL) && (defined(_MSC_VER) || defined(__ICC)) +namespace std +{ + // Workarounds for (non-standard) iterator category detection for older versions (MSVC7/IC8 and earlier) + std::bidirectional_iterator_tag PUGIXML_FUNCTION _Iter_cat(const pugi::xml_node_iterator&); + std::bidirectional_iterator_tag PUGIXML_FUNCTION _Iter_cat(const pugi::xml_attribute_iterator&); + std::bidirectional_iterator_tag PUGIXML_FUNCTION _Iter_cat(const pugi::xml_named_node_iterator&); +} +#endif + +#if !defined(PUGIXML_NO_STL) && defined(__SUNPRO_CC) +namespace std +{ + // Workarounds for (non-standard) iterator category detection + std::bidirectional_iterator_tag PUGIXML_FUNCTION __iterator_category(const pugi::xml_node_iterator&); + std::bidirectional_iterator_tag PUGIXML_FUNCTION __iterator_category(const pugi::xml_attribute_iterator&); + std::bidirectional_iterator_tag PUGIXML_FUNCTION __iterator_category(const pugi::xml_named_node_iterator&); +} +#endif + +#endif + +// Make sure implementation is included in header-only mode +// Use macro expansion in #include to work around QMake (QTBUG-11923) +#if defined(PUGIXML_HEADER_ONLY) && !defined(PUGIXML_SOURCE) +# define PUGIXML_SOURCE "pugixml.cpp" +# include PUGIXML_SOURCE +#endif + +/** + * Copyright (c) 2006-2016 Arseny Kapoulkine + * + * Permission is hereby granted, free of charge, to any person + * obtaining a copy of this software and associated documentation + * files (the "Software"), to deal in the Software without + * restriction, including without limitation the rights to use, + * copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following + * conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR + * OTHER DEALINGS IN THE SOFTWARE. + */ diff --git a/linux/include/sqlite/sqlite3.h b/linux/include/sqlite/sqlite3.h index 4c109b2b8..f3cf3b464 100644 --- a/linux/include/sqlite/sqlite3.h +++ b/linux/include/sqlite/sqlite3.h @@ -123,7 +123,7 @@ extern "C" { */ #define SQLITE_VERSION "3.20.0" #define SQLITE_VERSION_NUMBER 3020000 -#define SQLITE_SOURCE_ID "2017-08-08 22:48:04 a78d932165bd7dc2ac9042c93762c4dcc22bf1ed" +#define SQLITE_SOURCE_ID "2017-08-08 23:33:01 a80452fd36181666ad43237d451a5b14ba993d89" /* ** CAPI3REF: Run-Time Library Version Numbers diff --git a/linux/lib/Debug/libACE.so b/linux/lib/Debug/libACE.so new file mode 120000 index 000000000..4ea47ff5c --- /dev/null +++ b/linux/lib/Debug/libACE.so @@ -0,0 +1 @@ +libACE.so.5.7.5 \ No newline at end of file diff --git a/linux/lib/Debug/libACE.so.5.7.5 b/linux/lib/Debug/libACE.so.5.7.5 new file mode 100755 index 000000000..0ce882d50 Binary files /dev/null and b/linux/lib/Debug/libACE.so.5.7.5 differ diff --git a/linux/lib/Debug/libOnixS.CmeMdp3HandlerCpp.so b/linux/lib/Debug/libOnixS.CmeMdp3HandlerCpp.so new file mode 120000 index 000000000..4dc84ff6a --- /dev/null +++ b/linux/lib/Debug/libOnixS.CmeMdp3HandlerCpp.so @@ -0,0 +1 @@ +libOnixS.CmeMdp3HandlerCpp.so.3.8.0.0 \ No newline at end of file diff --git a/linux/lib/Debug/libOnixS.CmeMdp3HandlerCpp.so.3.8.0.0 b/linux/lib/Debug/libOnixS.CmeMdp3HandlerCpp.so.3.8.0.0 new file mode 100755 index 000000000..9c2d4454e Binary files /dev/null and b/linux/lib/Debug/libOnixS.CmeMdp3HandlerCpp.so.3.8.0.0 differ diff --git a/linux/lib/debug/libboost_atomic.a b/linux/lib/Debug/libboost_atomic.a similarity index 100% rename from linux/lib/debug/libboost_atomic.a rename to linux/lib/Debug/libboost_atomic.a diff --git a/linux/lib/debug/libboost_chrono.a b/linux/lib/Debug/libboost_chrono.a similarity index 100% rename from linux/lib/debug/libboost_chrono.a rename to linux/lib/Debug/libboost_chrono.a diff --git a/linux/lib/debug/libboost_date_time.a b/linux/lib/Debug/libboost_date_time.a similarity index 100% rename from linux/lib/debug/libboost_date_time.a rename to linux/lib/Debug/libboost_date_time.a diff --git a/linux/lib/debug/libboost_filesystem.a b/linux/lib/Debug/libboost_filesystem.a similarity index 100% rename from linux/lib/debug/libboost_filesystem.a rename to linux/lib/Debug/libboost_filesystem.a diff --git a/linux/lib/debug/libboost_regex.a b/linux/lib/Debug/libboost_regex.a similarity index 100% rename from linux/lib/debug/libboost_regex.a rename to linux/lib/Debug/libboost_regex.a diff --git a/linux/lib/debug/libboost_system.a b/linux/lib/Debug/libboost_system.a similarity index 100% rename from linux/lib/debug/libboost_system.a rename to linux/lib/Debug/libboost_system.a diff --git a/linux/lib/debug/libboost_thread.a b/linux/lib/Debug/libboost_thread.a similarity index 100% rename from linux/lib/debug/libboost_thread.a rename to linux/lib/Debug/libboost_thread.a diff --git a/linux/lib/debug/libcurl.a b/linux/lib/Debug/libcurl.a similarity index 100% rename from linux/lib/debug/libcurl.a rename to linux/lib/Debug/libcurl.a diff --git a/linux/lib/debug/libdouble-conversion.a b/linux/lib/Debug/libdouble-conversion.a similarity index 100% rename from linux/lib/debug/libdouble-conversion.a rename to linux/lib/Debug/libdouble-conversion.a diff --git a/linux/lib/debug/libfmt.a b/linux/lib/Debug/libfmt.a similarity index 100% rename from linux/lib/debug/libfmt.a rename to linux/lib/Debug/libfmt.a diff --git a/linux/lib/debug/libprotobuf.a b/linux/lib/Debug/libprotobuf.a similarity index 100% rename from linux/lib/debug/libprotobuf.a rename to linux/lib/Debug/libprotobuf.a diff --git a/linux/lib/debug/libprotoc.a b/linux/lib/Debug/libprotoc.a similarity index 100% rename from linux/lib/debug/libprotoc.a rename to linux/lib/Debug/libprotoc.a diff --git a/linux/lib/Debug/libpugixml.a b/linux/lib/Debug/libpugixml.a new file mode 100644 index 000000000..0c869f53c Binary files /dev/null and b/linux/lib/Debug/libpugixml.a differ diff --git a/linux/lib/debug/libsqlite3.a b/linux/lib/Debug/libsqlite3.a similarity index 99% rename from linux/lib/debug/libsqlite3.a rename to linux/lib/Debug/libsqlite3.a index 1502eb458..f7d926306 100644 Binary files a/linux/lib/debug/libsqlite3.a and b/linux/lib/Debug/libsqlite3.a differ diff --git a/linux/lib/debug/libtbb.a b/linux/lib/Debug/libtbb.a similarity index 99% rename from linux/lib/debug/libtbb.a rename to linux/lib/Debug/libtbb.a index b017f8b1e..33d79ecc0 100644 Binary files a/linux/lib/debug/libtbb.a and b/linux/lib/Debug/libtbb.a differ diff --git a/linux/lib/debug/libz.a b/linux/lib/Debug/libz.a similarity index 100% rename from linux/lib/debug/libz.a rename to linux/lib/Debug/libz.a diff --git a/linux/lib/Release/libACE.so b/linux/lib/Release/libACE.so new file mode 120000 index 000000000..4ea47ff5c --- /dev/null +++ b/linux/lib/Release/libACE.so @@ -0,0 +1 @@ +libACE.so.5.7.5 \ No newline at end of file diff --git a/linux/lib/Release/libACE.so.5.7.5 b/linux/lib/Release/libACE.so.5.7.5 new file mode 100755 index 000000000..0ce882d50 Binary files /dev/null and b/linux/lib/Release/libACE.so.5.7.5 differ diff --git a/linux/lib/Release/libOnixS.CmeMdp3HandlerCpp.so b/linux/lib/Release/libOnixS.CmeMdp3HandlerCpp.so new file mode 120000 index 000000000..4dc84ff6a --- /dev/null +++ b/linux/lib/Release/libOnixS.CmeMdp3HandlerCpp.so @@ -0,0 +1 @@ +libOnixS.CmeMdp3HandlerCpp.so.3.8.0.0 \ No newline at end of file diff --git a/linux/lib/Release/libOnixS.CmeMdp3HandlerCpp.so.3.8.0.0 b/linux/lib/Release/libOnixS.CmeMdp3HandlerCpp.so.3.8.0.0 new file mode 100755 index 000000000..9c2d4454e Binary files /dev/null and b/linux/lib/Release/libOnixS.CmeMdp3HandlerCpp.so.3.8.0.0 differ diff --git a/linux/lib/release/libboost_atomic.a b/linux/lib/Release/libboost_atomic.a similarity index 100% rename from linux/lib/release/libboost_atomic.a rename to linux/lib/Release/libboost_atomic.a diff --git a/linux/lib/release/libboost_chrono.a b/linux/lib/Release/libboost_chrono.a similarity index 100% rename from linux/lib/release/libboost_chrono.a rename to linux/lib/Release/libboost_chrono.a diff --git a/linux/lib/release/libboost_date_time.a b/linux/lib/Release/libboost_date_time.a similarity index 100% rename from linux/lib/release/libboost_date_time.a rename to linux/lib/Release/libboost_date_time.a diff --git a/linux/lib/release/libboost_filesystem.a b/linux/lib/Release/libboost_filesystem.a similarity index 100% rename from linux/lib/release/libboost_filesystem.a rename to linux/lib/Release/libboost_filesystem.a diff --git a/linux/lib/release/libboost_regex.a b/linux/lib/Release/libboost_regex.a similarity index 100% rename from linux/lib/release/libboost_regex.a rename to linux/lib/Release/libboost_regex.a diff --git a/linux/lib/release/libboost_system.a b/linux/lib/Release/libboost_system.a similarity index 100% rename from linux/lib/release/libboost_system.a rename to linux/lib/Release/libboost_system.a diff --git a/linux/lib/release/libboost_thread.a b/linux/lib/Release/libboost_thread.a similarity index 100% rename from linux/lib/release/libboost_thread.a rename to linux/lib/Release/libboost_thread.a diff --git a/linux/lib/release/libcurl.a b/linux/lib/Release/libcurl.a similarity index 100% rename from linux/lib/release/libcurl.a rename to linux/lib/Release/libcurl.a diff --git a/linux/lib/release/libdouble-conversion.a b/linux/lib/Release/libdouble-conversion.a similarity index 100% rename from linux/lib/release/libdouble-conversion.a rename to linux/lib/Release/libdouble-conversion.a diff --git a/linux/lib/release/libfmt.a b/linux/lib/Release/libfmt.a similarity index 100% rename from linux/lib/release/libfmt.a rename to linux/lib/Release/libfmt.a diff --git a/linux/lib/release/libprotobuf.a b/linux/lib/Release/libprotobuf.a similarity index 100% rename from linux/lib/release/libprotobuf.a rename to linux/lib/Release/libprotobuf.a diff --git a/linux/lib/release/libprotoc.a b/linux/lib/Release/libprotoc.a similarity index 100% rename from linux/lib/release/libprotoc.a rename to linux/lib/Release/libprotoc.a diff --git a/linux/lib/Release/libpugixml.a b/linux/lib/Release/libpugixml.a new file mode 100644 index 000000000..47c25cef0 Binary files /dev/null and b/linux/lib/Release/libpugixml.a differ diff --git a/linux/lib/release/libsqlite3.a b/linux/lib/Release/libsqlite3.a similarity index 99% rename from linux/lib/release/libsqlite3.a rename to linux/lib/Release/libsqlite3.a index 1502eb458..f7d926306 100644 Binary files a/linux/lib/release/libsqlite3.a and b/linux/lib/Release/libsqlite3.a differ diff --git a/linux/lib/release/libtbb.a b/linux/lib/Release/libtbb.a similarity index 99% rename from linux/lib/release/libtbb.a rename to linux/lib/Release/libtbb.a index 11e740eaa..4e8973556 100644 Binary files a/linux/lib/release/libtbb.a and b/linux/lib/Release/libtbb.a differ diff --git a/linux/lib/release/libz.a b/linux/lib/Release/libz.a similarity index 100% rename from linux/lib/release/libz.a rename to linux/lib/Release/libz.a diff --git a/src/boost/build_boost.sh b/src/boost/build_boost.sh index 4a3d286d3..43f6b99f7 100755 --- a/src/boost/build_boost.sh +++ b/src/boost/build_boost.sh @@ -9,9 +9,9 @@ target=$root/linux if [ -d "$work" ]; then rm -Rf $work; fi mkdir $work -rm -f $target/lib/debug/libboost.* -rm -f $target/lib/release/libboost.* -rm -f $target/include/boost +rm -f $target/lib/Debug/libboost.* +rm -f $target/lib/Release/libboost.* +rm -rf $target/include/boost unzip -q $src/boost/$boost -d $work @@ -33,7 +33,7 @@ cp -R boost $target/include/ --with-date_time \ --with-atomic -cp stage/lib/* $target/lib/release +cp stage/lib/* $target/lib/Release rm -rf stage # build debug @@ -47,6 +47,6 @@ rm -rf stage --with-date_time \ --with-atomic -cp stage/lib/* $target/lib/debug +cp stage/lib/* $target/lib/Debug rm -rf $work diff --git a/src/curl/build_curl.sh b/src/curl/build_curl.sh index ba920cce9..3c71e0979 100755 --- a/src/curl/build_curl.sh +++ b/src/curl/build_curl.sh @@ -9,9 +9,9 @@ target=$root/linux if [ -d "$work" ]; then rm -Rf $work; fi mkdir $work -rm -f $target/lib/debug/libcurl.* -rm -f $target/lib/release/libcurl.* -rm -f $target/include/curl +rm -f $target/lib/Debug/libcurl.* +rm -f $target/lib/Release/libcurl.* +rm -rf $target/include/curl unzip -q $src/curl/$curl -d $work @@ -50,7 +50,7 @@ cd $work/$curl --prefix=$work/$curl/debug_build make -j$(nproc) install -cp -R debug_build/lib/libcurl.a $target/lib/debug/ +cp -R debug_build/lib/libcurl.a $target/lib/Debug/ rm -Rf $work mkdir $work @@ -89,6 +89,6 @@ cd $work/$curl make -j$(nproc) install cp -R release_build/include/curl $target/include -cp -R release_build/lib/libcurl.a $target/lib/release/ +cp -R release_build/lib/libcurl.a $target/lib/Release/ rm -Rf $work diff --git a/src/double-conversion/build_double-conversion.sh b/src/double-conversion/build_double-conversion.sh index bb559bb1f..54a4b5405 100755 --- a/src/double-conversion/build_double-conversion.sh +++ b/src/double-conversion/build_double-conversion.sh @@ -9,7 +9,7 @@ target=$root/linux if [ -d "$work" ]; then rm -Rf $work; fi mkdir $work -rm -f $target/lib/debug/libdouble.* +rm -f $target/lib/Debug/libdouble.* rm -f $target/lib/release/libdouble.* rm -rf $target/include/double-conversion @@ -23,15 +23,15 @@ mkdir debug_build cd debug_build cmake -DCMAKE_BUILD_TYPE=Debug .. make -j $(nproc) -cp double-conversion/libdouble-conversion.a $target/lib/debug/ +cp double-conversion/libdouble-conversion.a $target/lib/Debug/ -# debug +# release cd $work/$double mkdir release_build cd release_build cmake -DCMAKE_BUILD_TYPE=Release .. make -j $(nproc) -cp double-conversion/libdouble-conversion.a $target/lib/release/ +cp double-conversion/libdouble-conversion.a $target/lib/Release/ -# rm -Rf $work +rm -Rf $work diff --git a/src/fmt/build_fmt.sh b/src/fmt/build_fmt.sh index 50f45868b..5af49a98e 100755 --- a/src/fmt/build_fmt.sh +++ b/src/fmt/build_fmt.sh @@ -9,9 +9,9 @@ target=$root/linux if [ -d "$work" ]; then rm -Rf $work; fi mkdir $work -rm -f $target/lib/debug/libfmt.* -rm -f $target/lib/release/libfmt.* -rm -f $target/include/fmt +rm -f $target/lib/Debug/libfmt.* +rm -f $target/lib/Release/libfmt.* +rm -rf $target/include/fmt unzip -q $src/fmt/$fmt -d $work @@ -23,7 +23,7 @@ mkdir debug_build cd debug_build cmake -DFMT_TEST=no -DFMT_INSTALL=no -DCMAKE_BUILD_TYPE=Debug .. make -j $(nproc) -cp fmt/libfmt.a $target/lib/debug/ +cp fmt/libfmt.a $target/lib/Debug/ # release cd $work/$fmt @@ -31,6 +31,5 @@ mkdir release_build cd release_build cmake -DFMT_TEST=no -DFMT_INSTALL=no -DCMAKE_BUILD_TYPE=Release .. make -j $(nproc) -cp fmt/libfmt.a $target/lib/release/ +cp fmt/libfmt.a $target/lib/Release/ -rm -Rf $work diff --git a/src/onixs/OnixS.CmeMdp3HandlerCpp-Ubuntu1404-gcc482-x64-3.8.0.0.zip b/src/onixs/OnixS.CmeMdp3HandlerCpp-Ubuntu1404-gcc482-x64-3.8.0.0.zip new file mode 100644 index 000000000..0cf7e0e89 Binary files /dev/null and b/src/onixs/OnixS.CmeMdp3HandlerCpp-Ubuntu1404-gcc482-x64-3.8.0.0.zip differ diff --git a/src/onixs/build_onixs.sh b/src/onixs/build_onixs.sh new file mode 100755 index 000000000..bbc400f10 --- /dev/null +++ b/src/onixs/build_onixs.sh @@ -0,0 +1,24 @@ +#!/bin/bash + +onixs="OnixS.CmeMdp3HandlerCpp-Ubuntu1404-gcc482-x64-3.8.0.0" +root=`realpath ../..` +work=$root/work +src=$root/src +target=$root/linux + +if [ -d "$work" ]; then rm -Rf $work; fi +mkdir $work + +rm -f $target/lib/Debug/libOnixS* +rm -f $target/lib/Debug/libACE* +rm -f $target/lib/Release/libOnixS* +rm -f $target/lib/Release/libACE* +rm -rf $target/include/OnixS + +unzip -q $src/onixs/$onixs -d $work +cp -R $work/$onixs/include/OnixS $target/include/OnixS +cp -R $work/$onixs/lib/* $target/lib/Debug/ +cp -R $work/$onixs/lib/* $target/lib/Release/ + +rm -rf $work + diff --git a/src/protobuf/build_protobuf.sh b/src/protobuf/build_protobuf.sh index 783e1c06a..9f329c3e8 100755 --- a/src/protobuf/build_protobuf.sh +++ b/src/protobuf/build_protobuf.sh @@ -9,8 +9,8 @@ target=$root/linux if [ -d "$work" ]; then rm -Rf $work; fi mkdir $work -rm -f $target/lib/debug/libproto* -rm -f $target/lib/release/libproto* +rm -f $target/lib/Debug/libproto* +rm -f $target/lib/Release/libproto* rm -rf $target/include/google rm -f $target/bin/proto* @@ -27,8 +27,8 @@ cd release cmake -DCMAKE_BUILD_TYPE=Release -Dprotobuf_BUILD_TESTS=OFF $work/$protobuf/cmake make -j $(nproc) cp protoc $target/bin/ -cp libprotobuf.a $target/lib/release -cp libprotoc.a $target/lib/release +cp libprotobuf.a $target/lib/Release +cp libprotoc.a $target/lib/Release # debug cd $work/$protobuf @@ -36,8 +36,8 @@ mkdir debug cd debug cmake -DCMAKE_BUILD_TYPE=Debug -Dprotobuf_BUILD_TESTS=OFF $work/$protobuf/cmake make -j $(nproc) -cp libprotobufd.a $target/lib/debug/libprotobuf.a -cp libprotocd.a $target/lib/debug/libprotoc.a +cp libprotobufd.a $target/lib/Debug/libprotobuf.a +cp libprotocd.a $target/lib/Debug/libprotoc.a rm -rf $work diff --git a/src/pugixml/build_pugixml.sh b/src/pugixml/build_pugixml.sh new file mode 100755 index 000000000..0876e1ea7 --- /dev/null +++ b/src/pugixml/build_pugixml.sh @@ -0,0 +1,42 @@ +#!/bin/bash + +pugi="pugixml-1.8.1" +root=`realpath ../..` +work=$root/work +src=$root/src +target=$root/linux + +if [ -d "$work" ]; then rm -Rf $work; fi +mkdir $work + +rm -f $target/lib/Debug/libpugi.* +rm -f $target/lib/Release/libpugi.* +rm -rf $target/include/pugixml + +unzip -q $src/pugixml/$pugi -d $work + +mkdir -p $target/include/pugixml + +# headers +cp -R $work/$pugi/src/* $target/include/pugixml/ + +# debug +cd $work/$pugi +mkdir debug_build +cd debug_build +cmake -DCMAKE_BUILD_TYPE=Debug .. +make -j $(nproc) +cp libpugixml.a $target/lib/Debug/ + +# release +cd $work/$pugi +mkdir release_build +cd release_build +cmake -DCMAKE_BUILD_TYPE=Release .. +make -j $(nproc) +cp libpugixml.a $target/lib/Release/ + +# clean up +rm -rf $work + + diff --git a/src/pugixml/pugixml-1.8.1.zip b/src/pugixml/pugixml-1.8.1.zip new file mode 100644 index 000000000..bcd54cea3 Binary files /dev/null and b/src/pugixml/pugixml-1.8.1.zip differ diff --git a/src/sqlite/build_sqlite.sh b/src/sqlite/build_sqlite.sh index 6cebd0a40..77ba4a13e 100755 --- a/src/sqlite/build_sqlite.sh +++ b/src/sqlite/build_sqlite.sh @@ -9,8 +9,8 @@ target=$root/linux if [ -d "$work" ]; then rm -Rf $work; fi mkdir $work -rm -f $target/lib/debug/libsqlite* -rm -f $target/lib/release/libsqlite* +rm -f $target/lib/Debug/libsqlite* +rm -f $target/lib/Release/libsqlite* rm -f $target/bin/sqlite3 rm -rf $target/include/sqlite3 @@ -32,8 +32,8 @@ make -j $(nproc) sqlite3.c mkdir -p $target/include/sqlite cp sqlite3.h $target/include/sqlite cp sqlite3 $target/bin/ -cp .libs/libsqlite3.a $target/lib/debug/ -cp .libs/libsqlite3.a $target/lib/release/ +cp .libs/libsqlite3.a $target/lib/Debug/ +cp .libs/libsqlite3.a $target/lib/Release/ rm -rf $work diff --git a/src/tbb/build_tbb.sh b/src/tbb/build_tbb.sh index 8b81a0982..723664672 100755 --- a/src/tbb/build_tbb.sh +++ b/src/tbb/build_tbb.sh @@ -9,8 +9,8 @@ target=$root/linux if [ -d "$work" ]; then rm -Rf $work; fi mkdir $work -rm -f $target/lib/debug/libtbb* -rm -f $target/lib/release/libtbb* +rm -f $target/lib/Debug/libtbb* +rm -f $target/lib/Release/libtbb* rm -rf $target/include/tbb unzip -q $src/tbb/$tbb -d $work @@ -18,7 +18,7 @@ cp -R $work/$tbb/include/tbb $target/include/ cd $work/$tbb make -j $(nproc) extra_inc=big_iron.inc tbb -find -name libtbb_debug.a | xargs -I {} cp {} $target/lib/debug/libtbb.a -find -name libtbb.a | xargs -I {} cp {} $target/lib/release/libtbb.a +find -name libtbb_debug.a | xargs -I {} cp {} $target/lib/Debug/libtbb.a +find -name libtbb.a | xargs -I {} cp {} $target/lib/Release/libtbb.a rm -Rf $work diff --git a/src/zlib/build_zlib.sh b/src/zlib/build_zlib.sh index e0bc1c568..4d67c9d22 100755 --- a/src/zlib/build_zlib.sh +++ b/src/zlib/build_zlib.sh @@ -9,8 +9,8 @@ target=$root/linux if [ -d "$work" ]; then rm -Rf $work; fi mkdir $work -rm -f $target/lib/debug/libzlib* -rm -f $target/lib/release/libzlib* +rm -f $target/lib/Debug/libzlib* +rm -f $target/lib/Release/libzlib* rm -rf $target/include/zlib unzip -q $src/zlib/$zlib -d $work @@ -21,7 +21,7 @@ mkdir debug_build cd debug_build cmake -DCMAKE_BUILD_TYPE=Debug .. make -j $(nproc) -cp libz.a $target/lib/debug/ +cp libz.a $target/lib/Debug/ # release cd $work/$zlib @@ -29,7 +29,7 @@ mkdir release_build cd release_build cmake -DCMAKE_BUILD_TYPE=Release .. make -j $(nproc) -cp libz.a $target/lib/release/ +cp libz.a $target/lib/Release/ # headers mkdir -p $target/include/zlib