octave: scripts/+matlab/+net/base64encode.m annotate

annotate scripts/+matlab/+net/base64encode.m @ 28769:903fe321649b

Add Matlab compatible wrappers for base64_encode and base64_decode. * liboctave/util/oct-base64.cc, oct-base64.h (base64_decode_bytes): New function to decode base64 encoded strings into bytes. * libinterp/corefcn/data.cc (F__base64_decode_bytes__): New internal function to decode base64 encoded strings into bytes. * scripts/+matlab/+net/base64decode.m, scripts/+matlab/+net/base64encode.m: Add Matlab compatible wrappers for base64_encode and __base64_decode_bytes__. * scripts/+matlab/+net/module.mk: Add new file. * scripts/module.mk: Include new module.mk file. * doc/interpreter/system.txi: Add documentation for new functions to manual. * NEWS: Announce new functions.

author	Markus Mützel <markus.muetzel@gmx.de>
date	Tue, 22 Sep 2020 15:59:00 +0200
parents
children	28de41192f3c

rev	line source
28769 903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	1 ########################################################################
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	2 ##
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	3 ## Copyright (C) 2020 The Octave Project Developers
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	4 ##
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	5 ## See the file COPYRIGHT.md in the top-level directory of this
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	6 ## distribution or <https://octave.org/copyright/>.
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	7 ##
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	8 ## This file is part of Octave.
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	9 ##
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	10 ## Octave is free software: you can redistribute it and/or modify it
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	11 ## under the terms of the GNU General Public License as published by
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	12 ## the Free Software Foundation, either version 3 of the License, or
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	13 ## (at your option) any later version.
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	14 ##
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	15 ## Octave is distributed in the hope that it will be useful, but
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	18 ## GNU General Public License for more details.
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	19 ##
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	20 ## You should have received a copy of the GNU General Public License
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	21 ## along with Octave; see the file COPYING. If not, see
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	22 ## <https://www.gnu.org/licenses/>.
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	23 ##
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	24 ########################################################################
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	25
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	26 ## -- texinfo --
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	27 ## @deftypefn {} {@var{b64_str} =} matlab.net.base64encode (@var{in})
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	28 ##
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	29 ## Convert @var{in} to a base64 encoded string @var{b64_str}.
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	30 ##
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	31 ## The input @var{in} can be a string or numeric vector.
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	32 ## The output @var{b64_str} will be encoded according to RFC 4648.
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	33 ##
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	34 ## @seealso{matlab.net.base64decode, base64_decode, base64_encode, unicode2native}
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	35 ## @end deftypefn
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	36
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	37 function b64_str = base64encode (in)
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	38
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	39 if (nargin != 1 \|\| nargout > 1)
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	40 print_usage ();
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	41 endif
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	42
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	43 if (! isvector (in) \|\| ! (isnumeric (in) \|\| ischar (in)))
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	44 error ("base64encode: IN must be a numeric or character vector");
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	45 endif
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	46
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	47 if (any (in != round (in)))
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	48 error ("base64encode: IN must consist of integers");
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	49 endif
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	50
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	51 b64_str = base64_encode (uint8 (in));
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	52
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	53 endfunction
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	54
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	55
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	56 ## Test char vector input
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	57 %!assert (matlab.net.base64encode (1), "AQ==");
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	58 %!assert (matlab.net.base64encode (255), "/w==");
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	59 %!assert (matlab.net.base64encode (1:3), "AQID");
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	60 %!assert (matlab.net.base64encode ("a"), "YQ==");
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	61 %!assert (matlab.net.base64encode ("abcdefg"), "YWJjZGVmZw==");
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	62
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	63 ## Test input validation
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	64 %!error matlab.net.base64encode ()
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	65 %!error <numeric or character vector> matlab.net.base64encode ({1,2})
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	66 %!error <numeric or character vector> matlab.net.base64encode ([1,2;3,4])
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: diff changeset	67 %!error <consist of integers> matlab.net.base64encode (pi)

Mercurial > octave

annotate scripts/+matlab/+net/base64encode.m @ 28769:903fe321649b