Mercurial > octave
view libinterp/parse-tree/comment-list.h @ 28510:a3ea758870dc stable
new comment_elt predicates
* comment-list.h (comment_elt::is_block, comment_elt::is_full_line,
comment_elt::is_end_of_line, comment_elt::is_doc_string,
comment_elt::is_copyright): New functions.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Fri, 29 May 2020 11:00:41 -0400 |
parents | bd51beb6205e |
children | 0a5b15007766 |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 2000-2020 The Octave Project Developers // // See the file COPYRIGHT.md in the top-level directory of this // distribution or <https://octave.org/copyright/>. // // This file is part of Octave. // // Octave is free software: you can redistribute it and/or modify it // under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // Octave is distributed in the hope that it will be useful, but // WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with Octave; see the file COPYING. If not, see // <https://www.gnu.org/licenses/>. // //////////////////////////////////////////////////////////////////////// #if ! defined (octave_comment_list_h) #define octave_comment_list_h 1 #include "octave-config.h" #include <string> #include "base-list.h" namespace octave { extern std::string get_comment_text (void); extern char * get_comment_text_c_str (void); extern void save_comment_text (const std::string& text); class comment_elt { public: enum comment_type { unknown, block, full_line, end_of_line, doc_string, copyright }; comment_elt (const std::string& s = "", comment_type t = unknown) : m_text (s), m_type (t) { } comment_elt (const comment_elt& oc) : m_text (oc.m_text), m_type (oc.m_type) { } comment_elt& operator = (const comment_elt& oc) { if (this != &oc) { m_text = oc.m_text; m_type = oc.m_type; } return *this; } std::string text (void) const { return m_text; } comment_type type (void) const { return m_type; } bool is_block (void) const { return m_type == block; } bool is_full_line (void) const { return m_type == full_line; } bool is_end_of_line (void) const { return m_type == end_of_line; } bool is_doc_string (void) const { return m_type == doc_string; } bool is_copyright (void) const { return m_type == copyright; } ~comment_elt (void) = default; private: // The text of the comment. std::string m_text; // The type of comment. comment_type m_type; }; class comment_list : public base_list<comment_elt> { public: comment_list (void) { } void append (const comment_elt& elt) { base_list<comment_elt>::append (elt); } void append (const std::string& s, comment_elt::comment_type t = comment_elt::unknown) { append (comment_elt (s, t)); } comment_list * dup (void) const; }; } #endif