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 "SyntaxTree.h"
11 :
12 : #include "InputParameters.h"
13 : #include "MooseUtils.h"
14 : #include "Parser.h"
15 :
16 : #include <algorithm>
17 : #include <cctype>
18 :
19 67659 : SyntaxTree::SyntaxTree(bool use_long_names)
20 67659 : : SyntaxFormatterInterface(), _use_long_names(use_long_names)
21 : {
22 67659 : }
23 :
24 67659 : SyntaxTree::~SyntaxTree() = default;
25 :
26 : void
27 2078271 : SyntaxTree::insertNode(std::string syntax,
28 : const std::string & action,
29 : bool is_action_params,
30 : InputParameters * params)
31 : {
32 2078271 : if (!_root)
33 33852 : _root = std::make_unique<TreeNode>("", *this);
34 :
35 2078271 : _root->insertNode(syntax, action, is_action_params, params);
36 2078271 : }
37 :
38 : std::string
39 33852 : SyntaxTree::print(const std::string & search_string)
40 : {
41 33852 : bool found = false;
42 33852 : std::string output;
43 :
44 : // Clear the list of "seen" parameters before printing the tree
45 33852 : _params_printed.clear();
46 :
47 33852 : if (_root)
48 33852 : output = _root->print(-1, search_string, found);
49 :
50 33852 : if (found)
51 33852 : return preamble() + output + postscript();
52 : else
53 0 : return "";
54 33852 : }
55 :
56 : void
57 17340519 : SyntaxTree::seenIt(const std::string & prefix, const std::string & item)
58 : {
59 17340519 : _params_printed.insert(prefix + item);
60 17340519 : }
61 :
62 : bool
63 57257988 : SyntaxTree::haveSeenIt(const std::string & prefix, const std::string & item) const
64 : {
65 57257988 : return _params_printed.find(prefix + item) != _params_printed.end();
66 : }
67 :
68 691759 : SyntaxTree::TreeNode::TreeNode(const std::string & name,
69 : SyntaxTree & syntax_tree,
70 : const std::string * action,
71 : InputParameters * params,
72 691759 : TreeNode * parent)
73 691759 : : _name(name), _parent(parent), _syntax_tree(syntax_tree)
74 : {
75 691759 : if (action)
76 453629 : _action_params.emplace(*action, std::make_unique<InputParameters>(*params));
77 691759 : }
78 :
79 691759 : SyntaxTree::TreeNode::~TreeNode() = default;
80 :
81 : void
82 3016668 : SyntaxTree::TreeNode::insertNode(std::string & syntax,
83 : const std::string & action,
84 : bool is_action_params,
85 : InputParameters * params)
86 : {
87 3016668 : std::string::size_type pos = syntax.find_first_of("/");
88 3016668 : std::string item;
89 3016668 : bool is_leaf = true;
90 :
91 3016668 : item = syntax.substr(0, pos);
92 3016668 : if (pos != std::string::npos)
93 : {
94 938397 : syntax = syntax.substr(pos + 1);
95 938397 : is_leaf = false;
96 : }
97 :
98 3016668 : bool node_created = false;
99 3016668 : if (_children.find(item) == _children.end())
100 : {
101 1315814 : _children[item] = std::make_unique<TreeNode>(
102 1315814 : item, _syntax_tree, is_leaf && is_action_params ? &action : NULL, params, this);
103 657907 : if (is_leaf && !is_action_params)
104 48432 : _children[item]->insertParams(action, is_action_params, params);
105 657907 : node_created = true;
106 : }
107 :
108 3016668 : if (!is_leaf)
109 938397 : _children[item]->insertNode(syntax, action, is_action_params, params);
110 2078271 : else if (!node_created)
111 1576210 : _children[item]->insertParams(action, is_action_params, params);
112 3016668 : }
113 :
114 : void
115 1624642 : SyntaxTree::TreeNode::insertParams(const std::string & action,
116 : bool is_action_params,
117 : InputParameters * params)
118 : {
119 1624642 : if (is_action_params)
120 959855 : _action_params.emplace(action, std::make_unique<InputParameters>(*params));
121 : else
122 664787 : _moose_object_params.emplace(action, std::make_unique<InputParameters>(*params));
123 1624642 : }
124 :
125 : std::string
126 752915 : SyntaxTree::TreeNode::print(short depth, const std::string & search_string, bool & found)
127 : {
128 1505830 : std::string doc = "";
129 752915 : std::string long_name(getLongName());
130 752915 : std::string name(_syntax_tree.isLongNames() ? long_name : _name);
131 752915 : std::string out;
132 :
133 752915 : if (depth < 0)
134 : {
135 301615 : for (const auto & c_it : _children)
136 : {
137 267763 : bool local_found = false;
138 267763 : std::string local_out(c_it.second->print(depth + 1, search_string, local_found));
139 267763 : found |= local_found; // Update the current frame's found variable
140 267763 : if (local_found)
141 267094 : out += local_out;
142 267763 : }
143 33852 : return out;
144 : }
145 :
146 : // GlobalParamsAction is special - we need to just always print it out
147 : // if (_name == "GlobalParamsAction")
148 : // found = true;
149 :
150 719063 : std::string indent((depth + 1) * 2, ' ');
151 :
152 : std::multimap<std::string, std::unique_ptr<InputParameters>>::const_iterator it =
153 719063 : _moose_object_params.begin();
154 : do
155 : {
156 886513 : bool local_found = false;
157 886513 : std::string local_out;
158 :
159 : // Compare the block name, if it's matched we are going to pass an empty search string
160 : // which means match ALL parameters
161 886513 : std::string local_search_string;
162 886513 : if (MooseUtils::wildCardMatch(name, search_string))
163 861508 : found = true;
164 : else
165 25005 : local_search_string = search_string;
166 :
167 886513 : if (it != _moose_object_params.end())
168 725899 : doc = it->second->getClassDescription();
169 886513 : local_out += _syntax_tree.printBlockOpen(name, depth, doc);
170 :
171 4357379 : for (const auto & a_it : _action_params)
172 3470866 : if (a_it.first != "EmptyAction")
173 : {
174 6941624 : local_out += _syntax_tree.printParams(
175 6941624 : name, long_name, *(a_it.second), depth, local_search_string, local_found);
176 3470812 : found |= local_found; // Update the current frame's found variable
177 : // DEBUG
178 : // Moose::out << "\n" << indent << "(" << ait->first << ")";
179 : // DEBUG
180 : }
181 :
182 886513 : if (it != _moose_object_params.end())
183 : {
184 1451798 : local_out += _syntax_tree.printParams(
185 1451798 : name, long_name, *it->second, depth, local_search_string, local_found);
186 725899 : found |= local_found;
187 : // DEBUG
188 : // Moose::out << "\n" << indent << "{" << it->first << "}";
189 : // DEBUG
190 : }
191 :
192 886513 : local_out += _syntax_tree.preTraverse(depth);
193 :
194 1337813 : for (const auto & c_it : _children)
195 : {
196 451300 : bool child_found = false;
197 451300 : std::string child_out(c_it.second->print(depth + 1, local_search_string, child_found));
198 451300 : found |= child_found; // Update the current frame's found variable
199 :
200 451300 : if (child_found)
201 426964 : local_out += child_out;
202 451300 : }
203 :
204 886513 : local_out += _syntax_tree.printBlockClose(name, depth);
205 :
206 886513 : if (found)
207 861508 : out += local_out;
208 :
209 : // If there are no moose object params then we have to be careful about how we
210 : // increment the iterator. We only want to increment if we aren't already
211 : // at the end.
212 886513 : } while (it != _moose_object_params.end() && ++it != _moose_object_params.end());
213 :
214 719063 : return out;
215 752915 : }
216 :
217 : std::string
218 1954431 : SyntaxTree::TreeNode::getLongName(const std::string & delim) const
219 : {
220 1954431 : if (_parent)
221 2403032 : return _parent->getLongName(delim) + delim + _name;
222 : else
223 752915 : return _name;
224 : }
225 :
226 : bool
227 752915 : SyntaxTree::isLongNames() const
228 : {
229 752915 : return _use_long_names;
230 : }
|
