ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
Public Member Functions | Data Fields
JSMin Class Reference

Main JSMin application class. More...

+ Collaboration diagram for JSMin:

Public Member Functions

 isAlphaNum ($c)
 Indicates whether a character is alphanumeric or _, $, \ or non-ASCII. More...
 
 get ()
 Get the next character from the input stream. More...
 
 peek ()
 Get the next character from the input stream, without gettng it. More...
 
 put ($c)
 Adds a char to the output steram / string. More...
 
 next ()
 Get the next character from the input stream, excluding comments. More...
 
 action ($action)
 Do something ! More...
 
 minify ()
 Run the JSMin application : minify some JS code. More...
 
 JSMin ($inFileName='-', $outFileName='-', $comments=NULL)
 Prepare a new JSMin application. More...
 
 JSMin_File ($inFileName='-', $outFileName='-', $comments=NULL)
 
 JSMin_String ($inString, $comments=NULL)
 

Data Fields

 $in
 
 $out
 
 $theA
 
 $theB
 
 $inLength = 0
 variables used for string-based parsing More...
 
 $inPos = 0
 
 $isString = false
 

Detailed Description

Main JSMin application class.

Example of use :

$jsMin = new JSMin(...input..., ...output...); $jsMin->minify();

Do not specify input and/or output (or default to '-') to use stdin and/or stdout.

Definition at line 175 of file JSMin_lib.php.

Member Function Documentation

◆ action()

JSMin::action (   $action)

Do something !

The action to perform is determined by the argument :

JSMin::ACT_FULL : Output A. Copy B to A. Get the next B. JSMin::ACT_BUF : Copy B to A. Get the next B. (Delete A). JSMin::ACT_IMM : Get the next B. (Delete B).

A string is treated as a single character. Also, regular expressions are recognized if preceded by '(', ',' or '='.

Parameters
int$actionThe action to perform : one of the JSMin::ACT_* constants.

Definition at line 418 of file JSMin_lib.php.

References JSMIN_ACT_BUF, JSMIN_ACT_FULL, JSMIN_ACT_IMM, and ORD_NL.

418  {
419 
420  // Choice of possible actions
421  // Note the frequent fallthroughs : the actions are decrementally "long"
422 
423  switch ($action) {
424 
425  case JSMIN_ACT_FULL :
426 
427  // Write A to output, then fall through
428 
429  $this->put($this->theA);
430 
431  case JSMIN_ACT_BUF : // N.B. possible fallthrough from above
432 
433  // Copy B to A
434 
435  $tmpA = $this->theA = $this->theB;
436 
437  // Treating a string as a single char : outputting it whole
438  // Note that the string-opening char (" or ') is memorized in B
439 
440  if ($tmpA == '\'' || $tmpA == '"') {
441 
442  while (true) {
443 
444  // Output string contents
445 
446  $this->put($tmpA);
447 
448  // Get next character, watching out for termination of the current string,
449  // new line & co (then the string is not terminated !), or a backslash
450  // (upon which the following char is directly output to serve the escape mechanism)
451 
452  $tmpA = $this->theA = $this->get();
453 
454  if ($tmpA == $this->theB) {
455 
456  // String terminated
457 
458  break; // from while(true)
459  }
460 
461  // else
462 
463  if (ord($tmpA) <= ORD_NL) {
464 
465  // Whoopsie
466 
467  //throw new UnterminatedStringLiteralJSMinException();
468  trigger_error('UnterminatedStringLiteral', E_USER_ERROR);
469  }
470 
471  // else
472 
473  if ($tmpA == '\\') {
474 
475  // Escape next char immediately
476 
477  $this->put($tmpA);
478  $tmpA = $this->theA = $this->get();
479  }
480  }
481  }
482 
483  case JSMIN_ACT_IMM : // N.B. possible fallthrough from above
484 
485  // Get the next B
486 
487  $this->theB = $this->next();
488 
489  // Special case of recognising regular expressions (beginning with /) that are
490  // preceded by '(', ',' or '='
491 
492  $tmpA = $this->theA;
493 
494  if ($this->theB == '/' && ($tmpA == '(' || $tmpA == ',' || $tmpA == '=')) {
495 
496  // Output the two successive chars
497 
498  $this->put($tmpA);
499  $this->put($this->theB);
500 
501  // Look for the end of the RE literal, watching out for escaped chars or a control /
502  // end of line char (the RE literal then being unterminated !)
503 
504  while (true) {
505 
506  $tmpA = $this->theA = $this->get();
507 
508  if ($tmpA == '/') {
509 
510  // RE literal terminated
511 
512  break; // from while(true)
513  }
514 
515  // else
516 
517  if ($tmpA == '\\') {
518 
519  // Escape next char immediately
520 
521  $this->put($tmpA);
522  $tmpA = $this->theA = $this->get();
523  }
524  else if (ord($tmpA) <= ORD_NL) {
525 
526  // Whoopsie
527 
528  //throw new UnterminatedRegExpLiteralJSMinException();
529  trigger_error('UnterminatedRegExpLiteral', E_USER_ERROR);
530  }
531 
532  // Output RE characters
533 
534  $this->put($tmpA);
535  }
536 
537  // Move forward after the RE literal
538 
539  $this->theB = $this->next();
540  }
541 
542  break;
543  default :
544  //throw new JSMinException('Expected a JSMin::ACT_* constant in action().');
545  trigger_error('Expected a JSMin::ACT_* constant in action()', E_USER_ERROR);
546  }
547  }
JSMIN_ACT_BUF
const JSMIN_ACT_BUF
Constant describing an action() : Copy B to A.
Definition: JSMin_lib.php:156
JSMin\next
next()
Get the next character from the input stream, excluding comments.
Definition: JSMin_lib.php:331
ORD_NL
const ORD_NL
Some ASCII character ordinals.
Definition: JSMin_lib.php:99
JSMIN_ACT_IMM
const JSMIN_ACT_IMM
Constant describing an action() : Get the next B.
Definition: JSMin_lib.php:162
JSMIN_ACT_FULL
const JSMIN_ACT_FULL
Constant describing an action() : Output A.
Definition: JSMin_lib.php:150
JSMin\put
put($c)
Adds a char to the output steram / string.
Definition: JSMin_lib.php:312

◆ get()

JSMin::get ( )

Get the next character from the input stream.

If said character is a control character, translate it to a space or linefeed.

Returns
string The next character from the specified input stream.
See also
$in
peek()

Definition at line 240 of file JSMin_lib.php.

References EOF, and ORD_space.

240  {
241 
242  // Get next input character and advance position in file
243 
244  if ($this->isString) {
245  if ($this->inPos < $this->inLength) {
246  $c = $this->in[$this->inPos];
247  ++$this->inPos;
248  }
249  else {
250  return EOF;
251  }
252  }
253  else
254  $c = $this->in->fgetc();
255 
256  // Test for non-problematic characters
257 
258  if ($c === "\n" || $c === EOF || ord($c) >= ORD_space) {
259  return $c;
260  }
261 
262  // else
263  // Make linefeeds into newlines
264 
265  if ($c === "\r") {
266  return "\n";
267  }
268 
269  // else
270  // Consider space
271 
272  return ' ';
273  }
ORD_space
const ORD_space
Definition: JSMin_lib.php:100
EOF
const EOF
How fgetc() reports an End Of File.
Definition: JSMin_lib.php:92

◆ isAlphaNum()

JSMin::isAlphaNum (   $c)

Indicates whether a character is alphanumeric or _, $, \ or non-ASCII.

Parameters
string$cThe single character to test.
Returns
boolean Whether the char is a letter, digit, underscore, dollar, backslash, or non-ASCII.

Definition at line 214 of file JSMin_lib.php.

References ORD_0, ORD_9, ORD_a, ORD_cA, ORD_cZ, and ORD_z.

Referenced by minify().

214  {
215 
216  // Get ASCII value of character for C-like comparisons
217 
218  $a = ord($c);
219 
220  // Compare using defined character ordinals, or between PHP strings
221  // Note : === is micro-faster than == when types are known to be the same
222 
223  return
224  ($a >= ORD_a && $a <= ORD_z) ||
225  ($a >= ORD_0 && $a <= ORD_9) ||
226  ($a >= ORD_cA && $a <= ORD_cZ) ||
227  $c === '_' || $c === '$' || $c === '\\' || $a > 126
228  ;
229  }
ORD_z
const ORD_z
Definition: JSMin_lib.php:104
ORD_cA
const ORD_cA
Definition: JSMin_lib.php:101
ORD_a
const ORD_a
Definition: JSMin_lib.php:103
ORD_cZ
const ORD_cZ
Definition: JSMin_lib.php:102
ORD_0
const ORD_0
Definition: JSMin_lib.php:105
ORD_9
const ORD_9
Definition: JSMin_lib.php:106
+ Here is the caller graph for this function:

◆ JSMin()

JSMin::JSMin (   $inFileName = '-',
  $outFileName = '-',
  $comments = NULL 
)

Prepare a new JSMin application.

The next step is to minify() the input into the output.

Parameters
string$inFileNameThe pathname of the input (unminified JS) file. STDIN if '-' or absent.
string$outFileNameThe pathname of the output (minified JS) file. STDOUT if '-' or absent. If outFileName === FALSE, we assume that inFileName is in fact the string to be minified!!!
array$commentsOptional lines to present as comments at the beginning of the output.

Definition at line 682 of file JSMin_lib.php.

682  {
683  if ($outFileName === FALSE) {
684  $this->JSMin_String($inFileName, $comments);
685  }
686  else {
687  $this->JSMin_File($inFileName, $outFileName, $comments);
688  }
689  }
JSMin\JSMin_File
JSMin_File($inFileName='-', $outFileName='-', $comments=NULL)
Definition: JSMin_lib.php:691
JSMin\JSMin_String
JSMin_String($inString, $comments=NULL)
Definition: JSMin_lib.php:740

◆ JSMin_File()

JSMin::JSMin_File (   $inFileName = '-',
  $outFileName = '-',
  $comments = NULL 
)

Definition at line 691 of file JSMin_lib.php.

691  {
692 
693  // Recuperate input and output streams.
694  // Use STDIN and STDOUT by default, if they are defined (CLI mode) and no file names are provided
695 
696  if ($inFileName == '-') $inFileName = 'php://stdin';
697  if ($outFileName == '-') $outFileName = 'php://stdout';
698 
699  /*try {
700 
701  $this->in = new SplFileObject($inFileName, 'rb', TRUE);
702  }
703  catch (Exception $e) {
704 
705  throw new FileOpenFailedJSMinException(
706  'Failed to open "'.$inFileName.'" for reading only.'
707  );
708  }
709 
710  try {
711 
712  $this->out = new SplFileObject($outFileName, 'wb', TRUE);
713  }
714  catch (Exception $e) {
715 
716  throw new FileOpenFailedJSMinException(
717  'Failed to open "'.$outFileName.'" for writing only.'
718  );
719  }
720  */
721  $this->in = fopen($inFileName, 'rb');
722  if (!$this->in) {
723  trigger_error('Failed to open "'.$inFileName, E_USER_ERROR);
724  }
725  $this->out = fopen($outFileName, 'wb');
726  if (!$this->out) {
727  trigger_error('Failed to open "'.$outFileName, E_USER_ERROR);
728  }
729 
730  // Present possible initial comments
731 
732  if ($comments !== NULL) {
733  foreach ($comments as $comm) {
734  $this->out->fwrite('// '.str_replace("\n", " ", $comm)."\n");
735  }
736  }
737 
738  }

◆ JSMin_String()

JSMin::JSMin_String (   $inString,
  $comments = NULL 
)

Definition at line 740 of file JSMin_lib.php.

740  {
741  $this->in = $inString;
742  $this->out = '';
743  $this->inLength = strlen($inString);
744  $this->inPos = 0;
745  $this->isString = true;
746 
747  if ($comments !== NULL) {
748  foreach ($comments as $comm) {
749  $this->out .= '// '.str_replace("\n", " ", $comm)."\n";
750  }
751  }
752  }

◆ minify()

JSMin::minify ( )

Run the JSMin application : minify some JS code.

The code is read from the input stream, and its minified version is written to the output one. In case input is a string, minified vesrions is also returned by this function as string. That is : characters which are insignificant to JavaScript are removed, as well as comments ; tabs are replaced with spaces ; carriage returns are replaced with linefeeds, and finally most spaces and linefeeds are deleted.

Note : name was changed from jsmin() because PHP identifiers are case-insensitive, and it is already the name of this class.

See also
JSMin()
Returns
null | string

Definition at line 564 of file JSMin_lib.php.

References $out, EOF, isAlphaNum(), JSMIN_ACT_BUF, JSMIN_ACT_FULL, and JSMIN_ACT_IMM.

564  {
565 
566  // Initialize A and run the first (minimal) action
567 
568  $this->theA = "\n";
569  $this->action(JSMIN_ACT_IMM);
570 
571  // Proceed all the way to the end of the input file
572 
573  while ($this->theA !== EOF) {
574 
575  switch ($this->theA) {
576 
577  case ' ' :
578 
579  if (JSMin::isAlphaNum($this->theB)) {
580  $this->action(JSMIN_ACT_FULL);
581  }
582  else {
583  $this->action(JSMIN_ACT_BUF);
584  }
585 
586  break;
587  case "\n" :
588 
589  switch ($this->theB) {
590 
591  case '{' : case '[' : case '(' :
592  case '+' : case '-' :
593 
594  $this->action(JSMIN_ACT_FULL);
595 
596  break;
597  case ' ' :
598 
599  $this->action(JSMIN_ACT_IMM);
600 
601  break;
602  default :
603 
604  if (JSMin::isAlphaNum($this->theB)) {
605  $this->action(JSMIN_ACT_FULL);
606  }
607  else {
608  $this->action(JSMIN_ACT_BUF);
609  }
610 
611  break;
612  }
613 
614  break;
615  default :
616 
617  switch ($this->theB) {
618 
619  case ' ' :
620 
621  if (JSMin::isAlphaNum($this->theA)) {
622 
623  $this->action(JSMIN_ACT_FULL);
624  break;
625  }
626 
627  // else
628 
629  $this->action(JSMIN_ACT_IMM);
630 
631  break;
632  case "\n" :
633 
634  switch ($this->theA) {
635 
636  case '}' : case ']' : case ')' : case '+' :
637  case '-' : case '"' : case '\'' :
638 
639  $this->action(JSMIN_ACT_FULL);
640 
641  break;
642  default :
643 
644  if (JSMin::isAlphaNum($this->theA)) {
645  $this->action(JSMIN_ACT_FULL);
646  }
647  else {
648  $this->action(JSMIN_ACT_IMM);
649  }
650 
651  break;
652  }
653 
654  break;
655  default :
656 
657  $this->action(JSMIN_ACT_FULL);
658 
659  break;
660  }
661 
662  break;
663  }
664  }
665 
666  if ($this->isString) {
667  return $this->out;
668 
669  }
670  }
JSMIN_ACT_BUF
const JSMIN_ACT_BUF
Constant describing an action() : Copy B to A.
Definition: JSMin_lib.php:156
JSMin\isAlphaNum
isAlphaNum($c)
Indicates whether a character is alphanumeric or _, $, \ or non-ASCII.
Definition: JSMin_lib.php:214
JSMIN_ACT_IMM
const JSMIN_ACT_IMM
Constant describing an action() : Get the next B.
Definition: JSMin_lib.php:162
JSMIN_ACT_FULL
const JSMIN_ACT_FULL
Constant describing an action() : Output A.
Definition: JSMin_lib.php:150
JSMin\action
action($action)
Do something !
Definition: JSMin_lib.php:418
EOF
const EOF
How fgetc() reports an End Of File.
Definition: JSMin_lib.php:92
+ Here is the call graph for this function:

◆ next()

JSMin::next ( )

Get the next character from the input stream, excluding comments.

peek() is used to see if a '/' is followed by a '*' or '/'. Multiline comments are actually returned as a single space.

Returns
string The next character from the specified input stream, skipping comments.
See also
$in

Definition at line 331 of file JSMin_lib.php.

References EOF, and ORD_NL.

331  {
332 
333  // Get next char from input, translated if necessary
334 
335  $c = $this->get();
336 
337  // Check comment possibility
338 
339  if ($c == '/') {
340 
341  // Look ahead : a comment is two slashes or slashes followed by asterisk (to be closed)
342 
343  switch ($this->peek()) {
344 
345  case '/' :
346 
347  // Comment is up to the end of the line
348  // TOTEST : simple $this->in->fgets()
349 
350  while (true) {
351 
352  $c = $this->get();
353 
354  if (ord($c) <= ORD_NL) {
355  return $c;
356  }
357  }
358 
359  case '*' :
360 
361  // Comment is up to comment close.
362  // Might not be terminated, if we hit the end of file.
363 
364  while (true) {
365 
366  // N.B. not using switch() because of having to test EOF with ===
367 
368  $c = $this->get();
369 
370  if ($c == '*') {
371 
372  // Comment termination if the char ahead is a slash
373 
374  if ($this->peek() == '/') {
375 
376  // Advance again and make into a single space
377 
378  $this->get();
379  return ' ';
380  }
381  }
382  else if ($c === EOF) {
383 
384  // Whoopsie
385 
386  //throw new UnterminatedCommentJSMinException();
387  trigger_error('UnterminatedComment', E_USER_ERROR);
388  }
389  }
390 
391  default :
392 
393  // Not a comment after all
394 
395  return $c;
396  }
397  }
398 
399  // No risk of a comment
400 
401  return $c;
402  }
ORD_NL
const ORD_NL
Some ASCII character ordinals.
Definition: JSMin_lib.php:99
JSMin\peek
peek()
Get the next character from the input stream, without gettng it.
Definition: JSMin_lib.php:283
EOF
const EOF
How fgetc() reports an End Of File.
Definition: JSMin_lib.php:92

◆ peek()

JSMin::peek ( )

Get the next character from the input stream, without gettng it.

Returns
string The next character from the specified input stream, without advancing the position in the underlying file.
See also
$in
get()

Definition at line 283 of file JSMin_lib.php.

References EOF.

283  {
284 
285  if ($this->isString) {
286  if ($this->inPos < $this->inLength) {
287  $c = $this->in[$this->inPos];
288  }
289  else {
290  return EOF;
291  }
292  }
293  else {
294  // Get next input character
295 
296  $c = $this->in->fgetc();
297 
298  // Regress position in file
299 
300  $this->in->fseek(-1, SEEK_CUR);
301 
302  // Return character obtained
303  }
304 
305  return $c;
306  }
EOF
const EOF
How fgetc() reports an End Of File.
Definition: JSMin_lib.php:92

◆ put()

JSMin::put (   $c)

Adds a char to the output steram / string.

See also
$out

Definition at line 312 of file JSMin_lib.php.

313  {
314  if ($this->isString) {
315  $this->out .= $c;
316  }
317  else {
318  $this->out->fwrite($c);
319  }
320  }

Field Documentation

◆ $in

JSMin::$in

Definition at line 182 of file JSMin_lib.php.

◆ $inLength

JSMin::$inLength = 0

variables used for string-based parsing

Definition at line 204 of file JSMin_lib.php.

◆ $inPos

JSMin::$inPos = 0

Definition at line 205 of file JSMin_lib.php.

◆ $isString

JSMin::$isString = false

Definition at line 206 of file JSMin_lib.php.

◆ $out

JSMin::$out

Definition at line 189 of file JSMin_lib.php.

◆ $theA

JSMin::$theA

Definition at line 195 of file JSMin_lib.php.

◆ $theB

JSMin::$theB

Definition at line 201 of file JSMin_lib.php.

The documentation for this class was generated from the following file: