[Added package and class overviews. bjorn@bringert.net**20041025090923] < > { hunk ./Makefile 25 +DOC_PKGS = se.chalmers.cs.gf + hunk ./Makefile 73 - $(JAVADOC) -d doc/javadoc $(SRC) + $(JAVADOC) -d doc/javadoc -sourcepath $(SRCDIRS) -overview se/chalmers/cs/gf/overview.html -subpackages $(DOC_PKGS) hunk ./doc/gf-java.html 46 -using this syste, only to produce the grammars for them.

+using this system, only to produce the grammars for them.

hunk ./doc/gf-java.html 53 -the OAA interfce. +the OAA interface. hunk ./doc/gf-java.html 60 -

JavaDoc for the API can be built using make javadoc.

+

JavaDoc for the GF API.

+ +

JavaDoc for the API can also be built using make javadoc.

hunk ./se/chalmers/cs/gf/GFException.java 3 +/** + * Exception thrown by the GF interpreter. + */ hunk ./se/chalmers/cs/gf/abssyn/GFTreeToTree.java 6 +/** + * Builds an untyped GF abstract syntax tree from a tree + * in the BNFC-generated abstract syntax for trees. + */ hunk ./se/chalmers/cs/gf/abssyn/IntLiteral.java 3 +/** + * An integer literal in untyped abstract syntax trees. + */ hunk ./se/chalmers/cs/gf/abssyn/MetaVariable.java 3 +/** + * A metavariable in untyped abstract syntax trees. + */ hunk ./se/chalmers/cs/gf/abssyn/StringLiteral.java 3 +/** + * A string literal in untyped abstract syntax trees. + */ hunk ./se/chalmers/cs/gf/abssyn/Tree.java 3 +/** + * Interface implemented by all the abstract syntax classes. + */ hunk ./se/chalmers/cs/gf/abssyn/TreeVisitor.java 3 +/** + * Visitor interface for visiting untyped abstract syntax trees. + */ addfile ./se/chalmers/cs/gf/abssyn/package.html hunk ./se/chalmers/cs/gf/abssyn/package.html 1 - + +Untyped abstract syntax trees. + addfile ./se/chalmers/cs/gf/gfcutil/package.html hunk ./se/chalmers/cs/gf/gfcutil/package.html 1 - + +Classes representing GFC modules and definitions. + hunk ./se/chalmers/cs/gf/linearize/LinearizeAll.java 10 +/** + * Linearize a tree with a set of linearizers. + */ hunk ./se/chalmers/cs/gf/linearize/LinearizeTree.java 6 +/** + * Linearize an abstract syntax tree to a string representation + * of the tree itself. + */ hunk ./se/chalmers/cs/gf/linearize/Unlexer.java 6 +/** + * Glues together strings in linearization. + */ hunk ./se/chalmers/cs/gf/linearize/gfvalue/Param.java 3 -// FIXME: need more efficient represenatation - +/** + * A parameter. + */ hunk ./se/chalmers/cs/gf/linearize/gfvalue/Param.java 7 + + // FIXME: needs more efficient representation hunk ./se/chalmers/cs/gf/linearize/gfvalue/Pre.java 9 +/** + * Prefix-dependent choice. + */ hunk ./se/chalmers/cs/gf/linearize/gfvalue/Record.java 7 + +/** + * Record value. + */ hunk ./se/chalmers/cs/gf/linearize/gfvalue/Str.java 3 +/** + * String value. + */ hunk ./se/chalmers/cs/gf/linearize/gfvalue/Table.java 8 - * FIXME: needs more efficient represenatation + * A table. hunk ./se/chalmers/cs/gf/linearize/gfvalue/Table.java 11 + + // FIXME: needs more efficient represenatation hunk ./se/chalmers/cs/gf/linearize/gfvalue/Value.java 3 +/** + * Base class for GF values. + */ hunk ./se/chalmers/cs/gf/linearize/gfvalue/Value.java 8 + /** + * Default implementation just calls toString(). + */ addfile ./se/chalmers/cs/gf/linearize/gfvalue/package.html hunk ./se/chalmers/cs/gf/linearize/gfvalue/package.html 1 - + +GF values: strings, records, tables etc. + addfile ./se/chalmers/cs/gf/linearize/package.html hunk ./se/chalmers/cs/gf/linearize/package.html 1 - + +Linearization functionality. + hunk ./se/chalmers/cs/gf/oaa/GFAgent.java 19 +/** + * The GF OAA agent. + */ hunk ./se/chalmers/cs/gf/oaa/Linearize.java 14 +/** + * Implements the linearization solvable. + */ hunk ./se/chalmers/cs/gf/oaa/Parse.java 14 +/** + * Implements the parsing solvable. + */ hunk ./se/chalmers/cs/gf/oaa/Translate.java 13 +/** + * Implements the translation solvable. + */ addfile ./se/chalmers/cs/gf/oaa/package.html hunk ./se/chalmers/cs/gf/oaa/package.html 1 - + +GF OAA agent. + addfile ./se/chalmers/cs/gf/overview.html hunk ./se/chalmers/cs/gf/overview.html 1 - + +These classes implement an interpreter for GF grammars. + addfile ./se/chalmers/cs/gf/package.html hunk ./se/chalmers/cs/gf/package.html 1 - + +Basic GF classes. + hunk ./se/chalmers/cs/gf/parse/ParseAll.java 11 +/** + * Try parsing with a collection of parsers. + */ hunk ./se/chalmers/cs/gf/parse/ParseAll.java 18 + /** + * @param parsers The parsers that should be used to + * parse with. + */ hunk ./se/chalmers/cs/gf/parse/ParseDecimal.java 8 +/** + * Parses a decimal number to the numerals abstract syntax. + */ hunk ./se/chalmers/cs/gf/parse/ParseLogger.java 5 +/** + * Handles logging for the parsing package. + */ hunk ./se/chalmers/cs/gf/parse/chart/KilburyParser.java 6 +/** + * A bottom-up chart parser. + */ hunk ./se/chalmers/cs/gf/parse/chart/Lexer.java 6 +/** + * A simple lexer. + */ hunk ./se/chalmers/cs/gf/parse/chart/TreeBuilder.java 8 +/** + * Builds abstract syntax trees from a parsing chart. + */ addfile ./se/chalmers/cs/gf/parse/chart/package.html hunk ./se/chalmers/cs/gf/parse/chart/package.html 1 - + +A bottom-up chart parser. + addfile ./se/chalmers/cs/gf/parse/package.html hunk ./se/chalmers/cs/gf/parse/package.html 1 - + +General parsing functionality. + hunk ./se/chalmers/cs/gf/translate/TranslatorFactory.java 73 - * @param extraparsers Class names of extra linearizers to load + * @param extralinearizers Class names of extra linearizers to load addfile ./se/chalmers/cs/gf/translate/package.html hunk ./se/chalmers/cs/gf/translate/package.html 1 - + +Translation functionality. + addfile ./se/chalmers/cs/gf/translategui/package.html hunk ./se/chalmers/cs/gf/translategui/package.html 1 - + +A simple translation GUI. + addfile ./se/chalmers/cs/gf/typedtree/package.html hunk ./se/chalmers/cs/gf/typedtree/package.html 1 - + +Generation of typed tree representations of abstract syntax. + addfile ./se/chalmers/cs/gf/util/package.html hunk ./se/chalmers/cs/gf/util/package.html 1 - + +General utilities. + }