telyn / c2ephp

support/IReader.php

Doc Comments +10 added lines, -1 removed lines

@@ -12,13 +12,14 @@ 
 interface IReader {
     /// @brief Reads an integer
     /**
-     * @param $length Length of the integer in bytes.
+     * @param integer $length Length of the integer in bytes.
      */
     public function ReadInt($length);
 
     /// @brief Reads a string
     /**
      * @param $length Length of the string to read in bytes
+     * @return string|false
      */
     public function Read($length);
 
@@ -30,24 +31,32 @@ 
      * memory-wise, but it simplifies the code and c2e files don't
      * tend to get big enough to make this inefficiency a concern on
      * any reasonably modern hardware.
+     * @return string
      */
     public function GetSubString($start,$length=FALSE);
     /// @brief Gets the position of the cursor
     /**
      * This is analagous to ftell in C or PHP.
+     * @return integer
      */
     public function GetPosition();
     /// @brief Changes the current position in the reader's stream
     /**
      * This is analagous to fseek in C or PHP.
+     * @return void
      */
     public function Seek($position); 
     /// @brief Advances the position of the reader by $count.
+
+    /**
+     * @return void
+     */
     public function Skip($count);
     /// @brief Reads a c-style string at the current position.
     /**
      * C-style means that the string is terminated by a NUL (0) 
      * character.
+     * @return string
      */
     public function ReadCString(); //read a string of unknown length until the first NUL
 }

Spacing +1 added lines, -1 removed lines

@@ -31,7 +31,7 @@
      * tend to get big enough to make this inefficiency a concern on
      * any reasonably modern hardware.
      */
-    public function GetSubString($start,$length=FALSE);
+    public function GetSubString($start, $length = FALSE);
     /// @brief Gets the position of the cursor
     /**
      * This is analagous to ftell in C or PHP.

support/StringReader.php

Doc Comments +11 added lines

@@ -50,12 +50,20 @@ 
     public function Skip($count) {
         $this->position += $count;
     }
+
+    /**
+     * @param integer $characters
+     */
     public function ReadInt($characters) {
         return BytesToIntLilEnd($this->Read($characters));
     }
     public function GetPosition() {
         return $this->position;
     }
+
+    /**
+     * @param integer $start
+     */
     public function GetSubString($start,$length = FALSE) {
         if($length == FALSE) {
             $length = strlen($this->string)-$start;
@@ -65,6 +73,9 @@ 
     }
 }
 
+/**
+ * @param false|string $string
+ */
 function BytesToIntLilEnd($string) { //little endian
     if($string == "") {
         return false;

Spacing +13 added lines, -13 removed lines

@@ -23,11 +23,11 @@ 
         $this->position = 0;
     }
     public function Read($characters) {
-        if($characters > 0) {
-            if($this->position+$characters > strlen($this->string)) {
+        if ($characters > 0) {
+            if ($this->position+$characters > strlen($this->string)) {
                 return false;
             }
-            $str = substr($this->string,$this->position,$characters);
+            $str = substr($this->string, $this->position, $characters);
 
             $this->position += $characters;
             return $str;
@@ -36,13 +36,13 @@ 
     }
     public function ReadCString() {
         $string = '';
-        while(($char = $this->Read(1)) !== false) {
-            $string.=$char;
-            if($char == "\0") {
+        while (($char = $this->Read(1)) !== false) {
+            $string .= $char;
+            if ($char == "\0") {
                 break;
             }           
         }
-        return substr($string,0,-1);
+        return substr($string, 0, -1);
     }
     public function Seek($position) {
         $this->position = $position;
@@ -56,23 +56,23 @@ 
     public function GetPosition() {
         return $this->position;
     }
-    public function GetSubString($start,$length = FALSE) {
-        if($length == FALSE) {
+    public function GetSubString($start, $length = FALSE) {
+        if ($length == FALSE) {
             $length = strlen($this->string)-$start;
         }
-        $str = substr($this->string,$start,$length);         
+        $str = substr($this->string, $start, $length);         
         return $str;
     }
 }
 
 function BytesToIntLilEnd($string) { //little endian
-    if($string == "") {
+    if ($string == "") {
         return false;
     }
     $length = strlen($string);
     $int = 0;
-    for($i=0;$i<$length;$i++) {
-        $int += ord($string{$i})<<($i*8);
+    for ($i = 0; $i < $length; $i++) {
+        $int += ord($string{$i}) << ($i*8);
     }
     return $int;
 }

unit-tests/ReaderTest.php

Spacing +10 added lines, -10 removed lines

@@ -1,7 +1,7 @@ 
 <?php
-require_once(dirname(__FILE__) . '/AbstractTestCase.php');
-require_once(dirname(__FILE__) . '/../support/FileReader.php');
-require_once(dirname(__FILE__) . '/../support/StringReader.php');
+require_once(dirname(__FILE__).'/AbstractTestCase.php');
+require_once(dirname(__FILE__).'/../support/FileReader.php');
+require_once(dirname(__FILE__).'/../support/StringReader.php');
 
 class ReaderTest extends c2ephpAbstractTestCase {
 
@@ -10,19 +10,19 @@ 
      */
     public function testStringReader($string) {
         $stringReader = new StringReader($string);
-        $this->assertEquals($string[0],$stringReader->Read(1));
-        $this->assertEquals($string[1],$stringReader->Read(1));
+        $this->assertEquals($string[0], $stringReader->Read(1));
+        $this->assertEquals($string[1], $stringReader->Read(1));
         $stringReader->skip(2);
-        $this->assertEquals($string[4],$stringReader->Read(1));
-        $this->assertEquals(substr($string,3,8),$stringReader->GetSubString(3,8));
-        $this->assertEquals($string[5],$stringReader->Read(1));
+        $this->assertEquals($string[4], $stringReader->Read(1));
+        $this->assertEquals(substr($string, 3, 8), $stringReader->GetSubString(3, 8));
+        $this->assertEquals($string[5], $stringReader->Read(1));
 
-        $this->assertEquals($string,$stringReader->GetSubString(0));
+        $this->assertEquals($string, $stringReader->GetSubString(0));
     }
     
     public function generateStrings() {
         return array(
-            array('striiing','blimp!!!!!!!'),
+            array('striiing', 'blimp!!!!!!!'),
         );
     }
 }

unit-tests/AbstractTestCase.php

Spacing +4 added lines, -4 removed lines

@@ -1,6 +1,6 @@ 
 <?php
-require_once(dirname(__FILE__) . '/../agents/PRAYFile.php');
-require_once(dirname(__FILE__) . '/../support/FileReader.php');
+require_once(dirname(__FILE__).'/../agents/PRAYFile.php');
+require_once(dirname(__FILE__).'/../support/FileReader.php');
 
 abstract class c2ephpAbstractTestCase extends PHPUnit_Framework_TestCase {
     /// @brief Agent Files fixture
@@ -27,7 +27,7 @@ 
         );
 
         $prayfiles = array();
-        foreach($files as $info) {
+        foreach ($files as $info) {
 
             $prayfiles[] = array(new PRAYFile(new FileReader($info['path'])), $info);
         }
@@ -44,7 +44,7 @@ 
 
 
         $prayfiles = array();
-        foreach($files as $info) {
+        foreach ($files as $info) {
 
             $prayfiles[] = array(new PRAYFile(new FileReader($info['path'])), $info);
         }

unit-tests/PRAYFileTest.php

Indentation +4 added lines, -4 removed lines

@@ -4,16 +4,16 @@
 class PRAYFileTest extends c2ephpAbstractTestCase {
     
     /**
-      * @dataProvider createAgentFiles
-      */
+     * @dataProvider createAgentFiles
+     */
     public function testCreatePRAYFile(PRAYFile $prayfile) {
         $this->assertInstanceOf('PRAYFile',$prayfile);
         $this->assertNotNull($prayfile);
     }
     
     /**
-      * @dataProvider createAgentFiles
-      */
+     * @dataProvider createAgentFiles
+     */
     public function testNumberOfBlocks(PRAYFile $prayfile,$fixtureInfo) {
         $this->assertNotNull($prayfile);
         $this->assertEquals($fixtureInfo['block count'],sizeof($prayfile->GetBlocks()));

Spacing +15 added lines, -15 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-require_once(dirname(__FILE__) . '/AbstractTestCase.php');
+require_once(dirname(__FILE__).'/AbstractTestCase.php');
 
 class PRAYFileTest extends c2ephpAbstractTestCase {
     
@@ -7,56 +7,56 @@ 
       * @dataProvider createAgentFiles
       */
     public function testCreatePRAYFile(PRAYFile $prayfile) {
-        $this->assertInstanceOf('PRAYFile',$prayfile);
+        $this->assertInstanceOf('PRAYFile', $prayfile);
         $this->assertNotNull($prayfile);
     }
     
     /**
       * @dataProvider createAgentFiles
       */
-    public function testNumberOfBlocks(PRAYFile $prayfile,$fixtureInfo) {
+    public function testNumberOfBlocks(PRAYFile $prayfile, $fixtureInfo) {
         $this->assertNotNull($prayfile);
-        $this->assertEquals($fixtureInfo['block count'],sizeof($prayfile->GetBlocks()));
+        $this->assertEquals($fixtureInfo['block count'], sizeof($prayfile->GetBlocks()));
     }
 
     /**
      * @dataProvider createAgentFiles
      */
-    public function testFirstAgentDescription(PRAYFile $prayfile,$info) {
+    public function testFirstAgentDescription(PRAYFile $prayfile, $info) {
         $this->assertNotNull($prayfile);
         $blocks = $prayfile->GetBlocks(PRAY_BLOCK_AGNT);
-        $this->assertEquals($info['first agent desc'],$blocks[0]->GetAgentDescription());
+        $this->assertEquals($info['first agent desc'], $blocks[0]->GetAgentDescription());
     }
 
     /**
      * @dataProvider createAgentFiles
      */ 
-    public function testChangeAGNTAndRecompile(PRAYFile $prayfile,$info) {
+    public function testChangeAGNTAndRecompile(PRAYFile $prayfile, $info) {
         $this->assertNotNull($prayfile);
         $blocks = $prayfile->GetBlocks(PRAY_BLOCK_AGNT);
-        $blocks[0]->SetTag('Agent Description','Testing');
-        $this->assertEquals('Testing',$blocks[0]->GetAgentDescription());
+        $blocks[0]->SetTag('Agent Description', 'Testing');
+        $this->assertEquals('Testing', $blocks[0]->GetAgentDescription());
         $data = $prayfile->Compile();
         $newfile = new PRAYFile(new StringReader($data));
-        $this->assertEquals($info['block count'],sizeof($newfile->GetBlocks()));
+        $this->assertEquals($info['block count'], sizeof($newfile->GetBlocks()));
         $newfile->GetBlocks('AGNT');
-        $this->assertEquals('Testing',$blocks[0]->GetAgentDescription());
+        $this->assertEquals('Testing', $blocks[0]->GetAgentDescription());
     }
 
     /**
      * @dataProvider createCreatureFiles
      */ 
-    public function testChangeGLSTAndRecompile(PRAYFILE $prayfile,$info) {
+    public function testChangeGLSTAndRecompile(PRAYFILE $prayfile, $info) {
         $this->assertNotNull($prayfile);
         $blocks = $prayfile->GetBlocks(PRAY_BLOCK_GLST);
-        $this->assertEquals($info['events count'],$blocks[0]->GetHistory()->CountEvents());
+        $this->assertEquals($info['events count'], $blocks[0]->GetHistory()->CountEvents());
         $blocks[0]->GetHistory()->RemoveEvent(0);
-        $this->assertEquals($info['events count']-1,$blocks[0]->GetHistory()->CountEvents());
+        $this->assertEquals($info['events count']-1, $blocks[0]->GetHistory()->CountEvents());
         
         $data = $prayfile->Compile();
         $newfile = new PRAYFile(new StringReader($data));
         $blocks = $newfile->GetBlocks(PRAY_BLOCK_GLST);
-        $this->assertEquals($info['events count']-1,$blocks[0]->GetHistory()->CountEvents());
+        $this->assertEquals($info['events count']-1, $blocks[0]->GetHistory()->CountEvents());
 
     }
 }

sprites/C16Frame.php

Spacing +38 added lines, -38 removed lines

@@ -25,9 +25,9 @@ 
      * @param $reader An IReader or GD image resource.
      * @param $encoding The encoding of the C16 frame (555 or 565). Defaults to 565
      */
-    public function C16Frame($reader,$encoding='565')
+    public function C16Frame($reader, $encoding = '565')
     {
-        if($reader instanceof IReader) {
+        if ($reader instanceof IReader) {
             $this->reader = $reader;
             $this->encoding = $encoding;
             $this->offset = $this->reader->ReadInt(4);
@@ -35,17 +35,17 @@ 
             $width = $this->reader->ReadInt(2);
             $height = $this->reader->ReadInt(2);
 
-            parent::SpriteFrame($width,$height);
+            parent::SpriteFrame($width, $height);
 
-            for($x = 0; $x < ($height - 1); $x++)
+            for ($x = 0; $x < ($height-1); $x++)
             {
                 $this->lineOffset[$x] = $this->reader->ReadInt(4);
             }
-        } else if(is_resource($reader)) {
-            if(get_resource_type($reader) == 'gd') {
+        } else if (is_resource($reader)) {
+            if (get_resource_type($reader) == 'gd') {
 
-                $this->encoding = ($encoding=='555')?'555':'565';
-                parent::SpriteFrame(imagesx($reader),imagesy($reader),true);
+                $this->encoding = ($encoding == '555') ? '555' : '565';
+                parent::SpriteFrame(imagesx($reader), imagesy($reader), true);
                 $this->gdImage = $reader;
             }
         } else {
@@ -70,37 +70,37 @@ 
         $image = imagecreatetruecolor($this->GetWidth(),
             $this->GetHeight());
         $this->reader->Seek($this->offset);
-        for($y = 0; $y < $this->GetHeight(); $y++)
+        for ($y = 0; $y < $this->GetHeight(); $y++)
         {
-            for($x = 0; $x < $this->GetWidth();)
+            for ($x = 0; $x < $this->GetWidth();)
             {
                 $run = $this->reader->ReadInt(2);
-                if(($run & 0x0001) > 0)
+                if (($run & 0x0001) > 0)
                     $run_type = "colour";
                 else
                     $run_type = "black";
                 $run_length = ($run & 0x7FFF) >> 1;
-                if($run_type == "black")
+                if ($run_type == "black")
                 {
-                    $z = $x + $run_length;
-                    for(;$x < $z; $x++)
+                    $z = $x+$run_length;
+                    for (;$x < $z; $x++)
                     {
                         imagesetpixel($image, $x, $y, imagecolorallocate($image, 0, 0, 0));
                     }
                 }
                 else //colour run
                 {
-                    $z = $x + $run_length;
-                    for(;$x < $z; $x++)
+                    $z = $x+$run_length;
+                    for (;$x < $z; $x++)
                     {
                         $pixel = $this->reader->ReadInt(2);
-                        if($this->encoding == "565")
+                        if ($this->encoding == "565")
                         {
                             $red   = ($pixel & 0xF800) >> 8;
                             $green = ($pixel & 0x07E0) >> 3;
                             $blue  = ($pixel & 0x001F) << 3;
                         }
-                        else if($this->encoding == "555")
+                        else if ($this->encoding == "555")
                         {
                             $red   = ($pixel & 0x7C00) >> 7;
                             $green = ($pixel & 0x03E0) >> 2;
@@ -110,7 +110,7 @@ 
                         imagesetpixel($image, $x, $y, $colour);
                     }
                 }
-                if($x == $this->GetWidth())
+                if ($x == $this->GetWidth())
                     $this->reader->Skip(2);
             }
         }
@@ -127,21 +127,21 @@ 
     public function Encode() {
         $data = '';
         $lineOffsets = array();
-        for($y = 0; $y < $this->GetHeight(); $y++) {
+        for ($y = 0; $y < $this->GetHeight(); $y++) {
             $wasblack = 0;
             $runlength = 0;
-            if($y > 0) {
+            if ($y > 0) {
                 $lineOffsets[] = strlen($data);
             }
             $colourRunData = '';
-            for($x = 0; $x < $this->GetWidth(); $x++) {
+            for ($x = 0; $x < $this->GetWidth(); $x++) {
 
-                $pixel = $this->GetPixel($x,$y);
-                if($pixel['red'] > 255 || $pixel['green'] > 255 || $pixel['blue'] > 255) {
+                $pixel = $this->GetPixel($x, $y);
+                if ($pixel['red'] > 255 || $pixel['green'] > 255 || $pixel['blue'] > 255) {
                     throw new Exception('Pixel colour out of range.');
                 }
                 $newpixel = 0;
-                if($this->encoding == '555') {
+                if ($this->encoding == '555') {
                     $newpixel = (($pixel['red'] << 7) & 0xF800) | (($pixel['green'] << 2) & 0x03E0) | (($pixel['blue'] >> 3) & 0x001F);
                 } else {
                     $newpixel = (($pixel['red'] << 8) & 0xF800) | (($pixel['green'] << 3) & 0x07E0) | (($pixel['blue'] >> 3) & 0x001F);
@@ -149,48 +149,48 @@ 
 
 
                 // if isblack !== wasblack
-                if(($newpixel == 0) !== $wasblack || $runlength > 32766) {
+                if (($newpixel == 0) !== $wasblack || $runlength > 32766) {
                     //end the run if this isn't the first run
-                    if($wasblack !== 0) {
+                    if ($wasblack !== 0) {
 
                         //output data.
                         $run = $runlength << 1;
-                        if($wasblack) {
-                            $data .= pack('v',$run);
+                        if ($wasblack) {
+                            $data .= pack('v', $run);
 
                         } else {
                             $run = $run | 1;
-                            $data .= pack('v',$run);
+                            $data .= pack('v', $run);
                             $data .= $colourRunData;
                             $colourRunData = '';
                         }
                     }
                     //start a new run
-                    if($newpixel == 0) {
+                    if ($newpixel == 0) {
                         $wasblack = true;
                         $colourRunData = '';
                     } else {
                         $wasblack = false;
-                        $colourRunData = pack('v',$newpixel);
+                        $colourRunData = pack('v', $newpixel);
                     }
                     $runlength = 1;
 
                 } else {
-                    if(!$wasblack) {
-                        $colourRunData .= pack('v',$newpixel);
+                    if (!$wasblack) {
+                        $colourRunData .= pack('v', $newpixel);
                     }
                     $runlength++;
                 }
 
-                if($x == ($this->GetWidth()-1)) {
+                if ($x == ($this->GetWidth()-1)) {
                     //end run and output data.
                     $run = $runlength << 1;
-                    if($wasblack) {
-                        $data .= pack('v',$run);
+                    if ($wasblack) {
+                        $data .= pack('v', $run);
 
                     } else {
                         $run = $run | 1;
-                        $data .= pack('v',$run);
+                        $data .= pack('v', $run);
                         $data .= $colourRunData;
                         $colourRunData = '';
                     }

Braces +10 added lines, -10 removed lines

@@ -75,10 +75,11 @@ 
             for($x = 0; $x < $this->GetWidth();)
             {
                 $run = $this->reader->ReadInt(2);
-                if(($run & 0x0001) > 0)
-                    $run_type = "colour";
-                else
-                    $run_type = "black";
+                if(($run & 0x0001) > 0) {
+                                    $run_type = "colour";
+                } else {
+                                    $run_type = "black";
+                }
                 $run_length = ($run & 0x7FFF) >> 1;
                 if($run_type == "black")
                 {
@@ -87,8 +88,7 @@ 
                     {
                         imagesetpixel($image, $x, $y, imagecolorallocate($image, 0, 0, 0));
                     }
-                }
-                else //colour run
+                } else //colour run
                 {
                     $z = $x + $run_length;
                     for(;$x < $z; $x++)
@@ -99,8 +99,7 @@ 
                             $red   = ($pixel & 0xF800) >> 8;
                             $green = ($pixel & 0x07E0) >> 3;
                             $blue  = ($pixel & 0x001F) << 3;
-                        }
-                        else if($this->encoding == "555")
+                        } else if($this->encoding == "555")
                         {
                             $red   = ($pixel & 0x7C00) >> 7;
                             $green = ($pixel & 0x03E0) >> 2;
@@ -110,8 +109,9 @@ 
                         imagesetpixel($image, $x, $y, $colour);
                     }
                 }
-                if($x == $this->GetWidth())
-                    $this->reader->Skip(2);
+                if($x == $this->GetWidth()) {
+                                    $this->reader->Skip(2);
+                }
             }
         }
         $this->gdImage = $image;

sprites/SPRFile.php

Indentation +23 added lines, -23 removed lines

@@ -15,31 +15,31 @@
      * Reads in the IReader and creates SPRFrames as required.
      * @param $reader An IReader to read from.
      */
-	public function SPRFile(IReader $reader) {
-		parent::SpriteFile('SPR');
-		$frameCount = $reader->ReadInt(2);
+    public function SPRFile(IReader $reader) {
+        parent::SpriteFile('SPR');
+        $frameCount = $reader->ReadInt(2);
 		
-		for($i=0;$i<$frameCount;$i++) {
-			$offset = $reader->ReadInt(4);
-			$width = $reader->ReadInt(2);
-			$height = $reader->ReadInt(2);
-			$this->AddFrame(new SPRFrame($reader,$width,$height,$offset));
-		}
-	}
+        for($i=0;$i<$frameCount;$i++) {
+            $offset = $reader->ReadInt(4);
+            $width = $reader->ReadInt(2);
+            $height = $reader->ReadInt(2);
+            $this->AddFrame(new SPRFrame($reader,$width,$height,$offset));
+        }
+    }
 
     /// @brief Compiles the SPR file into a binary string
-	public function Compile() {
-	  $data = pack('v',$this->GetFrameCount());
-	  $offset = 2+(8*$this->GetFrameCount());
-	  foreach($this->GetFrames() as $frame) {
-	    $data .= pack('V',$offset);
-	    $data .= pack('vv',$frame->GetWidth(),$frame->GetHeight());
-	    $offset += $frame->GetWidth()*$frame->GetHeight();
-	  }
-	  foreach($this->GetFrames() as $frame) {
-	    $data .= $frame->Encode();
-	  }
-	  return $data;
-	}
+    public function Compile() {
+        $data = pack('v',$this->GetFrameCount());
+        $offset = 2+(8*$this->GetFrameCount());
+        foreach($this->GetFrames() as $frame) {
+        $data .= pack('V',$offset);
+        $data .= pack('vv',$frame->GetWidth(),$frame->GetHeight());
+        $offset += $frame->GetWidth()*$frame->GetHeight();
+        }
+        foreach($this->GetFrames() as $frame) {
+        $data .= $frame->Encode();
+        }
+        return $data;
+    }
 }
 ?>

Spacing +7 added lines, -7 removed lines

@@ -19,24 +19,24 @@
 		parent::SpriteFile('SPR');
 		$frameCount = $reader->ReadInt(2);
 		
-		for($i=0;$i<$frameCount;$i++) {
+		for ($i = 0; $i < $frameCount; $i++) {
 			$offset = $reader->ReadInt(4);
 			$width = $reader->ReadInt(2);
 			$height = $reader->ReadInt(2);
-			$this->AddFrame(new SPRFrame($reader,$width,$height,$offset));
+			$this->AddFrame(new SPRFrame($reader, $width, $height, $offset));
 		}
 	}
 
     /// @brief Compiles the SPR file into a binary string
 	public function Compile() {
-	  $data = pack('v',$this->GetFrameCount());
+	  $data = pack('v', $this->GetFrameCount());
 	  $offset = 2+(8*$this->GetFrameCount());
-	  foreach($this->GetFrames() as $frame) {
-	    $data .= pack('V',$offset);
-	    $data .= pack('vv',$frame->GetWidth(),$frame->GetHeight());
+	  foreach ($this->GetFrames() as $frame) {
+	    $data .= pack('V', $offset);
+	    $data .= pack('vv', $frame->GetWidth(), $frame->GetHeight());
 	    $offset += $frame->GetWidth()*$frame->GetHeight();
 	  }
-	  foreach($this->GetFrames() as $frame) {
+	  foreach ($this->GetFrames() as $frame) {
 	    $data .= $frame->Encode();
 	  }
 	  return $data;

caos/highlight/CAOSHighlighter.php

Switch Indentation +3 added lines, -3 removed lines

@@ -443,9 +443,9 @@
         case 'untl':
         case 'next':
         case 'ever':
-            case 'repe';
-            $this->currentIndent--;
-            break;
+        case 'repe';
+        $this->currentIndent--;
+        break;
         }
     }
 

Spacing +109 added lines, -109 removed lines

@@ -1,9 +1,9 @@ 
 <?php
 
-define('FORMAT_C1','C1');
-define('FORMAT_C2','C2');
-define('FORMAT_C3','C3');
-define('FORMAT_DS','DS');
+define('FORMAT_C1', 'C1');
+define('FORMAT_C2', 'C2');
+define('FORMAT_C3', 'C3');
+define('FORMAT_DS', 'DS');
 
 
 /// @brief Class for highlighting CAOS 
@@ -63,11 +63,11 @@ 
         require_once(dirname(__FILE__).'/'.$format.'/Operators.php');
 
         //put into arrays
-        $this->caosCommandVariables = call_user_func(array($format.'CAOSCommandVariables','GetTokens'));
-        $this->caosCommands = call_user_func(array($format.'CAOSCommands','GetTokens'));
-        $this->caosVariables = call_user_func(array($format.'CAOSVariables','GetTokens'));
-        $this->caosOperators = call_user_func(array($format.'CAOSOperators','GetTokens'));
-        $this->caosFlowControls = call_user_func(array($format.'CAOSFlowControls','GetTokens'));
+        $this->caosCommandVariables = call_user_func(array($format.'CAOSCommandVariables', 'GetTokens'));
+        $this->caosCommands = call_user_func(array($format.'CAOSCommands', 'GetTokens'));
+        $this->caosVariables = call_user_func(array($format.'CAOSVariables', 'GetTokens'));
+        $this->caosOperators = call_user_func(array($format.'CAOSOperators', 'GetTokens'));
+        $this->caosFlowControls = call_user_func(array($format.'CAOSFlowControls', 'GetTokens'));
     }
 
     /// @brief Highlights the given CAOS script.
@@ -78,21 +78,21 @@ 
      * @param $script the CAOS script as a string.
      */
     public function HighlightScript($script) {
-        if(strpos($script,"\r") !== false) {
-            $script = str_replace("\r\n","\n",$script); //get rid of mac and windows newlines.
-            $script = str_replace("\r","\n",$script);
+        if (strpos($script, "\r") !== false) {
+            $script = str_replace("\r\n", "\n", $script); //get rid of mac and windows newlines.
+            $script = str_replace("\r", "\n", $script);
         }
         //remove tabs and spaces before newlines.
-        $script = str_replace(" \n","\n",$script);
-        $script = str_replace("\t",'',$script);
+        $script = str_replace(" \n", "\n", $script);
+        $script = str_replace("\t", '', $script);
         $script = $this->SmartRemoveMultipleSpaces($script);
-        $this->scriptLines = explode("\n",$script);
+        $this->scriptLines = explode("\n", $script);
 
         //now that we have the lines, we can make the list of subroutines.
         $this->ScanForSubroutines();
         $this->currentLine = 0;
         $this->highlightedLines = array();
-        while(($line = $this->HighlightNextLine()) !== false) {
+        while (($line = $this->HighlightNextLine()) !== false) {
 
             $this->highlightedLines[] = $line;
         }
@@ -111,22 +111,22 @@ 
         $newString = array();
         $inString = false;
         $inComment = false;
-        for($i=0;$i<strlen($text);$i++) {
+        for ($i = 0; $i < strlen($text); $i++) {
             $character = $text{$i};
-            if($character == '"') {
+            if ($character == '"') {
                 $inString = !$inString;
-            } else if($character == '*') {
+            } else if ($character == '*') {
                 $inComment = true;
-            } else if($character == "\n" ) {
+            } else if ($character == "\n") {
                 $inComment = false;
-            } else if(!$inString && !$inComment && $character == ' ') {
-                while($i+2 < strlen($text) && $text{$i+1} == ' ') {
+            } else if (!$inString && !$inComment && $character == ' ') {
+                while ($i+2 < strlen($text) && $text{$i+1} == ' ') {
                     $i++;
                 }
             }
             $newString[] = $character;
         }
-        return trim(implode('',$newString));
+        return trim(implode('', $newString));
     }
 
     /// @endcond
@@ -140,9 +140,9 @@ 
      */
     private function ScanForSubroutines() {
         //expects $scriptLines to be filled out
-        foreach($this->scriptLines as $line) {
-            $words = explode(' ',strtolower($line));
-            if($words[0] == 'subr') {
+        foreach ($this->scriptLines as $line) {
+            $words = explode(' ', strtolower($line));
+            if ($words[0] == 'subr') {
                 $this->scriptSubroutines[] = $words[1];
             }
         }	
@@ -158,20 +158,20 @@ 
      * CAOS highlighted and contains a lot of strange logic.
      */
     private function HighlightNextLine() {
-        if(sizeof($this->scriptLines) <= $this->currentLine) {
+        if (sizeof($this->scriptLines) <= $this->currentLine) {
             return false;
         }
         $line = $this->scriptLines[$this->currentLine];
         //$line = $this->SmartRemoveMultipleSpaces($line);
-        if(strlen($line) == 0 && $this->currentIndent > 0) {
+        if (strlen($line) == 0 && $this->currentIndent > 0) {
             $highlightedLine = $this->CreateIndentForThisLine('')."\n";
             $this->currentLine++;
             return $highlightedLine;
-        } else if(strlen($line) == 0) {
+        } else if (strlen($line) == 0) {
             $this->currentLine++;
             return '';
         }
-        $words = explode(' ',$line);
+        $words = explode(' ', $line);
 
         $this->SetIndentForThisLine($words[0]);
 
@@ -182,83 +182,83 @@ 
         $firstToken = '';
 
         //if last line is a comment and this line starts with scrp set last line's indent to 0 (remove whitespace at front)
-        if(in_array($words[0],array('scrp','rscr'))) {
-            if(!empty($this->scriptLines[$this->currentLine-1])) {
-                if($this->scriptLines[$this->currentLine-1]{0} == '*') {
+        if (in_array($words[0], array('scrp', 'rscr'))) {
+            if (!empty($this->scriptLines[$this->currentLine-1])) {
+                if ($this->scriptLines[$this->currentLine-1]{0} == '*') {
                     $this->highlightedLines[$this->currentLine-1] = ltrim($this->highlightedLines[$this->currentLine-1]);
                 }
             }
         } 
 
-        for($this->currentWord=0;$this->currentWord<sizeof($words);$this->currentWord++) {
+        for ($this->currentWord = 0; $this->currentWord < sizeof($words); $this->currentWord++) {
 
             $word = $words[$this->currentWord];
             $highlightedWord = $word;
-            if($inString) {
-                if($this->currentWord == sizeof($words)-1) {
-                    if(strpos($word,'"') === false) {
+            if ($inString) {
+                if ($this->currentWord == sizeof($words)-1) {
+                    if (strpos($word, '"') === false) {
                         $highlightedWord = htmlentities($word).'</span>';
-                        $highlightedLineBeforeString = substr($highlightedLine,0,$whenStringBegan);
-                        $highlightedLineAfterString = substr($highlightedLine,$whenStringBegan);
+                        $highlightedLineBeforeString = substr($highlightedLine, 0, $whenStringBegan);
+                        $highlightedLineAfterString = substr($highlightedLine, $whenStringBegan);
                         $highlightedLineAfterString .= $highlightedWord;
-                        $highlightedLineAfterString = str_replace('<span class="string">','<span class="error">',$highlightedLineAfterString);
+                        $highlightedLineAfterString = str_replace('<span class="string">', '<span class="error">', $highlightedLineAfterString);
                         $highlightedLine = $highlightedLineBeforeString.$highlightedLineAfterString;
                         $inString = false;
                         continue;
 
                     }
                 }
-                if(($position = strpos($word,'"')) !== false) {
-                    $firstHalf = substr($word,0,$position);
-                    $secondHalf = substr($word,$position+1);
+                if (($position = strpos($word, '"')) !== false) {
+                    $firstHalf = substr($word, 0, $position);
+                    $secondHalf = substr($word, $position+1);
 
                     $highlightedWord = htmlentities($firstHalf).'"</span>'; //end the string
-                    if($secondHalf != '') {
+                    if ($secondHalf != '') {
                         $highlightedWord .= '<span class="error">'.htmlentities($secondHalf).'</span>';
                     }
-                    $inString=false;
+                    $inString = false;
                 } else {
                     $highlightedLine .= $word.' ';
                     continue;					
                 }
-            } else if($inByteString) {
-                if($this->currentWord == sizeof($words)-1) {
-                    if(strpos($word,']') === false) {
+            } else if ($inByteString) {
+                if ($this->currentWord == sizeof($words)-1) {
+                    if (strpos($word, ']') === false) {
                         $highlightedWord = htmlentities($word).'</span>';
-                        $highlightedLineBeforeString = substr($highlightedLine,0,$whenStringBegan);
-                        $highlightedLineAfterString = substr($highlightedLine,$whenStringBegan);
+                        $highlightedLineBeforeString = substr($highlightedLine, 0, $whenStringBegan);
+                        $highlightedLineAfterString = substr($highlightedLine, $whenStringBegan);
                         $highlightedLineAfterString .= $highlightedWord;
-                        $highlightedLineAfterString = str_replace('<span class="bytestring">','<span class="error">',$highlightedLineAfterString);
+                        $highlightedLineAfterString = str_replace('<span class="bytestring">', '<span class="error">', $highlightedLineAfterString);
                         $highlightedLine = $highlightedLineBeforeString.$highlightedLineAfterString;
                         continue;
                     }
                 }
-                if(($position = strpos($word,']')) !== false) {
-                    $firstHalf = substr($word,0,$position);
-                    $secondHalf = substr($word,$position+1);
+                if (($position = strpos($word, ']')) !== false) {
+                    $firstHalf = substr($word, 0, $position);
+                    $secondHalf = substr($word, $position+1);
 
                     $highlightedWord = htmlentities($firstHalf).']</span>'; //end the string
-                    if($secondHalf != '') {
+                    if ($secondHalf != '') {
                         $highlightedWord .= '<span class="error">'.htmlentities($secondHalf).'</span>';
                     }
-                    $inByteString=false;
+                    $inByteString = false;
                 } else {
                     $highlightedLine .= $word.' ';
                     continue;
                 }
-            } else if($firstToken != '') {
+            } else if ($firstToken != '') {
                 //sort out unquoted strings
-                if($this->currentWord == 1) {
-                    if($firstToken == 'subr') {
-                        if(strlen($word) == 4 || $this->scriptFormat != FORMAT_C2) {
+                if ($this->currentWord == 1) {
+                    if ($firstToken == 'subr') {
+                        if (strlen($word) == 4 || $this->scriptFormat != FORMAT_C2) {
                             $highlightedWord = '<span class="label">'.$word.'</span>';
                         } else {
                             $highlightedWord = '<span class="error">'.$word.'</span>';
                         }
-                    } else if($firstToken == 'gsub') {
-                        if(in_array($word,$this->scriptSubroutines)) {
+                    } else if ($firstToken == 'gsub') {
+                        if (in_array($word, $this->scriptSubroutines)) {
                             //C3/DS allow for any length of subroutine name, C2 and C1 probably only allow 4-character names.
-                            if(in_array($this->scriptFormat,array(FORMAT_C3,FORMAT_DS)) || strlen($word) == 4) {
+                            if (in_array($this->scriptFormat, array(FORMAT_C3, FORMAT_DS)) || strlen($word) == 4) {
                                 $highlightedWord = '<span class="label">'.$word.'</span>';
                             } else {
                                 $highlightedWord = '<span class="error">'.$word.'</span>';
@@ -267,29 +267,29 @@ 
                             $highlightedWord = '<span class="error">'.$word.'</span>';
                         }
                     }
-                    if($this->scriptFormat == FORMAT_C2) {
-                        if(in_array(strtolower($firstToken),array('tokn','snde','sndc','sndl','sndq','plbs'))) {
-                            if(strlen($word) == 4) {
+                    if ($this->scriptFormat == FORMAT_C2) {
+                        if (in_array(strtolower($firstToken), array('tokn', 'snde', 'sndc', 'sndl', 'sndq', 'plbs'))) {
+                            if (strlen($word) == 4) {
                                 $highlightedWord = '<span class="string">'.$word.'</span>';
                             } else {
                                 $highlightedWord = '<span class="error">'.$word.'</span>';
                             }
                         }
                     }
-                } else if($this->currentWord == 2) {
-                    if($this->scriptFormat == 'C2') {
-                        if(preg_match('/^new: (scen|simp|cbtn|comp|vhcl|lift|bkbd|cbub)$/i',$firstToken)) {
-                            if(strlen($word) == 4) {
+                } else if ($this->currentWord == 2) {
+                    if ($this->scriptFormat == 'C2') {
+                        if (preg_match('/^new: (scen|simp|cbtn|comp|vhcl|lift|bkbd|cbub)$/i', $firstToken)) {
+                            if (strlen($word) == 4) {
                                 $highlightedWord = '<span class="string">'.$word.'</span>';
                             } else {
                                 $highlightedWord = '<span class="error">'.$word.'</span>';
                             }
                         }
                     }
-                } else if($this->currentWord == sizeof($words)-1) {
-                    if($this->scriptFormat == 'C2') {
-                        if(strtolower($firstToken) == 'rmsc') {
-                            if(strlen($word) == 4) {
+                } else if ($this->currentWord == sizeof($words)-1) {
+                    if ($this->scriptFormat == 'C2') {
+                        if (strtolower($firstToken) == 'rmsc') {
+                            if (strlen($word) == 4) {
                                 $highlightedWord = '<span class="string">'.$word.'</span>';
                             } else {
                                 $highlightedWord = '<span class="error">'.$word.'</span>';
@@ -298,17 +298,17 @@ 
                     }
                 }
             }
-            if($highlightedWord == $word) {
+            if ($highlightedWord == $word) {
                 $highlightedWord = $this->TryToHighlightToken($word);
-                if($this->currentWord == 0) {
+                if ($this->currentWord == 0) {
                     $firstToken = $word;
                 }
                 //Highlight two-word block.
-                if($highlightedWord == $word && $this->currentWord < sizeof($words)-1) {
+                if ($highlightedWord == $word && $this->currentWord < sizeof($words)-1) {
                     $wordPair = $word.' '.$words[$this->currentWord+1];
                     $highlightedWord = $this->TryToHighlightToken($wordPair);
-                    if($highlightedWord != $wordPair) {
-                        if($this->currentWord == 0) {
+                    if ($highlightedWord != $wordPair) {
+                        if ($this->currentWord == 0) {
                             $firstToken = $wordPair;
                         }
                         $this->currentWord++;
@@ -316,46 +316,46 @@ 
                         $highlightedWord = $word;
                     }
                 }
-                if($highlightedWord == $word) { //invalid caos command
-                    if($word{0} == '"' && $this->scriptFormat != FORMAT_C2) { //if it begins a string. (C2 has no strings)
+                if ($highlightedWord == $word) { //invalid caos command
+                    if ($word{0} == '"' && $this->scriptFormat != FORMAT_C2) { //if it begins a string. (C2 has no strings)
                         $whenStringBegan = strlen($highlightedLine);
                         $highlightedWord = '<span class="string">'.htmlentities($word);
-                        if($word{strlen($word)-1} == '"') {
+                        if ($word{strlen($word)-1} == '"') {
                             $highlightedWord .= '</span>'; //end the string
                             $inString = false;
-                        } else if($this->currentWord == sizeof($words)-1) {
+                        } else if ($this->currentWord == sizeof($words)-1) {
                             $highlightedWord = '<span class="error">'.htmlentities($word).'</span>';
                             $inString = false;
                         } else {
                             $inString = true;
                         }
-                    } else if($word{0} == '[') { //begins a bytestring
+                    } else if ($word{0} == '[') { //begins a bytestring
                         $highlightedWord = '<span class="bytestring">'.htmlentities($word);
                         $whenStringBegan = strlen($highlightedLine);
-                        if($this->scriptFormat == 'C2') {
+                        if ($this->scriptFormat == 'C2') {
                             //c2 bytestrings are part of the original term, on they're own they're wrong!
                             $highlightedWord = '<span class="error">'.htmlentities($word);
                         }
-                        if($word{strlen($word)-1} == ']') {
+                        if ($word{strlen($word)-1} == ']') {
                             $highlightedWord .= '</span>';
                             $inByteString = false;
-                        } else if($this->currentWord == sizeof($words)-1) {
+                        } else if ($this->currentWord == sizeof($words)-1) {
                             $highlightedWord = '<span class="error">'.htmlentities($word).'</span>';
                             $inByteString = false;
                         } else {
                             $inByteString = true;
                         }
-                    } else if(is_numeric($word)) {
+                    } else if (is_numeric($word)) {
                         $highlightedWord = '<span class="number">'.htmlentities($word).'</span>';
-                    } else if($word{0} == '*') { // because of SmartRemoveMultipleSpaces, prints exactly as written :)
+                    } else if ($word{0} == '*') { // because of SmartRemoveMultipleSpaces, prints exactly as written :)
                         $highlightedWord = '<span class="comment">';
-                        for($i=$this->currentWord;$i<sizeof($words);$i++)
+                        for ($i = $this->currentWord; $i < sizeof($words); $i++)
                         {
-                            if($i!=$this->currentWord)
+                            if ($i != $this->currentWord)
                             {
-                                $highlightedWord.=' ';
+                                $highlightedWord .= ' ';
                             }
-                            $highlightedWord.= htmlentities($words[$i]);
+                            $highlightedWord .= htmlentities($words[$i]);
                         }
                         $highlightedWord .= '</span>';
                         $highlightedLine .= $highlightedWord;
@@ -387,27 +387,27 @@ 
 
         //first position commands + flow controls only
         //2nd position commands + command variables + variables only.
-        if(in_array($lcword,$this->caosCommands)) {
+        if (in_array($lcword, $this->caosCommands)) {
             $word = '<span class="command">'.htmlentities($word).'</span>';
-        } else if(in_array($lcword,$this->caosVariables)) {
+        } else if (in_array($lcword, $this->caosVariables)) {
             $word = '<span class="variable">'.htmlentities($word).'</span>';
             //vaXX, ovXX
-        } else if(in_array($this->scriptFormat,array('C2','C3','DS')) && preg_match("/^(va|ov)[0-9]{2}$/", $lcword)) {
+        } else if (in_array($this->scriptFormat, array('C2', 'C3', 'DS')) && preg_match("/^(va|ov)[0-9]{2}$/", $lcword)) {
             $word = '<span class="variable">'.htmlentities($word).'</span>';
             //mvXX
-        } else if(in_array($this->scriptFormat,array('C3','DS')) && preg_match('/^(mv)[0-9]{2}$/',$lcword)) {
+        } else if (in_array($this->scriptFormat, array('C3', 'DS')) && preg_match('/^(mv)[0-9]{2}$/', $lcword)) {
             $word = '<span class="variable">'.htmlentities($word).'</span>';
             //obvX
-        } else if(in_array($this->scriptFormat,array('C1','C2')) && preg_match('/^(obv)[0-9]$/',$lcword)) {
+        } else if (in_array($this->scriptFormat, array('C1', 'C2')) && preg_match('/^(obv)[0-9]$/', $lcword)) {
             $word = '<span class="variable">'.htmlentities($word).'</span>';
-        } else if($this->scriptFormat == 'C2' && preg_match('/^([Aa][Nn][Ii][Mm]|[Pp][Rr][Ll][Dd])(\[[0-9]+R?\])$/',$word,$matches)) {
+        } else if ($this->scriptFormat == 'C2' && preg_match('/^([Aa][Nn][Ii][Mm]|[Pp][Rr][Ll][Dd])(\[[0-9]+R?\])$/', $word, $matches)) {
             $word = '<span class="variable">'.strtolower($matches[1]).'</span><span class="bytestring">'.$matches[2].'</span>';
-        } else if(in_array($lcword,$this->caosOperators)) {
+        } else if (in_array($lcword, $this->caosOperators)) {
             $word = '<span class="operator">'.htmlentities($word).'</span>';
-        } else if(in_array($lcword,$this->caosFlowControls)) {
+        } else if (in_array($lcword, $this->caosFlowControls)) {
             $word = '<span class="flowcontrol">'.htmlentities($word).'</span>';
-        } else if(in_array($lcword,$this->caosCommandVariables)) {
-            if($this->currentWord == 0) {
+        } else if (in_array($lcword, $this->caosCommandVariables)) {
+            if ($this->currentWord == 0) {
                 $word = '<span class="command">'.htmlentities($word).'</span>';
             } else {
                 $word = '<span class="variable">'.htmlentities($word).'</span>';
@@ -426,7 +426,7 @@ 
      * @param $firstword The first word of the line
      */
     private function SetIndentForThisLine($firstword) {
-        switch($firstword) {
+        switch ($firstword) {
         case 'scrp':
         case 'endm':
         case 'rscr':
@@ -456,7 +456,7 @@ 
      * Sets the indent for the next line
      */
     private function SetIndentForNextLine($firstword) {
-        switch($firstword) {
+        switch ($firstword) {
         case 'scrp':
         case 'rscr':
         case 'iscr':
@@ -490,14 +490,14 @@ 
      */
     private function CreateIndentForThisLine($firstword) {
         $indent = '';
-        if(in_array($firstword,array('scrp','rscr'))) {
-            if(!empty($this->previousLineCode)) {
-                if($this->previousLineCode{0} != '*') {
+        if (in_array($firstword, array('scrp', 'rscr'))) {
+            if (!empty($this->previousLineCode)) {
+                if ($this->previousLineCode{0} != '*') {
                     $indent = "\n";
                 }
             }
         }
-        for($i=0;$i<$this->currentIndent;$i++) {
+        for ($i = 0; $i < $this->currentIndent; $i++) {
             $indent .= "\t";
         }
         return $indent;

caos/highlight/DS/CommandVariables.php

Indentation +72 added lines, -72 removed lines

@@ -5,93 +5,93 @@
 /// @brief DS CAOS dictionary of tokens that can act like commands or variables
 class DSCAOSCommandVariables {
     /// @brief Returns an array of tokens.
-	public static function GetTokens() {
-		return array(
-			'attr',
-			'base',
-			'bhvr',
-			'clik', //I have no experience using this, but I think this is right.
-			'gall',
-			'hand',
-			'mira',
-			'paus',
-			'plne',
-			'pose',
-			'rnge',
-			'targ',
-			'tick',
+    public static function GetTokens() {
+        return array(
+            'attr',
+            'base',
+            'bhvr',
+            'clik', //I have no experience using this, but I think this is right.
+            'gall',
+            'hand',
+            'mira',
+            'paus',
+            'plne',
+            'pose',
+            'rnge',
+            'targ',
+            'tick',
 		
-			//camera
-			'meta',
-			'trck',
-			'wdow',
+            //camera
+            'meta',
+            'trck',
+            'wdow',
 		
-			//compound
-			'page',
-			'ptxt',
+            //compound
+            'page',
+            'ptxt',
 		
-			//creatures
-			'aslp',
-			'dead',
-			'dirn',
-			'drea',
-			'face',
-			'ins#',
-			'mind',
-			'motr',
-			'norn',
-			'uncs',
-			'zomb',
+            //creatures
+            'aslp',
+            'dead',
+            'dirn',
+            'drea',
+            'face',
+            'ins#',
+            'mind',
+            'motr',
+            'norn',
+            'uncs',
+            'zomb',
 		
-			//files
+            //files
 			
-			//input
-			'pure',
+            //input
+            'pure',
 		
-			//map
-			'perm',
+            //map
+            'perm',
 			
-			//motion
-			'accg',
-			'admp',
-			'aero',
-			'avel',
-			'elas',
-			'fdmp',
-			'fric',
-			'fvel',
-			'sdmp',
-			'spin',
-			'svel',
-			'varc',
+            //motion
+            'accg',
+            'admp',
+            'aero',
+            'avel',
+            'elas',
+            'fdmp',
+            'fric',
+            'fvel',
+            'sdmp',
+            'spin',
+            'svel',
+            'varc',
 			
-			//ports
+            //ports
 			
-			//resources
+            //resources
 			
-			//caos
+            //caos
 			
-			//sounds
-			'vois',
+            //sounds
+            'vois',
 			
-			//time
-			'buzz',
-			'wpau',
-			'targ',
+            //time
+            'buzz',
+            'wpau',
+            'targ',
 			
-			//vehicles
-			'cabp',
-			'cabv',
+            //vehicles
+            'cabp',
+            'cabv',
 			
-			//world
-			'delw',
-			'load',
+            //world
+            'delw',
+            'load',
 		
-			//net
-			'net: line',
-			'net: pass'
-		);
-	}
+            //net
+            'net: line',
+            'net: pass'
+        );
+    }
 }
 
 /// @endcond