From e2dcac2bf48a9615e64ca61d4dd4ac4a44be8be9 Mon Sep 17 00:00:00 2001
From: Dustin Wilson <dustin@dustinwilson.com>
Date: Fri, 25 Jun 2021 10:46:26 -0500
Subject: [PATCH] Changed Project name to Fukkus

---
 README                               |  7 +++++++
 lib/Grammar/Data.php                 | 27 +++++++++++++++++++++++++++
 lib/Grammar/Registry.php             |  4 ++--
 lib/Grammar/Tokenizer.php            |  9 +++++++++
 lib/Highlighter.php                  | 14 ++++++++++++++
 lib/Scope/Data.php                   |  2 +-
 lib/Scope/Exception.php              |  6 ++++--
 lib/Scope/Matcher.php                |  2 +-
 lib/Scope/Matchers/AndMatcher.php    |  2 +-
 lib/Scope/Matchers/GroupMatcher.php  |  2 +-
 lib/Scope/Matchers/NegateMatcher.php |  2 +-
 lib/Scope/Matchers/OrMatcher.php     |  2 +-
 lib/Scope/Matchers/PathMatcher.php   |  2 +-
 lib/Scope/Matchers/ScopeMatcher.php  |  2 +-
 lib/Scope/Parser.php                 |  2 +-
 15 files changed, 72 insertions(+), 13 deletions(-)
 create mode 100644 README
 create mode 100644 lib/Grammar/Data.php
 create mode 100644 lib/Grammar/Tokenizer.php
 create mode 100644 lib/Highlighter.php

diff --git a/README b/README
new file mode 100644
index 0000000..a0241b7
--- /dev/null
+++ b/README
@@ -0,0 +1,7 @@
+[a]: https://atom.io
+[b]: https://github.com/atom/highlights
+[c]: https://macromates.com
+
+# Fukkus #
+
+Fukkus is a multilanguage syntax highlighter written in PHP. It takes code as input and returns HTML with classes based upon tokens in the code. It is loosely based upon [Atom][a]'s [Highlights][b] which is used in the Atom text editor to syntax highlight code. Atom's Highlights is in turn based upon [TextMate][c]'s syntax highlighting using its concepts of scope selectors and common classes for components of programming languages.
\ No newline at end of file
diff --git a/lib/Grammar/Data.php b/lib/Grammar/Data.php
new file mode 100644
index 0000000..ae0ad78
--- /dev/null
+++ b/lib/Grammar/Data.php
@@ -0,0 +1,27 @@
+<?php
+/** @license MIT
+ * Copyright 2021 Dustin Wilson et al.
+ * See LICENSE and AUTHORS files for details */
+
+declare(strict_types=1);
+namespace dW\Fukkus\Grammar;
+
+class Data {
+    public static function withFile(string $filepath): \Generator {
+        $fp = fopen($filepath, 'r');
+        try {
+            while ($line = fgets($fp)) {
+                yield $line;
+            }
+        } finally {
+            fclose($fp);
+        }
+    }
+
+    public static function withString(string $data): \Generator {
+        $data = explode("\n", $data);
+        foreach ($data as $d) {
+            yield $d;
+        }
+    }
+}
\ No newline at end of file
diff --git a/lib/Grammar/Registry.php b/lib/Grammar/Registry.php
index 3371cc5..cc5b8c5 100644
--- a/lib/Grammar/Registry.php
+++ b/lib/Grammar/Registry.php
@@ -4,7 +4,7 @@
  * See LICENSE and AUTHORS files for details */
 
 declare(strict_types=1);
-namespace dW\Highlighter\Grammar;
+namespace dW\Fukkus\Grammar;
 
 class Registry {
     protected static array $grammars = [];
@@ -49,7 +49,7 @@ class Registry {
         }
 
         if (!$force && isset(self::$grammars[$grammar['scopeName']])) {
-            throw new \Exception("Grammar \"{$grammar['scopeName']}\" already exists.");
+            throw new \Exception("Grammar with the \"{$grammar['scopeName']}\" scope already exists.");
         }
 
         self::$grammars[$grammar['scopeName']] = $grammar;
diff --git a/lib/Grammar/Tokenizer.php b/lib/Grammar/Tokenizer.php
new file mode 100644
index 0000000..1bbec56
--- /dev/null
+++ b/lib/Grammar/Tokenizer.php
@@ -0,0 +1,9 @@
+<?php
+/** @license MIT
+ * Copyright 2021 Dustin Wilson et al.
+ * See LICENSE and AUTHORS files for details */
+
+declare(strict_types=1);
+namespace dW\Fukkus\Grammar;
+
+class Tokenizer {}
\ No newline at end of file
diff --git a/lib/Highlighter.php b/lib/Highlighter.php
new file mode 100644
index 0000000..99dd436
--- /dev/null
+++ b/lib/Highlighter.php
@@ -0,0 +1,14 @@
+<?php
+/** @license MIT
+ * Copyright 2021 Dustin Wilson et al.
+ * See LICENSE and AUTHORS files for details */
+
+declare(strict_types=1);
+namespace dW\Fukkus;
+
+class Highlighter {
+    public static function highlightString(string $string): string {
+        $data = Grammar\Data::fromString($string);
+
+    }
+}
\ No newline at end of file
diff --git a/lib/Scope/Data.php b/lib/Scope/Data.php
index f146ec3..392cd87 100644
--- a/lib/Scope/Data.php
+++ b/lib/Scope/Data.php
@@ -4,7 +4,7 @@
  * See LICENSE and AUTHORS files for details */
 
 declare(strict_types=1);
-namespace dW\Highlighter\Scope;
+namespace dW\Fukkus\Scope;
 
 /**
  * Tokenizes scope strings into an array of segments of the original string and
diff --git a/lib/Scope/Exception.php b/lib/Scope/Exception.php
index ad55331..468d670 100644
--- a/lib/Scope/Exception.php
+++ b/lib/Scope/Exception.php
@@ -4,10 +4,10 @@
  * See LICENSE and AUTHORS files for details */
 
 declare(strict_types=1);
-namespace dW\Highlighter\Scope;
+namespace dW\Fukkus\Scope;
 
 class Exception extends \Exception {
-    const MESSAGE = '%s expected; found %s at offset %s';
+    const MESSAGE = "%s expected; found %s at offset %s\n";
 
     public function __construct(array|string $expected, string|bool $found, int $offset) {
         if (!is_string($expected)) {
@@ -28,6 +28,8 @@ class Exception extends \Exception {
                     $expected = implode(' or ', $expected);
                 }
             }
+        } else {
+            $expected = ($expected !== false) ? $expected : 'end of input';
         }
 
         $found = ($found !== false) ? "\"$found\"" : 'end of input';
diff --git a/lib/Scope/Matcher.php b/lib/Scope/Matcher.php
index de2d285..81f68a7 100644
--- a/lib/Scope/Matcher.php
+++ b/lib/Scope/Matcher.php
@@ -4,6 +4,6 @@
  * See LICENSE and AUTHORS files for details */
 
 declare(strict_types=1);
-namespace dW\Highlighter\Scope;
+namespace dW\Fukkus\Scope;
 
 abstract class Matcher {}
\ No newline at end of file
diff --git a/lib/Scope/Matchers/AndMatcher.php b/lib/Scope/Matchers/AndMatcher.php
index 3d45309..c2def6d 100644
--- a/lib/Scope/Matchers/AndMatcher.php
+++ b/lib/Scope/Matchers/AndMatcher.php
@@ -4,7 +4,7 @@
  * See LICENSE and AUTHORS files for details */
 
 declare(strict_types=1);
-namespace dW\Highlighter\Scope;
+namespace dW\Fukkus\Scope;
 
 class AndMatcher extends Matcher {
     protected array $matchers = [];
diff --git a/lib/Scope/Matchers/GroupMatcher.php b/lib/Scope/Matchers/GroupMatcher.php
index 5e28e83..2b17e0d 100644
--- a/lib/Scope/Matchers/GroupMatcher.php
+++ b/lib/Scope/Matchers/GroupMatcher.php
@@ -4,7 +4,7 @@
  * See LICENSE and AUTHORS files for details */
 
 declare(strict_types=1);
-namespace dW\Highlighter\Scope;
+namespace dW\Fukkus\Scope;
 
 class GroupMatcher extends Matcher {
     protected string|null $prefix;
diff --git a/lib/Scope/Matchers/NegateMatcher.php b/lib/Scope/Matchers/NegateMatcher.php
index dfe28b9..144e5de 100644
--- a/lib/Scope/Matchers/NegateMatcher.php
+++ b/lib/Scope/Matchers/NegateMatcher.php
@@ -4,7 +4,7 @@
  * See LICENSE and AUTHORS files for details */
 
 declare(strict_types=1);
-namespace dW\Highlighter\Scope;
+namespace dW\Fukkus\Scope;
 
 class NegateMatcher extends Matcher {
     protected Matcher $matcher;
diff --git a/lib/Scope/Matchers/OrMatcher.php b/lib/Scope/Matchers/OrMatcher.php
index 810b6f1..0be6115 100644
--- a/lib/Scope/Matchers/OrMatcher.php
+++ b/lib/Scope/Matchers/OrMatcher.php
@@ -4,7 +4,7 @@
  * See LICENSE and AUTHORS files for details */
 
 declare(strict_types=1);
-namespace dW\Highlighter\Scope;
+namespace dW\Fukkus\Scope;
 
 class OrMatcher extends Matcher {
     protected array $matchers = [];
diff --git a/lib/Scope/Matchers/PathMatcher.php b/lib/Scope/Matchers/PathMatcher.php
index 7f6763b..b490610 100644
--- a/lib/Scope/Matchers/PathMatcher.php
+++ b/lib/Scope/Matchers/PathMatcher.php
@@ -4,7 +4,7 @@
  * See LICENSE and AUTHORS files for details */
 
 declare(strict_types=1);
-namespace dW\Highlighter\Scope;
+namespace dW\Fukkus\Scope;
 
 class PathMatcher extends Matcher {
     protected string|null $prefix;
diff --git a/lib/Scope/Matchers/ScopeMatcher.php b/lib/Scope/Matchers/ScopeMatcher.php
index fe08f8b..d6a4ab6 100644
--- a/lib/Scope/Matchers/ScopeMatcher.php
+++ b/lib/Scope/Matchers/ScopeMatcher.php
@@ -4,7 +4,7 @@
  * See LICENSE and AUTHORS files for details */
 
 declare(strict_types=1);
-namespace dW\Highlighter\Scope;
+namespace dW\Fukkus\Scope;
 
 class ScopeMatcher extends Matcher {
     protected array $segments;
diff --git a/lib/Scope/Parser.php b/lib/Scope/Parser.php
index 10fa677..ec56c63 100644
--- a/lib/Scope/Parser.php
+++ b/lib/Scope/Parser.php
@@ -4,7 +4,7 @@
  * See LICENSE and AUTHORS files for details */
 
 declare(strict_types=1);
-namespace dW\Highlighter\Scope;
+namespace dW\Fukkus\Scope;
 
 /** Parses scope strings into a matcher tree */
 class Parser {