├── .gitignore ├── codecov.yml ├── tests ├── bootstrap.php └── CalculateTest.php ├── CHANGELOG.md ├── .travis.yml ├── composer.json ├── phpunit.xml ├── src ├── Expressions │ ├── Number.php │ ├── Modulo.php │ ├── Addition.php │ ├── Division.php │ ├── OperatorOr.php │ ├── ComparisonEQ.php │ ├── ComparisonGT.php │ ├── ComparisonGTE.php │ ├── ComparisonLT.php │ ├── ComparisonLTE.php │ ├── ComparisonNE.php │ ├── Subtraction.php │ ├── Multiplication.php │ ├── OperatorAnd.php │ ├── Binary.php │ ├── Variable.php │ ├── Parenthesis.php │ ├── Operator.php │ └── Ternary.php ├── Stack.php ├── Expression.php └── Math.php ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | composer.phar 2 | /vendor/ 3 | composer.lock 4 | -------------------------------------------------------------------------------- /codecov.yml: -------------------------------------------------------------------------------- 1 | comment: 2 | layout: header, changes, diff 3 | coverage: {} 4 | -------------------------------------------------------------------------------- /tests/bootstrap.php: -------------------------------------------------------------------------------- 1 | =5.4.0" 20 | }, 21 | "require-dev": { 22 | "phpunit/phpunit": "~5.2 || ~4.8" 23 | }, 24 | "autoload": { 25 | "psr-4": { 26 | "SimpleMath\\": "src" 27 | } 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /phpunit.xml: -------------------------------------------------------------------------------- 1 | 2 | 12 | 13 | 14 | 15 | 16 | 17 | ./tests 18 | 19 | 20 | 21 | 22 | src/ 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /src/Expressions/Number.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | This file is part of SimpleMath. 6 | 7 | This program is free software; you can redistribute it and/or modify 8 | it under the terms of the GNU General Public License as published by 9 | the Free Software Foundation; either version 2 of the License, or 10 | (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License along 18 | with this program; if not, write to the Free Software Foundation, Inc., 19 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 20 | */ 21 | namespace SimpleMath\Expressions; 22 | 23 | class Number extends \SimpleMath\Expression { 24 | 25 | public function operate(\SimpleMath\Stack $stack, $variables=array()) { 26 | return $this->value; 27 | } 28 | 29 | } 30 | -------------------------------------------------------------------------------- /src/Expressions/Modulo.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | This file is part of SimpleMath. 6 | 7 | This program is free software; you can redistribute it and/or modify 8 | it under the terms of the GNU General Public License as published by 9 | the Free Software Foundation; either version 2 of the License, or 10 | (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License along 18 | with this program; if not, write to the Free Software Foundation, Inc., 19 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 20 | */ 21 | namespace SimpleMath\Expressions; 22 | 23 | class Modulo extends Operator { 24 | 25 | protected $precidence = 5; 26 | 27 | protected function calculate($left, $right) 28 | { 29 | return $left % $right; 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /src/Expressions/Addition.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | This file is part of SimpleMath. 6 | 7 | This program is free software; you can redistribute it and/or modify 8 | it under the terms of the GNU General Public License as published by 9 | the Free Software Foundation; either version 2 of the License, or 10 | (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License along 18 | with this program; if not, write to the Free Software Foundation, Inc., 19 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 20 | */ 21 | namespace SimpleMath\Expressions; 22 | 23 | class Addition extends Operator { 24 | 25 | protected $precidence = 4; 26 | 27 | protected function calculate($left, $right) 28 | { 29 | return $left + $right; 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /src/Expressions/Division.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | This file is part of SimpleMath. 6 | 7 | This program is free software; you can redistribute it and/or modify 8 | it under the terms of the GNU General Public License as published by 9 | the Free Software Foundation; either version 2 of the License, or 10 | (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License along 18 | with this program; if not, write to the Free Software Foundation, Inc., 19 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 20 | */ 21 | namespace SimpleMath\Expressions; 22 | 23 | class Division extends Operator { 24 | 25 | protected $precidence = 5; 26 | 27 | protected function calculate($left, $right) 28 | { 29 | return $left / $right; 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /src/Expressions/OperatorOr.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | This file is part of SimpleMath. 6 | 7 | This program is free software; you can redistribute it and/or modify 8 | it under the terms of the GNU General Public License as published by 9 | the Free Software Foundation; either version 2 of the License, or 10 | (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License along 18 | with this program; if not, write to the Free Software Foundation, Inc., 19 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 20 | */ 21 | namespace SimpleMath\Expressions; 22 | 23 | class OperatorOr extends Binary { 24 | 25 | protected $precidence = 2; 26 | 27 | protected function calculate($left, $right) 28 | { 29 | return $left || $right; 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /src/Expressions/ComparisonEQ.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | This file is part of SimpleMath. 6 | 7 | This program is free software; you can redistribute it and/or modify 8 | it under the terms of the GNU General Public License as published by 9 | the Free Software Foundation; either version 2 of the License, or 10 | (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License along 18 | with this program; if not, write to the Free Software Foundation, Inc., 19 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 20 | */ 21 | namespace SimpleMath\Expressions; 22 | 23 | class ComparisonEQ extends Binary { 24 | 25 | protected $precidence = 3; 26 | 27 | protected function calculate($left, $right) 28 | { 29 | return $left == $right; 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /src/Expressions/ComparisonGT.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | This file is part of SimpleMath. 6 | 7 | This program is free software; you can redistribute it and/or modify 8 | it under the terms of the GNU General Public License as published by 9 | the Free Software Foundation; either version 2 of the License, or 10 | (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License along 18 | with this program; if not, write to the Free Software Foundation, Inc., 19 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 20 | */ 21 | namespace SimpleMath\Expressions; 22 | 23 | class ComparisonGT extends Binary { 24 | 25 | protected $precidence = 3; 26 | 27 | protected function calculate($left, $right) 28 | { 29 | return $left > $right; 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /src/Expressions/ComparisonGTE.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | This file is part of SimpleMath. 6 | 7 | This program is free software; you can redistribute it and/or modify 8 | it under the terms of the GNU General Public License as published by 9 | the Free Software Foundation; either version 2 of the License, or 10 | (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License along 18 | with this program; if not, write to the Free Software Foundation, Inc., 19 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 20 | */ 21 | namespace SimpleMath\Expressions; 22 | 23 | class ComparisonGTE extends Binary { 24 | 25 | protected $precidence = 3; 26 | 27 | protected function calculate($left, $right) 28 | { 29 | return $left >= $right; 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /src/Expressions/ComparisonLT.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | This file is part of SimpleMath. 6 | 7 | This program is free software; you can redistribute it and/or modify 8 | it under the terms of the GNU General Public License as published by 9 | the Free Software Foundation; either version 2 of the License, or 10 | (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License along 18 | with this program; if not, write to the Free Software Foundation, Inc., 19 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 20 | */ 21 | namespace SimpleMath\Expressions; 22 | 23 | class ComparisonLT extends Binary { 24 | 25 | protected $precidence = 3; 26 | 27 | protected function calculate($left, $right) 28 | { 29 | return $left < $right; 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /src/Expressions/ComparisonLTE.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | This file is part of SimpleMath. 6 | 7 | This program is free software; you can redistribute it and/or modify 8 | it under the terms of the GNU General Public License as published by 9 | the Free Software Foundation; either version 2 of the License, or 10 | (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License along 18 | with this program; if not, write to the Free Software Foundation, Inc., 19 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 20 | */ 21 | namespace SimpleMath\Expressions; 22 | 23 | class ComparisonLTE extends Binary { 24 | 25 | protected $precidence = 3; 26 | 27 | protected function calculate($left, $right) 28 | { 29 | return $left <= $right; 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /src/Expressions/ComparisonNE.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | This file is part of SimpleMath. 6 | 7 | This program is free software; you can redistribute it and/or modify 8 | it under the terms of the GNU General Public License as published by 9 | the Free Software Foundation; either version 2 of the License, or 10 | (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License along 18 | with this program; if not, write to the Free Software Foundation, Inc., 19 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 20 | */ 21 | namespace SimpleMath\Expressions; 22 | 23 | class ComparisonNE extends Binary { 24 | 25 | protected $precidence = 3; 26 | 27 | protected function calculate($left, $right) 28 | { 29 | return $left != $right; 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /src/Expressions/Subtraction.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | This file is part of SimpleMath. 6 | 7 | This program is free software; you can redistribute it and/or modify 8 | it under the terms of the GNU General Public License as published by 9 | the Free Software Foundation; either version 2 of the License, or 10 | (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License along 18 | with this program; if not, write to the Free Software Foundation, Inc., 19 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 20 | */ 21 | namespace SimpleMath\Expressions; 22 | 23 | class Subtraction extends Operator { 24 | 25 | protected $precidence = 4; 26 | 27 | protected function calculate($left, $right) 28 | { 29 | return $left - $right; 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /src/Expressions/Multiplication.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | This file is part of SimpleMath. 6 | 7 | This program is free software; you can redistribute it and/or modify 8 | it under the terms of the GNU General Public License as published by 9 | the Free Software Foundation; either version 2 of the License, or 10 | (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License along 18 | with this program; if not, write to the Free Software Foundation, Inc., 19 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 20 | */ 21 | namespace SimpleMath\Expressions; 22 | 23 | class Multiplication extends Operator { 24 | 25 | protected $precidence = 5; 26 | 27 | protected function calculate($left, $right) 28 | { 29 | return $right * $left; 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /src/Expressions/OperatorAnd.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | This file is part of SimpleMath. 6 | 7 | This program is free software; you can redistribute it and/or modify 8 | it under the terms of the GNU General Public License as published by 9 | the Free Software Foundation; either version 2 of the License, or 10 | (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License along 18 | with this program; if not, write to the Free Software Foundation, Inc., 19 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 20 | */ 21 | namespace SimpleMath\Expressions; 22 | 23 | class OperatorAnd extends Binary { 24 | 25 | protected $precidence = 2; 26 | 27 | protected function calculate($left, $right) 28 | { 29 | return $left && $right; 30 | } 31 | } 32 | 33 | -------------------------------------------------------------------------------- /src/Expressions/Binary.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | This file is part of SimpleMath. 6 | 7 | This program is free software; you can redistribute it and/or modify 8 | it under the terms of the GNU General Public License as published by 9 | the Free Software Foundation; either version 2 of the License, or 10 | (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License along 18 | with this program; if not, write to the Free Software Foundation, Inc., 19 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 20 | */ 21 | namespace SimpleMath\Expressions; 22 | 23 | abstract class Binary extends Operator { 24 | 25 | public function operate(\SimpleMath\Stack $stack, $variables=array()) 26 | { 27 | return parent::operate($stack, $variables) ? 1 : 0; 28 | } 29 | } 30 | 31 | 32 | -------------------------------------------------------------------------------- /src/Expressions/Variable.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | This file is part of SimpleMath. 6 | 7 | This program is free software; you can redistribute it and/or modify 8 | it under the terms of the GNU General Public License as published by 9 | the Free Software Foundation; either version 2 of the License, or 10 | (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License along 18 | with this program; if not, write to the Free Software Foundation, Inc., 19 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 20 | */ 21 | namespace SimpleMath\Expressions; 22 | 23 | class Variable extends \SimpleMath\Expression { 24 | 25 | public function operate(\SimpleMath\Stack $stack, $variables=array()) { 26 | return isset($variables[$this->value]) ? $variables[$this->value] : 0; 27 | } 28 | 29 | } 30 | 31 | -------------------------------------------------------------------------------- /src/Stack.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | This file is part of SimpleMath. 6 | 7 | This program is free software; you can redistribute it and/or modify 8 | it under the terms of the GNU General Public License as published by 9 | the Free Software Foundation; either version 2 of the License, or 10 | (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License along 18 | with this program; if not, write to the Free Software Foundation, Inc., 19 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 20 | */ 21 | namespace SimpleMath; 22 | 23 | class Stack { 24 | 25 | protected $data = array(); 26 | 27 | public function push($element) { 28 | $this->data[] = $element; 29 | } 30 | 31 | public function poke() { 32 | return end($this->data); 33 | } 34 | 35 | public function pop() { 36 | return array_pop($this->data); 37 | } 38 | 39 | } 40 | -------------------------------------------------------------------------------- /src/Expressions/Parenthesis.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | This file is part of SimpleMath. 6 | 7 | This program is free software; you can redistribute it and/or modify 8 | it under the terms of the GNU General Public License as published by 9 | the Free Software Foundation; either version 2 of the License, or 10 | (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License along 18 | with this program; if not, write to the Free Software Foundation, Inc., 19 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 20 | */ 21 | namespace SimpleMath\Expressions; 22 | 23 | class Parenthesis extends \SimpleMath\Expression { 24 | 25 | protected $precidence = 6; 26 | 27 | public function operate(\SimpleMath\Stack $stack, $variables=array()) { 28 | } 29 | 30 | public function isParenthesis() { 31 | return true; 32 | } 33 | 34 | public function isOpen() { 35 | return $this->value == '('; 36 | } 37 | 38 | } 39 | 40 | -------------------------------------------------------------------------------- /src/Expressions/Operator.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | This file is part of SimpleMath. 6 | 7 | This program is free software; you can redistribute it and/or modify 8 | it under the terms of the GNU General Public License as published by 9 | the Free Software Foundation; either version 2 of the License, or 10 | (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License along 18 | with this program; if not, write to the Free Software Foundation, Inc., 19 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 20 | */ 21 | namespace SimpleMath\Expressions; 22 | 23 | abstract class Operator extends \SimpleMath\Expression { 24 | 25 | public function isOperator() { 26 | return true; 27 | } 28 | 29 | public function operate(\SimpleMath\Stack $stack, $variables=array()) 30 | { 31 | $right = $stack->pop()->operate($stack, $variables); 32 | $left = $stack->pop(); 33 | $left = ($left ? $left->operate($stack, $variables) : 0); 34 | return $this->calculate($left, $right); 35 | } 36 | 37 | abstract protected function calculate($left, $right); 38 | } 39 | -------------------------------------------------------------------------------- /src/Expressions/Ternary.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | This file is part of SimpleMath. 6 | 7 | This program is free software; you can redistribute it and/or modify 8 | it under the terms of the GNU General Public License as published by 9 | the Free Software Foundation; either version 2 of the License, or 10 | (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License along 18 | with this program; if not, write to the Free Software Foundation, Inc., 19 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 20 | */ 21 | namespace SimpleMath\Expressions; 22 | 23 | class Ternary extends \SimpleMath\Expression { 24 | 25 | protected $precidence = 1; 26 | protected $leftAssoc = false; 27 | 28 | public function isOperator() { 29 | return true; 30 | } 31 | 32 | public function operateTernary(\SimpleMath\Stack $stack, $variables=array()) { 33 | $right = $stack->pop()->operate($stack, $variables); 34 | $left = $stack->pop()->operate($stack, $variables); 35 | return array($left, $right); 36 | } 37 | 38 | public function operate(\SimpleMath\Stack $stack, $variables=array()) { 39 | if (! $this->isOpen()) { 40 | throw new \RuntimeException('Mismatched ternary operator!'); 41 | } else { 42 | $right = $stack->pop(); 43 | if ($right instanceof Ternary) { 44 | $right = $right->operateTernary($stack, $variables); 45 | } else { 46 | throw new \RuntimeException('Mismatched ternary operator!'); 47 | } 48 | $left = $stack->pop()->operate($stack, $variables); 49 | if ($left) { 50 | return $right[0]; 51 | } else { 52 | return $right[1]; 53 | } 54 | } 55 | } 56 | 57 | public function isOpen() { 58 | return $this->value == '?'; 59 | } 60 | } 61 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # SimpleMath 2 | 3 | Simple math expression evaluator. 4 | 5 | Please note that in most cases it's better to use [Symfony ExpressionLanguage Component](https://packagist.org/packages/symfony/expression-language) instead. It performs better and provides more features. 6 | 7 | This repository will probably not receive any updates in future. 8 | 9 | [![Build Status](https://travis-ci.org/phpmyadmin/simple-math.svg?branch=master)](https://travis-ci.org/phpmyadmin/simple-math) 10 | [![codecov.io](https://codecov.io/github/phpmyadmin/simple-math/coverage.svg?branch=master)](https://codecov.io/github/phpmyadmin/simple-math?branch=master) 11 | [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/phpmyadmin/simple-math/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/phpmyadmin/simple-math/?branch=master) 12 | [![Packagist](https://img.shields.io/packagist/dt/phpmyadmin/simple-math.svg)](https://packagist.org/packages/phpmyadmin/simple-math) 13 | 14 | ## Features 15 | 16 | * Supports basic arithmetic operations `+`, `-`, `*`, `/`, `%` 17 | * Supports parenthesis 18 | * Supports right associative ternary operator 19 | * Supports comparison operators `==`, `!=`, `>`, `<`, `>=`, `<=` 20 | * Supports basic logical operations `&&`, `||` 21 | * Supports variables (either PHP style `$a` or simple `n`) 22 | 23 | The library was developed in order to be able to evaluate Gettext plural 24 | equations, but can be used for any mathematical calculations. 25 | 26 | ## Installation 27 | 28 | Please use [Composer][1] to install: 29 | 30 | ``` 31 | composer require phpmyadmin/simple-math 32 | ``` 33 | 34 | ## Documentation 35 | 36 | The API documentation is available at 37 | . 38 | 39 | 40 | ## Object API usage 41 | 42 | ```php 43 | // Create math object 44 | $math = new SimpleMath\Math(); 45 | 46 | // Evaluate expression 47 | $value = $math->evaluate('1 + 2'); 48 | 49 | // Evaluate expression with PHP style variable 50 | $math->registerVariable('$a', 4); 51 | $value = $math->evaluate('$a + 1'); 52 | 53 | // Evaluate expression with variable 54 | $math->registerVariable('n', 4); 55 | $value = $math->evaluate('n + 1'); 56 | 57 | // Calculate same expression with different values 58 | $math = new SimpleMath\Math(); 59 | 60 | $math->parse('n + 1'); 61 | 62 | $math->registerVariable('n', 10); 63 | $value = $math->run(); 64 | 65 | $math->registerVariable('n', 100); 66 | $value = $math->run(); 67 | ``` 68 | 69 | ## History 70 | 71 | This library is based on [Expressions.php gist][2]. It adds some functions, 72 | performance improvements and ability to install using [Composer][1]. 73 | 74 | [1]:https://getcomposer.org/ 75 | [2]:https://gist.github.com/dremie/fcb1f5beecc327679de8cca51c8e4743 76 | -------------------------------------------------------------------------------- /src/Expression.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | This file is part of SimpleMath. 6 | 7 | This program is free software; you can redistribute it and/or modify 8 | it under the terms of the GNU General Public License as published by 9 | the Free Software Foundation; either version 2 of the License, or 10 | (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License along 18 | with this program; if not, write to the Free Software Foundation, Inc., 19 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 20 | */ 21 | namespace SimpleMath; 22 | 23 | abstract class Expression { 24 | 25 | protected $value = ''; 26 | protected $precidence = 0; 27 | protected $leftAssoc = true; 28 | 29 | public function __construct($value) { 30 | $this->value = $value; 31 | } 32 | 33 | public function getPrecidence() { 34 | return $this->precidence; 35 | } 36 | 37 | public function isLeftAssoc() { 38 | return $this->leftAssoc; 39 | } 40 | 41 | public function isOpen() { 42 | return false; 43 | } 44 | 45 | public static function factory($value) { 46 | if (is_numeric($value)) { 47 | return new Expressions\Number($value); 48 | } elseif (preg_match('/^\$?[a-z]+$/', $value)) { 49 | return new Expressions\Variable($value); 50 | } 51 | 52 | switch ($value) { 53 | case '+': 54 | return new Expressions\Addition($value); 55 | case '-': 56 | return new Expressions\Subtraction($value); 57 | case '*': 58 | return new Expressions\Multiplication($value); 59 | case '/': 60 | return new Expressions\Division($value); 61 | case '%': 62 | return new Expressions\Modulo($value); 63 | case '?': 64 | case ':': 65 | return new Expressions\Ternary($value); 66 | case '(': 67 | case ')': 68 | return new Expressions\Parenthesis($value); 69 | case '==': 70 | return new Expressions\ComparisonEQ($value); 71 | case '<': 72 | return new Expressions\ComparisonLT($value); 73 | case '>': 74 | return new Expressions\ComparisonGT($value); 75 | case '<=': 76 | return new Expressions\ComparisonLTE($value); 77 | case '>=': 78 | return new Expressions\ComparisonGTE($value); 79 | case '!=': 80 | return new Expressions\ComparisonNE($value); 81 | case '||': 82 | return new Expressions\OperatorOr($value); 83 | case '&&': 84 | return new Expressions\OperatorAnd($value); 85 | } 86 | 87 | throw new \RuntimeException('Undefined Value ' . $value); 88 | } 89 | 90 | abstract public function operate(Stack $stack, $variables=array()); 91 | 92 | public function isOperator() { 93 | return false; 94 | } 95 | 96 | public function isParenthesis() { 97 | return false; 98 | } 99 | 100 | public function render() { 101 | return $this->value; 102 | } 103 | } 104 | -------------------------------------------------------------------------------- /src/Math.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | This file is part of SimpleMath. 6 | 7 | This program is free software; you can redistribute it and/or modify 8 | it under the terms of the GNU General Public License as published by 9 | the Free Software Foundation; either version 2 of the License, or 10 | (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License along 18 | with this program; if not, write to the Free Software Foundation, Inc., 19 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 20 | */ 21 | namespace SimpleMath; 22 | 23 | 24 | /** 25 | * Core class of the library performing parsing and calculations. 26 | */ 27 | class Math { 28 | 29 | protected $variables = array(); 30 | protected $stack = null; 31 | 32 | /** 33 | * Parses and executes given formula 34 | * 35 | * @param string $string Formula to process 36 | * 37 | * @return int 38 | */ 39 | public function evaluate($string) { 40 | $this->parse($string); 41 | return $this->run(); 42 | } 43 | 44 | /** 45 | * Parses given formula. The parsed formula is stored in 46 | * the class. 47 | * 48 | * @param string $string Formula to process 49 | * 50 | * @return void 51 | */ 52 | public function parse($string) { 53 | $tokens = $this->tokenize($string); 54 | $output = new Stack(); 55 | $operators = new Stack(); 56 | foreach ($tokens as $token) { 57 | $expression = Expression::factory($token); 58 | if ($expression->isOperator()) { 59 | $this->parseOperator($expression, $output, $operators); 60 | } elseif ($expression->isParenthesis()) { 61 | $this->parseParenthesis($expression, $output, $operators); 62 | } else { 63 | $output->push($expression); 64 | } 65 | } 66 | while (($operator = $operators->pop())) { 67 | if ($operator->isParenthesis()) { 68 | throw new \RuntimeException('Mismatched Parenthesis'); 69 | } 70 | $output->push($operator); 71 | } 72 | $this->stack = $output; 73 | } 74 | 75 | /** 76 | * Registers variable for use withing calculation 77 | * 78 | * @param string $name Name of variable 79 | * @param int $value Value of variable 80 | * 81 | * @return void 82 | */ 83 | public function registerVariable($name, $value) { 84 | $this->variables[$name] = $value; 85 | } 86 | 87 | /** 88 | * Executes currently parsed formula with current variables 89 | * 90 | * @return int 91 | */ 92 | public function run() { 93 | $stack = clone $this->stack; 94 | while (($operator = $stack->pop()) && $operator->isOperator()) { 95 | $value = $operator->operate($stack, $this->variables); 96 | if (!is_null($value)) { 97 | $stack->push(Expression::factory($value)); 98 | } 99 | } 100 | return $operator->render(); 101 | } 102 | 103 | protected function parseParenthesis(Expression $expression, Stack $output, Stack $operators) { 104 | if ($expression->isOpen()) { 105 | $operators->push($expression); 106 | } else { 107 | $clean = false; 108 | while (($end = $operators->pop())) { 109 | if ($end->isParenthesis()) { 110 | $clean = true; 111 | break; 112 | } else { 113 | $output->push($end); 114 | } 115 | } 116 | if (!$clean) { 117 | throw new \RuntimeException('Mismatched Parenthesis'); 118 | } 119 | } 120 | } 121 | 122 | protected function parseOperator(Expression $expression, Stack $output, Stack $operators) { 123 | $end = $operators->poke(); 124 | if (!$end) { 125 | $operators->push($expression); 126 | } elseif ($end->isOperator()) { 127 | do { 128 | if ($expression->isLeftAssoc() && $expression->getPrecidence() <= $end->getPrecidence()) { 129 | $output->push($operators->pop()); 130 | } elseif (!$expression->isLeftAssoc() && $expression->getPrecidence() < $end->getPrecidence()) { 131 | $output->push($operators->pop()); 132 | } else { 133 | break; 134 | } 135 | } while (($end = $operators->poke()) && $end->isOperator()); 136 | $operators->push($expression); 137 | } else { 138 | $operators->push($expression); 139 | } 140 | } 141 | 142 | protected function tokenize($string) { 143 | $parts = preg_split( 144 | '(([0-9]*\.?[0-9]+|\+|-|\(|\)|\*|%|\/|:|\?|==|<=|>=|<|>|!=|&&|\|\|)|\s+)', 145 | $string, 146 | null, 147 | PREG_SPLIT_NO_EMPTY | PREG_SPLIT_DELIM_CAPTURE 148 | ); 149 | $parts = array_map('trim', $parts); 150 | return $parts; 151 | } 152 | 153 | } 154 | -------------------------------------------------------------------------------- /tests/CalculateTest.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | This file is part of SimpleMath. 6 | 7 | This program is free software; you can redistribute it and/or modify 8 | it under the terms of the GNU General Public License as published by 9 | the Free Software Foundation; either version 2 of the License, or 10 | (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License along 18 | with this program; if not, write to the Free Software Foundation, Inc., 19 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 20 | */ 21 | 22 | use PHPUnit\Framework\TestCase; 23 | 24 | /** 25 | * Test for functions. 26 | * 27 | * @package PhpMyAdmin-test 28 | */ 29 | class EvaluateTest extends TestCase 30 | { 31 | /** 32 | * @dataProvider getEquations 33 | */ 34 | public function testEvaluate($equation, $result) 35 | { 36 | $math = new SimpleMath\Math(); 37 | $this->assertEquals( 38 | $result, 39 | $math->evaluate($equation) 40 | ); 41 | } 42 | 43 | public function getEquations() 44 | { 45 | return array( 46 | array('1 + 2', 3), 47 | array('1 - 1', 0), 48 | array('-1', -1), 49 | array('2 * 3', 6), 50 | array('6 / 2', 3), 51 | array('2*2', 4), 52 | array('2 * (1 + 1)', 4), 53 | array('(1 + 1) * (2 + 2)', 8), 54 | array('(2 + 3) * 4', 20), 55 | array('1 + 2 * ((3 + 4) * 5 + 6)', 83), 56 | array('(1 + 2) * (3 + 4) * (5 + 6)', 231), 57 | array( 58 | '(1+69) * (5-1) * (6 * (5+2-3+(75 * (2+6)+75 * ' . 59 | ' (1+5+2+6+3-15)+5)) - (515-(35 * (51-2))))', 60 | 1611120 61 | ), 62 | array('1 ? 10 : 20', 10), 63 | array('0 ? 10 : 20', 20), 64 | array('1 ? 0 : (0 ? 1 : 2)', 0), 65 | array('0 ? 0 : (1 ? 1 : 2)', 1), 66 | array('0 ? 0 : (0 ? 1 : 2)', 2), 67 | array('1 ? 0 : 0 ? 1 : 2', 0), 68 | array('0 ? 0 : 1 ? 1 : 2', 1), 69 | array('0 ? 0 : 0 ? 1 : 2', 2), 70 | array('10 == 20', 0), 71 | array('10 == 10', 1), 72 | array('10 != 20', 1), 73 | array('10 != 10', 0), 74 | array('10 < 20', 1), 75 | array('10 < 10', 0), 76 | array('10 <= 20', 1), 77 | array('10 <= 10', 1), 78 | array('20 > 20', 0), 79 | array('20 > 10', 1), 80 | array('20 >= 20', 1), 81 | array('20 >= 10', 1), 82 | array('1 == 1 ? 10 : 20', 10), 83 | array('1 || 2', 1), 84 | array('1 || 0', 1), 85 | array('0 || 0', 0), 86 | array('1 && 2', 1), 87 | array('1 && 0', 0), 88 | array('0 && 0', 0), 89 | array('2 % 2', 0), 90 | array('4 % 2', 0), 91 | array('4 % 3', 1), 92 | ); 93 | } 94 | 95 | /** 96 | * @dataProvider getVariableEquations 97 | */ 98 | public function testVariable($equation, $name, $variable, $result) 99 | { 100 | $math = new SimpleMath\Math(); 101 | $math->registerVariable($name, $variable); 102 | $this->assertEquals( 103 | $result, 104 | $math->evaluate($equation) 105 | ); 106 | } 107 | 108 | public function getVariableEquations() 109 | { 110 | return array( 111 | array('($a + 3) * 4', '$a', 4, 28), 112 | array('($a + 3) * 4', '$a', 1, 16), 113 | array('($a + $a) * 4', '$a', 5, 40), 114 | array('n + 1', 'n', 100, 101), 115 | ); 116 | } 117 | 118 | public function testDifferentVariable() 119 | { 120 | $math = new SimpleMath\Math(); 121 | 122 | $math->parse('n + 1'); 123 | 124 | $math->registerVariable('n', 10); 125 | $this->assertEquals(11, $math->run()); 126 | 127 | $math->registerVariable('n', 100); 128 | $this->assertEquals(101, $math->run()); 129 | 130 | $math->registerVariable('n', -2); 131 | $this->assertEquals(-1, $math->run()); 132 | 133 | $math->registerVariable('n', 0); 134 | $this->assertEquals(1, $math->run()); 135 | } 136 | 137 | /** 138 | * @dataProvider gettextData 139 | */ 140 | public function testGettext($equation, $expected) 141 | { 142 | $math = new SimpleMath\Math(); 143 | $math->parse($equation); 144 | $values = array(0, 1, 2, 3, 4, 5, 10, 11, 100); 145 | foreach ($values as $key => $value) { 146 | $math->registerVariable('n', $value); 147 | $this->assertEquals($expected[$key], $math->run(), 'n=' . $value); 148 | } 149 | } 150 | 151 | public function gettextData() 152 | { 153 | return array( 154 | array( 155 | '(n != 1)', 156 | array(1, 0, 1, 1, 1, 1, 1, 1, 1), 157 | ), 158 | array( 159 | '(n==1) ? 0 : (n>=2 && n<=4) ? 1 : 2', 160 | array(2, 0, 1, 1, 1, 2, 2, 2, 2), 161 | ), 162 | array( 163 | '(n==0 ? 0 : n==1 ? 1 : n==2 ? 2 : n%100>=3 && n%100<=10 ? 3 : n%100>=11 ? 4 : 5)', 164 | array(0, 1, 2, 3, 3, 3, 3, 4, 5), 165 | ), 166 | ); 167 | } 168 | 169 | /** 170 | * @dataProvider errorEquations 171 | */ 172 | public function testErrors($equation) 173 | { 174 | $this->setExpectedException('RuntimeException'); 175 | $math = new SimpleMath\Math(); 176 | $math->evaluate($equation); 177 | } 178 | 179 | public function errorEquations() 180 | { 181 | return array( 182 | array('1 ? 2'), 183 | array('1 + (1 : 2)'), 184 | array('(1 + 2'), 185 | array('1 + 2)'), 186 | array('#'), 187 | ); 188 | } 189 | } 190 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | --------------------------------------------------------------------------------