From ad485d0160d62c4c7077e88342e70f9e4bd3300e Mon Sep 17 00:00:00 2001
From: Kaz Kylheku <kaz@kylheku.com>
Date: Thu, 21 Jan 2016 05:46:02 -0800
Subject: Support for Base 64 encoding.

* filter.c (tobase64_k, frombase64_k): New keyword symbol variables.
(col_check, get_base64_char, b64_code): New static functions.
(base64_decode, base64_encode): New functions.
(filter_init): Initialize new keyword symbol variables, and register
base64-encode and base64-decode intrinsic functions.

* filter.h (base64_encode, base64_decode): Declared.

* txr.1: Documented base64-encode, base64-decode,
as well as :tobase64 and :frombase64.
---
 txr.1 | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 63 insertions(+)

(limited to 'txr.1')

diff --git a/txr.1 b/txr.1
index b6799cec..2a1e5d3d 100644
--- a/txr.1
+++ b/txr.1
@@ -7904,6 +7904,12 @@ character, being in the
 reserved set, encodes to
 .codn %2B .
 
+.coIP :frombase64
+Decode from the Base 64 encoding described in RFC 4648.
+
+.coIP :tobase64
+Encodes to the RFC 4648 Base 64 encoding.
+
 .coIP :tonumber
 Converts strings to numbers. Strings that contain a period,
 .code e
@@ -37201,6 +37207,63 @@ be suitable for insertion into a HTML template, depending on the
 context of its insertion. It is suitable as text placed between
 tags but not necessary as tag attribute material.
 
+.coNP Functions @ base64-encode and @ base64-decode
+.synb
+.mets (base64-encode < string <> [ column-width ])
+.mets (base64-decode < string)
+.syne
+.desc
+The
+.code base64-encode
+function converts the UTF-8 representation of
+.meta string
+to Base 64 and returns that representation as a string.
+
+The
+.code base64-decode
+functions performs the opposite conversion; it extracts the
+bytes encoded in a Base 64 string, and decodes them as UTF-8
+to return a character string.
+
+The Base 64 encoding divides the UTF-8 representation into groups of
+six bits, each representing the values 0 to 63. Each value is then
+mapped to the characters
+.code A
+to
+.codn Z,
+.code a
+to
+.codn z,
+the digits
+.code 0
+to
+.code 9
+and the characters
+.code +
+and
+.codn /.
+One or two consecutive occurrences of the character
+.code =
+are added as padding so that the number of
+non-whitespace characters is divisible by four. These characters map to
+the code 0, but are understood not to contribute to the length of the
+encoded message. The
+.code base64-encode
+function enforces this convention, but
+.code base64-decode
+doesn't require these padding characters.
+
+Base64-encoding an empty string results in an empty string.
+
+If the
+.meta column-width
+argument is passed to
+.codn base64-encode ,
+then the Base 64 encoded string, unless empty, contains newline
+characters, which divide it into lines which are
+.meta column-width
+long, except possibly for the last line.
+
 .SS* Filter Module
 The filter module provides a trie (pronounced "try") data structure,
 which is suitable for representing dictionaries for efficient filtering.
-- 
cgit v1.2.3