.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "CSS::Minifier::XS 3pm" .TH CSS::Minifier::XS 3pm "2015-06-01" "perl v5.24.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" CSS::Minifier::XS \- XS based CSS minifier .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& use CSS::Minifier::XS qw(minify); \& $minified = minify($css); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\f(CW\*(C`CSS::Minifier::XS\*(C'\fR is a \s-1CSS \s0\*(L"minifier\*(R"; its designed to remove un-necessary whitespace and comments from \s-1CSS\s0 files, while also \fBnot\fR breaking the \s-1CSS.\s0 .PP \&\f(CW\*(C`CSS::Minifier::XS\*(C'\fR is similar in function to \f(CW\*(C`CSS::Minifier\*(C'\fR, but is substantially faster as its written in \s-1XS\s0 and not just pure Perl. .SH "METHODS" .IX Header "METHODS" .IP "minify($css)" 4 .IX Item "minify($css)" Minifies the given \f(CW$css\fR, returning the minified \s-1CSS\s0 back to the caller. .SH "HOW IT WORKS" .IX Header "HOW IT WORKS" \&\f(CW\*(C`CSS::Minifier::XS\*(C'\fR minifies the \s-1CSS\s0 by removing un-necessary whitespace from \&\s-1CSS\s0 documents. Comment blocks are also removed, \fIexcept\fR when (a) they contain the word \*(L"copyright\*(R" in them, or (b) they're needed to implement the \&\*(L"Mac/IE Comment Hack\*(R". .PP Internally, the minification is done by taking multiple passes through the \s-1CSS\s0 document: .SS "Pass 1: Tokenize" .IX Subsection "Pass 1: Tokenize" First, we go through and parse the \s-1CSS\s0 document into a series of tokens internally. The tokenizing process \fBdoes not\fR check to make sure that you've got syntactically valid \s-1CSS,\s0 it just breaks up the text into a stream of tokens suitable for processing by the subsequent stages. .SS "Pass 2: Collapse" .IX Subsection "Pass 2: Collapse" We then march through the token list and collapse certain tokens down to their smallest possible representation. \fIIf\fR they're still included in the final results we only want to include them at their shortest. .IP "Whitespace" 4 .IX Item "Whitespace" Runs of multiple whitespace characters are reduced down to a single whitespace character. If the whitespace contains any \*(L"end of line\*(R" (\s-1EOL\s0) characters, then the end result is the \fIfirst\fR \s-1EOL\s0 character encountered. Otherwise, the result is the first whitespace character in the run. .IP "Comments" 4 .IX Item "Comments" Comments implementing the \*(L"Mac/IE Comment Hack\*(R" are collapsed down to the smallest possible comment that would still implement the hack (\*(L"/*\e*/\*(R" to start the hack, and \*(L"/**/\*(R" to end it). .IP "Zero Units" 4 .IX Item "Zero Units" Zero Units (e.g. \*(L"0px\*(R") are reduced down to just \*(L"0\*(R", as the \s-1CSS\s0 specification indicates that the unit is not required when its a zero value. .SS "Pass 3: Pruning" .IX Subsection "Pass 3: Pruning" We then go back through the token list and prune and remove un-necessary tokens. .IP "Whitespace" 4 .IX Item "Whitespace" Wherever possible, whitespace is removed; before+after comment blocks, and before+after various symbols/sigils. .IP "Comments" 4 .IX Item "Comments" Comments that either (a) are needed to implement the \*(L"Mac/IE Comment Hack\*(R", or that (b) contain the word \*(L"copyright\*(R" in them are preserved. \fBAll\fR other comments are removed. .IP "Symbols/Sigils" 4 .IX Item "Symbols/Sigils" Semi-colons that are immediately followed by a closing brace (e.g. \*(L";}\*(R") are removed; semi-colons are needed to separate multiple declarations, but aren't required at the end of a group. .IP "Everything else" 4 .IX Item "Everything else" We keep everything else; identifiers, quoted literal strings, symbols/sigils, etc. .SS "Pass 4: Re-assembly" .IX Subsection "Pass 4: Re-assembly" Lastly, we go back through the token list and re-assemble it all back into a single \s-1CSS\s0 string, which is then returned back to the caller. .SH "AUTHOR" .IX Header "AUTHOR" Graham TerMarsch (cpan@howlingfrog.com) .SH "REPORTING BUGS" .IX Header "REPORTING BUGS" Please report bugs via \s-1RT \&\s0(), and be sure to include the \s-1CSS\s0 that you're having troubles minifying. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (C) 2007\-, Graham TerMarsch. All Rights Reserved. .PP This is free software; you can redistribute it and/or modify it under the same license as Perl itself. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\f(CW\*(C`CSS::Minifier\*(C'\fR.