www.mooseframework.org
MooseEnumBase.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
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 "MooseEnumBase.h"
11 #include "MooseUtils.h"
12 #include "MooseError.h"
13 #include "Conversion.h"
14 
15 #include <sstream>
16 #include <algorithm>
17 #include <iterator>
18 #include <limits>
19 #include <string>
20 #include <iostream>
21 #include <cstdlib>
22 
23 MooseEnumBase::MooseEnumBase(std::string names, bool allow_out_of_range)
24  : _allow_out_of_range(allow_out_of_range)
25 {
26  if (names.find(',') != std::string::npos)
27  mooseError("Spaces are required to separate options, comma support has been removed.");
28  else
29  addEnumerationNames(names);
30 }
31 
33  : _items(other_enum._items),
34  _deprecated_items(other_enum._deprecated_items),
35  _allow_out_of_range(other_enum._allow_out_of_range)
36 {
37 }
38 
42 MooseEnumBase::MooseEnumBase() : _allow_out_of_range(false) {}
43 
44 void
45 MooseEnumBase::deprecate(const std::string & name, const std::string & raw_name)
46 {
47  std::set<MooseEnumItem>::const_iterator deprecated = find(name);
48  if (deprecated == _items.end())
49  mooseError("Cannot deprecate the enum item ", name, ", is not an available value.");
50 
51  std::set<MooseEnumItem>::const_iterator replaced = find(raw_name);
52  if (replaced == _items.end())
53  mooseError("Cannot deprecate the enum item ",
54  name,
55  ", since the replaced item ",
56  raw_name,
57  " it is not an available value.");
58 
59  _deprecated_items.emplace(std::make_pair(*deprecated, *replaced));
61 }
62 
63 void
64 MooseEnumBase::addEnumerationNames(const std::string & names)
65 {
66  std::vector<std::string> elements;
67  MooseUtils::tokenize(names, elements, 1, " ");
68  for (const std::string & raw_name : elements)
69  addEnumerationName(raw_name);
70 }
71 
72 void
73 MooseEnumBase::addEnumerationName(const std::string & raw_name)
74 {
75  // Make sure the option is not malformed
76  if (raw_name.find_first_of('=') == 0 || raw_name.find_last_of('=') == raw_name.length() - 1)
77  mooseError("You cannot place whitespace around the '=' character in MooseEnumBase");
78 
79  // Split on equals sign
80  std::vector<std::string> name_value;
81  MooseUtils::tokenize(MooseUtils::trim(raw_name), name_value, 1, "=");
82 
83  // There should be one or two items in the name_value
84  if (name_value.size() < 1 || name_value.size() > 2)
85  mooseError("Invalid option supplied in MooseEnumBase: ", raw_name);
86 
87  // Remove un-wanted space around string
88  name_value[0] = MooseUtils::trim(name_value[0]);
89 
90  // See if there is a value supplied for this option
91  // strtol allows for proper conversions of both int and hex strings
92  int value;
93  if (name_value.size() == 2)
94  value = std::strtol(name_value[1].c_str(), NULL, 0);
95  else
96  value = getNextValidID();
97 
98  addEnumerationName(name_value[0], value);
99 }
100 
101 int
103 {
104  int value = -1; // Use -1 so if no values exist the first will be zero
105  for (const auto & item : _items)
106  value = std::max(value, item.id());
107  return ++value;
108 }
109 
110 void
111 MooseEnumBase::addEnumerationName(const std::string & name, const int & value)
112 {
113  addEnumerationItem(MooseEnumItem(name, value));
114 }
115 
116 void
118 {
119  if (_items.count(item) > 0) // do nothing for identical insertions
120  return;
121 
122  if (find(item.id()) != _items.end())
123  mooseError("The supplied id ",
124  item.id(),
125  " already exists in the enumeration, cannot not add '",
126  item,
127  "'.");
128  if (find(item.name()) != _items.end())
129  mooseError("The name '", item.name(), "' already exists in the enumeration.");
130 
131  _items.insert(item);
132 }
133 
134 void
136 {
137  std::map<MooseEnumItem, MooseEnumItem>::const_iterator it = _deprecated_items.find(item);
138  if (it != _deprecated_items.end())
139  {
140  if (it->second.name().empty())
141  mooseWarning(item.name() + " is deprecated");
142  else
143  mooseWarning(item.name() + " is deprecated, consider using " + it->second.name());
144  }
145 }
146 
147 std::vector<std::string>
149 {
150  std::vector<std::string> out;
151  out.reserve(_items.size());
152  for (const auto & item : _items)
153  out.push_back(item.name());
154  return out;
155 }
156 
157 std::string
159 {
160  return Moose::stringify(_items, " ");
161 }
162 
163 std::vector<int>
165 {
166  std::vector<int> out;
167  out.reserve(_items.size());
168  for (const auto & item : _items)
169  out.push_back(item.id());
170  return out;
171 }
172 
173 std::set<MooseEnumItem>::const_iterator
174 MooseEnumBase::find(const std::string & name) const
175 {
176  std::string upper = MooseUtils::toUpper(name);
177  return std::find_if(_items.begin(), _items.end(), [&upper](MooseEnumItem const & item) {
178  return item.name() == upper;
179  });
180 }
181 
182 std::set<MooseEnumItem>::const_iterator
183 MooseEnumBase::find(int id) const
184 {
185  return std::find_if(
186  _items.begin(), _items.end(), [&id](MooseEnumItem const & item) { return item.id() == id; });
187 }
188 
189 std::set<MooseEnumItem>::const_iterator
190 MooseEnumBase::find(const MooseEnumItem & other) const
191 {
192  return std::find_if(_items.begin(), _items.end(), [&other](MooseEnumItem const & item) {
193  return item.id() == other.id();
194  });
195 }
int getNextValidID() const
Compute the next valid ID.
void tokenize(const std::string &str, std::vector< T > &elements, unsigned int min_len=1, const std::string &delims="/")
This function will split the passed in string on a set of delimiters appending the substrings to the ...
Definition: MooseUtils.h:532
const std::string & name() const
Definition: MooseEnumItem.h:37
std::string toUpper(const std::string &name)
Convert supplied string to upper case.
Definition: MooseUtils.C:651
void addEnumerationItem(const MooseEnumItem &item)
void addEnumerationName(const std::string &raw_name)
Definition: MooseEnumBase.C:73
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:207
std::map< MooseEnumItem, MooseEnumItem > _deprecated_items
The map of deprecated names and optional replacements.
void mooseWarning(Args &&... args)
Emit a warning message with the given stringified, concatenated args.
Definition: MooseError.h:219
void addEnumerationNames(const std::string &names)
Methods to add possible enumeration value to the enum.
Definition: MooseEnumBase.C:64
MooseEnumBase()
Private constuctor for use by libmesh::Parameters.
Definition: MooseEnumBase.C:42
std::string getRawNames() const
Method for returning the raw name strings for this instance.
The base class for both the MooseEnum and MultiMooseEnum classes.
Definition: MooseEnumBase.h:24
std::string trim(const std::string &str, const std::string &white_space=" \\\)
Standard scripting language trim function.
Definition: MooseUtils.C:113
virtual void checkDeprecated() const =0
Method that must be implemented to check derived class values against the _deprecated_names.
std::vector< int > getIDs() const
Method for returning a vector of ids for this instance.
std::string stringify(const T &t)
conversion to string
Definition: Conversion.h:60
std::vector< std::string > getNames() const
Method for returning a vector of all valid enumeration names for this instance.
std::set< MooseEnumItem > _items
Storage for the assigned items.
const int & id() const
Return the numeric, name, or raw name.
Definition: MooseEnumItem.h:36
Class for containing MooseEnum item information.
Definition: MooseEnumItem.h:21
virtual void deprecate(const std::string &name, const std::string &raw_name="")
Deprecates various options in the MOOSE enum.
Definition: MooseEnumBase.C:45
std::set< MooseEnumItem >::const_iterator find(const MooseEnumItem &other) const
Locate an item.