XdmfCoreReader.cpp 13.2 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
#include "XdmfArrayType.hpp"
35 36
#include "XdmfCoreItemFactory.hpp"
#include "XdmfCoreReader.hpp"
37
#include "XdmfError.hpp"
38 39
#include "XdmfFunction.hpp"
#include "XdmfSubset.hpp"
40
#include "XdmfItem.hpp"
41
#include "XdmfSystemUtils.hpp"
42

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

public:

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

  ~XdmfCoreReaderImpl()
  {
  };

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

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

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

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

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

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

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

    while(currNode != NULL) {
      if(currNode->type == XML_ELEMENT_NODE) {
126 127
        // Normal reading
        this->readSingleNode(currNode, myItems);
128 129 130 131 132 133 134 135 136 137 138 139 140
      }
      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,
141
                 std::vector<shared_ptr<XdmfItem> > & myItems)
142
  {
143 144 145 146 147 148
    // Deal with proper resolution of XIncludes
    if(xmlStrcmp(currNode->name, (xmlChar*)"include") == 0) {
      
      xmlChar * xpointer = NULL;
      xmlChar * href = NULL;
      
149 150
      xmlAttrPtr currAttribute = currNode->properties;
      while(currAttribute != NULL) {
151 152 153 154 155 156
        if(xmlStrcmp(currAttribute->name, (xmlChar*)"xpointer") == 0) {
          xpointer = currAttribute->children->content;
        }
        if(xmlStrcmp(currAttribute->name, (xmlChar*)"href") == 0) {
          href = currAttribute->children->content;
        }
157 158
        currAttribute = currAttribute->next;
      }
159

160 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
      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);
191
      }
192 193 194 195 196 197 198 199 200
      
      if(href) {
        xmlXPathFreeContext(mXPathContext);
      }
      
      mXPathContext = oldContext;
      
    }
    else {
201

202 203 204 205 206 207
      // 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);
208 209
      }
      else {
210 211
        // Otherwise, generate a new XdmfItem from the node
        std::map<std::string, std::string> itemProperties;
212

213
        xmlNodePtr childNode = currNode->children;
214
        // generate content if an array or arrayReference
215
        if (mItemFactory->isArrayTag((char *)currNode->name)) {
216 217 218 219
          while(childNode != NULL) {
            if(childNode->type == XML_TEXT_NODE && childNode->content) {
              std::string content((char *)childNode->content);
              boost::algorithm::trim(content);
220

221 222 223 224 225 226 227 228 229
              if(content.size() != 0) {
                itemProperties.insert(std::make_pair("Content", content));
                itemProperties.insert(std::make_pair("XMLDir", mXMLDir));
                break;
              }
            }
            childNode = childNode->next;
          }
        }
230

231 232 233 234 235 236 237
        // 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;
        }
238

239 240 241
        // Build XdmfItem
        const std::vector<shared_ptr<XdmfItem> > childItems =
          this->read(currNode->children);
242
        shared_ptr<XdmfItem> newItem =
243 244 245
          mItemFactory->createItem((const char *)currNode->name,
                                   itemProperties,
                                   childItems);
246

247
        if(newItem == NULL) {
248
          XdmfError::message(XdmfError::FATAL,
249 250 251
                             "mItemFactory failed to createItem in "
                             "XdmfCoreReader::XdmfCoreReaderImpl::readSingleNode");
        }
252

253 254

        // Populate built XdmfItem
255 256 257
        newItem->populateItem(itemProperties,
                              childItems,
                              mCoreReader);
258 259 260

        myItems.push_back(newItem);
        mXPathMap.insert(std::make_pair(currNode, newItem));
261 262 263 264 265 266
      }
    }
  }

  void
  readPathObjects(const std::string & xPath,
267
                  std::vector<shared_ptr<XdmfItem> > & myItems)
268 269 270 271 272
  {
    xmlXPathObjectPtr xPathObject =
      xmlXPathEvalExpression((xmlChar*)xPath.c_str(), mXPathContext);
    if(xPathObject && xPathObject->nodesetval) {
      for(int i=0; i<xPathObject->nodesetval->nodeNr; ++i) {
273
        this->readSingleNode(xPathObject->nodesetval->nodeTab[i], myItems);
274 275 276 277 278 279
      }
    }
    xmlXPathFreeObject(xPathObject);
  }

  xmlDocPtr mDocument;
280
  std::map<std::string, xmlDocPtr> mDocuments;
281
  const XdmfCoreReader * const mCoreReader;
282
  const shared_ptr<const XdmfCoreItemFactory> mItemFactory;
283 284
  std::string mXMLDir;
  xmlXPathContextPtr mXPathContext;
285
  std::map<xmlNodePtr, shared_ptr<XdmfItem> > mXPathMap;
286 287
};

288
XdmfCoreReader::XdmfCoreReader(const shared_ptr<const XdmfCoreItemFactory> itemFactory) :
289
  mImpl(new XdmfCoreReaderImpl(itemFactory, this))
290 291 292 293 294
{
}

XdmfCoreReader::~XdmfCoreReader()
{
295
  delete mImpl;
296 297
}

298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
XdmfItem *
XdmfCoreReader::DuplicatePointer(shared_ptr<XdmfItem> original) const
{
  if (mImpl == NULL) {
    XdmfError::message(XdmfError::FATAL, "Error: Reader Internal Object is NULL");
  }
  return mImpl->mItemFactory->DuplicatePointer(original);
}

std::vector<shared_ptr<XdmfHeavyDataController> >
XdmfCoreReader::generateHeavyDataControllers(std::map<std::string, std::string> controllerProperties,
                                             const std::vector<unsigned int> & passedDimensions,
                                             shared_ptr<const XdmfArrayType> passedArrayType,
                                             const std::string & passedFormat) const
{
  return mImpl->mItemFactory->generateHeavyDataControllers(controllerProperties,
                                                           passedDimensions,
                                                           passedArrayType,
                                                           passedFormat);
}

shared_ptr<XdmfHeavyDataWriter>
XdmfCoreReader::generateHeavyDataWriter(std::string typeName, std::string path) const
{
  return mImpl->mItemFactory->generateHeavyDataWriter(typeName, path);
}

325 326 327
shared_ptr<XdmfItem >
XdmfCoreReader::parse(const std::string & lightData) const
{
328
  mImpl->parse(lightData);
329
  const xmlNodePtr currNode = xmlDocGetRootElement(mImpl->mDocument);
330
  std::vector<shared_ptr<XdmfItem> > toReturn;
331 332 333 334
  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);
335
  }
336 337
  else {
    toReturn = mImpl->read(currNode);
338
  }
339 340 341 342
  mImpl->closeFile();
  return(toReturn[0]);
}

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

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

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

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

382 383 384 385 386 387 388 389 390 391 392
// C Wrappers

XDMFITEM *
XdmfCoreReaderRead(XDMFCOREREADER * reader, char * filePath, int * status)
{
  XDMF_ERROR_WRAP_START(status)
  shared_ptr<XdmfItem> returnItem = ((XdmfCoreReader *)reader)->read(filePath);
  return (XDMFITEM *)((void *)((XdmfItem *)((XdmfCoreReader *)reader)->DuplicatePointer(returnItem)));
  XDMF_ERROR_WRAP_END(status)
  return NULL;
}