xml.hpp

Go to the documentation of this file.

//-----------------------------------------------------------------------------------------
/*

Fix8 is released under the GNU LESSER GENERAL PUBLIC LICENSE Version 3.

Fix8 Open Source FIX Engine.
Copyright (C) 2010-16 David L. Dight <fix@fix8.org>

Fix8 is free software: you can  redistribute it and / or modify  it under the  terms of the
GNU Lesser General  Public License as  published  by the Free  Software Foundation,  either
version 3 of the License, or (at your option) any later version.

Fix8 is distributed in the hope  that it will be useful, but WITHOUT ANY WARRANTY;  without
even the  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

You should  have received a copy of the GNU Lesser General Public  License along with Fix8.
If not, see <http://www.gnu.org/licenses/>.

BECAUSE THE PROGRAM IS  LICENSED FREE OF  CHARGE, THERE IS NO  WARRANTY FOR THE PROGRAM, TO
THE EXTENT  PERMITTED  BY  APPLICABLE  LAW.  EXCEPT WHEN  OTHERWISE  STATED IN  WRITING THE
COPYRIGHT HOLDERS AND/OR OTHER PARTIES  PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY
KIND,  EITHER EXPRESSED   OR   IMPLIED,  INCLUDING,  BUT   NOT  LIMITED   TO,  THE  IMPLIED
WARRANTIES  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS TO
THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE,
YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

IN NO EVENT UNLESS REQUIRED  BY APPLICABLE LAW  OR AGREED TO IN  WRITING WILL ANY COPYRIGHT
HOLDER, OR  ANY OTHER PARTY  WHO MAY MODIFY  AND/OR REDISTRIBUTE  THE PROGRAM AS  PERMITTED
ABOVE,  BE  LIABLE  TO  YOU  FOR  DAMAGES,  INCLUDING  ANY  GENERAL, SPECIAL, INCIDENTAL OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR
THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH
HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

*/
//-----------------------------------------------------------------------------------------
#ifndef _XML_ELEMENT_HPP_
# define _XML_ELEMENT_HPP_

//-----------------------------------------------------------------------------------------
#include <set>

//----------------------------------------------------------------------------------------
using Str2Chr = std::map<std::string, unsigned char>;

//----------------------------------------------------------------------------------------
class XmlElement
{
   static const Str2Chr stringtochar_;

   enum { MaxDepth = 128 };
   static FIX8::RegExp rCE_, rCX_, rIn_, rEn_, rEv_;

   XmlElement *parent_, *root_;

   int errors_, line_, incline_, maxdepth_, seq_;
   std::string inclusion_;

   std::string tag_, *value_, *decl_;
   int depth_, sequence_, txtline_, chldcnt_, subidx_;

   struct EntityOrderComp
   {
      bool operator()(const XmlElement *a, const XmlElement *b) const
         { return a->GetSequence() < b->GetSequence(); }
   };

public:
   using XmlSet = std::set<const XmlElement *, EntityOrderComp>;
   using XmlAttrs = std::map<std::string, std::string>;
   XmlAttrs *attrs_;
   F8API static const XmlAttrs emptyattrs_;

   enum Flags { noextensions, nocase };
   using XmlFlags = FIX8::ebitset<Flags>;
   static XmlFlags flags_;
   static void set_flags(XmlFlags flags) { flags_ = flags; }

private:
   using XmlSubEls = std::multimap<std::string, XmlElement *>;
   XmlSubEls *children_;
   bool _was_include;

   XmlSet *ordchildren_;
   F8API static const XmlSet emptyset_;

public:
   F8API XmlElement(std::istream& ifs, int subidx, XmlElement *parent=nullptr, int txtline=0, int depth=0, const char *rootAttr=nullptr);

   F8API virtual ~XmlElement();

   XmlElement(const XmlElement&) = delete;

   XmlElement& operator=(const XmlElement&) = delete;

   F8API int ParseAttrs(const std::string& attlst);

   F8API const XmlElement *find(const std::string& what,
      const std::string *atag=nullptr, const std::string *aval=nullptr, const char delim='/') const;

   F8API int find(const std::string& what, XmlSet& eset,
      const std::string *atag=nullptr, const std::string *aval=nullptr, const char delim='/') const;

   F8API const XmlElement *find_child(const std::string& what,
      const std::string *atag=nullptr, const std::string *aval=nullptr, const char delim='/') const
   {
      const std::string sterm(tag_ + '/' + what);
      return find(sterm, atag, aval, delim);
   }

   F8API int find_child(const std::string& what, XmlSet& eset,
      const std::string *atag=nullptr, const std::string *aval=nullptr, const char delim='/') const
   {
      const std::string sterm(tag_ + '/' + what);
      return find(sterm, eset, atag, aval, delim);
   }

   F8API bool GetAttr(const std::string& what, std::string& target) const;

   bool GetAttrValue(std::string& target) const
   {
      static const std::string valstr("value");
      return GetAttr(valstr, target);
   }

   bool HasAttr(const std::string& what) const
      { return attrs_ ? attrs_->find(what) != attrs_->end() : false; }

   bool FindAttrGetValue(const std::string& what, std::string& target)
   {
       const XmlElement *inst(find(what));
       return inst ? inst->GetAttrValue(target) : false;
   }

   F8API bool findAttrByValue(const std::string& what, const std::string& value) const;

   template<typename T>
   T FindAttr(const std::string& what, const T defValue) const
   {
      if (attrs_)
      {
         XmlAttrs::iterator itr(attrs_->find(what));
         if (itr != attrs_->end())
            return FIX8::get_value<T>(itr->second);
      }

      return defValue;
   }

   template<typename T>
   T& FindAttrRef(const std::string& what, T& target) const
   {
      if (attrs_)
      {
         XmlAttrs::iterator itr(attrs_->find(what));
         if (itr != attrs_->end())
            target = FIX8::get_value<T>(itr->second);
      }

      return target;
   }

   F8API bool Insert( XmlElement *what );

   F8API const std::string& InplaceXlate( std::string& what );

   int GetDepth() const { return depth_; }

   int GetErrorCnt() const { return errors_; }

   int GetLineCnt() const { return line_; }

   int GetChildCnt() const { return chldcnt_; }

   int GetLine() const { return txtline_; }

   int GetSubIdx() const { return subidx_; }

   int GetSequence() const { return sequence_; }

   int GetMaxDepthPermitted() const { return MaxDepth; }

   int GetMaxDepth() const { return maxdepth_; }

   std::string GetPath() const { return parent_ ? parent_->GetPath() + '/' + tag_ : "//" + tag_; }

   const std::string& GetTag() const { return tag_; }

   std::string GetLocString() const
   {
      std::ostringstream ostr;
      ostr << '"' << tag_ << "\" (" << GetPath() << ':' << txtline_ << ')';
      return ostr.str();
   }

   const std::string *GetVal() const { return value_; }

   const std::string *GetDecl() const { return decl_; }

   F8API static XmlElement *Factory(std::istream& istr, const char *docpath=nullptr);

   F8API static XmlElement *Factory(const std::string& fname);

   XmlAttrs::const_iterator abegin() const { return attrs_ ? attrs_->begin() : emptyattrs_.end(); }

   XmlAttrs::const_iterator aend() const { return attrs_ ? attrs_->end() : emptyattrs_.end(); }

   XmlSet::const_iterator begin() const { return ordchildren_ ? ordchildren_->begin() : emptyset_.end(); }

   XmlSet::const_iterator end() const { return ordchildren_ ? ordchildren_->end() : emptyset_.end(); }

   const XmlElement *GetRoot() const { return parent_ ? parent_->root_ : this; }

   const XmlElement *GetParent() const { return parent_; }

   friend F8API std::ostream& operator<<(std::ostream& os, const XmlElement& en);
};

F8API std::ostream& operator<<( std::ostream& os, const XmlElement& en );

#endif // _XML_ELEMENT_HPP_