Mercurial > octave-nkf
annotate src/comment-list.h @ 14138:72c96de7a403 stable
maint: update copyright notices for 2012
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Mon, 02 Jan 2012 14:25:41 -0500 |
| parents | 7dd7cccf0757 |
| children |
| rev | line source |
|---|---|
| 3665 | 1 /* |
| 2 | |
|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
13983
diff
changeset
|
3 Copyright (C) 2000-2012 John W. Eaton |
| 3665 | 4 |
| 5 This file is part of Octave. | |
| 6 | |
| 7 Octave is free software; you can redistribute it and/or modify it | |
| 8 under the terms of the GNU General Public License as published by the | |
| 7016 | 9 Free Software Foundation; either version 3 of the License, or (at your |
| 10 option) any later version. | |
| 3665 | 11 |
| 12 Octave is distributed in the hope that it will be useful, but WITHOUT | |
| 13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 15 for more details. | |
| 16 | |
| 17 You should have received a copy of the GNU General Public License | |
| 7016 | 18 along with Octave; see the file COPYING. If not, see |
| 19 <http://www.gnu.org/licenses/>. | |
| 3665 | 20 |
| 21 */ | |
| 22 | |
| 23 #if !defined (octave_comment_list_h) | |
| 24 #define octave_comment_list_h 1 | |
| 25 | |
| 26 #include <string> | |
| 27 | |
| 4219 | 28 #include <base-list.h> |
| 3665 | 29 |
| 30 extern std::string get_comment_text (void); | |
| 31 | |
| 32 extern char *get_comment_text_c_str (void); | |
| 33 | |
| 34 extern void save_comment_text (const std::string& text); | |
| 35 | |
| 36 class | |
| 37 octave_comment_elt | |
| 38 { | |
| 39 public: | |
| 40 | |
| 41 enum comment_type | |
| 42 { | |
| 43 unknown, | |
| 44 block, | |
| 45 end_of_line, | |
| 46 doc_string, | |
| 47 copyright | |
| 48 }; | |
| 49 | |
| 50 octave_comment_elt (const std::string& s = std::string (), | |
| 10313 | 51 comment_type t = unknown) |
| 3665 | 52 : txt (s), typ (t) { } |
| 53 | |
| 54 octave_comment_elt (const octave_comment_elt& oc) | |
| 55 : txt (oc.txt), typ (oc.typ) { } | |
| 56 | |
| 57 octave_comment_elt& operator = (const octave_comment_elt& oc) | |
| 58 { | |
| 59 if (this != &oc) | |
| 10313 | 60 { |
| 61 txt = oc.txt; | |
| 62 typ = oc.typ; | |
| 63 } | |
| 3665 | 64 |
| 65 return *this; | |
| 66 } | |
| 67 | |
| 68 std::string text (void) const { return txt; } | |
| 69 | |
| 70 comment_type type (void) const { return typ; } | |
| 71 | |
| 72 ~octave_comment_elt (void) { } | |
| 73 | |
| 74 private: | |
| 75 | |
| 76 // The text of the comment. | |
| 77 std::string txt; | |
| 78 | |
| 79 // The type of comment. | |
| 80 comment_type typ; | |
| 81 }; | |
| 82 | |
| 83 class | |
| 4219 | 84 octave_comment_list : public octave_base_list<octave_comment_elt> |
| 3665 | 85 { |
| 86 public: | |
| 87 | |
| 5861 | 88 octave_comment_list (void) { } |
| 89 | |
| 4219 | 90 void append (const octave_comment_elt& elt) |
| 91 { octave_base_list<octave_comment_elt>::append (elt); } | |
| 3665 | 92 |
| 4212 | 93 void append (const std::string& s, |
| 10313 | 94 octave_comment_elt::comment_type t = octave_comment_elt::unknown) |
| 4219 | 95 { append (octave_comment_elt (s, t)); } |
| 5861 | 96 |
|
8913
35cd375d4bb3
make tree::dup functions const
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
97 octave_comment_list *dup (void) const; |
| 3665 | 98 }; |
| 99 | |
| 100 class | |
| 101 octave_comment_buffer | |
| 102 { | |
| 103 public: | |
| 104 | |
| 105 octave_comment_buffer (void) | |
| 5861 | 106 : comment_list (new octave_comment_list ()) { } |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
107 |
|
13983
7dd7cccf0757
clean up memory allocated for singletons before exit
John W. Eaton <jwe@octave.org>
parents:
11586
diff
changeset
|
108 ~octave_comment_buffer (void) { delete comment_list; } |
|
7dd7cccf0757
clean up memory allocated for singletons before exit
John W. Eaton <jwe@octave.org>
parents:
11586
diff
changeset
|
109 |
| 3665 | 110 static bool instance_ok (void); |
| 111 | |
| 112 static void append | |
| 113 (const std::string& s, | |
| 114 octave_comment_elt::comment_type t = octave_comment_elt::unknown); | |
| 115 | |
| 116 static octave_comment_list *get_comment (void); | |
| 117 | |
| 118 private: | |
| 119 | |
| 120 void do_append (const std::string& s, octave_comment_elt::comment_type t); | |
| 121 | |
| 122 octave_comment_list *do_get_comment (void); | |
| 123 | |
| 124 octave_comment_list *comment_list; | |
| 125 | |
| 126 static octave_comment_buffer *instance; | |
|
13983
7dd7cccf0757
clean up memory allocated for singletons before exit
John W. Eaton <jwe@octave.org>
parents:
11586
diff
changeset
|
127 |
|
7dd7cccf0757
clean up memory allocated for singletons before exit
John W. Eaton <jwe@octave.org>
parents:
11586
diff
changeset
|
128 static void cleanup_instance (void) { delete instance; instance = 0; } |
| 3665 | 129 }; |
| 130 | |
| 131 #endif |