annotate liboctave/util/oct-base64.cc @ 27923:bd51beb6205e

update formatting of copyright notices * Use <https://octave.org/copyright/> instead of <https://octave.org/COPYRIGHT.html/>. * For consistency with other comments in the Octave sources, use C++-style comments for copyright blocks in C and C++ files. * Use delimiters above and below copyright blocks that are appropriate for the language used in the file. * Eliminate extra spacing inside copyright blocks. * lex.ll (looks_like_copyright): Also allow newlines and carriage returns before the word "Copyright". * scripts/mk-doc.pl (gethelp): Also skip empty comment lines. * bp-table.cc, type.m: Adjust tests.
author John W. Eaton <jwe@octave.org>
date Wed, 08 Jan 2020 11:59:41 -0500
parents 1891570abac8
children 903fe321649b 0a5b15007766
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
2 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
3 // Copyright (C) 2012-2020 The Octave Project Developers
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
4 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
7 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
9 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
14 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
19 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
23 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
24 ////////////////////////////////////////////////////////////////////////
15252
fa0118cb67d9 move base64 encode and decode functionality to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
25
21724
aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents: 21301
diff changeset
26 #if defined (HAVE_CONFIG_H)
21301
40de9f8f23a6 Use '#include "config.h"' rather than <config.h>.
Rik <rik@octave.org>
parents: 21213
diff changeset
27 # include "config.h"
21213
f7d1050b9b53 maint: Clean up various usages of #ifdef.
Rik <rik@octave.org>
parents: 21202
diff changeset
28 #endif
15252
fa0118cb67d9 move base64 encode and decode functionality to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
29
21213
f7d1050b9b53 maint: Clean up various usages of #ifdef.
Rik <rik@octave.org>
parents: 21202
diff changeset
30 #include <algorithm>
15252
fa0118cb67d9 move base64 encode and decode functionality to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
31
21213
f7d1050b9b53 maint: Clean up various usages of #ifdef.
Rik <rik@octave.org>
parents: 21202
diff changeset
32 #include "Array.h"
21892
8fcc81df840c hide gnulib base64 function header
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
33 #include "base64-wrappers.h"
21213
f7d1050b9b53 maint: Clean up various usages of #ifdef.
Rik <rik@octave.org>
parents: 21202
diff changeset
34 #include "oct-base64.h"
15252
fa0118cb67d9 move base64 encode and decode functionality to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
35
23748
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
36 namespace octave
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
37 {
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
38 bool
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
39 base64_encode (const char *inc, const size_t inlen, char **out)
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
40 {
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
41 bool ret = false;
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
42
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
43 size_t outlen = octave_base64_encode_alloc_wrapper (inc, inlen, out);
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
44
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
45 if (! out)
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
46 {
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
47 if (outlen == 0 && inlen != 0)
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
48 (*current_liboctave_error_handler)
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
49 ("base64_encode: input array too large");
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
50 else
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
51 (*current_liboctave_error_handler)
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
52 ("base64_encode: memory allocation error");
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
53 }
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
54 else
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
55 ret = true;
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
56
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
57 return ret;
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
58 }
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
59
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
60 Array<double>
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
61 base64_decode (const std::string& str)
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
62 {
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
63 Array<double> retval;
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
64
25704
96584a825b0f avoid alignment warning on solaris systems (bug #54389)
John W. Eaton <jwe@octave.org>
parents: 25054
diff changeset
65 double *out;
23748
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
66 size_t outlen;
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
67
25704
96584a825b0f avoid alignment warning on solaris systems (bug #54389)
John W. Eaton <jwe@octave.org>
parents: 25054
diff changeset
68 bool ok
96584a825b0f avoid alignment warning on solaris systems (bug #54389)
John W. Eaton <jwe@octave.org>
parents: 25054
diff changeset
69 = octave_base64_decode_alloc_wrapper (str.data (), str.length (),
96584a825b0f avoid alignment warning on solaris systems (bug #54389)
John W. Eaton <jwe@octave.org>
parents: 25054
diff changeset
70 reinterpret_cast<char **> (&out),
96584a825b0f avoid alignment warning on solaris systems (bug #54389)
John W. Eaton <jwe@octave.org>
parents: 25054
diff changeset
71 &outlen);
23748
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
72
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
73 if (! ok)
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
74 (*current_liboctave_error_handler)
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
75 ("base64_decode: input was not valid base64");
25704
96584a825b0f avoid alignment warning on solaris systems (bug #54389)
John W. Eaton <jwe@octave.org>
parents: 25054
diff changeset
76
23748
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
77 if (! out)
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
78 (*current_liboctave_error_handler)
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
79 ("base64_decode: memory allocation error");
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
80
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
81 if ((outlen % (sizeof (double) / sizeof (char))) != 0)
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
82 {
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
83 ::free (out);
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
84 (*current_liboctave_error_handler)
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
85 ("base64_decode: incorrect input size");
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
86 }
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
87 else
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
88 {
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
89 octave_idx_type len = (outlen * sizeof (char)) / sizeof (double);
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
90 retval.resize (dim_vector (1, len));
25704
96584a825b0f avoid alignment warning on solaris systems (bug #54389)
John W. Eaton <jwe@octave.org>
parents: 25054
diff changeset
91 std::copy (out, out + len, retval.fortran_vec ());
23748
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
92 ::free (out);
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
93 }
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
94
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
95 return retval;
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
96 }
6e86d3b5a063 move base64 encode and decode functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23447
diff changeset
97 }