Line data    Source code

       1             : //* This file is part of the MOOSE framework
       2             : //* https://mooseframework.inl.gov
       3             : //*
       4             : //* All rights reserved, see COPYRIGHT for full restrictions
       5             : //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
       6             : //*
       7             : //* Licensed under LGPL 2.1, please see LICENSE for details
       8             : //* https://www.gnu.org/licenses/lgpl-2.1.html
       9             : 
      10             : #include "YAMLFormatter.h"
      11             : 
      12             : // MOOSE includes
      13             : #include "MooseEnum.h"
      14             : #include "MultiMooseEnum.h"
      15             : #include "Parser.h"
      16             : 
      17             : #include "libmesh/vector_value.h"
      18             : #include "libmesh/point.h"
      19             : 
      20             : // C++ includes
      21             : #include <sstream>
      22             : #include <vector>
      23             : 
      24          20 : YAMLFormatter::YAMLFormatter(bool dump_mode) : SyntaxTree(true), _dump_mode(dump_mode) {}
      25             : 
      26             : std::string
      27          20 : YAMLFormatter::preamble() const
      28             : {
      29             :   // important: start and end yaml data delimiters used by python
      30          20 :   return "**START YAML DATA**\n";
      31             : }
      32             : 
      33             : std::string
      34          20 : YAMLFormatter::postscript() const
      35             : {
      36          20 :   return "**END YAML DATA**\n";
      37             : }
      38             : 
      39             : std::string
      40       46914 : YAMLFormatter::printParams(const std::string & prefix,
      41             :                            const std::string & /*fully_qualified_name*/,
      42             :                            InputParameters & params,
      43             :                            short depth,
      44             :                            const std::string & search_string,
      45             :                            bool & found)
      46             : {
      47       46914 :   std::ostringstream oss;
      48       46914 :   std::string indent(depth * 2, ' ');
      49             : 
      50     1600202 :   for (auto & iter : params)
      51             :   {
      52     1553288 :     std::string name = iter.first;
      53             :     // First make sure we want to see this parameter, also block active and type
      54     2680160 :     if (params.isPrivate(iter.first) || name == "active" ||
      55     2680160 :         (search_string != "" && search_string != iter.first) || haveSeenIt(prefix, iter.first))
      56     1134808 :       continue;
      57             : 
      58      418480 :     found = true;
      59             : 
      60             :     // Mark it as "seen"
      61      418480 :     seenIt(prefix, iter.first);
      62             : 
      63             :     // Block params may be required and will have a doc string
      64      418480 :     std::string required = params.isParamRequired(iter.first) ? "Yes" : "No";
      65             : 
      66      418480 :     oss << indent << "  - name: " << name << "\n";
      67      418480 :     oss << indent << "    required: " << required << "\n";
      68      418480 :     oss << indent << "    default: !!str ";
      69             : 
      70             :     // Only output default if it has one
      71      418480 :     if (params.isParamValid(iter.first))
      72             :     {
      73             :       // prints the value, which is the default value when dumping the tree
      74             :       // because it hasn't been changed
      75             : 
      76             :       // Output stream, performing special operations for writing objects such as Points and
      77             :       // RealVectorValues
      78      282369 :       std::ostringstream toss;
      79      282369 :       buildOutputString(toss, iter);
      80             : 
      81             :       // remove additional '\n' possibly generated in output (breaks YAML parsing)
      82      282369 :       std::string tmp_str = toss.str();
      83     1298538 :       for (auto & ch : tmp_str)
      84     1016169 :         if (ch == '\n')
      85           0 :           ch = ' ';
      86      282369 :       if (tmp_str == ",")
      87          70 :         oss << "\"" << tmp_str << "\"";
      88             :       else
      89      282299 :         oss << tmp_str;
      90      282369 :     }
      91      136111 :     else if (params.hasDefaultCoupledValue(iter.first))
      92         340 :       oss << params.defaultCoupledValue(iter.first);
      93             : 
      94      418480 :     std::string doc = params.getDocString(iter.first);
      95      418480 :     MooseUtils::escape(doc);
      96             :     // Print the type
      97             :     oss << "\n"
      98      418480 :         << indent << "    cpp_type: " << params.type(iter.first) << "\n"
      99      418480 :         << indent << "    group_name: ";
     100      418480 :     std::string group_name = params.getGroupName(iter.first);
     101      418480 :     if (!group_name.empty())
     102      252893 :       oss << "'" << group_name << "'";
     103      418480 :     oss << "\n";
     104             : 
     105      418480 :     oss << indent << "    doc_unit: ";
     106      418480 :     std::string doc_unit = params.getDocUnit(iter.first);
     107      418480 :     if (!doc_unit.empty())
     108           0 :       oss << "'" << doc_unit << "'";
     109      418480 :     oss << "\n";
     110             : 
     111      418480 :     if (params.have_parameter<MooseEnum>(name))
     112       12699 :       addEnumOptionsAndDocs(oss, params.get<MooseEnum>(name), indent);
     113      418480 :     if (params.have_parameter<MultiMooseEnum>(name))
     114       12818 :       addEnumOptionsAndDocs(oss, params.get<MultiMooseEnum>(name), indent);
     115      418480 :     if (params.have_parameter<ExecFlagEnum>(name))
     116       10890 :       addEnumOptionsAndDocs(oss, params.get<ExecFlagEnum>(name), indent);
     117      418480 :     if (params.have_parameter<std::vector<MooseEnum>>(name))
     118          20 :       addEnumOptionsAndDocs(oss, params.get<std::vector<MooseEnum>>(name)[0], indent);
     119             : 
     120      418480 :     oss << indent << "    description: |\n      " << indent << doc << std::endl;
     121     1553288 :   }
     122             : 
     123       93828 :   return oss.str();
     124       46914 : }
     125             : 
     126             : template <typename T>
     127             : void
     128       36427 : YAMLFormatter::addEnumOptionsAndDocs(std::ostringstream & oss,
     129             :                                      T & param,
     130             :                                      const std::string & indent)
     131             : {
     132       36427 :   oss << indent << "    options: " << param.getRawNames() << '\n';
     133       36427 :   const auto & docs = param.getItemDocumentation();
     134       36427 :   if (!docs.empty())
     135             :   {
     136          90 :     oss << indent << "    option_docs:\n";
     137         330 :     for (const auto & doc : docs)
     138             :     {
     139         240 :       oss << indent << "    - name: " << doc.first.name() << "\n";
     140         240 :       oss << indent << "      description: |\n";
     141         240 :       oss << indent << "        " << doc.second << "\n";
     142             :     }
     143             :   }
     144       36427 : }
     145             : 
     146             : std::string
     147       48102 : YAMLFormatter::preTraverse(short depth) const
     148             : {
     149       48102 :   std::string indent(depth * 2, ' ');
     150             : 
     151       96204 :   return indent + "  subblocks:\n";
     152       48102 : }
     153             : 
     154             : std::string
     155       48102 : YAMLFormatter::printBlockOpen(const std::string & name, short depth, const std::string & doc)
     156             : {
     157       48102 :   std::ostringstream oss;
     158       48102 :   std::string indent(depth * 2, ' ');
     159             : 
     160       48102 :   std::string docEscaped = doc;
     161       48102 :   MooseUtils::escape(docEscaped);
     162             : 
     163       48102 :   oss << indent << "- name: " << name << "\n";
     164       48102 :   oss << indent << "  description: |\n" << indent << "    " << docEscaped << "\n";
     165       48102 :   oss << indent << "  parameters:\n";
     166             : 
     167       96204 :   return oss.str();
     168       48102 : }
     169             : 
     170             : std::string
     171       48102 : YAMLFormatter::printBlockClose(const std::string & /*name*/, short /*depth*/) const
     172             : {
     173       48102 :   return std::string();
     174             : }
     175             : 
     176             : void
     177      282369 : YAMLFormatter::buildOutputString(
     178             :     std::ostringstream & output,
     179             :     const std::iterator_traits<InputParameters::iterator>::value_type & p)
     180             : {
     181      282369 :   libMesh::Parameters::Value * val = MooseUtils::get(p.second);
     182             : 
     183             :   // Account for Point
     184      282369 :   InputParameters::Parameter<Point> * ptr0 = dynamic_cast<InputParameters::Parameter<Point> *>(val);
     185             : 
     186             :   // Account for RealVectorValues
     187             :   InputParameters::Parameter<RealVectorValue> * ptr1 =
     188      282369 :       dynamic_cast<InputParameters::Parameter<RealVectorValue> *>(val);
     189             : 
     190             :   // Output the Point components
     191      282369 :   if (ptr0)
     192         270 :     output << ptr0->get().operator()(0) << " " << ptr0->get().operator()(1) << " "
     193         270 :            << ptr0->get().operator()(2);
     194             : 
     195             :   // Output the RealVectorValue components
     196      282099 :   else if (ptr1)
     197         120 :     output << ptr1->get().operator()(0) << " " << ptr1->get().operator()(1) << " "
     198         120 :            << ptr1->get().operator()(2);
     199             : 
     200             :   // General case, call the print operator
     201             :   else
     202      281979 :     p.second->print(output);
     203      282369 : }