1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
[manpage_begin ascii85 n 1.0]
[keywords ascii85]
[keywords encoding]
[copyright "2010, Emiliano Gavil\u00e1n"]
[moddesc {Text encoding & decoding binary data}]
[titledesc {ascii85-encode/decode binary data}]
[category {Text processing}]
[require Tcl 8.4]
[require ascii85 [opt 1.0]]
[description]
[para]
This package provides procedures to encode binary data into ascii85 and back.
[list_begin definitions]
[call [cmd ::ascii85::encode] [opt "[option -maxlen] [arg maxlen]"] [opt "[option -wrapchar] [arg wrapchar]"] [arg string]]
Ascii85 encodes the given binary [arg string] and returns the encoded
result. Inserts the character [arg wrapchar] every [arg maxlen]
characters of output. [arg wrapchar] defaults to newline. [arg maxlen]
defaults to [const 76].
[para]
[emph {Note well}]: If your string is not simple ascii you should fix
the string encoding before doing ascii85 encoding. See the examples.
[para]
The command will throw an error for negative values of [arg maxlen],
or if [arg maxlen] is not an integer number.
[call [cmd ::ascii85::decode] [arg "string"]]
Ascii85 decodes the given [arg "string"] and returns the binary data.
The decoder ignores whitespace in the string, as well as tabs and
newlines.
[list_end]
[section {EXAMPLES}]
[example {
% ascii85::encode "Hello, world"
87cURD_*#TDfTZ)
}]
[example {
% ascii85::encode [string repeat xyz 24]
G^4U[H$X^\H?a^]G^4U[H$X^\H?a^]G^4U[H$X^\H?a^]G^4U[H$X^\H?a^]G^4U[H$X^\H?a^]G
^4U[H$X^\H?a^]
% ascii85::encode -wrapchar "" [string repeat xyz 24]
G^4U[H$X^\H?a^]G^4U[H$X^\H?a^]G^4U[H$X^\H?a^]G^4U[H$X^\H?a^]G^4U[H$X^\H?a^]G^4U[H$X^\H?a^]
}]
[example {
# NOTE: ascii85 encodes BINARY strings.
% set chemical [encoding convertto utf-8 "C\u2088H\u2081\u2080N\u2084O\u2082"]
% set encoded [ascii85::encode $chemical]
6fN]R8E,5Pidu\UiduhZidua
% set caffeine [encoding convertfrom utf-8 [ascii85::decode $encoded]]
}]
[section References]
[list_begin enum]
[enum] [uri http://en.wikipedia.org/wiki/Ascii85]
[enum] Postscript Language Reference Manual, 3rd Edition, page 131.
[uri http://www.adobe.com/devnet/postscript/pdfs/PLRM.pdf]
[list_end]
[vset CATEGORY base64]
[include ../common-text/feedback.inc]
[manpage_end]
|
