highlightjs-supercollider/supercollider.js

highlight.js syntax definition for the Supercollider language

/*
Language: SuperCollider
Requires:
Author: Brian Heim <brianlheim@gmail.com>
Contributors: Brian Heim <brianlheim@gmail.com>
Category: audio, music, scripting, research
Description: SuperCollider is a language for audio synthesis and algorithmic composition.
*/
var module = module ? module : {}; // shim for browser use

function hljsDefineSuperCollider(hljs) {
  var KEYWORDS = {
    keyword: "arg classvar|10 const super this var|2",
    built_in:
      "false inf|2 nil|2 true thisFunction|10 thisFunctionDef|10 thisMethod|10 " +
      "thisProcess|10 thisThread|10 currentEnvironment|10 topEnvironment|10"
  };

  var CLASS = {
    className: "type",
    begin: "\\b[A-Z]\\w*\\b",
    relevance: 0
  };
  var PRIMITIVE = {
    className: "meta",
    begin: "_\\w+",
    relevance: 0
  };
  var CHAR_LITERAL = {
    className: "literal",
    begin: "\\$\\\\?."
  };
  var ENV_VAR = {
    className: "title",
    begin: "~\\w+",
    relevance: 2 // ~env vars are pretty common in SC
  };

  var NUMBER_RADIX_RE = "\\b\\d+r[0-9a-zA-Z]*(\\.[0-9A-Z]*)?\\b";
  var NUMBER_FLOAT_RE = "\\b((\\d+(\\.\\d+)?([eE][-+]?\\d+)?(pi)?)|pi)\\b";
  var NUMBER_INT_RE = "\\b0x[a-fA-F0-9]+\\b";
  var NUMBER_SCALE_RE = /\b\d+(s+|b+|[sb]\d+)\b/;
  var NUMBER = {
    className: "number",
    variants: [
      { begin: NUMBER_RADIX_RE },
      { begin: NUMBER_SCALE_RE },
      { begin: NUMBER_FLOAT_RE },
      { begin: NUMBER_INT_RE }
    ],
    relevance: 0
  };

  var BACKSLASH_SYMBOL_RE = "\\\\\\w+";
  var SYMBOL_SELECTOR_RE = "[A-Za-z_]\\w*\\:";

  var BLOCK_COMMENT = hljs.C_BLOCK_COMMENT_MODE;
  BLOCK_COMMENT.contains.push("self"); // block comments in SC are nested

  return {
    aliases: ["supercollider", "sc"],
    keywords: KEYWORDS,
    contains: [
      {
        className: "type",
        // relevance boost for common but sc-specific class names: Synth, SynthDef
        begin: /\b(Synth|SynthDef)\b/,
        relevance: 10
      },
      CLASS,
      PRIMITIVE,
      CHAR_LITERAL,
      ENV_VAR,
      NUMBER,
      {
        className: "symbol",
        variants: [
          { begin: BACKSLASH_SYMBOL_RE, relevance: 5 }, // backslash syms are pretty common
          hljs.APOS_STRING_MODE,
          { begin: SYMBOL_SELECTOR_RE, relevance: 0 }
        ]
      },

      hljs.QUOTE_STRING_MODE,
      hljs.C_LINE_COMMENT_MODE,
      BLOCK_COMMENT
    ],
    // avoid common confusions: we don't declare classes with "class Aaa"
    illegal: /\bclass\s+[A-Z]/
  };
}

module.exports = function(hljs) {
  hljs.registerLanguage("supercollider", hljsDefineSuperCollider);
};

module.exports.definer = hljsDefineSuperCollider;