Syntax.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* 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 <string>
#include <map>
#include <set>
#include "DependencyResolver.h"
#include "FileLineInfo.h"

class Syntax
{
public:
  struct ActionInfo
  {
    std::string _action;
    std::string _task;
  };

  Syntax();

  void registerTaskName(const std::string & task, bool should_auto_build = false);

  void registerTaskName(const std::string & task,
                        const std::string & moose_object_type,
                        bool should_auto_build = false);

  void
  appendTaskName(const std::string & task, const std::string & moose_object_type, bool deprecated);

  void addDependency(const std::string & task, const std::string & pre_req);

  void addDependencySets(const std::string & action_sets);

  void deleteTaskDependencies(const std::string & task);

  void clearTaskDependencies();

  const std::vector<std::string> & getSortedTask();

  const std::vector<std::vector<std::string>> & getSortedTaskSet();

  bool hasTask(const std::string & task) const;

  bool isActionRequired(const std::string & task) const;

  bool shouldAutoBuild(const std::string & task) const;

  void registerActionSyntax(const std::string & action,
                            const std::string & syntax,
                            const std::string & task = "",
                            const std::string & file = "",
                            int line = -1);

  void replaceActionSyntax(const std::string & action,
                           const std::string & syntax,
                           const std::string & task,
                           const std::string & file = "",
                           int line = -1);

  void registerSyntaxType(const std::string & syntax, const std::string & type);

  const std::multimap<std::string, std::string> & getAssociatedTypes() const;

  void deprecateActionSyntax(const std::string & syntax);
  void deprecateActionSyntax(const std::string & syntax, const std::string & message);

  std::string deprecatedActionSyntaxMessage(const std::string syntax);

  bool isDeprecatedSyntax(const std::string & syntax) const;

  std::vector<std::string> getSyntaxByAction(const std::string & action,
                                             const std::string & task = "");

  std::vector<std::string> getNonDeprecatedSyntaxByAction(const std::string & action,
                                                          const std::string & task = "");

  std::string isAssociated(const std::string & real_id,
                           bool * is_parent,
                           const std::map<std::string, std::set<std::string>> & alt_map = {}) const;

  std::pair<std::multimap<std::string, ActionInfo>::const_iterator,
            std::multimap<std::string, ActionInfo>::const_iterator>
  getActions(const std::string & syntax) const;

  const std::multimap<std::string, ActionInfo> & getAssociatedActions() const;

  bool verifyMooseObjectTask(const std::string & base, const std::string & task) const;

  FileLineInfo getLineInfo(const std::string & syntax,
                           const std::string & action,
                           const std::string & task) const;

protected:
  std::map<std::string, bool> _registered_tasks;

  std::multimap<std::string, std::string> _moose_systems_to_tasks;

  std::multimap<std::string, std::string> _deprecated_list_moose_systems_to_tasks;

  DependencyResolver<std::string> _tasks;

  std::multimap<std::string, ActionInfo> _syntax_to_actions;

  std::multimap<std::string, std::pair<std::string, std::string>> _actions_to_syntax;

  std::multimap<std::string, std::string> _associated_types;

  bool _actions_to_syntax_valid;

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

  FileLineInfoMap _syntax_to_line;
};