Modifier and Type	Class and Description
pack-priv static enum	ProtoParser.Context
pack-priv abstract static class	ProtoParser.OptionKindAndValue

Modifier and Type	Field and Description
private final char[]	data
private final ProtoFile.Builder	fileBuilder
private final String	filePath
private int	line The number of newline characters encountered thus far.
private int	lineStart The index of the most recent newline character.
private String	packageName Output package name, or null if none yet encountered.
private int	pos Our cursor within the document.
private String	prefix The current package name + nested type names, separated by dots.

Access	Constructor and Description
pack-priv	ProtoParser(String filePath, char[] data)

Method Summary

Modifier and Type	Method and Description
private void	addToList(List<Object> list, Object value) Adds an object or objects to a List.
private int	column()
private int	hexDigit(char c)
private int	line()
private void	newline() Call this every time a '\n' is encountered.
public static ProtoFile	parse(String name, Reader reader) Parse a named `.proto` schema.
public static ProtoFile	parse(String name, String data) Parse a named `.proto` schema.
public static ProtoFile	parseUtf8(File file) Parse a `.proto` definition file.
public static ProtoFile	parseUtf8(Path path) Parse a `.proto` definition file.
public static ProtoFile	parseUtf8(String name, InputStream is) Parse a named `.proto` schema.
private char	peekChar() Peeks a non-whitespace character and returns it.
private char	readChar() Reads a non-whitespace character and returns it.
private String	readComment() Reads a comment and returns its body.
private DataType	readDataType() Reads a scalar, map, or type name.
private Object	readDeclaration(String documentation, ProtoParser.Context context)
private String	readDocumentation() Like `skipWhitespace`, but this returns a string containing all comment text.
private EnumElement	readEnumElement(String documentation) Reads an enumerated type declaration and returns it.
private ExtendElement	readExtend(String documentation) Reads an extend declaration.
private ExtensionsElement	readExtensions(String documentation) Reads extensions like "extensions 101;" or "extensions 101 to max;".
private FieldElement	readField(String documentation, FieldElement.Label label) Reads an field declaration and returns it.
private int	readInt() Reads an integer and returns it.
private ProtoParser.OptionKindAndValue	readKindAndValue() Reads a value that can be a map, list, string, number, boolean or enum.
private List<Object>	readList() Returns a list of values.
private Map<String, Object>	readMap(char openBrace, char closeBrace, char keyValueSeparator) Returns a map of string keys and values.
private MessageElement	readMessage(String documentation) Reads a message declaration.
private String	readName() Reads a (paren-wrapped), [square-wrapped] or naked symbol name.
private char	readNumericEscape(int radix, int len)
private OneOfElement	readOneOf(String documentation)
private OptionElement	readOption(char keyValueSeparator) Reads a option containing a name, an '=' or ':', and a value.
pack-priv ProtoFile	readProtoFile()
private String	readQuotedString()
private RpcElement	readRpc(String documentation) Reads an rpc and returns it.
private ServiceElement	readService(String documentation) Reads a service declaration and returns it.
private String	readString() Reads a quoted or unquoted string and returns it.
private String	readWord() Reads a non-empty word and returns it.
private void	skipWhitespace(boolean skipComments) Skips whitespace characters and optionally comments.
private String	tryAppendTrailingDocumentation(String documentation)
private RuntimeException	unexpected(String message)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

data	back to summary
private final char[] data

fileBuilder	back to summary
private final ProtoFile.Builder fileBuilder

filePath	back to summary
private final String filePath

line	back to summary
private int line The number of newline characters encountered thus far.

lineStart	back to summary
private int lineStart The index of the most recent newline character.

packageName	back to summary
private String packageName Output package name, or null if none yet encountered.

pos	back to summary
private int pos Our cursor within the document. `data[pos]` is the next character to be read.

prefix	back to summary
private String prefix The current package name + nested type names, separated by dots.

Constructor Detail

ProtoParser	back to summary
pack-priv ProtoParser(String filePath, char[] data)

Method Detail

addToList	back to summary
private void addToList(List<Object> list, Object value) Adds an object or objects to a List.

column	back to summary
private int column()

hexDigit	back to summary
private int hexDigit(char c)

line	back to summary
private int line()

newline	back to summary
private void newline() Call this every time a '\n' is encountered.

parse	back to summary
public static ProtoFile parse(String name, Reader reader) throws IOException Parse a named `.proto` schema. The `Reader` is not closed.

parse	back to summary
public static ProtoFile parse(String name, String data) Parse a named `.proto` schema.

parseUtf8	back to summary
public static ProtoFile parseUtf8(File file) throws IOException Parse a `.proto` definition file.

parseUtf8	back to summary
public static ProtoFile parseUtf8(Path path) throws IOException Parse a `.proto` definition file.

parseUtf8	back to summary
public static ProtoFile parseUtf8(String name, InputStream is) throws IOException Parse a named `.proto` schema. The `InputStream` is not closed.

peekChar	back to summary
private char peekChar() Peeks a non-whitespace character and returns it. The only difference between this and `readChar` is that this doesn't consume the char.

readChar	back to summary
private char readChar() Reads a non-whitespace character and returns it.

readComment	back to summary
private String readComment() Reads a comment and returns its body.

readDataType	back to summary
private DataType readDataType() Reads a scalar, map, or type name.

readDeclaration	back to summary
private Object readDeclaration(String documentation, ProtoParser.Context context)

readDocumentation	back to summary
private String readDocumentation() Like `skipWhitespace`, but this returns a string containing all comment text. By convention, comments before a declaration document that declaration.

readEnumElement	back to summary
private EnumElement readEnumElement(String documentation) Reads an enumerated type declaration and returns it.

readExtend	back to summary
private ExtendElement readExtend(String documentation) Reads an extend declaration.

readExtensions	back to summary
private ExtensionsElement readExtensions(String documentation) Reads extensions like "extensions 101;" or "extensions 101 to max;".

readField	back to summary
private FieldElement readField(String documentation, FieldElement.Label label) Reads an field declaration and returns it.

readInt	back to summary
private int readInt() Reads an integer and returns it.

readKindAndValue	back to summary
private ProtoParser.OptionKindAndValue readKindAndValue() Reads a value that can be a map, list, string, number, boolean or enum.

readList	back to summary
private List<Object> readList() Returns a list of values. This is similar to JSON with '[' and ']' surrounding the list and ',' separating values.

readMap	back to summary
private Map<String, Object> readMap(char openBrace, char closeBrace, char keyValueSeparator) Returns a map of string keys and values. This is similar to a JSON object, with '{' and '}' surrounding the map, ':' separating keys from values, and ',' separating entries. Annotations @SuppressWarnings:unchecked

readMap

back to summary

private Map<String, Object> readMap(char openBrace, char closeBrace, char keyValueSeparator)

Returns a map of string keys and values. This is similar to a JSON object, with '{' and '}' surrounding the map, ':' separating keys from values, and ',' separating entries.

Annotations

@SuppressWarnings:unchecked

readMessage	back to summary
private MessageElement readMessage(String documentation) Reads a message declaration.

readName	back to summary
private String readName() Reads a (paren-wrapped), [square-wrapped] or naked symbol name.

readNumericEscape	back to summary
private char readNumericEscape(int radix, int len)

readOneOf	back to summary
private OneOfElement readOneOf(String documentation)

readOption	back to summary
private OptionElement readOption(char keyValueSeparator) Reads a option containing a name, an '=' or ':', and a value.

readProtoFile	back to summary
pack-priv ProtoFile readProtoFile()

readQuotedString	back to summary
private String readQuotedString()

readRpc	back to summary
private RpcElement readRpc(String documentation) Reads an rpc and returns it.

readService	back to summary
private ServiceElement readService(String documentation) Reads a service declaration and returns it.

readString	back to summary
private String readString() Reads a quoted or unquoted string and returns it.

readWord	back to summary
private String readWord() Reads a non-empty word and returns it.

skipWhitespace	back to summary
private void skipWhitespace(boolean skipComments) Skips whitespace characters and optionally comments. When this returns, either `pos == data.length` or a non-whitespace character.

tryAppendTrailingDocumentation	back to summary
private String tryAppendTrailingDocumentation(String documentation)

unexpected	back to summary
private RuntimeException unexpected(String message)

com.squareup.protoparser back to summary

pack-priv final Enum ProtoParser.Context

Class Inheritance

extends Enum<ProtoParser.Context>

java.lang.Object
java.lang.Enum
com.squareup.protoparser.ProtoParser.Context

Field Summary

Modifier and Type	Field and Description
public static final ProtoParser.Context	ENUM
public static final ProtoParser.Context	EXTEND
public static final ProtoParser.Context	FILE
public static final ProtoParser.Context	MESSAGE
public static final ProtoParser.Context	RPC
public static final ProtoParser.Context	SERVICE

Constructor Summary

Access	Constructor and Description
private	Context()

Method Summary

Modifier and Type	Method and Description
public boolean	permitsExtensions()
public boolean	permitsField()
public boolean	permitsImport()
public boolean	permitsOneOf()
public boolean	permitsPackage()
public boolean	permitsRpc()
public boolean	permitsSyntax()
public static ProtoParser.Context	valueOf(String name)
public static ProtoParser.Context[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ENUM	back to summary
public static final ProtoParser.Context ENUM

EXTEND	back to summary
public static final ProtoParser.Context EXTEND

FILE	back to summary
public static final ProtoParser.Context FILE

MESSAGE	back to summary
public static final ProtoParser.Context MESSAGE

RPC	back to summary
public static final ProtoParser.Context RPC

SERVICE	back to summary
public static final ProtoParser.Context SERVICE

Constructor Detail

Context	back to summary
private Context()

Method Detail

permitsExtensions	back to summary
public boolean permitsExtensions()

permitsField	back to summary
public boolean permitsField()

permitsImport	back to summary
public boolean permitsImport()

permitsOneOf	back to summary
public boolean permitsOneOf()

permitsPackage	back to summary
public boolean permitsPackage()

permitsRpc	back to summary
public boolean permitsRpc()

permitsSyntax	back to summary
public boolean permitsSyntax()

valueOf	back to summary
public static ProtoParser.Context valueOf(String name)

values	back to summary
public static ProtoParser.Context[] values()

Modifier and Type	Method and Description
pack-priv abstract OptionElement.Kind	kind()
pack-priv static ProtoParser.OptionKindAndValue	of(OptionElement.Kind kind, Object value)
pack-priv abstract Object	value()

public final Class ProtoParser

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum ProtoParser.Context

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv abstract Class ProtoParser.OptionKindAndValue

Constructor Summary

Method Summary

Constructor Detail

Method Detail