XdmfCoreReader.cpp 9.4 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
#include <cstring>
29 30 31
#include "XdmfCoreItemFactory.hpp"
#include "XdmfCoreReader.hpp"
#include "XdmfItem.hpp"
32
#include "XdmfSystemUtils.hpp"
33
#include "XdmfError.hpp"
34 35 36 37 38 39 40 41

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

public:

42
  XdmfCoreReaderImpl(const shared_ptr<const XdmfCoreItemFactory> itemFactory,
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
                     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) {
74 75 76
      XdmfError::message(XdmfError::FATAL,
                         "xmlReadFile could not read " + filePath +
                         " in XdmfCoreReader::XdmfCoreReaderImpl::openFile");
77 78 79 80 81 82
    }

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

83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
  void
  parse(const std::string & lightData) 
  {
    mDocument = xmlParseDoc((const xmlChar*)lightData.c_str());
                               
    if(mDocument == NULL) {
      XdmfError::message(XdmfError::FATAL,
                         "xmlReadFile could not parse passed light data string"
                         " in XdmfCoreReader::XdmfCoreReaderImpl::parse");
    }

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

98 99 100 101 102
  /**
   * Constructs XdmfItems for all nodes in currNode's tree.
   * XdmfItems are constructed by recursively calling this function for all
   * children of currNode.
   */
103
  std::vector<shared_ptr<XdmfItem> >
104 105
  read(xmlNodePtr currNode)
  {
106
    std::vector<shared_ptr<XdmfItem> > myItems;
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

    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,
149
                 std::vector<shared_ptr<XdmfItem> > & myItems)
150
  {
151
    std::map<xmlNodePtr, shared_ptr<XdmfItem> >::const_iterator iter =
152 153 154 155 156 157
      mXPathMap.find(currNode);
    if(iter != mXPathMap.end()) {
      myItems.push_back(iter->second);
    }
    else {
      std::map<std::string, std::string> itemProperties;
158 159 160

      xmlNodePtr childNode = currNode->children;
      while(childNode != NULL) {
161 162 163 164
        if(childNode->type == XML_TEXT_NODE && childNode->content) {
          const char * content = (char*)childNode->content;

          // determine if content is whitespace
165
          const size_t contentSize = std::strlen(content);
166 167
          bool whitespace = true;

168
          for(size_t i=0; i<contentSize; ++i) {
169 170 171 172 173 174 175 176 177 178 179
            if(!isspace(content[i])) {
              whitespace = false;
              break;
            }
          }

          if(!whitespace) {
            itemProperties["Content"] = content;
            itemProperties["XMLDir"] = mXMLDir;
            break;
          }
180 181
        }
        childNode = childNode->next;
182 183 184 185 186 187 188 189
      }
      xmlAttrPtr currAttribute = currNode->properties;
      while(currAttribute != NULL) {
        itemProperties[(const char *)currAttribute->name] =
          (const char *)currAttribute->children->content;
        currAttribute = currAttribute->next;
      }

190
      std::vector<shared_ptr<XdmfItem> > childItems =
191
        this->read(currNode->children);
192
      shared_ptr<XdmfItem> newItem =
193 194 195 196
        mItemFactory->createItem((const char *)currNode->name,
                                 itemProperties,
                                 childItems);
      if(newItem == NULL) {
197 198 199
        XdmfError::message(XdmfError::FATAL, 
                           "mItemFactory failed to createItem in "
                           "XdmfCoreReader::XdmfCoreReaderImpl::readSingleNode");
200 201 202 203 204 205 206 207 208 209
      }

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

  void
  readPathObjects(const std::string & xPath,
210
                  std::vector<shared_ptr<XdmfItem> > & myItems)
211 212 213 214 215 216 217 218 219 220 221 222 223
  {
    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;
224
  const shared_ptr<const XdmfCoreItemFactory> mItemFactory;
225
  const std::string mRootItemTag;
226 227
  std::string mXMLDir;
  xmlXPathContextPtr mXPathContext;
228
  std::map<xmlNodePtr, shared_ptr<XdmfItem> > mXPathMap;
229 230
};

231
XdmfCoreReader::XdmfCoreReader(const shared_ptr<const XdmfCoreItemFactory> itemFactory) :
232
  mImpl(new XdmfCoreReaderImpl(itemFactory, this))
233 234 235 236 237
{
}

XdmfCoreReader::~XdmfCoreReader()
{
238
  delete mImpl;
239 240
}

241 242 243 244 245 246 247 248 249 250 251
shared_ptr<XdmfItem >
XdmfCoreReader::parse(const std::string & lightData) const
{
  mImpl->parse(lightData);
  const xmlNodePtr currNode = xmlDocGetRootElement(mImpl->mDocument);
  const std::vector<shared_ptr<XdmfItem> > toReturn =
    mImpl->read(currNode->children);
  mImpl->closeFile();
  return(toReturn[0]);
}

252
std::vector<shared_ptr<XdmfItem> >
253
XdmfCoreReader::readItems(const std::string & filePath) const
254
{
255 256
  mImpl->openFile(filePath);
  const xmlNodePtr currNode = xmlDocGetRootElement(mImpl->mDocument);
257
  const std::vector<shared_ptr<XdmfItem> > toReturn =
258 259 260
    mImpl->read(currNode->children);
  mImpl->closeFile();
  return toReturn;
261 262
}

263
shared_ptr<XdmfItem>
264
XdmfCoreReader::read(const std::string & filePath) const
265
{
266
  const std::vector<shared_ptr<XdmfItem> > toReturn = readItems(filePath);
267
  if (toReturn.size() == 0) {
268
    return(shared_ptr<XdmfItem>());
269 270
  }
  return(toReturn[0]);
271
}
272

273
std::vector<shared_ptr<XdmfItem> >
274 275
XdmfCoreReader::read(const std::string & filePath,
                     const std::string & xPath) const
276
{
277
  mImpl->openFile(filePath);
278
  std::vector<shared_ptr<XdmfItem> > toReturn = this->readPathObjects(xPath);
279 280
  mImpl->closeFile();
  return toReturn;
281
}
282

283
std::vector<shared_ptr<XdmfItem> >
284
XdmfCoreReader::readPathObjects(const std::string & xPath) const
285
{
286
  std::vector<shared_ptr<XdmfItem> > toReturn;
287 288
  mImpl->readPathObjects(xPath, toReturn);
  return toReturn;
289 290
}