MIT => GPL, full repo restructure & code refactor => modular languages

Author: petervaro

.gitignore

@@ -1,7 +1,19 @@
-*.pyc
 *.DS_Store
+*.pyc
+*.pyo
+*.sublime-workspace
+*.sublime-project
+*.idraw
+
 __old__.json
 __old__.xml
-*.pyo
 
-*.idraw
+.ccom_cache
+.clic_cache
+.cdoc_cache
+
+.ccom_todo
+.cdoc_toc
+
+build
+readme.html

Gloom/LICENSE

@@ -0,0 +1,25 @@
+#format CENTER 80
+
+Python and Cython Syntax Highlighters
+=====================================
+
+Version: {VERSION}
+File: {FILE}
+
+For more information about the project, please visit
+<https://github.com/petervaro/python>.
+Copyright (C) 2013 - 2014 Peter Varo
+
+This program is free software: you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program, most likely a file in the root directory,
+called 'LICENSE'. If not, see <http://www.gnu.org/licenses>.

INFO

@@ -1,83 +1,99 @@
 # Python and Cython language bundles
 
-This repo is about Python 3.3+ and Cython 0.19.1+ related bundles for Sublime
+***THE MOST POPULAR (AND FEATURE RICH) PYTHON SYNTAX HIGHLIGHTER FOR SUBLIME
+(OVER 11,000 DOWNLOADS!)***
+
+This repo is about python 3.3+ and cython 0.19.1+ related bundles for Sublime
 Text 2/3 and TextMate editors and for online usage.
 
-![Preview](preview.png)
+![Preview](img/preview.png)
 
 ### Python 3.3
 
 Python 3.3 is a truly powerful version of python, with a lot new and creative
 features -- and some of them are actually bringing new or different syntaxes!
-Sadly, the only available `tmLanguage` and still popular syntax-highlight
-definition file is pretty old (only supports 2.x) and has some annoying bugs --
-and because of that, the syntax of these new features brake the full highlighting
-of the code, not to mention the lack of new built-in keywords and notations and
-extra unused one.
-
-I do belive, that a good syntax highlighter for software developers has to be as
-much help as an auto-complete popup or a code linter script in a text editor.
-
-That's why I implemented a new syntax definition, started from scratch and
-created especially for Python 3.3 and above. I did this with a python
-dictionary plus a little converter script and not in `JSON` (ugly double escape
-characters -- *Ouch!*) nor in `XML`/`tmLanguage` (com'n is there anyone, who
-likes to read-and-write these?). The result is a dynamic, reuseable, easy to read
-and write (syntax highlighted regexes -- with comments and variables!) and
-maintain and pretty short (old: 3331 lines, new: 1226 lines) syntax definition file!
+Unfortunately, the only available and default `tmLanguage` syntax-highlight
+definition file is pretty old (only supports 2.x) and has several annoying bugs
+and unfinished features -- not to mention, that the syntax of the new python
+features brake the full highlighting of the entire code.
+
+I belive, that a good syntax highlighter for software developers has to be as
+much help as the auto-completion pop-up or a code linter script in a text
+editor.
+
+That's why I have implemented a new syntax definition from scratch that is
+created especially for python 3.3 and above. I did this with a python
+structures, converters and buiuld scripts. *(I found editing `JSON` files with
+their ugly double escape characters or editing `XML`/`tmLanguage`s directly
+pretty annoying.)*
+
+The end result is very flexible, dynamic, reuseable and easy to read and write
+(syntax highlighted regexes -- with comments and variables). It is also simple
+to maintain and pretty short too (the new version is only 35% of the old one)!
 
 ### Cython support
 
-Unfortunately cython syntax highlighter definitions are also lack of updated,
-fully working and 100% python compatible syntax definitions! I created a brand
-new highlighter from scartch, based on the new Python one, but one of the future
-plans is to make this dictionary an addition/extended version of it, so the
-changes will automatically updated in both language files.
+Unfortunately cython syntax highlighter definitions also lack of updated,
+fully-working and 100% python compatible syntax definitions! I have created a
+brand-new build-system to combine and convert the highlighter based on the
+python one. With this tool, it is quite easy to keep up-to-date both the cython
+and the python definitions, and as a plus, I only have to maintain a single
+code-base. *Viva la* modularity!
 
 ### Highlight on web
 
 ***WORK IN PROGRESS***
 
-After used to the syntax highlight in the text editor, sharing the code online
-with the same colors and highlights is evident! Thanks to Craig Campbell and his
-amazing [`Rainbow.js`](http://craig.is/making/rainbows/) it is also possible!
+Previously I wanted to support [`Rainbow.js`](http://craig.is/making/rainbows),
+but unfortunately this project hasn't been updated for almost a year now, it
+also has several very important, pending, open issues and without these the
+proper "translation" from my syntax highlighters to a Rainbow one is impossible.
+
+Thankfully, there is a new, and very actively developed tool, called the
+[Ace Editor](http://ace.c9.io). I'm willing to support them, as they are
+providing a more feature rich syntax highlighter system, they call it
+`Ace Mode`. *(Further more, it is very similar to the `tmLanguage` system, and
+they also provide a tool for automatic `Mode` generation from `tmLanguage`,
+which is not perfect of course, as they claimed, but still better than
+nothing!)*
 
-*At the moment a few features are missing from Rainbow.js to make it as powerful
-and complete as the tmLanguage files.. so I wait now :)*
+> The old, Rainbow-compatible version is still available:
+`etc/archive/js/Python.js`, but as before, it is still work-in-progress state,
+and it is very unlikely that I will finish it and/or support it in the future.
 
 ### New is better
 
-Below some of the improvements:
-
-- Added better number highlight:
-	- all types of floating point notations are working now
-	- all types of complex number notations are working now
-	- new types of binary and octal number notations are supported
-	- long integer is removed
-- The `...` syntax notation of `Ellipsis` is supported now
-- Declaration rules are extended with `nonlocal`
-- Ex-statements-now-functions (like `print`) are updated
-- New exceptions added
-- Function annotations are supported
-- Language variable `cls` added
-- Better regex support (multiline, grouping, comments and more are improved)
+Below are some of the most important improvements:
+
+- Added better number highlighting:
+	- All types of floating point notations are working now;
+	- All types of complex number notations are working now;
+	- New types of binary and octal-number notations are supported;
+	- Long integer is removed.
+- The `...` syntax notation of `Ellipsis` is supported now.
+- Declaration rules are extended with `nonlocal`.
+- *Ex-statements-now-functions* (like `print`) are updated.
+- New Exception highlighting added.
+- Function annotations are now supported.
+- Conventional-language variable `cls` added.
+- Better regex support (multiline, grouping, comments and more are improved).
 - String and byte literals:
-	- Byte notation added
-	- Proper string prefixes added
-- All the unused built-in and magic functions/methods are removed
-- All the unused keywords and notations are removed
+	- Byte notation added;
+	- Proper string prefixes added.
+- All the unused built-in and magic functions/methods are now removed.
+- All the unused keywords and notations are now removed.
 
 ### Future plans
 
-- Support format mini-language in strings
-- Create a better Twilight-based theme file
+- Support format mini-language in strings.
+- Create a better Twilight-based theme file.
 
 ### Installation
 
 ***Via Package Control***
 
-The fastest and easiest way to install theses packages to Sublime Text is the
-follow:
+The fastest and easiest way to install these packages for Sublime Text is the
+following:
 
 1. Install [Package Control](https://sublime.wbond.net/installation)
 2. Open `Tools` → `Command Palette`
@@ -87,18 +103,18 @@ follow:
 
 ***Set as default***
 
-After you installed the language definition file successfully, all you have to do is
-assign the `.py` files to always open with this syntax highlighter. Go to
+After you installed the language definition file successfully, all you have to
+do is assign the `.py` files to always open with this syntax highlighter. Go to
 
 `View` → `Syntax` → `Open all with current extension as...` → `Python 3`
 
 To remove this setting, you can always overwrite this preference.
 
 ***Manual installation***
 
-Download the tmLanguage files from the Python and Cython branches of this repository.
-Navigate to your `Packages` folder and create a `Python3` and/or a `Cython` folder(s)
-and copy the tmLanguage and sublime-build files into.
+Download the `tmLanguage` files from the python and Cython branches of this
+repository. Navigate to your `Packages` folder and create a `Python3` and/or a
+`Cython` folder(s) and copy the `tmLanguage` and sublime-build files into.
 
 ***Theme file***
 
@@ -108,42 +124,38 @@ your old color theme to the new one.*
 
 ### Contribute
 
-Any help is appreciated and more than welcome -- my goal is to make the
-*'de facto'* language bundle for Python 3. If you want to submit a change,
+Any help is appreciated and more than welcome -- my goal is to make this the
+*'de facto'* language bundle for python 3. If you want to submit a change,
 please use the following conventions when editing the original python files:
 
-- variables uses `underscore_separated_names`,
-- all files uses 4 spaces for indentation,
-- `=` and `:` operators are aligned if length of variable names are similar
-- `(`, `[` and `{` start a new line, if possible and reasonable
-- each line tries to fit in the width 80 columns
-- comment separators can be easily generated with the `str_to_separator()`
+- variables uses `underscore_separated_names`;
+- all files uses 4 spaces for indentation;
+- `=` and `:` operators are aligned if length of variable names are similar;
+- `(`, `[` and `{` start a new line, if possible and reasonable;
+- each line must fit in the width 80 columns (code, text, etc.);
+- comment separators can be easily generated with the `src.utils.separator()`
 function
 
 ### Appreciation
 
-*Thank you very much Jon Clements for all the support and answers about Python
-and regexes in general and of course thanks for all the wonderful members of the [**so**python](http://sopython.com) chat room! May the Cabbage be with us ;)*
-
-### MIT LICENSE
+*Thank you very much Jon Clements for all the support and answers about python
+and regexes in general, Kevin, Ffisegydd, Zero Piraeus and Poke for the support,
+and of course thanks for all the wonderful members of the
+[sopython](http://sopython.com) chat room! May the Cabbage be with us ;)*
 
-The MIT License (MIT)
+### LICENSE
 
-Copyright (c) 2013-2014 Peter Varo
+Copyright (C) 2013 - 2014 Peter Varo
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
+This program is free software: you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation, either version 3 of the License, or (at your option) any later
+version.
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+This program is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE. See the GNU General Public License for more details.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+You should have received a copy of the GNU General Public License along with
+this program, most likely a file in the root directory, called 'LICENSE'. If
+not, see http://www.gnu.org/licenses.