See: Description
Interface | Description |
---|---|
ArchiveParserConstants |
Token literal values and constants.
|
CharStream |
This interface describes a character stream that maintains line and
column number positions of the characters.
|
DeltaTextLine |
Class | Description |
---|---|
Archive |
Handling of RCS/CVS style version control archives.
|
ArchiveParser |
Parses an RCS/CVS style version control archive into an Archive.
|
ArchiveParserTokenManager |
Token Manager.
|
BranchNode |
Represents a branch node in a version control archive.
|
DeltaAddTextLine | |
DeltaDelTextLine | |
DeltaText |
RCS DeltaText _text_ container.
|
FastCharStream |
An efficient implementation of JavaCC's CharStream interface.
|
KeywordsFormat |
Formatter for the RCS keywords.
|
Line |
An annotated line of a revision.
|
Lines |
A list of the lines in the text of a revision annotated with the
version that corresponds to each line.
|
Node |
Ancestor to all nodes in a version control Archive.
|
Path |
A path from the head revision to a given revision in an Archive.
|
Phrases |
A set of "new phrases" for an Archive.
|
Token |
Describes the input token stream.
|
TrunkNode |
Represents a node on the trunk or main branch of a version control Archive.
|
Version |
Contains and manages a version number of the form "x(\.y)*".
|
Exception | Description |
---|---|
BranchNotFoundException | |
HeadAlreadySetException |
Thrown if the ArchiveParser finds that the head node is set more than once.
|
InvalidBranchVersionNumberException |
Thrown if the version number given for a branch node is invalid.
|
InvalidFileFormatException |
Thrown if the ArchiveParser cannot parse a given archive.
|
InvalidTrunkVersionNumberException |
Thrown if the version number given for a trunk node is invalid.
|
InvalidVersionNumberException |
Thrown whenever a given version number is invalid for the context.
|
NodeNotFoundException | |
ParseException |
This exception is thrown when parse errors are encountered.
|
RCSException |
Error | Description |
---|---|
TokenMgrError |
Token Manager Error.
|
JRCS is not intended to replace RCS nor CVS. JRCS was written to be able create archive analysis tools that can do things like identify hot spots in the source code, measure the contributions by each developer, or assess how bugs make it in.
The reasons why JRCS has the ability do do check-ins and save archives is API symmetry, and to simplify the writing of unit tests.
The rcs
package implements th8e
archive handling functionality. The entry point to the library is
class Archive
.
CAVEAT UTILITOR: Do not make modifications to your archives with JRCS. There needs to be an important amount of additional testing before it's safe to do that.
The diff
package implements
the differencing engine that JRCS uses. The engine has the power
of Unix diff, is simple to understand, and can be used
independently of the archive handling functionality. The entry
point to the differencing engine is class Diff
.
The Jakarta ORO Regexp library is used for RCS keyword management. You can get a copy of Jakarta ORO from:
http://jakarta.apache.org/oro/
A copy of Jakarta Regexp is included in the full distribution of this library.
The RCS parser is constructed using the JavaCC compiler compiler. You can get a copy of JavaCC from:
http://www.metamata.com/javacc/
JavaCC is not distributable, so you must get a copy of it yourself if you intend to use it. Keep in mind that, as distributed, this library does not require JavaCC to be compiled because all the JavaCC generated .java files are included.
If you decide to use JavaCC, please adjust the "javacc.lib.dir" property as needed. You'll also need to download the set of optional tasks for Ant.
The library tests are written for the JUnit Testing Framework. For distributions and documentation see:
http://www.junit.org/
Copyright 2002 the Apache Software Foundation
Copyright ? 1999-2001 Juancarlo A?ez, Caracas, Venezuela.
All rights reserved
. http://www.suigeneris.org/jrcs