XdmfCoreReader.cpp 8.11 KB
Newer Older
Kenneth Leiter's avatar
Kenneth Leiter committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
/*****************************************************************************/
/*                                    XDMF                                   */
/*                       eXtensible Data Model and Format                    */
/*                                                                           */
/*  Id : XdmfCoreReader.cpp                                                  */
/*                                                                           */
/*  Author:                                                                  */
/*     Kenneth Leiter                                                        */
/*     kenneth.leiter@arl.army.mil                                           */
/*     US Army Research Laboratory                                           */
/*     Aberdeen Proving Ground, MD                                           */
/*                                                                           */
/*     Copyright @ 2011 US Army Research Laboratory                          */
/*     All Rights Reserved                                                   */
/*     See Copyright.txt for details                                         */
/*                                                                           */
/*     This software is distributed WITHOUT ANY WARRANTY; without            */
/*     even the implied warranty of MERCHANTABILITY or FITNESS               */
/*     FOR A PARTICULAR PURPOSE.  See the above copyright notice             */
/*     for more information.                                                 */
/*                                                                           */
/*****************************************************************************/
23

24
#include <libxml/xpointer.h>
25
#include <libxml/xmlreader.h>
26
#include <map>
27
#include <sstream>
28 29 30
#include "XdmfCoreItemFactory.hpp"
#include "XdmfCoreReader.hpp"
#include "XdmfItem.hpp"
31
#include "XdmfSystemUtils.hpp"
32
#include "XdmfError.hpp"
33 34 35 36 37 38 39 40

/**
 * PIMPL
 */
class XdmfCoreReader::XdmfCoreReaderImpl {

public:

41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
  XdmfCoreReaderImpl(const boost::shared_ptr<const XdmfCoreItemFactory> itemFactory,
                     const XdmfCoreReader * const coreReader) :
    mCoreReader(coreReader),
    mItemFactory(itemFactory)
  {
  };

  ~XdmfCoreReaderImpl()
  {
  };

  void
  closeFile()
  {
    mXPathMap.clear();
    xmlXPathFreeContext(mXPathContext);
    xmlFreeDoc(mDocument);
    xmlCleanupParser();
  }

  void
  openFile(const std::string & filePath)
  {
    mXMLDir = XdmfSystemUtils::getRealPath(filePath);
    size_t index = mXMLDir.find_last_of("/\\");
    if(index != std::string::npos) {
      mXMLDir = mXMLDir.substr(0, index + 1);
    }

    mDocument = xmlReadFile(filePath.c_str(), NULL, 0);

    if(mDocument == NULL) {
73
      XdmfError::message(XdmfError::FATAL, "xmlReadFile could not read "+filePath+" in XdmfCoreReader::XdmfCoreReaderImpl::openFile");
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
    }

    mXPathContext = xmlXPtrNewContext(mDocument, NULL, NULL);
    mXPathMap.clear();
  }

  /**
   * Constructs XdmfItems for all nodes in currNode's tree.
   * XdmfItems are constructed by recursively calling this function for all
   * children of currNode.
   */
  std::vector<boost::shared_ptr<XdmfItem> >
  read(xmlNodePtr currNode)
  {
    std::vector<boost::shared_ptr<XdmfItem> > myItems;

    while(currNode != NULL) {
      if(currNode->type == XML_ELEMENT_NODE) {
        xmlChar * xpointer = NULL;
        if(xmlStrcmp(currNode->name, (xmlChar*)"include") == 0) {
          // Deal with proper reading of XIncludes
          xmlAttrPtr currAttribute = currNode->properties;
          while(currAttribute != NULL) {
            if(xmlStrcmp(currAttribute->name, (xmlChar*)"xpointer") == 0) {
              xpointer = currAttribute->children->content;
              break;
            }
          }
          if(xpointer) {
            xmlXPathObjectPtr xPathObject =
              xmlXPtrEval(xpointer, mXPathContext);
            if(xPathObject && xPathObject->nodesetval) {
              for(int i=0; i<xPathObject->nodesetval->nodeNr; ++i) {
                this->readSingleNode(xPathObject->nodesetval->nodeTab[i],
                                     myItems);
              }
            }
            xmlXPathFreeObject(xPathObject);
          }
        }
        else {
          // Normal reading
          this->readSingleNode(currNode, myItems);
        }
      }
      currNode = currNode->next;
    }
    return myItems;
  }

  /**
   * Reads a single xmlNode into an XdmfItem object in memory. The constructed
   * XdmfItem is added to myItems and an entry is added mapping the xmlNodePtr
   * to the new XdmfItem in the mXPathMap.
   */
  void
  readSingleNode(const xmlNodePtr currNode,
                 std::vector<boost::shared_ptr<XdmfItem> > & myItems)
  {
    std::map<xmlNodePtr, boost::shared_ptr<XdmfItem> >::const_iterator iter =
      mXPathMap.find(currNode);
    if(iter != mXPathMap.end()) {
      myItems.push_back(iter->second);
    }
    else {
      std::map<std::string, std::string> itemProperties;
      if(currNode->children != NULL) {
        xmlChar *content = xmlNodeGetContent(currNode);
        itemProperties["Content"] = (char*)content;
        xmlFree(content);
        itemProperties["XMLDir"] = mXMLDir;
      }
      xmlAttrPtr currAttribute = currNode->properties;
      while(currAttribute != NULL) {
        itemProperties[(const char *)currAttribute->name] =
          (const char *)currAttribute->children->content;
        currAttribute = currAttribute->next;
      }

      std::vector<boost::shared_ptr<XdmfItem> > childItems =
        this->read(currNode->children);
      boost::shared_ptr<XdmfItem> newItem =
        mItemFactory->createItem((const char *)currNode->name,
                                 itemProperties,
                                 childItems);
      if(newItem == NULL) {
160
        XdmfError::message(XdmfError::FATAL, "mItemFactory failed to createItem in XdmfCoreReader::XdmfCoreReaderImpl::readSingleNode");
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
      }

      newItem->populateItem(itemProperties, childItems, mCoreReader);
      myItems.push_back(newItem);
      mXPathMap[currNode] = newItem;
    }
  }

  void
  readPathObjects(const std::string & xPath,
                  std::vector<boost::shared_ptr<XdmfItem> > & myItems)
  {
    xmlXPathObjectPtr xPathObject =
      xmlXPathEvalExpression((xmlChar*)xPath.c_str(), mXPathContext);
    if(xPathObject && xPathObject->nodesetval) {
      for(int i=0; i<xPathObject->nodesetval->nodeNr; ++i) {
        this->readSingleNode(xPathObject->nodesetval->nodeTab[i], myItems);
      }
    }
    xmlXPathFreeObject(xPathObject);
  }

  xmlDocPtr mDocument;
  const XdmfCoreReader * const mCoreReader;
  const boost::shared_ptr<const XdmfCoreItemFactory> mItemFactory;
  std::string mXMLDir;
  xmlXPathContextPtr mXPathContext;
  std::map<xmlNodePtr, boost::shared_ptr<XdmfItem> > mXPathMap;
189 190
};

191
XdmfCoreReader::XdmfCoreReader(const boost::shared_ptr<const XdmfCoreItemFactory> itemFactory) :
192
  mImpl(new XdmfCoreReaderImpl(itemFactory, this))
193 194 195 196 197
{
}

XdmfCoreReader::~XdmfCoreReader()
{
198
  delete mImpl;
199 200
}

201 202
std::vector<boost::shared_ptr<XdmfItem> >
XdmfCoreReader::readItems(const std::string & filePath) const
203
{
204 205 206 207 208 209
  mImpl->openFile(filePath);
  const xmlNodePtr currNode = xmlDocGetRootElement(mImpl->mDocument);
  const std::vector<boost::shared_ptr<XdmfItem> > toReturn =
    mImpl->read(currNode->children);
  mImpl->closeFile();
  return toReturn;
210 211
}

212 213
boost::shared_ptr<XdmfItem>
XdmfCoreReader::read(const std::string & filePath) const
214
{
215 216 217 218 219 220
  const std::vector<boost::shared_ptr<XdmfItem> > toReturn =
    readItems(filePath);
  if (toReturn.size() == 0) {
    return(boost::shared_ptr<XdmfItem>());
  }
  return(toReturn[0]);
221
}
222

223 224 225
std::vector<boost::shared_ptr<XdmfItem> >
XdmfCoreReader::read(const std::string & filePath,
                     const std::string & xPath) const
226
{
227 228 229 230 231
  mImpl->openFile(filePath);
  std::vector<boost::shared_ptr<XdmfItem> > toReturn =
    this->readPathObjects(xPath);
  mImpl->closeFile();
  return toReturn;
232
}
233

234 235
std::vector<boost::shared_ptr<XdmfItem> >
XdmfCoreReader::readPathObjects(const std::string & xPath) const
236
{
237 238 239
  std::vector<boost::shared_ptr<XdmfItem> > toReturn;
  mImpl->readPathObjects(xPath, toReturn);
  return toReturn;
240 241
}