Gzip (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
No edit summary
 
(9 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Template:String:Gzip subtitle}}
{{Template:String:Gzip subtitle}}
This function compresses a longstring using the "deflate" algorithm, which is described completely in RFC 1951. The GZIP format is described in RFC 1952. It is very effective with HTML and XML data.


==Syntax==
==Syntax==
{{Template:String:Gzip syntax}}
{{Template:String:Gzip syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%outString</th><td>The result of the GZIP operation, compressing the method object <var class="term">string</var>.</td></tr>
<tr><th>%outString</th>
<td>The result of the GZIP operation, compressing the method object <var class="term">string</var>.</td></tr>
 
<tr><th>string</th>
<tr><th>string</th>
<td>The string to be compressed by the GZIP operation.</td></tr>
<td>The string to be compressed by the GZIP operation.</td></tr>
<tr><th><var>FixedCode</var></th>
<tr><th><var>FixedCode</var></th>
<td><var>Boolean</var> value ([[under construction]]).</td></tr>
<td><var>FixedCode</var> is an optional, [[Notation conventions for methods#Named parameters|name required]], parameter that is a <var>[[Boolean_enumeration#Using_Boolean_enumerations|Boolean]]</var> value that specifies whether the compression uses fixed codes or is dynamic, based on the contents of the input <var class="term">string</var>.
<ul>
<li>With fixed code compression (<code>fixedCode=true</code>), the tables used for compression (defined as part of RFC 1951) are somewhat optimized for ASCII character data, but they slightly decrease the amount of CPU required to perform compression. Also, since the codes are already defined as part of the specification, they are not included in the compressed data.
<li>With dynamic compression (<code>fixedCode=false</code>), the compression code tables are generated based on the input data. Dynamic tables typically provide somewhat better compression on most types of data. There is a very slight CPU overhead in computing the frequencies of byte values in the input data. Also, since the code tables are dynamic, they are included as part of the compressed data. This will increase the size of the compressed longstring, but these tables are small, since they are also stored in a compressed form.
</ul>
The default value for this argument is <var>False</var> (use dynamic compression).</td></tr>
 
<tr><th><var>LazyMatch</var></th>
<tr><th><var>LazyMatch</var></th>
<td><var>Boolean</var> value ([[under construction]])</td></tr>
<td><var>LazyMatch</var> is an optional, name required, parameter that is a <var>Boolean</var> value that specifies whether to use "lazy match" compression, as specified in RFC 1951.
The default value for this argument is <var>False</var> (do not use "lazy match" compression).</td></tr>
 
<tr><th><var>MaxChain</var></th>
<tr><th><var>MaxChain</var></th>
<td>number ([[under construction]])</td></tr>
<td><var>MaxChain</var> is an optional, name required, parameter that is a numeric value that specifies the maximum hash chain length, as explained in RFC 1951.
The default value for this argument is 0. If specified, it must be between 0 and 99, inclusive.</td></tr>
 
<tr><th><var>Filename</var></th>
<tr><th><var>Filename</var></th>
<td>string ([[under construction]])</td></tr>
<td><var>Filename</var> is an optional, name required, parameter that is a string to be stored as the internal name of the compressed string. Decompression programs will use this name for the output file when the string is un-zipped. The maximum length of the file name is 32 bytes. </td></tr>
 
<tr><th><var>LastModified</var></th>
<tr><th><var>LastModified</var></th>
<td>The date/time stamp to be stored as a component of <var class="term">%outString</var>, expressed as the number of milliseconds since 12:00 AM, Jan 1, 1900. The default is the current date and time (that is, <var>[[CurrentTimeMilliseconds (System function)|%(System):CurrentTimeMilliseconds]]</var>).
<td>The date/time stamp to be stored as a component of <var class="term">%outString</var>, expressed as the number of milliseconds since 12:00 AM, Jan 1, 1900. The default is the current date and time (that is, <var>[[CurrentTimeMilliseconds (System function)|%(System):CurrentTimeMilliseconds]]</var>).
Line 25: Line 41:
==Usage notes==
==Usage notes==
<ul>
<ul>
<li>The inverse of <var>Gzip</var> is <var>[[Gunzip (String function)|Gunzip]]</var>.
<li>The <var>[[NCMPBUF parameter|NCMPBUF]]</var> parameter must be set by User 0 before <var>Gzip</var> can be used. If <var>Gzip</var> is called and the <var>NCMPBUF</var> value is 0, the request is cancelled.  
</ul>
</ul>


==Examples==
==See also==
==See also==
Related methods:
<ul>
<ul>
<li>Gunzip (String function)
<li>The inverse of <var>Gzip</var> is <var>[[Gunzip (String function)|Gunzip]]</var>.
<li>Deflate (String function)
<li>Other related methods:
<ul>
<li><var>[[GunzipDatetimeNS (String function)|GunzipDatetimeNS]]</var>
<li><var>[[GunzipFilename (String function)|GunzipFilename]]</var>
<li><var>[[Zip (String function)|Zip]]</var>
<li><var>[[Deflate (String function)|Deflate]]</var>
<li><var>[[Inflate (String function)|Inflate]]</var>
</ul>
</ul>
</ul>


{{Template:String:Gzip footer}}
{{Template:String:Gzip footer}}

Latest revision as of 21:19, 3 September 2015

Compress a longstring with GZIP (String class)

[Introduced in Sirius Mods 7.4]

This function compresses a longstring using the "deflate" algorithm, which is described completely in RFC 1951. The GZIP format is described in RFC 1952. It is very effective with HTML and XML data.

Syntax

%outString = string:Gzip[( [FixedCode= boolean], [LazyMatch= boolean], - [MaxChain= number], [Filename= string], - [LastModified= number])]

Syntax terms

%outString The result of the GZIP operation, compressing the method object string.
string The string to be compressed by the GZIP operation.
FixedCode FixedCode is an optional, name required, parameter that is a Boolean value that specifies whether the compression uses fixed codes or is dynamic, based on the contents of the input string.
  • With fixed code compression (fixedCode=true), the tables used for compression (defined as part of RFC 1951) are somewhat optimized for ASCII character data, but they slightly decrease the amount of CPU required to perform compression. Also, since the codes are already defined as part of the specification, they are not included in the compressed data.
  • With dynamic compression (fixedCode=false), the compression code tables are generated based on the input data. Dynamic tables typically provide somewhat better compression on most types of data. There is a very slight CPU overhead in computing the frequencies of byte values in the input data. Also, since the code tables are dynamic, they are included as part of the compressed data. This will increase the size of the compressed longstring, but these tables are small, since they are also stored in a compressed form.
The default value for this argument is False (use dynamic compression).
LazyMatch LazyMatch is an optional, name required, parameter that is a Boolean value that specifies whether to use "lazy match" compression, as specified in RFC 1951. The default value for this argument is False (do not use "lazy match" compression).
MaxChain MaxChain is an optional, name required, parameter that is a numeric value that specifies the maximum hash chain length, as explained in RFC 1951. The default value for this argument is 0. If specified, it must be between 0 and 99, inclusive.
Filename Filename is an optional, name required, parameter that is a string to be stored as the internal name of the compressed string. Decompression programs will use this name for the output file when the string is un-zipped. The maximum length of the file name is 32 bytes.
LastModified The date/time stamp to be stored as a component of %outString, expressed as the number of milliseconds since 12:00 AM, Jan 1, 1900. The default is the current date and time (that is, %(System):CurrentTimeMilliseconds).

After Gzip stores a value into %outString, the LastModified date/time stamp can be obtained with the GunzipDatetimeNS function, but note that its output is in seconds, not milliseconds.

Usage notes

  • The NCMPBUF parameter must be set by User 0 before Gzip can be used. If Gzip is called and the NCMPBUF value is 0, the request is cancelled.

See also