JsonSyntaxTree.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html
 
#pragma once
 
#include "InputParameters.h"
#include "FileLineInfo.h"
#include "nlohmann/json.h"
#include <string>
#include <vector>
#include <utility>
 
class JsonSyntaxTree
{
public:
  JsonSyntaxTree(const std::string & search_string);
  virtual ~JsonSyntaxTree() {}
 
  bool addParameters(const std::string & parent_path,
                     const std::string & path,
                     bool is_type,
                     const std::string & action,
                     bool is_action,
                     InputParameters * params,
                     const FileLineInfo & lineinfo,
                     const std::string & classname);
 
  void addActionTask(const std::string & path,
                     const std::string & action,
                     const std::string & task,
                     const FileLineInfo & lineinfo);
  const nlohmann::json & getRoot() const { return _root; }
 
  void addSyntaxType(const std::string & path, const std::string type);
 
  void addGlobal();
 
  static std::string documentationCppType(const std::string & cpp_type);
  static std::string basicCppType(const std::string & cpp_type);
 
protected:
  std::string buildOptions(const std::iterator_traits<InputParameters::iterator>::value_type & p,
                           bool & out_of_range_allowed,
                           std::map<MooseEnumItem, std::string> & docs);
 
  size_t setParams(InputParameters * params, bool search_match, nlohmann::json & all_params);
 
  static std::string
  buildOutputString(const std::iterator_traits<InputParameters::iterator>::value_type & p);
  static std::vector<std::string> splitPath(const std::string & path);
  nlohmann::json & getJson(const std::string & parent, const std::string & path, bool is_type);
  nlohmann::json & getJson(const std::string & path);
  std::pair<std::string, std::string> getObjectLabel(const std::string & obj) const;
  std::pair<std::string, std::string> getActionLabel(const std::string & action) const;
 
  nlohmann::json _root;
  std::string _search;
 
  std::map<std::string, std::pair<std::string, std::string>> _action_label_map;
  std::map<std::string, std::pair<std::string, std::string>> _object_label_map;
 
  // Allow the MooseServer class to use protected static convenience methods
  friend class MooseServer;
};