XdmfCoreReader.cpp 12.7 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 28 29
#include <boost/algorithm/string/trim.hpp>
#include <boost/tokenizer.hpp>
#include <cstring>
30
#include <map>
31
#include <sstream>
32 33
#include <utility>
#include "XdmfArray.hpp"
34 35
#include "XdmfArrayType.hpp"
#include "XdmfHDF5Controller.hpp"
36 37
#include "XdmfCoreItemFactory.hpp"
#include "XdmfCoreReader.hpp"
38
#include "XdmfError.hpp"
39 40
#include "XdmfFunction.hpp"
#include "XdmfSubset.hpp"
41
#include "XdmfItem.hpp"
42
#include "XdmfSystemUtils.hpp"
43

44 45 46 47 48 49 50
/**
 * PIMPL
 */
class XdmfCoreReader::XdmfCoreReaderImpl {

public:

51
  XdmfCoreReaderImpl(const shared_ptr<const XdmfCoreItemFactory> itemFactory,
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
                     const XdmfCoreReader * const coreReader) :
    mCoreReader(coreReader),
    mItemFactory(itemFactory)
  {
  };

  ~XdmfCoreReaderImpl()
  {
  };

  void
  closeFile()
  {
    mXPathMap.clear();
    xmlXPathFreeContext(mXPathContext);
67 68 69 70 71 72
    for(std::map<std::string, xmlDocPtr>::const_iterator iter = 
	  mDocuments.begin(); iter != mDocuments.end(); ++iter) {
      xmlFreeDoc(iter->second);
    }
    mDocuments.clear();
    
73 74 75 76 77 78 79 80 81 82 83 84
    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);
    }

85
    mDocument = xmlReadFile(filePath.c_str(), NULL, XML_PARSE_NOENT);
86 87

    if(mDocument == NULL) {
88 89 90
      XdmfError::message(XdmfError::FATAL,
                         "xmlReadFile could not read " + filePath +
                         " in XdmfCoreReader::XdmfCoreReaderImpl::openFile");
91 92
    }

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

95 96 97 98
    mXPathContext = xmlXPtrNewContext(mDocument, NULL, NULL);
    mXPathMap.clear();
  }

99 100 101 102 103 104
  void
  parse(const std::string & lightData) 
  {
    mDocument = xmlParseDoc((const xmlChar*)lightData.c_str());
                               
    if(mDocument == NULL) {
105 106 107
      XdmfError::message(XdmfError::FATAL,
                         "xmlReadFile could not parse passed light data string"
                         " in XdmfCoreReader::XdmfCoreReaderImpl::parse");
108
    }
109 110
    
    //mDocuments.insert(std::make_pair((char*)mDocument->URL, mDocument));
111 112 113 114
    mXPathContext = xmlXPtrNewContext(mDocument, NULL, NULL);
    mXPathMap.clear();
  }

115 116 117 118 119
  /**
   * Constructs XdmfItems for all nodes in currNode's tree.
   * XdmfItems are constructed by recursively calling this function for all
   * children of currNode.
   */
120
  std::vector<shared_ptr<XdmfItem> >
121 122
  read(xmlNodePtr currNode)
  {
123
    std::vector<shared_ptr<XdmfItem> > myItems;
124 125 126

    while(currNode != NULL) {
      if(currNode->type == XML_ELEMENT_NODE) {
127 128
        // Normal reading
        this->readSingleNode(currNode, myItems);
129 130 131 132 133 134 135 136 137 138 139 140 141
      }
      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,
142
                 std::vector<shared_ptr<XdmfItem> > & myItems)
143
  {
144
    
145 146 147 148 149 150
    // Deal with proper resolution of XIncludes
    if(xmlStrcmp(currNode->name, (xmlChar*)"include") == 0) {
      
      xmlChar * xpointer = NULL;
      xmlChar * href = NULL;
      
151 152
      xmlAttrPtr currAttribute = currNode->properties;
      while(currAttribute != NULL) {
153 154 155 156 157 158
        if(xmlStrcmp(currAttribute->name, (xmlChar*)"xpointer") == 0) {
          xpointer = currAttribute->children->content;
        }
        if(xmlStrcmp(currAttribute->name, (xmlChar*)"href") == 0) {
          href = currAttribute->children->content;
        }
159 160
        currAttribute = currAttribute->next;
      }
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 189 190 191 192
      xmlXPathContextPtr oldContext = mXPathContext;
      if(href) {
        xmlDocPtr document;
        xmlChar * filePath = xmlBuildURI(href, mDocument->URL);
        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;
        }
        
        mXPathContext = xmlXPtrNewContext(document, NULL, NULL);           
      }
      
      if(xpointer) {
        xmlXPathObjectPtr result = xmlXPtrEval(xpointer, mXPathContext);
        if(result && !xmlXPathNodeSetIsEmpty(result->nodesetval)) {
          for(int i=0; i<result->nodesetval->nodeNr; ++i) {
            this->readSingleNode(result->nodesetval->nodeTab[i],
                                 myItems);
          }
        }
        else {
          XdmfError::message(XdmfError::FATAL,
                             "Invalid xpointer encountered.");
        }
        xmlXPathFreeObject(result);
193
      }
194 195 196 197 198 199 200 201 202
      
      if(href) {
        xmlXPathFreeContext(mXPathContext);
      }
      
      mXPathContext = oldContext;
      
    }
    else {
203

204 205 206 207 208 209
      // Check to see if the node is already in the XPath Map (seen previously)
      std::map<xmlNodePtr, shared_ptr<XdmfItem> >::const_iterator iter =
        mXPathMap.find(currNode);
      // If it is grab it from the previously stored items
      if(iter != mXPathMap.end()) {
        myItems.push_back(iter->second);
210 211
      }
      else {
212 213 214 215
        // Otherwise, generate a new XdmfItem from the node
        std::map<std::string, std::string> itemProperties;
        
        xmlNodePtr childNode = currNode->children;
216
        // generate content if an array or arrayReference
217
        if (XdmfArray::ItemTag.compare((char *)currNode->name) == 0 ||
218 219 220
            strcmp("DataStructure", (char *)currNode->name) == 0 ||
            XdmfFunction::ItemTag.compare((char *)currNode->name) == 0 ||
            XdmfSubset::ItemTag.compare((char *)currNode->name) == 0) {
221 222
          while(childNode != NULL) {
            if(childNode->type == XML_TEXT_NODE && childNode->content) {
Andrew J. Burns (Cont's avatar
Andrew J. Burns (Cont committed
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
///*
            const char * content = (char*)childNode->content;

            // Determine if content is whitespace
            bool whitespace = true;

            const char * contentPtr = content;
            // Step through to end of pointer
            while(contentPtr != NULL) {
              // If not a whitespace character, break
              if(!isspace(*contentPtr++)) {
                whitespace = false;
                break;
              }
            }

            if(!whitespace) {
              itemProperties.insert(std::make_pair("Content", content));
              itemProperties.insert(std::make_pair("XMLDir", mXMLDir));
              break;
            }
//*/
/*              
246 247 248 249 250 251 252 253
              std::string content((char *)childNode->content);
              boost::algorithm::trim(content);
              
              if(content.size() != 0) {
                itemProperties.insert(std::make_pair("Content", content));
                itemProperties.insert(std::make_pair("XMLDir", mXMLDir));
                break;
              }
Andrew J. Burns (Cont's avatar
Andrew J. Burns (Cont committed
254
*/
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
            }
            childNode = childNode->next;
          }
        }
        
        // Pull attributes from node
        xmlAttrPtr currAttribute = currNode->properties;
        while(currAttribute != NULL) {
          itemProperties.insert(std::make_pair((char *)currAttribute->name,
                                               (char *)currAttribute->children->content));
          currAttribute = currAttribute->next;
        }
        
        // Build XdmfItem
        const std::vector<shared_ptr<XdmfItem> > childItems =
          this->read(currNode->children);
        shared_ptr<XdmfItem> newItem = 
          mItemFactory->createItem((const char *)currNode->name,
                                   itemProperties,
                                   childItems);
        
        if(newItem == NULL) {
          XdmfError::message(XdmfError::FATAL, 
                             "mItemFactory failed to createItem in "
                             "XdmfCoreReader::XdmfCoreReaderImpl::readSingleNode");
        }
        

        // Populate built XdmfItem
284 285 286
        newItem->populateItem(itemProperties,
                              childItems,
                              mCoreReader);
287 288 289

        myItems.push_back(newItem);
        mXPathMap.insert(std::make_pair(currNode, newItem));
290 291 292 293 294 295
      }
    }
  }

  void
  readPathObjects(const std::string & xPath,
296
                  std::vector<shared_ptr<XdmfItem> > & myItems)
297 298 299 300 301
  {
    xmlXPathObjectPtr xPathObject =
      xmlXPathEvalExpression((xmlChar*)xPath.c_str(), mXPathContext);
    if(xPathObject && xPathObject->nodesetval) {
      for(int i=0; i<xPathObject->nodesetval->nodeNr; ++i) {
302
        this->readSingleNode(xPathObject->nodesetval->nodeTab[i], myItems);
303 304 305 306 307 308
      }
    }
    xmlXPathFreeObject(xPathObject);
  }

  xmlDocPtr mDocument;
309
  std::map<std::string, xmlDocPtr> mDocuments;
310
  const XdmfCoreReader * const mCoreReader;
311
  const shared_ptr<const XdmfCoreItemFactory> mItemFactory;
312 313
  std::string mXMLDir;
  xmlXPathContextPtr mXPathContext;
314
  std::map<xmlNodePtr, shared_ptr<XdmfItem> > mXPathMap;
315 316
};

317
XdmfCoreReader::XdmfCoreReader(const shared_ptr<const XdmfCoreItemFactory> itemFactory) :
318
  mImpl(new XdmfCoreReaderImpl(itemFactory, this))
319 320 321 322 323
{
}

XdmfCoreReader::~XdmfCoreReader()
{
324
  delete mImpl;
325 326
}

327 328 329
shared_ptr<XdmfItem >
XdmfCoreReader::parse(const std::string & lightData) const
{
330
  mImpl->parse(lightData);
331
  const xmlNodePtr currNode = xmlDocGetRootElement(mImpl->mDocument);
332
  std::vector<shared_ptr<XdmfItem> > toReturn;
333 334 335 336
  if(mImpl->mItemFactory->createItem((const char*)currNode->name,
                                     std::map<std::string, std::string>(),
                                     std::vector<shared_ptr<XdmfItem> >()) == NULL) {
    toReturn = mImpl->read(currNode->children);
337
  }
338 339
  else {
    toReturn = mImpl->read(currNode);
340
  }
341 342 343 344
  mImpl->closeFile();
  return(toReturn[0]);
}

345
std::vector<shared_ptr<XdmfItem> >
346
XdmfCoreReader::readItems(const std::string & filePath) const
347
{
348 349 350 351 352 353
  mImpl->openFile(filePath);
  const xmlNodePtr currNode = xmlDocGetRootElement(mImpl->mDocument);
  const std::vector<shared_ptr<XdmfItem> > toReturn =
    mImpl->read(currNode->children);
  mImpl->closeFile();
  return toReturn;
354 355
}

356
shared_ptr<XdmfItem>
357
XdmfCoreReader::read(const std::string & filePath) const
358
{
359 360 361
  const std::vector<shared_ptr<XdmfItem> > toReturn = readItems(filePath);
  if (toReturn.size() == 0) {
    return(shared_ptr<XdmfItem>());
362
  }
363
  return(toReturn[0]);
364
}
365

366
std::vector<shared_ptr<XdmfItem> >
367 368
XdmfCoreReader::read(const std::string & filePath,
                     const std::string & xPath) const
369
{
370 371 372 373
  mImpl->openFile(filePath);
  std::vector<shared_ptr<XdmfItem> > toReturn = this->readPathObjects(xPath);
  mImpl->closeFile();
  return toReturn;
374
}
375

376
std::vector<shared_ptr<XdmfItem> >
377
XdmfCoreReader::readPathObjects(const std::string & xPath) const
378
{
379
  std::vector<shared_ptr<XdmfItem> > toReturn;
380
  mImpl->readPathObjects(xPath, toReturn);
381
  return toReturn;
382 383
}