Skip to content

Instantly share code, notes, and snippets.

@olleolleolle

olleolleolle/arduino_syntax_coloring.diff

Created March 1, 2009 17:48
Show Gist options
  • Save olleolleolle/72410 to your computer and use it in GitHub Desktop.
Save olleolleolle/72410 to your computer and use it in GitHub Desktop.
Download ZIP
Support for Arduino's syntax in Bespin (the Mozilla code editor).
Raw
arduino_syntax_coloring.diff
diff -r 601a944a1639 frontend/js/bespin/bootstrap_dependencies.js
--- a/frontend/js/bespin/bootstrap_dependencies.js Sat Feb 28 22:26:57 2009 -0800
+++ b/frontend/js/bespin/bootstrap_dependencies.js Sun Mar 01 18:44:18 2009 +0100
@@ -59,6 +59,7 @@
dojo.require("bespin.syntax.css");
dojo.require("bespin.syntax.html");
dojo.require("bespin.syntax.php");
+dojo.require("bespin.syntax.arduino");
dojo.require("bespin.cmd.commandline");
dojo.require("bespin.cmd.commands");
diff -r 601a944a1639 frontend/js/bespin/syntax/arduino.js
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/frontend/js/bespin/syntax/arduino.js Sun Mar 01 18:44:18 2009 +0100
@@ -0,0 +1,197 @@
+/* ***** BEGIN LICENSE BLOCK *****
+ * Version: MPL 1.1
+ *
+ * The contents of this file are subject to the Mozilla Public License
+ * Version 1.1 (the "License"); you may not use this file except in
+ * compliance with the License. You may obtain a copy of the License at
+ * http://www.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS"
+ * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.
+ * See the License for the specific language governing rights and
+ * limitations under the License.
+ *
+ * The Original Code is Bespin.
+ *
+ * The Initial Developer of the Original Code is Mozilla.
+ * Portions created by the Initial Developer are Copyright (C) 2009
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s):
+ * Bespin Team (bespin@mozilla.com)
+ * Olle Jonsson (olle.jonsson@gmail.com)
+ * Peter Neubauer (peter@neubauer.se)
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+// = Arduino Syntax Highlighting Implementation =
+//
+// Module for syntax highlighting Arduino PDE files.
+
+dojo.provide("bespin.syntax.arduino");
+
+// ** {{{ bespin.syntax.ArduinoSyntaxEngine }}} **
+//
+// Tracks syntax highlighting data on a per-line basis. This is a quick-and-dirty implementation that
+// supports five basic highlights: keywords, punctuation, strings, comments, and "everything else", all
+// lumped into one last bucket.
+
+bespin.syntax.ArduinoConstants = {
+ C_STYLE_COMMENT: "c-comment",
+ LINE_COMMENT: "comment",
+ STRING: "string",
+ KEYWORD: "keyword",
+ PUNCTUATION: "punctuation",
+ OTHER: "plain"
+}
+
+dojo.declare("bespin.syntax.ArduinoSyntaxEngine", null, {
+ keywords: 'HIGH LOW INPUT OUTPUT SERIAL DISPLAY DEC BIN HEX OCT BYTE PI HALF_PI TWO_PI LSBFIRST MSBFIRST CHANGE FALLING RISING DEFAULT EXTERNAL INTERAL ' +
+ 'boolean byte case char class default do double else false float for if int long new null private protected public return short signed static switch this throw try true unsigned void while word ' +
+ 'abs acos asin atan atan2 ceil constrain cos degrees exp floor log map max min radians random randomSeed round sin sq sqrt tan ' +
+ 'bitRead bitWrite bitSet bitClear bit highByte lowByte ' +
+ 'analogReference analogRead analogWrite attachInterrupt detachInterrupt delay delayMicroseconds digitalWrite digitalRead interrupts millis micros noInterrupts pinMode pulseIn shiftOut ' +
+ 'Serial begin read print println available flush ' +
+ 'setup loop'.split(" "),
+
+ punctuation: '{ } > < / + - % * . , ; ( ) ? : = " \''.split(" "),
+
+ highlight: function(line, meta) {
+ if (!meta) meta = {};
+
+ var K = bespin.syntax.ArduinoConstants; // aliasing the constants for shorter reference ;-)
+
+ var regions = {}; // contains the individual style types as keys, with array of start/stop positions as value
+
+ // current state, maintained as we parse through each character in the line; values at any time should be consistent
+ var currentStyle = (meta.inMultilineComment) ? K.C_STYLE_COMMENT : undefined;
+ var currentRegion = {}; // should always have a start property for a non-blank buffer
+ var buffer = "";
+
+ // these properties are related to the parser state above but are special cases
+ var stringChar = ""; // the character used to start the current string
+ var multiline = meta.inMultilineComment;
+
+ for (var i = 0; i < line.length; i++) {
+ var c = line.charAt(i);
+
+ // check if we're in a comment and whether this character ends the comment
+ if (currentStyle == K.C_STYLE_COMMENT) {
+ if (c == "/" && /\*$/.test(buffer)) { // has the c-style comment just ended?
+ currentRegion.stop = i + 1;
+ this.addRegion(regions, currentStyle, currentRegion);
+ currentRegion = {};
+ currentStyle = undefined;
+ multiline = false;
+ buffer = "";
+ } else {
+ if (buffer == "") currentRegion = { start: i };
+ buffer += c;
+ }
+
+ continue;
+ }
+
+ if (this.isWhiteSpaceOrPunctuation(c)) {
+ // check if we're in a string
+ if (currentStyle == K.STRING) {
+ // if this is not an unescaped end quote (either a single quote or double quote to match how the string started) then keep going
+ if ( ! (c == stringChar && !/\\$/.test(buffer))) {
+ if (buffer == "") currentRegion = { start: i };
+ buffer += c;
+ continue;
+ }
+ }
+
+ // if the buffer is full, add it to the regions
+ if (buffer != "") {
+ currentRegion.stop = i;
+
+ if (currentStyle != K.STRING) { // if this is a string, we're all set to add it; if not, figure out if its a keyword
+ if (this.keywords.indexOf(buffer) != -1) {
+ // the buffer contains a keyword
+ currentStyle = K.KEYWORD;
+ } else {
+ currentStyle = K.OTHER;
+ }
+ }
+ this.addRegion(regions, currentStyle, currentRegion);
+ currentRegion = {};
+ stringChar = "";
+ buffer = "";
+ // i don't clear the current style here so I can check if it was a string below
+ }
+
+ if (this.isPunctuation(c)) {
+ if (c == "*" && i > 0 && (line.charAt(i - 1) == "/")) {
+ // remove the previous region in the punctuation bucket, which is a forward slash
+ regions[K.PUNCTUATION].pop();
+
+ // we are in a c-style comment
+ multiline = true;
+ currentStyle = K.C_STYLE_COMMENT;
+ currentRegion = { start: i - 1 };
+ buffer = "/*";
+ continue;
+ }
+
+ // check for a line comment; this ends the parsing for the rest of the line
+ if (c == '/' && i > 0 && (line.charAt(i - 1) == '/')) {
+ currentRegion = { start: i - 1, stop: line.length };
+ currentStyle = K.LINE_COMMENT;
+ this.addRegion(regions, currentStyle, currentRegion);
+ buffer = "";
+ currentStyle = undefined;
+ currentRegion = {};
+ break; // once we get a line comment, we're done!
+ }
+
+ // add an ad-hoc region for just this one punctuation character
+ this.addRegion(regions, K.PUNCTUATION, { start: i, stop: i + 1 });
+ }
+
+ // find out if the current quote is the end or the beginning of the string
+ if ((c == "'" || c == '"') && (currentStyle != K.STRING)) {
+ currentStyle = K.STRING;
+ stringChar = c;
+ } else {
+ currentStyle = undefined;
+ }
+
+ continue;
+ }
+
+ if (buffer == "") currentRegion = { start: i };
+ buffer += c;
+ }
+
+ // check for a trailing character inside of a string or a comment
+ if (buffer != "") {
+ if (!currentStyle) currentStyle = K.OTHER;
+ currentRegion.stop = line.length;
+ this.addRegion(regions, currentStyle, currentRegion);
+ }
+
+ return { regions: regions, meta: { inMultilineComment: multiline } };
+ },
+
+ addRegion: function(regions, type, data) {
+ if (!regions[type]) regions[type] = [];
+ regions[type].push(data);
+ },
+
+ isWhiteSpaceOrPunctuation: function(ch) {
+ return this.isPunctuation(ch) || this.isWhiteSpace(ch);
+ },
+
+ isPunctuation: function(ch) {
+ return this.punctuation.indexOf(ch) != -1;
+ },
+
+ isWhiteSpace: function(ch) {
+ return ch == " ";
+ }
+});
+
+// Register
+bespin.syntax.EngineResolver.register(new bespin.syntax.ArduinoSyntaxEngine(), ['pde']);
\ No newline at end of file
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment