Prettify (Java Prettify 2.0.1 API)

java.lang.Object
- prettify.parser.Prettify

```
public class Prettify
extends Object
```
This is similar to the prettify.js in JavaScript Prettify. All comments are adapted from the JavaScript Prettify.
Some functions for browser-side pretty printing of code contained in html.

For a fairly comprehensive set of languages see the README file that came with this source. At a minimum, the lexer should work on a number of languages including C and friends, Java, Python, Bash, SQL, HTML, XML, CSS, Javascript, and Makefiles. It works passably on Ruby, PHP and Awk and a subset of Perl, but, because of commenting conventions, doesn't work on Smalltalk, Lisp-like, or CAML-like languages without an explicit lang class.
Usage:
1. include this source file in an html page via <script type="text/javascript" src="/path/to/prettify.js"></script>
2. define style rules. See the example page for examples.
3. mark the <pre> and <code> tags in your source with class=prettyprint. You can also use the (html deprecated) <xmp> tag, but the pretty printer needs to do more substantial DOM manipulations to support that, so some css styles may not be preserved.
That's it. I wanted to keep the API as simple as possible, so there's no need to specify which language the code is in, but if you wish, you can add another class to the <pre> or <code> element to specify the language, as in <pre class="prettyprint lang-java">. Any class that starts with "lang-" followed by a file extension, specifies the file type. See the "lang-*.js" files in this directory for code that implements per-language file handlers.
Change log:
cbeust, 2006/08/22
Java annotations (start with "@") are now captured as literals ("lit")

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Prettify.CreateSimpleLexer

Nested Classes
Modifier and Type	Class and Description
`class`	`Prettify.CreateSimpleLexer`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALL_KEYWORDS`
`static String`	`C_KEYWORDS`
`static Pattern`	`C_TYPES`
`static String`	`COFFEE_KEYWORDS`
`static String`	`COMMON_KEYWORDS`
`static String`	`CPP_KEYWORDS`
`static String`	`CSHARP_KEYWORDS`
`static String`	`FLOW_CONTROL_KEYWORDS`
`static String`	`JAVA_KEYWORDS`
`static String`	`JSCRIPT_KEYWORDS`
`protected Map<String,Object>`	`langHandlerRegistry` Maps language-specific file extensions to handlers.
`static String`	`PERL_KEYWORDS`
`static String`	`PR_ATTRIB_NAME` token style for an sgml attribute name.
`static String`	`PR_ATTRIB_VALUE` token style for an sgml attribute value.
`static String`	`PR_COMMENT` token style for a comment
`static String`	`PR_DECLARATION` token style for a markup declaration such as a DOCTYPE.
`static String`	`PR_KEYWORD` token style for a keyword
`static String`	`PR_LITERAL` token style for a literal value.
`static String`	`PR_NOCODE` A class that indicates a section of markup that is not code, e.g.
`static String`	`PR_PLAIN` token style for a plain text.
`static String`	`PR_PUNCTUATION` token style for a punctuation string.
`static String`	`PR_SOURCE` token style for embedded source.
`static String`	`PR_STRING` token style for a string literal
`static String`	`PR_TAG` token style for an sgml tag.
`static String`	`PR_TYPE` token style for a type
`static String`	`PYTHON_KEYWORDS`
`static String`	`RUBY_KEYWORDS`
`static String`	`RUST_KEYWORDS`
`static String`	`SH_KEYWORDS`

Constructor Summary

Constructors
Constructor and Description

Prettify()

Constructors
Constructor and Description
`Prettify()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected static void`	`appendDecorations(int basePos, String sourceCode, Prettify.CreateSimpleLexer langHandler, List<Object> out)` Apply the given language handler to sourceCode and add the resulting decorations to out.
`protected List<String>`	`getFileExtensionsFromClass(Class<? extends Lang> clazz)`
`Prettify.CreateSimpleLexer`	`langHandlerForExtension(String extension, String source)` Get the parser for the extension specified.
`void`	`register(Class<? extends Lang> clazz)` Register language handler.
`protected void`	`registerLangHandler(Prettify.CreateSimpleLexer handler, List<String> fileExtensions)` Register a language handler for the given file extensions.
`protected Prettify.CreateSimpleLexer`	`sourceDecorator(Map<String,Object> options)` returns a function that produces a list of decorations from source text.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FLOW_CONTROL_KEYWORDS
```
public static final String FLOW_CONTROL_KEYWORDS
```
    See Also:
    
    Constant Field Values
  - C_KEYWORDS
```
public static final String C_KEYWORDS
```
    See Also:
    
    Constant Field Values
  - COMMON_KEYWORDS
```
public static final String COMMON_KEYWORDS
```
    See Also:
    
    Constant Field Values
  - CPP_KEYWORDS
```
public static final String CPP_KEYWORDS
```
    See Also:
    
    Constant Field Values
  - JAVA_KEYWORDS
```
public static final String JAVA_KEYWORDS
```
    See Also:
    
    Constant Field Values
  - RUST_KEYWORDS
```
public static final String RUST_KEYWORDS
```
    See Also:
    
    Constant Field Values
  - CSHARP_KEYWORDS
```
public static final String CSHARP_KEYWORDS
```
    See Also:
    
    Constant Field Values
  - COFFEE_KEYWORDS
```
public static final String COFFEE_KEYWORDS
```
    See Also:
    
    Constant Field Values
  - JSCRIPT_KEYWORDS
```
public static final String JSCRIPT_KEYWORDS
```
    See Also:
    
    Constant Field Values
  - PERL_KEYWORDS
```
public static final String PERL_KEYWORDS
```
    See Also:
    
    Constant Field Values
  - PYTHON_KEYWORDS
```
public static final String PYTHON_KEYWORDS
```
    See Also:
    
    Constant Field Values
  - RUBY_KEYWORDS
```
public static final String RUBY_KEYWORDS
```
    See Also:
    
    Constant Field Values
  - SH_KEYWORDS
```
public static final String SH_KEYWORDS
```
    See Also:
    
    Constant Field Values
  - ALL_KEYWORDS
```
public static final String ALL_KEYWORDS
```
    See Also:
    
    Constant Field Values
  - C_TYPES
```
public static final Pattern C_TYPES
```
  - PR_STRING
```
public static final String PR_STRING
```
    token style for a string literal
    
    See Also:
    
    Constant Field Values
  - PR_KEYWORD
```
public static final String PR_KEYWORD
```
    token style for a keyword
    
    See Also:
    
    Constant Field Values
  - PR_COMMENT
```
public static final String PR_COMMENT
```
    token style for a comment
    
    See Also:
    
    Constant Field Values
  - PR_TYPE
```
public static final String PR_TYPE
```
    token style for a type
    
    See Also:
    
    Constant Field Values
  - PR_LITERAL
```
public static final String PR_LITERAL
```
    token style for a literal value. e.g. 1, null, true.
    
    See Also:
    
    Constant Field Values
  - PR_PUNCTUATION
```
public static final String PR_PUNCTUATION
```
    token style for a punctuation string.
    
    See Also:
    
    Constant Field Values
  - PR_PLAIN
```
public static final String PR_PLAIN
```
    token style for a plain text.
    
    See Also:
    
    Constant Field Values
  - PR_TAG
```
public static final String PR_TAG
```
    token style for an sgml tag.
    
    See Also:
    
    Constant Field Values
  - PR_DECLARATION
```
public static final String PR_DECLARATION
```
    token style for a markup declaration such as a DOCTYPE.
    
    See Also:
    
    Constant Field Values
  - PR_SOURCE
```
public static final String PR_SOURCE
```
    token style for embedded source.
    
    See Also:
    
    Constant Field Values
  - PR_ATTRIB_NAME
```
public static final String PR_ATTRIB_NAME
```
    token style for an sgml attribute name.
    
    See Also:
    
    Constant Field Values
  - PR_ATTRIB_VALUE
```
public static final String PR_ATTRIB_VALUE
```
    token style for an sgml attribute value.
    
    See Also:
    
    Constant Field Values
  - PR_NOCODE
```
public static final String PR_NOCODE
```
    A class that indicates a section of markup that is not code, e.g. to allow embedding of line numbers within code listings.
    
    See Also:
    
    Constant Field Values
  - langHandlerRegistry
```
protected Map<String,Object> langHandlerRegistry
```
    Maps language-specific file extensions to handlers.
- Constructor Detail
  - Prettify
```
public Prettify()
```
- Method Detail
  - appendDecorations
```
protected static void appendDecorations(int basePos,
                                        String sourceCode,
                                        Prettify.CreateSimpleLexer langHandler,
                                        List<Object> out)
```
    Apply the given language handler to sourceCode and add the resulting decorations to out.
    
    Parameters:
    
    basePos - the index of sourceCode within the chunk of source whose decorations are already present on out.
  - sourceDecorator
```
protected Prettify.CreateSimpleLexer sourceDecorator(Map<String,Object> options)
                                              throws Exception
```
    returns a function that produces a list of decorations from source text. This code treats ", ', and ` as string delimiters, and \ as a string escape. It does not recognize perl's qq() style strings. It has no special handling for double delimiter escapes as in basic, or the tripled delimiters used in python, but should work on those regardless although in those cases a single string literal may be broken up into multiple adjacent string literals. It recognizes C, C++, and shell style comments.
    
    Parameters:
    
    options - a set of optional parameters.
    
    Returns:
    
    a function that examines the source code in the input job and builds the decoration list.
    
    Throws:
    
    Exception
  - registerLangHandler
```
protected void registerLangHandler(Prettify.CreateSimpleLexer handler,
                                   List<String> fileExtensions)
                            throws Exception
```
    Register a language handler for the given file extensions.
    
    Parameters:
    
    handler - a function from source code to a list of decorations. Takes a single argument job which describes the state of the computation. The single parameter has the form { sourceCode: {string} as plain text. decorations: {Array.<number|string>} an array of style classes preceded by the position at which they start in job.sourceCode in order. The language handler should assigned this field. basePos: {int} the position of source in the larger source chunk. All positions in the output decorations array are relative to the larger source chunk. }
    
    fileExtensions -
    
    Throws:
    
    Exception
  - register
```
public void register(Class<? extends Lang> clazz)
              throws Exception
```
    Register language handler. The clazz will not be instantiated
    
    Parameters:
    
    clazz - the class of the language
    
    Throws:
    
    Exception - cannot instantiate the object using the class, or language handler with specified extension exist already
  - getFileExtensionsFromClass
```
protected List<String> getFileExtensionsFromClass(Class<? extends Lang> clazz)
                                           throws Exception
```
    Throws:
    
    Exception
  - langHandlerForExtension
```
public Prettify.CreateSimpleLexer langHandlerForExtension(String extension,
                                                          String source)
```
    Get the parser for the extension specified.
    
    Parameters:
    
    extension - the file extension, if null, default parser will be returned
    
    source - the source code
    
    Returns:
    
    the parser

Class Prettify

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FLOW_CONTROL_KEYWORDS

C_KEYWORDS

COMMON_KEYWORDS

CPP_KEYWORDS

JAVA_KEYWORDS

RUST_KEYWORDS

CSHARP_KEYWORDS

COFFEE_KEYWORDS

JSCRIPT_KEYWORDS

PERL_KEYWORDS

PYTHON_KEYWORDS

RUBY_KEYWORDS

SH_KEYWORDS

ALL_KEYWORDS

C_TYPES

PR_STRING

PR_KEYWORD

PR_COMMENT

PR_TYPE

PR_LITERAL

PR_PUNCTUATION

PR_PLAIN

PR_TAG

PR_DECLARATION

PR_SOURCE

PR_ATTRIB_NAME

PR_ATTRIB_VALUE

PR_NOCODE

langHandlerRegistry

Constructor Detail

Prettify

Method Detail

appendDecorations

sourceDecorator

registerLangHandler

register

getFileExtensionsFromClass

langHandlerForExtension