Builder.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

// MOOSE includes
#include "ConsoleStreamInterface.h"
#include "MooseTypes.h"
#include "InputParameters.h"

#include "hit/hit.h"

#include <set>
#include <vector>
#include <string>
#include <iomanip>
#include <optional>

// Forward declarations
class ActionWarehouse;
class SyntaxTree;
class MooseApp;
class Factory;
class ActionFactory;
class JsonSyntaxTree;
class Parser;
class Syntax;

namespace Moose
{
class Builder;

class UnusedWalker : public hit::Walker
{
public:
  UnusedWalker(std::set<std::string> used, Builder & p) : _used(used), _builder(p) {}

  void walk(const std::string & fullpath, const std::string & nodename, hit::Node * n) override;

  std::vector<hit::ErrorMessage> errors;

private:
  std::set<std::string> _used;
  Builder & _builder;
};

class Builder : public ConsoleStreamInterface, public hit::Walker
{
public:
  enum SyntaxFormatterType
  {
    INPUT_FILE,
    YAML
  };

  Builder(MooseApp & app, ActionWarehouse & action_wh, Parser & parser);
  virtual ~Builder();

  static InputParameters validParams();

  std::string getPrimaryFileName(bool stripLeadingPath = true) const;

  void build();

  void extractParams(const hit::Node * const section_node, InputParameters & p);
  void extractParams(const std::string & prefix, InputParameters & p);

  void initSyntaxFormatter(SyntaxFormatterType type, bool dump_mode);

  void buildFullTree(const std::string & search_string);

  void buildJsonSyntaxTree(JsonSyntaxTree & tree) const;

  void walk(const std::string & fullpath, const std::string & nodepath, hit::Node * n);

  void errorCheck(const libMesh::Parallel::Communicator & comm, bool warn_unused, bool err_unused);

  std::vector<std::string> listValidParams(std::string & section_name);

private:
  bool isGlobal(const hit::Node & node) const;

  const hit::Node * queryGlobalParamsNode() const;

  MooseApp & _app;
  Factory & _factory;
  ActionWarehouse & _action_wh;
  ActionFactory & _action_factory;
  Syntax & _syntax;
  Parser & _parser;
  hit::Node & _root;

  std::unique_ptr<SyntaxTree> _syntax_formatter;

  std::set<std::string> _extracted_vars;

  std::vector<std::string> _secs_need_first;

  std::vector<hit::ErrorMessage> _errors;

  std::map<std::string, std::string> _deprecated_params;

  mutable std::optional<const hit::Node *> _global_params_node;

  void walkRaw(std::string fullpath, std::string nodepath, hit::Node * n);
};
}