From b8eb9732f5567a87a6325aaa3075901846b79409 Mon Sep 17 00:00:00 2001
From: Shakir El Amrani <elamrani.sv.laza@gmail.com>
Date: Sun, 27 Nov 2022 18:23:28 +0100
Subject: [PATCH 1/7] change: formating enhacements

---
 mathexphtml.php | 165 ++++++++++++++++++++++--------------------------
 1 file changed, 77 insertions(+), 88 deletions(-)

diff --git a/mathexphtml.php b/mathexphtml.php
index 1aa3448..6771cbf 100644
--- a/mathexphtml.php
+++ b/mathexphtml.php
@@ -1,18 +1,18 @@
 <?php
 
-/******
+/**
  * mathExpHtml Class
- *
+ * 
  * This class is free for the educational use as long as maintain this header together with this class.
  * Author: Win Aung Cho
  * Contact winaungcho@gmail.com
  * version 1.0
  * Date: 26-11-2022
- *
- ******/
+ */
 class mathExpHtml
 {
     private $tokens;
+
     function __construct($str)
     {
         define('_OPERATORS', array(
@@ -28,17 +28,22 @@ function __construct($str)
             '>',
             ','
         ));
+
         $this->tokens = $this->str2tokens($str);
     }
+
     function operators()
     {
         return _OPERATORS;
     }
+
     function str2tokens($str)
     {
         $tokens = preg_split('/([<>()*\/=^+-])\s*|([\d.]+)\s*|(\w+)\s*|({\w+})\s*/', $str, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
+
         return $tokens;
     }
+
     function tokentype($token)
     {
         return (is_numeric($token) ? "value" : (in_array($token, _OPERATORS) ? "operator" : (preg_match('/^[\w-]+$/', $token) ? "alphanum" : 
@@ -47,86 +52,80 @@ function tokentype($token)
     function mathhtml($a, $o, $b)
     {
         $html = "";
+
         switch ($o)
         {
             case '+':
             case '-':
-            
             case '=':
             case '<':
             case '>':
             case ',':
                 $html = "$a $o $b";
-            break;
+                break;
+
             case '*':
-            $html = "$a • $b";
-            break;
+                $html = "$a • $b";
+                break;
+
             case '^':
                 $html = "$a<sup>$b</sup>";
-            break;
+                break;
+
             case '/':
                 $html = "<div class=\"fraction\">";
                 $html .= "<span class=\"numer\">$a</span>"; // numerator
                 $html .= "<span class=\"bar\">/</span>";
                 $html .= "<span class=\"denom\">$b</span>"; // denominator
                 $html .= "</div>";
-            break;
+                break;
         }
+
         return ($html);
     }
-    function testknownoperator($token){
+
+    function testknownoperator($token) 
+    {
     	$pattern = "/([(),+])\s*/";
-    	//$str = strip_tags($token);
     	$test = preg_split($pattern, $token, 8, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
-    	
-    	//echo "<br/>";
-    	//print_r($test);
-    	//echo "<br/>";
-    	
     	$html = "";
-    	
     	if (strip_tags($test[0]) == 'sum'){
     		$html = "<span class=\"intsuma\">".
     		"<span class=\"lim\">".$test[4]."</span>".
     		"<span class=\"sum-frac\">&sum;</span>".
     		"<span class=\"lim\">".$test[2]."</span>".
     		"</span>";
-    	}/*
-    	 else if (strip_tags($test[0]) == 'int'){
-    		$html = "<span class=\"intsuma\">".
-    		"<span class=\"lim\">".$test[4]."</span>".
-    		"<span class=\"sum-frac\">&int;</span>".
-    		"<span class=\"lim\">".$test[2]."</span>".
-    		"</span>";
     	}
-    	*/
+
     	return $html;
     }
-    function formatelement($tokens)
+
+    function formatelement($tokens) 
     {
         $len = count($tokens);
-        for ($i = 0;$i < $len;$i++)
-        {
+        for ($i = 0;$i < $len;$i++) {
             $a = $tokens[$i];
             $b = ($i < $len - 1) ? trim($tokens[$i + 1]) : " ";
-            if ($this->tokentype($a) == "alphanum")
-            {
-                if ($b[0] == '('){
+
+            if ($this->tokentype($a) == "alphanum") {
+                if ($b[0] == '(') {
                 	$a = "<span style='color:green;'><var>$a</var></span>";
+                } else {
+                    $a = "<var>$a</var>";
                 }
-                else $a = "<var>$a</var>";
-            }
-            else if ($this->tokentype($a) == "value"){
+            } elseif ($this->tokentype($a) == "value") {
             	$a = "<span style='color:blue;'>$a</span>";
-            } else if ($this->tokentype($a) == "vector"){
+            } elseif ($this->tokentype($a) == "vector") {
             	$a = str_replace(array("{", "}"), "", $a);
             	$s = strlen($a);
             	$a = " <span class=\"sym\"><var>$a</var>".
             		"<span class=\"vec\" style=\"transform:scale($s,1.0);\">&rarr;</span>".
             		"</span>";
             }
+
             $tokens[$i] = $a;
         }
+
         return $tokens;
     }
     
@@ -136,143 +135,133 @@ function parsepar($tokens)
         $pos = 0;
         $len = count($tokens);
         $level = 0;
-        while ($pos < $len)
-        {
+        while ($pos < $len) {
             $a = $tokens[$pos];
-            while ($a != "(" && $pos < $len)
-            {
+
+            while ($a != "(" && $pos < $len) {
                 $pos++;
                 $a = $tokens[$pos];
             }
-            while ($a != ")" && $pos < $len)
-            {
-                if ($a == "(")
-                {
+
+            while ($a != ")" && $pos < $len) {
+                if ($a == "(") {
                     $start = $pos;
                     $level++;
                 }
+
                 $pos++;
                 $a = $tokens[$pos];
             }
-            if ($a == ")")
-            {
+
+            if ($a == ")") {
                 $end = $pos;
                 $level--;
                 $subtokens = array_slice($tokens, $start + 1, $end - $start - 1);
                 array_splice($tokens, $start + 1, $end - $start);
                 $tokens[$start] = "(" . $this->exphtml($subtokens) . ")";
-                //echo "sub ".$subtokens[0]."=>".count($subtokens)."<br/>";
                 $pos = $start;
             }
+
             $pos++;
         }
-        /*
-        print_r($tokens);
-        echo "<br/>";
-        print_r($subtokens);
-        echo "<br/>";
-        echo "level ".$level."<br/>";
-        */
-        if ($level != 0) $tokens = $this->parsepar($tokens);
+
+        if ($level != 0) {
+            $tokens = $this->parsepar($tokens);
+        }
+
         return $tokens;
     }
+
     function exphtml($tokens)
     {
         $len = count($tokens);
         
-        if ($len <= 2)
-        {
+        if ($len <= 2) {
             return $tokens[0];
         }
-        // merge function
-        for ($i = 0;$i < $len;$i++)
-        {
+
+        for ($i = 0;$i < $len;$i++) {
             $a = $tokens[$i];
             $b = ($i < $len - 1) ? trim($tokens[$i + 1]) : " ";
-            if ($this->tokentype(strip_tags($a)) == "alphanum")
-            {
-                if ($b[0] == '('){
+            if ($this->tokentype(strip_tags($a)) == "alphanum") {
+                if ($b[0] == '(') {
                 	$tokens[$i] = $a . $b;
                 	array_splice($tokens, $i + 1, 1);
                 	$html = $this->testknownoperator($tokens[$i]);
-                	if ($html != "") $tokens[$i] = $html;
+                	if ($html != "") {
+                        $tokens[$i] = $html;
+                    }
                 }
             }
         }
+
         $len = count($tokens);
-        //echo "length ".$len."<br/>";
         $pos = 0;
-        while ($pos < $len - 2)
-        {
+        while ($pos < $len - 2) {
             $a = $tokens[$pos];
             $o = $tokens[$pos + 1];
             $b = $tokens[$pos + 2];
 
-            if ($this->tokentype($o) == "operator" && $o == '^')
-            {
+            if ($this->tokentype($o) == "operator" && $o == '^') {
                 $a = $this->mathhtml($a, $o, $b);
                 $tokens[$pos] = $a;
                 array_splice($tokens, $pos + 1, 2);
                 $len = count($tokens);
+            } else {
+                $pos += 2;
             }
-            else $pos += 2;
         }
 
         $pos = 0;
-        while ($pos < $len - 2)
-        {
+        while ($pos < $len - 2) {
             $a = $tokens[$pos];
             $o = $tokens[$pos + 1];
             $b = $tokens[$pos + 2];
 
-            if ($this->tokentype($o) == "operator" && ($o == "/" || $o == "*"))
-            {
+            if ($this->tokentype($o) == "operator" && ($o == "/" || $o == "*")) {
                 $a = $this->mathhtml($a, $o, $b);
                 $tokens[$pos] = $a;
                 array_splice($tokens, $pos + 1, 2);
                 $len = count($tokens);
             }
-            else $pos += 2;
+            else {
+                $pos += 2;
+            }
         }
 
         $pos = 0;
         $a = $tokens[$pos];
-        while ($pos < $len - 2)
-        {
+        while ($pos < $len - 2) {
             $o = $tokens[$pos + 1];
             $b = $tokens[$pos + 2];
             
-            if ($this->tokentype($o) == "operator")
-            {
+            if ($this->tokentype($o) == "operator") {
                 $a = $this->mathhtml($a, $o, $b);
             }
+
             $pos += 2;
         }
+
         if ($pos < $len-1 && $tokens[$pos+1][0] == '(') {
         	$a .= $tokens[$pos+1];
         }
         
         return $a;
     }
+
     function printtokens()
     {
         echo "<pre>";
-        foreach ($this->tokens as $token)
-        {
+        foreach ($this->tokens as $token) {
             $token = trim($token);
             echo $token . "  is " . $this->tokentype($token) . "<br/>";
         }
-        echo "</pre>";
-        echo "<br/>";
+        echo "<br/></pre>";
     }
+
     function gethtml()
     {
         $tokens = $this->parsepar($this->tokens);
-        //echo "<br/>";
-        //print_r($tokens);
-        //echo "<br/>";
         echo "" . $this->exphtml($tokens) . "";
     }
 }
-
-?>

From aa8e0f38e7e5fcaf8e456cceb37b43d487af8120 Mon Sep 17 00:00:00 2001
From: Shakir El Amrani <elamrani.sv.laza@gmail.com>
Date: Sun, 27 Nov 2022 18:31:26 +0100
Subject: [PATCH 2/7] change: added visibility properties to class methods

---
 mathexphtml.php | 51 +++++++++++++++++++++++++------------------------
 1 file changed, 26 insertions(+), 25 deletions(-)

diff --git a/mathexphtml.php b/mathexphtml.php
index 6771cbf..9a929ec 100644
--- a/mathexphtml.php
+++ b/mathexphtml.php
@@ -13,7 +13,7 @@ class mathExpHtml
 {
     private $tokens;
 
-    function __construct($str)
+    public function __construct($str)
     {
         define('_OPERATORS', array(
             '(',
@@ -32,24 +32,41 @@ function __construct($str)
         $this->tokens = $this->str2tokens($str);
     }
 
-    function operators()
+    public function printtokens()
+    {
+        echo "<pre>";
+        foreach ($this->tokens as $token) {
+            $token = trim($token);
+            echo $token . "  is " . $this->tokentype($token) . "<br/>";
+        }
+        echo "<br/></pre>";
+    }
+
+    public function gethtml()
+    {
+        $tokens = $this->parsepar($this->tokens);
+        echo "" . $this->exphtml($tokens) . "";
+    }
+
+    private function operators()
     {
         return _OPERATORS;
     }
 
-    function str2tokens($str)
+    private function str2tokens($str)
     {
         $tokens = preg_split('/([<>()*\/=^+-])\s*|([\d.]+)\s*|(\w+)\s*|({\w+})\s*/', $str, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
 
         return $tokens;
     }
 
-    function tokentype($token)
+    private function tokentype($token)
     {
         return (is_numeric($token) ? "value" : (in_array($token, _OPERATORS) ? "operator" : (preg_match('/^[\w-]+$/', $token) ? "alphanum" : 
         	(preg_match('/({\w+})/', $token)?"vector":"none"))));
     }
-    function mathhtml($a, $o, $b)
+
+    private function mathhtml($a, $o, $b)
     {
         $html = "";
 
@@ -84,7 +101,7 @@ function mathhtml($a, $o, $b)
         return ($html);
     }
 
-    function testknownoperator($token) 
+    private function testknownoperator($token) 
     {
     	$pattern = "/([(),+])\s*/";
     	$test = preg_split($pattern, $token, 8, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
@@ -100,7 +117,7 @@ function testknownoperator($token)
     	return $html;
     }
 
-    function formatelement($tokens) 
+    private function formatelement($tokens) 
     {
         $len = count($tokens);
         for ($i = 0;$i < $len;$i++) {
@@ -129,7 +146,7 @@ function formatelement($tokens)
         return $tokens;
     }
     
-    function parsepar($tokens)
+    private function parsepar($tokens)
     {
         $tokens = $this->formatelement($tokens);
         $pos = 0;
@@ -172,7 +189,7 @@ function parsepar($tokens)
         return $tokens;
     }
 
-    function exphtml($tokens)
+    private function exphtml($tokens)
     {
         $len = count($tokens);
         
@@ -248,20 +265,4 @@ function exphtml($tokens)
         
         return $a;
     }
-
-    function printtokens()
-    {
-        echo "<pre>";
-        foreach ($this->tokens as $token) {
-            $token = trim($token);
-            echo $token . "  is " . $this->tokentype($token) . "<br/>";
-        }
-        echo "<br/></pre>";
-    }
-
-    function gethtml()
-    {
-        $tokens = $this->parsepar($this->tokens);
-        echo "" . $this->exphtml($tokens) . "";
-    }
 }

From 4c84743d3a251c639082a77724aadfb626868aa2 Mon Sep 17 00:00:00 2001
From: Shakir El Amrani <elamrani.sv.laza@gmail.com>
Date: Sun, 27 Nov 2022 18:32:54 +0100
Subject: [PATCH 3/7] change: uppercase class name

---
 mathexphtml.php => MathExpHtml.php | 4 ++--
 example.php                        | 6 +++---
 2 files changed, 5 insertions(+), 5 deletions(-)
 rename mathexphtml.php => MathExpHtml.php (99%)

diff --git a/mathexphtml.php b/MathExpHtml.php
similarity index 99%
rename from mathexphtml.php
rename to MathExpHtml.php
index 9a929ec..db51a2b 100644
--- a/mathexphtml.php
+++ b/MathExpHtml.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * mathExpHtml Class
+ * MathExpHtml Class
  * 
  * This class is free for the educational use as long as maintain this header together with this class.
  * Author: Win Aung Cho
@@ -9,7 +9,7 @@
  * version 1.0
  * Date: 26-11-2022
  */
-class mathExpHtml
+class MathExpHtml
 {
     private $tokens;
 
diff --git a/example.php b/example.php
index 72579c3..2eeeed1 100644
--- a/example.php
+++ b/example.php
@@ -1,8 +1,8 @@
 <?php
-include("mathexphtml.php");
+include("MathExpHtml.php");
 
 /******
- * mathExpHtml Class and example file
+ * MathExpHtml Class and example file
  *
  * This class is free for the educational use as long as maintain this header together with this class.
  * Author: Win Aung Cho
@@ -98,7 +98,7 @@
 		<div style="overflow-x:auto;overflow-y:auto; width:100%;height:100%;white-space: nowrap;">
 			<?php
 				$str = "a=sum(i=1,3)(23.5*{vec}-(((cos(2+θ/2)+asd9)^2)/4.5+sin(0.5*θ))/(20.06+π*(16))^2-26)";
-				$parser = new mathExpHtml($str);
+				$parser = new MathExpHtml($str);
 
 				$parser->printtokens();
 				$parser->gethtml();

From 704587a4a167185033c06e93a4a9888f6f98a162 Mon Sep 17 00:00:00 2001
From: Shakir El Amrani <elamrani.sv.laza@gmail.com>
Date: Sun, 27 Nov 2022 17:39:25 +0000
Subject: [PATCH 4/7] change: fixed formatting issues in the example page

---
 example.php | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/example.php b/example.php
index 2eeeed1..24fc172 100644
--- a/example.php
+++ b/example.php
@@ -1,7 +1,6 @@
 <?php
-include("MathExpHtml.php");
 
-/******
+/**
  * MathExpHtml Class and example file
  *
  * This class is free for the educational use as long as maintain this header together with this class.
@@ -9,11 +8,13 @@
  * Contact winaungcho@gmail.com
  * version 1.0
  * Date: 26-11-2022
- *
- ******/
+ */
+
+include("MathExpHtml.php");
+
 ?>
 
-<html>
+<html lang="en">
 	<head>
 		<meta charset="utf-8">
 		<style>
@@ -99,7 +100,6 @@
 			<?php
 				$str = "a=sum(i=1,3)(23.5*{vec}-(((cos(2+θ/2)+asd9)^2)/4.5+sin(0.5*θ))/(20.06+π*(16))^2-26)";
 				$parser = new MathExpHtml($str);
-
 				$parser->printtokens();
 				$parser->gethtml();
 			?>

From befb3c9ac4abf1a9126a8052df50badf68789636 Mon Sep 17 00:00:00 2001
From: Shakir El Amrani <elamrani.sv.laza@gmail.com>
Date: Sun, 27 Nov 2022 17:47:27 +0000
Subject: [PATCH 5/7] change: enhance the formatting and fix typos

---
 README.md | 32 +++++++++++++++++++-------------
 1 file changed, 19 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index a9c78ba..d1976af 100644
--- a/README.md
+++ b/README.md
@@ -1,26 +1,32 @@
-![Math-Expression-to-HTML](mathexphtml.jpg)
 # Math-Expression-to-HTML
-Produce html code from the mathematic expression string
 
-## Check Demo
-Visit following link and check demo in forum.
-[Demo](https://edu.structsoftlab.com/forum/)
+Produce html code from the mathematic expression string.
+![Math-Expression-to-HTML](mathexphtml.jpg)
+
+## Demo version
+
+Visit following link and check demo in forum
+[Demo](https://edu.structsoftlab.com/forum/).
 
 ## Features
-Algorythm is very simple.
-- String is tokenized using preg_split into array of tokens, 
+
+Algorithm is very simple.
+
+- String is tokenized using `preg_split` into array of tokens, 
 - Token types are value, alpha-numeric and operator.
 - Alpha numeric represents as a variable or function name.
 - There are some known functions such as summation sign sum(i=1, 5).
 - First tokens are simplify into simple expression inside the parenthesis.
-- Nested parenthesis are alliwed.
+- Nested parenthesis are allowed.
 - Simple inside () are convert into html code using predefined css classes.
 - Precedence are common as following order, ^, *,/,+.-.
-- Multiple expressions of () may connected without operator, 
--  eg., (3+a/4)(sin(0.5*θ))
-- Vector variable can be used in written form enclosed with cali-bracket.
--  eg., {vec}
+- Multiple expressions of () may connected without operator eg., (3+a/4)(sin(0.5*θ))
+- Vector variable can be used in written form enclosed with cali-bracket eg., {vec}.
+
+## Licence
+
+This project is published under the Gnu General Public License see [the License File](LICENSE) for more information.
 
 ## Contact
-Contact me for comercial use via mail winaungcho@gmail.com
 
+Contact me for comercial use via mail winaungcho@gmail.com.

From 0ef386160daa00884623872c9f84d07e290fcdee Mon Sep 17 00:00:00 2001
From: Shakir El Amrani <elamrani.sv.laza@gmail.com>
Date: Sun, 27 Nov 2022 17:51:40 +0000
Subject: [PATCH 6/7] add: added more documentation about class usage

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/README.md b/README.md
index d1976af..77ce6c8 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,18 @@ Produce html code from the mathematic expression string.
 Visit following link and check demo in forum
 [Demo](https://edu.structsoftlab.com/forum/).
 
+## Usage
+
+First include the `MathExpHtml.php` class in your file, and use the class as following to generate the HTML for the math expressions:
+
+```php
+$expression = "a=sum(i=1,3)(23.5*{vec}-(((cos(2+θ/2)+asd9)^2)/4.5+sin(0.5*θ))/(20.06+π*(16))^2-26)";
+
+$parser = new MathExpHtml($expression);
+$parser->printtokens();
+$parser->gethtml();
+```
+
 ## Features
 
 Algorithm is very simple.

From eb4acbaa9dccd118d81d10639b6d1d8874c33906 Mon Sep 17 00:00:00 2001
From: Shakir El Amrani <elamrani.sv.laza@gmail.com>
Date: Sun, 27 Nov 2022 17:53:51 +0000
Subject: [PATCH 7/7] change: camelcase the printtokens method

---
 MathExpHtml.php | 2 +-
 README.md       | 2 +-
 example.php     | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/MathExpHtml.php b/MathExpHtml.php
index db51a2b..0de174c 100644
--- a/MathExpHtml.php
+++ b/MathExpHtml.php
@@ -32,7 +32,7 @@ public function __construct($str)
         $this->tokens = $this->str2tokens($str);
     }
 
-    public function printtokens()
+    public function printTokens()
     {
         echo "<pre>";
         foreach ($this->tokens as $token) {
diff --git a/README.md b/README.md
index 77ce6c8..c30e5af 100644
--- a/README.md
+++ b/README.md
@@ -16,7 +16,7 @@ First include the `MathExpHtml.php` class in your file, and use the class as fol
 $expression = "a=sum(i=1,3)(23.5*{vec}-(((cos(2+θ/2)+asd9)^2)/4.5+sin(0.5*θ))/(20.06+π*(16))^2-26)";
 
 $parser = new MathExpHtml($expression);
-$parser->printtokens();
+$parser->printTokens();
 $parser->gethtml();
 ```
 
diff --git a/example.php b/example.php
index 24fc172..ef6f147 100644
--- a/example.php
+++ b/example.php
@@ -100,7 +100,7 @@
 			<?php
 				$str = "a=sum(i=1,3)(23.5*{vec}-(((cos(2+θ/2)+asd9)^2)/4.5+sin(0.5*θ))/(20.06+π*(16))^2-26)";
 				$parser = new MathExpHtml($str);
-				$parser->printtokens();
+				$parser->printTokens();
 				$parser->gethtml();
 			?>
 		</div>