junrushao1994 commented on code in PR #11971: URL: https://github.com/apache/tvm/pull/11971#discussion_r911423496
########## include/tvm/script/printer/doc_printer.h: ########## @@ -0,0 +1,148 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +#ifndef TVM_SCRIPT_PRINTER_DOC_PRINTER_H_ +#define TVM_SCRIPT_PRINTER_DOC_PRINTER_H_ + +#include <tvm/script/printer/doc.h> + +#include <string> +#include <memory> + +namespace tvm { +namespace script { +namespace printer { + +/*! + * \brief Configurable options for DocPrinter + * + * \sa DocPrinter + */ +struct DocPrinterOptions { + int indent_spaces = 4; +}; + +/*! + * \brief DocPrinter is responsible for printing Doc tree into text format + * \details This is the base class for translating Doc into string. + * Each target language needs to have its subclass of DocPrinter + * to define the actual logic of printing Doc. + * + * \sa Doc + */ +class DocPrinter { + public: + /*! + * \brief The constructor of DocPrinter + * + * \param options the option for printer + */ + explicit DocPrinter(const DocPrinterOptions& options); + virtual ~DocPrinter() = default; + + /*! + * \brief Append a doc into the final content + * + * \param doc the Doc to be printed + * + * \sa GetString + */ + void Append(const Doc& doc); + + /*! + * \brief Get the printed string of all Doc appended + * + * The content of each Doc in the returned string will + * appear in the same order as they are appended. + * + * \sa Append + */ + String GetString() const; + + protected: + /*! + * \brief Get the printed string + * + * It will dispatch to the PrintTypedDoc method based on + * the actual type of Doc. + * + * \sa PrintTypedDoc + */ + void PrintDoc(const Doc& doc); + + /*! + * \brief Virtual method to print a LiteralDoc + */ + virtual void PrintTypedDoc(const LiteralDoc& doc) = 0; + + using OutputStream = std::ostringstream; Review Comment: No need for this definition. Also, use `std::ostream` to be a bit more general -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
