annotate src/comment-list.h @ 5307:4c8a2e4e0717

[project @ 2005-04-26 19:24:27 by jwe]
author jwe
date Tue, 26 Apr 2005 19:24:47 +0000
parents e35b034d3523
children 2a6cb4ed8f1e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
1 /*
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
2
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
3 Copyright (C) 2000 John W. Eaton
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
4
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
6
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
10 later version.
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
11
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
15 for more details.
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
16
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, write to the Free
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5105
diff changeset
19 Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5105
diff changeset
20 02110-1301, USA.
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
21
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
22 */
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
23
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
24 #if !defined (octave_comment_list_h)
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
25 #define octave_comment_list_h 1
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
26
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
27 #include <string>
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
28
4219
23d06c9e1edd [project @ 2002-12-06 21:29:17 by jwe]
jwe
parents: 4212
diff changeset
29 #include <base-list.h>
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
30
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
31 extern std::string get_comment_text (void);
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
32
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
33 extern char *get_comment_text_c_str (void);
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
34
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
35 extern void save_comment_text (const std::string& text);
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
36
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
37 class
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
38 octave_comment_elt
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
39 {
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
40 public:
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
41
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
42 enum comment_type
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
43 {
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
44 unknown,
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
45 block,
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
46 end_of_line,
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
47 doc_string,
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
48 copyright
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
49 };
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
50
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
51 octave_comment_elt (const std::string& s = std::string (),
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
52 comment_type t = unknown)
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
53 : txt (s), typ (t) { }
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
54
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
55 octave_comment_elt (const octave_comment_elt& oc)
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
56 : txt (oc.txt), typ (oc.typ) { }
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
57
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
58 octave_comment_elt& operator = (const octave_comment_elt& oc)
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
59 {
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
60 if (this != &oc)
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
61 {
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
62 txt = oc.txt;
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
63 typ = oc.typ;
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
64 }
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
65
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
66 return *this;
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
67 }
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
68
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
69 std::string text (void) const { return txt; }
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
70
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
71 comment_type type (void) const { return typ; }
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
72
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
73 ~octave_comment_elt (void) { }
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
74
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
75 private:
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
76
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
77 // The text of the comment.
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
78 std::string txt;
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
79
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
80 // The type of comment.
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
81 comment_type typ;
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
82 };
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
83
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
84 class
4219
23d06c9e1edd [project @ 2002-12-06 21:29:17 by jwe]
jwe
parents: 4212
diff changeset
85 octave_comment_list : public octave_base_list<octave_comment_elt>
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
86 {
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
87 public:
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
88
4219
23d06c9e1edd [project @ 2002-12-06 21:29:17 by jwe]
jwe
parents: 4212
diff changeset
89 void append (const octave_comment_elt& elt)
23d06c9e1edd [project @ 2002-12-06 21:29:17 by jwe]
jwe
parents: 4212
diff changeset
90 { octave_base_list<octave_comment_elt>::append (elt); }
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
91
4212
8ad52ec4f374 [project @ 2002-12-04 03:50:45 by jwe]
jwe
parents: 4192
diff changeset
92 void append (const std::string& s,
8ad52ec4f374 [project @ 2002-12-04 03:50:45 by jwe]
jwe
parents: 4192
diff changeset
93 octave_comment_elt::comment_type t = octave_comment_elt::unknown)
4219
23d06c9e1edd [project @ 2002-12-06 21:29:17 by jwe]
jwe
parents: 4212
diff changeset
94 { append (octave_comment_elt (s, t)); }
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
95 };
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
96
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
97 class
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
98 octave_comment_buffer
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
99 {
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
100 public:
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
101
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
102 octave_comment_buffer (void)
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
103 : comment_list (new octave_comment_list) { }
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
104
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
105 static bool instance_ok (void);
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
106
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
107 static void append
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
108 (const std::string& s,
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
109 octave_comment_elt::comment_type t = octave_comment_elt::unknown);
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
110
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
111 static octave_comment_list *get_comment (void);
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
112
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
113 private:
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
114
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
115 void do_append (const std::string& s, octave_comment_elt::comment_type t);
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
116
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
117 octave_comment_list *do_get_comment (void);
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
118
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
119 octave_comment_list *comment_list;
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
120
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
121 static octave_comment_buffer *instance;
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
122 };
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
123
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
124 #endif
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
125
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
126 /*
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
127 ;;; Local Variables: ***
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
128 ;;; mode: C++ ***
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
129 ;;; End: ***
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
130 */