XdmfCoreReader.cpp 10.5 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/uri.h>
25
#include <libxml/xpointer.h>
26
#include <libxml/xmlreader.h>
27
#include <map>
28
#include <sstream>
29
#include <cstring>
30 31 32
#include "XdmfCoreItemFactory.hpp"
#include "XdmfCoreReader.hpp"
#include "XdmfItem.hpp"
33
#include "XdmfSystemUtils.hpp"
34
#include "XdmfError.hpp"
35

36 37
#include <fstream>

38 39 40 41 42 43 44
/**
 * PIMPL
 */
class XdmfCoreReader::XdmfCoreReaderImpl {

public:

45
  XdmfCoreReaderImpl(const shared_ptr<const XdmfCoreItemFactory> itemFactory,
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
                     const XdmfCoreReader * const coreReader) :
    mCoreReader(coreReader),
    mItemFactory(itemFactory)
  {
  };

  ~XdmfCoreReaderImpl()
  {
  };

  void
  closeFile()
  {
    mXPathMap.clear();
    xmlXPathFreeContext(mXPathContext);
61 62 63 64 65 66
    for(std::map<std::string, xmlDocPtr>::const_iterator iter = 
	  mDocuments.begin(); iter != mDocuments.end(); ++iter) {
      xmlFreeDoc(iter->second);
    }
    mDocuments.clear();
    
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
    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) {
82 83 84
      XdmfError::message(XdmfError::FATAL,
                         "xmlReadFile could not read " + filePath +
                         " in XdmfCoreReader::XdmfCoreReaderImpl::openFile");
85 86
    }

87 88
    mDocuments.insert(std::make_pair((char*)mDocument->URL, mDocument));

89 90 91 92
    mXPathContext = xmlXPtrNewContext(mDocument, NULL, NULL);
    mXPathMap.clear();
  }

93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
  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();
  }

108 109 110 111 112
  /**
   * Constructs XdmfItems for all nodes in currNode's tree.
   * XdmfItems are constructed by recursively calling this function for all
   * children of currNode.
   */
113
  std::vector<shared_ptr<XdmfItem> >
114 115
  read(xmlNodePtr currNode)
  {
116
    std::vector<shared_ptr<XdmfItem> > myItems;
117 118 119 120 121

    while(currNode != NULL) {
      if(currNode->type == XML_ELEMENT_NODE) {
        if(xmlStrcmp(currNode->name, (xmlChar*)"include") == 0) {
          // Deal with proper reading of XIncludes
122 123 124 125

          xmlChar * xpointer = NULL;
          xmlChar * href = NULL;

126 127 128 129 130
          xmlAttrPtr currAttribute = currNode->properties;
          while(currAttribute != NULL) {
            if(xmlStrcmp(currAttribute->name, (xmlChar*)"xpointer") == 0) {
              xpointer = currAttribute->children->content;
            }
131 132 133 134 135 136 137 138
            if(xmlStrcmp(currAttribute->name, (xmlChar*)"href") == 0) {
              href = currAttribute->children->content;
            }
            currAttribute = currAttribute->next;
          }

          xmlXPathContextPtr context = mXPathContext;
          if(href) {
139
	    xmlDocPtr document;
140
            xmlChar * filePath = xmlBuildURI(href, mDocument->URL);
141 142 143 144 145 146 147 148 149 150
	    std::map<std::string, xmlDocPtr>::const_iterator iter = 
	      mDocuments.find((char*)filePath);
	    if(iter == mDocuments.end()) {
	      document = xmlReadFile((char*)filePath, NULL, 0);
	      mDocuments.insert(std::make_pair((char*)document->URL, document));
	    }
	    else {
	      document = iter->second;
	    }

151
            context = xmlXPtrNewContext(document, NULL, NULL);           
152
          }
153

154
          if(xpointer) {
155 156 157 158
            xmlXPathObjectPtr result = xmlXPtrEval(xpointer, context);
            if(result && !xmlXPathNodeSetIsEmpty(result->nodesetval)) {
              for(int i=0; i<result->nodesetval->nodeNr; ++i) {
                this->readSingleNode(result->nodesetval->nodeTab[i],
159 160 161
                                     myItems);
              }
            }
162 163 164 165 166
            xmlXPathFreeObject(result);
          }

          if(href) {
            xmlXPathFreeContext(context);
167
          }
168

169 170 171 172 173 174 175 176
        }
        else {
          // Normal reading
          this->readSingleNode(currNode, myItems);
        }
      }
      currNode = currNode->next;
    }
177

178 179 180 181 182 183 184 185 186 187
    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,
188
                 std::vector<shared_ptr<XdmfItem> > & myItems)
189
  {
190
    std::map<xmlNodePtr, shared_ptr<XdmfItem> >::const_iterator iter =
191 192 193 194 195 196
      mXPathMap.find(currNode);
    if(iter != mXPathMap.end()) {
      myItems.push_back(iter->second);
    }
    else {
      std::map<std::string, std::string> itemProperties;
197 198 199

      xmlNodePtr childNode = currNode->children;
      while(childNode != NULL) {
200 201 202 203
        if(childNode->type == XML_TEXT_NODE && childNode->content) {
          const char * content = (char*)childNode->content;

          // determine if content is whitespace
204
          const size_t contentSize = std::strlen(content);
205 206
          bool whitespace = true;

207
          for(size_t i=0; i<contentSize; ++i) {
208 209 210 211 212 213 214 215 216 217 218
            if(!isspace(content[i])) {
              whitespace = false;
              break;
            }
          }

          if(!whitespace) {
            itemProperties["Content"] = content;
            itemProperties["XMLDir"] = mXMLDir;
            break;
          }
219 220
        }
        childNode = childNode->next;
221 222 223 224 225 226 227 228
      }
      xmlAttrPtr currAttribute = currNode->properties;
      while(currAttribute != NULL) {
        itemProperties[(const char *)currAttribute->name] =
          (const char *)currAttribute->children->content;
        currAttribute = currAttribute->next;
      }

229
      std::vector<shared_ptr<XdmfItem> > childItems =
230
        this->read(currNode->children);
231
      shared_ptr<XdmfItem> newItem =
232 233 234 235
        mItemFactory->createItem((const char *)currNode->name,
                                 itemProperties,
                                 childItems);
      if(newItem == NULL) {
236 237 238
        XdmfError::message(XdmfError::FATAL, 
                           "mItemFactory failed to createItem in "
                           "XdmfCoreReader::XdmfCoreReaderImpl::readSingleNode");
239 240 241 242 243 244 245 246 247 248
      }

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

  void
  readPathObjects(const std::string & xPath,
249
                  std::vector<shared_ptr<XdmfItem> > & myItems)
250 251 252 253 254 255 256 257 258 259 260 261
  {
    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;
262
  std::map<std::string, xmlDocPtr> mDocuments;
263
  const XdmfCoreReader * const mCoreReader;
264
  const shared_ptr<const XdmfCoreItemFactory> mItemFactory;
265
  const std::string mRootItemTag;
266 267
  std::string mXMLDir;
  xmlXPathContextPtr mXPathContext;
268
  std::map<xmlNodePtr, shared_ptr<XdmfItem> > mXPathMap;
269 270
};

271
XdmfCoreReader::XdmfCoreReader(const shared_ptr<const XdmfCoreItemFactory> itemFactory) :
272
  mImpl(new XdmfCoreReaderImpl(itemFactory, this))
273 274 275 276 277
{
}

XdmfCoreReader::~XdmfCoreReader()
{
278
  delete mImpl;
279 280
}

281 282 283 284 285 286 287 288 289 290 291
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]);
}

292
std::vector<shared_ptr<XdmfItem> >
293
XdmfCoreReader::readItems(const std::string & filePath) const
294
{
295 296
  mImpl->openFile(filePath);
  const xmlNodePtr currNode = xmlDocGetRootElement(mImpl->mDocument);
297
  const std::vector<shared_ptr<XdmfItem> > toReturn =
298 299 300
    mImpl->read(currNode->children);
  mImpl->closeFile();
  return toReturn;
301 302
}

303
shared_ptr<XdmfItem>
304
XdmfCoreReader::read(const std::string & filePath) const
305
{
306
  const std::vector<shared_ptr<XdmfItem> > toReturn = readItems(filePath);
307
  if (toReturn.size() == 0) {
308
    return(shared_ptr<XdmfItem>());
309 310
  }
  return(toReturn[0]);
311
}
312

313
std::vector<shared_ptr<XdmfItem> >
314 315
XdmfCoreReader::read(const std::string & filePath,
                     const std::string & xPath) const
316
{
317
  mImpl->openFile(filePath);
318
  std::vector<shared_ptr<XdmfItem> > toReturn = this->readPathObjects(xPath);
319 320
  mImpl->closeFile();
  return toReturn;
321
}
322

323
std::vector<shared_ptr<XdmfItem> >
324
XdmfCoreReader::readPathObjects(const std::string & xPath) const
325
{
326
  std::vector<shared_ptr<XdmfItem> > toReturn;
327 328
  mImpl->readPathObjects(xPath, toReturn);
  return toReturn;
329 330
}