GNU Octave
4.2.1
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
Main Page
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Properties
Friends
Macros
Pages
libinterp
corefcn
comment-list.h
Go to the documentation of this file.
1
/*
2
3
Copyright (C) 2000-2017 John W. Eaton
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
9
Free Software Foundation; either version 3 of the License, or (at your
10
option) any later version.
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
18
along with Octave; see the file COPYING. If not, see
19
<http://www.gnu.org/licenses/>.
20
21
*/
22
23
#if ! defined (octave_comment_list_h)
24
#define octave_comment_list_h 1
25
26
#include "octave-config.h"
27
28
#include <string>
29
30
#include "
base-list.h
"
31
32
extern
std::string
get_comment_text
(
void
);
33
34
extern
char
*
get_comment_text_c_str
(
void
);
35
36
extern
void
save_comment_text
(
const
std::string
&
text
);
37
38
class
39
octave_comment_elt
40
{
41
public
:
42
43
enum
comment_type
44
{
45
unknown
,
46
block
,
47
full_line
,
48
end_of_line
,
49
doc_string
,
50
copyright
51
};
52
53
octave_comment_elt
(
const
std::string
&
s
=
""
,
54
comment_type
t
= unknown)
55
: txt (
s
), typ (
t
) { }
56
57
octave_comment_elt
(
const
octave_comment_elt
& oc)
58
: txt (oc.txt), typ (oc.typ) { }
59
60
octave_comment_elt
&
operator =
(
const
octave_comment_elt
& oc)
61
{
62
if
(
this
!= &oc)
63
{
64
txt = oc.
txt
;
65
typ = oc.
typ
;
66
}
67
68
return
*
this
;
69
}
70
71
std::string
text
(
void
)
const
{
return
txt; }
72
73
comment_type
type
(
void
)
const
{
return
typ; }
74
75
~octave_comment_elt
(
void
) { }
76
77
private
:
78
79
// The text of the comment.
80
std::string
txt
;
81
82
// The type of comment.
83
comment_type
typ
;
84
};
85
86
class
87
octave_comment_list
:
public
octave::base_list<octave_comment_elt>
88
{
89
public
:
90
91
octave_comment_list
(
void
) { }
92
93
void
append
(
const
octave_comment_elt
& elt)
94
{
octave::base_list<octave_comment_elt>::append
(elt); }
95
96
void
append
(
const
std::string
&
s
,
97
octave_comment_elt::comment_type
t
=
octave_comment_elt::unknown
)
98
{
append
(
octave_comment_elt
(s,
t
)); }
99
100
octave_comment_list
*dup (
void
)
const
;
101
};
102
103
#endif
octave_comment_elt::type
comment_type type(void) const
Definition:
comment-list.h:73
octave_comment_list::octave_comment_list
octave_comment_list(void)
Definition:
comment-list.h:91
octave_comment_elt::end_of_line
Definition:
comment-list.h:48
text
Definition:
graphics.h:7885
octave_comment_elt::octave_comment_elt
octave_comment_elt(const octave_comment_elt &oc)
Definition:
comment-list.h:57
octave_comment_elt::comment_type
comment_type
Definition:
comment-list.h:43
t
OCTAVE_EXPORT octave_value_list return the number of command line arguments passed to Octave If called with the optional argument the function t
Definition:
ov-usr-fcn.cc:935
octave_comment_list
Definition:
comment-list.h:86
octave_comment_elt::full_line
Definition:
comment-list.h:47
base-list.h
s
s
Definition:
file-io.cc:2682
octave_comment_list::append
void append(const std::string &s, octave_comment_elt::comment_type t=octave_comment_elt::unknown)
Definition:
comment-list.h:96
octave_comment_elt::typ
comment_type typ
Definition:
comment-list.h:83
octave_comment_elt::txt
std::string txt
Definition:
comment-list.h:80
octave_comment_elt::~octave_comment_elt
~octave_comment_elt(void)
Definition:
comment-list.h:75
octave_comment_elt::doc_string
Definition:
comment-list.h:49
octave_comment_elt::octave_comment_elt
octave_comment_elt(const std::string &s="", comment_type t=unknown)
Definition:
comment-list.h:53
append
bool append
Definition:
load-save.cc:1582
get_comment_text_c_str
char * get_comment_text_c_str(void)
get_comment_text
std::string get_comment_text(void)
octave_comment_elt::text
std::string text(void) const
Definition:
comment-list.h:71
save_comment_text
void save_comment_text(const std::string &text)
octave_comment_elt::block
Definition:
comment-list.h:46
octave_comment_elt
Definition:
comment-list.h:38
octave::base_list::append
void append(const elt_type &s)
Definition:
base-list.h:110
octave_comment_list::append
void append(const octave_comment_elt &elt)
Definition:
comment-list.h:93
string
If this string is the system will ring the terminal sometimes it is useful to be able to print the original representation of the string
Definition:
utils.cc:854
octave_comment_elt::unknown
Definition:
comment-list.h:45
octave_value_list::operator=
octave_value_list & operator=(const octave_value_list &obj)
Definition:
ovl.h:75
octave::base_list< octave_comment_elt >
Generated on Wed May 10 2017 15:42:44 for GNU Octave by
1.8.8