XdmfCoreReader.cpp 14 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 <cstring>
25
#include <map>
26
#include <sstream>
27 28
#include <utility>
#include "XdmfArray.hpp"
29
#include "XdmfArrayType.hpp"
30 31
#include "XdmfCoreItemFactory.hpp"
#include "XdmfCoreReader.hpp"
32
#include "XdmfError.hpp"
33 34
#include "XdmfFunction.hpp"
#include "XdmfSubset.hpp"
35
#include "XdmfItem.hpp"
36
#include "XdmfSystemUtils.hpp"
37

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
    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);
    }

79
    mDocument = xmlReadFile(filePath.c_str(), NULL, XML_PARSE_NOENT);
80 81

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

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

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

155 156 157 158 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
      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);
186
      }
187 188 189 190 191 192 193 194 195
      
      if(href) {
        xmlXPathFreeContext(mXPathContext);
      }
      
      mXPathContext = oldContext;
      
    }
    else {
196

197 198 199 200 201 202
      // 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);
203 204
      }
      else {
205 206
        // Otherwise, generate a new XdmfItem from the node
        std::map<std::string, std::string> itemProperties;
207

208
        xmlNodePtr childNode = currNode->children;
209
        // generate content if an array or arrayReference
210
        if (mItemFactory->isArrayTag((char *)currNode->name)) {
211 212
          while(childNode != NULL) {
            if(childNode->type == XML_TEXT_NODE && childNode->content) {
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
              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) {
228
                std::string contentString(content);
229 230 231 232 233 234 235 236 237 238 239 240 241 242
                // find first nonwhitespace
                unsigned int start = 0;
                int check = contentString.find_first_not_of(" \t\n\r\f\v");
                if (check >= 0)
                {
                  start = check;
                }
                unsigned int end = contentString.size();
                check = contentString.find_last_not_of(" \t\n\r\f\v");
                if (check >= 0)
                {
                  end = check;
                }
                contentString = contentString.substr(start, end - start + 1);
243
                itemProperties.insert(std::make_pair("Content", contentString));
244 245 246
                itemProperties.insert(std::make_pair("XMLDir", mXMLDir));
                break;
              }
247 248 249 250
            }
            childNode = childNode->next;
          }
        }
251

252 253 254 255 256 257 258
        // 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;
        }
259

260 261 262
        // Build XdmfItem
        const std::vector<shared_ptr<XdmfItem> > childItems =
          this->read(currNode->children);
263
        shared_ptr<XdmfItem> newItem =
264 265 266
          mItemFactory->createItem((const char *)currNode->name,
                                   itemProperties,
                                   childItems);
267

268
        if(newItem.get() == NULL) {
269
          XdmfError::message(XdmfError::FATAL,
270 271 272
                             "mItemFactory failed to createItem in "
                             "XdmfCoreReader::XdmfCoreReaderImpl::readSingleNode");
        }
273

274 275

        // Populate built XdmfItem
276 277 278
        newItem->populateItem(itemProperties,
                              childItems,
                              mCoreReader);
279 280 281

        myItems.push_back(newItem);
        mXPathMap.insert(std::make_pair(currNode, newItem));
282 283 284 285 286 287
      }
    }
  }

  void
  readPathObjects(const std::string & xPath,
288
                  std::vector<shared_ptr<XdmfItem> > & myItems)
289 290 291 292 293
  {
    xmlXPathObjectPtr xPathObject =
      xmlXPathEvalExpression((xmlChar*)xPath.c_str(), mXPathContext);
    if(xPathObject && xPathObject->nodesetval) {
      for(int i=0; i<xPathObject->nodesetval->nodeNr; ++i) {
294
        this->readSingleNode(xPathObject->nodesetval->nodeTab[i], myItems);
295 296 297 298 299 300
      }
    }
    xmlXPathFreeObject(xPathObject);
  }

  xmlDocPtr mDocument;
301
  std::map<std::string, xmlDocPtr> mDocuments;
302
  const XdmfCoreReader * const mCoreReader;
303
  const shared_ptr<const XdmfCoreItemFactory> mItemFactory;
304 305
  std::string mXMLDir;
  xmlXPathContextPtr mXPathContext;
306
  std::map<xmlNodePtr, shared_ptr<XdmfItem> > mXPathMap;
307 308
};

309
XdmfCoreReader::XdmfCoreReader(const shared_ptr<const XdmfCoreItemFactory> itemFactory) :
310
  mImpl(new XdmfCoreReaderImpl(itemFactory, this))
311 312 313 314 315
{
}

XdmfCoreReader::~XdmfCoreReader()
{
316
  delete mImpl;
317 318
}

319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
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);
}

346 347 348
shared_ptr<XdmfItem >
XdmfCoreReader::parse(const std::string & lightData) const
{
349
  mImpl->parse(lightData);
350
  const xmlNodePtr currNode = xmlDocGetRootElement(mImpl->mDocument);
351
  std::vector<shared_ptr<XdmfItem> > toReturn;
352 353
  if(mImpl->mItemFactory->createItem((const char*)currNode->name,
                                     std::map<std::string, std::string>(),
354
                                     std::vector<shared_ptr<XdmfItem> >()).get() == NULL) {
355
    toReturn = mImpl->read(currNode->children);
356
  }
357 358
  else {
    toReturn = mImpl->read(currNode);
359
  }
360 361 362 363
  mImpl->closeFile();
  return(toReturn[0]);
}

364
std::vector<shared_ptr<XdmfItem> >
365
XdmfCoreReader::readItems(const std::string & filePath) const
366
{
367 368 369 370 371 372
  mImpl->openFile(filePath);
  const xmlNodePtr currNode = xmlDocGetRootElement(mImpl->mDocument);
  const std::vector<shared_ptr<XdmfItem> > toReturn =
    mImpl->read(currNode->children);
  mImpl->closeFile();
  return toReturn;
373 374
}

375
shared_ptr<XdmfItem>
376
XdmfCoreReader::read(const std::string & filePath) const
377
{
378 379 380
  const std::vector<shared_ptr<XdmfItem> > toReturn = readItems(filePath);
  if (toReturn.size() == 0) {
    return(shared_ptr<XdmfItem>());
381
  }
382
  return(toReturn[0]);
383
}
384

385
std::vector<shared_ptr<XdmfItem> >
386 387
XdmfCoreReader::read(const std::string & filePath,
                     const std::string & xPath) const
388
{
389 390 391 392
  mImpl->openFile(filePath);
  std::vector<shared_ptr<XdmfItem> > toReturn = this->readPathObjects(xPath);
  mImpl->closeFile();
  return toReturn;
393
}
394

395
std::vector<shared_ptr<XdmfItem> >
396
XdmfCoreReader::readPathObjects(const std::string & xPath) const
397
{
398
  std::vector<shared_ptr<XdmfItem> > toReturn;
399
  mImpl->readPathObjects(xPath, toReturn);
400
  return toReturn;
401 402
}

403 404 405 406 407 408 409 410 411 412 413
// 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;
}