1 ////////////////////////////////////////////////////////////////////////
2 //
3 // Copyright (C) 1996-2021 The Octave Project Developers
4 //
5 // See the file COPYRIGHT.md in the top-level directory of this
6 // distribution or <https://octave.org/copyright/>.
7 //
8 // This file is part of Octave.
9 //
10 // Octave is free software: you can redistribute it and/or modify it
11 // under the terms of the GNU General Public License as published by
12 // the Free Software Foundation, either version 3 of the License, or
13 // (at your option) any later version.
14 //
15 // Octave is distributed in the hope that it will be useful, but
16 // WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 // GNU General Public License for more details.
19 //
20 // You should have received a copy of the GNU General Public License
21 // along with Octave; see the file COPYING. If not, see
22 // <https://www.gnu.org/licenses/>.
23 //
24 ////////////////////////////////////////////////////////////////////////
25
26 /*
27
28 The function string_vector::list_in_columns was adapted from a similar
29 function distributed in the GNU file utilities, copyright (C) 85, 88,
30 90, 91, 95, 1996 Free Software Foundation, Inc.
31
32 */
33
34 #if defined (HAVE_CONFIG_H)
35 # include "config.h"
36 #endif
37
38 #include <ostream>
39 #include <string>
40
41 #include "cmd-edit.h"
42 #include "lo-utils.h"
43 #include "str-vec.h"
44
45 // Create a string vector from a NULL terminated list of C strings.
46
string_vector(const char * const * s)47 string_vector::string_vector (const char * const *s)
48 : m_data ()
49 {
50 octave_idx_type n = 0;
51
52 if (s)
53 {
54 const char * const *t = s;
55
56 while (*t++)
57 n++;
58 }
59
60 resize (n);
61
62 for (octave_idx_type i = 0; i < n; i++)
63 elem (i) = s[i];
64 }
65
66 // Create a string vector from up to N C strings. Assumes that N is
67 // nonnegative.
68
string_vector(const char * const * s,octave_idx_type n)69 string_vector::string_vector (const char * const *s, octave_idx_type n)
70 : m_data (dim_vector (n, 1))
71 {
72 for (octave_idx_type i = 0; i < n; i++)
73 elem (i) = s[i];
74 }
75
76 string_vector&
sort(bool make_uniq)77 string_vector::sort (bool make_uniq)
78 {
79 // Don't use Array<std::string>::sort () to allow sorting in place.
80 octave_sort<std::string> lsort;
81 lsort.sort (m_data.fortran_vec (), numel ());
82
83 if (make_uniq)
84 uniq ();
85
86 return *this;
87 }
88 string_vector&
uniq(void)89 string_vector::uniq (void)
90 {
91 octave_idx_type len = numel ();
92
93 if (len > 0)
94 {
95 octave_idx_type k = 0;
96
97 for (octave_idx_type i = 1; i < len; i++)
98 if (elem (i) != elem (k))
99 if (++k != i)
100 elem (k) = elem (i);
101
102 if (len != ++k)
103 resize (k);
104 }
105
106 return *this;
107 }
108
109 string_vector&
append(const std::string & s)110 string_vector::append (const std::string& s)
111 {
112 octave_idx_type len = numel ();
113
114 resize (len + 1);
115
116 elem (len) = s;
117
118 return *this;
119 }
120
121 string_vector&
append(const string_vector & sv)122 string_vector::append (const string_vector& sv)
123 {
124 octave_idx_type len = numel ();
125 octave_idx_type sv_len = sv.numel ();
126 octave_idx_type new_len = len + sv_len;
127
128 resize (new_len);
129
130 for (octave_idx_type i = 0; i < sv_len; i++)
131 elem (len + i) = sv[i];
132
133 return *this;
134 }
135
136 std::string
join(const std::string & sep) const137 string_vector::join (const std::string& sep) const
138 {
139 std::string retval;
140
141 octave_idx_type len = numel ();
142
143 if (len > 0)
144 {
145 octave_idx_type i;
146
147 for (i = 0; i < len - 1; i++)
148 retval += elem (i) + sep;
149
150 retval += elem (i);
151 }
152
153 return retval;
154 }
155
156 char **
c_str_vec(void) const157 string_vector::c_str_vec (void) const
158 {
159 octave_idx_type len = numel ();
160
161 char **retval = new char * [len + 1];
162
163 retval[len] = nullptr;
164
165 for (octave_idx_type i = 0; i < len; i++)
166 retval[i] = strsave (elem (i).c_str ());
167
168 return retval;
169 }
170
171 std::list<std::string>
std_list(void) const172 string_vector::std_list (void) const
173 {
174 octave_idx_type len = numel ();
175
176 std::list<std::string> retval;
177
178 for (octave_idx_type i = 0; i < len; i++)
179 retval.push_back (elem (i));
180
181 return retval;
182 }
183
184 void
delete_c_str_vec(const char * const * v)185 string_vector::delete_c_str_vec (const char * const *v)
186 {
187 if (! v)
188 return;
189
190 const char * const *p = v;
191
192 while (*p)
193 delete [] *p++;
194
195 delete [] v;
196 }
197
198 // Format a list in neat columns.
199
200 std::ostream&
list_in_columns(std::ostream & os,int width,const std::string & prefix) const201 string_vector::list_in_columns (std::ostream& os, int width,
202 const std::string& prefix) const
203 {
204 // Compute the maximum name length.
205
206 octave_idx_type max_name_length = 0;
207 octave_idx_type total_names = numel ();
208
209 if (total_names == 0)
210 {
211 // List empty, remember to end output with a newline.
212
213 os << "\n";
214 return os;
215 }
216
217 for (octave_idx_type i = 0; i < total_names; i++)
218 {
219 octave_idx_type name_length = elem (i).length ();
220 if (name_length > max_name_length)
221 max_name_length = name_length;
222 }
223
224 // Allow at least two spaces between names.
225
226 max_name_length += 2;
227
228 // Calculate the maximum number of columns that will fit.
229
230 octave_idx_type line_length
231 = ((width <= 0 ? octave::command_editor::terminal_cols () : width)
232 - prefix.length ());
233
234 octave_idx_type nc = line_length / max_name_length;
235 if (nc == 0)
236 nc = 1;
237
238 // Calculate the number of rows that will be in each column except
239 // possibly for a short column on the right.
240
241 octave_idx_type nr = total_names / nc + (total_names % nc != 0);
242
243 octave_idx_type count;
244 for (octave_idx_type row = 0; row < nr; row++)
245 {
246 count = row;
247 octave_idx_type pos = 0;
248
249 // Print the next row.
250
251 os << prefix;
252
253 while (1)
254 {
255 std::string nm = elem (count);
256
257 os << nm;
258 octave_idx_type name_length = nm.length ();
259
260 count += nr;
261 if (count >= total_names)
262 break;
263
264 octave_idx_type spaces_to_pad = max_name_length - name_length;
265 for (octave_idx_type i = 0; i < spaces_to_pad; i++)
266 os << ' ';
267 pos += max_name_length;
268 }
269 os << "\n";
270 }
271
272 return os;
273 }
274