Update README, fix -f, tidy up

Author: supposedly

README.md

@@ -1,5 +1,5 @@
 # rueltabel
-A compiler for a reimagined Golly ruletable language to the traditional format. See [`examples/`](/examples) for examples.
+A transpiler from a reimagined Golly ruletable language to the traditional format. See [`examples/`](/examples) for examples.
 
 ## Setup
 
@@ -15,8 +15,18 @@ A compiler for a reimagined Golly ruletable language to the traditional format.
 $ python to_ruletable.py [infile] [outdir] [flags...]
 ```
 The output file will be written to `outdir` with a .rule extension and the same filename as `infile`.  
-Currently, the only supported flag is `-v` (`--verbose`), which will cause more info to be printed the
-more it is repeated (up to three repetitions).
+Supported flags:
+  - `-v`: Verbose. Can be repeated up to four times, causing more info to be displayed each time.
+  - `-t [HEADER]`: Change the "COMPILED FROM RUELTABEL" header that is added by default to transpiled
+                   rules. (If `-t` is given no argument the header will be removed)
+  - `-f TRANSITION`: Find a certain transition defined within a tabel section; requires, of course, that
+                     the rule have a `@TABEL` section to search within. Makes it so that, if a certain
+                     cell isn't behaving the way it's supposed to, you can `-f` the transition it's
+                     undergoing and the script will find the offending transition for you (instead of
+                     making you guess at what you typo'd).  
+                     Transition should be given in the standard Golly form `C,N,...,C'` -- that is, state of the
+                     current center cell, then its neighborhood, and finally the state it transitions into
+                     on the next tick. Example [here](https://user-images.githubusercontent.com/32081933/39951382-2b37fca0-553e-11e8-87b5-69685dfe4881.png)!  
 
 ## Spec
 - All variables unbound by default, because needing to define eight "any state" vars is ridiculous.
@@ -104,6 +114,19 @@ foo, N..NW bar, baz -> S:2 E[(2, 3)] SE[wutz] N[NE: (2, 3)] NE[E]
 - Support switching symmetries partway through via the `symmetries:` directive. (When parsing, this results in all transitions being expanded to the 'lowest'
 symmetry type specified overall.)
 
+## Non-table-related changes
+- The `@COLORS` segment in a ruelfile allows multiple states with the same color to be defined as such
+  on the same line as each other, and for colors to be written as either base-10 `R G B` values or as
+  hexadecimal color codes. `1 10: FFF`, for instance, says to assign the color `#FFFFFF` to states 1 and
+  10, and can also be written as `1 10: FFFFFF` or `1 10: 255 255 255` (or as two separate lines, although
+  the colon is still mandatory). Comments in this segment start with `#` and go until the end of their line.
+- The `@ICONS` segment uses an ad-hoc RLE syntax instead of Gollyesque XPM data. See [this post](http://conwaylife.com/forums/viewtopic.php?f=7&t=3361&p=59944#p59944)
+  for an explanation + example.
+- **All segments are optional**. The parser will also transcribe unidentified segments as is, meaning that
+  a file can have a `@TABLE` segment (under which the normal Golly ruletable language is used) rather than
+  `@TABEL` and it will not be modified by the parser.
+- Specially-treated ruel segments whose names are not respellings, like `@ICONS` and `@COLORS`, will still be
+  ignored by the parser if their header is immediately followed by the comment `#golly`, either on the same line (after whitespace) or on the line immediately below.
 
 ## To do
 - DOCS! Or at least a proper introductory writeup.

examples/compiled_ruletables/bct.rule

@@ -70,11 +70,11 @@ var any_7 = any_0
 
 var live_0 = {1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17}
 
-var _233626425726624_0 = {14, 15}
+var _149636772488731_0 = {14, 15}
 
-var _227631875077152_0 = {3, 4}
+var _764365149070759_0 = {3, 4}
 
-var _328669587150795_0 = {10, 11}
+var _945675959837757_0 = {10, 11}
 
 vacddata_0, 1, any_0, any_1, any_2, any_3, any_4, any_5, 5, 16
 vacddata_0, 2, any_0, any_1, any_2, any_3, any_4, any_5, 5, 17
@@ -87,7 +87,7 @@ vacrdata_0, any_0, any_1, any_2, any_3, any_4, any_5, rdata_0, any_6, rdata_0
 rdata_0, any_0, any_1, any_2, any_3, any_4, any_5, 0, any_6, 0
 0, 5, any_0, any_1, any_2, any_3, any_4, 0, rdata_0, 14
 0, 5, data_0, 0, any_0, any_1, any_2, any_3, any_4, 14
-_233626425726624_0, any_0, any_1, any_2, any_3, any_4, any_5, any_6, any_7, 0
+_149636772488731_0, any_0, any_1, any_2, any_3, any_4, any_5, any_6, any_7, 0
 any_0, 14, any_1, any_2, __all__0, __all__1, __all__2, any_3, any_4, 15
 any_0, 15, any_1, any_2, __all__0, __all__1, __all__2, any_3, any_4, 5
 5, 0, 0, 0, ddata_0, 0, 0, 0, 0, 0
@@ -106,7 +106,7 @@ data_0, any_0, any_1, 5, any_2, any_3, any_4, any_5, any_6, 0
 0, 8, any_0, any_1, __all__0, __all__1, __all__2, any_2, any_3, 10
 9, any_0, any_1, any_2, any_3, any_4, any_5, any_6, any_7, 2
 0, 9, any_0, any_1, __all__0, __all__1, __all__2, any_2, any_3, 11
-_328669587150795_0, any_0, any_1, any_2, any_3, any_4, any_5, any_6, any_7, 0
+_945675959837757_0, any_0, any_1, any_2, any_3, any_4, any_5, any_6, any_7, 0
 any_0, 10, any_1, any_2, __all__0, __all__1, __all__2, any_3, any_4, 3
 any_0, 11, any_1, any_2, __all__0, __all__1, __all__2, any_3, any_4, 4
 data_0, any_0, any_1, 0, any_2, data_1, any_3, any_4, any_5, data_1
@@ -123,14 +123,14 @@ vacdata_0, any_0, any_1, vacdata_1, any_2, any_3, any_4, any_5, any_6, vacdata_1
 
 
 @COLORS
-1  235 235 235  lighter gray
-2   30  30  30  darker gray
-12 235 235 235  lighter gray
-13  30  30  30  darker gray
-16 235 235 235  lighter gray
-17  30  30  30  darker gray
-3  200 200 200  light gray
-4   90  90  90  dark gray
-5    0 255 255  cyan
-14   0 255 255  cyan
-15   0 255 255  cyan
+3 200 200 200
+4 90 90 90
+1 235 235 235
+12 235 235 235
+16 235 235 235
+2 30 30 30
+13 30 30 30
+17 30 30 30
+5 0 255 255
+14 0 255 255
+15 0 255 255

examples/rueltabels/Simpl.ruel

@@ -42,16 +42,16 @@ off = {0..10}
 
 
 @COLORS
-0: 808080
-1: 000
-2: 6E0000
-3: 6E4800
-4: 486E00
-5: 006E00
-6: 006E48
-7: 00486E
-8: 00006E
-9: 48006E
+ 0: 808080
+ 1: 000
+ 2: 6E0000
+ 3: 6E4800
+ 4: 486E00
+ 5: 006E00
+ 6: 006E48
+ 7: 00486E
+ 8: 00006E
+ 9: 48006E
 10: 6E0048
 11: FFC8C8
 12: FFECC8

examples/rueltabels/bct.ruel

@@ -1,5 +1,4 @@
 @RUEL bct
-
 An implementation of bitwise cyclic tag.
 
 state 0: Vacuum.
@@ -12,8 +11,6 @@ state 4: Program-tape 1.
 
 state 5: Shifter. Moves both itself and the data tape one unit down to render program execution cyclic.
 
-
-
 state 6: Transitory program-tape 0.
 state 7: Transitory program-tape 1.
 
@@ -32,31 +29,27 @@ state 15: Ditto but about to turn into normal reflector.
 state 16: To-be-moved-down data-tape 0.
 state 17: To-be-moved-down data-tape 1.
 
-@COLORS: golly
-1  235 235 235  lighter gray
-2   30  30  30  darker gray
-12 235 235 235  lighter gray
-13  30  30  30  darker gray
-16 235 235 235  lighter gray
-17  30  30  30  darker gray
-3  200 200 200  light gray
-4   90  90  90  dark gray
-5    0 255 255  cyan
-14   0 255 255  cyan
-15   0 255 255  cyan
+@COLORS
+      3: C8C8C8  # light gray
+      4: 5A5A5A  # dark gray
+1 12 16: EBEBEB  # lighter gray
+2 13 17: 1E1E1E  # darker gray
+5 14 15: 00FFFF  # cyan
 
 @TABEL
 states: 18
 neighborhood: Moore
 symmetries: none
 
+
 data = {1, 2}
 rdata = {12, 13}
 ddata = {16, 17}
-vacdata = {0, 1, 2}
+vacdata = {0..2}
 vacrdata = {0, 12, 13}
 vacddata = {0, 16, 17}
 
+
 # If a shifter is encountered, reflect + shift data tape down 2 cell
 # go right
 vacddata, (1, 2), NE..W any, 5, [N: (16, 17)]
@@ -72,20 +65,20 @@ rdata, any, any, any, any, any, any, 0, any, 0
 
 # shift the shifter down two as well
 # right
-0, 5, any, any, any, any, any, 0, rdata, 14
+0, 5, NE..SW any, 0, rdata, 14
 # left
-0, 5, data, 0, any, any, any, any, any, 14
+0, 5, data, 0, SE..NW any, 14
 # finally
 (14, 15), N..NW any, 0 -> S[0: (15, 5)]
 # delete shifter at end of its input stream
-5, 0, 0, 0, ddata, 0, 0, 0, 0, 0
-5, 0, 0, 0, 0, 0, data, 0, 0, 0
+5, N..E 0, SE ddata, S..NW 0, 0
+5, N..S 0, data, 0, 0, 0
 
 # Shift prgm tape down 1 if rightward data above it
 (3, 4), rdata, NE..NW any, [0: (10, 11)]
 
 # If a data bit has a shifter to its right, don't attempt to copy it
-data, any, any, 5, any, any, any, any, any, 0
+data, N..NE any, E 5, SE..NW any, 0
 
 # If a prgm-tape 1 is encountered, shift it downward
 # and append the command to its left (by copying+shifting down) onto the right end of the data tape, 

magic/segment_types/icons.py

@@ -23,6 +23,12 @@ def lazylen(iterable):
     return sum(1 for _ in iterable)
 
 
+def maybe_double(symbol: str):
+    if len(symbol.encode()) < 2:
+        return symbol * 2
+    return symbol
+
+
 class Icon:
     HEIGHT = None
     _FILL = None
@@ -34,7 +40,7 @@ def __init__(self, rle):
         self._FILL = ['..' * self.HEIGHT]
         self._rle = rle
         self._split =''.join(
-          (val * 2 if len(val.encode()) < 2 else val) * int(run_length or 1)
+          maybe_double(val) * int(run_length or 1)
           for run_length, val in
             self._rRUNS.findall(self._rle)
           ).split('$$')
@@ -50,9 +56,7 @@ def set_height(cls, dims):
 
     @classmethod
     def solid_color(cls, color):
-        if len(color.encode()) < 2:
-            color *= 2
-        return [color * cls.HEIGHT] * cls.HEIGHT
+        return [maybe_double(color) * cls.HEIGHT] * cls.HEIGHT
 
     def _pad(self):
         # Horizontal padding
@@ -87,13 +91,15 @@ def __iter__(self):
         # /* width height num_colors chars_per_pixel */
         yield f'"{Icon.HEIGHT} {len(self.icons)*Icon.HEIGHT} {len(self.colormap)} 2"'
         # /* colors */
-        yield from (f'"{(symbol * 2 if len(symbol.encode()) < 2 else symbol)} c #{color}"' for symbol, color in self.colormap.items())
+        yield from (f'"{maybe_double(symbol)} c #{color}"' for symbol, color in self.colormap.items())
         # /* icons */
         yield from (f'"{line}"' for icon in (self.icons[key] for key in sorted(self.icons)) for line in icon)
 
-    @staticmethod
-    def _make_name():
-        return ''.join(random.sample(SAFE_CHARS, 2))
+    def _make_color_symbol(self):
+        name = ''.join(random.sample(SAFE_CHARS, 2))
+        while name in self.colormap.values():
+            name = ''.join(random.sample(SAFE_CHARS, 2))
+        return name
 
     def _parse_colors(self, start=0):
         lno, colormap = start, {}
@@ -106,7 +112,7 @@ def _parse_colors(self, start=0):
             state, color = match.groups()
             if len(color) < 6:
                 color *= 2
-            colormap[SYMBOL_MAP[int(state)] if state.isdigit() else state * 2 if len(state.encode()) < 2 else state] = color.upper()
+            colormap[SYMBOL_MAP[int(state)] if state.isdigit() else maybe_double(state)] = color.upper()
         return colormap, lno
 
     def _sep_states(self, start) -> dict:
@@ -131,9 +137,6 @@ def _fill_missing_states(self):
                 color = self._parsed_color_segment[state]
             except KeyError:
                 raise TabelReferenceError(self._start, f'No @ICONS-defined icon (and, subsequently, no substitute @COLORS-defined fill color) found for state {state}')
-            _name = self._make_name()
-            while _name in self.colormap.values():
-                _name = self._make_name()
-            symbol = _colormap_inv.get(color, _name)
+            symbol = _colormap_inv.get(color, self._make_color_symbol())
             self.colormap[symbol] = color
-            self.icons[state] = Icon.solid_color(symbol)
+            self.icons[state] = list(Icon.solid_color(symbol))

magic/segment_types/table.py

@@ -115,13 +115,14 @@ def match(self, tr):
           for lno, tr in self.transitions
           )
         for idx, (lno, tr) in _trs_no_names:
-            for in_state, tr_state in (zip(in_tr, tr) for in_tr in ((start, *napkin, end) for napkin in in_napkins.expand())):
-                while isinstance(tr_state, str):
-                    tr_state = tr[int(tr_state)]
-                if not (in_state == tr_state if isinstance(tr_state, int) else in_state in tr_state):
-                    break
-            else:
-                return f'Found!\n\nLine {1+self._start+lno}: "{self[lno]}"\n(compiled line "{", ".join(map(str, self.transitions[idx][1]))}")\n'
+            for in_tr in ((start, *napkin, end) for napkin in in_napkins.expand()):
+                for in_state, tr_state in zip(in_tr, tr):
+                    while isinstance(tr_state, str):  # binding
+                        tr_state = tr[int(tr_state)]
+                    if not (in_state == tr_state if isinstance(tr_state, int) else in_state in tr_state):
+                        break
+                else:
+                    return f'Found!\n\nLine {1+self._start+lno}: "{self._tbl[lno]}"\n(compiled line "{", ".join(map(str, self.transitions[idx][1]))}")\n'
         return None
 
     def _cardinal_sub(self, match):