Mercurial > octave
view libinterp/parse-tree/comment-list.h @ 33292:2e840d58dba7
comment_list: don't inherit from std::list
* comment-list.h (class comment_list): Store std::list<comment_elt> as
data member instead of using inheritance. Adjust member functions.
(comment_list::reference, comment_list::const_reference,
comment_list::iterator, comment_list::const_iterator): New typedefs.
(comment_list::clear, comment_list::front, comment_list::back,
comment_list::begin, comment_list::end, comment_list::empty):
New methods.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Thu, 28 Mar 2024 13:00:25 -0400 |
parents | 0b5f3219b650 |
children |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 2000-2024 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 <list> #include <memory> #include <string> OCTAVE_BEGIN_NAMESPACE(octave) extern std::string get_comment_text (); extern char * get_comment_text_c_str (); extern void save_comment_text (const std::string& text); class comment_elt { public: enum comment_type { unknown, block, full_line, end_of_line, copyright }; comment_elt (const std::string& s = "", comment_type t = unknown, bool uses_hash_char = false) : m_text (s), m_type (t), m_uses_hash_char (uses_hash_char) { } comment_elt (const comment_elt& oc) : m_text (oc.m_text), m_type (oc.m_type), m_uses_hash_char (oc.m_uses_hash_char) { } comment_elt& operator = (const comment_elt& oc) { if (this != &oc) { m_text = oc.m_text; m_type = oc.m_type; m_uses_hash_char = oc.m_uses_hash_char; } return *this; } bool empty () const { return m_text.empty (); } std::string text () const { return m_text; } comment_type type () const { return m_type; } bool is_block () const { return m_type == block; } bool is_full_line () const { return m_type == full_line; } bool is_end_of_line () const { return m_type == end_of_line; } bool is_copyright () const { return m_type == copyright; } bool uses_hash_char () const { return m_uses_hash_char; } void reset () { m_text = ""; m_type = unknown; m_uses_hash_char = false; } ~comment_elt () = default; private: // The text of the comment. std::string m_text; // The type of comment. comment_type m_type; // TRUE means a line comment uses '#' or a block comment used at least // one '#' delimiter. bool m_uses_hash_char; }; class comment_list { public: OCTAVE_DEFAULT_CONSTRUCT_COPY_MOVE_DELETE (comment_list) typedef std::list<comment_elt>::reference reference; typedef std::list<comment_elt>::const_reference const_reference; typedef std::list<comment_elt>::iterator iterator; typedef std::list<comment_elt>::const_iterator const_iterator; void append (const comment_elt& elt) { m_list.push_back (elt); } void append (const std::string& s, comment_elt::comment_type t = comment_elt::unknown, bool uses_hash_char = false) { m_list.push_back (comment_elt (s, t, uses_hash_char)); } void clear () { m_list.clear (); } bool empty () const { return m_list.empty (); } reference front () { return m_list.front (); } reference back () { return m_list.back (); } const_reference front () const { return m_list.front (); } const_reference back () const { return m_list.back (); } iterator begin () { return m_list.begin (); } iterator end () { return m_list.end (); } const_iterator begin () const { return m_list.begin (); } const_iterator end () const { return m_list.end (); } comment_list * dup () const; // Documentation for functions is typically the first block of // comments that doesn't look like a copyright statement. comment_elt find_doc_comment () const { for (const auto& elt : m_list) { // FIXME: should we also omit end-of-line comments? if (! elt.is_copyright ()) return elt; } return comment_elt (); } std::string find_doc_string () const { return find_doc_comment().text (); } private: std::list<comment_elt> m_list; }; OCTAVE_END_NAMESPACE(octave) #endif