Skip to content

Latest commit

 

History

History
92 lines (52 loc) · 2.35 KB

api-reference.md

File metadata and controls

92 lines (52 loc) · 2.35 KB
Raw

AceGrammar Methods

For node:

var AceGrammar = require('build/ace_grammar.js');

For browser:

<script src="build/ace_grammar.js"></script>

Method: clone

cloned_grammar = AceGrammar.clone( grammar [, deep=true] );

Clone (deep) a grammar

Utility to clone objects efficiently

Method: extend

extended_grammar = AceGrammar.extend( grammar, basegrammar1 [, basegrammar2, ..] );

Extend a grammar with basegrammar1, basegrammar2, etc..

This way arbitrary dialects and variations can be handled more easily

Method: pre_process

pre_processed_grammar = AceGrammar.pre_process( grammar );

This is used internally by the AceGrammar Class parse method In order to pre-process a JSON grammar (in-place) to transform any shorthand configurations to full object configurations and provide defaults. It also parses PEG/BNF (syntax) notations into full (syntax) configuration objects, so merging with other grammars can be easier if needed.

Method: parse

parsed_grammar = AceGrammar.parse( grammar );

This is used internally by the AceGrammar Class In order to parse a JSON grammar to a form suitable to be used by the syntax-highlight parser. However user can use this method to cache a parsedgrammar to be used later. Already parsed grammars are NOT re-parsed when passed through the parse method again

Method: getMode

mode = AceGrammar.getMode( grammar, [, DEFAULT, ace] );

This is the main method which transforms a JSON grammar into an ACE syntax-highlight parser. DEFAULT is the default return value ("text" by default) for things that are skipped or not styled In general there is no need to set this value, unless you need to return something else The ace reference can also be passed as parameter, for example, if ace is not already available when the add-on is first loaded (e.g via an async callback)

Parser Class: Parser

Parser = AceGrammar.Parser;

The Parser Class used to instantiate a highlight parser, is available. The getMode method will instantiate this parser class, which can be overriden/extended if needed, as needed. In general there is no need to override/extend the parser, unless you definately need to.