PvlToJSON.cpp

 
/* SPDX-License-Identifier: CC0-1.0 */
#include "PvlToJSON.h"
 
#include <nlohmann/json.hpp>
 
#include "Pvl.h"
#include "PvlKeyword.h"
#include "IException.h"
 
using json = nlohmann::json;
using namespace std;
 
namespace Isis {

  json pvlKeywordToJSON(PvlKeyword &keyword) {
    json jsonKeyword;
 
    // Convert values
    if (keyword.size() == 1) {
      jsonKeyword["Value"] = keyword[0].toStdString();
    }
    else if (keyword.size() > 1) {
      json valueList;
      for (int i = 0; i < keyword.size(); i++) {
        valueList.push_back(keyword[i].toStdString());
      }
      jsonKeyword["Value"] = valueList;
    }
 
    // Optionally convert units
    if (keyword.size() == 1 && !keyword.unit(0).isEmpty()) {
      jsonKeyword["Units"] = keyword.unit(0).toStdString();
    }
    else if (keyword.size() > 1 && !keyword.unit(0).isEmpty()) {
      json valueList;
      for (int i = 0; i < keyword.size(); i++) {
        valueList.push_back(keyword.unit(i).toStdString());
      }
      jsonKeyword["Units"] = valueList;
    }
 
    // Optionally convert comments
    if (keyword.comments() == 1) {
      jsonKeyword["Comment"] = keyword.comment(0).toStdString();
    }
    else if (keyword.comments() > 1) {
      json commentList;
      for (int i = 0; i < keyword.comments(); i++) {
        commentList.push_back(keyword.comment(i).toStdString());
      }
      jsonKeyword["Comment"] = commentList;
    }
    return jsonKeyword;
  }
 

  json pvlContainerToJSON(PvlContainer &container) {
    json jsonContainer;
 
    // Convert keywords
    PvlContainer::PvlKeywordIterator keywordIt;
    for (keywordIt = container.begin(); keywordIt != container.end(); keywordIt++) {
      string keywordName = keywordIt->name().replace("^", "ptr").replace(":", "_").toStdString();
      // Handle repeated keywords by packing them into an array
      if ( jsonContainer.contains(keywordName) ) {
        if (!jsonContainer[keywordName].is_array()) {
          json repeatedArray;
          repeatedArray.push_back(jsonContainer[keywordName]);
          jsonContainer[keywordName] = repeatedArray;
        }
        jsonContainer[keywordName].push_back(pvlKeywordToJSON(*keywordIt));
      }
      else {
          jsonContainer[keywordName] = pvlKeywordToJSON(*keywordIt);
      }
    }
 
    // Optionally convert comments
    if (container.comments() == 1) {
      jsonContainer["Comment"] = container.comment(0).toStdString();
    }
    else if (container.comments() > 1) {
      json commentList;
      for (int i = 0; i < container.comments(); i++) {
        commentList.push_back(container.comment(i).toStdString());
      }
      jsonContainer["Comment"] = commentList;
    }
    return jsonContainer;
 
  }
 

  json pvlGroupToJSON(PvlGroup &group) {
    // PvlGroups are just PvlContainers with extra input/output options
    // so we can just use the PvlContainer conversion directly.
    return pvlContainerToJSON(group);;
  }
 

  json pvlObjectToJSON(PvlObject &object) {
    // Convert keywords and comments
    json jsonObject = pvlContainerToJSON(object);
 
    // Convert groups
    PvlObject::PvlGroupIterator groupIt;
    for (groupIt = object.beginGroup(); groupIt != object.endGroup(); groupIt++) {
      // Handle repeated elements by packing them into an array
      if ( jsonObject.contains(groupIt->name().toStdString()) ) {
        if (!jsonObject[groupIt->name().toStdString()].is_array()) {
          json repeatedArray;
          repeatedArray.push_back(jsonObject[groupIt->name().toStdString()]);
          jsonObject[groupIt->name().toStdString()] = repeatedArray;
        }
        jsonObject[groupIt->name().toStdString()].push_back(pvlGroupToJSON(*groupIt));
      }
      else {
        jsonObject[groupIt->name().toStdString()] = pvlGroupToJSON(*groupIt);
      }
    }
 
    // Convert nested objects
    PvlObject::PvlObjectIterator objectIt;
    for (objectIt = object.beginObject(); objectIt != object.endObject(); objectIt++) {
      // Handle repeated elements by packing them into an array
      if ( jsonObject.contains(objectIt->name().toStdString()) ) {
        if (!jsonObject[objectIt->name().toStdString()].is_array()) {
          json repeatedArray;
          repeatedArray.push_back(jsonObject[objectIt->name().toStdString()]);
          jsonObject[objectIt->name().toStdString()] = repeatedArray;
        }
        jsonObject[objectIt->name().toStdString()].push_back(pvlObjectToJSON(*objectIt));
      }
      else {
        jsonObject[objectIt->name().toStdString()] = pvlObjectToJSON(*objectIt);
      }
    }
    return jsonObject;
  }
 

  json pvlToJSON(Pvl &pvl) {
    return pvlObjectToJSON(pvl);
  }

  json pvlToJSON(QString pvlFile) {
    Pvl pvl;
 
    try {
      pvl.read(pvlFile);
    }
    catch (IException &e){
      QString msg = QString("Failed to open file for PVL Input: [%1]").arg(pvlFile);
      throw IException(e, IException::User, msg, _FILEINFO_);
    }
 
    return pvlToJSON(pvl);
  }
}