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

#include <string>
#include <ostream>

class InputParameters;

class SyntaxFormatterInterface
{
public:
  SyntaxFormatterInterface() {}
  virtual ~SyntaxFormatterInterface() = default;

  virtual std::string preamble() const { return std::string(); }

  virtual std::string postscript() const { return std::string(); }

  virtual std::string preTraverse(short /*depth*/) const { return std::string(); }

  virtual std::string
  printBlockOpen(const std::string & name, short depth, const std::string & doc) = 0;

  virtual std::string printBlockClose(const std::string & name, short depth) const = 0;

  virtual std::string printParams(const std::string & prefix,
                                  const std::string & fully_qualified_name,
                                  InputParameters & params,
                                  short depth,
                                  const std::string & search_string,
                                  bool & found) = 0;
};