ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
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...
 
 __construct ($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 180 of file JSMin_lib.php.

Constructor & Destructor Documentation

◆ __construct()

JSMin::__construct (   $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.

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

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 423 of file JSMin_lib.php.

References $action, JSMIN_ACT_BUF, JSMIN_ACT_FULL, JSMIN_ACT_IMM, and ORD_NL.

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

◆ 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 247 of file JSMin_lib.php.

References $c, EOF, and ORD_space.

248  {
249 
250  // Get next input character and advance position in file
251 
252  if ($this->isString) {
253  if ($this->inPos < $this->inLength) {
254  $c = $this->in[$this->inPos];
255  ++$this->inPos;
256  } else {
257  return EOF;
258  }
259  } else {
260  $c = $this->in->fgetc();
261  }
262 
263  // Test for non-problematic characters
264 
265  if ($c === "\n" || $c === EOF || ord($c) >= ORD_space) {
266  return $c;
267  }
268 
269  // else
270  // Make linefeeds into newlines
271 
272  if ($c === "\r") {
273  return "\n";
274  }
275 
276  // else
277  // Consider space
278 
279  return ' ';
280  }
ORD_space
const ORD_space
Definition: JSMin_lib.php:100
$c
$c
Definition: inc.setup_header.php:183
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 220 of file JSMin_lib.php.

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

Referenced by minify().

221  {
222 
223  // Get ASCII value of character for C-like comparisons
224 
225  $a = ord($c);
226 
227  // Compare using defined character ordinals, or between PHP strings
228  // Note : === is micro-faster than == when types are known to be the same
229 
230  return
231  ($a >= ORD_a && $a <= ORD_z) ||
232  ($a >= ORD_0 && $a <= ORD_9) ||
233  ($a >= ORD_cA && $a <= ORD_cZ) ||
234  $c === '_' || $c === '$' || $c === '\\' || $a > 126
235  ;
236  }
ORD_z
const ORD_z
Definition: JSMin_lib.php:104
ORD_cA
const ORD_cA
Definition: JSMin_lib.php:101
$c
$c
Definition: inc.setup_header.php:183
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_File()

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

Definition at line 691 of file JSMin_lib.php.

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

◆ JSMin_String()

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

Definition at line 744 of file JSMin_lib.php.

745  {
746  $this->in = $inString;
747  $this->out = '';
748  $this->inLength = strlen($inString);
749  $this->inPos = 0;
750  $this->isString = true;
751 
752  if ($comments !== null) {
753  foreach ($comments as $comm) {
754  $this->out .= '// ' . str_replace("\n", " ", $comm) . "\n";
755  }
756  }
757  }

◆ 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 569 of file JSMin_lib.php.

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

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

References $c, EOF, and ORD_NL.

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

References $c, and EOF.

291  {
292  if ($this->isString) {
293  if ($this->inPos < $this->inLength) {
294  $c = $this->in[$this->inPos];
295  } else {
296  return EOF;
297  }
298  } else {
299  // Get next input character
300 
301  $c = $this->in->fgetc();
302 
303  // Regress position in file
304 
305  $this->in->fseek(-1, SEEK_CUR);
306 
307  // Return character obtained
308  }
309 
310  return $c;
311  }
$c
$c
Definition: inc.setup_header.php:183
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 317 of file JSMin_lib.php.

References $c.

318  {
319  if ($this->isString) {
320  $this->out .= $c;
321  } else {
322  $this->out->fwrite($c);
323  }
324  }
$c
$c
Definition: inc.setup_header.php:183

Field Documentation

◆ $in

JSMin::$in

Definition at line 188 of file JSMin_lib.php.

◆ $inLength

JSMin::$inLength = 0

variables used for string-based parsing

Definition at line 210 of file JSMin_lib.php.

◆ $inPos

JSMin::$inPos = 0

Definition at line 211 of file JSMin_lib.php.

◆ $isString

JSMin::$isString = false

Definition at line 212 of file JSMin_lib.php.

◆ $out

JSMin::$out

Definition at line 195 of file JSMin_lib.php.

◆ $theA

JSMin::$theA

Definition at line 201 of file JSMin_lib.php.

◆ $theB

JSMin::$theB

Definition at line 207 of file JSMin_lib.php.

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